Linux 6.12-rc1
[linux-block.git] / include / linux / netdev_features.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
a59e2ecb
MM
2/*
3 * Network device features.
a59e2ecb
MM
4 */
5#ifndef _LINUX_NETDEV_FEATURES_H
6#define _LINUX_NETDEV_FEATURES_H
7
c8f44aff 8#include <linux/types.h>
8681ef1f 9#include <linux/bitops.h>
3b89ea9c 10#include <asm/byteorder.h>
c8f44aff 11
a861a8b2 12typedef u64 netdev_features_t;
c8f44aff 13
a19f2a6d
MM
14enum {
15 NETIF_F_SG_BIT, /* Scatter/gather IO. */
16 NETIF_F_IP_CSUM_BIT, /* Can checksum TCP/UDP over IPv4. */
34324dc2 17 __UNUSED_NETIF_F_1,
a19f2a6d
MM
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. */
f646968f
PM
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 */
a19f2a6d
MM
25 NETIF_F_VLAN_CHALLENGED_BIT, /* Device cannot handle VLAN packets */
26 NETIF_F_GSO_BIT, /* Enable software GSO. */
00d066a4 27 __UNUSED_NETIF_F_12,
05c1280a 28 __UNUSED_NETIF_F_13,
a19f2a6d
MM
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,
a19f2a6d
MM
35 NETIF_F_GSO_ROBUST_BIT, /* ... ->SKB_GSO_DODGY */
36 NETIF_F_TSO_ECN_BIT, /* ... TCP ECN support */
cbc53e08 37 NETIF_F_TSO_MANGLEID_BIT, /* ... IPV4 ID mangling allowed */
a19f2a6d
MM
38 NETIF_F_TSO6_BIT, /* ... TCPv6 segmentation */
39 NETIF_F_FSO_BIT, /* ... FCoE segmentation */
68c33163 40 NETIF_F_GSO_GRE_BIT, /* ... GRE with TSO */
4749c09c 41 NETIF_F_GSO_GRE_CSUM_BIT, /* ... GRE with csum with TSO */
7e13318d
TH
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 */
73136267 44 NETIF_F_GSO_UDP_TUNNEL_BIT, /* ... UDP TUNNEL with TSO */
0f4f4ffa 45 NETIF_F_GSO_UDP_TUNNEL_CSUM_BIT,/* ... UDP TUNNEL with TSO & CSUM */
802ab55a
AD
46 NETIF_F_GSO_PARTIAL_BIT, /* ... Only segment inner-most L4
47 * in hardware and all other
48 * headers in software.
49 */
e585f236 50 NETIF_F_GSO_TUNNEL_REMCSUM_BIT, /* ... TUNNEL with TSO & REMCSUM */
90017acc 51 NETIF_F_GSO_SCTP_BIT, /* ... SCTP fragmentation */
c7ef8f0c 52 NETIF_F_GSO_ESP_BIT, /* ... ESP with TSO */
0c19f846 53 NETIF_F_GSO_UDP_BIT, /* ... UFO, deprecated except tuntap */
83aa025f 54 NETIF_F_GSO_UDP_L4_BIT, /* ... UDP payload GSO (not UFO) */
3b335832 55 NETIF_F_GSO_FRAGLIST_BIT, /* ... Fraglist GSO */
73136267 56 /**/NETIF_F_GSO_LAST = /* last bit, see GSO_MASK */
3b335832 57 NETIF_F_GSO_FRAGLIST_BIT,
a19f2a6d
MM
58
59 NETIF_F_FCOE_CRC_BIT, /* FCoE CRC32 */
53692b1d 60 NETIF_F_SCTP_CRC_BIT, /* SCTP checksum offload */
782dbbf5 61 __UNUSED_NETIF_F_37,
a19f2a6d
MM
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 */
36eabda3 67 NETIF_F_RXFCS_BIT, /* Append FCS to skb pkt data */
5e0c03c8 68 NETIF_F_RXALL_BIT, /* Receive errored frames too */
4ada8db3
DM
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 */
a6cc0cfa 72 NETIF_F_HW_L2FW_DOFFLOAD_BIT, /* Allow L2 Forwarding in Hardware */
a19f2a6d 73
1c78c64e 74 NETIF_F_HW_TC_BIT, /* Offload TC infrastructure */
c7ef8f0c
SK
75 NETIF_F_HW_ESP_BIT, /* Hardware ESP transformation offload */
76 NETIF_F_HW_ESP_TX_CSUM_BIT, /* ESP with TX checksum offload */
d764a122 77 NETIF_F_RX_UDP_TUNNEL_PORT_BIT, /* Offload of RX port for UDP tunnels */
2342a851 78 NETIF_F_HW_TLS_TX_BIT, /* Hardware TLS TX offload */
14136564 79 NETIF_F_HW_TLS_RX_BIT, /* Hardware TLS RX offload */
1c78c64e 80
fb1f5f79 81 NETIF_F_GRO_HW_BIT, /* Hardware Generic receive offload */
e0be6bea 82 NETIF_F_HW_TLS_RECORD_BIT, /* Offload TLS record */
3b335832 83 NETIF_F_GRO_FRAGLIST_BIT, /* Fraglist GRO */
fb1f5f79 84
5908220b 85 NETIF_F_HW_MACSEC_BIT, /* Offload MACsec operations */
6f1c0ea1 86 NETIF_F_GRO_UDP_FWD_BIT, /* Allow UDP GRO for forwarding */
5908220b 87
dcf0cd1c
GM
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
a19f2a6d
MM
93 /*
94 * Add your fresh new feature above and remember to update
2d8ea148 95 * netdev_features_strings[] in net/ethtool/common.c and maybe
a19f2a6d 96 * some feature mask #defines below. Please also describe it
ea5bacaa 97 * in Documentation/networking/netdev-features.rst.
a19f2a6d 98 */
a59e2ecb 99
a19f2a6d
MM
100 /**/NETDEV_FEATURE_COUNT
101};
a59e2ecb 102
a19f2a6d
MM
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)
a19f2a6d
MM
108#define NETIF_F_FRAGLIST __NETIF_F(FRAGLIST)
109#define NETIF_F_FSO __NETIF_F(FSO)
110#define NETIF_F_GRO __NETIF_F(GRO)
fb1f5f79 111#define NETIF_F_GRO_HW __NETIF_F(GRO_HW)
a19f2a6d
MM
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)
f646968f
PM
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)
a19f2a6d
MM
119#define NETIF_F_IP_CSUM __NETIF_F(IP_CSUM)
120#define NETIF_F_IPV6_CSUM __NETIF_F(IPV6_CSUM)
a19f2a6d
MM
121#define NETIF_F_LOOPBACK __NETIF_F(LOOPBACK)
122#define NETIF_F_LRO __NETIF_F(LRO)
a19f2a6d 123#define NETIF_F_NOCACHE_COPY __NETIF_F(NOCACHE_COPY)
a19f2a6d
MM
124#define NETIF_F_NTUPLE __NETIF_F(NTUPLE)
125#define NETIF_F_RXCSUM __NETIF_F(RXCSUM)
126#define NETIF_F_RXHASH __NETIF_F(RXHASH)
53692b1d 127#define NETIF_F_SCTP_CRC __NETIF_F(SCTP_CRC)
a19f2a6d
MM
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_TSO __NETIF_F(TSO)
a19f2a6d 132#define NETIF_F_VLAN_CHALLENGED __NETIF_F(VLAN_CHALLENGED)
36eabda3 133#define NETIF_F_RXFCS __NETIF_F(RXFCS)
5e0c03c8 134#define NETIF_F_RXALL __NETIF_F(RXALL)
a362db3d 135#define NETIF_F_GSO_GRE __NETIF_F(GSO_GRE)
4749c09c 136#define NETIF_F_GSO_GRE_CSUM __NETIF_F(GSO_GRE_CSUM)
7e13318d
TH
137#define NETIF_F_GSO_IPXIP4 __NETIF_F(GSO_IPXIP4)
138#define NETIF_F_GSO_IPXIP6 __NETIF_F(GSO_IPXIP6)
a362db3d 139#define NETIF_F_GSO_UDP_TUNNEL __NETIF_F(GSO_UDP_TUNNEL)
4b28252c 140#define NETIF_F_GSO_UDP_TUNNEL_CSUM __NETIF_F(GSO_UDP_TUNNEL_CSUM)
cbc53e08 141#define NETIF_F_TSO_MANGLEID __NETIF_F(TSO_MANGLEID)
802ab55a 142#define NETIF_F_GSO_PARTIAL __NETIF_F(GSO_PARTIAL)
e585f236 143#define NETIF_F_GSO_TUNNEL_REMCSUM __NETIF_F(GSO_TUNNEL_REMCSUM)
90017acc 144#define NETIF_F_GSO_SCTP __NETIF_F(GSO_SCTP)
c7ef8f0c 145#define NETIF_F_GSO_ESP __NETIF_F(GSO_ESP)
0c19f846 146#define NETIF_F_GSO_UDP __NETIF_F(GSO_UDP)
4ada8db3
DM
147#define NETIF_F_HW_VLAN_STAG_FILTER __NETIF_F(HW_VLAN_STAG_FILTER)
148#define NETIF_F_HW_VLAN_STAG_RX __NETIF_F(HW_VLAN_STAG_RX)
149#define NETIF_F_HW_VLAN_STAG_TX __NETIF_F(HW_VLAN_STAG_TX)
a6cc0cfa 150#define NETIF_F_HW_L2FW_DOFFLOAD __NETIF_F(HW_L2FW_DOFFLOAD)
1c78c64e 151#define NETIF_F_HW_TC __NETIF_F(HW_TC)
c7ef8f0c
SK
152#define NETIF_F_HW_ESP __NETIF_F(HW_ESP)
153#define NETIF_F_HW_ESP_TX_CSUM __NETIF_F(HW_ESP_TX_CSUM)
d764a122 154#define NETIF_F_RX_UDP_TUNNEL_PORT __NETIF_F(RX_UDP_TUNNEL_PORT)
e0be6bea 155#define NETIF_F_HW_TLS_RECORD __NETIF_F(HW_TLS_RECORD)
83aa025f 156#define NETIF_F_GSO_UDP_L4 __NETIF_F(GSO_UDP_L4)
2342a851 157#define NETIF_F_HW_TLS_TX __NETIF_F(HW_TLS_TX)
14136564 158#define NETIF_F_HW_TLS_RX __NETIF_F(HW_TLS_RX)
3b335832
SK
159#define NETIF_F_GRO_FRAGLIST __NETIF_F(GRO_FRAGLIST)
160#define NETIF_F_GSO_FRAGLIST __NETIF_F(GSO_FRAGLIST)
5908220b 161#define NETIF_F_HW_MACSEC __NETIF_F(HW_MACSEC)
6f1c0ea1 162#define NETIF_F_GRO_UDP_FWD __NETIF_F(GRO_UDP_FWD)
dcf0cd1c
GM
163#define NETIF_F_HW_HSR_TAG_INS __NETIF_F(HW_HSR_TAG_INS)
164#define NETIF_F_HW_HSR_TAG_RM __NETIF_F(HW_HSR_TAG_RM)
165#define NETIF_F_HW_HSR_FWD __NETIF_F(HW_HSR_FWD)
166#define NETIF_F_HW_HSR_DUP __NETIF_F(HW_HSR_DUP)
a59e2ecb 167
85db6352 168/* Finds the next feature with the highest number of the range of start-1 till 0.
3b89ea9c
HM
169 */
170static inline int find_next_netdev_feature(u64 feature, unsigned long start)
171{
172 /* like BITMAP_LAST_WORD_MASK() for u64
173 * this sets the most significant 64 - start to 0.
174 */
175 feature &= ~0ULL >> (-start & ((sizeof(feature) * 8) - 1));
176
177 return fls64(feature) - 1;
178}
179
180/* This goes for the MSB to the LSB through the set feature bits,
181 * mask_addr should be a u64 and bit an int
182 */
183#define for_each_netdev_feature(mask_addr, bit) \
184 for ((bit) = find_next_netdev_feature((mask_addr), \
185 NETDEV_FEATURE_COUNT); \
186 (bit) >= 0; \
85db6352 187 (bit) = find_next_netdev_feature((mask_addr), (bit)))
fd867d51 188
a59e2ecb
MM
189/* Features valid for ethtool to change */
190/* = all defined minus driver/device-class-related */
05c1280a 191#define NETIF_F_NEVER_CHANGE NETIF_F_VLAN_CHALLENGED
a19f2a6d
MM
192
193/* remember that ((t)1 << t_BITS) is undefined in C99 */
194#define NETIF_F_ETHTOOL_BITS ((__NETIF_F_BIT(NETDEV_FEATURE_COUNT - 1) | \
195 (__NETIF_F_BIT(NETDEV_FEATURE_COUNT - 1) - 1)) & \
196 ~NETIF_F_NEVER_CHANGE)
197
198/* Segmentation offload feature mask */
199#define NETIF_F_GSO_MASK (__NETIF_F_BIT(NETIF_F_GSO_LAST + 1) - \
200 __NETIF_F_BIT(NETIF_F_GSO_SHIFT))
a59e2ecb 201
83896b0b 202/* List of IP checksum features. Note that NETIF_F_HW_CSUM should not be
a188222b
TH
203 * set in features when NETIF_F_IP_CSUM or NETIF_F_IPV6_CSUM are set--
204 * this would be contradictory
205 */
c8cd0989
TH
206#define NETIF_F_CSUM_MASK (NETIF_F_IP_CSUM | NETIF_F_IPV6_CSUM | \
207 NETIF_F_HW_CSUM)
a59e2ecb 208
756ca874
AD
209#define NETIF_F_ALL_TSO (NETIF_F_TSO | NETIF_F_TSO6 | \
210 NETIF_F_TSO_ECN | NETIF_F_TSO_MANGLEID)
a59e2ecb 211
b1c20f0b 212/* List of features with software fallbacks. */
2e4ef10f
AL
213#define NETIF_F_GSO_SOFTWARE (NETIF_F_ALL_TSO | NETIF_F_GSO_SCTP | \
214 NETIF_F_GSO_UDP_L4 | NETIF_F_GSO_FRAGLIST)
b1c20f0b 215
a59e2ecb
MM
216/*
217 * If one device supports one of these features, then enable them
218 * for all in netdev_increment_features.
219 */
220#define NETIF_F_ONE_FOR_ALL (NETIF_F_GSO_SOFTWARE | NETIF_F_GSO_ROBUST | \
221 NETIF_F_SG | NETIF_F_HIGHDMA | \
7889cbee 222 NETIF_F_FRAGLIST | NETIF_F_VLAN_CHALLENGED)
aafb3e98 223
a59e2ecb
MM
224/*
225 * If one device doesn't support one of these features, then disable it
226 * for all in netdev_increment_features.
227 */
228#define NETIF_F_ALL_FOR_ALL (NETIF_F_NOCACHE_COPY | NETIF_F_FSO)
229
fd867d51
JW
230/*
231 * If upper/master device has these features disabled, they must be disabled
232 * on all lower/slave devices as well.
233 */
234#define NETIF_F_UPPER_DISABLES NETIF_F_LRO
235
a59e2ecb
MM
236/* changeable features with no special hardware requirements */
237#define NETIF_F_SOFT_FEATURES (NETIF_F_GSO | NETIF_F_GRO)
238
1a3c998f 239/* Changeable features with no special hardware requirements that defaults to off. */
6f1c0ea1 240#define NETIF_F_SOFT_FEATURES_OFF (NETIF_F_GRO_FRAGLIST | NETIF_F_GRO_UDP_FWD)
1a3c998f 241
2adb956b
VY
242#define NETIF_F_VLAN_FEATURES (NETIF_F_HW_VLAN_CTAG_FILTER | \
243 NETIF_F_HW_VLAN_CTAG_RX | \
244 NETIF_F_HW_VLAN_CTAG_TX | \
245 NETIF_F_HW_VLAN_STAG_FILTER | \
246 NETIF_F_HW_VLAN_STAG_RX | \
247 NETIF_F_HW_VLAN_STAG_TX)
248
f6eec614
PS
249#define NETIF_F_GSO_ENCAP_ALL (NETIF_F_GSO_GRE | \
250 NETIF_F_GSO_GRE_CSUM | \
7e13318d
TH
251 NETIF_F_GSO_IPXIP4 | \
252 NETIF_F_GSO_IPXIP6 | \
f6eec614 253 NETIF_F_GSO_UDP_TUNNEL | \
59b93b41 254 NETIF_F_GSO_UDP_TUNNEL_CSUM)
f6eec614 255
a59e2ecb 256#endif /* _LINUX_NETDEV_FEATURES_H */