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