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 _LINUX_ETHTOOL_H
15 #define _LINUX_ETHTOOL_H
16 
17 #include "net/eth.h"
18 
19 #include "standard-headers/linux/kernel.h"
20 #include "standard-headers/linux/types.h"
21 #include "standard-headers/linux/if_ether.h"
22 
23 #include <limits.h> /* for INT_MAX */
24 
25 /* All structures exposed to userland should be defined such that they
26  * have the same layout for 32-bit and 64-bit userland.
27  */
28 
29 /**
30  * struct ethtool_cmd - DEPRECATED, link control and status
31  * This structure is DEPRECATED, please use struct ethtool_link_settings.
32  * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET
33  * @supported: Bitmask of %SUPPORTED_* flags for the link modes,
34  *	physical connectors and other link features for which the
35  *	interface supports autonegotiation or auto-detection.
36  *	Read-only.
37  * @advertising: Bitmask of %ADVERTISED_* flags for the link modes,
38  *	physical connectors and other link features that are
39  *	advertised through autonegotiation or enabled for
40  *	auto-detection.
41  * @speed: Low bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
42  * @duplex: Duplex mode; one of %DUPLEX_*
43  * @port: Physical connector type; one of %PORT_*
44  * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
45  *	applicable.  For clause 45 PHYs this is the PRTAD.
46  * @transceiver: Historically used to distinguish different possible
47  *	PHY types, but not in a consistent way.  Deprecated.
48  * @autoneg: Enable/disable autonegotiation and auto-detection;
49  *	either %AUTONEG_DISABLE or %AUTONEG_ENABLE
50  * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
51  *	protocols supported by the interface; 0 if unknown.
52  *	Read-only.
53  * @maxtxpkt: Historically used to report TX IRQ coalescing; now
54  *	obsoleted by &struct ethtool_coalesce.  Read-only; deprecated.
55  * @maxrxpkt: Historically used to report RX IRQ coalescing; now
56  *	obsoleted by &struct ethtool_coalesce.  Read-only; deprecated.
57  * @speed_hi: High bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
58  * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
59  *	%ETH_TP_MDI_*.  If the status is unknown or not applicable, the
60  *	value will be %ETH_TP_MDI_INVALID.  Read-only.
61  * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
62  *	%ETH_TP_MDI_*.  If MDI(-X) control is not implemented, reads
63  *	yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
64  *	When written successfully, the link should be renegotiated if
65  *	necessary.
66  * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes
67  *	and other link features that the link partner advertised
68  *	through autonegotiation; 0 if unknown or not applicable.
69  *	Read-only.
70  *
71  * The link speed in Mbps is split between @speed and @speed_hi.  Use
72  * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to
73  * access it.
74  *
75  * If autonegotiation is disabled, the speed and @duplex represent the
76  * fixed link mode and are writable if the driver supports multiple
77  * link modes.  If it is enabled then they are read-only; if the link
78  * is up they represent the negotiated link mode; if the link is down,
79  * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
80  * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
81  *
82  * Some hardware interfaces may have multiple PHYs and/or physical
83  * connectors fitted or do not allow the driver to detect which are
84  * fitted.  For these interfaces @port and/or @phy_address may be
85  * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
86  * Otherwise, attempts to write different values may be ignored or
87  * rejected.
88  *
89  * Users should assume that all fields not marked read-only are
90  * writable and subject to validation by the driver.  They should use
91  * %ETHTOOL_GSET to get the current values before making specific
92  * changes and then applying them with %ETHTOOL_SSET.
93  *
94  * Deprecated fields should be ignored by both users and drivers.
95  */
96 struct ethtool_cmd {
97 	uint32_t	cmd;
98 	uint32_t	supported;
99 	uint32_t	advertising;
100 	uint16_t	speed;
101 	uint8_t	duplex;
102 	uint8_t	port;
103 	uint8_t	phy_address;
104 	uint8_t	transceiver;
105 	uint8_t	autoneg;
106 	uint8_t	mdio_support;
107 	uint32_t	maxtxpkt;
108 	uint32_t	maxrxpkt;
109 	uint16_t	speed_hi;
110 	uint8_t	eth_tp_mdix;
111 	uint8_t	eth_tp_mdix_ctrl;
112 	uint32_t	lp_advertising;
113 	uint32_t	reserved[2];
114 };
115 
116 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
117 					 uint32_t speed)
118 {
119 	ep->speed = (uint16_t)(speed & 0xFFFF);
120 	ep->speed_hi = (uint16_t)(speed >> 16);
121 }
122 
123 static inline uint32_t ethtool_cmd_speed(const struct ethtool_cmd *ep)
124 {
125 	return (ep->speed_hi << 16) | ep->speed;
126 }
127 
128 /* Device supports clause 22 register access to PHY or peripherals
129  * using the interface defined in "standard-headers/linux/mii.h".  This should not be
130  * set if there are known to be no such peripherals present or if
131  * the driver only emulates clause 22 registers for compatibility.
132  */
133 #define ETH_MDIO_SUPPORTS_C22	1
134 
135 /* Device supports clause 45 register access to PHY or peripherals
136  * using the interface defined in "standard-headers/linux/mii.h" and <linux/mdio.h>.
137  * This should not be set if there are known to be no such peripherals
138  * present.
139  */
140 #define ETH_MDIO_SUPPORTS_C45	2
141 
142 #define ETHTOOL_FWVERS_LEN	32
143 #define ETHTOOL_BUSINFO_LEN	32
144 #define ETHTOOL_EROMVERS_LEN	32
145 
146 /**
147  * struct ethtool_drvinfo - general driver and device information
148  * @cmd: Command number = %ETHTOOL_GDRVINFO
149  * @driver: Driver short name.  This should normally match the name
150  *	in its bus driver structure (e.g. pci_driver::name).  Must
151  *	not be an empty string.
152  * @version: Driver version string; may be an empty string
153  * @fw_version: Firmware version string; may be an empty string
154  * @erom_version: Expansion ROM version string; may be an empty string
155  * @bus_info: Device bus address.  This should match the dev_name()
156  *	string for the underlying bus device, if there is one.  May be
157  *	an empty string.
158  * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and
159  *	%ETHTOOL_SPFLAGS commands; also the number of strings in the
160  *	%ETH_SS_PRIV_FLAGS set
161  * @n_stats: Number of uint64_t statistics returned by the %ETHTOOL_GSTATS
162  *	command; also the number of strings in the %ETH_SS_STATS set
163  * @testinfo_len: Number of results returned by the %ETHTOOL_TEST
164  *	command; also the number of strings in the %ETH_SS_TEST set
165  * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM
166  *	and %ETHTOOL_SEEPROM commands, in bytes
167  * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS
168  *	command, in bytes
169  *
170  * Users can use the %ETHTOOL_GSSET_INFO command to get the number of
171  * strings in any string set (from Linux 2.6.34).
172  *
173  * Drivers should set at most @driver, @version, @fw_version and
174  * @bus_info in their get_drvinfo() implementation.  The ethtool
175  * core fills in the other fields using other driver operations.
176  */
177 struct ethtool_drvinfo {
178 	uint32_t	cmd;
179 	char	driver[32];
180 	char	version[32];
181 	char	fw_version[ETHTOOL_FWVERS_LEN];
182 	char	bus_info[ETHTOOL_BUSINFO_LEN];
183 	char	erom_version[ETHTOOL_EROMVERS_LEN];
184 	char	reserved2[12];
185 	uint32_t	n_priv_flags;
186 	uint32_t	n_stats;
187 	uint32_t	testinfo_len;
188 	uint32_t	eedump_len;
189 	uint32_t	regdump_len;
190 };
191 
192 #define SOPASS_MAX	6
193 
194 /**
195  * struct ethtool_wolinfo - Wake-On-Lan configuration
196  * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL
197  * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes.
198  *	Read-only.
199  * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
200  * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE
201  *	is set in @wolopts.
202  */
203 struct ethtool_wolinfo {
204 	uint32_t	cmd;
205 	uint32_t	supported;
206 	uint32_t	wolopts;
207 	uint8_t	sopass[SOPASS_MAX];
208 };
209 
210 /* for passing single values */
211 struct ethtool_value {
212 	uint32_t	cmd;
213 	uint32_t	data;
214 };
215 
216 #define PFC_STORM_PREVENTION_AUTO	0xffff
217 #define PFC_STORM_PREVENTION_DISABLE	0
218 
219 enum tunable_id {
220 	ETHTOOL_ID_UNSPEC,
221 	ETHTOOL_RX_COPYBREAK,
222 	ETHTOOL_TX_COPYBREAK,
223 	ETHTOOL_PFC_PREVENTION_TOUT, /* timeout in msecs */
224 	/*
225 	 * Add your fresh new tunable attribute above and remember to update
226 	 * tunable_strings[] in net/core/ethtool.c
227 	 */
228 	__ETHTOOL_TUNABLE_COUNT,
229 };
230 
231 enum tunable_type_id {
232 	ETHTOOL_TUNABLE_UNSPEC,
233 	ETHTOOL_TUNABLE_U8,
234 	ETHTOOL_TUNABLE_U16,
235 	ETHTOOL_TUNABLE_U32,
236 	ETHTOOL_TUNABLE_U64,
237 	ETHTOOL_TUNABLE_STRING,
238 	ETHTOOL_TUNABLE_S8,
239 	ETHTOOL_TUNABLE_S16,
240 	ETHTOOL_TUNABLE_S32,
241 	ETHTOOL_TUNABLE_S64,
242 };
243 
244 struct ethtool_tunable {
245 	uint32_t	cmd;
246 	uint32_t	id;
247 	uint32_t	type_id;
248 	uint32_t	len;
249 	void	*data[0];
250 };
251 
252 #define DOWNSHIFT_DEV_DEFAULT_COUNT	0xff
253 #define DOWNSHIFT_DEV_DISABLE		0
254 
255 /* Time in msecs after which link is reported as down
256  * 0 = lowest time supported by the PHY
257  * 0xff = off, link down detection according to standard
258  */
259 #define ETHTOOL_PHY_FAST_LINK_DOWN_ON	0
260 #define ETHTOOL_PHY_FAST_LINK_DOWN_OFF	0xff
261 
262 /* Energy Detect Power Down (EDPD) is a feature supported by some PHYs, where
263  * the PHY's RX & TX blocks are put into a low-power mode when there is no
264  * link detected (typically cable is un-plugged). For RX, only a minimal
265  * link-detection is available, and for TX the PHY wakes up to send link pulses
266  * to avoid any lock-ups in case the peer PHY may also be running in EDPD mode.
267  *
268  * Some PHYs may support configuration of the wake-up interval for TX pulses,
269  * and some PHYs may support only disabling TX pulses entirely. For the latter
270  * a special value is required (ETHTOOL_PHY_EDPD_NO_TX) so that this can be
271  * configured from userspace (should the user want it).
272  *
273  * The interval units for TX wake-up are in milliseconds, since this should
274  * cover a reasonable range of intervals:
275  *  - from 1 millisecond, which does not sound like much of a power-saver
276  *  - to ~65 seconds which is quite a lot to wait for a link to come up when
277  *    plugging a cable
278  */
279 #define ETHTOOL_PHY_EDPD_DFLT_TX_MSECS		0xffff
280 #define ETHTOOL_PHY_EDPD_NO_TX			0xfffe
281 #define ETHTOOL_PHY_EDPD_DISABLE		0
282 
283 enum phy_tunable_id {
284 	ETHTOOL_PHY_ID_UNSPEC,
285 	ETHTOOL_PHY_DOWNSHIFT,
286 	ETHTOOL_PHY_FAST_LINK_DOWN,
287 	ETHTOOL_PHY_EDPD,
288 	/*
289 	 * Add your fresh new phy tunable attribute above and remember to update
290 	 * phy_tunable_strings[] in net/core/ethtool.c
291 	 */
292 	__ETHTOOL_PHY_TUNABLE_COUNT,
293 };
294 
295 /**
296  * struct ethtool_regs - hardware register dump
297  * @cmd: Command number = %ETHTOOL_GREGS
298  * @version: Dump format version.  This is driver-specific and may
299  *	distinguish different chips/revisions.  Drivers must use new
300  *	version numbers whenever the dump format changes in an
301  *	incompatible way.
302  * @len: On entry, the real length of @data.  On return, the number of
303  *	bytes used.
304  * @data: Buffer for the register dump
305  *
306  * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
307  * a register dump for the interface.  They must allocate the buffer
308  * immediately following this structure.
309  */
310 struct ethtool_regs {
311 	uint32_t	cmd;
312 	uint32_t	version;
313 	uint32_t	len;
314 	uint8_t	data[0];
315 };
316 
317 /**
318  * struct ethtool_eeprom - EEPROM dump
319  * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or
320  *	%ETHTOOL_SEEPROM
321  * @magic: A 'magic cookie' value to guard against accidental changes.
322  *	The value passed in to %ETHTOOL_SEEPROM must match the value
323  *	returned by %ETHTOOL_GEEPROM for the same device.  This is
324  *	unused when @cmd is %ETHTOOL_GMODULEEEPROM.
325  * @offset: Offset within the EEPROM to begin reading/writing, in bytes
326  * @len: On entry, number of bytes to read/write.  On successful
327  *	return, number of bytes actually read/written.  In case of
328  *	error, this may indicate at what point the error occurred.
329  * @data: Buffer to read/write from
330  *
331  * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find
332  * the length of an on-board or module EEPROM, respectively.  They
333  * must allocate the buffer immediately following this structure.
334  */
335 struct ethtool_eeprom {
336 	uint32_t	cmd;
337 	uint32_t	magic;
338 	uint32_t	offset;
339 	uint32_t	len;
340 	uint8_t	data[0];
341 };
342 
343 /**
344  * struct ethtool_eee - Energy Efficient Ethernet information
345  * @cmd: ETHTOOL_{G,S}EEE
346  * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
347  *	for which there is EEE support.
348  * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
349  *	advertised as eee capable.
350  * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
351  *	combinations advertised by the link partner as eee capable.
352  * @eee_active: Result of the eee auto negotiation.
353  * @eee_enabled: EEE configured mode (enabled/disabled).
354  * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
355  *	that eee was negotiated.
356  * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
357  *	its tx lpi (after reaching 'idle' state). Effective only when eee
358  *	was negotiated and tx_lpi_enabled was set.
359  */
360 struct ethtool_eee {
361 	uint32_t	cmd;
362 	uint32_t	supported;
363 	uint32_t	advertised;
364 	uint32_t	lp_advertised;
365 	uint32_t	eee_active;
366 	uint32_t	eee_enabled;
367 	uint32_t	tx_lpi_enabled;
368 	uint32_t	tx_lpi_timer;
369 	uint32_t	reserved[2];
370 };
371 
372 /**
373  * struct ethtool_modinfo - plugin module eeprom information
374  * @cmd: %ETHTOOL_GMODULEINFO
375  * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
376  * @eeprom_len: Length of the eeprom
377  *
378  * This structure is used to return the information to
379  * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
380  * The type code indicates the eeprom data format
381  */
382 struct ethtool_modinfo {
383 	uint32_t   cmd;
384 	uint32_t   type;
385 	uint32_t   eeprom_len;
386 	uint32_t   reserved[8];
387 };
388 
389 /**
390  * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
391  * @cmd: ETHTOOL_{G,S}COALESCE
392  * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
393  *	a packet arrives.
394  * @rx_max_coalesced_frames: Maximum number of packets to receive
395  *	before an RX interrupt.
396  * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
397  *	this value applies while an IRQ is being serviced by the host.
398  * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
399  *	except that this value applies while an IRQ is being serviced
400  *	by the host.
401  * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
402  *	a packet is sent.
403  * @tx_max_coalesced_frames: Maximum number of packets to be sent
404  *	before a TX interrupt.
405  * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
406  *	this value applies while an IRQ is being serviced by the host.
407  * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
408  *	except that this value applies while an IRQ is being serviced
409  *	by the host.
410  * @stats_block_coalesce_usecs: How many usecs to delay in-memory
411  *	statistics block updates.  Some drivers do not have an
412  *	in-memory statistic block, and in such cases this value is
413  *	ignored.  This value must not be zero.
414  * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
415  * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
416  * @pkt_rate_low: Threshold for low packet rate (packets per second).
417  * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
418  *	a packet arrives, when the packet rate is below @pkt_rate_low.
419  * @rx_max_coalesced_frames_low: Maximum number of packets to be received
420  *	before an RX interrupt, when the packet rate is below @pkt_rate_low.
421  * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
422  *	a packet is sent, when the packet rate is below @pkt_rate_low.
423  * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
424  *	a TX interrupt, when the packet rate is below @pkt_rate_low.
425  * @pkt_rate_high: Threshold for high packet rate (packets per second).
426  * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
427  *	a packet arrives, when the packet rate is above @pkt_rate_high.
428  * @rx_max_coalesced_frames_high: Maximum number of packets to be received
429  *	before an RX interrupt, when the packet rate is above @pkt_rate_high.
430  * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
431  *	a packet is sent, when the packet rate is above @pkt_rate_high.
432  * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
433  *	a TX interrupt, when the packet rate is above @pkt_rate_high.
434  * @rate_sample_interval: How often to do adaptive coalescing packet rate
435  *	sampling, measured in seconds.  Must not be zero.
436  *
437  * Each pair of (usecs, max_frames) fields specifies that interrupts
438  * should be coalesced until
439  *	(usecs > 0 && time_since_first_completion >= usecs) ||
440  *	(max_frames > 0 && completed_frames >= max_frames)
441  *
442  * It is illegal to set both usecs and max_frames to zero as this
443  * would cause interrupts to never be generated.  To disable
444  * coalescing, set usecs = 0 and max_frames = 1.
445  *
446  * Some implementations ignore the value of max_frames and use the
447  * condition time_since_first_completion >= usecs
448  *
449  * This is deprecated.  Drivers for hardware that does not support
450  * counting completions should validate that max_frames == !rx_usecs.
451  *
452  * Adaptive RX/TX coalescing is an algorithm implemented by some
453  * drivers to improve latency under low packet rates and improve
454  * throughput under high packet rates.  Some drivers only implement
455  * one of RX or TX adaptive coalescing.  Anything not implemented by
456  * the driver causes these values to be silently ignored.
457  *
458  * When the packet rate is below @pkt_rate_high but above
459  * @pkt_rate_low (both measured in packets per second) the
460  * normal {rx,tx}_* coalescing parameters are used.
461  */
462 struct ethtool_coalesce {
463 	uint32_t	cmd;
464 	uint32_t	rx_coalesce_usecs;
465 	uint32_t	rx_max_coalesced_frames;
466 	uint32_t	rx_coalesce_usecs_irq;
467 	uint32_t	rx_max_coalesced_frames_irq;
468 	uint32_t	tx_coalesce_usecs;
469 	uint32_t	tx_max_coalesced_frames;
470 	uint32_t	tx_coalesce_usecs_irq;
471 	uint32_t	tx_max_coalesced_frames_irq;
472 	uint32_t	stats_block_coalesce_usecs;
473 	uint32_t	use_adaptive_rx_coalesce;
474 	uint32_t	use_adaptive_tx_coalesce;
475 	uint32_t	pkt_rate_low;
476 	uint32_t	rx_coalesce_usecs_low;
477 	uint32_t	rx_max_coalesced_frames_low;
478 	uint32_t	tx_coalesce_usecs_low;
479 	uint32_t	tx_max_coalesced_frames_low;
480 	uint32_t	pkt_rate_high;
481 	uint32_t	rx_coalesce_usecs_high;
482 	uint32_t	rx_max_coalesced_frames_high;
483 	uint32_t	tx_coalesce_usecs_high;
484 	uint32_t	tx_max_coalesced_frames_high;
485 	uint32_t	rate_sample_interval;
486 };
487 
488 /**
489  * struct ethtool_ringparam - RX/TX ring parameters
490  * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM
491  * @rx_max_pending: Maximum supported number of pending entries per
492  *	RX ring.  Read-only.
493  * @rx_mini_max_pending: Maximum supported number of pending entries
494  *	per RX mini ring.  Read-only.
495  * @rx_jumbo_max_pending: Maximum supported number of pending entries
496  *	per RX jumbo ring.  Read-only.
497  * @tx_max_pending: Maximum supported number of pending entries per
498  *	TX ring.  Read-only.
499  * @rx_pending: Current maximum number of pending entries per RX ring
500  * @rx_mini_pending: Current maximum number of pending entries per RX
501  *	mini ring
502  * @rx_jumbo_pending: Current maximum number of pending entries per RX
503  *	jumbo ring
504  * @tx_pending: Current maximum supported number of pending entries
505  *	per TX ring
506  *
507  * If the interface does not have separate RX mini and/or jumbo rings,
508  * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0.
509  *
510  * There may also be driver-dependent minimum values for the number
511  * of entries per ring.
512  */
513 struct ethtool_ringparam {
514 	uint32_t	cmd;
515 	uint32_t	rx_max_pending;
516 	uint32_t	rx_mini_max_pending;
517 	uint32_t	rx_jumbo_max_pending;
518 	uint32_t	tx_max_pending;
519 	uint32_t	rx_pending;
520 	uint32_t	rx_mini_pending;
521 	uint32_t	rx_jumbo_pending;
522 	uint32_t	tx_pending;
523 };
524 
525 /**
526  * struct ethtool_channels - configuring number of network channel
527  * @cmd: ETHTOOL_{G,S}CHANNELS
528  * @max_rx: Read only. Maximum number of receive channel the driver support.
529  * @max_tx: Read only. Maximum number of transmit channel the driver support.
530  * @max_other: Read only. Maximum number of other channel the driver support.
531  * @max_combined: Read only. Maximum number of combined channel the driver
532  *	support. Set of queues RX, TX or other.
533  * @rx_count: Valid values are in the range 1 to the max_rx.
534  * @tx_count: Valid values are in the range 1 to the max_tx.
535  * @other_count: Valid values are in the range 1 to the max_other.
536  * @combined_count: Valid values are in the range 1 to the max_combined.
537  *
538  * This can be used to configure RX, TX and other channels.
539  */
540 
541 struct ethtool_channels {
542 	uint32_t	cmd;
543 	uint32_t	max_rx;
544 	uint32_t	max_tx;
545 	uint32_t	max_other;
546 	uint32_t	max_combined;
547 	uint32_t	rx_count;
548 	uint32_t	tx_count;
549 	uint32_t	other_count;
550 	uint32_t	combined_count;
551 };
552 
553 /**
554  * struct ethtool_pauseparam - Ethernet pause (flow control) parameters
555  * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM
556  * @autoneg: Flag to enable autonegotiation of pause frame use
557  * @rx_pause: Flag to enable reception of pause frames
558  * @tx_pause: Flag to enable transmission of pause frames
559  *
560  * Drivers should reject a non-zero setting of @autoneg when
561  * autoneogotiation is disabled (or not supported) for the link.
562  *
563  * If the link is autonegotiated, drivers should use
564  * mii_advertise_flowctrl() or similar code to set the advertised
565  * pause frame capabilities based on the @rx_pause and @tx_pause flags,
566  * even if @autoneg is zero.  They should also allow the advertised
567  * pause frame capabilities to be controlled directly through the
568  * advertising field of &struct ethtool_cmd.
569  *
570  * If @autoneg is non-zero, the MAC is configured to send and/or
571  * receive pause frames according to the result of autonegotiation.
572  * Otherwise, it is configured directly based on the @rx_pause and
573  * @tx_pause flags.
574  */
575 struct ethtool_pauseparam {
576 	uint32_t	cmd;
577 	uint32_t	autoneg;
578 	uint32_t	rx_pause;
579 	uint32_t	tx_pause;
580 };
581 
582 #define ETH_GSTRING_LEN		32
583 
584 /**
585  * enum ethtool_stringset - string set ID
586  * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST
587  * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS
588  * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with
589  *	%ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS
590  * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE;
591  *	now deprecated
592  * @ETH_SS_FEATURES: Device feature names
593  * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names
594  * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS
595  * @ETH_SS_PHY_TUNABLES: PHY tunable names
596  */
597 enum ethtool_stringset {
598 	ETH_SS_TEST		= 0,
599 	ETH_SS_STATS,
600 	ETH_SS_PRIV_FLAGS,
601 	ETH_SS_NTUPLE_FILTERS,
602 	ETH_SS_FEATURES,
603 	ETH_SS_RSS_HASH_FUNCS,
604 	ETH_SS_TUNABLES,
605 	ETH_SS_PHY_STATS,
606 	ETH_SS_PHY_TUNABLES,
607 };
608 
609 /**
610  * struct ethtool_gstrings - string set for data tagging
611  * @cmd: Command number = %ETHTOOL_GSTRINGS
612  * @string_set: String set ID; one of &enum ethtool_stringset
613  * @len: On return, the number of strings in the string set
614  * @data: Buffer for strings.  Each string is null-padded to a size of
615  *	%ETH_GSTRING_LEN.
616  *
617  * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in
618  * the string set.  They must allocate a buffer of the appropriate
619  * size immediately following this structure.
620  */
621 struct ethtool_gstrings {
622 	uint32_t	cmd;
623 	uint32_t	string_set;
624 	uint32_t	len;
625 	uint8_t	data[0];
626 };
627 
628 /**
629  * struct ethtool_sset_info - string set information
630  * @cmd: Command number = %ETHTOOL_GSSET_INFO
631  * @sset_mask: On entry, a bitmask of string sets to query, with bits
632  *	numbered according to &enum ethtool_stringset.  On return, a
633  *	bitmask of those string sets queried that are supported.
634  * @data: Buffer for string set sizes.  On return, this contains the
635  *	size of each string set that was queried and supported, in
636  *	order of ID.
637  *
638  * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on
639  * return @sset_mask == 0x6 (sets 1, 2).  Then @data[0] contains the
640  * size of set 1 and @data[1] contains the size of set 2.
641  *
642  * Users must allocate a buffer of the appropriate size (4 * number of
643  * sets queried) immediately following this structure.
644  */
645 struct ethtool_sset_info {
646 	uint32_t	cmd;
647 	uint32_t	reserved;
648 	uint64_t	sset_mask;
649 	uint32_t	data[0];
650 };
651 
652 /**
653  * enum ethtool_test_flags - flags definition of ethtool_test
654  * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
655  *	only online tests.
656  * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
657  * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
658  *	test.
659  * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
660  */
661 
662 enum ethtool_test_flags {
663 	ETH_TEST_FL_OFFLINE	= (1 << 0),
664 	ETH_TEST_FL_FAILED	= (1 << 1),
665 	ETH_TEST_FL_EXTERNAL_LB	= (1 << 2),
666 	ETH_TEST_FL_EXTERNAL_LB_DONE	= (1 << 3),
667 };
668 
669 /**
670  * struct ethtool_test - device self-test invocation
671  * @cmd: Command number = %ETHTOOL_TEST
672  * @flags: A bitmask of flags from &enum ethtool_test_flags.  Some
673  *	flags may be set by the user on entry; others may be set by
674  *	the driver on return.
675  * @len: On return, the number of test results
676  * @data: Array of test results
677  *
678  * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
679  * number of test results that will be returned.  They must allocate a
680  * buffer of the appropriate size (8 * number of results) immediately
681  * following this structure.
682  */
683 struct ethtool_test {
684 	uint32_t	cmd;
685 	uint32_t	flags;
686 	uint32_t	reserved;
687 	uint32_t	len;
688 	uint64_t	data[0];
689 };
690 
691 /**
692  * struct ethtool_stats - device-specific statistics
693  * @cmd: Command number = %ETHTOOL_GSTATS
694  * @n_stats: On return, the number of statistics
695  * @data: Array of statistics
696  *
697  * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
698  * number of statistics that will be returned.  They must allocate a
699  * buffer of the appropriate size (8 * number of statistics)
700  * immediately following this structure.
701  */
702 struct ethtool_stats {
703 	uint32_t	cmd;
704 	uint32_t	n_stats;
705 	uint64_t	data[0];
706 };
707 
708 /**
709  * struct ethtool_perm_addr - permanent hardware address
710  * @cmd: Command number = %ETHTOOL_GPERMADDR
711  * @size: On entry, the size of the buffer.  On return, the size of the
712  *	address.  The command fails if the buffer is too small.
713  * @data: Buffer for the address
714  *
715  * Users must allocate the buffer immediately following this structure.
716  * A buffer size of %MAX_ADDR_LEN should be sufficient for any address
717  * type.
718  */
719 struct ethtool_perm_addr {
720 	uint32_t	cmd;
721 	uint32_t	size;
722 	uint8_t	data[0];
723 };
724 
725 /* boolean flags controlling per-interface behavior characteristics.
726  * When reading, the flag indicates whether or not a certain behavior
727  * is enabled/present.  When writing, the flag indicates whether
728  * or not the driver should turn on (set) or off (clear) a behavior.
729  *
730  * Some behaviors may read-only (unconditionally absent or present).
731  * If such is the case, return EINVAL in the set-flags operation if the
732  * flag differs from the read-only value.
733  */
734 enum ethtool_flags {
735 	ETH_FLAG_TXVLAN		= (1 << 7),	/* TX VLAN offload enabled */
736 	ETH_FLAG_RXVLAN		= (1 << 8),	/* RX VLAN offload enabled */
737 	ETH_FLAG_LRO		= (1 << 15),	/* LRO is enabled */
738 	ETH_FLAG_NTUPLE		= (1 << 27),	/* N-tuple filters enabled */
739 	ETH_FLAG_RXHASH		= (1 << 28),
740 };
741 
742 /* The following structures are for supporting RX network flow
743  * classification and RX n-tuple configuration. Note, all multibyte
744  * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
745  * be in network byte order.
746  */
747 
748 /**
749  * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
750  * @ip4src: Source host
751  * @ip4dst: Destination host
752  * @psrc: Source port
753  * @pdst: Destination port
754  * @tos: Type-of-service
755  *
756  * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
757  */
758 struct ethtool_tcpip4_spec {
759 	uint32_t	ip4src;
760 	uint32_t	ip4dst;
761 	uint16_t	psrc;
762 	uint16_t	pdst;
763 	uint8_t    tos;
764 };
765 
766 /**
767  * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
768  * @ip4src: Source host
769  * @ip4dst: Destination host
770  * @spi: Security parameters index
771  * @tos: Type-of-service
772  *
773  * This can be used to specify an IPsec transport or tunnel over IPv4.
774  */
775 struct ethtool_ah_espip4_spec {
776 	uint32_t	ip4src;
777 	uint32_t	ip4dst;
778 	uint32_t	spi;
779 	uint8_t    tos;
780 };
781 
782 #define	ETH_RX_NFC_IP4	1
783 
784 /**
785  * struct ethtool_usrip4_spec - general flow specification for IPv4
786  * @ip4src: Source host
787  * @ip4dst: Destination host
788  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
789  * @tos: Type-of-service
790  * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
791  * @proto: Transport protocol number; mask must be 0
792  */
793 struct ethtool_usrip4_spec {
794 	uint32_t	ip4src;
795 	uint32_t	ip4dst;
796 	uint32_t	l4_4_bytes;
797 	uint8_t    tos;
798 	uint8_t    ip_ver;
799 	uint8_t    proto;
800 };
801 
802 /**
803  * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc.
804  * @ip6src: Source host
805  * @ip6dst: Destination host
806  * @psrc: Source port
807  * @pdst: Destination port
808  * @tclass: Traffic Class
809  *
810  * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow.
811  */
812 struct ethtool_tcpip6_spec {
813 	uint32_t	ip6src[4];
814 	uint32_t	ip6dst[4];
815 	uint16_t	psrc;
816 	uint16_t	pdst;
817 	uint8_t    tclass;
818 };
819 
820 /**
821  * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6
822  * @ip6src: Source host
823  * @ip6dst: Destination host
824  * @spi: Security parameters index
825  * @tclass: Traffic Class
826  *
827  * This can be used to specify an IPsec transport or tunnel over IPv6.
828  */
829 struct ethtool_ah_espip6_spec {
830 	uint32_t	ip6src[4];
831 	uint32_t	ip6dst[4];
832 	uint32_t	spi;
833 	uint8_t    tclass;
834 };
835 
836 /**
837  * struct ethtool_usrip6_spec - general flow specification for IPv6
838  * @ip6src: Source host
839  * @ip6dst: Destination host
840  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
841  * @tclass: Traffic Class
842  * @l4_proto: Transport protocol number (nexthdr after any Extension Headers)
843  */
844 struct ethtool_usrip6_spec {
845 	uint32_t	ip6src[4];
846 	uint32_t	ip6dst[4];
847 	uint32_t	l4_4_bytes;
848 	uint8_t    tclass;
849 	uint8_t    l4_proto;
850 };
851 
852 union ethtool_flow_union {
853 	struct ethtool_tcpip4_spec		tcp_ip4_spec;
854 	struct ethtool_tcpip4_spec		udp_ip4_spec;
855 	struct ethtool_tcpip4_spec		sctp_ip4_spec;
856 	struct ethtool_ah_espip4_spec		ah_ip4_spec;
857 	struct ethtool_ah_espip4_spec		esp_ip4_spec;
858 	struct ethtool_usrip4_spec		usr_ip4_spec;
859 	struct ethtool_tcpip6_spec		tcp_ip6_spec;
860 	struct ethtool_tcpip6_spec		udp_ip6_spec;
861 	struct ethtool_tcpip6_spec		sctp_ip6_spec;
862 	struct ethtool_ah_espip6_spec		ah_ip6_spec;
863 	struct ethtool_ah_espip6_spec		esp_ip6_spec;
864 	struct ethtool_usrip6_spec		usr_ip6_spec;
865 	struct eth_header				ether_spec;
866 	uint8_t					hdata[52];
867 };
868 
869 /**
870  * struct ethtool_flow_ext - additional RX flow fields
871  * @h_dest: destination MAC address
872  * @vlan_etype: VLAN EtherType
873  * @vlan_tci: VLAN tag control information
874  * @data: user defined data
875  *
876  * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
877  * is set in &struct ethtool_rx_flow_spec @flow_type.
878  * @h_dest is valid if %FLOW_MAC_EXT is set.
879  */
880 struct ethtool_flow_ext {
881 	uint8_t		padding[2];
882 	unsigned char	h_dest[ETH_ALEN];
883 	uint16_t		vlan_etype;
884 	uint16_t		vlan_tci;
885 	uint32_t		data[2];
886 };
887 
888 /**
889  * struct ethtool_rx_flow_spec - classification rule for RX flows
890  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
891  * @h_u: Flow fields to match (dependent on @flow_type)
892  * @h_ext: Additional fields to match
893  * @m_u: Masks for flow field bits to be matched
894  * @m_ext: Masks for additional field bits to be matched
895  *	Note, all additional fields must be ignored unless @flow_type
896  *	includes the %FLOW_EXT or %FLOW_MAC_EXT flag
897  *	(see &struct ethtool_flow_ext description).
898  * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
899  *	if packets should be discarded, or %RX_CLS_FLOW_WAKE if the
900  *	packets should be used for Wake-on-LAN with %WAKE_FILTER
901  * @location: Location of rule in the table.  Locations must be
902  *	numbered such that a flow matching multiple rules will be
903  *	classified according to the first (lowest numbered) rule.
904  */
905 struct ethtool_rx_flow_spec {
906 	uint32_t		flow_type;
907 	union ethtool_flow_union h_u;
908 	struct ethtool_flow_ext h_ext;
909 	union ethtool_flow_union m_u;
910 	struct ethtool_flow_ext m_ext;
911 	uint64_t		ring_cookie;
912 	uint32_t		location;
913 };
914 
915 /* How rings are laid out when accessing virtual functions or
916  * offloaded queues is device specific. To allow users to do flow
917  * steering and specify these queues the ring cookie is partitioned
918  * into a 32bit queue index with an 8 bit virtual function id.
919  * This also leaves the 3bytes for further specifiers. It is possible
920  * future devices may support more than 256 virtual functions if
921  * devices start supporting PCIe w/ARI. However at the moment I
922  * do not know of any devices that support this so I do not reserve
923  * space for this at this time. If a future patch consumes the next
924  * byte it should be aware of this possibility.
925  */
926 #define ETHTOOL_RX_FLOW_SPEC_RING	0x00000000FFFFFFFFLL
927 #define ETHTOOL_RX_FLOW_SPEC_RING_VF	0x000000FF00000000LL
928 #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32
929 static inline uint64_t ethtool_get_flow_spec_ring(uint64_t ring_cookie)
930 {
931 	return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie;
932 }
933 
934 static inline uint64_t ethtool_get_flow_spec_ring_vf(uint64_t ring_cookie)
935 {
936 	return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >>
937 				ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF;
938 }
939 
940 /**
941  * struct ethtool_rxnfc - command to get or set RX flow classification rules
942  * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
943  *	%ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
944  *	%ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
945  * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
946  * @data: Command-dependent value
947  * @fs: Flow classification rule
948  * @rss_context: RSS context to be affected
949  * @rule_cnt: Number of rules to be affected
950  * @rule_locs: Array of used rule locations
951  *
952  * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
953  * the fields included in the flow hash, e.g. %RXH_IP_SRC.  The following
954  * structure fields must not be used, except that if @flow_type includes
955  * the %FLOW_RSS flag, then @rss_context determines which RSS context to
956  * act on.
957  *
958  * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
959  * on return.
960  *
961  * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
962  * rules on return.  If @data is non-zero on return then it is the
963  * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
964  * driver supports any special location values.  If that flag is not
965  * set in @data then special location values should not be used.
966  *
967  * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
968  * existing rule on entry and @fs contains the rule on return; if
969  * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is
970  * filled with the RSS context ID associated with the rule.
971  *
972  * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
973  * user buffer for @rule_locs on entry.  On return, @data is the size
974  * of the rule table, @rule_cnt is the number of defined rules, and
975  * @rule_locs contains the locations of the defined rules.  Drivers
976  * must use the second parameter to get_rxnfc() instead of @rule_locs.
977  *
978  * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
979  * @fs.@location either specifies the location to use or is a special
980  * location value with %RX_CLS_LOC_SPECIAL flag set.  On return,
981  * @fs.@location is the actual rule location.  If @fs.@flow_type
982  * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to
983  * use for flow spreading traffic which matches this rule.  The value
984  * from the rxfh indirection table will be added to @fs.@ring_cookie
985  * to choose which ring to deliver to.
986  *
987  * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
988  * existing rule on entry.
989  *
990  * A driver supporting the special location values for
991  * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
992  * location, and may remove a rule at a later location (lower
993  * priority) that matches exactly the same set of flows.  The special
994  * values are %RX_CLS_LOC_ANY, selecting any location;
995  * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
996  * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
997  * location (minimum priority).  Additional special values may be
998  * defined in future and drivers must return -%EINVAL for any
999  * unrecognised value.
1000  */
1001 struct ethtool_rxnfc {
1002 	uint32_t				cmd;
1003 	uint32_t				flow_type;
1004 	uint64_t				data;
1005 	struct ethtool_rx_flow_spec	fs;
1006 	union {
1007 		uint32_t			rule_cnt;
1008 		uint32_t			rss_context;
1009 	};
1010 	uint32_t				rule_locs[0];
1011 };
1012 
1013 
1014 /**
1015  * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
1016  * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
1017  * @size: On entry, the array size of the user buffer, which may be zero.
1018  *	On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
1019  *	indirection table.
1020  * @ring_index: RX ring/queue index for each hash value
1021  *
1022  * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
1023  * should be returned.  For %ETHTOOL_SRXFHINDIR, a @size of zero means
1024  * the table should be reset to default values.  This last feature
1025  * is not supported by the original implementations.
1026  */
1027 struct ethtool_rxfh_indir {
1028 	uint32_t	cmd;
1029 	uint32_t	size;
1030 	uint32_t	ring_index[0];
1031 };
1032 
1033 /**
1034  * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key.
1035  * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH
1036  * @rss_context: RSS context identifier.  Context 0 is the default for normal
1037  *	traffic; other contexts can be referenced as the destination for RX flow
1038  *	classification rules.  %ETH_RXFH_CONTEXT_ALLOC is used with command
1039  *	%ETHTOOL_SRSSH to allocate a new RSS context; on return this field will
1040  *	contain the ID of the newly allocated context.
1041  * @indir_size: On entry, the array size of the user buffer for the
1042  *	indirection table, which may be zero, or (for %ETHTOOL_SRSSH),
1043  *	%ETH_RXFH_INDIR_NO_CHANGE.  On return from %ETHTOOL_GRSSH,
1044  *	the array size of the hardware indirection table.
1045  * @key_size: On entry, the array size of the user buffer for the hash key,
1046  *	which may be zero.  On return from %ETHTOOL_GRSSH, the size of the
1047  *	hardware hash key.
1048  * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
1049  *	Valid values are one of the %ETH_RSS_HASH_*.
1050  * @rsvd:	Reserved for future extensions.
1051  * @rss_config: RX ring/queue index for each hash value i.e., indirection table
1052  *	of @indir_size uint32_t elements, followed by hash key of @key_size
1053  *	bytes.
1054  *
1055  * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the
1056  * size should be returned.  For %ETHTOOL_SRSSH, an @indir_size of
1057  * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested
1058  * and a @indir_size of zero means the indir table should be reset to default
1059  * values (if @rss_context == 0) or that the RSS context should be deleted.
1060  * An hfunc of zero means that hash function setting is not requested.
1061  */
1062 struct ethtool_rxfh {
1063 	uint32_t   cmd;
1064 	uint32_t	rss_context;
1065 	uint32_t   indir_size;
1066 	uint32_t   key_size;
1067 	uint8_t	hfunc;
1068 	uint8_t	rsvd8[3];
1069 	uint32_t	rsvd32;
1070 	uint32_t   rss_config[0];
1071 };
1072 #define ETH_RXFH_CONTEXT_ALLOC		0xffffffff
1073 #define ETH_RXFH_INDIR_NO_CHANGE	0xffffffff
1074 
1075 /**
1076  * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
1077  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1078  * @h_u: Flow field values to match (dependent on @flow_type)
1079  * @m_u: Masks for flow field value bits to be ignored
1080  * @vlan_tag: VLAN tag to match
1081  * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
1082  * @data: Driver-dependent data to match
1083  * @data_mask: Mask for driver-dependent data bits to be ignored
1084  * @action: RX ring/queue index to deliver to (non-negative) or other action
1085  *	(negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
1086  *
1087  * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
1088  * a field value and mask are both zero this is treated as if all mask
1089  * bits are set i.e. the field is ignored.
1090  */
1091 struct ethtool_rx_ntuple_flow_spec {
1092 	uint32_t		 flow_type;
1093 	union {
1094 		struct ethtool_tcpip4_spec		tcp_ip4_spec;
1095 		struct ethtool_tcpip4_spec		udp_ip4_spec;
1096 		struct ethtool_tcpip4_spec		sctp_ip4_spec;
1097 		struct ethtool_ah_espip4_spec		ah_ip4_spec;
1098 		struct ethtool_ah_espip4_spec		esp_ip4_spec;
1099 		struct ethtool_usrip4_spec		usr_ip4_spec;
1100 		struct eth_header				ether_spec;
1101 		uint8_t					hdata[72];
1102 	} h_u, m_u;
1103 
1104 	uint16_t	        vlan_tag;
1105 	uint16_t	        vlan_tag_mask;
1106 	uint64_t		data;
1107 	uint64_t		data_mask;
1108 
1109 	int32_t		action;
1110 #define ETHTOOL_RXNTUPLE_ACTION_DROP	(-1)	/* drop packet */
1111 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR	(-2)	/* clear filter */
1112 };
1113 
1114 /**
1115  * struct ethtool_rx_ntuple - command to set or clear RX flow filter
1116  * @cmd: Command number - %ETHTOOL_SRXNTUPLE
1117  * @fs: Flow filter specification
1118  */
1119 struct ethtool_rx_ntuple {
1120 	uint32_t					cmd;
1121 	struct ethtool_rx_ntuple_flow_spec	fs;
1122 };
1123 
1124 #define ETHTOOL_FLASH_MAX_FILENAME	128
1125 enum ethtool_flash_op_type {
1126 	ETHTOOL_FLASH_ALL_REGIONS	= 0,
1127 };
1128 
1129 /* for passing firmware flashing related parameters */
1130 struct ethtool_flash {
1131 	uint32_t	cmd;
1132 	uint32_t	region;
1133 	char	data[ETHTOOL_FLASH_MAX_FILENAME];
1134 };
1135 
1136 /**
1137  * struct ethtool_dump - used for retrieving, setting device dump
1138  * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
1139  * 	%ETHTOOL_SET_DUMP
1140  * @version: FW version of the dump, filled in by driver
1141  * @flag: driver dependent flag for dump setting, filled in by driver during
1142  *        get and filled in by ethtool for set operation.
1143  *        flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
1144  *        firmware dump is disabled.
1145  * @len: length of dump data, used as the length of the user buffer on entry to
1146  * 	 %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
1147  * 	 for %ETHTOOL_GET_DUMP_FLAG command
1148  * @data: data collected for get dump data operation
1149  */
1150 struct ethtool_dump {
1151 	uint32_t	cmd;
1152 	uint32_t	version;
1153 	uint32_t	flag;
1154 	uint32_t	len;
1155 	uint8_t	data[0];
1156 };
1157 
1158 #define ETH_FW_DUMP_DISABLE 0
1159 
1160 /* for returning and changing feature sets */
1161 
1162 /**
1163  * struct ethtool_get_features_block - block with state of 32 features
1164  * @available: mask of changeable features
1165  * @requested: mask of features requested to be enabled if possible
1166  * @active: mask of currently enabled features
1167  * @never_changed: mask of features not changeable for any device
1168  */
1169 struct ethtool_get_features_block {
1170 	uint32_t	available;
1171 	uint32_t	requested;
1172 	uint32_t	active;
1173 	uint32_t	never_changed;
1174 };
1175 
1176 /**
1177  * struct ethtool_gfeatures - command to get state of device's features
1178  * @cmd: command number = %ETHTOOL_GFEATURES
1179  * @size: On entry, the number of elements in the features[] array;
1180  *	on return, the number of elements in features[] needed to hold
1181  *	all features
1182  * @features: state of features
1183  */
1184 struct ethtool_gfeatures {
1185 	uint32_t	cmd;
1186 	uint32_t	size;
1187 	struct ethtool_get_features_block features[0];
1188 };
1189 
1190 /**
1191  * struct ethtool_set_features_block - block with request for 32 features
1192  * @valid: mask of features to be changed
1193  * @requested: values of features to be changed
1194  */
1195 struct ethtool_set_features_block {
1196 	uint32_t	valid;
1197 	uint32_t	requested;
1198 };
1199 
1200 /**
1201  * struct ethtool_sfeatures - command to request change in device's features
1202  * @cmd: command number = %ETHTOOL_SFEATURES
1203  * @size: array size of the features[] array
1204  * @features: feature change masks
1205  */
1206 struct ethtool_sfeatures {
1207 	uint32_t	cmd;
1208 	uint32_t	size;
1209 	struct ethtool_set_features_block features[0];
1210 };
1211 
1212 /**
1213  * struct ethtool_ts_info - holds a device's timestamping and PHC association
1214  * @cmd: command number = %ETHTOOL_GET_TS_INFO
1215  * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
1216  * @phc_index: device index of the associated PHC, or -1 if there is none
1217  * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
1218  * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
1219  *
1220  * The bits in the 'tx_types' and 'rx_filters' fields correspond to
1221  * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
1222  * respectively.  For example, if the device supports HWTSTAMP_TX_ON,
1223  * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
1224  *
1225  * Drivers should only report the filters they actually support without
1226  * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for
1227  * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the
1228  * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op.
1229  */
1230 struct ethtool_ts_info {
1231 	uint32_t	cmd;
1232 	uint32_t	so_timestamping;
1233 	int32_t	phc_index;
1234 	uint32_t	tx_types;
1235 	uint32_t	tx_reserved[3];
1236 	uint32_t	rx_filters;
1237 	uint32_t	rx_reserved[3];
1238 };
1239 
1240 /*
1241  * %ETHTOOL_SFEATURES changes features present in features[].valid to the
1242  * values of corresponding bits in features[].requested. Bits in .requested
1243  * not set in .valid or not changeable are ignored.
1244  *
1245  * Returns %EINVAL when .valid contains undefined or never-changeable bits
1246  * or size is not equal to required number of features words (32-bit blocks).
1247  * Returns >= 0 if request was completed; bits set in the value mean:
1248  *   %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
1249  *	changeable (not present in %ETHTOOL_GFEATURES' features[].available)
1250  *	those bits were ignored.
1251  *   %ETHTOOL_F_WISH - some or all changes requested were recorded but the
1252  *      resulting state of bits masked by .valid is not equal to .requested.
1253  *      Probably there are other device-specific constraints on some features
1254  *      in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
1255  *      here as though ignored bits were cleared.
1256  *   %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
1257  *      compatibility functions. Requested offload state cannot be properly
1258  *      managed by kernel.
1259  *
1260  * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
1261  * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
1262  * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
1263  * significant bit in features[0] fields. Empty strings mark undefined features.
1264  */
1265 enum ethtool_sfeatures_retval_bits {
1266 	ETHTOOL_F_UNSUPPORTED__BIT,
1267 	ETHTOOL_F_WISH__BIT,
1268 	ETHTOOL_F_COMPAT__BIT,
1269 };
1270 
1271 #define ETHTOOL_F_UNSUPPORTED   (1 << ETHTOOL_F_UNSUPPORTED__BIT)
1272 #define ETHTOOL_F_WISH          (1 << ETHTOOL_F_WISH__BIT)
1273 #define ETHTOOL_F_COMPAT        (1 << ETHTOOL_F_COMPAT__BIT)
1274 
1275 #define MAX_NUM_QUEUE		4096
1276 
1277 /**
1278  * struct ethtool_per_queue_op - apply sub command to the queues in mask.
1279  * @cmd: ETHTOOL_PERQUEUE
1280  * @sub_command: the sub command which apply to each queues
1281  * @queue_mask: Bitmap of the queues which sub command apply to
1282  * @data: A complete command structure following for each of the queues addressed
1283  */
1284 struct ethtool_per_queue_op {
1285 	uint32_t	cmd;
1286 	uint32_t	sub_command;
1287 	uint32_t	queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)];
1288 	char	data[];
1289 };
1290 
1291 /**
1292  * struct ethtool_fecparam - Ethernet forward error correction(fec) parameters
1293  * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM
1294  * @active_fec: FEC mode which is active on porte
1295  * @fec: Bitmask of supported/configured FEC modes
1296  * @rsvd: Reserved for future extensions. i.e FEC bypass feature.
1297  *
1298  * Drivers should reject a non-zero setting of @autoneg when
1299  * autoneogotiation is disabled (or not supported) for the link.
1300  *
1301  */
1302 struct ethtool_fecparam {
1303 	uint32_t   cmd;
1304 	/* bitmask of FEC modes */
1305 	uint32_t   active_fec;
1306 	uint32_t   fec;
1307 	uint32_t   reserved;
1308 };
1309 
1310 /**
1311  * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
1312  * @ETHTOOL_FEC_NONE: FEC mode configuration is not supported
1313  * @ETHTOOL_FEC_AUTO: Default/Best FEC mode provided by driver
1314  * @ETHTOOL_FEC_OFF: No FEC Mode
1315  * @ETHTOOL_FEC_RS: Reed-Solomon Forward Error Detection mode
1316  * @ETHTOOL_FEC_BASER: Base-R/Reed-Solomon Forward Error Detection mode
1317  */
1318 enum ethtool_fec_config_bits {
1319 	ETHTOOL_FEC_NONE_BIT,
1320 	ETHTOOL_FEC_AUTO_BIT,
1321 	ETHTOOL_FEC_OFF_BIT,
1322 	ETHTOOL_FEC_RS_BIT,
1323 	ETHTOOL_FEC_BASER_BIT,
1324 };
1325 
1326 #define ETHTOOL_FEC_NONE		(1 << ETHTOOL_FEC_NONE_BIT)
1327 #define ETHTOOL_FEC_AUTO		(1 << ETHTOOL_FEC_AUTO_BIT)
1328 #define ETHTOOL_FEC_OFF			(1 << ETHTOOL_FEC_OFF_BIT)
1329 #define ETHTOOL_FEC_RS			(1 << ETHTOOL_FEC_RS_BIT)
1330 #define ETHTOOL_FEC_BASER		(1 << ETHTOOL_FEC_BASER_BIT)
1331 
1332 /* CMDs currently supported */
1333 #define ETHTOOL_GSET		0x00000001 /* DEPRECATED, Get settings.
1334 					    * Please use ETHTOOL_GLINKSETTINGS
1335 					    */
1336 #define ETHTOOL_SSET		0x00000002 /* DEPRECATED, Set settings.
1337 					    * Please use ETHTOOL_SLINKSETTINGS
1338 					    */
1339 #define ETHTOOL_GDRVINFO	0x00000003 /* Get driver info. */
1340 #define ETHTOOL_GREGS		0x00000004 /* Get NIC registers. */
1341 #define ETHTOOL_GWOL		0x00000005 /* Get wake-on-lan options. */
1342 #define ETHTOOL_SWOL		0x00000006 /* Set wake-on-lan options. */
1343 #define ETHTOOL_GMSGLVL		0x00000007 /* Get driver message level */
1344 #define ETHTOOL_SMSGLVL		0x00000008 /* Set driver msg level. */
1345 #define ETHTOOL_NWAY_RST	0x00000009 /* Restart autonegotiation. */
1346 /* Get link status for host, i.e. whether the interface *and* the
1347  * physical port (if there is one) are up (ethtool_value). */
1348 #define ETHTOOL_GLINK		0x0000000a
1349 #define ETHTOOL_GEEPROM		0x0000000b /* Get EEPROM data */
1350 #define ETHTOOL_SEEPROM		0x0000000c /* Set EEPROM data. */
1351 #define ETHTOOL_GCOALESCE	0x0000000e /* Get coalesce config */
1352 #define ETHTOOL_SCOALESCE	0x0000000f /* Set coalesce config. */
1353 #define ETHTOOL_GRINGPARAM	0x00000010 /* Get ring parameters */
1354 #define ETHTOOL_SRINGPARAM	0x00000011 /* Set ring parameters. */
1355 #define ETHTOOL_GPAUSEPARAM	0x00000012 /* Get pause parameters */
1356 #define ETHTOOL_SPAUSEPARAM	0x00000013 /* Set pause parameters. */
1357 #define ETHTOOL_GRXCSUM		0x00000014 /* Get RX hw csum enable (ethtool_value) */
1358 #define ETHTOOL_SRXCSUM		0x00000015 /* Set RX hw csum enable (ethtool_value) */
1359 #define ETHTOOL_GTXCSUM		0x00000016 /* Get TX hw csum enable (ethtool_value) */
1360 #define ETHTOOL_STXCSUM		0x00000017 /* Set TX hw csum enable (ethtool_value) */
1361 #define ETHTOOL_GSG		0x00000018 /* Get scatter-gather enable
1362 					    * (ethtool_value) */
1363 #define ETHTOOL_SSG		0x00000019 /* Set scatter-gather enable
1364 					    * (ethtool_value). */
1365 #define ETHTOOL_TEST		0x0000001a /* execute NIC self-test. */
1366 #define ETHTOOL_GSTRINGS	0x0000001b /* get specified string set */
1367 #define ETHTOOL_PHYS_ID		0x0000001c /* identify the NIC */
1368 #define ETHTOOL_GSTATS		0x0000001d /* get NIC-specific statistics */
1369 #define ETHTOOL_GTSO		0x0000001e /* Get TSO enable (ethtool_value) */
1370 #define ETHTOOL_STSO		0x0000001f /* Set TSO enable (ethtool_value) */
1371 #define ETHTOOL_GPERMADDR	0x00000020 /* Get permanent hardware address */
1372 #define ETHTOOL_GUFO		0x00000021 /* Get UFO enable (ethtool_value) */
1373 #define ETHTOOL_SUFO		0x00000022 /* Set UFO enable (ethtool_value) */
1374 #define ETHTOOL_GGSO		0x00000023 /* Get GSO enable (ethtool_value) */
1375 #define ETHTOOL_SGSO		0x00000024 /* Set GSO enable (ethtool_value) */
1376 #define ETHTOOL_GFLAGS		0x00000025 /* Get flags bitmap(ethtool_value) */
1377 #define ETHTOOL_SFLAGS		0x00000026 /* Set flags bitmap(ethtool_value) */
1378 #define ETHTOOL_GPFLAGS		0x00000027 /* Get driver-private flags bitmap */
1379 #define ETHTOOL_SPFLAGS		0x00000028 /* Set driver-private flags bitmap */
1380 
1381 #define ETHTOOL_GRXFH		0x00000029 /* Get RX flow hash configuration */
1382 #define ETHTOOL_SRXFH		0x0000002a /* Set RX flow hash configuration */
1383 #define ETHTOOL_GGRO		0x0000002b /* Get GRO enable (ethtool_value) */
1384 #define ETHTOOL_SGRO		0x0000002c /* Set GRO enable (ethtool_value) */
1385 #define ETHTOOL_GRXRINGS	0x0000002d /* Get RX rings available for LB */
1386 #define ETHTOOL_GRXCLSRLCNT	0x0000002e /* Get RX class rule count */
1387 #define ETHTOOL_GRXCLSRULE	0x0000002f /* Get RX classification rule */
1388 #define ETHTOOL_GRXCLSRLALL	0x00000030 /* Get all RX classification rule */
1389 #define ETHTOOL_SRXCLSRLDEL	0x00000031 /* Delete RX classification rule */
1390 #define ETHTOOL_SRXCLSRLINS	0x00000032 /* Insert RX classification rule */
1391 #define ETHTOOL_FLASHDEV	0x00000033 /* Flash firmware to device */
1392 #define ETHTOOL_RESET		0x00000034 /* Reset hardware */
1393 #define ETHTOOL_SRXNTUPLE	0x00000035 /* Add an n-tuple filter to device */
1394 #define ETHTOOL_GRXNTUPLE	0x00000036 /* deprecated */
1395 #define ETHTOOL_GSSET_INFO	0x00000037 /* Get string set info */
1396 #define ETHTOOL_GRXFHINDIR	0x00000038 /* Get RX flow hash indir'n table */
1397 #define ETHTOOL_SRXFHINDIR	0x00000039 /* Set RX flow hash indir'n table */
1398 
1399 #define ETHTOOL_GFEATURES	0x0000003a /* Get device offload settings */
1400 #define ETHTOOL_SFEATURES	0x0000003b /* Change device offload settings */
1401 #define ETHTOOL_GCHANNELS	0x0000003c /* Get no of channels */
1402 #define ETHTOOL_SCHANNELS	0x0000003d /* Set no of channels */
1403 #define ETHTOOL_SET_DUMP	0x0000003e /* Set dump settings */
1404 #define ETHTOOL_GET_DUMP_FLAG	0x0000003f /* Get dump settings */
1405 #define ETHTOOL_GET_DUMP_DATA	0x00000040 /* Get dump data */
1406 #define ETHTOOL_GET_TS_INFO	0x00000041 /* Get time stamping and PHC info */
1407 #define ETHTOOL_GMODULEINFO	0x00000042 /* Get plug-in module information */
1408 #define ETHTOOL_GMODULEEEPROM	0x00000043 /* Get plug-in module eeprom */
1409 #define ETHTOOL_GEEE		0x00000044 /* Get EEE settings */
1410 #define ETHTOOL_SEEE		0x00000045 /* Set EEE settings */
1411 
1412 #define ETHTOOL_GRSSH		0x00000046 /* Get RX flow hash configuration */
1413 #define ETHTOOL_SRSSH		0x00000047 /* Set RX flow hash configuration */
1414 #define ETHTOOL_GTUNABLE	0x00000048 /* Get tunable configuration */
1415 #define ETHTOOL_STUNABLE	0x00000049 /* Set tunable configuration */
1416 #define ETHTOOL_GPHYSTATS	0x0000004a /* get PHY-specific statistics */
1417 
1418 #define ETHTOOL_PERQUEUE	0x0000004b /* Set per queue options */
1419 
1420 #define ETHTOOL_GLINKSETTINGS	0x0000004c /* Get ethtool_link_settings */
1421 #define ETHTOOL_SLINKSETTINGS	0x0000004d /* Set ethtool_link_settings */
1422 #define ETHTOOL_PHY_GTUNABLE	0x0000004e /* Get PHY tunable configuration */
1423 #define ETHTOOL_PHY_STUNABLE	0x0000004f /* Set PHY tunable configuration */
1424 #define ETHTOOL_GFECPARAM	0x00000050 /* Get FEC settings */
1425 #define ETHTOOL_SFECPARAM	0x00000051 /* Set FEC settings */
1426 
1427 /* compatibility with older code */
1428 #define SPARC_ETH_GSET		ETHTOOL_GSET
1429 #define SPARC_ETH_SSET		ETHTOOL_SSET
1430 
1431 /* Link mode bit indices */
1432 enum ethtool_link_mode_bit_indices {
1433 	ETHTOOL_LINK_MODE_10baseT_Half_BIT	= 0,
1434 	ETHTOOL_LINK_MODE_10baseT_Full_BIT	= 1,
1435 	ETHTOOL_LINK_MODE_100baseT_Half_BIT	= 2,
1436 	ETHTOOL_LINK_MODE_100baseT_Full_BIT	= 3,
1437 	ETHTOOL_LINK_MODE_1000baseT_Half_BIT	= 4,
1438 	ETHTOOL_LINK_MODE_1000baseT_Full_BIT	= 5,
1439 	ETHTOOL_LINK_MODE_Autoneg_BIT		= 6,
1440 	ETHTOOL_LINK_MODE_TP_BIT		= 7,
1441 	ETHTOOL_LINK_MODE_AUI_BIT		= 8,
1442 	ETHTOOL_LINK_MODE_MII_BIT		= 9,
1443 	ETHTOOL_LINK_MODE_FIBRE_BIT		= 10,
1444 	ETHTOOL_LINK_MODE_BNC_BIT		= 11,
1445 	ETHTOOL_LINK_MODE_10000baseT_Full_BIT	= 12,
1446 	ETHTOOL_LINK_MODE_Pause_BIT		= 13,
1447 	ETHTOOL_LINK_MODE_Asym_Pause_BIT	= 14,
1448 	ETHTOOL_LINK_MODE_2500baseX_Full_BIT	= 15,
1449 	ETHTOOL_LINK_MODE_Backplane_BIT		= 16,
1450 	ETHTOOL_LINK_MODE_1000baseKX_Full_BIT	= 17,
1451 	ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT	= 18,
1452 	ETHTOOL_LINK_MODE_10000baseKR_Full_BIT	= 19,
1453 	ETHTOOL_LINK_MODE_10000baseR_FEC_BIT	= 20,
1454 	ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21,
1455 	ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT	= 22,
1456 	ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT	= 23,
1457 	ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT	= 24,
1458 	ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT	= 25,
1459 	ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT	= 26,
1460 	ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT	= 27,
1461 	ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT	= 28,
1462 	ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT	= 29,
1463 	ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT	= 30,
1464 	ETHTOOL_LINK_MODE_25000baseCR_Full_BIT	= 31,
1465 
1466 	/* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit
1467 	 * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_*
1468 	 * macro for bits > 31. The only way to use indices > 31 is to
1469 	 * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API.
1470 	 */
1471 
1472 	ETHTOOL_LINK_MODE_25000baseKR_Full_BIT	= 32,
1473 	ETHTOOL_LINK_MODE_25000baseSR_Full_BIT	= 33,
1474 	ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT	= 34,
1475 	ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT	= 35,
1476 	ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT	= 36,
1477 	ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT	= 37,
1478 	ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT	= 38,
1479 	ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT	= 39,
1480 	ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT		= 40,
1481 	ETHTOOL_LINK_MODE_1000baseX_Full_BIT	= 41,
1482 	ETHTOOL_LINK_MODE_10000baseCR_Full_BIT	= 42,
1483 	ETHTOOL_LINK_MODE_10000baseSR_Full_BIT	= 43,
1484 	ETHTOOL_LINK_MODE_10000baseLR_Full_BIT	= 44,
1485 	ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT	= 45,
1486 	ETHTOOL_LINK_MODE_10000baseER_Full_BIT	= 46,
1487 	ETHTOOL_LINK_MODE_2500baseT_Full_BIT	= 47,
1488 	ETHTOOL_LINK_MODE_5000baseT_Full_BIT	= 48,
1489 
1490 	ETHTOOL_LINK_MODE_FEC_NONE_BIT	= 49,
1491 	ETHTOOL_LINK_MODE_FEC_RS_BIT	= 50,
1492 	ETHTOOL_LINK_MODE_FEC_BASER_BIT	= 51,
1493 	ETHTOOL_LINK_MODE_50000baseKR_Full_BIT		 = 52,
1494 	ETHTOOL_LINK_MODE_50000baseSR_Full_BIT		 = 53,
1495 	ETHTOOL_LINK_MODE_50000baseCR_Full_BIT		 = 54,
1496 	ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT	 = 55,
1497 	ETHTOOL_LINK_MODE_50000baseDR_Full_BIT		 = 56,
1498 	ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT	 = 57,
1499 	ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT	 = 58,
1500 	ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT	 = 59,
1501 	ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60,
1502 	ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT	 = 61,
1503 	ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT	 = 62,
1504 	ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT	 = 63,
1505 	ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64,
1506 	ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT	 = 65,
1507 	ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT	 = 66,
1508 	ETHTOOL_LINK_MODE_100baseT1_Full_BIT		 = 67,
1509 	ETHTOOL_LINK_MODE_1000baseT1_Full_BIT		 = 68,
1510 	ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT	 = 69,
1511 	ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT	 = 70,
1512 	ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71,
1513 	ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT	 = 72,
1514 	ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT	 = 73,
1515 
1516 	/* must be last entry */
1517 	__ETHTOOL_LINK_MODE_MASK_NBITS
1518 };
1519 
1520 #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name)	\
1521 	(1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT))
1522 
1523 /* DEPRECATED macros. Please migrate to
1524  * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
1525  * define any new SUPPORTED_* macro for bits > 31.
1526  */
1527 #define SUPPORTED_10baseT_Half		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
1528 #define SUPPORTED_10baseT_Full		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
1529 #define SUPPORTED_100baseT_Half		__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
1530 #define SUPPORTED_100baseT_Full		__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
1531 #define SUPPORTED_1000baseT_Half	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
1532 #define SUPPORTED_1000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
1533 #define SUPPORTED_Autoneg		__ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
1534 #define SUPPORTED_TP			__ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
1535 #define SUPPORTED_AUI			__ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
1536 #define SUPPORTED_MII			__ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
1537 #define SUPPORTED_FIBRE			__ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
1538 #define SUPPORTED_BNC			__ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
1539 #define SUPPORTED_10000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
1540 #define SUPPORTED_Pause			__ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
1541 #define SUPPORTED_Asym_Pause		__ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
1542 #define SUPPORTED_2500baseX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
1543 #define SUPPORTED_Backplane		__ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
1544 #define SUPPORTED_1000baseKX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
1545 #define SUPPORTED_10000baseKX4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
1546 #define SUPPORTED_10000baseKR_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
1547 #define SUPPORTED_10000baseR_FEC	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
1548 #define SUPPORTED_20000baseMLD2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
1549 #define SUPPORTED_20000baseKR2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
1550 #define SUPPORTED_40000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
1551 #define SUPPORTED_40000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
1552 #define SUPPORTED_40000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
1553 #define SUPPORTED_40000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
1554 #define SUPPORTED_56000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
1555 #define SUPPORTED_56000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
1556 #define SUPPORTED_56000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
1557 #define SUPPORTED_56000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
1558 /* Please do not define any new SUPPORTED_* macro for bits > 31, see
1559  * notice above.
1560  */
1561 
1562 /*
1563  * DEPRECATED macros. Please migrate to
1564  * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
1565  * define any new ADERTISE_* macro for bits > 31.
1566  */
1567 #define ADVERTISED_10baseT_Half		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
1568 #define ADVERTISED_10baseT_Full		__ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
1569 #define ADVERTISED_100baseT_Half	__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
1570 #define ADVERTISED_100baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
1571 #define ADVERTISED_1000baseT_Half	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
1572 #define ADVERTISED_1000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
1573 #define ADVERTISED_Autoneg		__ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
1574 #define ADVERTISED_TP			__ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
1575 #define ADVERTISED_AUI			__ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
1576 #define ADVERTISED_MII			__ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
1577 #define ADVERTISED_FIBRE		__ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
1578 #define ADVERTISED_BNC			__ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
1579 #define ADVERTISED_10000baseT_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
1580 #define ADVERTISED_Pause		__ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
1581 #define ADVERTISED_Asym_Pause		__ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
1582 #define ADVERTISED_2500baseX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
1583 #define ADVERTISED_Backplane		__ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
1584 #define ADVERTISED_1000baseKX_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
1585 #define ADVERTISED_10000baseKX4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
1586 #define ADVERTISED_10000baseKR_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
1587 #define ADVERTISED_10000baseR_FEC	__ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
1588 #define ADVERTISED_20000baseMLD2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
1589 #define ADVERTISED_20000baseKR2_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
1590 #define ADVERTISED_40000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
1591 #define ADVERTISED_40000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
1592 #define ADVERTISED_40000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
1593 #define ADVERTISED_40000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
1594 #define ADVERTISED_56000baseKR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
1595 #define ADVERTISED_56000baseCR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
1596 #define ADVERTISED_56000baseSR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
1597 #define ADVERTISED_56000baseLR4_Full	__ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
1598 /* Please do not define any new ADVERTISED_* macro for bits > 31, see
1599  * notice above.
1600  */
1601 
1602 /* The following are all involved in forcing a particular link
1603  * mode for the device for setting things.  When getting the
1604  * devices settings, these indicate the current mode and whether
1605  * it was forced up into this mode or autonegotiated.
1606  */
1607 
1608 /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal.
1609  * Update drivers/net/phy/phy.c:phy_speed_to_str() and
1610  * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values.
1611  */
1612 #define SPEED_10		10
1613 #define SPEED_100		100
1614 #define SPEED_1000		1000
1615 #define SPEED_2500		2500
1616 #define SPEED_5000		5000
1617 #define SPEED_10000		10000
1618 #define SPEED_14000		14000
1619 #define SPEED_20000		20000
1620 #define SPEED_25000		25000
1621 #define SPEED_40000		40000
1622 #define SPEED_50000		50000
1623 #define SPEED_56000		56000
1624 #define SPEED_100000		100000
1625 #define SPEED_200000		200000
1626 #define SPEED_400000		400000
1627 
1628 #define SPEED_UNKNOWN		-1
1629 
1630 static inline int ethtool_validate_speed(uint32_t speed)
1631 {
1632 	return speed <= INT_MAX || speed == (uint32_t)SPEED_UNKNOWN;
1633 }
1634 
1635 /* Duplex, half or full. */
1636 #define DUPLEX_HALF		0x00
1637 #define DUPLEX_FULL		0x01
1638 #define DUPLEX_UNKNOWN		0xff
1639 
1640 static inline int ethtool_validate_duplex(uint8_t duplex)
1641 {
1642 	switch (duplex) {
1643 	case DUPLEX_HALF:
1644 	case DUPLEX_FULL:
1645 	case DUPLEX_UNKNOWN:
1646 		return 1;
1647 	}
1648 
1649 	return 0;
1650 }
1651 
1652 /* Which connector port. */
1653 #define PORT_TP			0x00
1654 #define PORT_AUI		0x01
1655 #define PORT_MII		0x02
1656 #define PORT_FIBRE		0x03
1657 #define PORT_BNC		0x04
1658 #define PORT_DA			0x05
1659 #define PORT_NONE		0xef
1660 #define PORT_OTHER		0xff
1661 
1662 /* Which transceiver to use. */
1663 #define XCVR_INTERNAL		0x00 /* PHY and MAC are in the same package */
1664 #define XCVR_EXTERNAL		0x01 /* PHY and MAC are in different packages */
1665 #define XCVR_DUMMY1		0x02
1666 #define XCVR_DUMMY2		0x03
1667 #define XCVR_DUMMY3		0x04
1668 
1669 /* Enable or disable autonegotiation. */
1670 #define AUTONEG_DISABLE		0x00
1671 #define AUTONEG_ENABLE		0x01
1672 
1673 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
1674  * the driver is required to renegotiate link
1675  */
1676 #define ETH_TP_MDI_INVALID	0x00 /* status: unknown; control: unsupported */
1677 #define ETH_TP_MDI		0x01 /* status: MDI;     control: force MDI */
1678 #define ETH_TP_MDI_X		0x02 /* status: MDI-X;   control: force MDI-X */
1679 #define ETH_TP_MDI_AUTO		0x03 /*                  control: auto-select */
1680 
1681 /* Wake-On-Lan options. */
1682 #define WAKE_PHY		(1 << 0)
1683 #define WAKE_UCAST		(1 << 1)
1684 #define WAKE_MCAST		(1 << 2)
1685 #define WAKE_BCAST		(1 << 3)
1686 #define WAKE_ARP		(1 << 4)
1687 #define WAKE_MAGIC		(1 << 5)
1688 #define WAKE_MAGICSECURE	(1 << 6) /* only meaningful if WAKE_MAGIC */
1689 #define WAKE_FILTER		(1 << 7)
1690 
1691 /* L2-L4 network traffic flow types */
1692 #define	TCP_V4_FLOW	0x01	/* hash or spec (tcp_ip4_spec) */
1693 #define	UDP_V4_FLOW	0x02	/* hash or spec (udp_ip4_spec) */
1694 #define	SCTP_V4_FLOW	0x03	/* hash or spec (sctp_ip4_spec) */
1695 #define	AH_ESP_V4_FLOW	0x04	/* hash only */
1696 #define	TCP_V6_FLOW	0x05	/* hash or spec (tcp_ip6_spec; nfc only) */
1697 #define	UDP_V6_FLOW	0x06	/* hash or spec (udp_ip6_spec; nfc only) */
1698 #define	SCTP_V6_FLOW	0x07	/* hash or spec (sctp_ip6_spec; nfc only) */
1699 #define	AH_ESP_V6_FLOW	0x08	/* hash only */
1700 #define	AH_V4_FLOW	0x09	/* hash or spec (ah_ip4_spec) */
1701 #define	ESP_V4_FLOW	0x0a	/* hash or spec (esp_ip4_spec) */
1702 #define	AH_V6_FLOW	0x0b	/* hash or spec (ah_ip6_spec; nfc only) */
1703 #define	ESP_V6_FLOW	0x0c	/* hash or spec (esp_ip6_spec; nfc only) */
1704 #define	IPV4_USER_FLOW	0x0d	/* spec only (usr_ip4_spec) */
1705 #define	IP_USER_FLOW	IPV4_USER_FLOW
1706 #define	IPV6_USER_FLOW	0x0e	/* spec only (usr_ip6_spec; nfc only) */
1707 #define	IPV4_FLOW	0x10	/* hash only */
1708 #define	IPV6_FLOW	0x11	/* hash only */
1709 #define	ETHER_FLOW	0x12	/* spec only (ether_spec) */
1710 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1711 #define	FLOW_EXT	0x80000000
1712 #define	FLOW_MAC_EXT	0x40000000
1713 /* Flag to enable RSS spreading of traffic matching rule (nfc only) */
1714 #define	FLOW_RSS	0x20000000
1715 
1716 /* L3-L4 network traffic flow hash options */
1717 #define	RXH_L2DA	(1 << 1)
1718 #define	RXH_VLAN	(1 << 2)
1719 #define	RXH_L3_PROTO	(1 << 3)
1720 #define	RXH_IP_SRC	(1 << 4)
1721 #define	RXH_IP_DST	(1 << 5)
1722 #define	RXH_L4_B_0_1	(1 << 6) /* src port in case of TCP/UDP/SCTP */
1723 #define	RXH_L4_B_2_3	(1 << 7) /* dst port in case of TCP/UDP/SCTP */
1724 #define	RXH_DISCARD	(1 << 31)
1725 
1726 #define	RX_CLS_FLOW_DISC	0xffffffffffffffffULL
1727 #define RX_CLS_FLOW_WAKE	0xfffffffffffffffeULL
1728 
1729 /* Special RX classification rule insert location values */
1730 #define RX_CLS_LOC_SPECIAL	0x80000000	/* flag */
1731 #define RX_CLS_LOC_ANY		0xffffffff
1732 #define RX_CLS_LOC_FIRST	0xfffffffe
1733 #define RX_CLS_LOC_LAST		0xfffffffd
1734 
1735 /* EEPROM Standards for plug in modules */
1736 #define ETH_MODULE_SFF_8079		0x1
1737 #define ETH_MODULE_SFF_8079_LEN		256
1738 #define ETH_MODULE_SFF_8472		0x2
1739 #define ETH_MODULE_SFF_8472_LEN		512
1740 #define ETH_MODULE_SFF_8636		0x3
1741 #define ETH_MODULE_SFF_8636_LEN		256
1742 #define ETH_MODULE_SFF_8436		0x4
1743 #define ETH_MODULE_SFF_8436_LEN		256
1744 
1745 #define ETH_MODULE_SFF_8636_MAX_LEN     640
1746 #define ETH_MODULE_SFF_8436_MAX_LEN     640
1747 
1748 /* Reset flags */
1749 /* The reset() operation must clear the flags for the components which
1750  * were actually reset.  On successful return, the flags indicate the
1751  * components which were not reset, either because they do not exist
1752  * in the hardware or because they cannot be reset independently.  The
1753  * driver must never reset any components that were not requested.
1754  */
1755 enum ethtool_reset_flags {
1756 	/* These flags represent components dedicated to the interface
1757 	 * the command is addressed to.  Shift any flag left by
1758 	 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1759 	 * same type.
1760 	 */
1761 	ETH_RESET_MGMT		= 1 << 0,	/* Management processor */
1762 	ETH_RESET_IRQ		= 1 << 1,	/* Interrupt requester */
1763 	ETH_RESET_DMA		= 1 << 2,	/* DMA engine */
1764 	ETH_RESET_FILTER	= 1 << 3,	/* Filtering/flow direction */
1765 	ETH_RESET_OFFLOAD	= 1 << 4,	/* Protocol offload */
1766 	ETH_RESET_MAC		= 1 << 5,	/* Media access controller */
1767 	ETH_RESET_PHY		= 1 << 6,	/* Transceiver/PHY */
1768 	ETH_RESET_RAM		= 1 << 7,	/* RAM shared between
1769 						 * multiple components */
1770 	ETH_RESET_AP		= 1 << 8,	/* Application processor */
1771 
1772 	ETH_RESET_DEDICATED	= 0x0000ffff,	/* All components dedicated to
1773 						 * this interface */
1774 	ETH_RESET_ALL		= 0xffffffff,	/* All components used by this
1775 						 * interface, even if shared */
1776 };
1777 #define ETH_RESET_SHARED_SHIFT	16
1778 
1779 
1780 /**
1781  * struct ethtool_link_settings - link control and status
1782  *
1783  * IMPORTANT, Backward compatibility notice: When implementing new
1784  *	user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and
1785  *	if it succeeds use %ETHTOOL_SLINKSETTINGS to change link
1786  *	settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS
1787  *	succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in
1788  *	that case.  Conversely, if %ETHTOOL_GLINKSETTINGS fails, use
1789  *	%ETHTOOL_GSET to query and %ETHTOOL_SSET to change link
1790  *	settings; do not use %ETHTOOL_SLINKSETTINGS if
1791  *	%ETHTOOL_GLINKSETTINGS failed: stick to
1792  *	%ETHTOOL_GSET/%ETHTOOL_SSET in that case.
1793  *
1794  * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS
1795  * @speed: Link speed (Mbps)
1796  * @duplex: Duplex mode; one of %DUPLEX_*
1797  * @port: Physical connector type; one of %PORT_*
1798  * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
1799  *	applicable.  For clause 45 PHYs this is the PRTAD.
1800  * @autoneg: Enable/disable autonegotiation and auto-detection;
1801  *	either %AUTONEG_DISABLE or %AUTONEG_ENABLE
1802  * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
1803  *	protocols supported by the interface; 0 if unknown.
1804  *	Read-only.
1805  * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
1806  *	%ETH_TP_MDI_*.  If the status is unknown or not applicable, the
1807  *	value will be %ETH_TP_MDI_INVALID.  Read-only.
1808  * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
1809  *	%ETH_TP_MDI_*.  If MDI(-X) control is not implemented, reads
1810  *	yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
1811  *	When written successfully, the link should be renegotiated if
1812  *	necessary.
1813  * @link_mode_masks_nwords: Number of 32-bit words for each of the
1814  *	supported, advertising, lp_advertising link mode bitmaps. For
1815  *	%ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user
1816  *	(>= 0); on return, if handshake in progress, negative if
1817  *	request size unsupported by kernel: absolute value indicates
1818  *	kernel expected size and all the other fields but cmd
1819  *	are 0; otherwise (handshake completed), strictly positive
1820  *	to indicate size used by kernel and cmd field stays
1821  *	%ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For
1822  *	%ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive
1823  *	value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise
1824  *	refused. For drivers: ignore this field (use kernel's
1825  *	__ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
1826  *	be overwritten by kernel.
1827  * @supported: Bitmap with each bit meaning given by
1828  *	%ethtool_link_mode_bit_indices for the link modes, physical
1829  *	connectors and other link features for which the interface
1830  *	supports autonegotiation or auto-detection.  Read-only.
1831  * @advertising: Bitmap with each bit meaning given by
1832  *	%ethtool_link_mode_bit_indices for the link modes, physical
1833  *	connectors and other link features that are advertised through
1834  *	autonegotiation or enabled for auto-detection.
1835  * @lp_advertising: Bitmap with each bit meaning given by
1836  *	%ethtool_link_mode_bit_indices for the link modes, and other
1837  *	link features that the link partner advertised through
1838  *	autonegotiation; 0 if unknown or not applicable.  Read-only.
1839  * @transceiver: Used to distinguish different possible PHY types,
1840  *	reported consistently by PHYLIB.  Read-only.
1841  *
1842  * If autonegotiation is disabled, the speed and @duplex represent the
1843  * fixed link mode and are writable if the driver supports multiple
1844  * link modes.  If it is enabled then they are read-only; if the link
1845  * is up they represent the negotiated link mode; if the link is down,
1846  * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
1847  * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
1848  *
1849  * Some hardware interfaces may have multiple PHYs and/or physical
1850  * connectors fitted or do not allow the driver to detect which are
1851  * fitted.  For these interfaces @port and/or @phy_address may be
1852  * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
1853  * Otherwise, attempts to write different values may be ignored or
1854  * rejected.
1855  *
1856  * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt
1857  * are not available in %ethtool_link_settings. These fields will be
1858  * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will
1859  * fail if any of them is set to non-zero value.
1860  *
1861  * Users should assume that all fields not marked read-only are
1862  * writable and subject to validation by the driver.  They should use
1863  * %ETHTOOL_GLINKSETTINGS to get the current values before making specific
1864  * changes and then applying them with %ETHTOOL_SLINKSETTINGS.
1865  *
1866  * Drivers that implement %get_link_ksettings and/or
1867  * %set_link_ksettings should ignore the @cmd
1868  * and @link_mode_masks_nwords fields (any change to them overwritten
1869  * by kernel), and rely only on kernel's internal
1870  * %__ETHTOOL_LINK_MODE_MASK_NBITS and
1871  * %ethtool_link_mode_mask_t. Drivers that implement
1872  * %set_link_ksettings() should validate all fields other than @cmd
1873  * and @link_mode_masks_nwords that are not described as read-only or
1874  * deprecated, and must ignore all fields described as read-only.
1875  */
1876 struct ethtool_link_settings {
1877 	uint32_t	cmd;
1878 	uint32_t	speed;
1879 	uint8_t	duplex;
1880 	uint8_t	port;
1881 	uint8_t	phy_address;
1882 	uint8_t	autoneg;
1883 	uint8_t	mdio_support;
1884 	uint8_t	eth_tp_mdix;
1885 	uint8_t	eth_tp_mdix_ctrl;
1886 	int8_t	link_mode_masks_nwords;
1887 	uint8_t	transceiver;
1888 	uint8_t	reserved1[3];
1889 	uint32_t	reserved[7];
1890 	uint32_t	link_mode_masks[0];
1891 	/* layout of link_mode_masks fields:
1892 	 * uint32_t map_supported[link_mode_masks_nwords];
1893 	 * uint32_t map_advertising[link_mode_masks_nwords];
1894 	 * uint32_t map_lp_advertising[link_mode_masks_nwords];
1895 	 */
1896 };
1897 #endif /* _LINUX_ETHTOOL_H */
1898