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