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

source code of linux/include/uapi/linux/ethtool.h