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