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