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