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