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