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