Imported Upstream version 16.07-rc1
[deb_dpdk.git] / drivers / net / enic / base / rq_enet_desc.h
1 /*
2  * Copyright 2008-2010 Cisco Systems, Inc.  All rights reserved.
3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
4  *
5  * Copyright (c) 2014, Cisco Systems, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34
35 #ifndef _RQ_ENET_DESC_H_
36 #define _RQ_ENET_DESC_H_
37
38 /* Ethernet receive queue descriptor: 16B */
39 struct rq_enet_desc {
40         __le64 address;
41         __le16 length_type;
42         u8 reserved[6];
43 };
44
45 enum rq_enet_type_types {
46         RQ_ENET_TYPE_ONLY_SOP = 0,
47         RQ_ENET_TYPE_NOT_SOP = 1,
48         RQ_ENET_TYPE_RESV2 = 2,
49         RQ_ENET_TYPE_RESV3 = 3,
50 };
51
52 #define RQ_ENET_ADDR_BITS               64
53 #define RQ_ENET_LEN_BITS                14
54 #define RQ_ENET_LEN_MASK                ((1 << RQ_ENET_LEN_BITS) - 1)
55 #define RQ_ENET_TYPE_BITS               2
56 #define RQ_ENET_TYPE_MASK               ((1 << RQ_ENET_TYPE_BITS) - 1)
57
58 static inline void rq_enet_desc_enc(volatile struct rq_enet_desc *desc,
59         u64 address, u8 type, u16 length)
60 {
61         desc->address = cpu_to_le64(address);
62         desc->length_type = cpu_to_le16((length & RQ_ENET_LEN_MASK) |
63                 ((type & RQ_ENET_TYPE_MASK) << RQ_ENET_LEN_BITS));
64 }
65
66 static inline void rq_enet_desc_dec(struct rq_enet_desc *desc,
67         u64 *address, u8 *type, u16 *length)
68 {
69         *address = le64_to_cpu(desc->address);
70         *length = le16_to_cpu(desc->length_type) & RQ_ENET_LEN_MASK;
71         *type = (u8)((le16_to_cpu(desc->length_type) >> RQ_ENET_LEN_BITS) &
72                 RQ_ENET_TYPE_MASK);
73 }
74
75 #endif /* _RQ_ENET_DESC_H_ */