netdev_features.h

  1/* SPDX-License-Identifier: GPL-2.0-or-later */
  2/*
  3 * Network device features.
  4 */
  5#ifndef _LINUX_NETDEV_FEATURES_H
  6#define _LINUX_NETDEV_FEATURES_H
  7
  8#include <linux/types.h>
  9#include <linux/bitops.h>
 10#include <asm/byteorder.h>
 11
 12typedef u64 netdev_features_t;
 13
 14enum {
 15	NETIF_F_SG_BIT,			/* Scatter/gather IO. */
 16	NETIF_F_IP_CSUM_BIT,		/* Can checksum TCP/UDP over IPv4. */
 17	__UNUSED_NETIF_F_1,
 18	NETIF_F_HW_CSUM_BIT,		/* Can checksum all the packets. */
 19	NETIF_F_IPV6_CSUM_BIT,		/* Can checksum TCP/UDP over IPV6 */
 20	NETIF_F_HIGHDMA_BIT,		/* Can DMA to high memory. */
 21	NETIF_F_FRAGLIST_BIT,		/* Scatter/gather IO. */
 22	NETIF_F_HW_VLAN_CTAG_TX_BIT,	/* Transmit VLAN CTAG HW acceleration */
 23	NETIF_F_HW_VLAN_CTAG_RX_BIT,	/* Receive VLAN CTAG HW acceleration */
 24	NETIF_F_HW_VLAN_CTAG_FILTER_BIT,/* Receive filtering on VLAN CTAGs */
 25	NETIF_F_VLAN_CHALLENGED_BIT,	/* Device cannot handle VLAN packets */
 26	NETIF_F_GSO_BIT,		/* Enable software GSO. */
 27	__UNUSED_NETIF_F_12,
 28	__UNUSED_NETIF_F_13,
 29	NETIF_F_GRO_BIT,		/* Generic receive offload */
 30	NETIF_F_LRO_BIT,		/* large receive offload */
 31
 32	/**/NETIF_F_GSO_SHIFT,		/* keep the order of SKB_GSO_* bits */
 33	NETIF_F_TSO_BIT			/* ... TCPv4 segmentation */
 34		= NETIF_F_GSO_SHIFT,
 35	NETIF_F_GSO_ROBUST_BIT,		/* ... ->SKB_GSO_DODGY */
 36	NETIF_F_TSO_ECN_BIT,		/* ... TCP ECN support */
 37	NETIF_F_TSO_MANGLEID_BIT,	/* ... IPV4 ID mangling allowed */
 38	NETIF_F_TSO6_BIT,		/* ... TCPv6 segmentation */
 39	NETIF_F_FSO_BIT,		/* ... FCoE segmentation */
 40	NETIF_F_GSO_GRE_BIT,		/* ... GRE with TSO */
 41	NETIF_F_GSO_GRE_CSUM_BIT,	/* ... GRE with csum with TSO */
 42	NETIF_F_GSO_IPXIP4_BIT,		/* ... IP4 or IP6 over IP4 with TSO */
 43	NETIF_F_GSO_IPXIP6_BIT,		/* ... IP4 or IP6 over IP6 with TSO */
 44	NETIF_F_GSO_UDP_TUNNEL_BIT,	/* ... UDP TUNNEL with TSO */
 45	NETIF_F_GSO_UDP_TUNNEL_CSUM_BIT,/* ... UDP TUNNEL with TSO & CSUM */
 46	NETIF_F_GSO_PARTIAL_BIT,	/* ... Only segment inner-most L4
 47					 *     in hardware and all other
 48					 *     headers in software.
 49					 */
 50	NETIF_F_GSO_TUNNEL_REMCSUM_BIT, /* ... TUNNEL with TSO & REMCSUM */
 51	NETIF_F_GSO_SCTP_BIT,		/* ... SCTP fragmentation */
 52	NETIF_F_GSO_ESP_BIT,		/* ... ESP with TSO */
 53	NETIF_F_GSO_UDP_BIT,		/* ... UFO, deprecated except tuntap */
 54	NETIF_F_GSO_UDP_L4_BIT,		/* ... UDP payload GSO (not UFO) */
 55	NETIF_F_GSO_FRAGLIST_BIT,		/* ... Fraglist GSO */
 56	NETIF_F_GSO_ACCECN_BIT,		/* TCP AccECN w/ TSO (no clear CWR) */
 57	/**/NETIF_F_GSO_LAST =		/* last bit, see GSO_MASK */
 58		NETIF_F_GSO_ACCECN_BIT,
 59
 60	NETIF_F_FCOE_CRC_BIT,		/* FCoE CRC32 */
 61	NETIF_F_SCTP_CRC_BIT,		/* SCTP checksum offload */
 62	NETIF_F_NTUPLE_BIT,		/* N-tuple filters supported */
 63	NETIF_F_RXHASH_BIT,		/* Receive hashing offload */
 64	NETIF_F_RXCSUM_BIT,		/* Receive checksumming offload */
 65	NETIF_F_NOCACHE_COPY_BIT,	/* Use no-cache copyfromuser */
 66	NETIF_F_LOOPBACK_BIT,		/* Enable loopback */
 67	NETIF_F_RXFCS_BIT,		/* Append FCS to skb pkt data */
 68	NETIF_F_RXALL_BIT,		/* Receive errored frames too */
 69	NETIF_F_HW_VLAN_STAG_TX_BIT,	/* Transmit VLAN STAG HW acceleration */
 70	NETIF_F_HW_VLAN_STAG_RX_BIT,	/* Receive VLAN STAG HW acceleration */
 71	NETIF_F_HW_VLAN_STAG_FILTER_BIT,/* Receive filtering on VLAN STAGs */
 72	NETIF_F_HW_L2FW_DOFFLOAD_BIT,	/* Allow L2 Forwarding in Hardware */
 73
 74	NETIF_F_HW_TC_BIT,		/* Offload TC infrastructure */
 75	NETIF_F_HW_ESP_BIT,		/* Hardware ESP transformation offload */
 76	NETIF_F_HW_ESP_TX_CSUM_BIT,	/* ESP with TX checksum offload */
 77	NETIF_F_RX_UDP_TUNNEL_PORT_BIT, /* Offload of RX port for UDP tunnels */
 78	NETIF_F_HW_TLS_TX_BIT,		/* Hardware TLS TX offload */
 79	NETIF_F_HW_TLS_RX_BIT,		/* Hardware TLS RX offload */
 80
 81	NETIF_F_GRO_HW_BIT,		/* Hardware Generic receive offload */
 82	NETIF_F_HW_TLS_RECORD_BIT,	/* Offload TLS record */
 83	NETIF_F_GRO_FRAGLIST_BIT,	/* Fraglist GRO */
 84
 85	NETIF_F_HW_MACSEC_BIT,		/* Offload MACsec operations */
 86	NETIF_F_GRO_UDP_FWD_BIT,	/* Allow UDP GRO for forwarding */
 87
 88	NETIF_F_HW_HSR_TAG_INS_BIT,	/* Offload HSR tag insertion */
 89	NETIF_F_HW_HSR_TAG_RM_BIT,	/* Offload HSR tag removal */
 90	NETIF_F_HW_HSR_FWD_BIT,		/* Offload HSR forwarding */
 91	NETIF_F_HW_HSR_DUP_BIT,		/* Offload HSR duplication */
 92
 93	/*
 94	 * Add your fresh new feature above and remember to update
 95	 * netdev_features_strings[] in net/ethtool/common.c and maybe
 96	 * some feature mask #defines below. Please also describe it
 97	 * in Documentation/networking/netdev-features.rst.
 98	 */
 99
100	/**/NETDEV_FEATURE_COUNT
101};
102
103/* copy'n'paste compression ;) */
104#define __NETIF_F_BIT(bit)	((netdev_features_t)1 << (bit))
105#define __NETIF_F(name)		__NETIF_F_BIT(NETIF_F_##name##_BIT)
106
107#define NETIF_F_FCOE_CRC	__NETIF_F(FCOE_CRC)
108#define NETIF_F_FRAGLIST	__NETIF_F(FRAGLIST)
109#define NETIF_F_FSO		__NETIF_F(FSO)
110#define NETIF_F_GRO		__NETIF_F(GRO)
111#define NETIF_F_GRO_HW		__NETIF_F(GRO_HW)
112#define NETIF_F_GSO		__NETIF_F(GSO)
113#define NETIF_F_GSO_ROBUST	__NETIF_F(GSO_ROBUST)
114#define NETIF_F_HIGHDMA		__NETIF_F(HIGHDMA)
115#define NETIF_F_HW_CSUM		__NETIF_F(HW_CSUM)
116#define NETIF_F_HW_VLAN_CTAG_FILTER __NETIF_F(HW_VLAN_CTAG_FILTER)
117#define NETIF_F_HW_VLAN_CTAG_RX	__NETIF_F(HW_VLAN_CTAG_RX)
118#define NETIF_F_HW_VLAN_CTAG_TX	__NETIF_F(HW_VLAN_CTAG_TX)
119#define NETIF_F_IP_CSUM		__NETIF_F(IP_CSUM)
120#define NETIF_F_IPV6_CSUM	__NETIF_F(IPV6_CSUM)
121#define NETIF_F_LOOPBACK	__NETIF_F(LOOPBACK)
122#define NETIF_F_LRO		__NETIF_F(LRO)
123#define NETIF_F_NOCACHE_COPY	__NETIF_F(NOCACHE_COPY)
124#define NETIF_F_NTUPLE		__NETIF_F(NTUPLE)
125#define NETIF_F_RXCSUM		__NETIF_F(RXCSUM)
126#define NETIF_F_RXHASH		__NETIF_F(RXHASH)
127#define NETIF_F_SCTP_CRC	__NETIF_F(SCTP_CRC)
128#define NETIF_F_SG		__NETIF_F(SG)
129#define NETIF_F_TSO6		__NETIF_F(TSO6)
130#define NETIF_F_TSO_ECN		__NETIF_F(TSO_ECN)
131#define NETIF_F_GSO_ACCECN	__NETIF_F(GSO_ACCECN)
132#define NETIF_F_TSO		__NETIF_F(TSO)
133#define NETIF_F_VLAN_CHALLENGED	__NETIF_F(VLAN_CHALLENGED)
134#define NETIF_F_RXFCS		__NETIF_F(RXFCS)
135#define NETIF_F_RXALL		__NETIF_F(RXALL)
136#define NETIF_F_GSO_GRE		__NETIF_F(GSO_GRE)
137#define NETIF_F_GSO_GRE_CSUM	__NETIF_F(GSO_GRE_CSUM)
138#define NETIF_F_GSO_IPXIP4	__NETIF_F(GSO_IPXIP4)
139#define NETIF_F_GSO_IPXIP6	__NETIF_F(GSO_IPXIP6)
140#define NETIF_F_GSO_UDP_TUNNEL	__NETIF_F(GSO_UDP_TUNNEL)
141#define NETIF_F_GSO_UDP_TUNNEL_CSUM __NETIF_F(GSO_UDP_TUNNEL_CSUM)
142#define NETIF_F_TSO_MANGLEID	__NETIF_F(TSO_MANGLEID)
143#define NETIF_F_GSO_PARTIAL	 __NETIF_F(GSO_PARTIAL)
144#define NETIF_F_GSO_TUNNEL_REMCSUM __NETIF_F(GSO_TUNNEL_REMCSUM)
145#define NETIF_F_GSO_SCTP	__NETIF_F(GSO_SCTP)
146#define NETIF_F_GSO_ESP		__NETIF_F(GSO_ESP)
147#define NETIF_F_GSO_UDP		__NETIF_F(GSO_UDP)
148#define NETIF_F_HW_VLAN_STAG_FILTER __NETIF_F(HW_VLAN_STAG_FILTER)
149#define NETIF_F_HW_VLAN_STAG_RX	__NETIF_F(HW_VLAN_STAG_RX)
150#define NETIF_F_HW_VLAN_STAG_TX	__NETIF_F(HW_VLAN_STAG_TX)
151#define NETIF_F_HW_L2FW_DOFFLOAD	__NETIF_F(HW_L2FW_DOFFLOAD)
152#define NETIF_F_HW_TC		__NETIF_F(HW_TC)
153#define NETIF_F_HW_ESP		__NETIF_F(HW_ESP)
154#define NETIF_F_HW_ESP_TX_CSUM	__NETIF_F(HW_ESP_TX_CSUM)
155#define	NETIF_F_RX_UDP_TUNNEL_PORT  __NETIF_F(RX_UDP_TUNNEL_PORT)
156#define NETIF_F_HW_TLS_RECORD	__NETIF_F(HW_TLS_RECORD)
157#define NETIF_F_GSO_UDP_L4	__NETIF_F(GSO_UDP_L4)
158#define NETIF_F_HW_TLS_TX	__NETIF_F(HW_TLS_TX)
159#define NETIF_F_HW_TLS_RX	__NETIF_F(HW_TLS_RX)
160#define NETIF_F_GRO_FRAGLIST	__NETIF_F(GRO_FRAGLIST)
161#define NETIF_F_GSO_FRAGLIST	__NETIF_F(GSO_FRAGLIST)
162#define NETIF_F_HW_MACSEC	__NETIF_F(HW_MACSEC)
163#define NETIF_F_GRO_UDP_FWD	__NETIF_F(GRO_UDP_FWD)
164#define NETIF_F_HW_HSR_TAG_INS	__NETIF_F(HW_HSR_TAG_INS)
165#define NETIF_F_HW_HSR_TAG_RM	__NETIF_F(HW_HSR_TAG_RM)
166#define NETIF_F_HW_HSR_FWD	__NETIF_F(HW_HSR_FWD)
167#define NETIF_F_HW_HSR_DUP	__NETIF_F(HW_HSR_DUP)
168
169/* Finds the next feature with the highest number of the range of start-1 till 0.
170 */
171static inline int find_next_netdev_feature(u64 feature, unsigned long start)
172{
173	/* like BITMAP_LAST_WORD_MASK() for u64
174	 * this sets the most significant 64 - start to 0.
175	 */
176	feature &= ~0ULL >> (-start & ((sizeof(feature) * 8) - 1));
177
178	return fls64(feature) - 1;
179}
180
181/* This goes for the MSB to the LSB through the set feature bits,
182 * mask_addr should be a u64 and bit an int
183 */
184#define for_each_netdev_feature(mask_addr, bit)				\
185	for ((bit) = find_next_netdev_feature((mask_addr),		\
186					      NETDEV_FEATURE_COUNT);	\
187	     (bit) >= 0;						\
188	     (bit) = find_next_netdev_feature((mask_addr), (bit)))
189
190/* Features valid for ethtool to change */
191/* = all defined minus driver/device-class-related */
192#define NETIF_F_NEVER_CHANGE	NETIF_F_VLAN_CHALLENGED
193
194/* remember that ((t)1 << t_BITS) is undefined in C99 */
195#define NETIF_F_ETHTOOL_BITS	((__NETIF_F_BIT(NETDEV_FEATURE_COUNT - 1) | \
196		(__NETIF_F_BIT(NETDEV_FEATURE_COUNT - 1) - 1)) & \
197		~NETIF_F_NEVER_CHANGE)
198
199/* Segmentation offload feature mask */
200#define NETIF_F_GSO_MASK	(__NETIF_F_BIT(NETIF_F_GSO_LAST + 1) - \
201		__NETIF_F_BIT(NETIF_F_GSO_SHIFT))
202
203/* List of IP checksum features. Note that NETIF_F_HW_CSUM should not be
204 * set in features when NETIF_F_IP_CSUM or NETIF_F_IPV6_CSUM are set--
205 * this would be contradictory
206 */
207#define NETIF_F_CSUM_MASK	(NETIF_F_IP_CSUM | NETIF_F_IPV6_CSUM | \
208				 NETIF_F_HW_CSUM)
209
210#define NETIF_F_ALL_TSO 	(NETIF_F_TSO | NETIF_F_TSO6 | \
211				 NETIF_F_TSO_ECN | NETIF_F_TSO_MANGLEID)
212
213/* List of features with software fallbacks. */
214#define NETIF_F_GSO_SOFTWARE	(NETIF_F_ALL_TSO | \
215				 NETIF_F_GSO_ACCECN | NETIF_F_GSO_SCTP | \
216				 NETIF_F_GSO_UDP_L4 | NETIF_F_GSO_FRAGLIST)
217
218/*
219 * If one device supports one of these features, then enable them
220 * for all in netdev_increment_features.
221 */
222#define NETIF_F_ONE_FOR_ALL	(NETIF_F_GSO_SOFTWARE | NETIF_F_GSO_ROBUST | \
223				 NETIF_F_SG | NETIF_F_HIGHDMA |		\
224				 NETIF_F_FRAGLIST | NETIF_F_VLAN_CHALLENGED)
225
226/*
227 * If one device doesn't support one of these features, then disable it
228 * for all in netdev_increment_features.
229 */
230#define NETIF_F_ALL_FOR_ALL	(NETIF_F_NOCACHE_COPY | NETIF_F_FSO)
231
232/*
233 * If upper/master device has these features disabled, they must be disabled
234 * on all lower/slave devices as well.
235 */
236#define NETIF_F_UPPER_DISABLES	NETIF_F_LRO
237
238/* changeable features with no special hardware requirements */
239#define NETIF_F_SOFT_FEATURES	(NETIF_F_GSO | NETIF_F_GRO)
240
241/* Changeable features with no special hardware requirements that defaults to off. */
242#define NETIF_F_SOFT_FEATURES_OFF	(NETIF_F_GRO_FRAGLIST | NETIF_F_GRO_UDP_FWD)
243
244#define NETIF_F_VLAN_FEATURES	(NETIF_F_HW_VLAN_CTAG_FILTER | \
245				 NETIF_F_HW_VLAN_CTAG_RX | \
246				 NETIF_F_HW_VLAN_CTAG_TX | \
247				 NETIF_F_HW_VLAN_STAG_FILTER | \
248				 NETIF_F_HW_VLAN_STAG_RX | \
249				 NETIF_F_HW_VLAN_STAG_TX)
250
251#define NETIF_F_GSO_ENCAP_ALL	(NETIF_F_GSO_GRE |			\
252				 NETIF_F_GSO_GRE_CSUM |			\
253				 NETIF_F_GSO_IPXIP4 |			\
254				 NETIF_F_GSO_IPXIP6 |			\
255				 NETIF_F_GSO_UDP_TUNNEL |		\
256				 NETIF_F_GSO_UDP_TUNNEL_CSUM)
257
258/* virtual device features */
259#define MASTER_UPPER_DEV_VLAN_FEATURES	 (NETIF_F_HW_CSUM | NETIF_F_SG | \
260					  NETIF_F_FRAGLIST | NETIF_F_GSO_SOFTWARE | \
261					  NETIF_F_GSO_ENCAP_ALL | \
262					  NETIF_F_HIGHDMA | NETIF_F_LRO)
263
264#define MASTER_UPPER_DEV_ENC_FEATURES	 (NETIF_F_HW_CSUM | NETIF_F_SG | \
265					  NETIF_F_RXCSUM | NETIF_F_GSO_SOFTWARE | \
266					  NETIF_F_GSO_PARTIAL)
267
268#define MASTER_UPPER_DEV_MPLS_FEATURES	 (NETIF_F_HW_CSUM | NETIF_F_SG | \
269					  NETIF_F_GSO_SOFTWARE)
270
271#define MASTER_UPPER_DEV_XFRM_FEATURES	 (NETIF_F_HW_ESP | NETIF_F_HW_ESP_TX_CSUM | \
272					  NETIF_F_GSO_ESP)
273
274#define MASTER_UPPER_DEV_GSO_PARTIAL_FEATURES (NETIF_F_GSO_ESP)
275
276static inline netdev_features_t netdev_base_features(netdev_features_t features)
277{
278	features &= ~NETIF_F_ONE_FOR_ALL;
279	features |= NETIF_F_ALL_FOR_ALL;
280	return features;
281}
282
283#endif	/* _LINUX_NETDEV_FEATURES_H */