2 * ethtool.h: Defines for Linux ethtool.
4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
8 * christopher.leech@intel.com,
9 * scott.feldman@intel.com)
10 * Portions Copyright (C) Sun Microsystems 2008
13 #ifndef _LINUX_ETHTOOL_H
14 #define _LINUX_ETHTOOL_H
16 #include <linux/types.h>
18 /* This should work for both 32 and 64 bit userland. */
21 __u32 supported
; /* Features this interface supports */
22 __u32 advertising
; /* Features this interface advertises */
23 __u16 speed
; /* The forced speed, 10Mb, 100Mb, gigabit */
24 __u8 duplex
; /* Duplex, half or full */
25 __u8 port
; /* Which connector port */
27 __u8 transceiver
; /* Which transceiver to use */
28 __u8 autoneg
; /* Enable or disable autonegotiation */
30 __u32 maxtxpkt
; /* Tx pkts before generating tx int */
31 __u32 maxrxpkt
; /* Rx pkts before generating rx int */
35 __u32 lp_advertising
; /* Features the link partner advertises */
39 static inline void ethtool_cmd_speed_set(struct ethtool_cmd
*ep
,
43 ep
->speed
= (__u16
)speed
;
44 ep
->speed_hi
= (__u16
)(speed
>> 16);
47 static inline __u32
ethtool_cmd_speed(struct ethtool_cmd
*ep
)
49 return (ep
->speed_hi
<< 16) | ep
->speed
;
52 #define ETHTOOL_BUSINFO_LEN 32
53 /* these strings are set to whatever the driver author decides... */
54 struct ethtool_drvinfo
{
56 char driver
[32]; /* driver short name, "tulip", "eepro100" */
57 char version
[32]; /* driver version string */
58 char fw_version
[32]; /* firmware version string, if applicable */
59 char bus_info
[ETHTOOL_BUSINFO_LEN
]; /* Bus info for this IF. */
60 /* For PCI devices, use pci_name(pci_dev). */
63 __u32 n_priv_flags
; /* number of flags valid in ETHTOOL_GPFLAGS */
64 __u32 n_stats
; /* number of u64's from ETHTOOL_GSTATS */
66 __u32 eedump_len
; /* Size of data from ETHTOOL_GEEPROM (bytes) */
67 __u32 regdump_len
; /* Size of data from ETHTOOL_GREGS (bytes) */
71 /* wake-on-lan settings */
72 struct ethtool_wolinfo
{
76 __u8 sopass
[SOPASS_MAX
]; /* SecureOn(tm) password */
79 /* for passing single values */
80 struct ethtool_value
{
85 /* for passing big chunks of data */
88 __u32 version
; /* driver-specific, indicates different chips/revs */
89 __u32 len
; /* bytes */
93 /* for passing EEPROM chunks */
94 struct ethtool_eeprom
{
97 __u32 offset
; /* in bytes */
98 __u32 len
; /* in bytes */
102 /* for configuring coalescing parameters of chip */
103 struct ethtool_coalesce
{
104 __u32 cmd
; /* ETHTOOL_{G,S}COALESCE */
106 /* How many usecs to delay an RX interrupt after
107 * a packet arrives. If 0, only rx_max_coalesced_frames
110 __u32 rx_coalesce_usecs
;
112 /* How many packets to delay an RX interrupt after
113 * a packet arrives. If 0, only rx_coalesce_usecs is
114 * used. It is illegal to set both usecs and max frames
115 * to zero as this would cause RX interrupts to never be
118 __u32 rx_max_coalesced_frames
;
120 /* Same as above two parameters, except that these values
121 * apply while an IRQ is being serviced by the host. Not
122 * all cards support this feature and the values are ignored
125 __u32 rx_coalesce_usecs_irq
;
126 __u32 rx_max_coalesced_frames_irq
;
128 /* How many usecs to delay a TX interrupt after
129 * a packet is sent. If 0, only tx_max_coalesced_frames
132 __u32 tx_coalesce_usecs
;
134 /* How many packets to delay a TX interrupt after
135 * a packet is sent. If 0, only tx_coalesce_usecs is
136 * used. It is illegal to set both usecs and max frames
137 * to zero as this would cause TX interrupts to never be
140 __u32 tx_max_coalesced_frames
;
142 /* Same as above two parameters, except that these values
143 * apply while an IRQ is being serviced by the host. Not
144 * all cards support this feature and the values are ignored
147 __u32 tx_coalesce_usecs_irq
;
148 __u32 tx_max_coalesced_frames_irq
;
150 /* How many usecs to delay in-memory statistics
151 * block updates. Some drivers do not have an in-memory
152 * statistic block, and in such cases this value is ignored.
153 * This value must not be zero.
155 __u32 stats_block_coalesce_usecs
;
157 /* Adaptive RX/TX coalescing is an algorithm implemented by
158 * some drivers to improve latency under low packet rates and
159 * improve throughput under high packet rates. Some drivers
160 * only implement one of RX or TX adaptive coalescing. Anything
161 * not implemented by the driver causes these values to be
164 __u32 use_adaptive_rx_coalesce
;
165 __u32 use_adaptive_tx_coalesce
;
167 /* When the packet rate (measured in packets per second)
168 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
172 __u32 rx_coalesce_usecs_low
;
173 __u32 rx_max_coalesced_frames_low
;
174 __u32 tx_coalesce_usecs_low
;
175 __u32 tx_max_coalesced_frames_low
;
177 /* When the packet rate is below pkt_rate_high but above
178 * pkt_rate_low (both measured in packets per second) the
179 * normal {rx,tx}_* coalescing parameters are used.
182 /* When the packet rate is (measured in packets per second)
183 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
187 __u32 rx_coalesce_usecs_high
;
188 __u32 rx_max_coalesced_frames_high
;
189 __u32 tx_coalesce_usecs_high
;
190 __u32 tx_max_coalesced_frames_high
;
192 /* How often to do adaptive coalescing packet rate sampling,
193 * measured in seconds. Must not be zero.
195 __u32 rate_sample_interval
;
198 /* for configuring RX/TX ring parameters */
199 struct ethtool_ringparam
{
200 __u32 cmd
; /* ETHTOOL_{G,S}RINGPARAM */
202 /* Read only attributes. These indicate the maximum number
203 * of pending RX/TX ring entries the driver will allow the
206 __u32 rx_max_pending
;
207 __u32 rx_mini_max_pending
;
208 __u32 rx_jumbo_max_pending
;
209 __u32 tx_max_pending
;
211 /* Values changeable by the user. The valid values are
212 * in the range 1 to the "*_max_pending" counterpart above.
215 __u32 rx_mini_pending
;
216 __u32 rx_jumbo_pending
;
220 /* for configuring link flow control parameters */
221 struct ethtool_pauseparam
{
222 __u32 cmd
; /* ETHTOOL_{G,S}PAUSEPARAM */
224 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
225 * being true) the user may set 'autonet' here non-zero to have the
226 * pause parameters be auto-negotiated too. In such a case, the
227 * {rx,tx}_pause values below determine what capabilities are
230 * If 'autoneg' is zero or the link is not being auto-negotiated,
231 * then {rx,tx}_pause force the driver to use/not-use pause
239 #define ETH_GSTRING_LEN 32
240 enum ethtool_stringset
{
246 /* for passing string sets for data tagging */
247 struct ethtool_gstrings
{
248 __u32 cmd
; /* ETHTOOL_GSTRINGS */
249 __u32 string_set
; /* string set id e.c. ETH_SS_TEST, etc*/
250 __u32 len
; /* number of strings in the string set */
254 enum ethtool_test_flags
{
255 ETH_TEST_FL_OFFLINE
= (1 << 0), /* online / offline */
256 ETH_TEST_FL_FAILED
= (1 << 1), /* test passed / failed */
259 /* for requesting NIC test and getting results*/
260 struct ethtool_test
{
261 __u32 cmd
; /* ETHTOOL_TEST */
262 __u32 flags
; /* ETH_TEST_FL_xxx */
264 __u32 len
; /* result length, in number of u64 elements */
268 /* for dumping NIC-specific statistics */
269 struct ethtool_stats
{
270 __u32 cmd
; /* ETHTOOL_GSTATS */
271 __u32 n_stats
; /* number of u64's being returned */
275 struct ethtool_perm_addr
{
276 __u32 cmd
; /* ETHTOOL_GPERMADDR */
281 /* boolean flags controlling per-interface behavior characteristics.
282 * When reading, the flag indicates whether or not a certain behavior
283 * is enabled/present. When writing, the flag indicates whether
284 * or not the driver should turn on (set) or off (clear) a behavior.
286 * Some behaviors may read-only (unconditionally absent or present).
287 * If such is the case, return EINVAL in the set-flags operation if the
288 * flag differs from the read-only value.
291 ETH_FLAG_LRO
= (1 << 15), /* LRO is enabled */
294 /* The following structures are for supporting RX network flow
295 * classification configuration. Note, all multibyte fields, e.g.,
296 * ip4src, ip4dst, psrc, pdst, spi, etc. are expected to be in network
299 struct ethtool_tcpip4_spec
{
307 struct ethtool_ah_espip4_spec
{
314 struct ethtool_rawip4_spec
{
320 struct ethtool_ether_spec
{
326 #define ETH_RX_NFC_IP4 1
327 #define ETH_RX_NFC_IP6 2
329 struct ethtool_usrip4_spec
{
338 struct ethtool_rx_flow_spec
{
341 struct ethtool_tcpip4_spec tcp_ip4_spec
;
342 struct ethtool_tcpip4_spec udp_ip4_spec
;
343 struct ethtool_tcpip4_spec sctp_ip4_spec
;
344 struct ethtool_ah_espip4_spec ah_ip4_spec
;
345 struct ethtool_ah_espip4_spec esp_ip4_spec
;
346 struct ethtool_rawip4_spec raw_ip4_spec
;
347 struct ethtool_ether_spec ether_spec
;
348 struct ethtool_usrip4_spec usr_ip4_spec
;
350 } h_u
, m_u
; /* entry, mask */
355 struct ethtool_rxnfc
{
358 /* The rx flow hash value or the rule DB size */
360 struct ethtool_rx_flow_spec fs
;
365 #define ETHTOOL_FLASH_MAX_FILENAME 128
366 enum ethtool_flash_op_type
{
367 ETHTOOL_FLASH_ALL_REGIONS
= 0,
370 /* for passing firmware flashing related parameters */
371 struct ethtool_flash
{
374 char data
[ETHTOOL_FLASH_MAX_FILENAME
];
378 /* CMDs currently supported */
379 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
380 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
381 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
382 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
383 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
384 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
385 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
386 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
387 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
388 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
389 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
390 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
391 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
392 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
393 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
394 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
395 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
396 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
397 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
398 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
399 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
400 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
401 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
403 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
404 * (ethtool_value). */
405 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
406 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
407 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
408 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
409 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
410 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
411 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
412 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
413 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
414 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
415 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
416 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
417 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
418 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
419 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
421 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
422 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
423 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
424 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
425 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
426 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
427 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
428 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
429 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
430 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
431 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
432 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
434 /* compatibility with older code */
435 #define SPARC_ETH_GSET ETHTOOL_GSET
436 #define SPARC_ETH_SSET ETHTOOL_SSET
438 /* Indicates what features are supported by the interface. */
439 #define SUPPORTED_10baseT_Half (1 << 0)
440 #define SUPPORTED_10baseT_Full (1 << 1)
441 #define SUPPORTED_100baseT_Half (1 << 2)
442 #define SUPPORTED_100baseT_Full (1 << 3)
443 #define SUPPORTED_1000baseT_Half (1 << 4)
444 #define SUPPORTED_1000baseT_Full (1 << 5)
445 #define SUPPORTED_Autoneg (1 << 6)
446 #define SUPPORTED_TP (1 << 7)
447 #define SUPPORTED_AUI (1 << 8)
448 #define SUPPORTED_MII (1 << 9)
449 #define SUPPORTED_FIBRE (1 << 10)
450 #define SUPPORTED_BNC (1 << 11)
451 #define SUPPORTED_10000baseT_Full (1 << 12)
452 #define SUPPORTED_Pause (1 << 13)
453 #define SUPPORTED_Asym_Pause (1 << 14)
454 #define SUPPORTED_2500baseX_Full (1 << 15)
455 #define SUPPORTED_Backplane (1 << 16)
456 #define SUPPORTED_1000baseKX_Full (1 << 17)
457 #define SUPPORTED_10000baseKX4_Full (1 << 18)
458 #define SUPPORTED_10000baseKR_Full (1 << 19)
459 #define SUPPORTED_10000baseR_FEC (1 << 20)
461 /* Indicates what features are advertised by the interface. */
462 #define ADVERTISED_10baseT_Half (1 << 0)
463 #define ADVERTISED_10baseT_Full (1 << 1)
464 #define ADVERTISED_100baseT_Half (1 << 2)
465 #define ADVERTISED_100baseT_Full (1 << 3)
466 #define ADVERTISED_1000baseT_Half (1 << 4)
467 #define ADVERTISED_1000baseT_Full (1 << 5)
468 #define ADVERTISED_Autoneg (1 << 6)
469 #define ADVERTISED_TP (1 << 7)
470 #define ADVERTISED_AUI (1 << 8)
471 #define ADVERTISED_MII (1 << 9)
472 #define ADVERTISED_FIBRE (1 << 10)
473 #define ADVERTISED_BNC (1 << 11)
474 #define ADVERTISED_10000baseT_Full (1 << 12)
475 #define ADVERTISED_Pause (1 << 13)
476 #define ADVERTISED_Asym_Pause (1 << 14)
477 #define ADVERTISED_2500baseX_Full (1 << 15)
478 #define ADVERTISED_Backplane (1 << 16)
479 #define ADVERTISED_1000baseKX_Full (1 << 17)
480 #define ADVERTISED_10000baseKX4_Full (1 << 18)
481 #define ADVERTISED_10000baseKR_Full (1 << 19)
482 #define ADVERTISED_10000baseR_FEC (1 << 20)
484 /* The following are all involved in forcing a particular link
485 * mode for the device for setting things. When getting the
486 * devices settings, these indicate the current mode and whether
487 * it was foced up into this mode or autonegotiated.
490 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
492 #define SPEED_100 100
493 #define SPEED_1000 1000
494 #define SPEED_2500 2500
495 #define SPEED_10000 10000
497 /* Duplex, half or full. */
498 #define DUPLEX_HALF 0x00
499 #define DUPLEX_FULL 0x01
501 /* Which connector port. */
503 #define PORT_AUI 0x01
504 #define PORT_MII 0x02
505 #define PORT_FIBRE 0x03
506 #define PORT_BNC 0x04
508 #define PORT_NONE 0xef
509 #define PORT_OTHER 0xff
511 /* Which transceiver to use. */
512 #define XCVR_INTERNAL 0x00
513 #define XCVR_EXTERNAL 0x01
514 #define XCVR_DUMMY1 0x02
515 #define XCVR_DUMMY2 0x03
516 #define XCVR_DUMMY3 0x04
518 /* Enable or disable autonegotiation. If this is set to enable,
519 * the forced link modes above are completely ignored.
521 #define AUTONEG_DISABLE 0x00
522 #define AUTONEG_ENABLE 0x01
524 /* Mode MDI or MDI-X */
525 #define ETH_TP_MDI_INVALID 0x00
526 #define ETH_TP_MDI 0x01
527 #define ETH_TP_MDI_X 0x02
529 /* Wake-On-Lan options. */
530 #define WAKE_PHY (1 << 0)
531 #define WAKE_UCAST (1 << 1)
532 #define WAKE_MCAST (1 << 2)
533 #define WAKE_BCAST (1 << 3)
534 #define WAKE_ARP (1 << 4)
535 #define WAKE_MAGIC (1 << 5)
536 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
538 /* L3-L4 network traffic flow types */
539 #define TCP_V4_FLOW 0x01
540 #define UDP_V4_FLOW 0x02
541 #define SCTP_V4_FLOW 0x03
542 #define AH_ESP_V4_FLOW 0x04
543 #define TCP_V6_FLOW 0x05
544 #define UDP_V6_FLOW 0x06
545 #define SCTP_V6_FLOW 0x07
546 #define AH_ESP_V6_FLOW 0x08
547 #define AH_V4_FLOW 0x09
548 #define ESP_V4_FLOW 0x0a
549 #define AH_V6_FLOW 0x0b
550 #define ESP_V6_FLOW 0x0c
551 #define IP_USER_FLOW 0x0d
552 #define IPV4_FLOW 0x10
553 #define IPV6_FLOW 0x11
555 /* L3-L4 network traffic flow hash options */
556 #define RXH_L2DA (1 << 1)
557 #define RXH_VLAN (1 << 2)
558 #define RXH_L3_PROTO (1 << 3)
559 #define RXH_IP_SRC (1 << 4)
560 #define RXH_IP_DST (1 << 5)
561 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
562 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
563 #define RXH_DISCARD (1 << 31)
565 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
568 /* The reset() operation must clear the flags for the components which
569 * were actually reset. On successful return, the flags indicate the
570 * components which were not reset, either because they do not exist
571 * in the hardware or because they cannot be reset independently. The
572 * driver must never reset any components that were not requested.
574 enum ethtool_reset_flags
{
575 /* These flags represent components dedicated to the interface
576 * the command is addressed to. Shift any flag left by
577 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
580 ETH_RESET_MGMT
= 1 << 0, /* Management processor */
581 ETH_RESET_IRQ
= 1 << 1, /* Interrupt requester */
582 ETH_RESET_DMA
= 1 << 2, /* DMA engine */
583 ETH_RESET_FILTER
= 1 << 3, /* Filtering/flow direction */
584 ETH_RESET_OFFLOAD
= 1 << 4, /* Protocol offload */
585 ETH_RESET_MAC
= 1 << 5, /* Media access controller */
586 ETH_RESET_PHY
= 1 << 6, /* Transceiver/PHY */
587 ETH_RESET_RAM
= 1 << 7, /* RAM shared between
588 * multiple components */
590 ETH_RESET_DEDICATED
= 0x0000ffff, /* All components dedicated to
592 ETH_RESET_ALL
= 0xffffffff, /* All components used by this
593 * interface, even if shared */
595 #define ETH_RESET_SHARED_SHIFT 16
597 #endif /* _LINUX_ETHTOOL_H */