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