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