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