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