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