GNU Linux-libre 4.14.266-gnu1
[releases.git] / include / linux / netdev_features.h
1 /*
2  * Network device features.
3  *
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version
8  * 2 of the License, or (at your option) any later version.
9  */
10 #ifndef _LINUX_NETDEV_FEATURES_H
11 #define _LINUX_NETDEV_FEATURES_H
12
13 #include <linux/types.h>
14 #include <linux/bitops.h>
15 #include <asm/byteorder.h>
16
17 typedef u64 netdev_features_t;
18
19 enum {
20         NETIF_F_SG_BIT,                 /* Scatter/gather IO. */
21         NETIF_F_IP_CSUM_BIT,            /* Can checksum TCP/UDP over IPv4. */
22         __UNUSED_NETIF_F_1,
23         NETIF_F_HW_CSUM_BIT,            /* Can checksum all the packets. */
24         NETIF_F_IPV6_CSUM_BIT,          /* Can checksum TCP/UDP over IPV6 */
25         NETIF_F_HIGHDMA_BIT,            /* Can DMA to high memory. */
26         NETIF_F_FRAGLIST_BIT,           /* Scatter/gather IO. */
27         NETIF_F_HW_VLAN_CTAG_TX_BIT,    /* Transmit VLAN CTAG HW acceleration */
28         NETIF_F_HW_VLAN_CTAG_RX_BIT,    /* Receive VLAN CTAG HW acceleration */
29         NETIF_F_HW_VLAN_CTAG_FILTER_BIT,/* Receive filtering on VLAN CTAGs */
30         NETIF_F_VLAN_CHALLENGED_BIT,    /* Device cannot handle VLAN packets */
31         NETIF_F_GSO_BIT,                /* Enable software GSO. */
32         NETIF_F_LLTX_BIT,               /* LockLess TX - deprecated. Please */
33                                         /* do not use LLTX in new drivers */
34         NETIF_F_NETNS_LOCAL_BIT,        /* Does not change network namespaces */
35         NETIF_F_GRO_BIT,                /* Generic receive offload */
36         NETIF_F_LRO_BIT,                /* large receive offload */
37
38         /**/NETIF_F_GSO_SHIFT,          /* keep the order of SKB_GSO_* bits */
39         NETIF_F_TSO_BIT                 /* ... TCPv4 segmentation */
40                 = NETIF_F_GSO_SHIFT,
41         NETIF_F_GSO_ROBUST_BIT,         /* ... ->SKB_GSO_DODGY */
42         NETIF_F_TSO_ECN_BIT,            /* ... TCP ECN support */
43         NETIF_F_TSO_MANGLEID_BIT,       /* ... IPV4 ID mangling allowed */
44         NETIF_F_TSO6_BIT,               /* ... TCPv6 segmentation */
45         NETIF_F_FSO_BIT,                /* ... FCoE segmentation */
46         NETIF_F_GSO_GRE_BIT,            /* ... GRE with TSO */
47         NETIF_F_GSO_GRE_CSUM_BIT,       /* ... GRE with csum with TSO */
48         NETIF_F_GSO_IPXIP4_BIT,         /* ... IP4 or IP6 over IP4 with TSO */
49         NETIF_F_GSO_IPXIP6_BIT,         /* ... IP4 or IP6 over IP6 with TSO */
50         NETIF_F_GSO_UDP_TUNNEL_BIT,     /* ... UDP TUNNEL with TSO */
51         NETIF_F_GSO_UDP_TUNNEL_CSUM_BIT,/* ... UDP TUNNEL with TSO & CSUM */
52         NETIF_F_GSO_PARTIAL_BIT,        /* ... Only segment inner-most L4
53                                          *     in hardware and all other
54                                          *     headers in software.
55                                          */
56         NETIF_F_GSO_TUNNEL_REMCSUM_BIT, /* ... TUNNEL with TSO & REMCSUM */
57         NETIF_F_GSO_SCTP_BIT,           /* ... SCTP fragmentation */
58         NETIF_F_GSO_ESP_BIT,            /* ... ESP with TSO */
59         NETIF_F_GSO_UDP_BIT,            /* ... UFO, deprecated except tuntap */
60         /**/NETIF_F_GSO_LAST =          /* last bit, see GSO_MASK */
61                 NETIF_F_GSO_UDP_BIT,
62
63         NETIF_F_FCOE_CRC_BIT,           /* FCoE CRC32 */
64         NETIF_F_SCTP_CRC_BIT,           /* SCTP checksum offload */
65         NETIF_F_FCOE_MTU_BIT,           /* Supports max FCoE MTU, 2158 bytes*/
66         NETIF_F_NTUPLE_BIT,             /* N-tuple filters supported */
67         NETIF_F_RXHASH_BIT,             /* Receive hashing offload */
68         NETIF_F_RXCSUM_BIT,             /* Receive checksumming offload */
69         NETIF_F_NOCACHE_COPY_BIT,       /* Use no-cache copyfromuser */
70         NETIF_F_LOOPBACK_BIT,           /* Enable loopback */
71         NETIF_F_RXFCS_BIT,              /* Append FCS to skb pkt data */
72         NETIF_F_RXALL_BIT,              /* Receive errored frames too */
73         NETIF_F_HW_VLAN_STAG_TX_BIT,    /* Transmit VLAN STAG HW acceleration */
74         NETIF_F_HW_VLAN_STAG_RX_BIT,    /* Receive VLAN STAG HW acceleration */
75         NETIF_F_HW_VLAN_STAG_FILTER_BIT,/* Receive filtering on VLAN STAGs */
76         NETIF_F_HW_L2FW_DOFFLOAD_BIT,   /* Allow L2 Forwarding in Hardware */
77
78         NETIF_F_HW_TC_BIT,              /* Offload TC infrastructure */
79         NETIF_F_HW_ESP_BIT,             /* Hardware ESP transformation offload */
80         NETIF_F_HW_ESP_TX_CSUM_BIT,     /* ESP with TX checksum offload */
81         NETIF_F_RX_UDP_TUNNEL_PORT_BIT, /* Offload of RX port for UDP tunnels */
82
83         /*
84          * Add your fresh new feature above and remember to update
85          * netdev_features_strings[] in net/core/ethtool.c and maybe
86          * some feature mask #defines below. Please also describe it
87          * in Documentation/networking/netdev-features.txt.
88          */
89
90         /**/NETDEV_FEATURE_COUNT
91 };
92
93 /* copy'n'paste compression ;) */
94 #define __NETIF_F_BIT(bit)      ((netdev_features_t)1 << (bit))
95 #define __NETIF_F(name)         __NETIF_F_BIT(NETIF_F_##name##_BIT)
96
97 #define NETIF_F_FCOE_CRC        __NETIF_F(FCOE_CRC)
98 #define NETIF_F_FCOE_MTU        __NETIF_F(FCOE_MTU)
99 #define NETIF_F_FRAGLIST        __NETIF_F(FRAGLIST)
100 #define NETIF_F_FSO             __NETIF_F(FSO)
101 #define NETIF_F_GRO             __NETIF_F(GRO)
102 #define NETIF_F_GSO             __NETIF_F(GSO)
103 #define NETIF_F_GSO_ROBUST      __NETIF_F(GSO_ROBUST)
104 #define NETIF_F_HIGHDMA         __NETIF_F(HIGHDMA)
105 #define NETIF_F_HW_CSUM         __NETIF_F(HW_CSUM)
106 #define NETIF_F_HW_VLAN_CTAG_FILTER __NETIF_F(HW_VLAN_CTAG_FILTER)
107 #define NETIF_F_HW_VLAN_CTAG_RX __NETIF_F(HW_VLAN_CTAG_RX)
108 #define NETIF_F_HW_VLAN_CTAG_TX __NETIF_F(HW_VLAN_CTAG_TX)
109 #define NETIF_F_IP_CSUM         __NETIF_F(IP_CSUM)
110 #define NETIF_F_IPV6_CSUM       __NETIF_F(IPV6_CSUM)
111 #define NETIF_F_LLTX            __NETIF_F(LLTX)
112 #define NETIF_F_LOOPBACK        __NETIF_F(LOOPBACK)
113 #define NETIF_F_LRO             __NETIF_F(LRO)
114 #define NETIF_F_NETNS_LOCAL     __NETIF_F(NETNS_LOCAL)
115 #define NETIF_F_NOCACHE_COPY    __NETIF_F(NOCACHE_COPY)
116 #define NETIF_F_NTUPLE          __NETIF_F(NTUPLE)
117 #define NETIF_F_RXCSUM          __NETIF_F(RXCSUM)
118 #define NETIF_F_RXHASH          __NETIF_F(RXHASH)
119 #define NETIF_F_SCTP_CRC        __NETIF_F(SCTP_CRC)
120 #define NETIF_F_SG              __NETIF_F(SG)
121 #define NETIF_F_TSO6            __NETIF_F(TSO6)
122 #define NETIF_F_TSO_ECN         __NETIF_F(TSO_ECN)
123 #define NETIF_F_TSO             __NETIF_F(TSO)
124 #define NETIF_F_VLAN_CHALLENGED __NETIF_F(VLAN_CHALLENGED)
125 #define NETIF_F_RXFCS           __NETIF_F(RXFCS)
126 #define NETIF_F_RXALL           __NETIF_F(RXALL)
127 #define NETIF_F_GSO_GRE         __NETIF_F(GSO_GRE)
128 #define NETIF_F_GSO_GRE_CSUM    __NETIF_F(GSO_GRE_CSUM)
129 #define NETIF_F_GSO_IPXIP4      __NETIF_F(GSO_IPXIP4)
130 #define NETIF_F_GSO_IPXIP6      __NETIF_F(GSO_IPXIP6)
131 #define NETIF_F_GSO_UDP_TUNNEL  __NETIF_F(GSO_UDP_TUNNEL)
132 #define NETIF_F_GSO_UDP_TUNNEL_CSUM __NETIF_F(GSO_UDP_TUNNEL_CSUM)
133 #define NETIF_F_TSO_MANGLEID    __NETIF_F(TSO_MANGLEID)
134 #define NETIF_F_GSO_PARTIAL      __NETIF_F(GSO_PARTIAL)
135 #define NETIF_F_GSO_TUNNEL_REMCSUM __NETIF_F(GSO_TUNNEL_REMCSUM)
136 #define NETIF_F_GSO_SCTP        __NETIF_F(GSO_SCTP)
137 #define NETIF_F_GSO_ESP         __NETIF_F(GSO_ESP)
138 #define NETIF_F_GSO_UDP         __NETIF_F(GSO_UDP)
139 #define NETIF_F_HW_VLAN_STAG_FILTER __NETIF_F(HW_VLAN_STAG_FILTER)
140 #define NETIF_F_HW_VLAN_STAG_RX __NETIF_F(HW_VLAN_STAG_RX)
141 #define NETIF_F_HW_VLAN_STAG_TX __NETIF_F(HW_VLAN_STAG_TX)
142 #define NETIF_F_HW_L2FW_DOFFLOAD        __NETIF_F(HW_L2FW_DOFFLOAD)
143 #define NETIF_F_HW_TC           __NETIF_F(HW_TC)
144 #define NETIF_F_HW_ESP          __NETIF_F(HW_ESP)
145 #define NETIF_F_HW_ESP_TX_CSUM  __NETIF_F(HW_ESP_TX_CSUM)
146 #define NETIF_F_RX_UDP_TUNNEL_PORT  __NETIF_F(RX_UDP_TUNNEL_PORT)
147
148 /* Finds the next feature with the highest number of the range of start till 0.
149  */
150 static inline int find_next_netdev_feature(u64 feature, unsigned long start)
151 {
152         /* like BITMAP_LAST_WORD_MASK() for u64
153          * this sets the most significant 64 - start to 0.
154          */
155         feature &= ~0ULL >> (-start & ((sizeof(feature) * 8) - 1));
156
157         return fls64(feature) - 1;
158 }
159
160 /* This goes for the MSB to the LSB through the set feature bits,
161  * mask_addr should be a u64 and bit an int
162  */
163 #define for_each_netdev_feature(mask_addr, bit)                         \
164         for ((bit) = find_next_netdev_feature((mask_addr),              \
165                                               NETDEV_FEATURE_COUNT);    \
166              (bit) >= 0;                                                \
167              (bit) = find_next_netdev_feature((mask_addr), (bit) - 1))
168
169 /* Features valid for ethtool to change */
170 /* = all defined minus driver/device-class-related */
171 #define NETIF_F_NEVER_CHANGE    (NETIF_F_VLAN_CHALLENGED | \
172                                  NETIF_F_LLTX | NETIF_F_NETNS_LOCAL)
173
174 /* remember that ((t)1 << t_BITS) is undefined in C99 */
175 #define NETIF_F_ETHTOOL_BITS    ((__NETIF_F_BIT(NETDEV_FEATURE_COUNT - 1) | \
176                 (__NETIF_F_BIT(NETDEV_FEATURE_COUNT - 1) - 1)) & \
177                 ~NETIF_F_NEVER_CHANGE)
178
179 /* Segmentation offload feature mask */
180 #define NETIF_F_GSO_MASK        (__NETIF_F_BIT(NETIF_F_GSO_LAST + 1) - \
181                 __NETIF_F_BIT(NETIF_F_GSO_SHIFT))
182
183 /* List of IP checksum features. Note that NETIF_F_ HW_CSUM should not be
184  * set in features when NETIF_F_IP_CSUM or NETIF_F_IPV6_CSUM are set--
185  * this would be contradictory
186  */
187 #define NETIF_F_CSUM_MASK       (NETIF_F_IP_CSUM | NETIF_F_IPV6_CSUM | \
188                                  NETIF_F_HW_CSUM)
189
190 #define NETIF_F_ALL_TSO         (NETIF_F_TSO | NETIF_F_TSO6 | \
191                                  NETIF_F_TSO_ECN | NETIF_F_TSO_MANGLEID)
192
193 #define NETIF_F_ALL_FCOE        (NETIF_F_FCOE_CRC | NETIF_F_FCOE_MTU | \
194                                  NETIF_F_FSO)
195
196 /* List of features with software fallbacks. */
197 #define NETIF_F_GSO_SOFTWARE    (NETIF_F_ALL_TSO | \
198                                  NETIF_F_GSO_SCTP)
199
200 /*
201  * If one device supports one of these features, then enable them
202  * for all in netdev_increment_features.
203  */
204 #define NETIF_F_ONE_FOR_ALL     (NETIF_F_GSO_SOFTWARE | NETIF_F_GSO_ROBUST | \
205                                  NETIF_F_SG | NETIF_F_HIGHDMA |         \
206                                  NETIF_F_FRAGLIST | NETIF_F_VLAN_CHALLENGED)
207
208 /*
209  * If one device doesn't support one of these features, then disable it
210  * for all in netdev_increment_features.
211  */
212 #define NETIF_F_ALL_FOR_ALL     (NETIF_F_NOCACHE_COPY | NETIF_F_FSO)
213
214 /*
215  * If upper/master device has these features disabled, they must be disabled
216  * on all lower/slave devices as well.
217  */
218 #define NETIF_F_UPPER_DISABLES  NETIF_F_LRO
219
220 /* changeable features with no special hardware requirements */
221 #define NETIF_F_SOFT_FEATURES   (NETIF_F_GSO | NETIF_F_GRO)
222
223 #define NETIF_F_VLAN_FEATURES   (NETIF_F_HW_VLAN_CTAG_FILTER | \
224                                  NETIF_F_HW_VLAN_CTAG_RX | \
225                                  NETIF_F_HW_VLAN_CTAG_TX | \
226                                  NETIF_F_HW_VLAN_STAG_FILTER | \
227                                  NETIF_F_HW_VLAN_STAG_RX | \
228                                  NETIF_F_HW_VLAN_STAG_TX)
229
230 #define NETIF_F_GSO_ENCAP_ALL   (NETIF_F_GSO_GRE |                      \
231                                  NETIF_F_GSO_GRE_CSUM |                 \
232                                  NETIF_F_GSO_IPXIP4 |                   \
233                                  NETIF_F_GSO_IPXIP6 |                   \
234                                  NETIF_F_GSO_UDP_TUNNEL |               \
235                                  NETIF_F_GSO_UDP_TUNNEL_CSUM)
236
237 #endif  /* _LINUX_NETDEV_FEATURES_H */