Linux-libre 5.7.6-gnu
[librecmc/linux-libre.git] / net / ethtool / common.c
1 // SPDX-License-Identifier: GPL-2.0-only
2
3 #include <linux/net_tstamp.h>
4 #include <linux/phy.h>
5
6 #include "common.h"
7
8 const char netdev_features_strings[NETDEV_FEATURE_COUNT][ETH_GSTRING_LEN] = {
9         [NETIF_F_SG_BIT] =               "tx-scatter-gather",
10         [NETIF_F_IP_CSUM_BIT] =          "tx-checksum-ipv4",
11         [NETIF_F_HW_CSUM_BIT] =          "tx-checksum-ip-generic",
12         [NETIF_F_IPV6_CSUM_BIT] =        "tx-checksum-ipv6",
13         [NETIF_F_HIGHDMA_BIT] =          "highdma",
14         [NETIF_F_FRAGLIST_BIT] =         "tx-scatter-gather-fraglist",
15         [NETIF_F_HW_VLAN_CTAG_TX_BIT] =  "tx-vlan-hw-insert",
16
17         [NETIF_F_HW_VLAN_CTAG_RX_BIT] =  "rx-vlan-hw-parse",
18         [NETIF_F_HW_VLAN_CTAG_FILTER_BIT] = "rx-vlan-filter",
19         [NETIF_F_HW_VLAN_STAG_TX_BIT] =  "tx-vlan-stag-hw-insert",
20         [NETIF_F_HW_VLAN_STAG_RX_BIT] =  "rx-vlan-stag-hw-parse",
21         [NETIF_F_HW_VLAN_STAG_FILTER_BIT] = "rx-vlan-stag-filter",
22         [NETIF_F_VLAN_CHALLENGED_BIT] =  "vlan-challenged",
23         [NETIF_F_GSO_BIT] =              "tx-generic-segmentation",
24         [NETIF_F_LLTX_BIT] =             "tx-lockless",
25         [NETIF_F_NETNS_LOCAL_BIT] =      "netns-local",
26         [NETIF_F_GRO_BIT] =              "rx-gro",
27         [NETIF_F_GRO_HW_BIT] =           "rx-gro-hw",
28         [NETIF_F_LRO_BIT] =              "rx-lro",
29
30         [NETIF_F_TSO_BIT] =              "tx-tcp-segmentation",
31         [NETIF_F_GSO_ROBUST_BIT] =       "tx-gso-robust",
32         [NETIF_F_TSO_ECN_BIT] =          "tx-tcp-ecn-segmentation",
33         [NETIF_F_TSO_MANGLEID_BIT] =     "tx-tcp-mangleid-segmentation",
34         [NETIF_F_TSO6_BIT] =             "tx-tcp6-segmentation",
35         [NETIF_F_FSO_BIT] =              "tx-fcoe-segmentation",
36         [NETIF_F_GSO_GRE_BIT] =          "tx-gre-segmentation",
37         [NETIF_F_GSO_GRE_CSUM_BIT] =     "tx-gre-csum-segmentation",
38         [NETIF_F_GSO_IPXIP4_BIT] =       "tx-ipxip4-segmentation",
39         [NETIF_F_GSO_IPXIP6_BIT] =       "tx-ipxip6-segmentation",
40         [NETIF_F_GSO_UDP_TUNNEL_BIT] =   "tx-udp_tnl-segmentation",
41         [NETIF_F_GSO_UDP_TUNNEL_CSUM_BIT] = "tx-udp_tnl-csum-segmentation",
42         [NETIF_F_GSO_PARTIAL_BIT] =      "tx-gso-partial",
43         [NETIF_F_GSO_SCTP_BIT] =         "tx-sctp-segmentation",
44         [NETIF_F_GSO_ESP_BIT] =          "tx-esp-segmentation",
45         [NETIF_F_GSO_UDP_L4_BIT] =       "tx-udp-segmentation",
46
47         [NETIF_F_FCOE_CRC_BIT] =         "tx-checksum-fcoe-crc",
48         [NETIF_F_SCTP_CRC_BIT] =        "tx-checksum-sctp",
49         [NETIF_F_FCOE_MTU_BIT] =         "fcoe-mtu",
50         [NETIF_F_NTUPLE_BIT] =           "rx-ntuple-filter",
51         [NETIF_F_RXHASH_BIT] =           "rx-hashing",
52         [NETIF_F_RXCSUM_BIT] =           "rx-checksum",
53         [NETIF_F_NOCACHE_COPY_BIT] =     "tx-nocache-copy",
54         [NETIF_F_LOOPBACK_BIT] =         "loopback",
55         [NETIF_F_RXFCS_BIT] =            "rx-fcs",
56         [NETIF_F_RXALL_BIT] =            "rx-all",
57         [NETIF_F_HW_L2FW_DOFFLOAD_BIT] = "l2-fwd-offload",
58         [NETIF_F_HW_TC_BIT] =            "hw-tc-offload",
59         [NETIF_F_HW_ESP_BIT] =           "esp-hw-offload",
60         [NETIF_F_HW_ESP_TX_CSUM_BIT] =   "esp-tx-csum-hw-offload",
61         [NETIF_F_RX_UDP_TUNNEL_PORT_BIT] =       "rx-udp_tunnel-port-offload",
62         [NETIF_F_HW_TLS_RECORD_BIT] =   "tls-hw-record",
63         [NETIF_F_HW_TLS_TX_BIT] =        "tls-hw-tx-offload",
64         [NETIF_F_HW_TLS_RX_BIT] =        "tls-hw-rx-offload",
65         [NETIF_F_GRO_FRAGLIST_BIT] =     "rx-gro-list",
66         [NETIF_F_HW_MACSEC_BIT] =        "macsec-hw-offload",
67 };
68
69 const char
70 rss_hash_func_strings[ETH_RSS_HASH_FUNCS_COUNT][ETH_GSTRING_LEN] = {
71         [ETH_RSS_HASH_TOP_BIT] =        "toeplitz",
72         [ETH_RSS_HASH_XOR_BIT] =        "xor",
73         [ETH_RSS_HASH_CRC32_BIT] =      "crc32",
74 };
75
76 const char
77 tunable_strings[__ETHTOOL_TUNABLE_COUNT][ETH_GSTRING_LEN] = {
78         [ETHTOOL_ID_UNSPEC]     = "Unspec",
79         [ETHTOOL_RX_COPYBREAK]  = "rx-copybreak",
80         [ETHTOOL_TX_COPYBREAK]  = "tx-copybreak",
81         [ETHTOOL_PFC_PREVENTION_TOUT] = "pfc-prevention-tout",
82 };
83
84 const char
85 phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN] = {
86         [ETHTOOL_ID_UNSPEC]     = "Unspec",
87         [ETHTOOL_PHY_DOWNSHIFT] = "phy-downshift",
88         [ETHTOOL_PHY_FAST_LINK_DOWN] = "phy-fast-link-down",
89         [ETHTOOL_PHY_EDPD]      = "phy-energy-detect-power-down",
90 };
91
92 #define __LINK_MODE_NAME(speed, type, duplex) \
93         #speed "base" #type "/" #duplex
94 #define __DEFINE_LINK_MODE_NAME(speed, type, duplex) \
95         [ETHTOOL_LINK_MODE(speed, type, duplex)] = \
96         __LINK_MODE_NAME(speed, type, duplex)
97 #define __DEFINE_SPECIAL_MODE_NAME(_mode, _name) \
98         [ETHTOOL_LINK_MODE_ ## _mode ## _BIT] = _name
99
100 const char link_mode_names[][ETH_GSTRING_LEN] = {
101         __DEFINE_LINK_MODE_NAME(10, T, Half),
102         __DEFINE_LINK_MODE_NAME(10, T, Full),
103         __DEFINE_LINK_MODE_NAME(100, T, Half),
104         __DEFINE_LINK_MODE_NAME(100, T, Full),
105         __DEFINE_LINK_MODE_NAME(1000, T, Half),
106         __DEFINE_LINK_MODE_NAME(1000, T, Full),
107         __DEFINE_SPECIAL_MODE_NAME(Autoneg, "Autoneg"),
108         __DEFINE_SPECIAL_MODE_NAME(TP, "TP"),
109         __DEFINE_SPECIAL_MODE_NAME(AUI, "AUI"),
110         __DEFINE_SPECIAL_MODE_NAME(MII, "MII"),
111         __DEFINE_SPECIAL_MODE_NAME(FIBRE, "FIBRE"),
112         __DEFINE_SPECIAL_MODE_NAME(BNC, "BNC"),
113         __DEFINE_LINK_MODE_NAME(10000, T, Full),
114         __DEFINE_SPECIAL_MODE_NAME(Pause, "Pause"),
115         __DEFINE_SPECIAL_MODE_NAME(Asym_Pause, "Asym_Pause"),
116         __DEFINE_LINK_MODE_NAME(2500, X, Full),
117         __DEFINE_SPECIAL_MODE_NAME(Backplane, "Backplane"),
118         __DEFINE_LINK_MODE_NAME(1000, KX, Full),
119         __DEFINE_LINK_MODE_NAME(10000, KX4, Full),
120         __DEFINE_LINK_MODE_NAME(10000, KR, Full),
121         __DEFINE_SPECIAL_MODE_NAME(10000baseR_FEC, "10000baseR_FEC"),
122         __DEFINE_LINK_MODE_NAME(20000, MLD2, Full),
123         __DEFINE_LINK_MODE_NAME(20000, KR2, Full),
124         __DEFINE_LINK_MODE_NAME(40000, KR4, Full),
125         __DEFINE_LINK_MODE_NAME(40000, CR4, Full),
126         __DEFINE_LINK_MODE_NAME(40000, SR4, Full),
127         __DEFINE_LINK_MODE_NAME(40000, LR4, Full),
128         __DEFINE_LINK_MODE_NAME(56000, KR4, Full),
129         __DEFINE_LINK_MODE_NAME(56000, CR4, Full),
130         __DEFINE_LINK_MODE_NAME(56000, SR4, Full),
131         __DEFINE_LINK_MODE_NAME(56000, LR4, Full),
132         __DEFINE_LINK_MODE_NAME(25000, CR, Full),
133         __DEFINE_LINK_MODE_NAME(25000, KR, Full),
134         __DEFINE_LINK_MODE_NAME(25000, SR, Full),
135         __DEFINE_LINK_MODE_NAME(50000, CR2, Full),
136         __DEFINE_LINK_MODE_NAME(50000, KR2, Full),
137         __DEFINE_LINK_MODE_NAME(100000, KR4, Full),
138         __DEFINE_LINK_MODE_NAME(100000, SR4, Full),
139         __DEFINE_LINK_MODE_NAME(100000, CR4, Full),
140         __DEFINE_LINK_MODE_NAME(100000, LR4_ER4, Full),
141         __DEFINE_LINK_MODE_NAME(50000, SR2, Full),
142         __DEFINE_LINK_MODE_NAME(1000, X, Full),
143         __DEFINE_LINK_MODE_NAME(10000, CR, Full),
144         __DEFINE_LINK_MODE_NAME(10000, SR, Full),
145         __DEFINE_LINK_MODE_NAME(10000, LR, Full),
146         __DEFINE_LINK_MODE_NAME(10000, LRM, Full),
147         __DEFINE_LINK_MODE_NAME(10000, ER, Full),
148         __DEFINE_LINK_MODE_NAME(2500, T, Full),
149         __DEFINE_LINK_MODE_NAME(5000, T, Full),
150         __DEFINE_SPECIAL_MODE_NAME(FEC_NONE, "None"),
151         __DEFINE_SPECIAL_MODE_NAME(FEC_RS, "RS"),
152         __DEFINE_SPECIAL_MODE_NAME(FEC_BASER, "BASER"),
153         __DEFINE_LINK_MODE_NAME(50000, KR, Full),
154         __DEFINE_LINK_MODE_NAME(50000, SR, Full),
155         __DEFINE_LINK_MODE_NAME(50000, CR, Full),
156         __DEFINE_LINK_MODE_NAME(50000, LR_ER_FR, Full),
157         __DEFINE_LINK_MODE_NAME(50000, DR, Full),
158         __DEFINE_LINK_MODE_NAME(100000, KR2, Full),
159         __DEFINE_LINK_MODE_NAME(100000, SR2, Full),
160         __DEFINE_LINK_MODE_NAME(100000, CR2, Full),
161         __DEFINE_LINK_MODE_NAME(100000, LR2_ER2_FR2, Full),
162         __DEFINE_LINK_MODE_NAME(100000, DR2, Full),
163         __DEFINE_LINK_MODE_NAME(200000, KR4, Full),
164         __DEFINE_LINK_MODE_NAME(200000, SR4, Full),
165         __DEFINE_LINK_MODE_NAME(200000, LR4_ER4_FR4, Full),
166         __DEFINE_LINK_MODE_NAME(200000, DR4, Full),
167         __DEFINE_LINK_MODE_NAME(200000, CR4, Full),
168         __DEFINE_LINK_MODE_NAME(100, T1, Full),
169         __DEFINE_LINK_MODE_NAME(1000, T1, Full),
170         __DEFINE_LINK_MODE_NAME(400000, KR8, Full),
171         __DEFINE_LINK_MODE_NAME(400000, SR8, Full),
172         __DEFINE_LINK_MODE_NAME(400000, LR8_ER8_FR8, Full),
173         __DEFINE_LINK_MODE_NAME(400000, DR8, Full),
174         __DEFINE_LINK_MODE_NAME(400000, CR8, Full),
175         __DEFINE_SPECIAL_MODE_NAME(FEC_LLRS, "LLRS"),
176 };
177 static_assert(ARRAY_SIZE(link_mode_names) == __ETHTOOL_LINK_MODE_MASK_NBITS);
178
179 const char netif_msg_class_names[][ETH_GSTRING_LEN] = {
180         [NETIF_MSG_DRV_BIT]             = "drv",
181         [NETIF_MSG_PROBE_BIT]           = "probe",
182         [NETIF_MSG_LINK_BIT]            = "link",
183         [NETIF_MSG_TIMER_BIT]           = "timer",
184         [NETIF_MSG_IFDOWN_BIT]          = "ifdown",
185         [NETIF_MSG_IFUP_BIT]            = "ifup",
186         [NETIF_MSG_RX_ERR_BIT]          = "rx_err",
187         [NETIF_MSG_TX_ERR_BIT]          = "tx_err",
188         [NETIF_MSG_TX_QUEUED_BIT]       = "tx_queued",
189         [NETIF_MSG_INTR_BIT]            = "intr",
190         [NETIF_MSG_TX_DONE_BIT]         = "tx_done",
191         [NETIF_MSG_RX_STATUS_BIT]       = "rx_status",
192         [NETIF_MSG_PKTDATA_BIT]         = "pktdata",
193         [NETIF_MSG_HW_BIT]              = "hw",
194         [NETIF_MSG_WOL_BIT]             = "wol",
195 };
196 static_assert(ARRAY_SIZE(netif_msg_class_names) == NETIF_MSG_CLASS_COUNT);
197
198 const char wol_mode_names[][ETH_GSTRING_LEN] = {
199         [const_ilog2(WAKE_PHY)]         = "phy",
200         [const_ilog2(WAKE_UCAST)]       = "ucast",
201         [const_ilog2(WAKE_MCAST)]       = "mcast",
202         [const_ilog2(WAKE_BCAST)]       = "bcast",
203         [const_ilog2(WAKE_ARP)]         = "arp",
204         [const_ilog2(WAKE_MAGIC)]       = "magic",
205         [const_ilog2(WAKE_MAGICSECURE)] = "magicsecure",
206         [const_ilog2(WAKE_FILTER)]      = "filter",
207 };
208 static_assert(ARRAY_SIZE(wol_mode_names) == WOL_MODE_COUNT);
209
210 const char sof_timestamping_names[][ETH_GSTRING_LEN] = {
211         [const_ilog2(SOF_TIMESTAMPING_TX_HARDWARE)]  = "hardware-transmit",
212         [const_ilog2(SOF_TIMESTAMPING_TX_SOFTWARE)]  = "software-transmit",
213         [const_ilog2(SOF_TIMESTAMPING_RX_HARDWARE)]  = "hardware-receive",
214         [const_ilog2(SOF_TIMESTAMPING_RX_SOFTWARE)]  = "software-receive",
215         [const_ilog2(SOF_TIMESTAMPING_SOFTWARE)]     = "software-system-clock",
216         [const_ilog2(SOF_TIMESTAMPING_SYS_HARDWARE)] = "hardware-legacy-clock",
217         [const_ilog2(SOF_TIMESTAMPING_RAW_HARDWARE)] = "hardware-raw-clock",
218         [const_ilog2(SOF_TIMESTAMPING_OPT_ID)]       = "option-id",
219         [const_ilog2(SOF_TIMESTAMPING_TX_SCHED)]     = "sched-transmit",
220         [const_ilog2(SOF_TIMESTAMPING_TX_ACK)]       = "ack-transmit",
221         [const_ilog2(SOF_TIMESTAMPING_OPT_CMSG)]     = "option-cmsg",
222         [const_ilog2(SOF_TIMESTAMPING_OPT_TSONLY)]   = "option-tsonly",
223         [const_ilog2(SOF_TIMESTAMPING_OPT_STATS)]    = "option-stats",
224         [const_ilog2(SOF_TIMESTAMPING_OPT_PKTINFO)]  = "option-pktinfo",
225         [const_ilog2(SOF_TIMESTAMPING_OPT_TX_SWHW)]  = "option-tx-swhw",
226 };
227 static_assert(ARRAY_SIZE(sof_timestamping_names) == __SOF_TIMESTAMPING_CNT);
228
229 const char ts_tx_type_names[][ETH_GSTRING_LEN] = {
230         [HWTSTAMP_TX_OFF]               = "off",
231         [HWTSTAMP_TX_ON]                = "on",
232         [HWTSTAMP_TX_ONESTEP_SYNC]      = "onestep-sync",
233         [HWTSTAMP_TX_ONESTEP_P2P]       = "onestep-p2p",
234 };
235 static_assert(ARRAY_SIZE(ts_tx_type_names) == __HWTSTAMP_TX_CNT);
236
237 const char ts_rx_filter_names[][ETH_GSTRING_LEN] = {
238         [HWTSTAMP_FILTER_NONE]                  = "none",
239         [HWTSTAMP_FILTER_ALL]                   = "all",
240         [HWTSTAMP_FILTER_SOME]                  = "some",
241         [HWTSTAMP_FILTER_PTP_V1_L4_EVENT]       = "ptpv1-l4-event",
242         [HWTSTAMP_FILTER_PTP_V1_L4_SYNC]        = "ptpv1-l4-sync",
243         [HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ]   = "ptpv1-l4-delay-req",
244         [HWTSTAMP_FILTER_PTP_V2_L4_EVENT]       = "ptpv2-l4-event",
245         [HWTSTAMP_FILTER_PTP_V2_L4_SYNC]        = "ptpv2-l4-sync",
246         [HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ]   = "ptpv2-l4-delay-req",
247         [HWTSTAMP_FILTER_PTP_V2_L2_EVENT]       = "ptpv2-l2-event",
248         [HWTSTAMP_FILTER_PTP_V2_L2_SYNC]        = "ptpv2-l2-sync",
249         [HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ]   = "ptpv2-l2-delay-req",
250         [HWTSTAMP_FILTER_PTP_V2_EVENT]          = "ptpv2-event",
251         [HWTSTAMP_FILTER_PTP_V2_SYNC]           = "ptpv2-sync",
252         [HWTSTAMP_FILTER_PTP_V2_DELAY_REQ]      = "ptpv2-delay-req",
253         [HWTSTAMP_FILTER_NTP_ALL]               = "ntp-all",
254 };
255 static_assert(ARRAY_SIZE(ts_rx_filter_names) == __HWTSTAMP_FILTER_CNT);
256
257 /* return false if legacy contained non-0 deprecated fields
258  * maxtxpkt/maxrxpkt. rest of ksettings always updated
259  */
260 bool
261 convert_legacy_settings_to_link_ksettings(
262         struct ethtool_link_ksettings *link_ksettings,
263         const struct ethtool_cmd *legacy_settings)
264 {
265         bool retval = true;
266
267         memset(link_ksettings, 0, sizeof(*link_ksettings));
268
269         /* This is used to tell users that driver is still using these
270          * deprecated legacy fields, and they should not use
271          * %ETHTOOL_GLINKSETTINGS/%ETHTOOL_SLINKSETTINGS
272          */
273         if (legacy_settings->maxtxpkt ||
274             legacy_settings->maxrxpkt)
275                 retval = false;
276
277         ethtool_convert_legacy_u32_to_link_mode(
278                 link_ksettings->link_modes.supported,
279                 legacy_settings->supported);
280         ethtool_convert_legacy_u32_to_link_mode(
281                 link_ksettings->link_modes.advertising,
282                 legacy_settings->advertising);
283         ethtool_convert_legacy_u32_to_link_mode(
284                 link_ksettings->link_modes.lp_advertising,
285                 legacy_settings->lp_advertising);
286         link_ksettings->base.speed
287                 = ethtool_cmd_speed(legacy_settings);
288         link_ksettings->base.duplex
289                 = legacy_settings->duplex;
290         link_ksettings->base.port
291                 = legacy_settings->port;
292         link_ksettings->base.phy_address
293                 = legacy_settings->phy_address;
294         link_ksettings->base.autoneg
295                 = legacy_settings->autoneg;
296         link_ksettings->base.mdio_support
297                 = legacy_settings->mdio_support;
298         link_ksettings->base.eth_tp_mdix
299                 = legacy_settings->eth_tp_mdix;
300         link_ksettings->base.eth_tp_mdix_ctrl
301                 = legacy_settings->eth_tp_mdix_ctrl;
302         return retval;
303 }
304
305 int __ethtool_get_link(struct net_device *dev)
306 {
307         if (!dev->ethtool_ops->get_link)
308                 return -EOPNOTSUPP;
309
310         return netif_running(dev) && dev->ethtool_ops->get_link(dev);
311 }
312
313 int ethtool_get_max_rxfh_channel(struct net_device *dev, u32 *max)
314 {
315         u32 dev_size, current_max = 0;
316         u32 *indir;
317         int ret;
318
319         if (!dev->ethtool_ops->get_rxfh_indir_size ||
320             !dev->ethtool_ops->get_rxfh)
321                 return -EOPNOTSUPP;
322         dev_size = dev->ethtool_ops->get_rxfh_indir_size(dev);
323         if (dev_size == 0)
324                 return -EOPNOTSUPP;
325
326         indir = kcalloc(dev_size, sizeof(indir[0]), GFP_USER);
327         if (!indir)
328                 return -ENOMEM;
329
330         ret = dev->ethtool_ops->get_rxfh(dev, indir, NULL, NULL);
331         if (ret)
332                 goto out;
333
334         while (dev_size--)
335                 current_max = max(current_max, indir[dev_size]);
336
337         *max = current_max;
338
339 out:
340         kfree(indir);
341         return ret;
342 }
343
344 int ethtool_check_ops(const struct ethtool_ops *ops)
345 {
346         if (WARN_ON(ops->set_coalesce && !ops->supported_coalesce_params))
347                 return -EINVAL;
348         /* NOTE: sufficiently insane drivers may swap ethtool_ops at runtime,
349          * the fact that ops are checked at registration time does not
350          * mean the ops attached to a netdev later on are sane.
351          */
352         return 0;
353 }
354
355 int __ethtool_get_ts_info(struct net_device *dev, struct ethtool_ts_info *info)
356 {
357         const struct ethtool_ops *ops = dev->ethtool_ops;
358         struct phy_device *phydev = dev->phydev;
359
360         memset(info, 0, sizeof(*info));
361         info->cmd = ETHTOOL_GET_TS_INFO;
362
363         if (phy_has_tsinfo(phydev))
364                 return phy_ts_info(phydev, info);
365         if (ops->get_ts_info)
366                 return ops->get_ts_info(dev, info);
367
368         info->so_timestamping = SOF_TIMESTAMPING_RX_SOFTWARE |
369                                 SOF_TIMESTAMPING_SOFTWARE;
370         info->phc_index = -1;
371
372         return 0;
373 }