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