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 */
105 struct 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
125 static 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
132 static 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 */
185 struct 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 */
211 struct ethtool_wolinfo {
212 __u32 cmd;
213 __u32 supported;
214 __u32 wolopts;
215 __u8 sopass[SOPASS_MAX];
216 };
217
218 /* for passing single values */
219 struct 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
227 enum 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
240 enum 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
253 struct 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
292 enum 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 */
319 struct 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 */
344 struct 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 */
370 struct 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 */
393 struct 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 */
473 struct 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 */
524 struct 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
552 struct 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 */
586 struct ethtool_pauseparam {
587 __u32 cmd;
588 __u32 autoneg;
589 __u32 rx_pause;
590 __u32 tx_pause;
591 };
592
593 /* Link extended state */
594 enum 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. */
609 enum 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 */
620 enum 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 */
629 enum 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 */
639 enum 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. */
647 enum 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. */
653 enum 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 */
687 enum 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 */
726 enum 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 */
740 enum 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 */
750 enum ethtool_module_power_mode {
751 ETHTOOL_MODULE_POWER_MODE_LOW = 1,
752 ETHTOOL_MODULE_POWER_MODE_HIGH,
753 };
754
755 /**
756 * enum ethtool_c33_pse_ext_state - groups of PSE extended states
757 * functions. IEEE 802.3-2022 33.2.4.4 Variables
758 *
759 * @ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION: Group of error_condition states
760 * @ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID: Group of mr_mps_valid states
761 * @ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE: Group of mr_pse_enable states
762 * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED: Group of option_detect_ted
763 * states
764 * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM: Group of option_vport_lim states
765 * @ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED: Group of ovld_detected states
766 * @ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE: Group of pd_dll_power_type
767 * states
768 * @ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE: Group of power_not_available
769 * states
770 * @ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED: Group of short_detected states
771 */
772 enum ethtool_c33_pse_ext_state {
773 ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION = 1,
774 ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID,
775 ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE,
776 ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED,
777 ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM,
778 ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED,
779 ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE,
780 ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE,
781 ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED,
782 };
783
784 /**
785 * enum ethtool_c33_pse_ext_substate_mr_mps_valid - mr_mps_valid states
786 * functions. IEEE 802.3-2022 33.2.4.4 Variables
787 *
788 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD: Underload
789 * state
790 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN: Port is not
791 * connected
792 *
793 * The PSE monitors either the DC or AC Maintain Power Signature
794 * (MPS, see 33.2.9.1). This variable indicates the presence or absence of
795 * a valid MPS.
796 */
797 enum ethtool_c33_pse_ext_substate_mr_mps_valid {
798 ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD = 1,
799 ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN,
800 };
801
802 /**
803 * enum ethtool_c33_pse_ext_substate_error_condition - error_condition states
804 * functions. IEEE 802.3-2022 33.2.4.4 Variables
805 *
806 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT: Non-existing
807 * port number
808 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT: Undefined port
809 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT: Internal
810 * hardware fault
811 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON:
812 * Communication error after force on
813 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS: Unknown
814 * port status
815 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF: Host
816 * crash turn off
817 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN:
818 * Host crash force shutdown
819 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE: Configuration
820 * change
821 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP: Over
822 * temperature detected
823 *
824 * error_condition is a variable indicating the status of
825 * implementation-specific fault conditions or optionally other system faults
826 * that prevent the PSE from meeting the specifications in Table 33–11 and that
827 * require the PSE not to source power. These error conditions are different
828 * from those monitored by the state diagrams in Figure 33–10.
829 */
830 enum ethtool_c33_pse_ext_substate_error_condition {
831 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT = 1,
832 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT,
833 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT,
834 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON,
835 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS,
836 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF,
837 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN,
838 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE,
839 ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP,
840 };
841
842 /**
843 * enum ethtool_c33_pse_ext_substate_mr_pse_enable - mr_pse_enable states
844 * functions. IEEE 802.3-2022 33.2.4.4 Variables
845 *
846 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE: Disable
847 * pin active
848 *
849 * mr_pse_enable is control variable that selects PSE operation and test
850 * functions.
851 */
852 enum ethtool_c33_pse_ext_substate_mr_pse_enable {
853 ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE = 1,
854 };
855
856 /**
857 * enum ethtool_c33_pse_ext_substate_option_detect_ted - option_detect_ted
858 * states functions. IEEE 802.3-2022 33.2.4.4 Variables
859 *
860 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS: Detection
861 * in process
862 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR:
863 * Connection check error
864 *
865 * option_detect_ted is a variable indicating if detection can be performed
866 * by the PSE during the ted_timer interval.
867 */
868 enum ethtool_c33_pse_ext_substate_option_detect_ted {
869 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS = 1,
870 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR,
871 };
872
873 /**
874 * enum ethtool_c33_pse_ext_substate_option_vport_lim - option_vport_lim states
875 * functions. IEEE 802.3-2022 33.2.4.4 Variables
876 *
877 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE: Main supply
878 * voltage is high
879 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE: Main supply
880 * voltage is low
881 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION: Voltage
882 * injection into the port
883 *
884 * option_vport_lim is an optional variable indicates if VPSE is out of the
885 * operating range during normal operating state.
886 */
887 enum ethtool_c33_pse_ext_substate_option_vport_lim {
888 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE = 1,
889 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE,
890 ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION,
891 };
892
893 /**
894 * enum ethtool_c33_pse_ext_substate_ovld_detected - ovld_detected states
895 * functions. IEEE 802.3-2022 33.2.4.4 Variables
896 *
897 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD: Overload state
898 *
899 * ovld_detected is a variable indicating if the PSE output current has been
900 * in an overload condition (see 33.2.7.6) for at least TCUT of a one-second
901 * sliding time.
902 */
903 enum ethtool_c33_pse_ext_substate_ovld_detected {
904 ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD = 1,
905 };
906
907 /**
908 * enum ethtool_c33_pse_ext_substate_power_not_available - power_not_available
909 * states functions. IEEE 802.3-2022 33.2.4.4 Variables
910 *
911 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED: Power
912 * budget exceeded for the controller
913 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET:
914 * Configured port power limit exceeded controller power budget
915 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT:
916 * Power request from PD exceeds port limit
917 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT: Power
918 * denied due to Hardware power limit
919 *
920 * power_not_available is a variable that is asserted in an
921 * implementation-dependent manner when the PSE is no longer capable of
922 * sourcing sufficient power to support the attached PD. Sufficient power
923 * is defined by classification; see 33.2.6.
924 */
925 enum ethtool_c33_pse_ext_substate_power_not_available {
926 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED = 1,
927 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET,
928 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT,
929 ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT,
930 };
931
932 /**
933 * enum ethtool_c33_pse_ext_substate_short_detected - short_detected states
934 * functions. IEEE 802.3-2022 33.2.4.4 Variables
935 *
936 * @ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION: Short
937 * condition was detected
938 *
939 * short_detected is a variable indicating if the PSE output current has been
940 * in a short circuit condition for TLIM within a sliding window (see 33.2.7.7).
941 */
942 enum ethtool_c33_pse_ext_substate_short_detected {
943 ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION = 1,
944 };
945
946 /**
947 * enum ethtool_pse_types - Types of PSE controller.
948 * @ETHTOOL_PSE_UNKNOWN: Type of PSE controller is unknown
949 * @ETHTOOL_PSE_PODL: PSE controller which support PoDL
950 * @ETHTOOL_PSE_C33: PSE controller which support Clause 33 (PoE)
951 */
952 enum ethtool_pse_types {
953 ETHTOOL_PSE_UNKNOWN = 1 << 0,
954 ETHTOOL_PSE_PODL = 1 << 1,
955 ETHTOOL_PSE_C33 = 1 << 2,
956 };
957
958 /**
959 * enum ethtool_c33_pse_admin_state - operational state of the PoDL PSE
960 * functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
961 * @ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN: state of PSE functions is unknown
962 * @ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED: PSE functions are disabled
963 * @ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED: PSE functions are enabled
964 */
965 enum ethtool_c33_pse_admin_state {
966 ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN = 1,
967 ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED,
968 ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED,
969 };
970
971 /**
972 * enum ethtool_c33_pse_pw_d_status - power detection status of the PSE.
973 * IEEE 802.3-2022 30.9.1.1.3 aPoDLPSEPowerDetectionStatus:
974 * @ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN: PSE status is unknown
975 * @ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED: The enumeration "disabled"
976 * indicates that the PSE State diagram is in the state DISABLED.
977 * @ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING: The enumeration "searching"
978 * indicates the PSE State diagram is in a state other than those
979 * listed.
980 * @ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING: The enumeration
981 * "deliveringPower" indicates that the PSE State diagram is in the
982 * state POWER_ON.
983 * @ETHTOOL_C33_PSE_PW_D_STATUS_TEST: The enumeration "test" indicates that
984 * the PSE State diagram is in the state TEST_MODE.
985 * @ETHTOOL_C33_PSE_PW_D_STATUS_FAULT: The enumeration "fault" indicates that
986 * the PSE State diagram is in the state TEST_ERROR.
987 * @ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT: The enumeration "otherFault"
988 * indicates that the PSE State diagram is in the state IDLE due to
989 * the variable error_condition = true.
990 */
991 enum ethtool_c33_pse_pw_d_status {
992 ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN = 1,
993 ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED,
994 ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING,
995 ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING,
996 ETHTOOL_C33_PSE_PW_D_STATUS_TEST,
997 ETHTOOL_C33_PSE_PW_D_STATUS_FAULT,
998 ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT,
999 };
1000
1001 /**
1002 * enum ethtool_podl_pse_admin_state - operational state of the PoDL PSE
1003 * functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
1004 * @ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN: state of PoDL PSE functions are
1005 * unknown
1006 * @ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED: PoDL PSE functions are disabled
1007 * @ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED: PoDL PSE functions are enabled
1008 */
1009 enum ethtool_podl_pse_admin_state {
1010 ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN = 1,
1011 ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED,
1012 ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED,
1013 };
1014
1015 /**
1016 * enum ethtool_podl_pse_pw_d_status - power detection status of the PoDL PSE.
1017 * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
1018 * @ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN: PoDL PSE
1019 * @ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED: "The enumeration “disabled” is
1020 * asserted true when the PoDL PSE state diagram variable mr_pse_enable is
1021 * false"
1022 * @ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING: "The enumeration “searching” is
1023 * asserted true when either of the PSE state diagram variables
1024 * pi_detecting or pi_classifying is true."
1025 * @ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING: "The enumeration “deliveringPower”
1026 * is asserted true when the PoDL PSE state diagram variable pi_powered is
1027 * true."
1028 * @ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP: "The enumeration “sleep” is asserted
1029 * true when the PoDL PSE state diagram variable pi_sleeping is true."
1030 * @ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE: "The enumeration “idle” is asserted true
1031 * when the logical combination of the PoDL PSE state diagram variables
1032 * pi_prebiased*!pi_sleeping is true."
1033 * @ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR: "The enumeration “error” is asserted
1034 * true when the PoDL PSE state diagram variable overload_held is true."
1035 */
1036 enum ethtool_podl_pse_pw_d_status {
1037 ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN = 1,
1038 ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED,
1039 ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING,
1040 ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING,
1041 ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP,
1042 ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE,
1043 ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR,
1044 };
1045
1046 /**
1047 * enum ethtool_mm_verify_status - status of MAC Merge Verify function
1048 * @ETHTOOL_MM_VERIFY_STATUS_UNKNOWN:
1049 * verification status is unknown
1050 * @ETHTOOL_MM_VERIFY_STATUS_INITIAL:
1051 * the 802.3 Verify State diagram is in the state INIT_VERIFICATION
1052 * @ETHTOOL_MM_VERIFY_STATUS_VERIFYING:
1053 * the Verify State diagram is in the state VERIFICATION_IDLE,
1054 * SEND_VERIFY or WAIT_FOR_RESPONSE
1055 * @ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED:
1056 * indicates that the Verify State diagram is in the state VERIFIED
1057 * @ETHTOOL_MM_VERIFY_STATUS_FAILED:
1058 * the Verify State diagram is in the state VERIFY_FAIL
1059 * @ETHTOOL_MM_VERIFY_STATUS_DISABLED:
1060 * verification of preemption operation is disabled
1061 */
1062 enum ethtool_mm_verify_status {
1063 ETHTOOL_MM_VERIFY_STATUS_UNKNOWN,
1064 ETHTOOL_MM_VERIFY_STATUS_INITIAL,
1065 ETHTOOL_MM_VERIFY_STATUS_VERIFYING,
1066 ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED,
1067 ETHTOOL_MM_VERIFY_STATUS_FAILED,
1068 ETHTOOL_MM_VERIFY_STATUS_DISABLED,
1069 };
1070
1071 /**
1072 * enum ethtool_module_fw_flash_status - plug-in module firmware flashing status
1073 * @ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED: The firmware flashing process has
1074 * started.
1075 * @ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS: The firmware flashing process
1076 * is in progress.
1077 * @ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED: The firmware flashing process was
1078 * completed successfully.
1079 * @ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR: The firmware flashing process was
1080 * stopped due to an error.
1081 */
1082 enum ethtool_module_fw_flash_status {
1083 ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED = 1,
1084 ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS,
1085 ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED,
1086 ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR,
1087 };
1088
1089 /**
1090 * struct ethtool_gstrings - string set for data tagging
1091 * @cmd: Command number = %ETHTOOL_GSTRINGS
1092 * @string_set: String set ID; one of &enum ethtool_stringset
1093 * @len: On return, the number of strings in the string set
1094 * @data: Buffer for strings. Each string is null-padded to a size of
1095 * %ETH_GSTRING_LEN.
1096 *
1097 * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in
1098 * the string set. They must allocate a buffer of the appropriate
1099 * size immediately following this structure.
1100 */
1101 struct ethtool_gstrings {
1102 __u32 cmd;
1103 __u32 string_set;
1104 __u32 len;
1105 __u8 data[];
1106 };
1107
1108 /**
1109 * struct ethtool_sset_info - string set information
1110 * @cmd: Command number = %ETHTOOL_GSSET_INFO
1111 * @reserved: Reserved for future use; see the note on reserved space.
1112 * @sset_mask: On entry, a bitmask of string sets to query, with bits
1113 * numbered according to &enum ethtool_stringset. On return, a
1114 * bitmask of those string sets queried that are supported.
1115 * @data: Buffer for string set sizes. On return, this contains the
1116 * size of each string set that was queried and supported, in
1117 * order of ID.
1118 *
1119 * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on
1120 * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the
1121 * size of set 1 and @data[1] contains the size of set 2.
1122 *
1123 * Users must allocate a buffer of the appropriate size (4 * number of
1124 * sets queried) immediately following this structure.
1125 */
1126 struct ethtool_sset_info {
1127 __u32 cmd;
1128 __u32 reserved;
1129 __u64 sset_mask;
1130 __u32 data[];
1131 };
1132
1133 /**
1134 * enum ethtool_test_flags - flags definition of ethtool_test
1135 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
1136 * only online tests.
1137 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
1138 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
1139 * test.
1140 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
1141 */
1142
1143 enum ethtool_test_flags {
1144 ETH_TEST_FL_OFFLINE = (1 << 0),
1145 ETH_TEST_FL_FAILED = (1 << 1),
1146 ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
1147 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
1148 };
1149
1150 /**
1151 * struct ethtool_test - device self-test invocation
1152 * @cmd: Command number = %ETHTOOL_TEST
1153 * @flags: A bitmask of flags from &enum ethtool_test_flags. Some
1154 * flags may be set by the user on entry; others may be set by
1155 * the driver on return.
1156 * @reserved: Reserved for future use; see the note on reserved space.
1157 * @len: On return, the number of test results
1158 * @data: Array of test results
1159 *
1160 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
1161 * number of test results that will be returned. They must allocate a
1162 * buffer of the appropriate size (8 * number of results) immediately
1163 * following this structure.
1164 */
1165 struct ethtool_test {
1166 __u32 cmd;
1167 __u32 flags;
1168 __u32 reserved;
1169 __u32 len;
1170 __u64 data[];
1171 };
1172
1173 /**
1174 * struct ethtool_stats - device-specific statistics
1175 * @cmd: Command number = %ETHTOOL_GSTATS
1176 * @n_stats: On return, the number of statistics
1177 * @data: Array of statistics
1178 *
1179 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
1180 * number of statistics that will be returned. They must allocate a
1181 * buffer of the appropriate size (8 * number of statistics)
1182 * immediately following this structure.
1183 */
1184 struct ethtool_stats {
1185 __u32 cmd;
1186 __u32 n_stats;
1187 __u64 data[];
1188 };
1189
1190 /**
1191 * struct ethtool_perm_addr - permanent hardware address
1192 * @cmd: Command number = %ETHTOOL_GPERMADDR
1193 * @size: On entry, the size of the buffer. On return, the size of the
1194 * address. The command fails if the buffer is too small.
1195 * @data: Buffer for the address
1196 *
1197 * Users must allocate the buffer immediately following this structure.
1198 * A buffer size of %MAX_ADDR_LEN should be sufficient for any address
1199 * type.
1200 */
1201 struct ethtool_perm_addr {
1202 __u32 cmd;
1203 __u32 size;
1204 __u8 data[];
1205 };
1206
1207 /* boolean flags controlling per-interface behavior characteristics.
1208 * When reading, the flag indicates whether or not a certain behavior
1209 * is enabled/present. When writing, the flag indicates whether
1210 * or not the driver should turn on (set) or off (clear) a behavior.
1211 *
1212 * Some behaviors may read-only (unconditionally absent or present).
1213 * If such is the case, return EINVAL in the set-flags operation if the
1214 * flag differs from the read-only value.
1215 */
1216 enum ethtool_flags {
1217 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
1218 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
1219 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
1220 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
1221 ETH_FLAG_RXHASH = (1 << 28),
1222 };
1223
1224 /* The following structures are for supporting RX network flow
1225 * classification and RX n-tuple configuration. Note, all multibyte
1226 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
1227 * be in network byte order.
1228 */
1229
1230 /**
1231 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
1232 * @ip4src: Source host
1233 * @ip4dst: Destination host
1234 * @psrc: Source port
1235 * @pdst: Destination port
1236 * @tos: Type-of-service
1237 *
1238 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
1239 */
1240 struct ethtool_tcpip4_spec {
1241 __be32 ip4src;
1242 __be32 ip4dst;
1243 __be16 psrc;
1244 __be16 pdst;
1245 __u8 tos;
1246 };
1247
1248 /**
1249 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
1250 * @ip4src: Source host
1251 * @ip4dst: Destination host
1252 * @spi: Security parameters index
1253 * @tos: Type-of-service
1254 *
1255 * This can be used to specify an IPsec transport or tunnel over IPv4.
1256 */
1257 struct ethtool_ah_espip4_spec {
1258 __be32 ip4src;
1259 __be32 ip4dst;
1260 __be32 spi;
1261 __u8 tos;
1262 };
1263
1264 #define ETH_RX_NFC_IP4 1
1265
1266 /**
1267 * struct ethtool_usrip4_spec - general flow specification for IPv4
1268 * @ip4src: Source host
1269 * @ip4dst: Destination host
1270 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
1271 * @tos: Type-of-service
1272 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
1273 * @proto: Transport protocol number; mask must be 0
1274 */
1275 struct ethtool_usrip4_spec {
1276 __be32 ip4src;
1277 __be32 ip4dst;
1278 __be32 l4_4_bytes;
1279 __u8 tos;
1280 __u8 ip_ver;
1281 __u8 proto;
1282 };
1283
1284 /**
1285 * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc.
1286 * @ip6src: Source host
1287 * @ip6dst: Destination host
1288 * @psrc: Source port
1289 * @pdst: Destination port
1290 * @tclass: Traffic Class
1291 *
1292 * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow.
1293 */
1294 struct ethtool_tcpip6_spec {
1295 __be32 ip6src[4];
1296 __be32 ip6dst[4];
1297 __be16 psrc;
1298 __be16 pdst;
1299 __u8 tclass;
1300 };
1301
1302 /**
1303 * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6
1304 * @ip6src: Source host
1305 * @ip6dst: Destination host
1306 * @spi: Security parameters index
1307 * @tclass: Traffic Class
1308 *
1309 * This can be used to specify an IPsec transport or tunnel over IPv6.
1310 */
1311 struct ethtool_ah_espip6_spec {
1312 __be32 ip6src[4];
1313 __be32 ip6dst[4];
1314 __be32 spi;
1315 __u8 tclass;
1316 };
1317
1318 /**
1319 * struct ethtool_usrip6_spec - general flow specification for IPv6
1320 * @ip6src: Source host
1321 * @ip6dst: Destination host
1322 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
1323 * @tclass: Traffic Class
1324 * @l4_proto: Transport protocol number (nexthdr after any Extension Headers)
1325 */
1326 struct ethtool_usrip6_spec {
1327 __be32 ip6src[4];
1328 __be32 ip6dst[4];
1329 __be32 l4_4_bytes;
1330 __u8 tclass;
1331 __u8 l4_proto;
1332 };
1333
1334 union ethtool_flow_union {
1335 struct ethtool_tcpip4_spec tcp_ip4_spec;
1336 struct ethtool_tcpip4_spec udp_ip4_spec;
1337 struct ethtool_tcpip4_spec sctp_ip4_spec;
1338 struct ethtool_ah_espip4_spec ah_ip4_spec;
1339 struct ethtool_ah_espip4_spec esp_ip4_spec;
1340 struct ethtool_usrip4_spec usr_ip4_spec;
1341 struct ethtool_tcpip6_spec tcp_ip6_spec;
1342 struct ethtool_tcpip6_spec udp_ip6_spec;
1343 struct ethtool_tcpip6_spec sctp_ip6_spec;
1344 struct ethtool_ah_espip6_spec ah_ip6_spec;
1345 struct ethtool_ah_espip6_spec esp_ip6_spec;
1346 struct ethtool_usrip6_spec usr_ip6_spec;
1347 struct ethhdr ether_spec;
1348 __u8 hdata[52];
1349 };
1350
1351 /**
1352 * struct ethtool_flow_ext - additional RX flow fields
1353 * @h_dest: destination MAC address
1354 * @vlan_etype: VLAN EtherType
1355 * @vlan_tci: VLAN tag control information
1356 * @data: user defined data
1357 * @padding: Reserved for future use; see the note on reserved space.
1358 *
1359 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
1360 * is set in &struct ethtool_rx_flow_spec @flow_type.
1361 * @h_dest is valid if %FLOW_MAC_EXT is set.
1362 */
1363 struct ethtool_flow_ext {
1364 __u8 padding[2];
1365 unsigned char h_dest[ETH_ALEN];
1366 __be16 vlan_etype;
1367 __be16 vlan_tci;
1368 __be32 data[2];
1369 };
1370
1371 /**
1372 * struct ethtool_rx_flow_spec - classification rule for RX flows
1373 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1374 * @h_u: Flow fields to match (dependent on @flow_type)
1375 * @h_ext: Additional fields to match
1376 * @m_u: Masks for flow field bits to be matched
1377 * @m_ext: Masks for additional field bits to be matched
1378 * Note, all additional fields must be ignored unless @flow_type
1379 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag
1380 * (see &struct ethtool_flow_ext description).
1381 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
1382 * if packets should be discarded, or %RX_CLS_FLOW_WAKE if the
1383 * packets should be used for Wake-on-LAN with %WAKE_FILTER
1384 * @location: Location of rule in the table. Locations must be
1385 * numbered such that a flow matching multiple rules will be
1386 * classified according to the first (lowest numbered) rule.
1387 */
1388 struct ethtool_rx_flow_spec {
1389 __u32 flow_type;
1390 union ethtool_flow_union h_u;
1391 struct ethtool_flow_ext h_ext;
1392 union ethtool_flow_union m_u;
1393 struct ethtool_flow_ext m_ext;
1394 __u64 ring_cookie;
1395 __u32 location;
1396 };
1397
1398 /* How rings are laid out when accessing virtual functions or
1399 * offloaded queues is device specific. To allow users to do flow
1400 * steering and specify these queues the ring cookie is partitioned
1401 * into a 32bit queue index with an 8 bit virtual function id.
1402 * This also leaves the 3bytes for further specifiers. It is possible
1403 * future devices may support more than 256 virtual functions if
1404 * devices start supporting PCIe w/ARI. However at the moment I
1405 * do not know of any devices that support this so I do not reserve
1406 * space for this at this time. If a future patch consumes the next
1407 * byte it should be aware of this possibility.
1408 */
1409 #define ETHTOOL_RX_FLOW_SPEC_RING 0x00000000FFFFFFFFLL
1410 #define ETHTOOL_RX_FLOW_SPEC_RING_VF 0x000000FF00000000LL
1411 #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32
1412 static inline __u64 ethtool_get_flow_spec_ring(__u64 ring_cookie)
1413 {
1414 return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie;
1415 }
1416
1417 static inline __u64 ethtool_get_flow_spec_ring_vf(__u64 ring_cookie)
1418 {
1419 return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >>
1420 ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF;
1421 }
1422
1423 /**
1424 * struct ethtool_rxnfc - command to get or set RX flow classification rules
1425 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
1426 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
1427 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
1428 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
1429 * @data: Command-dependent value
1430 * @fs: Flow classification rule
1431 * @rss_context: RSS context to be affected
1432 * @rule_cnt: Number of rules to be affected
1433 * @rule_locs: Array of used rule locations
1434 *
1435 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
1436 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
1437 * structure fields must not be used, except that if @flow_type includes
1438 * the %FLOW_RSS flag, then @rss_context determines which RSS context to
1439 * act on.
1440 *
1441 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
1442 * on return.
1443 *
1444 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
1445 * rules on return. If @data is non-zero on return then it is the
1446 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
1447 * driver supports any special location values. If that flag is not
1448 * set in @data then special location values should not be used.
1449 *
1450 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
1451 * existing rule on entry and @fs contains the rule on return; if
1452 * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is
1453 * filled with the RSS context ID associated with the rule.
1454 *
1455 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
1456 * user buffer for @rule_locs on entry. On return, @data is the size
1457 * of the rule table, @rule_cnt is the number of defined rules, and
1458 * @rule_locs contains the locations of the defined rules. Drivers
1459 * must use the second parameter to get_rxnfc() instead of @rule_locs.
1460 *
1461 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
1462 * @fs.@location either specifies the location to use or is a special
1463 * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
1464 * @fs.@location is the actual rule location. If @fs.@flow_type
1465 * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to
1466 * use for flow spreading traffic which matches this rule. The value
1467 * from the rxfh indirection table will be added to @fs.@ring_cookie
1468 * to choose which ring to deliver to.
1469 *
1470 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
1471 * existing rule on entry.
1472 *
1473 * A driver supporting the special location values for
1474 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
1475 * location, and may remove a rule at a later location (lower
1476 * priority) that matches exactly the same set of flows. The special
1477 * values are %RX_CLS_LOC_ANY, selecting any location;
1478 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
1479 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
1480 * location (minimum priority). Additional special values may be
1481 * defined in future and drivers must return -%EINVAL for any
1482 * unrecognised value.
1483 */
1484 struct ethtool_rxnfc {
1485 __u32 cmd;
1486 __u32 flow_type;
1487 __u64 data;
1488 struct ethtool_rx_flow_spec fs;
1489 union {
1490 __u32 rule_cnt;
1491 __u32 rss_context;
1492 };
1493 __u32 rule_locs[];
1494 };
1495
1496
1497 /**
1498 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
1499 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
1500 * @size: On entry, the array size of the user buffer, which may be zero.
1501 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
1502 * indirection table.
1503 * @ring_index: RX ring/queue index for each hash value
1504 *
1505 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
1506 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
1507 * the table should be reset to default values. This last feature
1508 * is not supported by the original implementations.
1509 */
1510 struct ethtool_rxfh_indir {
1511 __u32 cmd;
1512 __u32 size;
1513 __u32 ring_index[];
1514 };
1515
1516 /**
1517 * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key.
1518 * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH
1519 * @rss_context: RSS context identifier. Context 0 is the default for normal
1520 * traffic; other contexts can be referenced as the destination for RX flow
1521 * classification rules. %ETH_RXFH_CONTEXT_ALLOC is used with command
1522 * %ETHTOOL_SRSSH to allocate a new RSS context; on return this field will
1523 * contain the ID of the newly allocated context.
1524 * @indir_size: On entry, the array size of the user buffer for the
1525 * indirection table, which may be zero, or (for %ETHTOOL_SRSSH),
1526 * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH,
1527 * the array size of the hardware indirection table.
1528 * @key_size: On entry, the array size of the user buffer for the hash key,
1529 * which may be zero. On return from %ETHTOOL_GRSSH, the size of the
1530 * hardware hash key.
1531 * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
1532 * Valid values are one of the %ETH_RSS_HASH_*.
1533 * @input_xfrm: Defines how the input data is transformed. Valid values are one
1534 * of %RXH_XFRM_*.
1535 * @rsvd8: Reserved for future use; see the note on reserved space.
1536 * @rsvd32: Reserved for future use; see the note on reserved space.
1537 * @rss_config: RX ring/queue index for each hash value i.e., indirection table
1538 * of @indir_size __u32 elements, followed by hash key of @key_size
1539 * bytes.
1540 *
1541 * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the
1542 * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of
1543 * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested
1544 * and a @indir_size of zero means the indir table should be reset to default
1545 * values (if @rss_context == 0) or that the RSS context should be deleted.
1546 * An hfunc of zero means that hash function setting is not requested.
1547 */
1548 struct ethtool_rxfh {
1549 __u32 cmd;
1550 __u32 rss_context;
1551 __u32 indir_size;
1552 __u32 key_size;
1553 __u8 hfunc;
1554 __u8 input_xfrm;
1555 __u8 rsvd8[2];
1556 __u32 rsvd32;
1557 __u32 rss_config[];
1558 };
1559 #define ETH_RXFH_CONTEXT_ALLOC 0xffffffff
1560 #define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff
1561
1562 /**
1563 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
1564 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
1565 * @h_u: Flow field values to match (dependent on @flow_type)
1566 * @m_u: Masks for flow field value bits to be ignored
1567 * @vlan_tag: VLAN tag to match
1568 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
1569 * @data: Driver-dependent data to match
1570 * @data_mask: Mask for driver-dependent data bits to be ignored
1571 * @action: RX ring/queue index to deliver to (non-negative) or other action
1572 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
1573 *
1574 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
1575 * a field value and mask are both zero this is treated as if all mask
1576 * bits are set i.e. the field is ignored.
1577 */
1578 struct ethtool_rx_ntuple_flow_spec {
1579 __u32 flow_type;
1580 union {
1581 struct ethtool_tcpip4_spec tcp_ip4_spec;
1582 struct ethtool_tcpip4_spec udp_ip4_spec;
1583 struct ethtool_tcpip4_spec sctp_ip4_spec;
1584 struct ethtool_ah_espip4_spec ah_ip4_spec;
1585 struct ethtool_ah_espip4_spec esp_ip4_spec;
1586 struct ethtool_usrip4_spec usr_ip4_spec;
1587 struct ethhdr ether_spec;
1588 __u8 hdata[72];
1589 } h_u, m_u;
1590
1591 __u16 vlan_tag;
1592 __u16 vlan_tag_mask;
1593 __u64 data;
1594 __u64 data_mask;
1595
1596 __s32 action;
1597 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
1598 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
1599 };
1600
1601 /**
1602 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
1603 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
1604 * @fs: Flow filter specification
1605 */
1606 struct ethtool_rx_ntuple {
1607 __u32 cmd;
1608 struct ethtool_rx_ntuple_flow_spec fs;
1609 };
1610
1611 #define ETHTOOL_FLASH_MAX_FILENAME 128
1612 enum ethtool_flash_op_type {
1613 ETHTOOL_FLASH_ALL_REGIONS = 0,
1614 };
1615
1616 /* for passing firmware flashing related parameters */
1617 struct ethtool_flash {
1618 __u32 cmd;
1619 __u32 region;
1620 char data[ETHTOOL_FLASH_MAX_FILENAME];
1621 };
1622
1623 /**
1624 * struct ethtool_dump - used for retrieving, setting device dump
1625 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
1626 * %ETHTOOL_SET_DUMP
1627 * @version: FW version of the dump, filled in by driver
1628 * @flag: driver dependent flag for dump setting, filled in by driver during
1629 * get and filled in by ethtool for set operation.
1630 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
1631 * firmware dump is disabled.
1632 * @len: length of dump data, used as the length of the user buffer on entry to
1633 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
1634 * for %ETHTOOL_GET_DUMP_FLAG command
1635 * @data: data collected for get dump data operation
1636 */
1637 struct ethtool_dump {
1638 __u32 cmd;
1639 __u32 version;
1640 __u32 flag;
1641 __u32 len;
1642 __u8 data[];
1643 };
1644
1645 #define ETH_FW_DUMP_DISABLE 0
1646
1647 /* for returning and changing feature sets */
1648
1649 /**
1650 * struct ethtool_get_features_block - block with state of 32 features
1651 * @available: mask of changeable features
1652 * @requested: mask of features requested to be enabled if possible
1653 * @active: mask of currently enabled features
1654 * @never_changed: mask of features not changeable for any device
1655 */
1656 struct ethtool_get_features_block {
1657 __u32 available;
1658 __u32 requested;
1659 __u32 active;
1660 __u32 never_changed;
1661 };
1662
1663 /**
1664 * struct ethtool_gfeatures - command to get state of device's features
1665 * @cmd: command number = %ETHTOOL_GFEATURES
1666 * @size: On entry, the number of elements in the features[] array;
1667 * on return, the number of elements in features[] needed to hold
1668 * all features
1669 * @features: state of features
1670 */
1671 struct ethtool_gfeatures {
1672 __u32 cmd;
1673 __u32 size;
1674 struct ethtool_get_features_block features[];
1675 };
1676
1677 /**
1678 * struct ethtool_set_features_block - block with request for 32 features
1679 * @valid: mask of features to be changed
1680 * @requested: values of features to be changed
1681 */
1682 struct ethtool_set_features_block {
1683 __u32 valid;
1684 __u32 requested;
1685 };
1686
1687 /**
1688 * struct ethtool_sfeatures - command to request change in device's features
1689 * @cmd: command number = %ETHTOOL_SFEATURES
1690 * @size: array size of the features[] array
1691 * @features: feature change masks
1692 */
1693 struct ethtool_sfeatures {
1694 __u32 cmd;
1695 __u32 size;
1696 struct ethtool_set_features_block features[];
1697 };
1698
1699 /**
1700 * struct ethtool_ts_info - holds a device's timestamping and PHC association
1701 * @cmd: command number = %ETHTOOL_GET_TS_INFO
1702 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
1703 * @phc_index: device index of the associated PHC, or -1 if there is none
1704 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
1705 * @tx_reserved: Reserved for future use; see the note on reserved space.
1706 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
1707 * @rx_reserved: Reserved for future use; see the note on reserved space.
1708 *
1709 * The bits in the 'tx_types' and 'rx_filters' fields correspond to
1710 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
1711 * respectively. For example, if the device supports HWTSTAMP_TX_ON,
1712 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
1713 *
1714 * Drivers should only report the filters they actually support without
1715 * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for
1716 * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the
1717 * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op.
1718 */
1719 struct ethtool_ts_info {
1720 __u32 cmd;
1721 __u32 so_timestamping;
1722 __s32 phc_index;
1723 __u32 tx_types;
1724 __u32 tx_reserved[3];
1725 __u32 rx_filters;
1726 __u32 rx_reserved[3];
1727 };
1728
1729 /*
1730 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
1731 * values of corresponding bits in features[].requested. Bits in .requested
1732 * not set in .valid or not changeable are ignored.
1733 *
1734 * Returns %EINVAL when .valid contains undefined or never-changeable bits
1735 * or size is not equal to required number of features words (32-bit blocks).
1736 * Returns >= 0 if request was completed; bits set in the value mean:
1737 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
1738 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
1739 * those bits were ignored.
1740 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
1741 * resulting state of bits masked by .valid is not equal to .requested.
1742 * Probably there are other device-specific constraints on some features
1743 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
1744 * here as though ignored bits were cleared.
1745 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
1746 * compatibility functions. Requested offload state cannot be properly
1747 * managed by kernel.
1748 *
1749 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
1750 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
1751 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
1752 * significant bit in features[0] fields. Empty strings mark undefined features.
1753 */
1754 enum ethtool_sfeatures_retval_bits {
1755 ETHTOOL_F_UNSUPPORTED__BIT,
1756 ETHTOOL_F_WISH__BIT,
1757 ETHTOOL_F_COMPAT__BIT,
1758 };
1759
1760 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
1761 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
1762 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
1763
1764 #define MAX_NUM_QUEUE 4096
1765
1766 /**
1767 * struct ethtool_per_queue_op - apply sub command to the queues in mask.
1768 * @cmd: ETHTOOL_PERQUEUE
1769 * @sub_command: the sub command which apply to each queues
1770 * @queue_mask: Bitmap of the queues which sub command apply to
1771 * @data: A complete command structure following for each of the queues addressed
1772 */
1773 struct ethtool_per_queue_op {
1774 __u32 cmd;
1775 __u32 sub_command;
1776 __u32 queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)];
1777 char data[];
1778 };
1779
1780 /**
1781 * struct ethtool_fecparam - Ethernet Forward Error Correction parameters
1782 * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM
1783 * @active_fec: FEC mode which is active on the port, single bit set, GET only.
1784 * @fec: Bitmask of configured FEC modes.
1785 * @reserved: Reserved for future extensions, ignore on GET, write 0 for SET.
1786 *
1787 * Note that @reserved was never validated on input and ethtool user space
1788 * left it uninitialized when calling SET. Hence going forward it can only be
1789 * used to return a value to userspace with GET.
1790 *
1791 * FEC modes supported by the device can be read via %ETHTOOL_GLINKSETTINGS.
1792 * FEC settings are configured by link autonegotiation whenever it's enabled.
1793 * With autoneg on %ETHTOOL_GFECPARAM can be used to read the current mode.
1794 *
1795 * When autoneg is disabled %ETHTOOL_SFECPARAM controls the FEC settings.
1796 * It is recommended that drivers only accept a single bit set in @fec.
1797 * When multiple bits are set in @fec drivers may pick mode in an implementation
1798 * dependent way. Drivers should reject mixing %ETHTOOL_FEC_AUTO_BIT with other
1799 * FEC modes, because it's unclear whether in this case other modes constrain
1800 * AUTO or are independent choices.
1801 * Drivers must reject SET requests if they support none of the requested modes.
1802 *
1803 * If device does not support FEC drivers may use %ETHTOOL_FEC_NONE instead
1804 * of returning %EOPNOTSUPP from %ETHTOOL_GFECPARAM.
1805 *
1806 * See enum ethtool_fec_config_bits for definition of valid bits for both
1807 * @fec and @active_fec.
1808 */
1809 struct ethtool_fecparam {
1810 __u32 cmd;
1811 /* bitmask of FEC modes */
1812 __u32 active_fec;
1813 __u32 fec;
1814 __u32 reserved;
1815 };
1816
1817 /**
1818 * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
1819 * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not
1820 * be used together with other bits. GET only.
1821 * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually
1822 * based link mode and SFP parameters read from module's
1823 * EEPROM. This bit does _not_ mean autonegotiation.
1824 * @ETHTOOL_FEC_OFF_BIT: No FEC Mode
1825 * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode
1826 * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode
1827 * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet
1828 * Consortium)
1829 */
1830 enum ethtool_fec_config_bits {
1831 ETHTOOL_FEC_NONE_BIT,
1832 ETHTOOL_FEC_AUTO_BIT,
1833 ETHTOOL_FEC_OFF_BIT,
1834 ETHTOOL_FEC_RS_BIT,
1835 ETHTOOL_FEC_BASER_BIT,
1836 ETHTOOL_FEC_LLRS_BIT,
1837 };
1838
1839 #define ETHTOOL_FEC_NONE (1 << ETHTOOL_FEC_NONE_BIT)
1840 #define ETHTOOL_FEC_AUTO (1 << ETHTOOL_FEC_AUTO_BIT)
1841 #define ETHTOOL_FEC_OFF (1 << ETHTOOL_FEC_OFF_BIT)
1842 #define ETHTOOL_FEC_RS (1 << ETHTOOL_FEC_RS_BIT)
1843 #define ETHTOOL_FEC_BASER (1 << ETHTOOL_FEC_BASER_BIT)
1844 #define ETHTOOL_FEC_LLRS (1 << ETHTOOL_FEC_LLRS_BIT)
1845
1846 /* CMDs currently supported */
1847 #define ETHTOOL_GSET 0x00000001 /* DEPRECATED, Get settings.
1848 * Please use ETHTOOL_GLINKSETTINGS
1849 */
1850 #define ETHTOOL_SSET 0x00000002 /* DEPRECATED, Set settings.
1851 * Please use ETHTOOL_SLINKSETTINGS
1852 */
1853 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
1854 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
1855 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
1856 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
1857 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
1858 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
1859 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
1860 /* Get link status for host, i.e. whether the interface *and* the
1861 * physical port (if there is one) are up (ethtool_value). */
1862 #define ETHTOOL_GLINK 0x0000000a
1863 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
1864 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
1865 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
1866 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
1867 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
1868 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
1869 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
1870 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
1871 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
1872 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
1873 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
1874 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
1875 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
1876 * (ethtool_value) */
1877 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
1878 * (ethtool_value). */
1879 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
1880 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
1881 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
1882 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
1883 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
1884 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
1885 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
1886 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
1887 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
1888 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
1889 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
1890 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
1891 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
1892 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
1893 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
1894
1895 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
1896 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
1897 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
1898 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
1899 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
1900 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
1901 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
1902 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
1903 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
1904 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
1905 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
1906 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
1907 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
1908 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
1909 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
1910 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1911 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
1912
1913 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1914 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
1915 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1916 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1917 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1918 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1919 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
1920 #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
1921 #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */
1922 #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */
1923 #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */
1924 #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */
1925
1926 #define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */
1927 #define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */
1928 #define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */
1929 #define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */
1930 #define ETHTOOL_GPHYSTATS 0x0000004a /* get PHY-specific statistics */
1931
1932 #define ETHTOOL_PERQUEUE 0x0000004b /* Set per queue options */
1933
1934 #define ETHTOOL_GLINKSETTINGS 0x0000004c /* Get ethtool_link_settings */
1935 #define ETHTOOL_SLINKSETTINGS 0x0000004d /* Set ethtool_link_settings */
1936 #define ETHTOOL_PHY_GTUNABLE 0x0000004e /* Get PHY tunable configuration */
1937 #define ETHTOOL_PHY_STUNABLE 0x0000004f /* Set PHY tunable configuration */
1938 #define ETHTOOL_GFECPARAM 0x00000050 /* Get FEC settings */
1939 #define ETHTOOL_SFECPARAM 0x00000051 /* Set FEC settings */
1940
1941 /* compatibility with older code */
1942 #define SPARC_ETH_GSET ETHTOOL_GSET
1943 #define SPARC_ETH_SSET ETHTOOL_SSET
1944
1945 /* Link mode bit indices */
1946 enum ethtool_link_mode_bit_indices {
1947 ETHTOOL_LINK_MODE_10baseT_Half_BIT = 0,
1948 ETHTOOL_LINK_MODE_10baseT_Full_BIT = 1,
1949 ETHTOOL_LINK_MODE_100baseT_Half_BIT = 2,
1950 ETHTOOL_LINK_MODE_100baseT_Full_BIT = 3,
1951 ETHTOOL_LINK_MODE_1000baseT_Half_BIT = 4,
1952 ETHTOOL_LINK_MODE_1000baseT_Full_BIT = 5,
1953 ETHTOOL_LINK_MODE_Autoneg_BIT = 6,
1954 ETHTOOL_LINK_MODE_TP_BIT = 7,
1955 ETHTOOL_LINK_MODE_AUI_BIT = 8,
1956 ETHTOOL_LINK_MODE_MII_BIT = 9,
1957 ETHTOOL_LINK_MODE_FIBRE_BIT = 10,
1958 ETHTOOL_LINK_MODE_BNC_BIT = 11,
1959 ETHTOOL_LINK_MODE_10000baseT_Full_BIT = 12,
1960 ETHTOOL_LINK_MODE_Pause_BIT = 13,
1961 ETHTOOL_LINK_MODE_Asym_Pause_BIT = 14,
1962 ETHTOOL_LINK_MODE_2500baseX_Full_BIT = 15,
1963 ETHTOOL_LINK_MODE_Backplane_BIT = 16,
1964 ETHTOOL_LINK_MODE_1000baseKX_Full_BIT = 17,
1965 ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT = 18,
1966 ETHTOOL_LINK_MODE_10000baseKR_Full_BIT = 19,
1967 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT = 20,
1968 ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21,
1969 ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT = 22,
1970 ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT = 23,
1971 ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT = 24,
1972 ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT = 25,
1973 ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT = 26,
1974 ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT = 27,
1975 ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT = 28,
1976 ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT = 29,
1977 ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT = 30,
1978 ETHTOOL_LINK_MODE_25000baseCR_Full_BIT = 31,
1979
1980 /* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit
1981 * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_*
1982 * macro for bits > 31. The only way to use indices > 31 is to
1983 * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API.
1984 */
1985
1986 ETHTOOL_LINK_MODE_25000baseKR_Full_BIT = 32,
1987 ETHTOOL_LINK_MODE_25000baseSR_Full_BIT = 33,
1988 ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT = 34,
1989 ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT = 35,
1990 ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT = 36,
1991 ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT = 37,
1992 ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT = 38,
1993 ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT = 39,
1994 ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT = 40,
1995 ETHTOOL_LINK_MODE_1000baseX_Full_BIT = 41,
1996 ETHTOOL_LINK_MODE_10000baseCR_Full_BIT = 42,
1997 ETHTOOL_LINK_MODE_10000baseSR_Full_BIT = 43,
1998 ETHTOOL_LINK_MODE_10000baseLR_Full_BIT = 44,
1999 ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT = 45,
2000 ETHTOOL_LINK_MODE_10000baseER_Full_BIT = 46,
2001 ETHTOOL_LINK_MODE_2500baseT_Full_BIT = 47,
2002 ETHTOOL_LINK_MODE_5000baseT_Full_BIT = 48,
2003
2004 ETHTOOL_LINK_MODE_FEC_NONE_BIT = 49,
2005 ETHTOOL_LINK_MODE_FEC_RS_BIT = 50,
2006 ETHTOOL_LINK_MODE_FEC_BASER_BIT = 51,
2007 ETHTOOL_LINK_MODE_50000baseKR_Full_BIT = 52,
2008 ETHTOOL_LINK_MODE_50000baseSR_Full_BIT = 53,
2009 ETHTOOL_LINK_MODE_50000baseCR_Full_BIT = 54,
2010 ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT = 55,
2011 ETHTOOL_LINK_MODE_50000baseDR_Full_BIT = 56,
2012 ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT = 57,
2013 ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT = 58,
2014 ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT = 59,
2015 ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60,
2016 ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT = 61,
2017 ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT = 62,
2018 ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT = 63,
2019 ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64,
2020 ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT = 65,
2021 ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT = 66,
2022 ETHTOOL_LINK_MODE_100baseT1_Full_BIT = 67,
2023 ETHTOOL_LINK_MODE_1000baseT1_Full_BIT = 68,
2024 ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT = 69,
2025 ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT = 70,
2026 ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71,
2027 ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT = 72,
2028 ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT = 73,
2029 ETHTOOL_LINK_MODE_FEC_LLRS_BIT = 74,
2030 ETHTOOL_LINK_MODE_100000baseKR_Full_BIT = 75,
2031 ETHTOOL_LINK_MODE_100000baseSR_Full_BIT = 76,
2032 ETHTOOL_LINK_MODE_100000baseLR_ER_FR_Full_BIT = 77,
2033 ETHTOOL_LINK_MODE_100000baseCR_Full_BIT = 78,
2034 ETHTOOL_LINK_MODE_100000baseDR_Full_BIT = 79,
2035 ETHTOOL_LINK_MODE_200000baseKR2_Full_BIT = 80,
2036 ETHTOOL_LINK_MODE_200000baseSR2_Full_BIT = 81,
2037 ETHTOOL_LINK_MODE_200000baseLR2_ER2_FR2_Full_BIT = 82,
2038 ETHTOOL_LINK_MODE_200000baseDR2_Full_BIT = 83,
2039 ETHTOOL_LINK_MODE_200000baseCR2_Full_BIT = 84,
2040 ETHTOOL_LINK_MODE_400000baseKR4_Full_BIT = 85,
2041 ETHTOOL_LINK_MODE_400000baseSR4_Full_BIT = 86,
2042 ETHTOOL_LINK_MODE_400000baseLR4_ER4_FR4_Full_BIT = 87,
2043 ETHTOOL_LINK_MODE_400000baseDR4_Full_BIT = 88,
2044 ETHTOOL_LINK_MODE_400000baseCR4_Full_BIT = 89,
2045 ETHTOOL_LINK_MODE_100baseFX_Half_BIT = 90,
2046 ETHTOOL_LINK_MODE_100baseFX_Full_BIT = 91,
2047 ETHTOOL_LINK_MODE_10baseT1L_Full_BIT = 92,
2048 ETHTOOL_LINK_MODE_800000baseCR8_Full_BIT = 93,
2049 ETHTOOL_LINK_MODE_800000baseKR8_Full_BIT = 94,
2050 ETHTOOL_LINK_MODE_800000baseDR8_Full_BIT = 95,
2051 ETHTOOL_LINK_MODE_800000baseDR8_2_Full_BIT = 96,
2052 ETHTOOL_LINK_MODE_800000baseSR8_Full_BIT = 97,
2053 ETHTOOL_LINK_MODE_800000baseVR8_Full_BIT = 98,
2054 ETHTOOL_LINK_MODE_10baseT1S_Full_BIT = 99,
2055 ETHTOOL_LINK_MODE_10baseT1S_Half_BIT = 100,
2056 ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT = 101,
2057 ETHTOOL_LINK_MODE_10baseT1BRR_Full_BIT = 102,
2058
2059 /* must be last entry */
2060 __ETHTOOL_LINK_MODE_MASK_NBITS
2061 };
2062
2063 #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name) \
2064 (1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT))
2065
2066 /* DEPRECATED macros. Please migrate to
2067 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
2068 * define any new SUPPORTED_* macro for bits > 31.
2069 */
2070 #define SUPPORTED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
2071 #define SUPPORTED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
2072 #define SUPPORTED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
2073 #define SUPPORTED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
2074 #define SUPPORTED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
2075 #define SUPPORTED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
2076 #define SUPPORTED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
2077 #define SUPPORTED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
2078 #define SUPPORTED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
2079 #define SUPPORTED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
2080 #define SUPPORTED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
2081 #define SUPPORTED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
2082 #define SUPPORTED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
2083 #define SUPPORTED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
2084 #define SUPPORTED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
2085 #define SUPPORTED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
2086 #define SUPPORTED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
2087 #define SUPPORTED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
2088 #define SUPPORTED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
2089 #define SUPPORTED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
2090 #define SUPPORTED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
2091 #define SUPPORTED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
2092 #define SUPPORTED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
2093 #define SUPPORTED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
2094 #define SUPPORTED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
2095 #define SUPPORTED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
2096 #define SUPPORTED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
2097 #define SUPPORTED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
2098 #define SUPPORTED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
2099 #define SUPPORTED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
2100 #define SUPPORTED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
2101 /* Please do not define any new SUPPORTED_* macro for bits > 31, see
2102 * notice above.
2103 */
2104
2105 /*
2106 * DEPRECATED macros. Please migrate to
2107 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
2108 * define any new ADERTISE_* macro for bits > 31.
2109 */
2110 #define ADVERTISED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
2111 #define ADVERTISED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
2112 #define ADVERTISED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
2113 #define ADVERTISED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
2114 #define ADVERTISED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
2115 #define ADVERTISED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
2116 #define ADVERTISED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
2117 #define ADVERTISED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
2118 #define ADVERTISED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
2119 #define ADVERTISED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
2120 #define ADVERTISED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
2121 #define ADVERTISED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
2122 #define ADVERTISED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
2123 #define ADVERTISED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
2124 #define ADVERTISED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
2125 #define ADVERTISED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
2126 #define ADVERTISED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
2127 #define ADVERTISED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
2128 #define ADVERTISED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
2129 #define ADVERTISED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
2130 #define ADVERTISED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
2131 #define ADVERTISED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
2132 #define ADVERTISED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
2133 #define ADVERTISED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
2134 #define ADVERTISED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
2135 #define ADVERTISED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
2136 #define ADVERTISED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
2137 #define ADVERTISED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
2138 #define ADVERTISED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
2139 #define ADVERTISED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
2140 #define ADVERTISED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
2141 /* Please do not define any new ADVERTISED_* macro for bits > 31, see
2142 * notice above.
2143 */
2144
2145 /* The following are all involved in forcing a particular link
2146 * mode for the device for setting things. When getting the
2147 * devices settings, these indicate the current mode and whether
2148 * it was forced up into this mode or autonegotiated.
2149 */
2150
2151 /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal.
2152 * Update drivers/net/phy/phy.c:phy_speed_to_str() and
2153 * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values.
2154 */
2155 #define SPEED_10 10
2156 #define SPEED_100 100
2157 #define SPEED_1000 1000
2158 #define SPEED_2500 2500
2159 #define SPEED_5000 5000
2160 #define SPEED_10000 10000
2161 #define SPEED_14000 14000
2162 #define SPEED_20000 20000
2163 #define SPEED_25000 25000
2164 #define SPEED_40000 40000
2165 #define SPEED_50000 50000
2166 #define SPEED_56000 56000
2167 #define SPEED_100000 100000
2168 #define SPEED_200000 200000
2169 #define SPEED_400000 400000
2170 #define SPEED_800000 800000
2171
2172 #define SPEED_UNKNOWN -1
2173
2174 static inline int ethtool_validate_speed(__u32 speed)
2175 {
2176 return speed <= INT_MAX || speed == (__u32)SPEED_UNKNOWN;
2177 }
2178
2179 /* Duplex, half or full. */
2180 #define DUPLEX_HALF 0x00
2181 #define DUPLEX_FULL 0x01
2182 #define DUPLEX_UNKNOWN 0xff
2183
2184 static inline int ethtool_validate_duplex(__u8 duplex)
2185 {
2186 switch (duplex) {
2187 case DUPLEX_HALF:
2188 case DUPLEX_FULL:
2189 case DUPLEX_UNKNOWN:
2190 return 1;
2191 }
2192
2193 return 0;
2194 }
2195
2196 #define MASTER_SLAVE_CFG_UNSUPPORTED 0
2197 #define MASTER_SLAVE_CFG_UNKNOWN 1
2198 #define MASTER_SLAVE_CFG_MASTER_PREFERRED 2
2199 #define MASTER_SLAVE_CFG_SLAVE_PREFERRED 3
2200 #define MASTER_SLAVE_CFG_MASTER_FORCE 4
2201 #define MASTER_SLAVE_CFG_SLAVE_FORCE 5
2202 #define MASTER_SLAVE_STATE_UNSUPPORTED 0
2203 #define MASTER_SLAVE_STATE_UNKNOWN 1
2204 #define MASTER_SLAVE_STATE_MASTER 2
2205 #define MASTER_SLAVE_STATE_SLAVE 3
2206 #define MASTER_SLAVE_STATE_ERR 4
2207
2208 /* These are used to throttle the rate of data on the phy interface when the
2209 * native speed of the interface is higher than the link speed. These should
2210 * not be used for phy interfaces which natively support multiple speeds (e.g.
2211 * MII or SGMII).
2212 */
2213 /* No rate matching performed. */
2214 #define RATE_MATCH_NONE 0
2215 /* The phy sends pause frames to throttle the MAC. */
2216 #define RATE_MATCH_PAUSE 1
2217 /* The phy asserts CRS to prevent the MAC from transmitting. */
2218 #define RATE_MATCH_CRS 2
2219 /* The MAC is programmed with a sufficiently-large IPG. */
2220 #define RATE_MATCH_OPEN_LOOP 3
2221
2222 /* Which connector port. */
2223 #define PORT_TP 0x00
2224 #define PORT_AUI 0x01
2225 #define PORT_MII 0x02
2226 #define PORT_FIBRE 0x03
2227 #define PORT_BNC 0x04
2228 #define PORT_DA 0x05
2229 #define PORT_NONE 0xef
2230 #define PORT_OTHER 0xff
2231
2232 /* Which transceiver to use. */
2233 #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */
2234 #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */
2235 #define XCVR_DUMMY1 0x02
2236 #define XCVR_DUMMY2 0x03
2237 #define XCVR_DUMMY3 0x04
2238
2239 /* Enable or disable autonegotiation. */
2240 #define AUTONEG_DISABLE 0x00
2241 #define AUTONEG_ENABLE 0x01
2242
2243 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
2244 * the driver is required to renegotiate link
2245 */
2246 #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */
2247 #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */
2248 #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */
2249 #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */
2250
2251 /* Wake-On-Lan options. */
2252 #define WAKE_PHY (1 << 0)
2253 #define WAKE_UCAST (1 << 1)
2254 #define WAKE_MCAST (1 << 2)
2255 #define WAKE_BCAST (1 << 3)
2256 #define WAKE_ARP (1 << 4)
2257 #define WAKE_MAGIC (1 << 5)
2258 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
2259 #define WAKE_FILTER (1 << 7)
2260
2261 #define WOL_MODE_COUNT 8
2262
2263 /* RSS hash function data
2264 * XOR the corresponding source and destination fields of each specified
2265 * protocol. Both copies of the XOR'ed fields are fed into the RSS and RXHASH
2266 * calculation. Note that this XORing reduces the input set entropy and could
2267 * be exploited to reduce the RSS queue spread.
2268 */
2269 #define RXH_XFRM_SYM_XOR (1 << 0)
2270 #define RXH_XFRM_NO_CHANGE 0xff
2271
2272 /* L2-L4 network traffic flow types */
2273 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
2274 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
2275 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
2276 #define AH_ESP_V4_FLOW 0x04 /* hash only */
2277 #define TCP_V6_FLOW 0x05 /* hash or spec (tcp_ip6_spec; nfc only) */
2278 #define UDP_V6_FLOW 0x06 /* hash or spec (udp_ip6_spec; nfc only) */
2279 #define SCTP_V6_FLOW 0x07 /* hash or spec (sctp_ip6_spec; nfc only) */
2280 #define AH_ESP_V6_FLOW 0x08 /* hash only */
2281 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
2282 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
2283 #define AH_V6_FLOW 0x0b /* hash or spec (ah_ip6_spec; nfc only) */
2284 #define ESP_V6_FLOW 0x0c /* hash or spec (esp_ip6_spec; nfc only) */
2285 #define IPV4_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
2286 #define IP_USER_FLOW IPV4_USER_FLOW
2287 #define IPV6_USER_FLOW 0x0e /* spec only (usr_ip6_spec; nfc only) */
2288 #define IPV4_FLOW 0x10 /* hash only */
2289 #define IPV6_FLOW 0x11 /* hash only */
2290 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */
2291
2292 /* Used for GTP-U IPv4 and IPv6.
2293 * The format of GTP packets only includes
2294 * elements such as TEID and GTP version.
2295 * It is primarily intended for data communication of the UE.
2296 */
2297 #define GTPU_V4_FLOW 0x13 /* hash only */
2298 #define GTPU_V6_FLOW 0x14 /* hash only */
2299
2300 /* Use for GTP-C IPv4 and v6.
2301 * The format of these GTP packets does not include TEID.
2302 * Primarily expected to be used for communication
2303 * to create sessions for UE data communication,
2304 * commonly referred to as CSR (Create Session Request).
2305 */
2306 #define GTPC_V4_FLOW 0x15 /* hash only */
2307 #define GTPC_V6_FLOW 0x16 /* hash only */
2308
2309 /* Use for GTP-C IPv4 and v6.
2310 * Unlike GTPC_V4_FLOW, the format of these GTP packets includes TEID.
2311 * After session creation, it becomes this packet.
2312 * This is mainly used for requests to realize UE handover.
2313 */
2314 #define GTPC_TEID_V4_FLOW 0x17 /* hash only */
2315 #define GTPC_TEID_V6_FLOW 0x18 /* hash only */
2316
2317 /* Use for GTP-U and extended headers for the PSC (PDU Session Container).
2318 * The format of these GTP packets includes TEID and QFI.
2319 * In 5G communication using UPF (User Plane Function),
2320 * data communication with this extended header is performed.
2321 */
2322 #define GTPU_EH_V4_FLOW 0x19 /* hash only */
2323 #define GTPU_EH_V6_FLOW 0x1a /* hash only */
2324
2325 /* Use for GTP-U IPv4 and v6 PSC (PDU Session Container) extended headers.
2326 * This differs from GTPU_EH_V(4|6)_FLOW in that it is distinguished by
2327 * UL/DL included in the PSC.
2328 * There are differences in the data included based on Downlink/Uplink,
2329 * and can be used to distinguish packets.
2330 * The functions described so far are useful when you want to
2331 * handle communication from the mobile network in UPF, PGW, etc.
2332 */
2333 #define GTPU_UL_V4_FLOW 0x1b /* hash only */
2334 #define GTPU_UL_V6_FLOW 0x1c /* hash only */
2335 #define GTPU_DL_V4_FLOW 0x1d /* hash only */
2336 #define GTPU_DL_V6_FLOW 0x1e /* hash only */
2337
2338 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
2339 #define FLOW_EXT 0x80000000
2340 #define FLOW_MAC_EXT 0x40000000
2341 /* Flag to enable RSS spreading of traffic matching rule (nfc only) */
2342 #define FLOW_RSS 0x20000000
2343
2344 /* L3-L4 network traffic flow hash options */
2345 #define RXH_L2DA (1 << 1)
2346 #define RXH_VLAN (1 << 2)
2347 #define RXH_L3_PROTO (1 << 3)
2348 #define RXH_IP_SRC (1 << 4)
2349 #define RXH_IP_DST (1 << 5)
2350 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
2351 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
2352 #define RXH_GTP_TEID (1 << 8) /* teid in case of GTP */
2353 #define RXH_DISCARD (1 << 31)
2354
2355 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
2356 #define RX_CLS_FLOW_WAKE 0xfffffffffffffffeULL
2357
2358 /* Special RX classification rule insert location values */
2359 #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
2360 #define RX_CLS_LOC_ANY 0xffffffff
2361 #define RX_CLS_LOC_FIRST 0xfffffffe
2362 #define RX_CLS_LOC_LAST 0xfffffffd
2363
2364 /* EEPROM Standards for plug in modules */
2365 #define ETH_MODULE_SFF_8079 0x1
2366 #define ETH_MODULE_SFF_8079_LEN 256
2367 #define ETH_MODULE_SFF_8472 0x2
2368 #define ETH_MODULE_SFF_8472_LEN 512
2369 #define ETH_MODULE_SFF_8636 0x3
2370 #define ETH_MODULE_SFF_8636_LEN 256
2371 #define ETH_MODULE_SFF_8436 0x4
2372 #define ETH_MODULE_SFF_8436_LEN 256
2373
2374 #define ETH_MODULE_SFF_8636_MAX_LEN 640
2375 #define ETH_MODULE_SFF_8436_MAX_LEN 640
2376
2377 /* Reset flags */
2378 /* The reset() operation must clear the flags for the components which
2379 * were actually reset. On successful return, the flags indicate the
2380 * components which were not reset, either because they do not exist
2381 * in the hardware or because they cannot be reset independently. The
2382 * driver must never reset any components that were not requested.
2383 */
2384 enum ethtool_reset_flags {
2385 /* These flags represent components dedicated to the interface
2386 * the command is addressed to. Shift any flag left by
2387 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
2388 * same type.
2389 */
2390 ETH_RESET_MGMT = 1 << 0, /* Management processor */
2391 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
2392 ETH_RESET_DMA = 1 << 2, /* DMA engine */
2393 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
2394 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
2395 ETH_RESET_MAC = 1 << 5, /* Media access controller */
2396 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
2397 ETH_RESET_RAM = 1 << 7, /* RAM shared between
2398 * multiple components */
2399 ETH_RESET_AP = 1 << 8, /* Application processor */
2400
2401 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
2402 * this interface */
2403 ETH_RESET_ALL = 0xffffffff, /* All components used by this
2404 * interface, even if shared */
2405 };
2406 #define ETH_RESET_SHARED_SHIFT 16
2407
2408
2409 /**
2410 * struct ethtool_link_settings - link control and status
2411 *
2412 * IMPORTANT, Backward compatibility notice: When implementing new
2413 * user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and
2414 * if it succeeds use %ETHTOOL_SLINKSETTINGS to change link
2415 * settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS
2416 * succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in
2417 * that case. Conversely, if %ETHTOOL_GLINKSETTINGS fails, use
2418 * %ETHTOOL_GSET to query and %ETHTOOL_SSET to change link
2419 * settings; do not use %ETHTOOL_SLINKSETTINGS if
2420 * %ETHTOOL_GLINKSETTINGS failed: stick to
2421 * %ETHTOOL_GSET/%ETHTOOL_SSET in that case.
2422 *
2423 * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS
2424 * @speed: Link speed (Mbps)
2425 * @duplex: Duplex mode; one of %DUPLEX_*
2426 * @port: Physical connector type; one of %PORT_*
2427 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
2428 * applicable. For clause 45 PHYs this is the PRTAD.
2429 * @autoneg: Enable/disable autonegotiation and auto-detection;
2430 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE
2431 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
2432 * protocols supported by the interface; 0 if unknown.
2433 * Read-only.
2434 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
2435 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the
2436 * value will be %ETH_TP_MDI_INVALID. Read-only.
2437 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
2438 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads
2439 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
2440 * When written successfully, the link should be renegotiated if
2441 * necessary.
2442 * @link_mode_masks_nwords: Number of 32-bit words for each of the
2443 * supported, advertising, lp_advertising link mode bitmaps. For
2444 * %ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user
2445 * (>= 0); on return, if handshake in progress, negative if
2446 * request size unsupported by kernel: absolute value indicates
2447 * kernel expected size and all the other fields but cmd
2448 * are 0; otherwise (handshake completed), strictly positive
2449 * to indicate size used by kernel and cmd field stays
2450 * %ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For
2451 * %ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive
2452 * value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise
2453 * refused. For drivers: ignore this field (use kernel's
2454 * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
2455 * be overwritten by kernel.
2456 * @transceiver: Used to distinguish different possible PHY types,
2457 * reported consistently by PHYLIB. Read-only.
2458 * @master_slave_cfg: Master/slave port mode.
2459 * @master_slave_state: Master/slave port state.
2460 * @rate_matching: Rate adaptation performed by the PHY
2461 * @reserved: Reserved for future use; see the note on reserved space.
2462 * @link_mode_masks: Variable length bitmaps.
2463 *
2464 * If autonegotiation is disabled, the speed and @duplex represent the
2465 * fixed link mode and are writable if the driver supports multiple
2466 * link modes. If it is enabled then they are read-only; if the link
2467 * is up they represent the negotiated link mode; if the link is down,
2468 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
2469 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
2470 *
2471 * Some hardware interfaces may have multiple PHYs and/or physical
2472 * connectors fitted or do not allow the driver to detect which are
2473 * fitted. For these interfaces @port and/or @phy_address may be
2474 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
2475 * Otherwise, attempts to write different values may be ignored or
2476 * rejected.
2477 *
2478 * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt
2479 * are not available in %ethtool_link_settings. These fields will be
2480 * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will
2481 * fail if any of them is set to non-zero value.
2482 *
2483 * Users should assume that all fields not marked read-only are
2484 * writable and subject to validation by the driver. They should use
2485 * %ETHTOOL_GLINKSETTINGS to get the current values before making specific
2486 * changes and then applying them with %ETHTOOL_SLINKSETTINGS.
2487 *
2488 * Drivers that implement %get_link_ksettings and/or
2489 * %set_link_ksettings should ignore the @cmd
2490 * and @link_mode_masks_nwords fields (any change to them overwritten
2491 * by kernel), and rely only on kernel's internal
2492 * %__ETHTOOL_LINK_MODE_MASK_NBITS and
2493 * %ethtool_link_mode_mask_t. Drivers that implement
2494 * %set_link_ksettings() should validate all fields other than @cmd
2495 * and @link_mode_masks_nwords that are not described as read-only or
2496 * deprecated, and must ignore all fields described as read-only.
2497 *
2498 * @link_mode_masks is divided into three bitfields, each of length
2499 * @link_mode_masks_nwords:
2500 * - supported: Bitmap with each bit meaning given by
2501 * %ethtool_link_mode_bit_indices for the link modes, physical
2502 * connectors and other link features for which the interface
2503 * supports autonegotiation or auto-detection. Read-only.
2504 * - advertising: Bitmap with each bit meaning given by
2505 * %ethtool_link_mode_bit_indices for the link modes, physical
2506 * connectors and other link features that are advertised through
2507 * autonegotiation or enabled for auto-detection.
2508 * - lp_advertising: Bitmap with each bit meaning given by
2509 * %ethtool_link_mode_bit_indices for the link modes, and other
2510 * link features that the link partner advertised through
2511 * autonegotiation; 0 if unknown or not applicable. Read-only.
2512 */
2513 struct ethtool_link_settings {
2514 __u32 cmd;
2515 __u32 speed;
2516 __u8 duplex;
2517 __u8 port;
2518 __u8 phy_address;
2519 __u8 autoneg;
2520 __u8 mdio_support;
2521 __u8 eth_tp_mdix;
2522 __u8 eth_tp_mdix_ctrl;
2523 __s8 link_mode_masks_nwords;
2524 __u8 transceiver;
2525 __u8 master_slave_cfg;
2526 __u8 master_slave_state;
2527 __u8 rate_matching;
2528 __u32 reserved[7];
2529 __u32 link_mode_masks[];
2530 /* layout of link_mode_masks fields:
2531 * __u32 map_supported[link_mode_masks_nwords];
2532 * __u32 map_advertising[link_mode_masks_nwords];
2533 * __u32 map_lp_advertising[link_mode_masks_nwords];
2534 */
2535 };
2536 #endif /* _UAPI_LINUX_ETHTOOL_H */
2537
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.