xref: /linux/include/uapi/linux/ethtool.h (revision 37a93dd5c49b5fda807fd204edf2547c3493319c)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * ethtool.h: Defines for Linux ethtool.
4  *
5  * Copyright (C) 1998 David S. Miller (davem@redhat.com)
6  * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
7  * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
8  * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
9  *                                christopher.leech@intel.com,
10  *                                scott.feldman@intel.com)
11  * Portions Copyright (C) Sun Microsystems 2008
12  */
13 
14 #ifndef _UAPI_LINUX_ETHTOOL_H
15 #define _UAPI_LINUX_ETHTOOL_H
16 
17 #include <linux/const.h>
18 #include <linux/typelimits.h>
19 #include <linux/types.h>
20 #include <linux/if_ether.h>
21 
22 /* All structures exposed to userland should be defined such that they
23  * have the same layout for 32-bit and 64-bit userland.
24  */
25 
26 /* Note on reserved space.
27  * Reserved fields must not be accessed directly by user space because
28  * they may be replaced by a different field in the future. They must
29  * be initialized to zero before making the request, e.g. via memset
30  * of the entire structure or implicitly by not being set in a structure
31  * initializer.
32  */
33 
34 /**
35  * struct ethtool_cmd - DEPRECATED, link control and status
36  * This structure is DEPRECATED, please use struct ethtool_link_settings.
37  * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET
38  * @supported: Bitmask of %SUPPORTED_* flags for the link modes,
39  *	physical connectors and other link features for which the
40  *	interface supports autonegotiation or auto-detection.
41  *	Read-only.
42  * @advertising: Bitmask of %ADVERTISED_* flags for the link modes,
43  *	physical connectors and other link features that are
44  *	advertised through autonegotiation or enabled for
45  *	auto-detection.
46  * @speed: Low bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
47  * @duplex: Duplex mode; one of %DUPLEX_*
48  * @port: Physical connector type; one of %PORT_*
49  * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
50  *	applicable.  For clause 45 PHYs this is the PRTAD.
51  * @transceiver: Historically used to distinguish different possible
52  *	PHY types, but not in a consistent way.  Deprecated.
53  * @autoneg: Enable/disable autonegotiation and auto-detection;
54  *	either %AUTONEG_DISABLE or %AUTONEG_ENABLE
55  * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
56  *	protocols supported by the interface; 0 if unknown.
57  *	Read-only.
58  * @maxtxpkt: Historically used to report TX IRQ coalescing; now
59  *	obsoleted by &struct ethtool_coalesce.  Read-only; deprecated.
60  * @maxrxpkt: Historically used to report RX IRQ coalescing; now
61  *	obsoleted by &struct ethtool_coalesce.  Read-only; deprecated.
62  * @speed_hi: High bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
63  * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
64  *	%ETH_TP_MDI_*.  If the status is unknown or not applicable, the
65  *	value will be %ETH_TP_MDI_INVALID.  Read-only.
66  * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
67  *	%ETH_TP_MDI_*.  If MDI(-X) control is not implemented, reads
68  *	yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
69  *	When written successfully, the link should be renegotiated if
70  *	necessary.
71  * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes
72  *	and other link features that the link partner advertised
73  *	through autonegotiation; 0 if unknown or not applicable.
74  *	Read-only.
75  * @reserved: Reserved for future use; see the note on reserved space.
76  *
77  * The link speed in Mbps is split between @speed and @speed_hi.  Use
78  * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to
79  * access it.
80  *
81  * If autonegotiation is disabled, the speed and @duplex represent the
82  * fixed link mode and are writable if the driver supports multiple
83  * link modes.  If it is enabled then they are read-only; if the link
84  * is up they represent the negotiated link mode; if the link is down,
85  * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
86  * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
87  *
88  * Some hardware interfaces may have multiple PHYs and/or physical
89  * connectors fitted or do not allow the driver to detect which are
90  * fitted.  For these interfaces @port and/or @phy_address may be
91  * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
92  * Otherwise, attempts to write different values may be ignored or
93  * rejected.
94  *
95  * Users should assume that all fields not marked read-only are
96  * writable and subject to validation by the driver.  They should use
97  * %ETHTOOL_GSET to get the current values before making specific
98  * changes and then applying them with %ETHTOOL_SSET.
99  *
100  * Deprecated fields should be ignored by both users and drivers.
101  */
102 struct ethtool_cmd {
103 	__u32	cmd;
104 	__u32	supported;
105 	__u32	advertising;
106 	__u16	speed;
107 	__u8	duplex;
108 	__u8	port;
109 	__u8	phy_address;
110 	__u8	transceiver;
111 	__u8	autoneg;
112 	__u8	mdio_support;
113 	__u32	maxtxpkt;
114 	__u32	maxrxpkt;
115 	__u16	speed_hi;
116 	__u8	eth_tp_mdix;
117 	__u8	eth_tp_mdix_ctrl;
118 	__u32	lp_advertising;
119 	__u32	reserved[2];
120 };
121 
ethtool_cmd_speed_set(struct ethtool_cmd * ep,__u32 speed)122 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
123 					 __u32 speed)
124 {
125 	ep->speed = (__u16)(speed & 0xFFFF);
126 	ep->speed_hi = (__u16)(speed >> 16);
127 }
128 
ethtool_cmd_speed(const struct ethtool_cmd * ep)129 static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
130 {
131 	return (ep->speed_hi << 16) | ep->speed;
132 }
133 
134 /* Device supports clause 22 register access to PHY or peripherals
135  * using the interface defined in <linux/mii.h>.  This should not be
136  * set if there are known to be no such peripherals present or if
137  * the driver only emulates clause 22 registers for compatibility.
138  */
139 #define ETH_MDIO_SUPPORTS_C22	1
140 
141 /* Device supports clause 45 register access to PHY or peripherals
142  * using the interface defined in <linux/mii.h> and <linux/mdio.h>.
143  * This should not be set if there are known to be no such peripherals
144  * present.
145  */
146 #define ETH_MDIO_SUPPORTS_C45	2
147 
148 #define ETHTOOL_FWVERS_LEN	32
149 #define ETHTOOL_BUSINFO_LEN	32
150 #define ETHTOOL_EROMVERS_LEN	32
151 
152 /**
153  * struct ethtool_drvinfo - general driver and device information
154  * @cmd: Command number = %ETHTOOL_GDRVINFO
155  * @driver: Driver short name.  This should normally match the name
156  *	in its bus driver structure (e.g. pci_driver::name).  Must
157  *	not be an empty string.
158  * @version: Driver version string; may be an empty string
159  * @fw_version: Firmware version string; driver defined; may be an
160  *	empty string
161  * @erom_version: Expansion ROM version string; driver defined; may be
162  *	an empty string
163  * @bus_info: Device bus address.  This should match the dev_name()
164  *	string for the underlying bus device, if there is one.  May be
165  *	an empty string.
166  * @reserved2: Reserved for future use; see the note on reserved space.
167  * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and
168  *	%ETHTOOL_SPFLAGS commands; also the number of strings in the
169  *	%ETH_SS_PRIV_FLAGS set
170  * @n_stats: Number of u64 statistics returned by the %ETHTOOL_GSTATS
171  *	command; also the number of strings in the %ETH_SS_STATS set
172  * @testinfo_len: Number of results returned by the %ETHTOOL_TEST
173  *	command; also the number of strings in the %ETH_SS_TEST set
174  * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM
175  *	and %ETHTOOL_SEEPROM commands, in bytes
176  * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS
177  *	command, in bytes
178  *
179  * Users can use the %ETHTOOL_GSSET_INFO command to get the number of
180  * strings in any string set (from Linux 2.6.34).
181  */
182 struct ethtool_drvinfo {
183 	__u32	cmd;
184 	char	driver[32];
185 	char	version[32];
186 	char	fw_version[ETHTOOL_FWVERS_LEN];
187 	char	bus_info[ETHTOOL_BUSINFO_LEN];
188 	char	erom_version[ETHTOOL_EROMVERS_LEN];
189 	char	reserved2[12];
190 	__u32	n_priv_flags;
191 	__u32	n_stats;
192 	__u32	testinfo_len;
193 	__u32	eedump_len;
194 	__u32	regdump_len;
195 };
196 
197 #define SOPASS_MAX	6
198 
199 /**
200  * struct ethtool_wolinfo - Wake-On-Lan configuration
201  * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL
202  * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes.
203  *	Read-only.
204  * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
205  * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE
206  *	is set in @wolopts.
207  */
208 struct ethtool_wolinfo {
209 	__u32	cmd;
210 	__u32	supported;
211 	__u32	wolopts;
212 	__u8	sopass[SOPASS_MAX];
213 };
214 
215 /* for passing single values */
216 struct ethtool_value {
217 	__u32	cmd;
218 	__u32	data;
219 };
220 
221 #define PFC_STORM_PREVENTION_AUTO	0xffff
222 #define PFC_STORM_PREVENTION_DISABLE	0
223 
224 enum tunable_id {
225 	ETHTOOL_ID_UNSPEC,
226 	ETHTOOL_RX_COPYBREAK,
227 	ETHTOOL_TX_COPYBREAK,
228 	ETHTOOL_PFC_PREVENTION_TOUT, /* timeout in msecs */
229 	ETHTOOL_TX_COPYBREAK_BUF_SIZE,
230 	/*
231 	 * Add your fresh new tunable attribute above and remember to update
232 	 * tunable_strings[] in net/ethtool/common.c
233 	 */
234 	__ETHTOOL_TUNABLE_COUNT,
235 };
236 
237 enum tunable_type_id {
238 	ETHTOOL_TUNABLE_UNSPEC,
239 	ETHTOOL_TUNABLE_U8,
240 	ETHTOOL_TUNABLE_U16,
241 	ETHTOOL_TUNABLE_U32,
242 	ETHTOOL_TUNABLE_U64,
243 	ETHTOOL_TUNABLE_STRING,
244 	ETHTOOL_TUNABLE_S8,
245 	ETHTOOL_TUNABLE_S16,
246 	ETHTOOL_TUNABLE_S32,
247 	ETHTOOL_TUNABLE_S64,
248 };
249 
250 struct ethtool_tunable {
251 	__u32	cmd;
252 	__u32	id;
253 	__u32	type_id;
254 	__u32	len;
255 	void	*data[];
256 };
257 
258 #define DOWNSHIFT_DEV_DEFAULT_COUNT	0xff
259 #define DOWNSHIFT_DEV_DISABLE		0
260 
261 /* Time in msecs after which link is reported as down
262  * 0 = lowest time supported by the PHY
263  * 0xff = off, link down detection according to standard
264  */
265 #define ETHTOOL_PHY_FAST_LINK_DOWN_ON	0
266 #define ETHTOOL_PHY_FAST_LINK_DOWN_OFF	0xff
267 
268 /* Energy Detect Power Down (EDPD) is a feature supported by some PHYs, where
269  * the PHY's RX & TX blocks are put into a low-power mode when there is no
270  * link detected (typically cable is un-plugged). For RX, only a minimal
271  * link-detection is available, and for TX the PHY wakes up to send link pulses
272  * to avoid any lock-ups in case the peer PHY may also be running in EDPD mode.
273  *
274  * Some PHYs may support configuration of the wake-up interval for TX pulses,
275  * and some PHYs may support only disabling TX pulses entirely. For the latter
276  * a special value is required (ETHTOOL_PHY_EDPD_NO_TX) so that this can be
277  * configured from userspace (should the user want it).
278  *
279  * The interval units for TX wake-up are in milliseconds, since this should
280  * cover a reasonable range of intervals:
281  *  - from 1 millisecond, which does not sound like much of a power-saver
282  *  - to ~65 seconds which is quite a lot to wait for a link to come up when
283  *    plugging a cable
284  */
285 #define ETHTOOL_PHY_EDPD_DFLT_TX_MSECS		0xffff
286 #define ETHTOOL_PHY_EDPD_NO_TX			0xfffe
287 #define ETHTOOL_PHY_EDPD_DISABLE		0
288 
289 enum phy_tunable_id {
290 	ETHTOOL_PHY_ID_UNSPEC,
291 	ETHTOOL_PHY_DOWNSHIFT,
292 	ETHTOOL_PHY_FAST_LINK_DOWN,
293 	ETHTOOL_PHY_EDPD,
294 	/*
295 	 * Add your fresh new phy tunable attribute above and remember to update
296 	 * phy_tunable_strings[] in net/ethtool/common.c
297 	 */
298 	__ETHTOOL_PHY_TUNABLE_COUNT,
299 };
300 
301 /**
302  * struct ethtool_regs - hardware register dump
303  * @cmd: Command number = %ETHTOOL_GREGS
304  * @version: Dump format version.  This is driver-specific and may
305  *	distinguish different chips/revisions.  Drivers must use new
306  *	version numbers whenever the dump format changes in an
307  *	incompatible way.
308  * @len: On entry, the real length of @data.  On return, the number of
309  *	bytes used.
310  * @data: Buffer for the register dump
311  *
312  * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
313  * a register dump for the interface.  They must allocate the buffer
314  * immediately following this structure.
315  */
316 struct ethtool_regs {
317 	__u32	cmd;
318 	__u32	version;
319 	__u32	len;
320 	__u8	data[];
321 };
322 
323 /**
324  * struct ethtool_eeprom - EEPROM dump
325  * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or
326  *	%ETHTOOL_SEEPROM
327  * @magic: A 'magic cookie' value to guard against accidental changes.
328  *	The value passed in to %ETHTOOL_SEEPROM must match the value
329  *	returned by %ETHTOOL_GEEPROM for the same device.  This is
330  *	unused when @cmd is %ETHTOOL_GMODULEEEPROM.
331  * @offset: Offset within the EEPROM to begin reading/writing, in bytes
332  * @len: On entry, number of bytes to read/write.  On successful
333  *	return, number of bytes actually read/written.  In case of
334  *	error, this may indicate at what point the error occurred.
335  * @data: Buffer to read/write from
336  *
337  * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find
338  * the length of an on-board or module EEPROM, respectively.  They
339  * must allocate the buffer immediately following this structure.
340  */
341 struct ethtool_eeprom {
342 	__u32	cmd;
343 	__u32	magic;
344 	__u32	offset;
345 	__u32	len;
346 	__u8	data[];
347 };
348 
349 /**
350  * struct ethtool_eee - Energy Efficient Ethernet information
351  * @cmd: ETHTOOL_{G,S}EEE
352  * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
353  *	for which there is EEE support.
354  * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
355  *	advertised as eee capable.
356  * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
357  *	combinations advertised by the link partner as eee capable.
358  * @eee_active: Result of the eee auto negotiation.
359  * @eee_enabled: EEE configured mode (enabled/disabled).
360  * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
361  *	that eee was negotiated.
362  * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
363  *	its tx lpi (after reaching 'idle' state). Effective only when eee
364  *	was negotiated and tx_lpi_enabled was set.
365  * @reserved: Reserved for future use; see the note on reserved space.
366  */
367 struct ethtool_eee {
368 	__u32	cmd;
369 	__u32	supported;
370 	__u32	advertised;
371 	__u32	lp_advertised;
372 	__u32	eee_active;
373 	__u32	eee_enabled;
374 	__u32	tx_lpi_enabled;
375 	__u32	tx_lpi_timer;
376 	__u32	reserved[2];
377 };
378 
379 /**
380  * struct ethtool_modinfo - plugin module eeprom information
381  * @cmd: %ETHTOOL_GMODULEINFO
382  * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
383  * @eeprom_len: Length of the eeprom
384  * @reserved: Reserved for future use; see the note on reserved space.
385  *
386  * This structure is used to return the information to
387  * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
388  * The type code indicates the eeprom data format
389  */
390 struct ethtool_modinfo {
391 	__u32   cmd;
392 	__u32   type;
393 	__u32   eeprom_len;
394 	__u32   reserved[8];
395 };
396 
397 /**
398  * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
399  * @cmd: ETHTOOL_{G,S}COALESCE
400  * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
401  *	a packet arrives.
402  * @rx_max_coalesced_frames: Maximum number of packets to receive
403  *	before an RX interrupt.
404  * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
405  *	this value applies while an IRQ is being serviced by the host.
406  * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
407  *	except that this value applies while an IRQ is being serviced
408  *	by the host.
409  * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
410  *	a packet is sent.
411  * @tx_max_coalesced_frames: Maximum number of packets to be sent
412  *	before a TX interrupt.
413  * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
414  *	this value applies while an IRQ is being serviced by the host.
415  * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
416  *	except that this value applies while an IRQ is being serviced
417  *	by the host.
418  * @stats_block_coalesce_usecs: How many usecs to delay in-memory
419  *	statistics block updates.  Some drivers do not have an
420  *	in-memory statistic block, and in such cases this value is
421  *	ignored.  This value must not be zero.
422  * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
423  * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
424  * @pkt_rate_low: Threshold for low packet rate (packets per second).
425  * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
426  *	a packet arrives, when the packet rate is below @pkt_rate_low.
427  * @rx_max_coalesced_frames_low: Maximum number of packets to be received
428  *	before an RX interrupt, when the packet rate is below @pkt_rate_low.
429  * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
430  *	a packet is sent, when the packet rate is below @pkt_rate_low.
431  * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
432  *	a TX interrupt, when the packet rate is below @pkt_rate_low.
433  * @pkt_rate_high: Threshold for high packet rate (packets per second).
434  * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
435  *	a packet arrives, when the packet rate is above @pkt_rate_high.
436  * @rx_max_coalesced_frames_high: Maximum number of packets to be received
437  *	before an RX interrupt, when the packet rate is above @pkt_rate_high.
438  * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
439  *	a packet is sent, when the packet rate is above @pkt_rate_high.
440  * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
441  *	a TX interrupt, when the packet rate is above @pkt_rate_high.
442  * @rate_sample_interval: How often to do adaptive coalescing packet rate
443  *	sampling, measured in seconds.  Must not be zero.
444  *
445  * Each pair of (usecs, max_frames) fields specifies that interrupts
446  * should be coalesced until
447  *	(usecs > 0 && time_since_first_completion >= usecs) ||
448  *	(max_frames > 0 && completed_frames >= max_frames)
449  *
450  * It is illegal to set both usecs and max_frames to zero as this
451  * would cause interrupts to never be generated.  To disable
452  * coalescing, set usecs = 0 and max_frames = 1.
453  *
454  * Some implementations ignore the value of max_frames and use the
455  * condition time_since_first_completion >= usecs
456  *
457  * This is deprecated.  Drivers for hardware that does not support
458  * counting completions should validate that max_frames == !rx_usecs.
459  *
460  * Adaptive RX/TX coalescing is an algorithm implemented by some
461  * drivers to improve latency under low packet rates and improve
462  * throughput under high packet rates.  Some drivers only implement
463  * one of RX or TX adaptive coalescing.  Anything not implemented by
464  * the driver causes these values to be silently ignored.
465  *
466  * When the packet rate is below @pkt_rate_high but above
467  * @pkt_rate_low (both measured in packets per second) the
468  * normal {rx,tx}_* coalescing parameters are used.
469  */
470 struct ethtool_coalesce {
471 	__u32	cmd;
472 	__u32	rx_coalesce_usecs;
473 	__u32	rx_max_coalesced_frames;
474 	__u32	rx_coalesce_usecs_irq;
475 	__u32	rx_max_coalesced_frames_irq;
476 	__u32	tx_coalesce_usecs;
477 	__u32	tx_max_coalesced_frames;
478 	__u32	tx_coalesce_usecs_irq;
479 	__u32	tx_max_coalesced_frames_irq;
480 	__u32	stats_block_coalesce_usecs;
481 	__u32	use_adaptive_rx_coalesce;
482 	__u32	use_adaptive_tx_coalesce;
483 	__u32	pkt_rate_low;
484 	__u32	rx_coalesce_usecs_low;
485 	__u32	rx_max_coalesced_frames_low;
486 	__u32	tx_coalesce_usecs_low;
487 	__u32	tx_max_coalesced_frames_low;
488 	__u32	pkt_rate_high;
489 	__u32	rx_coalesce_usecs_high;
490 	__u32	rx_max_coalesced_frames_high;
491 	__u32	tx_coalesce_usecs_high;
492 	__u32	tx_max_coalesced_frames_high;
493 	__u32	rate_sample_interval;
494 };
495 
496 /**
497  * struct ethtool_ringparam - RX/TX ring parameters
498  * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM
499  * @rx_max_pending: Maximum supported number of pending entries per
500  *	RX ring.  Read-only.
501  * @rx_mini_max_pending: Maximum supported number of pending entries
502  *	per RX mini ring.  Read-only.
503  * @rx_jumbo_max_pending: Maximum supported number of pending entries
504  *	per RX jumbo ring.  Read-only.
505  * @tx_max_pending: Maximum supported number of pending entries per
506  *	TX ring.  Read-only.
507  * @rx_pending: Current maximum number of pending entries per RX ring
508  * @rx_mini_pending: Current maximum number of pending entries per RX
509  *	mini ring
510  * @rx_jumbo_pending: Current maximum number of pending entries per RX
511  *	jumbo ring
512  * @tx_pending: Current maximum supported number of pending entries
513  *	per TX ring
514  *
515  * If the interface does not have separate RX mini and/or jumbo rings,
516  * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0.
517  *
518  * There may also be driver-dependent minimum values for the number
519  * of entries per ring.
520  */
521 struct ethtool_ringparam {
522 	__u32	cmd;
523 	__u32	rx_max_pending;
524 	__u32	rx_mini_max_pending;
525 	__u32	rx_jumbo_max_pending;
526 	__u32	tx_max_pending;
527 	__u32	rx_pending;
528 	__u32	rx_mini_pending;
529 	__u32	rx_jumbo_pending;
530 	__u32	tx_pending;
531 };
532 
533 /**
534  * struct ethtool_channels - configuring number of network channel
535  * @cmd: ETHTOOL_{G,S}CHANNELS
536  * @max_rx: Read only. Maximum number of receive channel the driver support.
537  * @max_tx: Read only. Maximum number of transmit channel the driver support.
538  * @max_other: Read only. Maximum number of other channel the driver support.
539  * @max_combined: Read only. Maximum number of combined channel the driver
540  *	support. Set of queues RX, TX or other.
541  * @rx_count: Valid values are in the range 1 to the max_rx.
542  * @tx_count: Valid values are in the range 1 to the max_tx.
543  * @other_count: Valid values are in the range 1 to the max_other.
544  * @combined_count: Valid values are in the range 1 to the max_combined.
545  *
546  * This can be used to configure RX, TX and other channels.
547  */
548 
549 struct ethtool_channels {
550 	__u32	cmd;
551 	__u32	max_rx;
552 	__u32	max_tx;
553 	__u32	max_other;
554 	__u32	max_combined;
555 	__u32	rx_count;
556 	__u32	tx_count;
557 	__u32	other_count;
558 	__u32	combined_count;
559 };
560 
561 /**
562  * struct ethtool_pauseparam - Ethernet pause (flow control) parameters
563  * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM
564  * @autoneg: Flag to enable autonegotiation of pause frame use
565  * @rx_pause: Flag to enable reception of pause frames
566  * @tx_pause: Flag to enable transmission of pause frames
567  *
568  * Drivers should reject a non-zero setting of @autoneg when
569  * autoneogotiation is disabled (or not supported) for the link.
570  *
571  * If the link is autonegotiated, drivers should use
572  * mii_advertise_flowctrl() or similar code to set the advertised
573  * pause frame capabilities based on the @rx_pause and @tx_pause flags,
574  * even if @autoneg is zero.  They should also allow the advertised
575  * pause frame capabilities to be controlled directly through the
576  * advertising field of &struct ethtool_cmd.
577  *
578  * If @autoneg is non-zero, the MAC is configured to send and/or
579  * receive pause frames according to the result of autonegotiation.
580  * Otherwise, it is configured directly based on the @rx_pause and
581  * @tx_pause flags.
582  */
583 struct ethtool_pauseparam {
584 	__u32	cmd;
585 	__u32	autoneg;
586 	__u32	rx_pause;
587 	__u32	tx_pause;
588 };
589 
590 /* Link extended state */
591 enum ethtool_link_ext_state {
592 	ETHTOOL_LINK_EXT_STATE_AUTONEG,
593 	ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE,
594 	ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH,
595 	ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY,
596 	ETHTOOL_LINK_EXT_STATE_NO_CABLE,
597 	ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE,
598 	ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE,
599 	ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE,
600 	ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED,
601 	ETHTOOL_LINK_EXT_STATE_OVERHEAT,
602 	ETHTOOL_LINK_EXT_STATE_MODULE,
603 	ETHTOOL_LINK_EXT_STATE_OTP_SPEED_VIOLATION,
604 	ETHTOOL_LINK_EXT_STATE_BMC_REQUEST_DOWN,
605 };
606 
607 /* More information in addition to ETHTOOL_LINK_EXT_STATE_AUTONEG. */
608 enum ethtool_link_ext_substate_autoneg {
609 	ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED = 1,
610 	ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED,
611 	ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED,
612 	ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE,
613 	ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE,
614 	ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD,
615 };
616 
617 /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE.
618  */
619 enum ethtool_link_ext_substate_link_training {
620 	ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED = 1,
621 	ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT,
622 	ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY,
623 	ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT,
624 };
625 
626 /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH.
627  */
628 enum ethtool_link_ext_substate_link_logical_mismatch {
629 	ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK = 1,
630 	ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK,
631 	ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS,
632 	ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED,
633 	ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED,
634 };
635 
636 /* More information in addition to ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY.
637  */
638 enum ethtool_link_ext_substate_bad_signal_integrity {
639 	ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS = 1,
640 	ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE,
641 	ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST,
642 	ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS,
643 };
644 
645 /* More information in addition to ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE. */
646 enum ethtool_link_ext_substate_cable_issue {
647 	ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE = 1,
648 	ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE,
649 };
650 
651 /* More information in addition to ETHTOOL_LINK_EXT_STATE_MODULE. */
652 enum ethtool_link_ext_substate_module {
653 	ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY = 1,
654 };
655 
656 #define ETH_GSTRING_LEN		32
657 
658 /**
659  * enum ethtool_stringset - string set ID
660  * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST
661  * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS
662  * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with
663  *	%ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS
664  * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE;
665  *	now deprecated
666  * @ETH_SS_FEATURES: Device feature names
667  * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names
668  * @ETH_SS_TUNABLES: tunable names
669  * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS
670  * @ETH_SS_PHY_TUNABLES: PHY tunable names
671  * @ETH_SS_LINK_MODES: link mode names
672  * @ETH_SS_MSG_CLASSES: debug message class names
673  * @ETH_SS_WOL_MODES: wake-on-lan modes
674  * @ETH_SS_SOF_TIMESTAMPING: SOF_TIMESTAMPING_* flags
675  * @ETH_SS_TS_TX_TYPES: timestamping Tx types
676  * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters
677  * @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types
678  * @ETH_SS_STATS_STD: standardized stats
679  * @ETH_SS_STATS_ETH_PHY: names of IEEE 802.3 PHY statistics
680  * @ETH_SS_STATS_ETH_MAC: names of IEEE 802.3 MAC statistics
681  * @ETH_SS_STATS_ETH_CTRL: names of IEEE 802.3 MAC Control statistics
682  * @ETH_SS_STATS_RMON: names of RMON statistics
683  * @ETH_SS_STATS_PHY: names of PHY(dev) statistics
684  * @ETH_SS_TS_FLAGS: hardware timestamping flags
685  *
686  * @ETH_SS_COUNT: number of defined string sets
687  */
688 enum ethtool_stringset {
689 	ETH_SS_TEST		= 0,
690 	ETH_SS_STATS,
691 	ETH_SS_PRIV_FLAGS,
692 	ETH_SS_NTUPLE_FILTERS,
693 	ETH_SS_FEATURES,
694 	ETH_SS_RSS_HASH_FUNCS,
695 	ETH_SS_TUNABLES,
696 	ETH_SS_PHY_STATS,
697 	ETH_SS_PHY_TUNABLES,
698 	ETH_SS_LINK_MODES,
699 	ETH_SS_MSG_CLASSES,
700 	ETH_SS_WOL_MODES,
701 	ETH_SS_SOF_TIMESTAMPING,
702 	ETH_SS_TS_TX_TYPES,
703 	ETH_SS_TS_RX_FILTERS,
704 	ETH_SS_UDP_TUNNEL_TYPES,
705 	ETH_SS_STATS_STD,
706 	ETH_SS_STATS_ETH_PHY,
707 	ETH_SS_STATS_ETH_MAC,
708 	ETH_SS_STATS_ETH_CTRL,
709 	ETH_SS_STATS_RMON,
710 	ETH_SS_STATS_PHY,
711 	ETH_SS_TS_FLAGS,
712 
713 	/* add new constants above here */
714 	ETH_SS_COUNT
715 };
716 
717 /**
718  * enum ethtool_mac_stats_src - source of ethtool MAC statistics
719  * @ETHTOOL_MAC_STATS_SRC_AGGREGATE:
720  *	if device supports a MAC merge layer, this retrieves the aggregate
721  *	statistics of the eMAC and pMAC. Otherwise, it retrieves just the
722  *	statistics of the single (express) MAC.
723  * @ETHTOOL_MAC_STATS_SRC_EMAC:
724  *	if device supports a MM layer, this retrieves the eMAC statistics.
725  *	Otherwise, it retrieves the statistics of the single (express) MAC.
726  * @ETHTOOL_MAC_STATS_SRC_PMAC:
727  *	if device supports a MM layer, this retrieves the pMAC statistics.
728  */
729 enum ethtool_mac_stats_src {
730 	ETHTOOL_MAC_STATS_SRC_AGGREGATE,
731 	ETHTOOL_MAC_STATS_SRC_EMAC,
732 	ETHTOOL_MAC_STATS_SRC_PMAC,
733 };
734 
735 /**
736  * enum ethtool_module_power_mode_policy - plug-in module power mode policy
737  * @ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH: Module is always in high power mode.
738  * @ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO: Module is transitioned by the host
739  *	to high power mode when the first port using it is put administratively
740  *	up and to low power mode when the last port using it is put
741  *	administratively down.
742  */
743 enum ethtool_module_power_mode_policy {
744 	ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH = 1,
745 	ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO,
746 };
747 
748 /**
749  * enum ethtool_module_power_mode - plug-in module power mode
750  * @ETHTOOL_MODULE_POWER_MODE_LOW: Module is in low power mode.
751  * @ETHTOOL_MODULE_POWER_MODE_HIGH: Module is in high power mode.
752  */
753 enum ethtool_module_power_mode {
754 	ETHTOOL_MODULE_POWER_MODE_LOW = 1,
755 	ETHTOOL_MODULE_POWER_MODE_HIGH,
756 };
757 
758 /**
759  * enum ethtool_c33_pse_ext_state - groups of PSE extended states
760  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
761  *
762  * @ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION: Group of error_condition states
763  * @ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID: Group of mr_mps_valid states
764  * @ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE: Group of mr_pse_enable states
765  * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED: Group of option_detect_ted
766  *	states
767  * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM: Group of option_vport_lim states
768  * @ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED: Group of ovld_detected states
769  * @ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE: Group of pd_dll_power_type
770  *	states
771  * @ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE: Group of power_not_available
772  *	states
773  * @ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED: Group of short_detected states
774  */
775 enum ethtool_c33_pse_ext_state {
776 	ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION = 1,
777 	ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID,
778 	ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE,
779 	ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED,
780 	ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM,
781 	ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED,
782 	ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE,
783 	ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE,
784 	ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED,
785 };
786 
787 /**
788  * enum ethtool_c33_pse_ext_substate_mr_mps_valid - mr_mps_valid states
789  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
790  *
791  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD: Underload
792  *	state
793  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN: Port is not
794  *	connected
795  *
796  * The PSE monitors either the DC or AC Maintain Power Signature
797  * (MPS, see 33.2.9.1). This variable indicates the presence or absence of
798  * a valid MPS.
799  */
800 enum ethtool_c33_pse_ext_substate_mr_mps_valid {
801 	ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD = 1,
802 	ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN,
803 };
804 
805 /**
806  * enum ethtool_c33_pse_ext_substate_error_condition - error_condition states
807  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
808  *
809  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT: Non-existing
810  *	port number
811  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT: Undefined port
812  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT: Internal
813  *	hardware fault
814  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON:
815  *	Communication error after force on
816  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS: Unknown
817  *	port status
818  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF: Host
819  *	crash turn off
820  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN:
821  *	Host crash force shutdown
822  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE: Configuration
823  *	change
824  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP: Over
825  *	temperature detected
826  *
827  * error_condition is a variable indicating the status of
828  * implementation-specific fault conditions or optionally other system faults
829  * that prevent the PSE from meeting the specifications in Table 33–11 and that
830  * require the PSE not to source power. These error conditions are different
831  * from those monitored by the state diagrams in Figure 33–10.
832  */
833 enum ethtool_c33_pse_ext_substate_error_condition {
834 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT = 1,
835 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT,
836 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT,
837 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON,
838 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS,
839 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF,
840 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN,
841 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE,
842 	ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP,
843 };
844 
845 /**
846  * enum ethtool_c33_pse_ext_substate_mr_pse_enable - mr_pse_enable states
847  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
848  *
849  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE: Disable
850  *	pin active
851  *
852  * mr_pse_enable is control variable that selects PSE operation and test
853  * functions.
854  */
855 enum ethtool_c33_pse_ext_substate_mr_pse_enable {
856 	ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE = 1,
857 };
858 
859 /**
860  * enum ethtool_c33_pse_ext_substate_option_detect_ted - option_detect_ted
861  *	states functions. IEEE 802.3-2022 33.2.4.4 Variables
862  *
863  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS: Detection
864  *	in process
865  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR:
866  *	Connection check error
867  *
868  * option_detect_ted is a variable indicating if detection can be performed
869  * by the PSE during the ted_timer interval.
870  */
871 enum ethtool_c33_pse_ext_substate_option_detect_ted {
872 	ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS = 1,
873 	ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR,
874 };
875 
876 /**
877  * enum ethtool_c33_pse_ext_substate_option_vport_lim - option_vport_lim states
878  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
879  *
880  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE: Main supply
881  *	voltage is high
882  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE: Main supply
883  *	voltage is low
884  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION: Voltage
885  *	injection into the port
886  *
887  * option_vport_lim is an optional variable indicates if VPSE is out of the
888  * operating range during normal operating state.
889  */
890 enum ethtool_c33_pse_ext_substate_option_vport_lim {
891 	ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE = 1,
892 	ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE,
893 	ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION,
894 };
895 
896 /**
897  * enum ethtool_c33_pse_ext_substate_ovld_detected - ovld_detected states
898  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
899  *
900  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD: Overload state
901  *
902  * ovld_detected is a variable indicating if the PSE output current has been
903  * in an overload condition (see 33.2.7.6) for at least TCUT of a one-second
904  * sliding time.
905  */
906 enum ethtool_c33_pse_ext_substate_ovld_detected {
907 	ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD = 1,
908 };
909 
910 /**
911  * enum ethtool_c33_pse_ext_substate_power_not_available - power_not_available
912  *	states functions. IEEE 802.3-2022 33.2.4.4 Variables
913  *
914  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED: Power
915  *	budget exceeded for the controller
916  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET:
917  *	Configured port power limit exceeded controller power budget
918  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT:
919  *	Power request from PD exceeds port limit
920  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT: Power
921  *	denied due to Hardware power limit
922  *
923  * power_not_available is a variable that is asserted in an
924  * implementation-dependent manner when the PSE is no longer capable of
925  * sourcing sufficient power to support the attached PD. Sufficient power
926  * is defined by classification; see 33.2.6.
927  */
928 enum ethtool_c33_pse_ext_substate_power_not_available {
929 	ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED =  1,
930 	ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET,
931 	ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT,
932 	ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT,
933 };
934 
935 /**
936  * enum ethtool_c33_pse_ext_substate_short_detected - short_detected states
937  *      functions. IEEE 802.3-2022 33.2.4.4 Variables
938  *
939  * @ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION: Short
940  *	condition was detected
941  *
942  * short_detected is a variable indicating if the PSE output current has been
943  * in a short circuit condition for TLIM within a sliding window (see 33.2.7.7).
944  */
945 enum ethtool_c33_pse_ext_substate_short_detected {
946 	ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION = 1,
947 };
948 
949 /**
950  * enum ethtool_pse_types - Types of PSE controller.
951  * @ETHTOOL_PSE_UNKNOWN: Type of PSE controller is unknown
952  * @ETHTOOL_PSE_PODL: PSE controller which support PoDL
953  * @ETHTOOL_PSE_C33: PSE controller which support Clause 33 (PoE)
954  */
955 enum ethtool_pse_types {
956 	ETHTOOL_PSE_UNKNOWN =	1 << 0,
957 	ETHTOOL_PSE_PODL =	1 << 1,
958 	ETHTOOL_PSE_C33 =	1 << 2,
959 };
960 
961 /**
962  * enum ethtool_c33_pse_admin_state - operational state of the PoDL PSE
963  *	functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
964  * @ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN: state of PSE functions is unknown
965  * @ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED: PSE functions are disabled
966  * @ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED: PSE functions are enabled
967  */
968 enum ethtool_c33_pse_admin_state {
969 	ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN = 1,
970 	ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED,
971 	ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED,
972 };
973 
974 /**
975  * enum ethtool_c33_pse_pw_d_status - power detection status of the PSE.
976  *	IEEE 802.3-2022 30.9.1.1.3 aPoDLPSEPowerDetectionStatus:
977  * @ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN: PSE status is unknown
978  * @ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED: The enumeration "disabled"
979  *	indicates that the PSE State diagram is in the state DISABLED.
980  * @ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING: The enumeration "searching"
981  *	indicates the PSE State diagram is in a state other than those
982  *	listed.
983  * @ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING: The enumeration
984  *	"deliveringPower" indicates that the PSE State diagram is in the
985  *	state POWER_ON.
986  * @ETHTOOL_C33_PSE_PW_D_STATUS_TEST: The enumeration "test" indicates that
987  *	the PSE State diagram is in the state TEST_MODE.
988  * @ETHTOOL_C33_PSE_PW_D_STATUS_FAULT: The enumeration "fault" indicates that
989  *	the PSE State diagram is in the state TEST_ERROR.
990  * @ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT: The enumeration "otherFault"
991  *	indicates that the PSE State diagram is in the state IDLE due to
992  *	the variable error_condition = true.
993  */
994 enum ethtool_c33_pse_pw_d_status {
995 	ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN = 1,
996 	ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED,
997 	ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING,
998 	ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING,
999 	ETHTOOL_C33_PSE_PW_D_STATUS_TEST,
1000 	ETHTOOL_C33_PSE_PW_D_STATUS_FAULT,
1001 	ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT,
1002 };
1003 
1004 /**
1005  * enum ethtool_podl_pse_admin_state - operational state of the PoDL PSE
1006  *	functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
1007  * @ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN: state of PoDL PSE functions are
1008  * 	unknown
1009  * @ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED: PoDL PSE functions are disabled
1010  * @ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED: PoDL PSE functions are enabled
1011  */
1012 enum ethtool_podl_pse_admin_state {
1013 	ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN = 1,
1014 	ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED,
1015 	ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED,
1016 };
1017 
1018 /**
1019  * enum ethtool_podl_pse_pw_d_status - power detection status of the PoDL PSE.
1020  *	IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
1021  * @ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN: PoDL PSE
1022  * @ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED: "The enumeration “disabled” is
1023  *	asserted true when the PoDL PSE state diagram variable mr_pse_enable is
1024  *	false"
1025  * @ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING: "The enumeration “searching” is
1026  *	asserted true when either of the PSE state diagram variables
1027  *	pi_detecting or pi_classifying is true."
1028  * @ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING: "The enumeration “deliveringPower”
1029  *	is asserted true when the PoDL PSE state diagram variable pi_powered is
1030  *	true."
1031  * @ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP: "The enumeration “sleep” is asserted
1032  *	true when the PoDL PSE state diagram variable pi_sleeping is true."
1033  * @ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE: "The enumeration “idle” is asserted true
1034  *	when the logical combination of the PoDL PSE state diagram variables
1035  *	pi_prebiased*!pi_sleeping is true."
1036  * @ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR: "The enumeration “error” is asserted
1037  *	true when the PoDL PSE state diagram variable overload_held is true."
1038  */
1039 enum ethtool_podl_pse_pw_d_status {
1040 	ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN = 1,
1041 	ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED,
1042 	ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING,
1043 	ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING,
1044 	ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP,
1045 	ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE,
1046 	ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR,
1047 };
1048 
1049 /**
1050  * enum ethtool_mm_verify_status - status of MAC Merge Verify function
1051  * @ETHTOOL_MM_VERIFY_STATUS_UNKNOWN:
1052  *	verification status is unknown
1053  * @ETHTOOL_MM_VERIFY_STATUS_INITIAL:
1054  *	the 802.3 Verify State diagram is in the state INIT_VERIFICATION
1055  * @ETHTOOL_MM_VERIFY_STATUS_VERIFYING:
1056  *	the Verify State diagram is in the state VERIFICATION_IDLE,
1057  *	SEND_VERIFY or WAIT_FOR_RESPONSE
1058  * @ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED:
1059  *	indicates that the Verify State diagram is in the state VERIFIED
1060  * @ETHTOOL_MM_VERIFY_STATUS_FAILED:
1061  *	the Verify State diagram is in the state VERIFY_FAIL
1062  * @ETHTOOL_MM_VERIFY_STATUS_DISABLED:
1063  *	verification of preemption operation is disabled
1064  */
1065 enum ethtool_mm_verify_status {
1066 	ETHTOOL_MM_VERIFY_STATUS_UNKNOWN,
1067 	ETHTOOL_MM_VERIFY_STATUS_INITIAL,
1068 	ETHTOOL_MM_VERIFY_STATUS_VERIFYING,
1069 	ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED,
1070 	ETHTOOL_MM_VERIFY_STATUS_FAILED,
1071 	ETHTOOL_MM_VERIFY_STATUS_DISABLED,
1072 };
1073 
1074 /**
1075  * enum ethtool_module_fw_flash_status - plug-in module firmware flashing status
1076  * @ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED: The firmware flashing process has
1077  *	started.
1078  * @ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS: The firmware flashing process
1079  *	is in progress.
1080  * @ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED: The firmware flashing process was
1081  *	completed successfully.
1082  * @ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR: The firmware flashing process was
1083  *	stopped due to an error.
1084  */
1085 enum ethtool_module_fw_flash_status {
1086 	ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED = 1,
1087 	ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS,
1088 	ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED,
1089 	ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR,
1090 };
1091 
1092 /**
1093  * struct ethtool_gstrings - string set for data tagging
1094  * @cmd: Command number = %ETHTOOL_GSTRINGS
1095  * @string_set: String set ID; one of &enum ethtool_stringset
1096  * @len: Number of strings in the string set
1097  * @data: Buffer for strings.  Each string is null-padded to a size of
1098  *	%ETH_GSTRING_LEN.
1099  *
1100  * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in
1101  * the string set.  They must allocate a buffer of the appropriate
1102  * size immediately following this structure.
1103  *
1104  * Setting @len on input is optional (though preferred), but must be zeroed
1105  * otherwise.
1106  * When set, @len will return the requested count if it matches the actual
1107  * count; otherwise, it will be zero.
1108  * This prevents issues when the number of strings is different than the
1109  * userspace allocation.
1110  */
1111 struct ethtool_gstrings {
1112 	__u32	cmd;
1113 	__u32	string_set;
1114 	__u32	len;
1115 	__u8	data[];
1116 };
1117 
1118 /**
1119  * struct ethtool_sset_info - string set information
1120  * @cmd: Command number = %ETHTOOL_GSSET_INFO
1121  * @reserved: Reserved for future use; see the note on reserved space.
1122  * @sset_mask: On entry, a bitmask of string sets to query, with bits
1123  *	numbered according to &enum ethtool_stringset.  On return, a
1124  *	bitmask of those string sets queried that are supported.
1125  * @data: Buffer for string set sizes.  On return, this contains the
1126  *	size of each string set that was queried and supported, in
1127  *	order of ID.
1128  *
1129  * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on
1130  * return @sset_mask == 0x6 (sets 1, 2).  Then @data[0] contains the
1131  * size of set 1 and @data[1] contains the size of set 2.
1132  *
1133  * Users must allocate a buffer of the appropriate size (4 * number of
1134  * sets queried) immediately following this structure.
1135  */
1136 struct ethtool_sset_info {
1137 	__u32	cmd;
1138 	__u32	reserved;
1139 	__u64	sset_mask;
1140 	__u32	data[];
1141 };
1142 
1143 /**
1144  * enum ethtool_test_flags - flags definition of ethtool_test
1145  * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
1146  *	only online tests.
1147  * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
1148  * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
1149  *	test.
1150  * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
1151  */
1152 
1153 enum ethtool_test_flags {
1154 	ETH_TEST_FL_OFFLINE	= (1 << 0),
1155 	ETH_TEST_FL_FAILED	= (1 << 1),
1156 	ETH_TEST_FL_EXTERNAL_LB	= (1 << 2),
1157 	ETH_TEST_FL_EXTERNAL_LB_DONE	= (1 << 3),
1158 };
1159 
1160 /**
1161  * struct ethtool_test - device self-test invocation
1162  * @cmd: Command number = %ETHTOOL_TEST
1163  * @flags: A bitmask of flags from &enum ethtool_test_flags.  Some
1164  *	flags may be set by the user on entry; others may be set by
1165  *	the driver on return.
1166  * @reserved: Reserved for future use; see the note on reserved space.
1167  * @len: On return, the number of test results
1168  * @data: Array of test results
1169  *
1170  * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
1171  * number of test results that will be returned.  They must allocate a
1172  * buffer of the appropriate size (8 * number of results) immediately
1173  * following this structure.
1174  */
1175 struct ethtool_test {
1176 	__u32	cmd;
1177 	__u32	flags;
1178 	__u32	reserved;
1179 	__u32	len;
1180 	__u64	data[];
1181 };
1182 
1183 /**
1184  * struct ethtool_stats - device-specific statistics
1185  * @cmd: Command number = %ETHTOOL_GSTATS
1186  * @n_stats: Number of statistics
1187  * @data: Array of statistics
1188  *
1189  * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
1190  * number of statistics that will be returned.  They must allocate a
1191  * buffer of the appropriate size (8 * number of statistics)
1192  * immediately following this structure.
1193  *
1194  * Setting @n_stats on input is optional (though preferred), but must be zeroed
1195  * otherwise.
1196  * When set, @n_stats will return the requested count if it matches the actual
1197  * count; otherwise, it will be zero.
1198  * This prevents issues when the number of stats is different than the
1199  * userspace allocation.
1200  */
1201 struct ethtool_stats {
1202 	__u32	cmd;
1203 	__u32	n_stats;
1204 	__u64	data[];
1205 };
1206 
1207 /**
1208  * struct ethtool_perm_addr - permanent hardware address
1209  * @cmd: Command number = %ETHTOOL_GPERMADDR
1210  * @size: On entry, the size of the buffer.  On return, the size of the
1211  *	address.  The command fails if the buffer is too small.
1212  * @data: Buffer for the address
1213  *
1214  * Users must allocate the buffer immediately following this structure.
1215  * A buffer size of %MAX_ADDR_LEN should be sufficient for any address
1216  * type.
1217  */
1218 struct ethtool_perm_addr {
1219 	__u32	cmd;
1220 	__u32	size;
1221 	__u8	data[];
1222 };
1223 
1224 /* boolean flags controlling per-interface behavior characteristics.
1225  * When reading, the flag indicates whether or not a certain behavior
1226  * is enabled/present.  When writing, the flag indicates whether
1227  * or not the driver should turn on (set) or off (clear) a behavior.
1228  *
1229  * Some behaviors may read-only (unconditionally absent or present).
1230  * If such is the case, return EINVAL in the set-flags operation if the
1231  * flag differs from the read-only value.
1232  */
1233 enum ethtool_flags {
1234 	ETH_FLAG_TXVLAN		= (1 << 7),	/* TX VLAN offload enabled */
1235 	ETH_FLAG_RXVLAN		= (1 << 8),	/* RX VLAN offload enabled */
1236 	ETH_FLAG_LRO		= (1 << 15),	/* LRO is enabled */
1237 	ETH_FLAG_NTUPLE		= (1 << 27),	/* N-tuple filters enabled */
1238 	ETH_FLAG_RXHASH		= (1 << 28),
1239 };
1240 
1241 /* The following structures are for supporting RX network flow
1242  * classification and RX n-tuple configuration. Note, all multibyte
1243  * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
1244  * be in network byte order.
1245  */
1246 
1247 /**
1248  * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
1249  * @ip4src: Source host
1250  * @ip4dst: Destination host
1251  * @psrc: Source port
1252  * @pdst: Destination port
1253  * @tos: Type-of-service
1254  *
1255  * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
1256  */
1257 struct ethtool_tcpip4_spec {
1258 	__be32	ip4src;
1259 	__be32	ip4dst;
1260 	__be16	psrc;
1261 	__be16	pdst;
1262 	__u8    tos;
1263 };
1264 
1265 /**
1266  * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
1267  * @ip4src: Source host
1268  * @ip4dst: Destination host
1269  * @spi: Security parameters index
1270  * @tos: Type-of-service
1271  *
1272  * This can be used to specify an IPsec transport or tunnel over IPv4.
1273  */
1274 struct ethtool_ah_espip4_spec {
1275 	__be32	ip4src;
1276 	__be32	ip4dst;
1277 	__be32	spi;
1278 	__u8    tos;
1279 };
1280 
1281 #define	ETH_RX_NFC_IP4	1
1282 
1283 /**
1284  * struct ethtool_usrip4_spec - general flow specification for IPv4
1285  * @ip4src: Source host
1286  * @ip4dst: Destination host
1287  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
1288  * @tos: Type-of-service
1289  * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
1290  * @proto: Transport protocol number; mask must be 0
1291  */
1292 struct ethtool_usrip4_spec {
1293 	__be32	ip4src;
1294 	__be32	ip4dst;
1295 	__be32	l4_4_bytes;
1296 	__u8    tos;
1297 	__u8    ip_ver;
1298 	__u8    proto;
1299 };
1300 
1301 /**
1302  * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc.
1303  * @ip6src: Source host
1304  * @ip6dst: Destination host
1305  * @psrc: Source port
1306  * @pdst: Destination port
1307  * @tclass: Traffic Class
1308  *
1309  * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow.
1310  */
1311 struct ethtool_tcpip6_spec {
1312 	__be32	ip6src[4];
1313 	__be32	ip6dst[4];
1314 	__be16	psrc;
1315 	__be16	pdst;
1316 	__u8    tclass;
1317 };
1318 
1319 /**
1320  * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6
1321  * @ip6src: Source host
1322  * @ip6dst: Destination host
1323  * @spi: Security parameters index
1324  * @tclass: Traffic Class
1325  *
1326  * This can be used to specify an IPsec transport or tunnel over IPv6.
1327  */
1328 struct ethtool_ah_espip6_spec {
1329 	__be32	ip6src[4];
1330 	__be32	ip6dst[4];
1331 	__be32	spi;
1332 	__u8    tclass;
1333 };
1334 
1335 /**
1336  * struct ethtool_usrip6_spec - general flow specification for IPv6
1337  * @ip6src: Source host
1338  * @ip6dst: Destination host
1339  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
1340  * @tclass: Traffic Class
1341  * @l4_proto: Transport protocol number (nexthdr after any Extension Headers)
1342  */
1343 struct ethtool_usrip6_spec {
1344 	__be32	ip6src[4];
1345 	__be32	ip6dst[4];
1346 	__be32	l4_4_bytes;
1347 	__u8    tclass;
1348 	__u8    l4_proto;
1349 };
1350 
1351 union ethtool_flow_union {
1352 	struct ethtool_tcpip4_spec		tcp_ip4_spec;
1353 	struct ethtool_tcpip4_spec		udp_ip4_spec;
1354 	struct ethtool_tcpip4_spec		sctp_ip4_spec;
1355 	struct ethtool_ah_espip4_spec		ah_ip4_spec;
1356 	struct ethtool_ah_espip4_spec		esp_ip4_spec;
1357 	struct ethtool_usrip4_spec		usr_ip4_spec;
1358 	struct ethtool_tcpip6_spec		tcp_ip6_spec;
1359 	struct ethtool_tcpip6_spec		udp_ip6_spec;
1360 	struct ethtool_tcpip6_spec		sctp_ip6_spec;
1361 	struct ethtool_ah_espip6_spec		ah_ip6_spec;
1362 	struct ethtool_ah_espip6_spec		esp_ip6_spec;
1363 	struct ethtool_usrip6_spec		usr_ip6_spec;
1364 	struct ethhdr				ether_spec;
1365 	__u8					hdata[52];
1366 };
1367 
1368 /**
1369  * struct ethtool_flow_ext - additional RX flow fields
1370  * @h_dest: destination MAC address
1371  * @vlan_etype: VLAN EtherType
1372  * @vlan_tci: VLAN tag control information
1373  * @data: user defined data
1374  * @padding: Reserved for future use; see the note on reserved space.
1375  *
1376  * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
1377  * is set in &struct ethtool_rx_flow_spec @flow_type.
1378  * @h_dest is valid if %FLOW_MAC_EXT is set.
1379  */
1380 struct ethtool_flow_ext {
1381 	__u8		padding[2];
1382 	unsigned char	h_dest[ETH_ALEN];
1383 	__be16		vlan_etype;
1384 	__be16		vlan_tci;
1385 	__be32		data[2];
1386 };
1387 
1388 /**
1389  * struct ethtool_rx_flow_spec - classification rule for RX flows
1390  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1391  * @h_u: Flow fields to match (dependent on @flow_type)
1392  * @h_ext: Additional fields to match
1393  * @m_u: Masks for flow field bits to be matched
1394  * @m_ext: Masks for additional field bits to be matched
1395  *	Note, all additional fields must be ignored unless @flow_type
1396  *	includes the %FLOW_EXT or %FLOW_MAC_EXT flag
1397  *	(see &struct ethtool_flow_ext description).
1398  * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
1399  *	if packets should be discarded, or %RX_CLS_FLOW_WAKE if the
1400  *	packets should be used for Wake-on-LAN with %WAKE_FILTER
1401  * @location: Location of rule in the table.  Locations must be
1402  *	numbered such that a flow matching multiple rules will be
1403  *	classified according to the first (lowest numbered) rule.
1404  */
1405 struct ethtool_rx_flow_spec {
1406 	__u32		flow_type;
1407 	union ethtool_flow_union h_u;
1408 	struct ethtool_flow_ext h_ext;
1409 	union ethtool_flow_union m_u;
1410 	struct ethtool_flow_ext m_ext;
1411 	__u64		ring_cookie;
1412 	__u32		location;
1413 };
1414 
1415 /* How rings are laid out when accessing virtual functions or
1416  * offloaded queues is device specific. To allow users to do flow
1417  * steering and specify these queues the ring cookie is partitioned
1418  * into a 32bit queue index with an 8 bit virtual function id.
1419  * This also leaves the 3bytes for further specifiers. It is possible
1420  * future devices may support more than 256 virtual functions if
1421  * devices start supporting PCIe w/ARI. However at the moment I
1422  * do not know of any devices that support this so I do not reserve
1423  * space for this at this time. If a future patch consumes the next
1424  * byte it should be aware of this possibility.
1425  */
1426 #define ETHTOOL_RX_FLOW_SPEC_RING	0x00000000FFFFFFFFLL
1427 #define ETHTOOL_RX_FLOW_SPEC_RING_VF	0x000000FF00000000LL
1428 #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32
ethtool_get_flow_spec_ring(__u64 ring_cookie)1429 static inline __u64 ethtool_get_flow_spec_ring(__u64 ring_cookie)
1430 {
1431 	return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie;
1432 }
1433 
ethtool_get_flow_spec_ring_vf(__u64 ring_cookie)1434 static inline __u64 ethtool_get_flow_spec_ring_vf(__u64 ring_cookie)
1435 {
1436 	return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >>
1437 				ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF;
1438 }
1439 
1440 /**
1441  * struct ethtool_rxnfc - command to get or set RX flow classification rules
1442  * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
1443  *	%ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
1444  *	%ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
1445  * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
1446  * @data: Command-dependent value
1447  * @fs: Flow classification rule
1448  * @rss_context: RSS context to be affected
1449  * @rule_cnt: Number of rules to be affected
1450  * @rule_locs: Array of used rule locations
1451  *
1452  * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
1453  * the fields included in the flow hash, e.g. %RXH_IP_SRC.  The following
1454  * structure fields must not be used, except that if @flow_type includes
1455  * the %FLOW_RSS flag, then @rss_context determines which RSS context to
1456  * act on.
1457  *
1458  * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
1459  * on return.
1460  *
1461  * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
1462  * rules on return.  If @data is non-zero on return then it is the
1463  * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
1464  * driver supports any special location values.  If that flag is not
1465  * set in @data then special location values should not be used.
1466  *
1467  * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
1468  * existing rule on entry and @fs contains the rule on return; if
1469  * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is
1470  * filled with the RSS context ID associated with the rule.
1471  *
1472  * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
1473  * user buffer for @rule_locs on entry.  On return, @data is the size
1474  * of the rule table, @rule_cnt is the number of defined rules, and
1475  * @rule_locs contains the locations of the defined rules.  Drivers
1476  * must use the second parameter to get_rxnfc() instead of @rule_locs.
1477  *
1478  * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
1479  * @fs.@location either specifies the location to use or is a special
1480  * location value with %RX_CLS_LOC_SPECIAL flag set.  On return,
1481  * @fs.@location is the actual rule location.  If @fs.@flow_type
1482  * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to
1483  * use for flow spreading traffic which matches this rule.  The value
1484  * from the rxfh indirection table will be added to @fs.@ring_cookie
1485  * to choose which ring to deliver to.
1486  *
1487  * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
1488  * existing rule on entry.
1489  *
1490  * A driver supporting the special location values for
1491  * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
1492  * location, and may remove a rule at a later location (lower
1493  * priority) that matches exactly the same set of flows.  The special
1494  * values are %RX_CLS_LOC_ANY, selecting any location;
1495  * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
1496  * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
1497  * location (minimum priority).  Additional special values may be
1498  * defined in future and drivers must return -%EINVAL for any
1499  * unrecognised value.
1500  */
1501 struct ethtool_rxnfc {
1502 	__u32				cmd;
1503 	__u32				flow_type;
1504 	__u64				data;
1505 	struct ethtool_rx_flow_spec	fs;
1506 	union {
1507 		__u32			rule_cnt;
1508 		__u32			rss_context;
1509 	};
1510 	__u32				rule_locs[];
1511 };
1512 
1513 
1514 /**
1515  * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
1516  * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
1517  * @size: On entry, the array size of the user buffer, which may be zero.
1518  *	On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
1519  *	indirection table.
1520  * @ring_index: RX ring/queue index for each hash value
1521  *
1522  * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
1523  * should be returned.  For %ETHTOOL_SRXFHINDIR, a @size of zero means
1524  * the table should be reset to default values.  This last feature
1525  * is not supported by the original implementations.
1526  */
1527 struct ethtool_rxfh_indir {
1528 	__u32	cmd;
1529 	__u32	size;
1530 	__u32	ring_index[];
1531 };
1532 
1533 /**
1534  * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key.
1535  * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH
1536  * @rss_context: RSS context identifier.  Context 0 is the default for normal
1537  *	traffic; other contexts can be referenced as the destination for RX flow
1538  *	classification rules.  %ETH_RXFH_CONTEXT_ALLOC is used with command
1539  *	%ETHTOOL_SRSSH to allocate a new RSS context; on return this field will
1540  *	contain the ID of the newly allocated context.
1541  * @indir_size: On entry, the array size of the user buffer for the
1542  *	indirection table, which may be zero, or (for %ETHTOOL_SRSSH),
1543  *	%ETH_RXFH_INDIR_NO_CHANGE.  On return from %ETHTOOL_GRSSH,
1544  *	the array size of the hardware indirection table.
1545  * @key_size: On entry, the array size of the user buffer for the hash key,
1546  *	which may be zero.  On return from %ETHTOOL_GRSSH, the size of the
1547  *	hardware hash key.
1548  * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
1549  *	Valid values are one of the %ETH_RSS_HASH_*.
1550  * @input_xfrm: Defines how the input data is transformed. Valid values are one
1551  *	of %RXH_XFRM_*.
1552  * @rsvd8: Reserved for future use; see the note on reserved space.
1553  * @rsvd32: Reserved for future use; see the note on reserved space.
1554  * @rss_config: RX ring/queue index for each hash value i.e., indirection table
1555  *	of @indir_size __u32 elements, followed by hash key of @key_size
1556  *	bytes.
1557  *
1558  * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the
1559  * size should be returned.  For %ETHTOOL_SRSSH, an @indir_size of
1560  * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested
1561  * and a @indir_size of zero means the indir table should be reset to default
1562  * values (if @rss_context == 0) or that the RSS context should be deleted.
1563  * An hfunc of zero means that hash function setting is not requested.
1564  */
1565 struct ethtool_rxfh {
1566 	__u32   cmd;
1567 	__u32	rss_context;
1568 	__u32   indir_size;
1569 	__u32   key_size;
1570 	__u8	hfunc;
1571 	__u8	input_xfrm;
1572 	__u8	rsvd8[2];
1573 	__u32	rsvd32;
1574 	__u32   rss_config[];
1575 };
1576 #define ETH_RXFH_CONTEXT_ALLOC		0xffffffff
1577 #define ETH_RXFH_INDIR_NO_CHANGE	0xffffffff
1578 
1579 /**
1580  * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
1581  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1582  * @h_u: Flow field values to match (dependent on @flow_type)
1583  * @m_u: Masks for flow field value bits to be ignored
1584  * @vlan_tag: VLAN tag to match
1585  * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
1586  * @data: Driver-dependent data to match
1587  * @data_mask: Mask for driver-dependent data bits to be ignored
1588  * @action: RX ring/queue index to deliver to (non-negative) or other action
1589  *	(negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
1590  *
1591  * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
1592  * a field value and mask are both zero this is treated as if all mask
1593  * bits are set i.e. the field is ignored.
1594  */
1595 struct ethtool_rx_ntuple_flow_spec {
1596 	__u32		 flow_type;
1597 	union {
1598 		struct ethtool_tcpip4_spec		tcp_ip4_spec;
1599 		struct ethtool_tcpip4_spec		udp_ip4_spec;
1600 		struct ethtool_tcpip4_spec		sctp_ip4_spec;
1601 		struct ethtool_ah_espip4_spec		ah_ip4_spec;
1602 		struct ethtool_ah_espip4_spec		esp_ip4_spec;
1603 		struct ethtool_usrip4_spec		usr_ip4_spec;
1604 		struct ethhdr				ether_spec;
1605 		__u8					hdata[72];
1606 	} h_u, m_u;
1607 
1608 	__u16	        vlan_tag;
1609 	__u16	        vlan_tag_mask;
1610 	__u64		data;
1611 	__u64		data_mask;
1612 
1613 	__s32		action;
1614 #define ETHTOOL_RXNTUPLE_ACTION_DROP	(-1)	/* drop packet */
1615 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR	(-2)	/* clear filter */
1616 };
1617 
1618 /**
1619  * struct ethtool_rx_ntuple - command to set or clear RX flow filter
1620  * @cmd: Command number - %ETHTOOL_SRXNTUPLE
1621  * @fs: Flow filter specification
1622  */
1623 struct ethtool_rx_ntuple {
1624 	__u32					cmd;
1625 	struct ethtool_rx_ntuple_flow_spec	fs;
1626 };
1627 
1628 #define ETHTOOL_FLASH_MAX_FILENAME	128
1629 enum ethtool_flash_op_type {
1630 	ETHTOOL_FLASH_ALL_REGIONS	= 0,
1631 };
1632 
1633 /* for passing firmware flashing related parameters */
1634 struct ethtool_flash {
1635 	__u32	cmd;
1636 	__u32	region;
1637 	char	data[ETHTOOL_FLASH_MAX_FILENAME];
1638 };
1639 
1640 /**
1641  * struct ethtool_dump - used for retrieving, setting device dump
1642  * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
1643  * 	%ETHTOOL_SET_DUMP
1644  * @version: FW version of the dump, filled in by driver
1645  * @flag: driver dependent flag for dump setting, filled in by driver during
1646  *        get and filled in by ethtool for set operation.
1647  *        flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
1648  *        firmware dump is disabled.
1649  * @len: length of dump data, used as the length of the user buffer on entry to
1650  * 	 %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
1651  * 	 for %ETHTOOL_GET_DUMP_FLAG command
1652  * @data: data collected for get dump data operation
1653  */
1654 struct ethtool_dump {
1655 	__u32	cmd;
1656 	__u32	version;
1657 	__u32	flag;
1658 	__u32	len;
1659 	__u8	data[];
1660 };
1661 
1662 #define ETH_FW_DUMP_DISABLE 0
1663 
1664 /* for returning and changing feature sets */
1665 
1666 /**
1667  * struct ethtool_get_features_block - block with state of 32 features
1668  * @available: mask of changeable features
1669  * @requested: mask of features requested to be enabled if possible
1670  * @active: mask of currently enabled features
1671  * @never_changed: mask of features not changeable for any device
1672  */
1673 struct ethtool_get_features_block {
1674 	__u32	available;
1675 	__u32	requested;
1676 	__u32	active;
1677 	__u32	never_changed;
1678 };
1679 
1680 /**
1681  * struct ethtool_gfeatures - command to get state of device's features
1682  * @cmd: command number = %ETHTOOL_GFEATURES
1683  * @size: On entry, the number of elements in the features[] array;
1684  *	on return, the number of elements in features[] needed to hold
1685  *	all features
1686  * @features: state of features
1687  */
1688 struct ethtool_gfeatures {
1689 	__u32	cmd;
1690 	__u32	size;
1691 	struct ethtool_get_features_block features[];
1692 };
1693 
1694 /**
1695  * struct ethtool_set_features_block - block with request for 32 features
1696  * @valid: mask of features to be changed
1697  * @requested: values of features to be changed
1698  */
1699 struct ethtool_set_features_block {
1700 	__u32	valid;
1701 	__u32	requested;
1702 };
1703 
1704 /**
1705  * struct ethtool_sfeatures - command to request change in device's features
1706  * @cmd: command number = %ETHTOOL_SFEATURES
1707  * @size: array size of the features[] array
1708  * @features: feature change masks
1709  */
1710 struct ethtool_sfeatures {
1711 	__u32	cmd;
1712 	__u32	size;
1713 	struct ethtool_set_features_block features[];
1714 };
1715 
1716 /**
1717  * struct ethtool_ts_info - holds a device's timestamping and PHC association
1718  * @cmd: command number = %ETHTOOL_GET_TS_INFO
1719  * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
1720  * @phc_index: device index of the associated PHC, or -1 if there is none
1721  * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
1722  * @tx_reserved: Reserved for future use; see the note on reserved space.
1723  * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
1724  * @rx_reserved: Reserved for future use; see the note on reserved space.
1725  *
1726  * The bits in the 'tx_types' and 'rx_filters' fields correspond to
1727  * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
1728  * respectively.  For example, if the device supports HWTSTAMP_TX_ON,
1729  * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
1730  *
1731  * Drivers should only report the filters they actually support without
1732  * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for
1733  * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the
1734  * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op.
1735  */
1736 struct ethtool_ts_info {
1737 	__u32	cmd;
1738 	__u32	so_timestamping;
1739 	__s32	phc_index;
1740 	__u32	tx_types;
1741 	__u32	tx_reserved[3];
1742 	__u32	rx_filters;
1743 	__u32	rx_reserved[3];
1744 };
1745 
1746 /*
1747  * %ETHTOOL_SFEATURES changes features present in features[].valid to the
1748  * values of corresponding bits in features[].requested. Bits in .requested
1749  * not set in .valid or not changeable are ignored.
1750  *
1751  * Returns %EINVAL when .valid contains undefined or never-changeable bits
1752  * or size is not equal to required number of features words (32-bit blocks).
1753  * Returns >= 0 if request was completed; bits set in the value mean:
1754  *   %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
1755  *	changeable (not present in %ETHTOOL_GFEATURES' features[].available)
1756  *	those bits were ignored.
1757  *   %ETHTOOL_F_WISH - some or all changes requested were recorded but the
1758  *      resulting state of bits masked by .valid is not equal to .requested.
1759  *      Probably there are other device-specific constraints on some features
1760  *      in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
1761  *      here as though ignored bits were cleared.
1762  *   %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
1763  *      compatibility functions. Requested offload state cannot be properly
1764  *      managed by kernel.
1765  *
1766  * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
1767  * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
1768  * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
1769  * significant bit in features[0] fields. Empty strings mark undefined features.
1770  */
1771 enum ethtool_sfeatures_retval_bits {
1772 	ETHTOOL_F_UNSUPPORTED__BIT,
1773 	ETHTOOL_F_WISH__BIT,
1774 	ETHTOOL_F_COMPAT__BIT,
1775 };
1776 
1777 #define ETHTOOL_F_UNSUPPORTED   (1 << ETHTOOL_F_UNSUPPORTED__BIT)
1778 #define ETHTOOL_F_WISH          (1 << ETHTOOL_F_WISH__BIT)
1779 #define ETHTOOL_F_COMPAT        (1 << ETHTOOL_F_COMPAT__BIT)
1780 
1781 #define MAX_NUM_QUEUE		4096
1782 
1783 /**
1784  * struct ethtool_per_queue_op - apply sub command to the queues in mask.
1785  * @cmd: ETHTOOL_PERQUEUE
1786  * @sub_command: the sub command which apply to each queues
1787  * @queue_mask: Bitmap of the queues which sub command apply to
1788  * @data: A complete command structure following for each of the queues addressed
1789  */
1790 struct ethtool_per_queue_op {
1791 	__u32	cmd;
1792 	__u32	sub_command;
1793 	__u32	queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)];
1794 	char	data[];
1795 };
1796 
1797 /**
1798  * struct ethtool_fecparam - Ethernet Forward Error Correction parameters
1799  * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM
1800  * @active_fec: FEC mode which is active on the port, single bit set, GET only.
1801  * @fec: Bitmask of configured FEC modes.
1802  * @reserved: Reserved for future extensions, ignore on GET, write 0 for SET.
1803  *
1804  * Note that @reserved was never validated on input and ethtool user space
1805  * left it uninitialized when calling SET. Hence going forward it can only be
1806  * used to return a value to userspace with GET.
1807  *
1808  * FEC modes supported by the device can be read via %ETHTOOL_GLINKSETTINGS.
1809  * FEC settings are configured by link autonegotiation whenever it's enabled.
1810  * With autoneg on %ETHTOOL_GFECPARAM can be used to read the current mode.
1811  *
1812  * When autoneg is disabled %ETHTOOL_SFECPARAM controls the FEC settings.
1813  * It is recommended that drivers only accept a single bit set in @fec.
1814  * When multiple bits are set in @fec drivers may pick mode in an implementation
1815  * dependent way. Drivers should reject mixing %ETHTOOL_FEC_AUTO_BIT with other
1816  * FEC modes, because it's unclear whether in this case other modes constrain
1817  * AUTO or are independent choices.
1818  * Drivers must reject SET requests if they support none of the requested modes.
1819  *
1820  * If device does not support FEC drivers may use %ETHTOOL_FEC_NONE instead
1821  * of returning %EOPNOTSUPP from %ETHTOOL_GFECPARAM.
1822  *
1823  * See enum ethtool_fec_config_bits for definition of valid bits for both
1824  * @fec and @active_fec.
1825  */
1826 struct ethtool_fecparam {
1827 	__u32   cmd;
1828 	/* bitmask of FEC modes */
1829 	__u32   active_fec;
1830 	__u32   fec;
1831 	__u32   reserved;
1832 };
1833 
1834 /**
1835  * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
1836  * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not
1837  *			be used together with other bits. GET only.
1838  * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually
1839  *			based link mode and SFP parameters read from module's
1840  *			EEPROM. This bit does _not_ mean autonegotiation.
1841  * @ETHTOOL_FEC_OFF_BIT: No FEC Mode
1842  * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode
1843  * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode
1844  * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet
1845  *			Consortium)
1846  */
1847 enum ethtool_fec_config_bits {
1848 	ETHTOOL_FEC_NONE_BIT,
1849 	ETHTOOL_FEC_AUTO_BIT,
1850 	ETHTOOL_FEC_OFF_BIT,
1851 	ETHTOOL_FEC_RS_BIT,
1852 	ETHTOOL_FEC_BASER_BIT,
1853 	ETHTOOL_FEC_LLRS_BIT,
1854 };
1855 
1856 #define ETHTOOL_FEC_NONE		(1 << ETHTOOL_FEC_NONE_BIT)
1857 #define ETHTOOL_FEC_AUTO		(1 << ETHTOOL_FEC_AUTO_BIT)
1858 #define ETHTOOL_FEC_OFF			(1 << ETHTOOL_FEC_OFF_BIT)
1859 #define ETHTOOL_FEC_RS			(1 << ETHTOOL_FEC_RS_BIT)
1860 #define ETHTOOL_FEC_BASER		(1 << ETHTOOL_FEC_BASER_BIT)
1861 #define ETHTOOL_FEC_LLRS		(1 << ETHTOOL_FEC_LLRS_BIT)
1862 
1863 /* CMDs currently supported */
1864 #define ETHTOOL_GSET		0x00000001 /* DEPRECATED, Get settings.
1865 					    * Please use ETHTOOL_GLINKSETTINGS
1866 					    */
1867 #define ETHTOOL_SSET		0x00000002 /* DEPRECATED, Set settings.
1868 					    * Please use ETHTOOL_SLINKSETTINGS
1869 					    */
1870 #define ETHTOOL_GDRVINFO	0x00000003 /* Get driver info. */
1871 #define ETHTOOL_GREGS		0x00000004 /* Get NIC registers. */
1872 #define ETHTOOL_GWOL		0x00000005 /* Get wake-on-lan options. */
1873 #define ETHTOOL_SWOL		0x00000006 /* Set wake-on-lan options. */
1874 #define ETHTOOL_GMSGLVL		0x00000007 /* Get driver message level */
1875 #define ETHTOOL_SMSGLVL		0x00000008 /* Set driver msg level. */
1876 #define ETHTOOL_NWAY_RST	0x00000009 /* Restart autonegotiation. */
1877 /* Get link status for host, i.e. whether the interface *and* the
1878  * physical port (if there is one) are up (ethtool_value). */
1879 #define ETHTOOL_GLINK		0x0000000a
1880 #define ETHTOOL_GEEPROM		0x0000000b /* Get EEPROM data */
1881 #define ETHTOOL_SEEPROM		0x0000000c /* Set EEPROM data. */
1882 #define ETHTOOL_GCOALESCE	0x0000000e /* Get coalesce config */
1883 #define ETHTOOL_SCOALESCE	0x0000000f /* Set coalesce config. */
1884 #define ETHTOOL_GRINGPARAM	0x00000010 /* Get ring parameters */
1885 #define ETHTOOL_SRINGPARAM	0x00000011 /* Set ring parameters. */
1886 #define ETHTOOL_GPAUSEPARAM	0x00000012 /* Get pause parameters */
1887 #define ETHTOOL_SPAUSEPARAM	0x00000013 /* Set pause parameters. */
1888 #define ETHTOOL_GRXCSUM		0x00000014 /* Get RX hw csum enable (ethtool_value) */
1889 #define ETHTOOL_SRXCSUM		0x00000015 /* Set RX hw csum enable (ethtool_value) */
1890 #define ETHTOOL_GTXCSUM		0x00000016 /* Get TX hw csum enable (ethtool_value) */
1891 #define ETHTOOL_STXCSUM		0x00000017 /* Set TX hw csum enable (ethtool_value) */
1892 #define ETHTOOL_GSG		0x00000018 /* Get scatter-gather enable
1893 					    * (ethtool_value) */
1894 #define ETHTOOL_SSG		0x00000019 /* Set scatter-gather enable
1895 					    * (ethtool_value). */
1896 #define ETHTOOL_TEST		0x0000001a /* execute NIC self-test. */
1897 #define ETHTOOL_GSTRINGS	0x0000001b /* get specified string set */
1898 #define ETHTOOL_PHYS_ID		0x0000001c /* identify the NIC */
1899 #define ETHTOOL_GSTATS		0x0000001d /* get NIC-specific statistics */
1900 #define ETHTOOL_GTSO		0x0000001e /* Get TSO enable (ethtool_value) */
1901 #define ETHTOOL_STSO		0x0000001f /* Set TSO enable (ethtool_value) */
1902 #define ETHTOOL_GPERMADDR	0x00000020 /* Get permanent hardware address */
1903 #define ETHTOOL_GUFO		0x00000021 /* Get UFO enable (ethtool_value) */
1904 #define ETHTOOL_SUFO		0x00000022 /* Set UFO enable (ethtool_value) */
1905 #define ETHTOOL_GGSO		0x00000023 /* Get GSO enable (ethtool_value) */
1906 #define ETHTOOL_SGSO		0x00000024 /* Set GSO enable (ethtool_value) */
1907 #define ETHTOOL_GFLAGS		0x00000025 /* Get flags bitmap(ethtool_value) */
1908 #define ETHTOOL_SFLAGS		0x00000026 /* Set flags bitmap(ethtool_value) */
1909 #define ETHTOOL_GPFLAGS		0x00000027 /* Get driver-private flags bitmap */
1910 #define ETHTOOL_SPFLAGS		0x00000028 /* Set driver-private flags bitmap */
1911 
1912 #define ETHTOOL_GRXFH		0x00000029 /* Get RX flow hash configuration */
1913 #define ETHTOOL_SRXFH		0x0000002a /* Set RX flow hash configuration */
1914 #define ETHTOOL_GGRO		0x0000002b /* Get GRO enable (ethtool_value) */
1915 #define ETHTOOL_SGRO		0x0000002c /* Set GRO enable (ethtool_value) */
1916 #define ETHTOOL_GRXRINGS	0x0000002d /* Get RX rings available for LB */
1917 #define ETHTOOL_GRXCLSRLCNT	0x0000002e /* Get RX class rule count */
1918 #define ETHTOOL_GRXCLSRULE	0x0000002f /* Get RX classification rule */
1919 #define ETHTOOL_GRXCLSRLALL	0x00000030 /* Get all RX classification rule */
1920 #define ETHTOOL_SRXCLSRLDEL	0x00000031 /* Delete RX classification rule */
1921 #define ETHTOOL_SRXCLSRLINS	0x00000032 /* Insert RX classification rule */
1922 #define ETHTOOL_FLASHDEV	0x00000033 /* Flash firmware to device */
1923 #define ETHTOOL_RESET		0x00000034 /* Reset hardware */
1924 #define ETHTOOL_SRXNTUPLE	0x00000035 /* Add an n-tuple filter to device */
1925 #define ETHTOOL_GRXNTUPLE	0x00000036 /* deprecated */
1926 #define ETHTOOL_GSSET_INFO	0x00000037 /* Get string set info */
1927 #define ETHTOOL_GRXFHINDIR	0x00000038 /* Get RX flow hash indir'n table */
1928 #define ETHTOOL_SRXFHINDIR	0x00000039 /* Set RX flow hash indir'n table */
1929 
1930 #define ETHTOOL_GFEATURES	0x0000003a /* Get device offload settings */
1931 #define ETHTOOL_SFEATURES	0x0000003b /* Change device offload settings */
1932 #define ETHTOOL_GCHANNELS	0x0000003c /* Get no of channels */
1933 #define ETHTOOL_SCHANNELS	0x0000003d /* Set no of channels */
1934 #define ETHTOOL_SET_DUMP	0x0000003e /* Set dump settings */
1935 #define ETHTOOL_GET_DUMP_FLAG	0x0000003f /* Get dump settings */
1936 #define ETHTOOL_GET_DUMP_DATA	0x00000040 /* Get dump data */
1937 #define ETHTOOL_GET_TS_INFO	0x00000041 /* Get time stamping and PHC info */
1938 #define ETHTOOL_GMODULEINFO	0x00000042 /* Get plug-in module information */
1939 #define ETHTOOL_GMODULEEEPROM	0x00000043 /* Get plug-in module eeprom */
1940 #define ETHTOOL_GEEE		0x00000044 /* Get EEE settings */
1941 #define ETHTOOL_SEEE		0x00000045 /* Set EEE settings */
1942 
1943 #define ETHTOOL_GRSSH		0x00000046 /* Get RX flow hash configuration */
1944 #define ETHTOOL_SRSSH		0x00000047 /* Set RX flow hash configuration */
1945 #define ETHTOOL_GTUNABLE	0x00000048 /* Get tunable configuration */
1946 #define ETHTOOL_STUNABLE	0x00000049 /* Set tunable configuration */
1947 #define ETHTOOL_GPHYSTATS	0x0000004a /* get PHY-specific statistics */
1948 
1949 #define ETHTOOL_PERQUEUE	0x0000004b /* Set per queue options */
1950 
1951 #define ETHTOOL_GLINKSETTINGS	0x0000004c /* Get ethtool_link_settings */
1952 #define ETHTOOL_SLINKSETTINGS	0x0000004d /* Set ethtool_link_settings */
1953 #define ETHTOOL_PHY_GTUNABLE	0x0000004e /* Get PHY tunable configuration */
1954 #define ETHTOOL_PHY_STUNABLE	0x0000004f /* Set PHY tunable configuration */
1955 #define ETHTOOL_GFECPARAM	0x00000050 /* Get FEC settings */
1956 #define ETHTOOL_SFECPARAM	0x00000051 /* Set FEC settings */
1957 
1958 /* compatibility with older code */
1959 #define SPARC_ETH_GSET		ETHTOOL_GSET
1960 #define SPARC_ETH_SSET		ETHTOOL_SSET
1961 
1962 /* Link mode bit indices */
1963 enum ethtool_link_mode_bit_indices {
1964 	ETHTOOL_LINK_MODE_10baseT_Half_BIT	= 0,
1965 	ETHTOOL_LINK_MODE_10baseT_Full_BIT	= 1,
1966 	ETHTOOL_LINK_MODE_100baseT_Half_BIT	= 2,
1967 	ETHTOOL_LINK_MODE_100baseT_Full_BIT	= 3,
1968 	ETHTOOL_LINK_MODE_1000baseT_Half_BIT	= 4,
1969 	ETHTOOL_LINK_MODE_1000baseT_Full_BIT	= 5,
1970 	ETHTOOL_LINK_MODE_Autoneg_BIT		= 6,
1971 	ETHTOOL_LINK_MODE_TP_BIT		= 7,
1972 	ETHTOOL_LINK_MODE_AUI_BIT		= 8,
1973 	ETHTOOL_LINK_MODE_MII_BIT		= 9,
1974 	ETHTOOL_LINK_MODE_FIBRE_BIT		= 10,
1975 	ETHTOOL_LINK_MODE_BNC_BIT		= 11,
1976 	ETHTOOL_LINK_MODE_10000baseT_Full_BIT	= 12,
1977 	ETHTOOL_LINK_MODE_Pause_BIT		= 13,
1978 	ETHTOOL_LINK_MODE_Asym_Pause_BIT	= 14,
1979 	ETHTOOL_LINK_MODE_2500baseX_Full_BIT	= 15,
1980 	ETHTOOL_LINK_MODE_Backplane_BIT		= 16,
1981 	ETHTOOL_LINK_MODE_1000baseKX_Full_BIT	= 17,
1982 	ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT	= 18,
1983 	ETHTOOL_LINK_MODE_10000baseKR_Full_BIT	= 19,
1984 	ETHTOOL_LINK_MODE_10000baseR_FEC_BIT	= 20,
1985 	ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21,
1986 	ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT	= 22,
1987 	ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT	= 23,
1988 	ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT	= 24,
1989 	ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT	= 25,
1990 	ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT	= 26,
1991 	ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT	= 27,
1992 	ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT	= 28,
1993 	ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT	= 29,
1994 	ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT	= 30,
1995 	ETHTOOL_LINK_MODE_25000baseCR_Full_BIT	= 31,
1996 
1997 	/* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit
1998 	 * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_*
1999 	 * macro for bits > 31. The only way to use indices > 31 is to
2000 	 * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API.
2001 	 */
2002 
2003 	ETHTOOL_LINK_MODE_25000baseKR_Full_BIT	= 32,
2004 	ETHTOOL_LINK_MODE_25000baseSR_Full_BIT	= 33,
2005 	ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT	= 34,
2006 	ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT	= 35,
2007 	ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT	= 36,
2008 	ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT	= 37,
2009 	ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT	= 38,
2010 	ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT	= 39,
2011 	ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT		= 40,
2012 	ETHTOOL_LINK_MODE_1000baseX_Full_BIT	= 41,
2013 	ETHTOOL_LINK_MODE_10000baseCR_Full_BIT	= 42,
2014 	ETHTOOL_LINK_MODE_10000baseSR_Full_BIT	= 43,
2015 	ETHTOOL_LINK_MODE_10000baseLR_Full_BIT	= 44,
2016 	ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT	= 45,
2017 	ETHTOOL_LINK_MODE_10000baseER_Full_BIT	= 46,
2018 	ETHTOOL_LINK_MODE_2500baseT_Full_BIT	= 47,
2019 	ETHTOOL_LINK_MODE_5000baseT_Full_BIT	= 48,
2020 
2021 	ETHTOOL_LINK_MODE_FEC_NONE_BIT	= 49,
2022 	ETHTOOL_LINK_MODE_FEC_RS_BIT	= 50,
2023 	ETHTOOL_LINK_MODE_FEC_BASER_BIT	= 51,
2024 	ETHTOOL_LINK_MODE_50000baseKR_Full_BIT		 = 52,
2025 	ETHTOOL_LINK_MODE_50000baseSR_Full_BIT		 = 53,
2026 	ETHTOOL_LINK_MODE_50000baseCR_Full_BIT		 = 54,
2027 	ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT	 = 55,
2028 	ETHTOOL_LINK_MODE_50000baseDR_Full_BIT		 = 56,
2029 	ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT	 = 57,
2030 	ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT	 = 58,
2031 	ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT	 = 59,
2032 	ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60,
2033 	ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT	 = 61,
2034 	ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT	 = 62,
2035 	ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT	 = 63,
2036 	ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64,
2037 	ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT	 = 65,
2038 	ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT	 = 66,
2039 	ETHTOOL_LINK_MODE_100baseT1_Full_BIT		 = 67,
2040 	ETHTOOL_LINK_MODE_1000baseT1_Full_BIT		 = 68,
2041 	ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT	 = 69,
2042 	ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT	 = 70,
2043 	ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71,
2044 	ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT	 = 72,
2045 	ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT	 = 73,
2046 	ETHTOOL_LINK_MODE_FEC_LLRS_BIT			 = 74,
2047 	ETHTOOL_LINK_MODE_100000baseKR_Full_BIT		 = 75,
2048 	ETHTOOL_LINK_MODE_100000baseSR_Full_BIT		 = 76,
2049 	ETHTOOL_LINK_MODE_100000baseLR_ER_FR_Full_BIT	 = 77,
2050 	ETHTOOL_LINK_MODE_100000baseCR_Full_BIT		 = 78,
2051 	ETHTOOL_LINK_MODE_100000baseDR_Full_BIT		 = 79,
2052 	ETHTOOL_LINK_MODE_200000baseKR2_Full_BIT	 = 80,
2053 	ETHTOOL_LINK_MODE_200000baseSR2_Full_BIT	 = 81,
2054 	ETHTOOL_LINK_MODE_200000baseLR2_ER2_FR2_Full_BIT = 82,
2055 	ETHTOOL_LINK_MODE_200000baseDR2_Full_BIT	 = 83,
2056 	ETHTOOL_LINK_MODE_200000baseCR2_Full_BIT	 = 84,
2057 	ETHTOOL_LINK_MODE_400000baseKR4_Full_BIT	 = 85,
2058 	ETHTOOL_LINK_MODE_400000baseSR4_Full_BIT	 = 86,
2059 	ETHTOOL_LINK_MODE_400000baseLR4_ER4_FR4_Full_BIT = 87,
2060 	ETHTOOL_LINK_MODE_400000baseDR4_Full_BIT	 = 88,
2061 	ETHTOOL_LINK_MODE_400000baseCR4_Full_BIT	 = 89,
2062 	ETHTOOL_LINK_MODE_100baseFX_Half_BIT		 = 90,
2063 	ETHTOOL_LINK_MODE_100baseFX_Full_BIT		 = 91,
2064 	ETHTOOL_LINK_MODE_10baseT1L_Full_BIT		 = 92,
2065 	ETHTOOL_LINK_MODE_800000baseCR8_Full_BIT	 = 93,
2066 	ETHTOOL_LINK_MODE_800000baseKR8_Full_BIT	 = 94,
2067 	ETHTOOL_LINK_MODE_800000baseDR8_Full_BIT	 = 95,
2068 	ETHTOOL_LINK_MODE_800000baseDR8_2_Full_BIT	 = 96,
2069 	ETHTOOL_LINK_MODE_800000baseSR8_Full_BIT	 = 97,
2070 	ETHTOOL_LINK_MODE_800000baseVR8_Full_BIT	 = 98,
2071 	ETHTOOL_LINK_MODE_10baseT1S_Full_BIT		 = 99,
2072 	ETHTOOL_LINK_MODE_10baseT1S_Half_BIT		 = 100,
2073 	ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT	 = 101,
2074 	ETHTOOL_LINK_MODE_10baseT1BRR_Full_BIT		 = 102,
2075 	ETHTOOL_LINK_MODE_200000baseCR_Full_BIT		 = 103,
2076 	ETHTOOL_LINK_MODE_200000baseKR_Full_BIT		 = 104,
2077 	ETHTOOL_LINK_MODE_200000baseDR_Full_BIT		 = 105,
2078 	ETHTOOL_LINK_MODE_200000baseDR_2_Full_BIT	 = 106,
2079 	ETHTOOL_LINK_MODE_200000baseSR_Full_BIT		 = 107,
2080 	ETHTOOL_LINK_MODE_200000baseVR_Full_BIT		 = 108,
2081 	ETHTOOL_LINK_MODE_400000baseCR2_Full_BIT	 = 109,
2082 	ETHTOOL_LINK_MODE_400000baseKR2_Full_BIT	 = 110,
2083 	ETHTOOL_LINK_MODE_400000baseDR2_Full_BIT	 = 111,
2084 	ETHTOOL_LINK_MODE_400000baseDR2_2_Full_BIT	 = 112,
2085 	ETHTOOL_LINK_MODE_400000baseSR2_Full_BIT	 = 113,
2086 	ETHTOOL_LINK_MODE_400000baseVR2_Full_BIT	 = 114,
2087 	ETHTOOL_LINK_MODE_800000baseCR4_Full_BIT	 = 115,
2088 	ETHTOOL_LINK_MODE_800000baseKR4_Full_BIT	 = 116,
2089 	ETHTOOL_LINK_MODE_800000baseDR4_Full_BIT	 = 117,
2090 	ETHTOOL_LINK_MODE_800000baseDR4_2_Full_BIT	 = 118,
2091 	ETHTOOL_LINK_MODE_800000baseSR4_Full_BIT	 = 119,
2092 	ETHTOOL_LINK_MODE_800000baseVR4_Full_BIT	 = 120,
2093 	ETHTOOL_LINK_MODE_1600000baseCR8_Full_BIT	 = 121,
2094 	ETHTOOL_LINK_MODE_1600000baseKR8_Full_BIT	 = 122,
2095 	ETHTOOL_LINK_MODE_1600000baseDR8_Full_BIT	 = 123,
2096 	ETHTOOL_LINK_MODE_1600000baseDR8_2_Full_BIT	 = 124,
2097 
2098 	/* must be last entry */
2099 	__ETHTOOL_LINK_MODE_MASK_NBITS
2100 };
2101 
2102 #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name)	\
2103 	(1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT))
2104 
2105 /* DEPRECATED macros. Please migrate to
2106  * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
2107  * define any new SUPPORTED_* macro for bits > 31.
2108  */
2109 #define SUPPORTED_10baseT_Half		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
2110 #define SUPPORTED_10baseT_Full		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
2111 #define SUPPORTED_100baseT_Half		__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
2112 #define SUPPORTED_100baseT_Full		__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
2113 #define SUPPORTED_1000baseT_Half	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
2114 #define SUPPORTED_1000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
2115 #define SUPPORTED_Autoneg		__ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
2116 #define SUPPORTED_TP			__ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
2117 #define SUPPORTED_AUI			__ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
2118 #define SUPPORTED_MII			__ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
2119 #define SUPPORTED_FIBRE			__ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
2120 #define SUPPORTED_BNC			__ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
2121 #define SUPPORTED_10000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
2122 #define SUPPORTED_Pause			__ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
2123 #define SUPPORTED_Asym_Pause		__ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
2124 #define SUPPORTED_2500baseX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
2125 #define SUPPORTED_Backplane		__ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
2126 #define SUPPORTED_1000baseKX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
2127 #define SUPPORTED_10000baseKX4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
2128 #define SUPPORTED_10000baseKR_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
2129 #define SUPPORTED_10000baseR_FEC	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
2130 #define SUPPORTED_20000baseMLD2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
2131 #define SUPPORTED_20000baseKR2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
2132 #define SUPPORTED_40000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
2133 #define SUPPORTED_40000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
2134 #define SUPPORTED_40000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
2135 #define SUPPORTED_40000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
2136 #define SUPPORTED_56000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
2137 #define SUPPORTED_56000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
2138 #define SUPPORTED_56000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
2139 #define SUPPORTED_56000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
2140 /* Please do not define any new SUPPORTED_* macro for bits > 31, see
2141  * notice above.
2142  */
2143 
2144 /*
2145  * DEPRECATED macros. Please migrate to
2146  * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
2147  * define any new ADERTISE_* macro for bits > 31.
2148  */
2149 #define ADVERTISED_10baseT_Half		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
2150 #define ADVERTISED_10baseT_Full		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
2151 #define ADVERTISED_100baseT_Half	__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
2152 #define ADVERTISED_100baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
2153 #define ADVERTISED_1000baseT_Half	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
2154 #define ADVERTISED_1000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
2155 #define ADVERTISED_Autoneg		__ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
2156 #define ADVERTISED_TP			__ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
2157 #define ADVERTISED_AUI			__ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
2158 #define ADVERTISED_MII			__ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
2159 #define ADVERTISED_FIBRE		__ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
2160 #define ADVERTISED_BNC			__ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
2161 #define ADVERTISED_10000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
2162 #define ADVERTISED_Pause		__ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
2163 #define ADVERTISED_Asym_Pause		__ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
2164 #define ADVERTISED_2500baseX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
2165 #define ADVERTISED_Backplane		__ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
2166 #define ADVERTISED_1000baseKX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
2167 #define ADVERTISED_10000baseKX4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
2168 #define ADVERTISED_10000baseKR_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
2169 #define ADVERTISED_10000baseR_FEC	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
2170 #define ADVERTISED_20000baseMLD2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
2171 #define ADVERTISED_20000baseKR2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
2172 #define ADVERTISED_40000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
2173 #define ADVERTISED_40000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
2174 #define ADVERTISED_40000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
2175 #define ADVERTISED_40000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
2176 #define ADVERTISED_56000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
2177 #define ADVERTISED_56000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
2178 #define ADVERTISED_56000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
2179 #define ADVERTISED_56000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
2180 /* Please do not define any new ADVERTISED_* macro for bits > 31, see
2181  * notice above.
2182  */
2183 
2184 /* The following are all involved in forcing a particular link
2185  * mode for the device for setting things.  When getting the
2186  * devices settings, these indicate the current mode and whether
2187  * it was forced up into this mode or autonegotiated.
2188  */
2189 
2190 /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal.
2191  * Update drivers/net/phy/phy.c:phy_speed_to_str() and
2192  * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values.
2193  */
2194 #define SPEED_10		10
2195 #define SPEED_100		100
2196 #define SPEED_1000		1000
2197 #define SPEED_2500		2500
2198 #define SPEED_5000		5000
2199 #define SPEED_10000		10000
2200 #define SPEED_14000		14000
2201 #define SPEED_20000		20000
2202 #define SPEED_25000		25000
2203 #define SPEED_40000		40000
2204 #define SPEED_50000		50000
2205 #define SPEED_56000		56000
2206 #define SPEED_80000		80000
2207 #define SPEED_100000		100000
2208 #define SPEED_200000		200000
2209 #define SPEED_400000		400000
2210 #define SPEED_800000		800000
2211 #define SPEED_1600000		1600000
2212 
2213 #define SPEED_UNKNOWN		-1
2214 
ethtool_validate_speed(__u32 speed)2215 static inline int ethtool_validate_speed(__u32 speed)
2216 {
2217 	return speed <= __KERNEL_INT_MAX || speed == (__u32)SPEED_UNKNOWN;
2218 }
2219 
2220 /* Duplex, half or full. */
2221 #define DUPLEX_HALF		0x00
2222 #define DUPLEX_FULL		0x01
2223 #define DUPLEX_UNKNOWN		0xff
2224 
ethtool_validate_duplex(__u8 duplex)2225 static inline int ethtool_validate_duplex(__u8 duplex)
2226 {
2227 	switch (duplex) {
2228 	case DUPLEX_HALF:
2229 	case DUPLEX_FULL:
2230 	case DUPLEX_UNKNOWN:
2231 		return 1;
2232 	}
2233 
2234 	return 0;
2235 }
2236 
2237 #define MASTER_SLAVE_CFG_UNSUPPORTED		0
2238 #define MASTER_SLAVE_CFG_UNKNOWN		1
2239 #define MASTER_SLAVE_CFG_MASTER_PREFERRED	2
2240 #define MASTER_SLAVE_CFG_SLAVE_PREFERRED	3
2241 #define MASTER_SLAVE_CFG_MASTER_FORCE		4
2242 #define MASTER_SLAVE_CFG_SLAVE_FORCE		5
2243 #define MASTER_SLAVE_STATE_UNSUPPORTED		0
2244 #define MASTER_SLAVE_STATE_UNKNOWN		1
2245 #define MASTER_SLAVE_STATE_MASTER		2
2246 #define MASTER_SLAVE_STATE_SLAVE		3
2247 #define MASTER_SLAVE_STATE_ERR			4
2248 
2249 /* These are used to throttle the rate of data on the phy interface when the
2250  * native speed of the interface is higher than the link speed. These should
2251  * not be used for phy interfaces which natively support multiple speeds (e.g.
2252  * MII or SGMII).
2253  */
2254 /* No rate matching performed. */
2255 #define RATE_MATCH_NONE		0
2256 /* The phy sends pause frames to throttle the MAC. */
2257 #define RATE_MATCH_PAUSE	1
2258 /* The phy asserts CRS to prevent the MAC from transmitting. */
2259 #define RATE_MATCH_CRS		2
2260 /* The MAC is programmed with a sufficiently-large IPG. */
2261 #define RATE_MATCH_OPEN_LOOP	3
2262 
2263 /* Which connector port. */
2264 #define PORT_TP			0x00
2265 #define PORT_AUI		0x01
2266 #define PORT_MII		0x02
2267 #define PORT_FIBRE		0x03
2268 #define PORT_BNC		0x04
2269 #define PORT_DA			0x05
2270 #define PORT_NONE		0xef
2271 #define PORT_OTHER		0xff
2272 
2273 /* Which transceiver to use. */
2274 #define XCVR_INTERNAL		0x00 /* PHY and MAC are in the same package */
2275 #define XCVR_EXTERNAL		0x01 /* PHY and MAC are in different packages */
2276 #define XCVR_DUMMY1		0x02
2277 #define XCVR_DUMMY2		0x03
2278 #define XCVR_DUMMY3		0x04
2279 
2280 /* Enable or disable autonegotiation. */
2281 #define AUTONEG_DISABLE		0x00
2282 #define AUTONEG_ENABLE		0x01
2283 
2284 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
2285  * the driver is required to renegotiate link
2286  */
2287 #define ETH_TP_MDI_INVALID	0x00 /* status: unknown; control: unsupported */
2288 #define ETH_TP_MDI		0x01 /* status: MDI;     control: force MDI */
2289 #define ETH_TP_MDI_X		0x02 /* status: MDI-X;   control: force MDI-X */
2290 #define ETH_TP_MDI_AUTO		0x03 /*                  control: auto-select */
2291 
2292 /* Wake-On-Lan options. */
2293 #define WAKE_PHY		(1 << 0)
2294 #define WAKE_UCAST		(1 << 1)
2295 #define WAKE_MCAST		(1 << 2)
2296 #define WAKE_BCAST		(1 << 3)
2297 #define WAKE_ARP		(1 << 4)
2298 #define WAKE_MAGIC		(1 << 5)
2299 #define WAKE_MAGICSECURE	(1 << 6) /* only meaningful if WAKE_MAGIC */
2300 #define WAKE_FILTER		(1 << 7)
2301 
2302 #define WOL_MODE_COUNT		8
2303 
2304 /* RSS hash function data
2305  * XOR the corresponding source and destination fields of each specified
2306  * protocol. Both copies of the XOR'ed fields are fed into the RSS and RXHASH
2307  * calculation. Note that this XORing reduces the input set entropy and could
2308  * be exploited to reduce the RSS queue spread.
2309  */
2310 #define	RXH_XFRM_SYM_XOR	(1 << 0)
2311 /* Similar to SYM_XOR, except that one copy of the XOR'ed fields is replaced by
2312  * an OR of the same fields
2313  */
2314 #define	RXH_XFRM_SYM_OR_XOR	(1 << 1)
2315 #define	RXH_XFRM_NO_CHANGE	0xff
2316 
2317 enum {
2318 	/* L2-L4 network traffic flow types */
2319 	TCP_V4_FLOW	= 0x01,	/* hash or spec (tcp_ip4_spec) */
2320 	UDP_V4_FLOW	= 0x02,	/* hash or spec (udp_ip4_spec) */
2321 	SCTP_V4_FLOW	= 0x03,	/* hash or spec (sctp_ip4_spec) */
2322 	AH_ESP_V4_FLOW	= 0x04,	/* hash only */
2323 	TCP_V6_FLOW	= 0x05,	/* hash or spec (tcp_ip6_spec; nfc only) */
2324 	UDP_V6_FLOW	= 0x06,	/* hash or spec (udp_ip6_spec; nfc only) */
2325 	SCTP_V6_FLOW	= 0x07,	/* hash or spec (sctp_ip6_spec; nfc only) */
2326 	AH_ESP_V6_FLOW	= 0x08,	/* hash only */
2327 	AH_V4_FLOW	= 0x09,	/* hash or spec (ah_ip4_spec) */
2328 	ESP_V4_FLOW	= 0x0a,	/* hash or spec (esp_ip4_spec) */
2329 	AH_V6_FLOW	= 0x0b,	/* hash or spec (ah_ip6_spec; nfc only) */
2330 	ESP_V6_FLOW	= 0x0c,	/* hash or spec (esp_ip6_spec; nfc only) */
2331 	IPV4_USER_FLOW	= 0x0d,	/* spec only (usr_ip4_spec) */
2332 	IP_USER_FLOW	= IPV4_USER_FLOW,
2333 	IPV6_USER_FLOW	= 0x0e, /* spec only (usr_ip6_spec; nfc only) */
2334 	IPV4_FLOW	= 0x10, /* hash only */
2335 	IPV6_FLOW	= 0x11, /* hash only */
2336 	ETHER_FLOW	= 0x12, /* hash or spec (ether_spec) */
2337 
2338 	/* Used for GTP-U IPv4 and IPv6.
2339 	 * The format of GTP packets only includes
2340 	 * elements such as TEID and GTP version.
2341 	 * It is primarily intended for data communication of the UE.
2342 	 */
2343 	GTPU_V4_FLOW	= 0x13,	/* hash only */
2344 	GTPU_V6_FLOW	= 0x14,	/* hash only */
2345 
2346 	/* Use for GTP-C IPv4 and v6.
2347 	 * The format of these GTP packets does not include TEID.
2348 	 * Primarily expected to be used for communication
2349 	 * to create sessions for UE data communication,
2350 	 * commonly referred to as CSR (Create Session Request).
2351 	 */
2352 	GTPC_V4_FLOW	= 0x15,	/* hash only */
2353 	GTPC_V6_FLOW	= 0x16,	/* hash only */
2354 
2355 	/* Use for GTP-C IPv4 and v6.
2356 	 * Unlike GTPC_V4_FLOW, the format of these GTP packets includes TEID.
2357 	 * After session creation, it becomes this packet.
2358 	 * This is mainly used for requests to realize UE handover.
2359 	 */
2360 	GTPC_TEID_V4_FLOW	= 0x17,	/* hash only */
2361 	GTPC_TEID_V6_FLOW	= 0x18,	/* hash only */
2362 
2363 	/* Use for GTP-U and extended headers for the PSC (PDU Session Container).
2364 	 * The format of these GTP packets includes TEID and QFI.
2365 	 * In 5G communication using UPF (User Plane Function),
2366 	 * data communication with this extended header is performed.
2367 	 */
2368 	GTPU_EH_V4_FLOW	= 0x19,	/* hash only */
2369 	GTPU_EH_V6_FLOW	= 0x1a,	/* hash only */
2370 
2371 	/* Use for GTP-U IPv4 and v6 PSC (PDU Session Container) extended headers.
2372 	 * This differs from GTPU_EH_V(4|6)_FLOW in that it is distinguished by
2373 	 * UL/DL included in the PSC.
2374 	 * There are differences in the data included based on Downlink/Uplink,
2375 	 * and can be used to distinguish packets.
2376 	 * The functions described so far are useful when you want to
2377 	 * handle communication from the mobile network in UPF, PGW, etc.
2378 	 */
2379 	GTPU_UL_V4_FLOW	= 0x1b,	/* hash only */
2380 	GTPU_UL_V6_FLOW	= 0x1c,	/* hash only */
2381 	GTPU_DL_V4_FLOW	= 0x1d,	/* hash only */
2382 	GTPU_DL_V6_FLOW	= 0x1e,	/* hash only */
2383 
2384 	__FLOW_TYPE_COUNT,
2385 };
2386 
2387 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
2388 #define	FLOW_EXT	0x80000000
2389 #define	FLOW_MAC_EXT	0x40000000
2390 /* Flag to enable RSS spreading of traffic matching rule (nfc only) */
2391 #define	FLOW_RSS	0x20000000
2392 
2393 /* L2-L4 network traffic flow hash options */
2394 #define	RXH_L2DA	(1 << 1)
2395 #define	RXH_VLAN	(1 << 2)
2396 #define	RXH_L3_PROTO	(1 << 3)
2397 #define	RXH_IP_SRC	(1 << 4)
2398 #define	RXH_IP_DST	(1 << 5)
2399 #define	RXH_L4_B_0_1	(1 << 6) /* src port in case of TCP/UDP/SCTP */
2400 #define	RXH_L4_B_2_3	(1 << 7) /* dst port in case of TCP/UDP/SCTP */
2401 #define	RXH_GTP_TEID	(1 << 8) /* teid in case of GTP */
2402 #define	RXH_IP6_FL	(1 << 9) /* IPv6 flow label */
2403 #define	RXH_DISCARD	(1 << 31)
2404 
2405 #define	RX_CLS_FLOW_DISC	0xffffffffffffffffULL
2406 #define RX_CLS_FLOW_WAKE	0xfffffffffffffffeULL
2407 
2408 /* Special RX classification rule insert location values */
2409 #define RX_CLS_LOC_SPECIAL	0x80000000	/* flag */
2410 #define RX_CLS_LOC_ANY		0xffffffff
2411 #define RX_CLS_LOC_FIRST	0xfffffffe
2412 #define RX_CLS_LOC_LAST		0xfffffffd
2413 
2414 /* EEPROM Standards for plug in modules */
2415 #define ETH_MODULE_SFF_8079		0x1
2416 #define ETH_MODULE_SFF_8079_LEN		256
2417 #define ETH_MODULE_SFF_8472		0x2
2418 #define ETH_MODULE_SFF_8472_LEN		512
2419 #define ETH_MODULE_SFF_8636		0x3
2420 #define ETH_MODULE_SFF_8636_LEN		256
2421 #define ETH_MODULE_SFF_8436		0x4
2422 #define ETH_MODULE_SFF_8436_LEN		256
2423 
2424 #define ETH_MODULE_SFF_8636_MAX_LEN     640
2425 #define ETH_MODULE_SFF_8436_MAX_LEN     640
2426 
2427 /* Reset flags */
2428 /* The reset() operation must clear the flags for the components which
2429  * were actually reset.  On successful return, the flags indicate the
2430  * components which were not reset, either because they do not exist
2431  * in the hardware or because they cannot be reset independently.  The
2432  * driver must never reset any components that were not requested.
2433  */
2434 enum ethtool_reset_flags {
2435 	/* These flags represent components dedicated to the interface
2436 	 * the command is addressed to.  Shift any flag left by
2437 	 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
2438 	 * same type.
2439 	 */
2440 	ETH_RESET_MGMT		= 1 << 0,	/* Management processor */
2441 	ETH_RESET_IRQ		= 1 << 1,	/* Interrupt requester */
2442 	ETH_RESET_DMA		= 1 << 2,	/* DMA engine */
2443 	ETH_RESET_FILTER	= 1 << 3,	/* Filtering/flow direction */
2444 	ETH_RESET_OFFLOAD	= 1 << 4,	/* Protocol offload */
2445 	ETH_RESET_MAC		= 1 << 5,	/* Media access controller */
2446 	ETH_RESET_PHY		= 1 << 6,	/* Transceiver/PHY */
2447 	ETH_RESET_RAM		= 1 << 7,	/* RAM shared between
2448 						 * multiple components */
2449 	ETH_RESET_AP		= 1 << 8,	/* Application processor */
2450 
2451 	ETH_RESET_DEDICATED	= 0x0000ffff,	/* All components dedicated to
2452 						 * this interface */
2453 	ETH_RESET_ALL		= 0xffffffff,	/* All components used by this
2454 						 * interface, even if shared */
2455 };
2456 #define ETH_RESET_SHARED_SHIFT	16
2457 
2458 
2459 /**
2460  * struct ethtool_link_settings - link control and status
2461  *
2462  * IMPORTANT, Backward compatibility notice: When implementing new
2463  *	user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and
2464  *	if it succeeds use %ETHTOOL_SLINKSETTINGS to change link
2465  *	settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS
2466  *	succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in
2467  *	that case.  Conversely, if %ETHTOOL_GLINKSETTINGS fails, use
2468  *	%ETHTOOL_GSET to query and %ETHTOOL_SSET to change link
2469  *	settings; do not use %ETHTOOL_SLINKSETTINGS if
2470  *	%ETHTOOL_GLINKSETTINGS failed: stick to
2471  *	%ETHTOOL_GSET/%ETHTOOL_SSET in that case.
2472  *
2473  * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS
2474  * @speed: Link speed (Mbps)
2475  * @duplex: Duplex mode; one of %DUPLEX_*
2476  * @port: Physical connector type; one of %PORT_*
2477  * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
2478  *	applicable.  For clause 45 PHYs this is the PRTAD.
2479  * @autoneg: Enable/disable autonegotiation and auto-detection;
2480  *	either %AUTONEG_DISABLE or %AUTONEG_ENABLE
2481  * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
2482  *	protocols supported by the interface; 0 if unknown.
2483  *	Read-only.
2484  * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
2485  *	%ETH_TP_MDI_*.  If the status is unknown or not applicable, the
2486  *	value will be %ETH_TP_MDI_INVALID.  Read-only.
2487  * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
2488  *	%ETH_TP_MDI_*.  If MDI(-X) control is not implemented, reads
2489  *	yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
2490  *	When written successfully, the link should be renegotiated if
2491  *	necessary.
2492  * @link_mode_masks_nwords: Number of 32-bit words for each of the
2493  *	supported, advertising, lp_advertising link mode bitmaps. For
2494  *	%ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user
2495  *	(>= 0); on return, if handshake in progress, negative if
2496  *	request size unsupported by kernel: absolute value indicates
2497  *	kernel expected size and all the other fields but cmd
2498  *	are 0; otherwise (handshake completed), strictly positive
2499  *	to indicate size used by kernel and cmd field stays
2500  *	%ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For
2501  *	%ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive
2502  *	value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise
2503  *	refused. For drivers: ignore this field (use kernel's
2504  *	__ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
2505  *	be overwritten by kernel.
2506  * @transceiver: Used to distinguish different possible PHY types,
2507  *	reported consistently by PHYLIB.  Read-only.
2508  * @master_slave_cfg: Master/slave port mode.
2509  * @master_slave_state: Master/slave port state.
2510  * @rate_matching: Rate adaptation performed by the PHY
2511  * @reserved: Reserved for future use; see the note on reserved space.
2512  * @link_mode_masks: Variable length bitmaps.
2513  *
2514  * If autonegotiation is disabled, the speed and @duplex represent the
2515  * fixed link mode and are writable if the driver supports multiple
2516  * link modes.  If it is enabled then they are read-only; if the link
2517  * is up they represent the negotiated link mode; if the link is down,
2518  * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
2519  * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
2520  *
2521  * Some hardware interfaces may have multiple PHYs and/or physical
2522  * connectors fitted or do not allow the driver to detect which are
2523  * fitted.  For these interfaces @port and/or @phy_address may be
2524  * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
2525  * Otherwise, attempts to write different values may be ignored or
2526  * rejected.
2527  *
2528  * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt
2529  * are not available in %ethtool_link_settings. These fields will be
2530  * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will
2531  * fail if any of them is set to non-zero value.
2532  *
2533  * Users should assume that all fields not marked read-only are
2534  * writable and subject to validation by the driver.  They should use
2535  * %ETHTOOL_GLINKSETTINGS to get the current values before making specific
2536  * changes and then applying them with %ETHTOOL_SLINKSETTINGS.
2537  *
2538  * Drivers that implement %get_link_ksettings and/or
2539  * %set_link_ksettings should ignore the @cmd
2540  * and @link_mode_masks_nwords fields (any change to them overwritten
2541  * by kernel), and rely only on kernel's internal
2542  * %__ETHTOOL_LINK_MODE_MASK_NBITS and
2543  * %ethtool_link_mode_mask_t. Drivers that implement
2544  * %set_link_ksettings() should validate all fields other than @cmd
2545  * and @link_mode_masks_nwords that are not described as read-only or
2546  * deprecated, and must ignore all fields described as read-only.
2547  *
2548  * @link_mode_masks is divided into three bitfields, each of length
2549  * @link_mode_masks_nwords:
2550  * - supported: Bitmap with each bit meaning given by
2551  *	%ethtool_link_mode_bit_indices for the link modes, physical
2552  *	connectors and other link features for which the interface
2553  *	supports autonegotiation or auto-detection.  Read-only.
2554  * - advertising: Bitmap with each bit meaning given by
2555  *	%ethtool_link_mode_bit_indices for the link modes, physical
2556  *	connectors and other link features that are advertised through
2557  *	autonegotiation or enabled for auto-detection.
2558  * - lp_advertising: Bitmap with each bit meaning given by
2559  *	%ethtool_link_mode_bit_indices for the link modes, and other
2560  *	link features that the link partner advertised through
2561  *	autonegotiation; 0 if unknown or not applicable.  Read-only.
2562  */
2563 struct ethtool_link_settings {
2564 	__u32	cmd;
2565 	__u32	speed;
2566 	__u8	duplex;
2567 	__u8	port;
2568 	__u8	phy_address;
2569 	__u8	autoneg;
2570 	__u8	mdio_support;
2571 	__u8	eth_tp_mdix;
2572 	__u8	eth_tp_mdix_ctrl;
2573 	__s8	link_mode_masks_nwords;
2574 	__u8	transceiver;
2575 	__u8	master_slave_cfg;
2576 	__u8	master_slave_state;
2577 	__u8	rate_matching;
2578 	__u32	reserved[7];
2579 #ifndef __KERNEL__
2580 	/* Linux builds with -Wflex-array-member-not-at-end but does
2581 	 * not use the "link_mode_masks" member. Leave it defined for
2582 	 * userspace for now, and when userspace wants to start using
2583 	 * -Wfamnae, we'll need a new solution.
2584 	 */
2585 	__u32	link_mode_masks[];
2586 	/* layout of link_mode_masks fields:
2587 	 * __u32 map_supported[link_mode_masks_nwords];
2588 	 * __u32 map_advertising[link_mode_masks_nwords];
2589 	 * __u32 map_lp_advertising[link_mode_masks_nwords];
2590 	 */
2591 #endif
2592 };
2593 
2594 /**
2595  * enum phy_upstream - Represents the upstream component a given PHY device
2596  * is connected to, as in what is on the other end of the MII bus. Most PHYs
2597  * will be attached to an Ethernet MAC controller, but in some cases, there's
2598  * an intermediate PHY used as a media-converter, which will driver another
2599  * MII interface as its output.
2600  * @PHY_UPSTREAM_MAC: Upstream component is a MAC (a switch port,
2601  *		      or ethernet controller)
2602  * @PHY_UPSTREAM_PHY: Upstream component is a PHY (likely a media converter)
2603  */
2604 enum phy_upstream {
2605 	PHY_UPSTREAM_MAC,
2606 	PHY_UPSTREAM_PHY,
2607 };
2608 
2609 #endif /* _UAPI_LINUX_ETHTOOL_H */
2610