master
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2/*
3 * ethtool.h: Defines for Linux ethtool.
4 *
5 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
6 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
7 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
8 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
9 * christopher.leech@intel.com,
10 * scott.feldman@intel.com)
11 * Portions Copyright (C) Sun Microsystems 2008
12 */
13
14#ifndef _LINUX_ETHTOOL_H
15#define _LINUX_ETHTOOL_H
16
17#include <linux/const.h>
18#include <linux/types.h>
19#include <linux/if_ether.h>
20
21#include <limits.h> /* for INT_MAX */
22
23/* All structures exposed to userland should be defined such that they
24 * have the same layout for 32-bit and 64-bit userland.
25 */
26
27/* Note on reserved space.
28 * Reserved fields must not be accessed directly by user space because
29 * they may be replaced by a different field in the future. They must
30 * be initialized to zero before making the request, e.g. via memset
31 * of the entire structure or implicitly by not being set in a structure
32 * initializer.
33 */
34
35/**
36 * struct ethtool_cmd - DEPRECATED, link control and status
37 * This structure is DEPRECATED, please use struct ethtool_link_settings.
38 * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET
39 * @supported: Bitmask of %SUPPORTED_* flags for the link modes,
40 * physical connectors and other link features for which the
41 * interface supports autonegotiation or auto-detection.
42 * Read-only.
43 * @advertising: Bitmask of %ADVERTISED_* flags for the link modes,
44 * physical connectors and other link features that are
45 * advertised through autonegotiation or enabled for
46 * auto-detection.
47 * @speed: Low bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
48 * @duplex: Duplex mode; one of %DUPLEX_*
49 * @port: Physical connector type; one of %PORT_*
50 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
51 * applicable. For clause 45 PHYs this is the PRTAD.
52 * @transceiver: Historically used to distinguish different possible
53 * PHY types, but not in a consistent way. Deprecated.
54 * @autoneg: Enable/disable autonegotiation and auto-detection;
55 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE
56 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
57 * protocols supported by the interface; 0 if unknown.
58 * Read-only.
59 * @maxtxpkt: Historically used to report TX IRQ coalescing; now
60 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated.
61 * @maxrxpkt: Historically used to report RX IRQ coalescing; now
62 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated.
63 * @speed_hi: High bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
64 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
65 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the
66 * value will be %ETH_TP_MDI_INVALID. Read-only.
67 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
68 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads
69 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
70 * When written successfully, the link should be renegotiated if
71 * necessary.
72 * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes
73 * and other link features that the link partner advertised
74 * through autonegotiation; 0 if unknown or not applicable.
75 * Read-only.
76 * @reserved: Reserved for future use; see the note on reserved space.
77 *
78 * The link speed in Mbps is split between @speed and @speed_hi. Use
79 * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to
80 * access it.
81 *
82 * If autonegotiation is disabled, the speed and @duplex represent the
83 * fixed link mode and are writable if the driver supports multiple
84 * link modes. If it is enabled then they are read-only; if the link
85 * is up they represent the negotiated link mode; if the link is down,
86 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
87 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
88 *
89 * Some hardware interfaces may have multiple PHYs and/or physical
90 * connectors fitted or do not allow the driver to detect which are
91 * fitted. For these interfaces @port and/or @phy_address may be
92 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
93 * Otherwise, attempts to write different values may be ignored or
94 * rejected.
95 *
96 * Users should assume that all fields not marked read-only are
97 * writable and subject to validation by the driver. They should use
98 * %ETHTOOL_GSET to get the current values before making specific
99 * changes and then applying them with %ETHTOOL_SSET.
100 *
101 * Deprecated fields should be ignored by both users and drivers.
102 */
103struct ethtool_cmd {
104 __u32 cmd;
105 __u32 supported;
106 __u32 advertising;
107 __u16 speed;
108 __u8 duplex;
109 __u8 port;
110 __u8 phy_address;
111 __u8 transceiver;
112 __u8 autoneg;
113 __u8 mdio_support;
114 __u32 maxtxpkt;
115 __u32 maxrxpkt;
116 __u16 speed_hi;
117 __u8 eth_tp_mdix;
118 __u8 eth_tp_mdix_ctrl;
119 __u32 lp_advertising;
120 __u32 reserved[2];
121};
122
123static __inline__ void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
124 __u32 speed)
125{
126 ep->speed = (__u16)(speed & 0xFFFF);
127 ep->speed_hi = (__u16)(speed >> 16);
128}
129
130static __inline__ __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
131{
132 return (ep->speed_hi << 16) | ep->speed;
133}
134
135/* Device supports clause 22 register access to PHY or peripherals
136 * using the interface defined in <linux/mii.h>. This should not be
137 * set if there are known to be no such peripherals present or if
138 * the driver only emulates clause 22 registers for compatibility.
139 */
140#define ETH_MDIO_SUPPORTS_C22 1
141
142/* Device supports clause 45 register access to PHY or peripherals
143 * using the interface defined in <linux/mii.h> and <linux/mdio.h>.
144 * This should not be set if there are known to be no such peripherals
145 * present.
146 */
147#define ETH_MDIO_SUPPORTS_C45 2
148
149#define ETHTOOL_FWVERS_LEN 32
150#define ETHTOOL_BUSINFO_LEN 32
151#define ETHTOOL_EROMVERS_LEN 32
152
153/**
154 * struct ethtool_drvinfo - general driver and device information
155 * @cmd: Command number = %ETHTOOL_GDRVINFO
156 * @driver: Driver short name. This should normally match the name
157 * in its bus driver structure (e.g. pci_driver::name). Must
158 * not be an empty string.
159 * @version: Driver version string; may be an empty string
160 * @fw_version: Firmware version string; driver defined; may be an
161 * empty string
162 * @erom_version: Expansion ROM version string; driver defined; may be
163 * an empty string
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.
167 * @reserved2: Reserved for future use; see the note on reserved space.
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 */
183struct ethtool_drvinfo {
184 __u32 cmd;
185 char driver[32];
186 char version[32];
187 char fw_version[ETHTOOL_FWVERS_LEN];
188 char bus_info[ETHTOOL_BUSINFO_LEN];
189 char erom_version[ETHTOOL_EROMVERS_LEN];
190 char reserved2[12];
191 __u32 n_priv_flags;
192 __u32 n_stats;
193 __u32 testinfo_len;
194 __u32 eedump_len;
195 __u32 regdump_len;
196};
197
198#define SOPASS_MAX 6
199
200/**
201 * struct ethtool_wolinfo - Wake-On-Lan configuration
202 * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL
203 * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes.
204 * Read-only.
205 * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
206 * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE
207 * is set in @wolopts.
208 */
209struct ethtool_wolinfo {
210 __u32 cmd;
211 __u32 supported;
212 __u32 wolopts;
213 __u8 sopass[SOPASS_MAX];
214};
215
216/* for passing single values */
217struct ethtool_value {
218 __u32 cmd;
219 __u32 data;
220};
221
222#define PFC_STORM_PREVENTION_AUTO 0xffff
223#define PFC_STORM_PREVENTION_DISABLE 0
224
225enum tunable_id {
226 ETHTOOL_ID_UNSPEC,
227 ETHTOOL_RX_COPYBREAK,
228 ETHTOOL_TX_COPYBREAK,
229 ETHTOOL_PFC_PREVENTION_TOUT, /* timeout in msecs */
230 ETHTOOL_TX_COPYBREAK_BUF_SIZE,
231 /*
232 * Add your fresh new tunable attribute above and remember to update
233 * tunable_strings[] in net/ethtool/common.c
234 */
235 __ETHTOOL_TUNABLE_COUNT,
236};
237
238enum tunable_type_id {
239 ETHTOOL_TUNABLE_UNSPEC,
240 ETHTOOL_TUNABLE_U8,
241 ETHTOOL_TUNABLE_U16,
242 ETHTOOL_TUNABLE_U32,
243 ETHTOOL_TUNABLE_U64,
244 ETHTOOL_TUNABLE_STRING,
245 ETHTOOL_TUNABLE_S8,
246 ETHTOOL_TUNABLE_S16,
247 ETHTOOL_TUNABLE_S32,
248 ETHTOOL_TUNABLE_S64,
249};
250
251struct ethtool_tunable {
252 __u32 cmd;
253 __u32 id;
254 __u32 type_id;
255 __u32 len;
256 void *data[];
257};
258
259#define DOWNSHIFT_DEV_DEFAULT_COUNT 0xff
260#define DOWNSHIFT_DEV_DISABLE 0
261
262/* Time in msecs after which link is reported as down
263 * 0 = lowest time supported by the PHY
264 * 0xff = off, link down detection according to standard
265 */
266#define ETHTOOL_PHY_FAST_LINK_DOWN_ON 0
267#define ETHTOOL_PHY_FAST_LINK_DOWN_OFF 0xff
268
269/* Energy Detect Power Down (EDPD) is a feature supported by some PHYs, where
270 * the PHY's RX & TX blocks are put into a low-power mode when there is no
271 * link detected (typically cable is un-plugged). For RX, only a minimal
272 * link-detection is available, and for TX the PHY wakes up to send link pulses
273 * to avoid any lock-ups in case the peer PHY may also be running in EDPD mode.
274 *
275 * Some PHYs may support configuration of the wake-up interval for TX pulses,
276 * and some PHYs may support only disabling TX pulses entirely. For the latter
277 * a special value is required (ETHTOOL_PHY_EDPD_NO_TX) so that this can be
278 * configured from userspace (should the user want it).
279 *
280 * The interval units for TX wake-up are in milliseconds, since this should
281 * cover a reasonable range of intervals:
282 * - from 1 millisecond, which does not sound like much of a power-saver
283 * - to ~65 seconds which is quite a lot to wait for a link to come up when
284 * plugging a cable
285 */
286#define ETHTOOL_PHY_EDPD_DFLT_TX_MSECS 0xffff
287#define ETHTOOL_PHY_EDPD_NO_TX 0xfffe
288#define ETHTOOL_PHY_EDPD_DISABLE 0
289
290enum phy_tunable_id {
291 ETHTOOL_PHY_ID_UNSPEC,
292 ETHTOOL_PHY_DOWNSHIFT,
293 ETHTOOL_PHY_FAST_LINK_DOWN,
294 ETHTOOL_PHY_EDPD,
295 /*
296 * Add your fresh new phy tunable attribute above and remember to update
297 * phy_tunable_strings[] in net/ethtool/common.c
298 */
299 __ETHTOOL_PHY_TUNABLE_COUNT,
300};
301
302/**
303 * struct ethtool_regs - hardware register dump
304 * @cmd: Command number = %ETHTOOL_GREGS
305 * @version: Dump format version. This is driver-specific and may
306 * distinguish different chips/revisions. Drivers must use new
307 * version numbers whenever the dump format changes in an
308 * incompatible way.
309 * @len: On entry, the real length of @data. On return, the number of
310 * bytes used.
311 * @data: Buffer for the register dump
312 *
313 * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
314 * a register dump for the interface. They must allocate the buffer
315 * immediately following this structure.
316 */
317struct ethtool_regs {
318 __u32 cmd;
319 __u32 version;
320 __u32 len;
321 __u8 data[];
322};
323
324/**
325 * struct ethtool_eeprom - EEPROM dump
326 * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or
327 * %ETHTOOL_SEEPROM
328 * @magic: A 'magic cookie' value to guard against accidental changes.
329 * The value passed in to %ETHTOOL_SEEPROM must match the value
330 * returned by %ETHTOOL_GEEPROM for the same device. This is
331 * unused when @cmd is %ETHTOOL_GMODULEEEPROM.
332 * @offset: Offset within the EEPROM to begin reading/writing, in bytes
333 * @len: On entry, number of bytes to read/write. On successful
334 * return, number of bytes actually read/written. In case of
335 * error, this may indicate at what point the error occurred.
336 * @data: Buffer to read/write from
337 *
338 * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find
339 * the length of an on-board or module EEPROM, respectively. They
340 * must allocate the buffer immediately following this structure.
341 */
342struct ethtool_eeprom {
343 __u32 cmd;
344 __u32 magic;
345 __u32 offset;
346 __u32 len;
347 __u8 data[];
348};
349
350/**
351 * struct ethtool_eee - Energy Efficient Ethernet information
352 * @cmd: ETHTOOL_{G,S}EEE
353 * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
354 * for which there is EEE support.
355 * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
356 * advertised as eee capable.
357 * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
358 * combinations advertised by the link partner as eee capable.
359 * @eee_active: Result of the eee auto negotiation.
360 * @eee_enabled: EEE configured mode (enabled/disabled).
361 * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
362 * that eee was negotiated.
363 * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
364 * its tx lpi (after reaching 'idle' state). Effective only when eee
365 * was negotiated and tx_lpi_enabled was set.
366 * @reserved: Reserved for future use; see the note on reserved space.
367 */
368struct ethtool_eee {
369 __u32 cmd;
370 __u32 supported;
371 __u32 advertised;
372 __u32 lp_advertised;
373 __u32 eee_active;
374 __u32 eee_enabled;
375 __u32 tx_lpi_enabled;
376 __u32 tx_lpi_timer;
377 __u32 reserved[2];
378};
379
380/**
381 * struct ethtool_modinfo - plugin module eeprom information
382 * @cmd: %ETHTOOL_GMODULEINFO
383 * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
384 * @eeprom_len: Length of the eeprom
385 * @reserved: Reserved for future use; see the note on reserved space.
386 *
387 * This structure is used to return the information to
388 * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
389 * The type code indicates the eeprom data format
390 */
391struct ethtool_modinfo {
392 __u32 cmd;
393 __u32 type;
394 __u32 eeprom_len;
395 __u32 reserved[8];
396};
397
398/**
399 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
400 * @cmd: ETHTOOL_{G,S}COALESCE
401 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
402 * a packet arrives.
403 * @rx_max_coalesced_frames: Maximum number of packets to receive
404 * before an RX interrupt.
405 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
406 * this value applies while an IRQ is being serviced by the host.
407 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
408 * except that this value applies while an IRQ is being serviced
409 * by the host.
410 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
411 * a packet is sent.
412 * @tx_max_coalesced_frames: Maximum number of packets to be sent
413 * before a TX interrupt.
414 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
415 * this value applies while an IRQ is being serviced by the host.
416 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
417 * except that this value applies while an IRQ is being serviced
418 * by the host.
419 * @stats_block_coalesce_usecs: How many usecs to delay in-memory
420 * statistics block updates. Some drivers do not have an
421 * in-memory statistic block, and in such cases this value is
422 * ignored. This value must not be zero.
423 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
424 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
425 * @pkt_rate_low: Threshold for low packet rate (packets per second).
426 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
427 * a packet arrives, when the packet rate is below @pkt_rate_low.
428 * @rx_max_coalesced_frames_low: Maximum number of packets to be received
429 * before an RX interrupt, when the packet rate is below @pkt_rate_low.
430 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
431 * a packet is sent, when the packet rate is below @pkt_rate_low.
432 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
433 * a TX interrupt, when the packet rate is below @pkt_rate_low.
434 * @pkt_rate_high: Threshold for high packet rate (packets per second).
435 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
436 * a packet arrives, when the packet rate is above @pkt_rate_high.
437 * @rx_max_coalesced_frames_high: Maximum number of packets to be received
438 * before an RX interrupt, when the packet rate is above @pkt_rate_high.
439 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
440 * a packet is sent, when the packet rate is above @pkt_rate_high.
441 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
442 * a TX interrupt, when the packet rate is above @pkt_rate_high.
443 * @rate_sample_interval: How often to do adaptive coalescing packet rate
444 * sampling, measured in seconds. Must not be zero.
445 *
446 * Each pair of (usecs, max_frames) fields specifies that interrupts
447 * should be coalesced until
448 * (usecs > 0 && time_since_first_completion >= usecs) ||
449 * (max_frames > 0 && completed_frames >= max_frames)
450 *
451 * It is illegal to set both usecs and max_frames to zero as this
452 * would cause interrupts to never be generated. To disable
453 * coalescing, set usecs = 0 and max_frames = 1.
454 *
455 * Some implementations ignore the value of max_frames and use the
456 * condition time_since_first_completion >= usecs
457 *
458 * This is deprecated. Drivers for hardware that does not support
459 * counting completions should validate that max_frames == !rx_usecs.
460 *
461 * Adaptive RX/TX coalescing is an algorithm implemented by some
462 * drivers to improve latency under low packet rates and improve
463 * throughput under high packet rates. Some drivers only implement
464 * one of RX or TX adaptive coalescing. Anything not implemented by
465 * the driver causes these values to be silently ignored.
466 *
467 * When the packet rate is below @pkt_rate_high but above
468 * @pkt_rate_low (both measured in packets per second) the
469 * normal {rx,tx}_* coalescing parameters are used.
470 */
471struct ethtool_coalesce {
472 __u32 cmd;
473 __u32 rx_coalesce_usecs;
474 __u32 rx_max_coalesced_frames;
475 __u32 rx_coalesce_usecs_irq;
476 __u32 rx_max_coalesced_frames_irq;
477 __u32 tx_coalesce_usecs;
478 __u32 tx_max_coalesced_frames;
479 __u32 tx_coalesce_usecs_irq;
480 __u32 tx_max_coalesced_frames_irq;
481 __u32 stats_block_coalesce_usecs;
482 __u32 use_adaptive_rx_coalesce;
483 __u32 use_adaptive_tx_coalesce;
484 __u32 pkt_rate_low;
485 __u32 rx_coalesce_usecs_low;
486 __u32 rx_max_coalesced_frames_low;
487 __u32 tx_coalesce_usecs_low;
488 __u32 tx_max_coalesced_frames_low;
489 __u32 pkt_rate_high;
490 __u32 rx_coalesce_usecs_high;
491 __u32 rx_max_coalesced_frames_high;
492 __u32 tx_coalesce_usecs_high;
493 __u32 tx_max_coalesced_frames_high;
494 __u32 rate_sample_interval;
495};
496
497/**
498 * struct ethtool_ringparam - RX/TX ring parameters
499 * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM
500 * @rx_max_pending: Maximum supported number of pending entries per
501 * RX ring. Read-only.
502 * @rx_mini_max_pending: Maximum supported number of pending entries
503 * per RX mini ring. Read-only.
504 * @rx_jumbo_max_pending: Maximum supported number of pending entries
505 * per RX jumbo ring. Read-only.
506 * @tx_max_pending: Maximum supported number of pending entries per
507 * TX ring. Read-only.
508 * @rx_pending: Current maximum number of pending entries per RX ring
509 * @rx_mini_pending: Current maximum number of pending entries per RX
510 * mini ring
511 * @rx_jumbo_pending: Current maximum number of pending entries per RX
512 * jumbo ring
513 * @tx_pending: Current maximum supported number of pending entries
514 * per TX ring
515 *
516 * If the interface does not have separate RX mini and/or jumbo rings,
517 * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0.
518 *
519 * There may also be driver-dependent minimum values for the number
520 * of entries per ring.
521 */
522struct ethtool_ringparam {
523 __u32 cmd;
524 __u32 rx_max_pending;
525 __u32 rx_mini_max_pending;
526 __u32 rx_jumbo_max_pending;
527 __u32 tx_max_pending;
528 __u32 rx_pending;
529 __u32 rx_mini_pending;
530 __u32 rx_jumbo_pending;
531 __u32 tx_pending;
532};
533
534/**
535 * struct ethtool_channels - configuring number of network channel
536 * @cmd: ETHTOOL_{G,S}CHANNELS
537 * @max_rx: Read only. Maximum number of receive channel the driver support.
538 * @max_tx: Read only. Maximum number of transmit channel the driver support.
539 * @max_other: Read only. Maximum number of other channel the driver support.
540 * @max_combined: Read only. Maximum number of combined channel the driver
541 * support. Set of queues RX, TX or other.
542 * @rx_count: Valid values are in the range 1 to the max_rx.
543 * @tx_count: Valid values are in the range 1 to the max_tx.
544 * @other_count: Valid values are in the range 1 to the max_other.
545 * @combined_count: Valid values are in the range 1 to the max_combined.
546 *
547 * This can be used to configure RX, TX and other channels.
548 */
549
550struct ethtool_channels {
551 __u32 cmd;
552 __u32 max_rx;
553 __u32 max_tx;
554 __u32 max_other;
555 __u32 max_combined;
556 __u32 rx_count;
557 __u32 tx_count;
558 __u32 other_count;
559 __u32 combined_count;
560};
561
562/**
563 * struct ethtool_pauseparam - Ethernet pause (flow control) parameters
564 * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM
565 * @autoneg: Flag to enable autonegotiation of pause frame use
566 * @rx_pause: Flag to enable reception of pause frames
567 * @tx_pause: Flag to enable transmission of pause frames
568 *
569 * Drivers should reject a non-zero setting of @autoneg when
570 * autoneogotiation is disabled (or not supported) for the link.
571 *
572 * If the link is autonegotiated, drivers should use
573 * mii_advertise_flowctrl() or similar code to set the advertised
574 * pause frame capabilities based on the @rx_pause and @tx_pause flags,
575 * even if @autoneg is zero. They should also allow the advertised
576 * pause frame capabilities to be controlled directly through the
577 * advertising field of &struct ethtool_cmd.
578 *
579 * If @autoneg is non-zero, the MAC is configured to send and/or
580 * receive pause frames according to the result of autonegotiation.
581 * Otherwise, it is configured directly based on the @rx_pause and
582 * @tx_pause flags.
583 */
584struct ethtool_pauseparam {
585 __u32 cmd;
586 __u32 autoneg;
587 __u32 rx_pause;
588 __u32 tx_pause;
589};
590
591/* Link extended state */
592enum ethtool_link_ext_state {
593 ETHTOOL_LINK_EXT_STATE_AUTONEG,
594 ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE,
595 ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH,
596 ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY,
597 ETHTOOL_LINK_EXT_STATE_NO_CABLE,
598 ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE,
599 ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE,
600 ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE,
601 ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED,
602 ETHTOOL_LINK_EXT_STATE_OVERHEAT,
603 ETHTOOL_LINK_EXT_STATE_MODULE,
604};
605
606/* More information in addition to ETHTOOL_LINK_EXT_STATE_AUTONEG. */
607enum ethtool_link_ext_substate_autoneg {
608 ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED = 1,
609 ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED,
610 ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED,
611 ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE,
612 ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE,
613 ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD,
614};
615
616/* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE.
617 */
618enum ethtool_link_ext_substate_link_training {
619 ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED = 1,
620 ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT,
621 ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY,
622 ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT,
623};
624
625/* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH.
626 */
627enum ethtool_link_ext_substate_link_logical_mismatch {
628 ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK = 1,
629 ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK,
630 ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS,
631 ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED,
632 ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED,
633};
634
635/* More information in addition to ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY.
636 */
637enum ethtool_link_ext_substate_bad_signal_integrity {
638 ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS = 1,
639 ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE,
640 ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST,
641 ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS,
642};
643
644/* More information in addition to ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE. */
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
650/* More information in addition to ETHTOOL_LINK_EXT_STATE_MODULE. */
651enum ethtool_link_ext_substate_module {
652 ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY = 1,
653};
654
655#define ETH_GSTRING_LEN 32
656
657/**
658 * enum ethtool_stringset - string set ID
659 * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST
660 * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS
661 * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with
662 * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS
663 * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE;
664 * now deprecated
665 * @ETH_SS_FEATURES: Device feature names
666 * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names
667 * @ETH_SS_TUNABLES: tunable names
668 * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS
669 * @ETH_SS_PHY_TUNABLES: PHY tunable names
670 * @ETH_SS_LINK_MODES: link mode names
671 * @ETH_SS_MSG_CLASSES: debug message class names
672 * @ETH_SS_WOL_MODES: wake-on-lan modes
673 * @ETH_SS_SOF_TIMESTAMPING: SOF_TIMESTAMPING_* flags
674 * @ETH_SS_TS_TX_TYPES: timestamping Tx types
675 * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters
676 * @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types
677 * @ETH_SS_STATS_STD: standardized stats
678 * @ETH_SS_STATS_ETH_PHY: names of IEEE 802.3 PHY statistics
679 * @ETH_SS_STATS_ETH_MAC: names of IEEE 802.3 MAC statistics
680 * @ETH_SS_STATS_ETH_CTRL: names of IEEE 802.3 MAC Control statistics
681 * @ETH_SS_STATS_RMON: names of RMON statistics
682 * @ETH_SS_STATS_PHY: names of PHY(dev) statistics
683 * @ETH_SS_TS_FLAGS: hardware timestamping flags
684 *
685 * @ETH_SS_COUNT: number of defined string sets
686 */
687enum ethtool_stringset {
688 ETH_SS_TEST = 0,
689 ETH_SS_STATS,
690 ETH_SS_PRIV_FLAGS,
691 ETH_SS_NTUPLE_FILTERS,
692 ETH_SS_FEATURES,
693 ETH_SS_RSS_HASH_FUNCS,
694 ETH_SS_TUNABLES,
695 ETH_SS_PHY_STATS,
696 ETH_SS_PHY_TUNABLES,
697 ETH_SS_LINK_MODES,
698 ETH_SS_MSG_CLASSES,
699 ETH_SS_WOL_MODES,
700 ETH_SS_SOF_TIMESTAMPING,
701 ETH_SS_TS_TX_TYPES,
702 ETH_SS_TS_RX_FILTERS,
703 ETH_SS_UDP_TUNNEL_TYPES,
704 ETH_SS_STATS_STD,
705 ETH_SS_STATS_ETH_PHY,
706 ETH_SS_STATS_ETH_MAC,
707 ETH_SS_STATS_ETH_CTRL,
708 ETH_SS_STATS_RMON,
709 ETH_SS_STATS_PHY,
710 ETH_SS_TS_FLAGS,
711
712 /* add new constants above here */
713 ETH_SS_COUNT
714};
715
716/**
717 * enum ethtool_mac_stats_src - source of ethtool MAC statistics
718 * @ETHTOOL_MAC_STATS_SRC_AGGREGATE:
719 * if device supports a MAC merge layer, this retrieves the aggregate
720 * statistics of the eMAC and pMAC. Otherwise, it retrieves just the
721 * statistics of the single (express) MAC.
722 * @ETHTOOL_MAC_STATS_SRC_EMAC:
723 * if device supports a MM layer, this retrieves the eMAC statistics.
724 * Otherwise, it retrieves the statistics of the single (express) MAC.
725 * @ETHTOOL_MAC_STATS_SRC_PMAC:
726 * if device supports a MM layer, this retrieves the pMAC statistics.
727 */
728enum ethtool_mac_stats_src {
729 ETHTOOL_MAC_STATS_SRC_AGGREGATE,
730 ETHTOOL_MAC_STATS_SRC_EMAC,
731 ETHTOOL_MAC_STATS_SRC_PMAC,
732};
733
734/**
735 * enum ethtool_module_power_mode_policy - plug-in module power mode policy
736 * @ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH: Module is always in high power mode.
737 * @ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO: Module is transitioned by the host
738 * to high power mode when the first port using it is put administratively
739 * up and to low power mode when the last port using it is put
740 * administratively down.
741 */
742enum ethtool_module_power_mode_policy {
743 ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH = 1,
744 ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO,
745};
746
747/**
748 * enum ethtool_module_power_mode - plug-in module power mode
749 * @ETHTOOL_MODULE_POWER_MODE_LOW: Module is in low power mode.
750 * @ETHTOOL_MODULE_POWER_MODE_HIGH: Module is in high power mode.
751 */
752enum ethtool_module_power_mode {
753 ETHTOOL_MODULE_POWER_MODE_LOW = 1,
754 ETHTOOL_MODULE_POWER_MODE_HIGH,
755};
756
757/**
758 * enum ethtool_c33_pse_ext_state - groups of PSE extended states
759 * functions. IEEE 802.3-2022 33.2.4.4 Variables
760 *
761 * @ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION: Group of error_condition states
762 * @ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID: Group of mr_mps_valid states
763 * @ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE: Group of mr_pse_enable states
764 * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED: Group of option_detect_ted
765 * states
766 * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM: Group of option_vport_lim states
767 * @ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED: Group of ovld_detected states
768 * @ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE: Group of pd_dll_power_type
769 * states
770 * @ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE: Group of power_not_available
771 * states
772 * @ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED: Group of short_detected states
773 */
774enum ethtool_c33_pse_ext_state {
775 ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION = 1,
776 ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID,
777 ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE,
778 ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED,
779 ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM,
780 ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED,
781 ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE,
782 ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE,
783 ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED,
784};
785
786/**
787 * enum ethtool_c33_pse_ext_substate_mr_mps_valid - mr_mps_valid states
788 * functions. IEEE 802.3-2022 33.2.4.4 Variables
789 *
790 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD: Underload
791 * state
792 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN: Port is not
793 * connected
794 *
795 * The PSE monitors either the DC or AC Maintain Power Signature
796 * (MPS, see 33.2.9.1). This variable indicates the presence or absence of
797 * a valid MPS.
798 */
799enum ethtool_c33_pse_ext_substate_mr_mps_valid {
800 ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD = 1,
801 ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN,
802};
803
804/**
805 * enum ethtool_c33_pse_ext_substate_error_condition - error_condition states
806 * functions. IEEE 802.3-2022 33.2.4.4 Variables
807 *
808 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT: Non-existing
809 * port number
810 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT: Undefined port
811 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT: Internal
812 * hardware fault
813 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON:
814 * Communication error after force on
815 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS: Unknown
816 * port status
817 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF: Host
818 * crash turn off
819 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN:
820 * Host crash force shutdown
821 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE: Configuration
822 * change
823 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP: Over
824 * temperature detected
825 *
826 * error_condition is a variable indicating the status of
827 * implementation-specific fault conditions or optionally other system faults
828 * that prevent the PSE from meeting the specifications in Table 33–11 and that
829 * require the PSE not to source power. These error conditions are different
830 * from those monitored by the state diagrams in Figure 33–10.
831 */
832enum ethtool_c33_pse_ext_substate_error_condition {
833 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT = 1,
834 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT,
835 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT,
836 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON,
837 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS,
838 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF,
839 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN,
840 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE,
841 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP,
842};
843
844/**
845 * enum ethtool_c33_pse_ext_substate_mr_pse_enable - mr_pse_enable states
846 * functions. IEEE 802.3-2022 33.2.4.4 Variables
847 *
848 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE: Disable
849 * pin active
850 *
851 * mr_pse_enable is control variable that selects PSE operation and test
852 * functions.
853 */
854enum ethtool_c33_pse_ext_substate_mr_pse_enable {
855 ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE = 1,
856};
857
858/**
859 * enum ethtool_c33_pse_ext_substate_option_detect_ted - option_detect_ted
860 * states functions. IEEE 802.3-2022 33.2.4.4 Variables
861 *
862 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS: Detection
863 * in process
864 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR:
865 * Connection check error
866 *
867 * option_detect_ted is a variable indicating if detection can be performed
868 * by the PSE during the ted_timer interval.
869 */
870enum ethtool_c33_pse_ext_substate_option_detect_ted {
871 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS = 1,
872 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR,
873};
874
875/**
876 * enum ethtool_c33_pse_ext_substate_option_vport_lim - option_vport_lim states
877 * functions. IEEE 802.3-2022 33.2.4.4 Variables
878 *
879 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE: Main supply
880 * voltage is high
881 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE: Main supply
882 * voltage is low
883 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION: Voltage
884 * injection into the port
885 *
886 * option_vport_lim is an optional variable indicates if VPSE is out of the
887 * operating range during normal operating state.
888 */
889enum ethtool_c33_pse_ext_substate_option_vport_lim {
890 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE = 1,
891 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE,
892 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION,
893};
894
895/**
896 * enum ethtool_c33_pse_ext_substate_ovld_detected - ovld_detected states
897 * functions. IEEE 802.3-2022 33.2.4.4 Variables
898 *
899 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD: Overload state
900 *
901 * ovld_detected is a variable indicating if the PSE output current has been
902 * in an overload condition (see 33.2.7.6) for at least TCUT of a one-second
903 * sliding time.
904 */
905enum ethtool_c33_pse_ext_substate_ovld_detected {
906 ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD = 1,
907};
908
909/**
910 * enum ethtool_c33_pse_ext_substate_power_not_available - power_not_available
911 * states functions. IEEE 802.3-2022 33.2.4.4 Variables
912 *
913 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED: Power
914 * budget exceeded for the controller
915 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET:
916 * Configured port power limit exceeded controller power budget
917 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT:
918 * Power request from PD exceeds port limit
919 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT: Power
920 * denied due to Hardware power limit
921 *
922 * power_not_available is a variable that is asserted in an
923 * implementation-dependent manner when the PSE is no longer capable of
924 * sourcing sufficient power to support the attached PD. Sufficient power
925 * is defined by classification; see 33.2.6.
926 */
927enum ethtool_c33_pse_ext_substate_power_not_available {
928 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED = 1,
929 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET,
930 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT,
931 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT,
932};
933
934/**
935 * enum ethtool_c33_pse_ext_substate_short_detected - short_detected states
936 * functions. IEEE 802.3-2022 33.2.4.4 Variables
937 *
938 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION: Short
939 * condition was detected
940 *
941 * short_detected is a variable indicating if the PSE output current has been
942 * in a short circuit condition for TLIM within a sliding window (see 33.2.7.7).
943 */
944enum ethtool_c33_pse_ext_substate_short_detected {
945 ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION = 1,
946};
947
948/**
949 * enum ethtool_pse_types - Types of PSE controller.
950 * @ETHTOOL_PSE_UNKNOWN: Type of PSE controller is unknown
951 * @ETHTOOL_PSE_PODL: PSE controller which support PoDL
952 * @ETHTOOL_PSE_C33: PSE controller which support Clause 33 (PoE)
953 */
954enum ethtool_pse_types {
955 ETHTOOL_PSE_UNKNOWN = 1 << 0,
956 ETHTOOL_PSE_PODL = 1 << 1,
957 ETHTOOL_PSE_C33 = 1 << 2,
958};
959
960/**
961 * enum ethtool_c33_pse_admin_state - operational state of the PoDL PSE
962 * functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
963 * @ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN: state of PSE functions is unknown
964 * @ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED: PSE functions are disabled
965 * @ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED: PSE functions are enabled
966 */
967enum ethtool_c33_pse_admin_state {
968 ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN = 1,
969 ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED,
970 ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED,
971};
972
973/**
974 * enum ethtool_c33_pse_pw_d_status - power detection status of the PSE.
975 * IEEE 802.3-2022 30.9.1.1.3 aPoDLPSEPowerDetectionStatus:
976 * @ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN: PSE status is unknown
977 * @ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED: The enumeration "disabled"
978 * indicates that the PSE State diagram is in the state DISABLED.
979 * @ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING: The enumeration "searching"
980 * indicates the PSE State diagram is in a state other than those
981 * listed.
982 * @ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING: The enumeration
983 * "deliveringPower" indicates that the PSE State diagram is in the
984 * state POWER_ON.
985 * @ETHTOOL_C33_PSE_PW_D_STATUS_TEST: The enumeration "test" indicates that
986 * the PSE State diagram is in the state TEST_MODE.
987 * @ETHTOOL_C33_PSE_PW_D_STATUS_FAULT: The enumeration "fault" indicates that
988 * the PSE State diagram is in the state TEST_ERROR.
989 * @ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT: The enumeration "otherFault"
990 * indicates that the PSE State diagram is in the state IDLE due to
991 * the variable error_condition = true.
992 */
993enum ethtool_c33_pse_pw_d_status {
994 ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN = 1,
995 ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED,
996 ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING,
997 ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING,
998 ETHTOOL_C33_PSE_PW_D_STATUS_TEST,
999 ETHTOOL_C33_PSE_PW_D_STATUS_FAULT,
1000 ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT,
1001};
1002
1003/**
1004 * enum ethtool_podl_pse_admin_state - operational state of the PoDL PSE
1005 * functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
1006 * @ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN: state of PoDL PSE functions are
1007 * unknown
1008 * @ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED: PoDL PSE functions are disabled
1009 * @ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED: PoDL PSE functions are enabled
1010 */
1011enum ethtool_podl_pse_admin_state {
1012 ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN = 1,
1013 ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED,
1014 ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED,
1015};
1016
1017/**
1018 * enum ethtool_podl_pse_pw_d_status - power detection status of the PoDL PSE.
1019 * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
1020 * @ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN: PoDL PSE
1021 * @ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED: "The enumeration “disabled” is
1022 * asserted true when the PoDL PSE state diagram variable mr_pse_enable is
1023 * false"
1024 * @ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING: "The enumeration “searching” is
1025 * asserted true when either of the PSE state diagram variables
1026 * pi_detecting or pi_classifying is true."
1027 * @ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING: "The enumeration “deliveringPower”
1028 * is asserted true when the PoDL PSE state diagram variable pi_powered is
1029 * true."
1030 * @ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP: "The enumeration “sleep” is asserted
1031 * true when the PoDL PSE state diagram variable pi_sleeping is true."
1032 * @ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE: "The enumeration “idle” is asserted true
1033 * when the logical combination of the PoDL PSE state diagram variables
1034 * pi_prebiased*!pi_sleeping is true."
1035 * @ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR: "The enumeration “error” is asserted
1036 * true when the PoDL PSE state diagram variable overload_held is true."
1037 */
1038enum ethtool_podl_pse_pw_d_status {
1039 ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN = 1,
1040 ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED,
1041 ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING,
1042 ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING,
1043 ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP,
1044 ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE,
1045 ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR,
1046};
1047
1048/**
1049 * enum ethtool_mm_verify_status - status of MAC Merge Verify function
1050 * @ETHTOOL_MM_VERIFY_STATUS_UNKNOWN:
1051 * verification status is unknown
1052 * @ETHTOOL_MM_VERIFY_STATUS_INITIAL:
1053 * the 802.3 Verify State diagram is in the state INIT_VERIFICATION
1054 * @ETHTOOL_MM_VERIFY_STATUS_VERIFYING:
1055 * the Verify State diagram is in the state VERIFICATION_IDLE,
1056 * SEND_VERIFY or WAIT_FOR_RESPONSE
1057 * @ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED:
1058 * indicates that the Verify State diagram is in the state VERIFIED
1059 * @ETHTOOL_MM_VERIFY_STATUS_FAILED:
1060 * the Verify State diagram is in the state VERIFY_FAIL
1061 * @ETHTOOL_MM_VERIFY_STATUS_DISABLED:
1062 * verification of preemption operation is disabled
1063 */
1064enum ethtool_mm_verify_status {
1065 ETHTOOL_MM_VERIFY_STATUS_UNKNOWN,
1066 ETHTOOL_MM_VERIFY_STATUS_INITIAL,
1067 ETHTOOL_MM_VERIFY_STATUS_VERIFYING,
1068 ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED,
1069 ETHTOOL_MM_VERIFY_STATUS_FAILED,
1070 ETHTOOL_MM_VERIFY_STATUS_DISABLED,
1071};
1072
1073/**
1074 * enum ethtool_module_fw_flash_status - plug-in module firmware flashing status
1075 * @ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED: The firmware flashing process has
1076 * started.
1077 * @ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS: The firmware flashing process
1078 * is in progress.
1079 * @ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED: The firmware flashing process was
1080 * completed successfully.
1081 * @ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR: The firmware flashing process was
1082 * stopped due to an error.
1083 */
1084enum ethtool_module_fw_flash_status {
1085 ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED = 1,
1086 ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS,
1087 ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED,
1088 ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR,
1089};
1090
1091/**
1092 * struct ethtool_gstrings - string set for data tagging
1093 * @cmd: Command number = %ETHTOOL_GSTRINGS
1094 * @string_set: String set ID; one of &enum ethtool_stringset
1095 * @len: On return, the number of strings in the string set
1096 * @data: Buffer for strings. Each string is null-padded to a size of
1097 * %ETH_GSTRING_LEN.
1098 *
1099 * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in
1100 * the string set. They must allocate a buffer of the appropriate
1101 * size immediately following this structure.
1102 */
1103struct ethtool_gstrings {
1104 __u32 cmd;
1105 __u32 string_set;
1106 __u32 len;
1107 __u8 data[];
1108};
1109
1110/**
1111 * struct ethtool_sset_info - string set information
1112 * @cmd: Command number = %ETHTOOL_GSSET_INFO
1113 * @reserved: Reserved for future use; see the note on reserved space.
1114 * @sset_mask: On entry, a bitmask of string sets to query, with bits
1115 * numbered according to &enum ethtool_stringset. On return, a
1116 * bitmask of those string sets queried that are supported.
1117 * @data: Buffer for string set sizes. On return, this contains the
1118 * size of each string set that was queried and supported, in
1119 * order of ID.
1120 *
1121 * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on
1122 * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the
1123 * size of set 1 and @data[1] contains the size of set 2.
1124 *
1125 * Users must allocate a buffer of the appropriate size (4 * number of
1126 * sets queried) immediately following this structure.
1127 */
1128struct ethtool_sset_info {
1129 __u32 cmd;
1130 __u32 reserved;
1131 __u64 sset_mask;
1132 __u32 data[];
1133};
1134
1135/**
1136 * enum ethtool_test_flags - flags definition of ethtool_test
1137 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
1138 * only online tests.
1139 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
1140 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
1141 * test.
1142 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
1143 */
1144
1145enum ethtool_test_flags {
1146 ETH_TEST_FL_OFFLINE = (1 << 0),
1147 ETH_TEST_FL_FAILED = (1 << 1),
1148 ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
1149 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
1150};
1151
1152/**
1153 * struct ethtool_test - device self-test invocation
1154 * @cmd: Command number = %ETHTOOL_TEST
1155 * @flags: A bitmask of flags from &enum ethtool_test_flags. Some
1156 * flags may be set by the user on entry; others may be set by
1157 * the driver on return.
1158 * @reserved: Reserved for future use; see the note on reserved space.
1159 * @len: On return, the number of test results
1160 * @data: Array of test results
1161 *
1162 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
1163 * number of test results that will be returned. They must allocate a
1164 * buffer of the appropriate size (8 * number of results) immediately
1165 * following this structure.
1166 */
1167struct ethtool_test {
1168 __u32 cmd;
1169 __u32 flags;
1170 __u32 reserved;
1171 __u32 len;
1172 __u64 data[];
1173};
1174
1175/**
1176 * struct ethtool_stats - device-specific statistics
1177 * @cmd: Command number = %ETHTOOL_GSTATS
1178 * @n_stats: On return, the number of statistics
1179 * @data: Array of statistics
1180 *
1181 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
1182 * number of statistics that will be returned. They must allocate a
1183 * buffer of the appropriate size (8 * number of statistics)
1184 * immediately following this structure.
1185 */
1186struct ethtool_stats {
1187 __u32 cmd;
1188 __u32 n_stats;
1189 __u64 data[];
1190};
1191
1192/**
1193 * struct ethtool_perm_addr - permanent hardware address
1194 * @cmd: Command number = %ETHTOOL_GPERMADDR
1195 * @size: On entry, the size of the buffer. On return, the size of the
1196 * address. The command fails if the buffer is too small.
1197 * @data: Buffer for the address
1198 *
1199 * Users must allocate the buffer immediately following this structure.
1200 * A buffer size of %MAX_ADDR_LEN should be sufficient for any address
1201 * type.
1202 */
1203struct ethtool_perm_addr {
1204 __u32 cmd;
1205 __u32 size;
1206 __u8 data[];
1207};
1208
1209/* boolean flags controlling per-interface behavior characteristics.
1210 * When reading, the flag indicates whether or not a certain behavior
1211 * is enabled/present. When writing, the flag indicates whether
1212 * or not the driver should turn on (set) or off (clear) a behavior.
1213 *
1214 * Some behaviors may read-only (unconditionally absent or present).
1215 * If such is the case, return EINVAL in the set-flags operation if the
1216 * flag differs from the read-only value.
1217 */
1218enum ethtool_flags {
1219 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
1220 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
1221 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
1222 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
1223 ETH_FLAG_RXHASH = (1 << 28),
1224};
1225
1226/* The following structures are for supporting RX network flow
1227 * classification and RX n-tuple configuration. Note, all multibyte
1228 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
1229 * be in network byte order.
1230 */
1231
1232/**
1233 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
1234 * @ip4src: Source host
1235 * @ip4dst: Destination host
1236 * @psrc: Source port
1237 * @pdst: Destination port
1238 * @tos: Type-of-service
1239 *
1240 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
1241 */
1242struct ethtool_tcpip4_spec {
1243 __be32 ip4src;
1244 __be32 ip4dst;
1245 __be16 psrc;
1246 __be16 pdst;
1247 __u8 tos;
1248};
1249
1250/**
1251 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
1252 * @ip4src: Source host
1253 * @ip4dst: Destination host
1254 * @spi: Security parameters index
1255 * @tos: Type-of-service
1256 *
1257 * This can be used to specify an IPsec transport or tunnel over IPv4.
1258 */
1259struct ethtool_ah_espip4_spec {
1260 __be32 ip4src;
1261 __be32 ip4dst;
1262 __be32 spi;
1263 __u8 tos;
1264};
1265
1266#define ETH_RX_NFC_IP4 1
1267
1268/**
1269 * struct ethtool_usrip4_spec - general flow specification for IPv4
1270 * @ip4src: Source host
1271 * @ip4dst: Destination host
1272 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
1273 * @tos: Type-of-service
1274 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
1275 * @proto: Transport protocol number; mask must be 0
1276 */
1277struct ethtool_usrip4_spec {
1278 __be32 ip4src;
1279 __be32 ip4dst;
1280 __be32 l4_4_bytes;
1281 __u8 tos;
1282 __u8 ip_ver;
1283 __u8 proto;
1284};
1285
1286/**
1287 * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc.
1288 * @ip6src: Source host
1289 * @ip6dst: Destination host
1290 * @psrc: Source port
1291 * @pdst: Destination port
1292 * @tclass: Traffic Class
1293 *
1294 * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow.
1295 */
1296struct ethtool_tcpip6_spec {
1297 __be32 ip6src[4];
1298 __be32 ip6dst[4];
1299 __be16 psrc;
1300 __be16 pdst;
1301 __u8 tclass;
1302};
1303
1304/**
1305 * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6
1306 * @ip6src: Source host
1307 * @ip6dst: Destination host
1308 * @spi: Security parameters index
1309 * @tclass: Traffic Class
1310 *
1311 * This can be used to specify an IPsec transport or tunnel over IPv6.
1312 */
1313struct ethtool_ah_espip6_spec {
1314 __be32 ip6src[4];
1315 __be32 ip6dst[4];
1316 __be32 spi;
1317 __u8 tclass;
1318};
1319
1320/**
1321 * struct ethtool_usrip6_spec - general flow specification for IPv6
1322 * @ip6src: Source host
1323 * @ip6dst: Destination host
1324 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
1325 * @tclass: Traffic Class
1326 * @l4_proto: Transport protocol number (nexthdr after any Extension Headers)
1327 */
1328struct ethtool_usrip6_spec {
1329 __be32 ip6src[4];
1330 __be32 ip6dst[4];
1331 __be32 l4_4_bytes;
1332 __u8 tclass;
1333 __u8 l4_proto;
1334};
1335
1336union ethtool_flow_union {
1337 struct ethtool_tcpip4_spec tcp_ip4_spec;
1338 struct ethtool_tcpip4_spec udp_ip4_spec;
1339 struct ethtool_tcpip4_spec sctp_ip4_spec;
1340 struct ethtool_ah_espip4_spec ah_ip4_spec;
1341 struct ethtool_ah_espip4_spec esp_ip4_spec;
1342 struct ethtool_usrip4_spec usr_ip4_spec;
1343 struct ethtool_tcpip6_spec tcp_ip6_spec;
1344 struct ethtool_tcpip6_spec udp_ip6_spec;
1345 struct ethtool_tcpip6_spec sctp_ip6_spec;
1346 struct ethtool_ah_espip6_spec ah_ip6_spec;
1347 struct ethtool_ah_espip6_spec esp_ip6_spec;
1348 struct ethtool_usrip6_spec usr_ip6_spec;
1349 struct ethhdr ether_spec;
1350 __u8 hdata[52];
1351};
1352
1353/**
1354 * struct ethtool_flow_ext - additional RX flow fields
1355 * @h_dest: destination MAC address
1356 * @vlan_etype: VLAN EtherType
1357 * @vlan_tci: VLAN tag control information
1358 * @data: user defined data
1359 * @padding: Reserved for future use; see the note on reserved space.
1360 *
1361 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
1362 * is set in &struct ethtool_rx_flow_spec @flow_type.
1363 * @h_dest is valid if %FLOW_MAC_EXT is set.
1364 */
1365struct ethtool_flow_ext {
1366 __u8 padding[2];
1367 unsigned char h_dest[ETH_ALEN];
1368 __be16 vlan_etype;
1369 __be16 vlan_tci;
1370 __be32 data[2];
1371};
1372
1373/**
1374 * struct ethtool_rx_flow_spec - classification rule for RX flows
1375 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1376 * @h_u: Flow fields to match (dependent on @flow_type)
1377 * @h_ext: Additional fields to match
1378 * @m_u: Masks for flow field bits to be matched
1379 * @m_ext: Masks for additional field bits to be matched
1380 * Note, all additional fields must be ignored unless @flow_type
1381 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag
1382 * (see &struct ethtool_flow_ext description).
1383 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
1384 * if packets should be discarded, or %RX_CLS_FLOW_WAKE if the
1385 * packets should be used for Wake-on-LAN with %WAKE_FILTER
1386 * @location: Location of rule in the table. Locations must be
1387 * numbered such that a flow matching multiple rules will be
1388 * classified according to the first (lowest numbered) rule.
1389 */
1390struct ethtool_rx_flow_spec {
1391 __u32 flow_type;
1392 union ethtool_flow_union h_u;
1393 struct ethtool_flow_ext h_ext;
1394 union ethtool_flow_union m_u;
1395 struct ethtool_flow_ext m_ext;
1396 __u64 ring_cookie;
1397 __u32 location;
1398};
1399
1400/* How rings are laid out when accessing virtual functions or
1401 * offloaded queues is device specific. To allow users to do flow
1402 * steering and specify these queues the ring cookie is partitioned
1403 * into a 32bit queue index with an 8 bit virtual function id.
1404 * This also leaves the 3bytes for further specifiers. It is possible
1405 * future devices may support more than 256 virtual functions if
1406 * devices start supporting PCIe w/ARI. However at the moment I
1407 * do not know of any devices that support this so I do not reserve
1408 * space for this at this time. If a future patch consumes the next
1409 * byte it should be aware of this possibility.
1410 */
1411#define ETHTOOL_RX_FLOW_SPEC_RING 0x00000000FFFFFFFFLL
1412#define ETHTOOL_RX_FLOW_SPEC_RING_VF 0x000000FF00000000LL
1413#define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32
1414static __inline__ __u64 ethtool_get_flow_spec_ring(__u64 ring_cookie)
1415{
1416 return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie;
1417}
1418
1419static __inline__ __u64 ethtool_get_flow_spec_ring_vf(__u64 ring_cookie)
1420{
1421 return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >>
1422 ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF;
1423}
1424
1425/**
1426 * struct ethtool_rxnfc - command to get or set RX flow classification rules
1427 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
1428 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
1429 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
1430 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
1431 * @data: Command-dependent value
1432 * @fs: Flow classification rule
1433 * @rss_context: RSS context to be affected
1434 * @rule_cnt: Number of rules to be affected
1435 * @rule_locs: Array of used rule locations
1436 *
1437 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
1438 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
1439 * structure fields must not be used, except that if @flow_type includes
1440 * the %FLOW_RSS flag, then @rss_context determines which RSS context to
1441 * act on.
1442 *
1443 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
1444 * on return.
1445 *
1446 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
1447 * rules on return. If @data is non-zero on return then it is the
1448 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
1449 * driver supports any special location values. If that flag is not
1450 * set in @data then special location values should not be used.
1451 *
1452 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
1453 * existing rule on entry and @fs contains the rule on return; if
1454 * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is
1455 * filled with the RSS context ID associated with the rule.
1456 *
1457 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
1458 * user buffer for @rule_locs on entry. On return, @data is the size
1459 * of the rule table, @rule_cnt is the number of defined rules, and
1460 * @rule_locs contains the locations of the defined rules. Drivers
1461 * must use the second parameter to get_rxnfc() instead of @rule_locs.
1462 *
1463 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
1464 * @fs.@location either specifies the location to use or is a special
1465 * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
1466 * @fs.@location is the actual rule location. If @fs.@flow_type
1467 * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to
1468 * use for flow spreading traffic which matches this rule. The value
1469 * from the rxfh indirection table will be added to @fs.@ring_cookie
1470 * to choose which ring to deliver to.
1471 *
1472 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
1473 * existing rule on entry.
1474 *
1475 * A driver supporting the special location values for
1476 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
1477 * location, and may remove a rule at a later location (lower
1478 * priority) that matches exactly the same set of flows. The special
1479 * values are %RX_CLS_LOC_ANY, selecting any location;
1480 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
1481 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
1482 * location (minimum priority). Additional special values may be
1483 * defined in future and drivers must return -%EINVAL for any
1484 * unrecognised value.
1485 */
1486struct ethtool_rxnfc {
1487 __u32 cmd;
1488 __u32 flow_type;
1489 __u64 data;
1490 struct ethtool_rx_flow_spec fs;
1491 union {
1492 __u32 rule_cnt;
1493 __u32 rss_context;
1494 };
1495 __u32 rule_locs[];
1496};
1497
1498
1499/**
1500 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
1501 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
1502 * @size: On entry, the array size of the user buffer, which may be zero.
1503 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
1504 * indirection table.
1505 * @ring_index: RX ring/queue index for each hash value
1506 *
1507 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
1508 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
1509 * the table should be reset to default values. This last feature
1510 * is not supported by the original implementations.
1511 */
1512struct ethtool_rxfh_indir {
1513 __u32 cmd;
1514 __u32 size;
1515 __u32 ring_index[];
1516};
1517
1518/**
1519 * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key.
1520 * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH
1521 * @rss_context: RSS context identifier. Context 0 is the default for normal
1522 * traffic; other contexts can be referenced as the destination for RX flow
1523 * classification rules. %ETH_RXFH_CONTEXT_ALLOC is used with command
1524 * %ETHTOOL_SRSSH to allocate a new RSS context; on return this field will
1525 * contain the ID of the newly allocated context.
1526 * @indir_size: On entry, the array size of the user buffer for the
1527 * indirection table, which may be zero, or (for %ETHTOOL_SRSSH),
1528 * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH,
1529 * the array size of the hardware indirection table.
1530 * @key_size: On entry, the array size of the user buffer for the hash key,
1531 * which may be zero. On return from %ETHTOOL_GRSSH, the size of the
1532 * hardware hash key.
1533 * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
1534 * Valid values are one of the %ETH_RSS_HASH_*.
1535 * @input_xfrm: Defines how the input data is transformed. Valid values are one
1536 * of %RXH_XFRM_*.
1537 * @rsvd8: Reserved for future use; see the note on reserved space.
1538 * @rsvd32: Reserved for future use; see the note on reserved space.
1539 * @rss_config: RX ring/queue index for each hash value i.e., indirection table
1540 * of @indir_size __u32 elements, followed by hash key of @key_size
1541 * bytes.
1542 *
1543 * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the
1544 * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of
1545 * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested
1546 * and a @indir_size of zero means the indir table should be reset to default
1547 * values (if @rss_context == 0) or that the RSS context should be deleted.
1548 * An hfunc of zero means that hash function setting is not requested.
1549 */
1550struct ethtool_rxfh {
1551 __u32 cmd;
1552 __u32 rss_context;
1553 __u32 indir_size;
1554 __u32 key_size;
1555 __u8 hfunc;
1556 __u8 input_xfrm;
1557 __u8 rsvd8[2];
1558 __u32 rsvd32;
1559 __u32 rss_config[];
1560};
1561#define ETH_RXFH_CONTEXT_ALLOC 0xffffffff
1562#define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff
1563
1564/**
1565 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
1566 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1567 * @h_u: Flow field values to match (dependent on @flow_type)
1568 * @m_u: Masks for flow field value bits to be ignored
1569 * @vlan_tag: VLAN tag to match
1570 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
1571 * @data: Driver-dependent data to match
1572 * @data_mask: Mask for driver-dependent data bits to be ignored
1573 * @action: RX ring/queue index to deliver to (non-negative) or other action
1574 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
1575 *
1576 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
1577 * a field value and mask are both zero this is treated as if all mask
1578 * bits are set i.e. the field is ignored.
1579 */
1580struct ethtool_rx_ntuple_flow_spec {
1581 __u32 flow_type;
1582 union {
1583 struct ethtool_tcpip4_spec tcp_ip4_spec;
1584 struct ethtool_tcpip4_spec udp_ip4_spec;
1585 struct ethtool_tcpip4_spec sctp_ip4_spec;
1586 struct ethtool_ah_espip4_spec ah_ip4_spec;
1587 struct ethtool_ah_espip4_spec esp_ip4_spec;
1588 struct ethtool_usrip4_spec usr_ip4_spec;
1589 struct ethhdr ether_spec;
1590 __u8 hdata[72];
1591 } h_u, m_u;
1592
1593 __u16 vlan_tag;
1594 __u16 vlan_tag_mask;
1595 __u64 data;
1596 __u64 data_mask;
1597
1598 __s32 action;
1599#define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
1600#define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
1601};
1602
1603/**
1604 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
1605 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
1606 * @fs: Flow filter specification
1607 */
1608struct ethtool_rx_ntuple {
1609 __u32 cmd;
1610 struct ethtool_rx_ntuple_flow_spec fs;
1611};
1612
1613#define ETHTOOL_FLASH_MAX_FILENAME 128
1614enum ethtool_flash_op_type {
1615 ETHTOOL_FLASH_ALL_REGIONS = 0,
1616};
1617
1618/* for passing firmware flashing related parameters */
1619struct ethtool_flash {
1620 __u32 cmd;
1621 __u32 region;
1622 char data[ETHTOOL_FLASH_MAX_FILENAME];
1623};
1624
1625/**
1626 * struct ethtool_dump - used for retrieving, setting device dump
1627 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
1628 * %ETHTOOL_SET_DUMP
1629 * @version: FW version of the dump, filled in by driver
1630 * @flag: driver dependent flag for dump setting, filled in by driver during
1631 * get and filled in by ethtool for set operation.
1632 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
1633 * firmware dump is disabled.
1634 * @len: length of dump data, used as the length of the user buffer on entry to
1635 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
1636 * for %ETHTOOL_GET_DUMP_FLAG command
1637 * @data: data collected for get dump data operation
1638 */
1639struct ethtool_dump {
1640 __u32 cmd;
1641 __u32 version;
1642 __u32 flag;
1643 __u32 len;
1644 __u8 data[];
1645};
1646
1647#define ETH_FW_DUMP_DISABLE 0
1648
1649/* for returning and changing feature sets */
1650
1651/**
1652 * struct ethtool_get_features_block - block with state of 32 features
1653 * @available: mask of changeable features
1654 * @requested: mask of features requested to be enabled if possible
1655 * @active: mask of currently enabled features
1656 * @never_changed: mask of features not changeable for any device
1657 */
1658struct ethtool_get_features_block {
1659 __u32 available;
1660 __u32 requested;
1661 __u32 active;
1662 __u32 never_changed;
1663};
1664
1665/**
1666 * struct ethtool_gfeatures - command to get state of device's features
1667 * @cmd: command number = %ETHTOOL_GFEATURES
1668 * @size: On entry, the number of elements in the features[] array;
1669 * on return, the number of elements in features[] needed to hold
1670 * all features
1671 * @features: state of features
1672 */
1673struct ethtool_gfeatures {
1674 __u32 cmd;
1675 __u32 size;
1676 struct ethtool_get_features_block features[];
1677};
1678
1679/**
1680 * struct ethtool_set_features_block - block with request for 32 features
1681 * @valid: mask of features to be changed
1682 * @requested: values of features to be changed
1683 */
1684struct ethtool_set_features_block {
1685 __u32 valid;
1686 __u32 requested;
1687};
1688
1689/**
1690 * struct ethtool_sfeatures - command to request change in device's features
1691 * @cmd: command number = %ETHTOOL_SFEATURES
1692 * @size: array size of the features[] array
1693 * @features: feature change masks
1694 */
1695struct ethtool_sfeatures {
1696 __u32 cmd;
1697 __u32 size;
1698 struct ethtool_set_features_block features[];
1699};
1700
1701/**
1702 * struct ethtool_ts_info - holds a device's timestamping and PHC association
1703 * @cmd: command number = %ETHTOOL_GET_TS_INFO
1704 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
1705 * @phc_index: device index of the associated PHC, or -1 if there is none
1706 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
1707 * @tx_reserved: Reserved for future use; see the note on reserved space.
1708 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
1709 * @rx_reserved: Reserved for future use; see the note on reserved space.
1710 *
1711 * The bits in the 'tx_types' and 'rx_filters' fields correspond to
1712 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
1713 * respectively. For example, if the device supports HWTSTAMP_TX_ON,
1714 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
1715 *
1716 * Drivers should only report the filters they actually support without
1717 * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for
1718 * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the
1719 * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op.
1720 */
1721struct ethtool_ts_info {
1722 __u32 cmd;
1723 __u32 so_timestamping;
1724 __s32 phc_index;
1725 __u32 tx_types;
1726 __u32 tx_reserved[3];
1727 __u32 rx_filters;
1728 __u32 rx_reserved[3];
1729};
1730
1731/*
1732 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
1733 * values of corresponding bits in features[].requested. Bits in .requested
1734 * not set in .valid or not changeable are ignored.
1735 *
1736 * Returns %EINVAL when .valid contains undefined or never-changeable bits
1737 * or size is not equal to required number of features words (32-bit blocks).
1738 * Returns >= 0 if request was completed; bits set in the value mean:
1739 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
1740 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
1741 * those bits were ignored.
1742 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
1743 * resulting state of bits masked by .valid is not equal to .requested.
1744 * Probably there are other device-specific constraints on some features
1745 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
1746 * here as though ignored bits were cleared.
1747 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
1748 * compatibility functions. Requested offload state cannot be properly
1749 * managed by kernel.
1750 *
1751 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
1752 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
1753 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
1754 * significant bit in features[0] fields. Empty strings mark undefined features.
1755 */
1756enum ethtool_sfeatures_retval_bits {
1757 ETHTOOL_F_UNSUPPORTED__BIT,
1758 ETHTOOL_F_WISH__BIT,
1759 ETHTOOL_F_COMPAT__BIT,
1760};
1761
1762#define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
1763#define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
1764#define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
1765
1766#define MAX_NUM_QUEUE 4096
1767
1768/**
1769 * struct ethtool_per_queue_op - apply sub command to the queues in mask.
1770 * @cmd: ETHTOOL_PERQUEUE
1771 * @sub_command: the sub command which apply to each queues
1772 * @queue_mask: Bitmap of the queues which sub command apply to
1773 * @data: A complete command structure following for each of the queues addressed
1774 */
1775struct ethtool_per_queue_op {
1776 __u32 cmd;
1777 __u32 sub_command;
1778 __u32 queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)];
1779 char data[];
1780};
1781
1782/**
1783 * struct ethtool_fecparam - Ethernet Forward Error Correction parameters
1784 * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM
1785 * @active_fec: FEC mode which is active on the port, single bit set, GET only.
1786 * @fec: Bitmask of configured FEC modes.
1787 * @reserved: Reserved for future extensions, ignore on GET, write 0 for SET.
1788 *
1789 * Note that @reserved was never validated on input and ethtool user space
1790 * left it uninitialized when calling SET. Hence going forward it can only be
1791 * used to return a value to userspace with GET.
1792 *
1793 * FEC modes supported by the device can be read via %ETHTOOL_GLINKSETTINGS.
1794 * FEC settings are configured by link autonegotiation whenever it's enabled.
1795 * With autoneg on %ETHTOOL_GFECPARAM can be used to read the current mode.
1796 *
1797 * When autoneg is disabled %ETHTOOL_SFECPARAM controls the FEC settings.
1798 * It is recommended that drivers only accept a single bit set in @fec.
1799 * When multiple bits are set in @fec drivers may pick mode in an implementation
1800 * dependent way. Drivers should reject mixing %ETHTOOL_FEC_AUTO_BIT with other
1801 * FEC modes, because it's unclear whether in this case other modes constrain
1802 * AUTO or are independent choices.
1803 * Drivers must reject SET requests if they support none of the requested modes.
1804 *
1805 * If device does not support FEC drivers may use %ETHTOOL_FEC_NONE instead
1806 * of returning %EOPNOTSUPP from %ETHTOOL_GFECPARAM.
1807 *
1808 * See enum ethtool_fec_config_bits for definition of valid bits for both
1809 * @fec and @active_fec.
1810 */
1811struct ethtool_fecparam {
1812 __u32 cmd;
1813 /* bitmask of FEC modes */
1814 __u32 active_fec;
1815 __u32 fec;
1816 __u32 reserved;
1817};
1818
1819/**
1820 * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
1821 * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not
1822 * be used together with other bits. GET only.
1823 * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually
1824 * based link mode and SFP parameters read from module's
1825 * EEPROM. This bit does _not_ mean autonegotiation.
1826 * @ETHTOOL_FEC_OFF_BIT: No FEC Mode
1827 * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode
1828 * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode
1829 * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet
1830 * Consortium)
1831 */
1832enum ethtool_fec_config_bits {
1833 ETHTOOL_FEC_NONE_BIT,
1834 ETHTOOL_FEC_AUTO_BIT,
1835 ETHTOOL_FEC_OFF_BIT,
1836 ETHTOOL_FEC_RS_BIT,
1837 ETHTOOL_FEC_BASER_BIT,
1838 ETHTOOL_FEC_LLRS_BIT,
1839};
1840
1841#define ETHTOOL_FEC_NONE (1 << ETHTOOL_FEC_NONE_BIT)
1842#define ETHTOOL_FEC_AUTO (1 << ETHTOOL_FEC_AUTO_BIT)
1843#define ETHTOOL_FEC_OFF (1 << ETHTOOL_FEC_OFF_BIT)
1844#define ETHTOOL_FEC_RS (1 << ETHTOOL_FEC_RS_BIT)
1845#define ETHTOOL_FEC_BASER (1 << ETHTOOL_FEC_BASER_BIT)
1846#define ETHTOOL_FEC_LLRS (1 << ETHTOOL_FEC_LLRS_BIT)
1847
1848/* CMDs currently supported */
1849#define ETHTOOL_GSET 0x00000001 /* DEPRECATED, Get settings.
1850 * Please use ETHTOOL_GLINKSETTINGS
1851 */
1852#define ETHTOOL_SSET 0x00000002 /* DEPRECATED, Set settings.
1853 * Please use ETHTOOL_SLINKSETTINGS
1854 */
1855#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
1856#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
1857#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
1858#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
1859#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
1860#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
1861#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
1862/* Get link status for host, i.e. whether the interface *and* the
1863 * physical port (if there is one) are up (ethtool_value). */
1864#define ETHTOOL_GLINK 0x0000000a
1865#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
1866#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
1867#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
1868#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
1869#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
1870#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
1871#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
1872#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
1873#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
1874#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
1875#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
1876#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
1877#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
1878 * (ethtool_value) */
1879#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
1880 * (ethtool_value). */
1881#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
1882#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
1883#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
1884#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
1885#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
1886#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
1887#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
1888#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
1889#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
1890#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
1891#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
1892#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
1893#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
1894#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
1895#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
1896
1897#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
1898#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
1899#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
1900#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
1901#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
1902#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
1903#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
1904#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
1905#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
1906#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
1907#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
1908#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
1909#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
1910#define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
1911#define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
1912#define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1913#define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
1914
1915#define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1916#define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
1917#define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1918#define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1919#define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1920#define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1921#define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
1922#define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
1923#define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */
1924#define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */
1925#define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */
1926#define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */
1927
1928#define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */
1929#define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */
1930#define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */
1931#define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */
1932#define ETHTOOL_GPHYSTATS 0x0000004a /* get PHY-specific statistics */
1933
1934#define ETHTOOL_PERQUEUE 0x0000004b /* Set per queue options */
1935
1936#define ETHTOOL_GLINKSETTINGS 0x0000004c /* Get ethtool_link_settings */
1937#define ETHTOOL_SLINKSETTINGS 0x0000004d /* Set ethtool_link_settings */
1938#define ETHTOOL_PHY_GTUNABLE 0x0000004e /* Get PHY tunable configuration */
1939#define ETHTOOL_PHY_STUNABLE 0x0000004f /* Set PHY tunable configuration */
1940#define ETHTOOL_GFECPARAM 0x00000050 /* Get FEC settings */
1941#define ETHTOOL_SFECPARAM 0x00000051 /* Set FEC settings */
1942
1943/* compatibility with older code */
1944#define SPARC_ETH_GSET ETHTOOL_GSET
1945#define SPARC_ETH_SSET ETHTOOL_SSET
1946
1947/* Link mode bit indices */
1948enum ethtool_link_mode_bit_indices {
1949 ETHTOOL_LINK_MODE_10baseT_Half_BIT = 0,
1950 ETHTOOL_LINK_MODE_10baseT_Full_BIT = 1,
1951 ETHTOOL_LINK_MODE_100baseT_Half_BIT = 2,
1952 ETHTOOL_LINK_MODE_100baseT_Full_BIT = 3,
1953 ETHTOOL_LINK_MODE_1000baseT_Half_BIT = 4,
1954 ETHTOOL_LINK_MODE_1000baseT_Full_BIT = 5,
1955 ETHTOOL_LINK_MODE_Autoneg_BIT = 6,
1956 ETHTOOL_LINK_MODE_TP_BIT = 7,
1957 ETHTOOL_LINK_MODE_AUI_BIT = 8,
1958 ETHTOOL_LINK_MODE_MII_BIT = 9,
1959 ETHTOOL_LINK_MODE_FIBRE_BIT = 10,
1960 ETHTOOL_LINK_MODE_BNC_BIT = 11,
1961 ETHTOOL_LINK_MODE_10000baseT_Full_BIT = 12,
1962 ETHTOOL_LINK_MODE_Pause_BIT = 13,
1963 ETHTOOL_LINK_MODE_Asym_Pause_BIT = 14,
1964 ETHTOOL_LINK_MODE_2500baseX_Full_BIT = 15,
1965 ETHTOOL_LINK_MODE_Backplane_BIT = 16,
1966 ETHTOOL_LINK_MODE_1000baseKX_Full_BIT = 17,
1967 ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT = 18,
1968 ETHTOOL_LINK_MODE_10000baseKR_Full_BIT = 19,
1969 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT = 20,
1970 ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21,
1971 ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT = 22,
1972 ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT = 23,
1973 ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT = 24,
1974 ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT = 25,
1975 ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT = 26,
1976 ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT = 27,
1977 ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT = 28,
1978 ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT = 29,
1979 ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT = 30,
1980 ETHTOOL_LINK_MODE_25000baseCR_Full_BIT = 31,
1981
1982 /* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit
1983 * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_*
1984 * macro for bits > 31. The only way to use indices > 31 is to
1985 * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API.
1986 */
1987
1988 ETHTOOL_LINK_MODE_25000baseKR_Full_BIT = 32,
1989 ETHTOOL_LINK_MODE_25000baseSR_Full_BIT = 33,
1990 ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT = 34,
1991 ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT = 35,
1992 ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT = 36,
1993 ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT = 37,
1994 ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT = 38,
1995 ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT = 39,
1996 ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT = 40,
1997 ETHTOOL_LINK_MODE_1000baseX_Full_BIT = 41,
1998 ETHTOOL_LINK_MODE_10000baseCR_Full_BIT = 42,
1999 ETHTOOL_LINK_MODE_10000baseSR_Full_BIT = 43,
2000 ETHTOOL_LINK_MODE_10000baseLR_Full_BIT = 44,
2001 ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT = 45,
2002 ETHTOOL_LINK_MODE_10000baseER_Full_BIT = 46,
2003 ETHTOOL_LINK_MODE_2500baseT_Full_BIT = 47,
2004 ETHTOOL_LINK_MODE_5000baseT_Full_BIT = 48,
2005
2006 ETHTOOL_LINK_MODE_FEC_NONE_BIT = 49,
2007 ETHTOOL_LINK_MODE_FEC_RS_BIT = 50,
2008 ETHTOOL_LINK_MODE_FEC_BASER_BIT = 51,
2009 ETHTOOL_LINK_MODE_50000baseKR_Full_BIT = 52,
2010 ETHTOOL_LINK_MODE_50000baseSR_Full_BIT = 53,
2011 ETHTOOL_LINK_MODE_50000baseCR_Full_BIT = 54,
2012 ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT = 55,
2013 ETHTOOL_LINK_MODE_50000baseDR_Full_BIT = 56,
2014 ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT = 57,
2015 ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT = 58,
2016 ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT = 59,
2017 ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60,
2018 ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT = 61,
2019 ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT = 62,
2020 ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT = 63,
2021 ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64,
2022 ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT = 65,
2023 ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT = 66,
2024 ETHTOOL_LINK_MODE_100baseT1_Full_BIT = 67,
2025 ETHTOOL_LINK_MODE_1000baseT1_Full_BIT = 68,
2026 ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT = 69,
2027 ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT = 70,
2028 ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71,
2029 ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT = 72,
2030 ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT = 73,
2031 ETHTOOL_LINK_MODE_FEC_LLRS_BIT = 74,
2032 ETHTOOL_LINK_MODE_100000baseKR_Full_BIT = 75,
2033 ETHTOOL_LINK_MODE_100000baseSR_Full_BIT = 76,
2034 ETHTOOL_LINK_MODE_100000baseLR_ER_FR_Full_BIT = 77,
2035 ETHTOOL_LINK_MODE_100000baseCR_Full_BIT = 78,
2036 ETHTOOL_LINK_MODE_100000baseDR_Full_BIT = 79,
2037 ETHTOOL_LINK_MODE_200000baseKR2_Full_BIT = 80,
2038 ETHTOOL_LINK_MODE_200000baseSR2_Full_BIT = 81,
2039 ETHTOOL_LINK_MODE_200000baseLR2_ER2_FR2_Full_BIT = 82,
2040 ETHTOOL_LINK_MODE_200000baseDR2_Full_BIT = 83,
2041 ETHTOOL_LINK_MODE_200000baseCR2_Full_BIT = 84,
2042 ETHTOOL_LINK_MODE_400000baseKR4_Full_BIT = 85,
2043 ETHTOOL_LINK_MODE_400000baseSR4_Full_BIT = 86,
2044 ETHTOOL_LINK_MODE_400000baseLR4_ER4_FR4_Full_BIT = 87,
2045 ETHTOOL_LINK_MODE_400000baseDR4_Full_BIT = 88,
2046 ETHTOOL_LINK_MODE_400000baseCR4_Full_BIT = 89,
2047 ETHTOOL_LINK_MODE_100baseFX_Half_BIT = 90,
2048 ETHTOOL_LINK_MODE_100baseFX_Full_BIT = 91,
2049 ETHTOOL_LINK_MODE_10baseT1L_Full_BIT = 92,
2050 ETHTOOL_LINK_MODE_800000baseCR8_Full_BIT = 93,
2051 ETHTOOL_LINK_MODE_800000baseKR8_Full_BIT = 94,
2052 ETHTOOL_LINK_MODE_800000baseDR8_Full_BIT = 95,
2053 ETHTOOL_LINK_MODE_800000baseDR8_2_Full_BIT = 96,
2054 ETHTOOL_LINK_MODE_800000baseSR8_Full_BIT = 97,
2055 ETHTOOL_LINK_MODE_800000baseVR8_Full_BIT = 98,
2056 ETHTOOL_LINK_MODE_10baseT1S_Full_BIT = 99,
2057 ETHTOOL_LINK_MODE_10baseT1S_Half_BIT = 100,
2058 ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT = 101,
2059 ETHTOOL_LINK_MODE_10baseT1BRR_Full_BIT = 102,
2060 ETHTOOL_LINK_MODE_200000baseCR_Full_BIT = 103,
2061 ETHTOOL_LINK_MODE_200000baseKR_Full_BIT = 104,
2062 ETHTOOL_LINK_MODE_200000baseDR_Full_BIT = 105,
2063 ETHTOOL_LINK_MODE_200000baseDR_2_Full_BIT = 106,
2064 ETHTOOL_LINK_MODE_200000baseSR_Full_BIT = 107,
2065 ETHTOOL_LINK_MODE_200000baseVR_Full_BIT = 108,
2066 ETHTOOL_LINK_MODE_400000baseCR2_Full_BIT = 109,
2067 ETHTOOL_LINK_MODE_400000baseKR2_Full_BIT = 110,
2068 ETHTOOL_LINK_MODE_400000baseDR2_Full_BIT = 111,
2069 ETHTOOL_LINK_MODE_400000baseDR2_2_Full_BIT = 112,
2070 ETHTOOL_LINK_MODE_400000baseSR2_Full_BIT = 113,
2071 ETHTOOL_LINK_MODE_400000baseVR2_Full_BIT = 114,
2072 ETHTOOL_LINK_MODE_800000baseCR4_Full_BIT = 115,
2073 ETHTOOL_LINK_MODE_800000baseKR4_Full_BIT = 116,
2074 ETHTOOL_LINK_MODE_800000baseDR4_Full_BIT = 117,
2075 ETHTOOL_LINK_MODE_800000baseDR4_2_Full_BIT = 118,
2076 ETHTOOL_LINK_MODE_800000baseSR4_Full_BIT = 119,
2077 ETHTOOL_LINK_MODE_800000baseVR4_Full_BIT = 120,
2078
2079 /* must be last entry */
2080 __ETHTOOL_LINK_MODE_MASK_NBITS
2081};
2082
2083#define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name) \
2084 (1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT))
2085
2086/* DEPRECATED macros. Please migrate to
2087 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
2088 * define any new SUPPORTED_* macro for bits > 31.
2089 */
2090#define SUPPORTED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
2091#define SUPPORTED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
2092#define SUPPORTED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
2093#define SUPPORTED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
2094#define SUPPORTED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
2095#define SUPPORTED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
2096#define SUPPORTED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
2097#define SUPPORTED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
2098#define SUPPORTED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
2099#define SUPPORTED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
2100#define SUPPORTED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
2101#define SUPPORTED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
2102#define SUPPORTED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
2103#define SUPPORTED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
2104#define SUPPORTED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
2105#define SUPPORTED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
2106#define SUPPORTED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
2107#define SUPPORTED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
2108#define SUPPORTED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
2109#define SUPPORTED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
2110#define SUPPORTED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
2111#define SUPPORTED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
2112#define SUPPORTED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
2113#define SUPPORTED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
2114#define SUPPORTED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
2115#define SUPPORTED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
2116#define SUPPORTED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
2117#define SUPPORTED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
2118#define SUPPORTED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
2119#define SUPPORTED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
2120#define SUPPORTED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
2121/* Please do not define any new SUPPORTED_* macro for bits > 31, see
2122 * notice above.
2123 */
2124
2125/*
2126 * DEPRECATED macros. Please migrate to
2127 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
2128 * define any new ADERTISE_* macro for bits > 31.
2129 */
2130#define ADVERTISED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
2131#define ADVERTISED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
2132#define ADVERTISED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
2133#define ADVERTISED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
2134#define ADVERTISED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
2135#define ADVERTISED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
2136#define ADVERTISED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
2137#define ADVERTISED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
2138#define ADVERTISED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
2139#define ADVERTISED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
2140#define ADVERTISED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
2141#define ADVERTISED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
2142#define ADVERTISED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
2143#define ADVERTISED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
2144#define ADVERTISED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
2145#define ADVERTISED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
2146#define ADVERTISED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
2147#define ADVERTISED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
2148#define ADVERTISED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
2149#define ADVERTISED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
2150#define ADVERTISED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
2151#define ADVERTISED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
2152#define ADVERTISED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
2153#define ADVERTISED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
2154#define ADVERTISED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
2155#define ADVERTISED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
2156#define ADVERTISED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
2157#define ADVERTISED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
2158#define ADVERTISED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
2159#define ADVERTISED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
2160#define ADVERTISED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
2161/* Please do not define any new ADVERTISED_* macro for bits > 31, see
2162 * notice above.
2163 */
2164
2165/* The following are all involved in forcing a particular link
2166 * mode for the device for setting things. When getting the
2167 * devices settings, these indicate the current mode and whether
2168 * it was forced up into this mode or autonegotiated.
2169 */
2170
2171/* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal.
2172 * Update drivers/net/phy/phy.c:phy_speed_to_str() and
2173 * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values.
2174 */
2175#define SPEED_10 10
2176#define SPEED_100 100
2177#define SPEED_1000 1000
2178#define SPEED_2500 2500
2179#define SPEED_5000 5000
2180#define SPEED_10000 10000
2181#define SPEED_14000 14000
2182#define SPEED_20000 20000
2183#define SPEED_25000 25000
2184#define SPEED_40000 40000
2185#define SPEED_50000 50000
2186#define SPEED_56000 56000
2187#define SPEED_100000 100000
2188#define SPEED_200000 200000
2189#define SPEED_400000 400000
2190#define SPEED_800000 800000
2191
2192#define SPEED_UNKNOWN -1
2193
2194static __inline__ int ethtool_validate_speed(__u32 speed)
2195{
2196 return speed <= INT_MAX || speed == (__u32)SPEED_UNKNOWN;
2197}
2198
2199/* Duplex, half or full. */
2200#define DUPLEX_HALF 0x00
2201#define DUPLEX_FULL 0x01
2202#define DUPLEX_UNKNOWN 0xff
2203
2204static __inline__ int ethtool_validate_duplex(__u8 duplex)
2205{
2206 switch (duplex) {
2207 case DUPLEX_HALF:
2208 case DUPLEX_FULL:
2209 case DUPLEX_UNKNOWN:
2210 return 1;
2211 }
2212
2213 return 0;
2214}
2215
2216#define MASTER_SLAVE_CFG_UNSUPPORTED 0
2217#define MASTER_SLAVE_CFG_UNKNOWN 1
2218#define MASTER_SLAVE_CFG_MASTER_PREFERRED 2
2219#define MASTER_SLAVE_CFG_SLAVE_PREFERRED 3
2220#define MASTER_SLAVE_CFG_MASTER_FORCE 4
2221#define MASTER_SLAVE_CFG_SLAVE_FORCE 5
2222#define MASTER_SLAVE_STATE_UNSUPPORTED 0
2223#define MASTER_SLAVE_STATE_UNKNOWN 1
2224#define MASTER_SLAVE_STATE_MASTER 2
2225#define MASTER_SLAVE_STATE_SLAVE 3
2226#define MASTER_SLAVE_STATE_ERR 4
2227
2228/* These are used to throttle the rate of data on the phy interface when the
2229 * native speed of the interface is higher than the link speed. These should
2230 * not be used for phy interfaces which natively support multiple speeds (e.g.
2231 * MII or SGMII).
2232 */
2233/* No rate matching performed. */
2234#define RATE_MATCH_NONE 0
2235/* The phy sends pause frames to throttle the MAC. */
2236#define RATE_MATCH_PAUSE 1
2237/* The phy asserts CRS to prevent the MAC from transmitting. */
2238#define RATE_MATCH_CRS 2
2239/* The MAC is programmed with a sufficiently-large IPG. */
2240#define RATE_MATCH_OPEN_LOOP 3
2241
2242/* Which connector port. */
2243#define PORT_TP 0x00
2244#define PORT_AUI 0x01
2245#define PORT_MII 0x02
2246#define PORT_FIBRE 0x03
2247#define PORT_BNC 0x04
2248#define PORT_DA 0x05
2249#define PORT_NONE 0xef
2250#define PORT_OTHER 0xff
2251
2252/* Which transceiver to use. */
2253#define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */
2254#define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */
2255#define XCVR_DUMMY1 0x02
2256#define XCVR_DUMMY2 0x03
2257#define XCVR_DUMMY3 0x04
2258
2259/* Enable or disable autonegotiation. */
2260#define AUTONEG_DISABLE 0x00
2261#define AUTONEG_ENABLE 0x01
2262
2263/* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
2264 * the driver is required to renegotiate link
2265 */
2266#define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */
2267#define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */
2268#define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */
2269#define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */
2270
2271/* Wake-On-Lan options. */
2272#define WAKE_PHY (1 << 0)
2273#define WAKE_UCAST (1 << 1)
2274#define WAKE_MCAST (1 << 2)
2275#define WAKE_BCAST (1 << 3)
2276#define WAKE_ARP (1 << 4)
2277#define WAKE_MAGIC (1 << 5)
2278#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
2279#define WAKE_FILTER (1 << 7)
2280
2281#define WOL_MODE_COUNT 8
2282
2283/* RSS hash function data
2284 * XOR the corresponding source and destination fields of each specified
2285 * protocol. Both copies of the XOR'ed fields are fed into the RSS and RXHASH
2286 * calculation. Note that this XORing reduces the input set entropy and could
2287 * be exploited to reduce the RSS queue spread.
2288 */
2289#define RXH_XFRM_SYM_XOR (1 << 0)
2290/* Similar to SYM_XOR, except that one copy of the XOR'ed fields is replaced by
2291 * an OR of the same fields
2292 */
2293#define RXH_XFRM_SYM_OR_XOR (1 << 1)
2294#define RXH_XFRM_NO_CHANGE 0xff
2295
2296enum {
2297 /* L2-L4 network traffic flow types */
2298 TCP_V4_FLOW = 0x01, /* hash or spec (tcp_ip4_spec) */
2299 UDP_V4_FLOW = 0x02, /* hash or spec (udp_ip4_spec) */
2300 SCTP_V4_FLOW = 0x03, /* hash or spec (sctp_ip4_spec) */
2301 AH_ESP_V4_FLOW = 0x04, /* hash only */
2302 TCP_V6_FLOW = 0x05, /* hash or spec (tcp_ip6_spec; nfc only) */
2303 UDP_V6_FLOW = 0x06, /* hash or spec (udp_ip6_spec; nfc only) */
2304 SCTP_V6_FLOW = 0x07, /* hash or spec (sctp_ip6_spec; nfc only) */
2305 AH_ESP_V6_FLOW = 0x08, /* hash only */
2306 AH_V4_FLOW = 0x09, /* hash or spec (ah_ip4_spec) */
2307 ESP_V4_FLOW = 0x0a, /* hash or spec (esp_ip4_spec) */
2308 AH_V6_FLOW = 0x0b, /* hash or spec (ah_ip6_spec; nfc only) */
2309 ESP_V6_FLOW = 0x0c, /* hash or spec (esp_ip6_spec; nfc only) */
2310 IPV4_USER_FLOW = 0x0d, /* spec only (usr_ip4_spec) */
2311 IP_USER_FLOW = IPV4_USER_FLOW,
2312 IPV6_USER_FLOW = 0x0e, /* spec only (usr_ip6_spec; nfc only) */
2313 IPV4_FLOW = 0x10, /* hash only */
2314 IPV6_FLOW = 0x11, /* hash only */
2315 ETHER_FLOW = 0x12, /* hash or spec (ether_spec) */
2316
2317 /* Used for GTP-U IPv4 and IPv6.
2318 * The format of GTP packets only includes
2319 * elements such as TEID and GTP version.
2320 * It is primarily intended for data communication of the UE.
2321 */
2322 GTPU_V4_FLOW = 0x13, /* hash only */
2323 GTPU_V6_FLOW = 0x14, /* hash only */
2324
2325 /* Use for GTP-C IPv4 and v6.
2326 * The format of these GTP packets does not include TEID.
2327 * Primarily expected to be used for communication
2328 * to create sessions for UE data communication,
2329 * commonly referred to as CSR (Create Session Request).
2330 */
2331 GTPC_V4_FLOW = 0x15, /* hash only */
2332 GTPC_V6_FLOW = 0x16, /* hash only */
2333
2334 /* Use for GTP-C IPv4 and v6.
2335 * Unlike GTPC_V4_FLOW, the format of these GTP packets includes TEID.
2336 * After session creation, it becomes this packet.
2337 * This is mainly used for requests to realize UE handover.
2338 */
2339 GTPC_TEID_V4_FLOW = 0x17, /* hash only */
2340 GTPC_TEID_V6_FLOW = 0x18, /* hash only */
2341
2342 /* Use for GTP-U and extended headers for the PSC (PDU Session Container).
2343 * The format of these GTP packets includes TEID and QFI.
2344 * In 5G communication using UPF (User Plane Function),
2345 * data communication with this extended header is performed.
2346 */
2347 GTPU_EH_V4_FLOW = 0x19, /* hash only */
2348 GTPU_EH_V6_FLOW = 0x1a, /* hash only */
2349
2350 /* Use for GTP-U IPv4 and v6 PSC (PDU Session Container) extended headers.
2351 * This differs from GTPU_EH_V(4|6)_FLOW in that it is distinguished by
2352 * UL/DL included in the PSC.
2353 * There are differences in the data included based on Downlink/Uplink,
2354 * and can be used to distinguish packets.
2355 * The functions described so far are useful when you want to
2356 * handle communication from the mobile network in UPF, PGW, etc.
2357 */
2358 GTPU_UL_V4_FLOW = 0x1b, /* hash only */
2359 GTPU_UL_V6_FLOW = 0x1c, /* hash only */
2360 GTPU_DL_V4_FLOW = 0x1d, /* hash only */
2361 GTPU_DL_V6_FLOW = 0x1e, /* hash only */
2362
2363 __FLOW_TYPE_COUNT,
2364};
2365
2366/* Flag to enable additional fields in struct ethtool_rx_flow_spec */
2367#define FLOW_EXT 0x80000000
2368#define FLOW_MAC_EXT 0x40000000
2369/* Flag to enable RSS spreading of traffic matching rule (nfc only) */
2370#define FLOW_RSS 0x20000000
2371
2372/* L2-L4 network traffic flow hash options */
2373#define RXH_L2DA (1 << 1)
2374#define RXH_VLAN (1 << 2)
2375#define RXH_L3_PROTO (1 << 3)
2376#define RXH_IP_SRC (1 << 4)
2377#define RXH_IP_DST (1 << 5)
2378#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
2379#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
2380#define RXH_GTP_TEID (1 << 8) /* teid in case of GTP */
2381#define RXH_DISCARD (1 << 31)
2382
2383#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
2384#define RX_CLS_FLOW_WAKE 0xfffffffffffffffeULL
2385
2386/* Special RX classification rule insert location values */
2387#define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
2388#define RX_CLS_LOC_ANY 0xffffffff
2389#define RX_CLS_LOC_FIRST 0xfffffffe
2390#define RX_CLS_LOC_LAST 0xfffffffd
2391
2392/* EEPROM Standards for plug in modules */
2393#define ETH_MODULE_SFF_8079 0x1
2394#define ETH_MODULE_SFF_8079_LEN 256
2395#define ETH_MODULE_SFF_8472 0x2
2396#define ETH_MODULE_SFF_8472_LEN 512
2397#define ETH_MODULE_SFF_8636 0x3
2398#define ETH_MODULE_SFF_8636_LEN 256
2399#define ETH_MODULE_SFF_8436 0x4
2400#define ETH_MODULE_SFF_8436_LEN 256
2401
2402#define ETH_MODULE_SFF_8636_MAX_LEN 640
2403#define ETH_MODULE_SFF_8436_MAX_LEN 640
2404
2405/* Reset flags */
2406/* The reset() operation must clear the flags for the components which
2407 * were actually reset. On successful return, the flags indicate the
2408 * components which were not reset, either because they do not exist
2409 * in the hardware or because they cannot be reset independently. The
2410 * driver must never reset any components that were not requested.
2411 */
2412enum ethtool_reset_flags {
2413 /* These flags represent components dedicated to the interface
2414 * the command is addressed to. Shift any flag left by
2415 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
2416 * same type.
2417 */
2418 ETH_RESET_MGMT = 1 << 0, /* Management processor */
2419 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
2420 ETH_RESET_DMA = 1 << 2, /* DMA engine */
2421 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
2422 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
2423 ETH_RESET_MAC = 1 << 5, /* Media access controller */
2424 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
2425 ETH_RESET_RAM = 1 << 7, /* RAM shared between
2426 * multiple components */
2427 ETH_RESET_AP = 1 << 8, /* Application processor */
2428
2429 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
2430 * this interface */
2431 ETH_RESET_ALL = 0xffffffff, /* All components used by this
2432 * interface, even if shared */
2433};
2434#define ETH_RESET_SHARED_SHIFT 16
2435
2436
2437/**
2438 * struct ethtool_link_settings - link control and status
2439 *
2440 * IMPORTANT, Backward compatibility notice: When implementing new
2441 * user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and
2442 * if it succeeds use %ETHTOOL_SLINKSETTINGS to change link
2443 * settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS
2444 * succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in
2445 * that case. Conversely, if %ETHTOOL_GLINKSETTINGS fails, use
2446 * %ETHTOOL_GSET to query and %ETHTOOL_SSET to change link
2447 * settings; do not use %ETHTOOL_SLINKSETTINGS if
2448 * %ETHTOOL_GLINKSETTINGS failed: stick to
2449 * %ETHTOOL_GSET/%ETHTOOL_SSET in that case.
2450 *
2451 * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS
2452 * @speed: Link speed (Mbps)
2453 * @duplex: Duplex mode; one of %DUPLEX_*
2454 * @port: Physical connector type; one of %PORT_*
2455 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
2456 * applicable. For clause 45 PHYs this is the PRTAD.
2457 * @autoneg: Enable/disable autonegotiation and auto-detection;
2458 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE
2459 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
2460 * protocols supported by the interface; 0 if unknown.
2461 * Read-only.
2462 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
2463 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the
2464 * value will be %ETH_TP_MDI_INVALID. Read-only.
2465 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
2466 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads
2467 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
2468 * When written successfully, the link should be renegotiated if
2469 * necessary.
2470 * @link_mode_masks_nwords: Number of 32-bit words for each of the
2471 * supported, advertising, lp_advertising link mode bitmaps. For
2472 * %ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user
2473 * (>= 0); on return, if handshake in progress, negative if
2474 * request size unsupported by kernel: absolute value indicates
2475 * kernel expected size and all the other fields but cmd
2476 * are 0; otherwise (handshake completed), strictly positive
2477 * to indicate size used by kernel and cmd field stays
2478 * %ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For
2479 * %ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive
2480 * value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise
2481 * refused. For drivers: ignore this field (use kernel's
2482 * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
2483 * be overwritten by kernel.
2484 * @transceiver: Used to distinguish different possible PHY types,
2485 * reported consistently by PHYLIB. Read-only.
2486 * @master_slave_cfg: Master/slave port mode.
2487 * @master_slave_state: Master/slave port state.
2488 * @rate_matching: Rate adaptation performed by the PHY
2489 * @reserved: Reserved for future use; see the note on reserved space.
2490 * @link_mode_masks: Variable length bitmaps.
2491 *
2492 * If autonegotiation is disabled, the speed and @duplex represent the
2493 * fixed link mode and are writable if the driver supports multiple
2494 * link modes. If it is enabled then they are read-only; if the link
2495 * is up they represent the negotiated link mode; if the link is down,
2496 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
2497 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
2498 *
2499 * Some hardware interfaces may have multiple PHYs and/or physical
2500 * connectors fitted or do not allow the driver to detect which are
2501 * fitted. For these interfaces @port and/or @phy_address may be
2502 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
2503 * Otherwise, attempts to write different values may be ignored or
2504 * rejected.
2505 *
2506 * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt
2507 * are not available in %ethtool_link_settings. These fields will be
2508 * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will
2509 * fail if any of them is set to non-zero value.
2510 *
2511 * Users should assume that all fields not marked read-only are
2512 * writable and subject to validation by the driver. They should use
2513 * %ETHTOOL_GLINKSETTINGS to get the current values before making specific
2514 * changes and then applying them with %ETHTOOL_SLINKSETTINGS.
2515 *
2516 * Drivers that implement %get_link_ksettings and/or
2517 * %set_link_ksettings should ignore the @cmd
2518 * and @link_mode_masks_nwords fields (any change to them overwritten
2519 * by kernel), and rely only on kernel's internal
2520 * %__ETHTOOL_LINK_MODE_MASK_NBITS and
2521 * %ethtool_link_mode_mask_t. Drivers that implement
2522 * %set_link_ksettings() should validate all fields other than @cmd
2523 * and @link_mode_masks_nwords that are not described as read-only or
2524 * deprecated, and must ignore all fields described as read-only.
2525 *
2526 * @link_mode_masks is divided into three bitfields, each of length
2527 * @link_mode_masks_nwords:
2528 * - supported: Bitmap with each bit meaning given by
2529 * %ethtool_link_mode_bit_indices for the link modes, physical
2530 * connectors and other link features for which the interface
2531 * supports autonegotiation or auto-detection. Read-only.
2532 * - advertising: Bitmap with each bit meaning given by
2533 * %ethtool_link_mode_bit_indices for the link modes, physical
2534 * connectors and other link features that are advertised through
2535 * autonegotiation or enabled for auto-detection.
2536 * - lp_advertising: Bitmap with each bit meaning given by
2537 * %ethtool_link_mode_bit_indices for the link modes, and other
2538 * link features that the link partner advertised through
2539 * autonegotiation; 0 if unknown or not applicable. Read-only.
2540 */
2541struct ethtool_link_settings {
2542 __u32 cmd;
2543 __u32 speed;
2544 __u8 duplex;
2545 __u8 port;
2546 __u8 phy_address;
2547 __u8 autoneg;
2548 __u8 mdio_support;
2549 __u8 eth_tp_mdix;
2550 __u8 eth_tp_mdix_ctrl;
2551 __s8 link_mode_masks_nwords;
2552 __u8 transceiver;
2553 __u8 master_slave_cfg;
2554 __u8 master_slave_state;
2555 __u8 rate_matching;
2556 __u32 reserved[7];
2557 /* Linux builds with -Wflex-array-member-not-at-end but does
2558 * not use the "link_mode_masks" member. Leave it defined for
2559 * userspace for now, and when userspace wants to start using
2560 * -Wfamnae, we'll need a new solution.
2561 */
2562 __u32 link_mode_masks[];
2563 /* layout of link_mode_masks fields:
2564 * __u32 map_supported[link_mode_masks_nwords];
2565 * __u32 map_advertising[link_mode_masks_nwords];
2566 * __u32 map_lp_advertising[link_mode_masks_nwords];
2567 */
2568};
2569
2570/**
2571 * enum phy_upstream - Represents the upstream component a given PHY device
2572 * is connected to, as in what is on the other end of the MII bus. Most PHYs
2573 * will be attached to an Ethernet MAC controller, but in some cases, there's
2574 * an intermediate PHY used as a media-converter, which will driver another
2575 * MII interface as its output.
2576 * @PHY_UPSTREAM_MAC: Upstream component is a MAC (a switch port,
2577 * or ethernet controller)
2578 * @PHY_UPSTREAM_PHY: Upstream component is a PHY (likely a media converter)
2579 */
2580enum phy_upstream {
2581 PHY_UPSTREAM_MAC,
2582 PHY_UPSTREAM_PHY,
2583};
2584
2585#endif /* _LINUX_ETHTOOL_H */