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)
12 #ifndef _LINUX_ETHTOOL_H
13 #define _LINUX_ETHTOOL_H
15 #include <linux/types.h>
17 /* This should work for both 32 and 64 bit userland. */
20 __u32 supported
; /* Features this interface supports */
21 __u32 advertising
; /* Features this interface advertises */
22 __u16 speed
; /* The forced speed, 10Mb, 100Mb, gigabit */
23 __u8 duplex
; /* Duplex, half or full */
24 __u8 port
; /* Which connector port */
26 __u8 transceiver
; /* Which transceiver to use */
27 __u8 autoneg
; /* Enable or disable autonegotiation */
28 __u32 maxtxpkt
; /* Tx pkts before generating tx int */
29 __u32 maxrxpkt
; /* Rx pkts before generating rx int */
33 #define ETHTOOL_BUSINFO_LEN 32
34 /* these strings are set to whatever the driver author decides... */
35 struct ethtool_drvinfo
{
37 char driver
[32]; /* driver short name, "tulip", "eepro100" */
38 char version
[32]; /* driver version string */
39 char fw_version
[32]; /* firmware version string, if applicable */
40 char bus_info
[ETHTOOL_BUSINFO_LEN
]; /* Bus info for this IF. */
41 /* For PCI devices, use pci_name(pci_dev). */
44 __u32 n_priv_flags
; /* number of flags valid in ETHTOOL_GPFLAGS */
45 __u32 n_stats
; /* number of u64's from ETHTOOL_GSTATS */
47 __u32 eedump_len
; /* Size of data from ETHTOOL_GEEPROM (bytes) */
48 __u32 regdump_len
; /* Size of data from ETHTOOL_GREGS (bytes) */
52 /* wake-on-lan settings */
53 struct ethtool_wolinfo
{
57 __u8 sopass
[SOPASS_MAX
]; /* SecureOn(tm) password */
60 /* for passing single values */
61 struct ethtool_value
{
66 /* for passing big chunks of data */
69 __u32 version
; /* driver-specific, indicates different chips/revs */
70 __u32 len
; /* bytes */
74 /* for passing EEPROM chunks */
75 struct ethtool_eeprom
{
78 __u32 offset
; /* in bytes */
79 __u32 len
; /* in bytes */
83 /* for configuring coalescing parameters of chip */
84 struct ethtool_coalesce
{
85 __u32 cmd
; /* ETHTOOL_{G,S}COALESCE */
87 /* How many usecs to delay an RX interrupt after
88 * a packet arrives. If 0, only rx_max_coalesced_frames
91 __u32 rx_coalesce_usecs
;
93 /* How many packets to delay an RX interrupt after
94 * a packet arrives. If 0, only rx_coalesce_usecs is
95 * used. It is illegal to set both usecs and max frames
96 * to zero as this would cause RX interrupts to never be
99 __u32 rx_max_coalesced_frames
;
101 /* Same as above two parameters, except that these values
102 * apply while an IRQ is being serviced by the host. Not
103 * all cards support this feature and the values are ignored
106 __u32 rx_coalesce_usecs_irq
;
107 __u32 rx_max_coalesced_frames_irq
;
109 /* How many usecs to delay a TX interrupt after
110 * a packet is sent. If 0, only tx_max_coalesced_frames
113 __u32 tx_coalesce_usecs
;
115 /* How many packets to delay a TX interrupt after
116 * a packet is sent. If 0, only tx_coalesce_usecs is
117 * used. It is illegal to set both usecs and max frames
118 * to zero as this would cause TX interrupts to never be
121 __u32 tx_max_coalesced_frames
;
123 /* Same as above two parameters, except that these values
124 * apply while an IRQ is being serviced by the host. Not
125 * all cards support this feature and the values are ignored
128 __u32 tx_coalesce_usecs_irq
;
129 __u32 tx_max_coalesced_frames_irq
;
131 /* How many usecs to delay in-memory statistics
132 * block updates. Some drivers do not have an in-memory
133 * statistic block, and in such cases this value is ignored.
134 * This value must not be zero.
136 __u32 stats_block_coalesce_usecs
;
138 /* Adaptive RX/TX coalescing is an algorithm implemented by
139 * some drivers to improve latency under low packet rates and
140 * improve throughput under high packet rates. Some drivers
141 * only implement one of RX or TX adaptive coalescing. Anything
142 * not implemented by the driver causes these values to be
145 __u32 use_adaptive_rx_coalesce
;
146 __u32 use_adaptive_tx_coalesce
;
148 /* When the packet rate (measured in packets per second)
149 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
153 __u32 rx_coalesce_usecs_low
;
154 __u32 rx_max_coalesced_frames_low
;
155 __u32 tx_coalesce_usecs_low
;
156 __u32 tx_max_coalesced_frames_low
;
158 /* When the packet rate is below pkt_rate_high but above
159 * pkt_rate_low (both measured in packets per second) the
160 * normal {rx,tx}_* coalescing parameters are used.
163 /* When the packet rate is (measured in packets per second)
164 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
168 __u32 rx_coalesce_usecs_high
;
169 __u32 rx_max_coalesced_frames_high
;
170 __u32 tx_coalesce_usecs_high
;
171 __u32 tx_max_coalesced_frames_high
;
173 /* How often to do adaptive coalescing packet rate sampling,
174 * measured in seconds. Must not be zero.
176 __u32 rate_sample_interval
;
179 /* for configuring RX/TX ring parameters */
180 struct ethtool_ringparam
{
181 __u32 cmd
; /* ETHTOOL_{G,S}RINGPARAM */
183 /* Read only attributes. These indicate the maximum number
184 * of pending RX/TX ring entries the driver will allow the
187 __u32 rx_max_pending
;
188 __u32 rx_mini_max_pending
;
189 __u32 rx_jumbo_max_pending
;
190 __u32 tx_max_pending
;
192 /* Values changeable by the user. The valid values are
193 * in the range 1 to the "*_max_pending" counterpart above.
196 __u32 rx_mini_pending
;
197 __u32 rx_jumbo_pending
;
201 /* for configuring link flow control parameters */
202 struct ethtool_pauseparam
{
203 __u32 cmd
; /* ETHTOOL_{G,S}PAUSEPARAM */
205 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
206 * being true) the user may set 'autonet' here non-zero to have the
207 * pause parameters be auto-negotiated too. In such a case, the
208 * {rx,tx}_pause values below determine what capabilities are
211 * If 'autoneg' is zero or the link is not being auto-negotiated,
212 * then {rx,tx}_pause force the driver to use/not-use pause
220 #define ETH_GSTRING_LEN 32
221 enum ethtool_stringset
{
227 /* for passing string sets for data tagging */
228 struct ethtool_gstrings
{
229 __u32 cmd
; /* ETHTOOL_GSTRINGS */
230 __u32 string_set
; /* string set id e.c. ETH_SS_TEST, etc*/
231 __u32 len
; /* number of strings in the string set */
235 enum ethtool_test_flags
{
236 ETH_TEST_FL_OFFLINE
= (1 << 0), /* online / offline */
237 ETH_TEST_FL_FAILED
= (1 << 1), /* test passed / failed */
240 /* for requesting NIC test and getting results*/
241 struct ethtool_test
{
242 __u32 cmd
; /* ETHTOOL_TEST */
243 __u32 flags
; /* ETH_TEST_FL_xxx */
245 __u32 len
; /* result length, in number of u64 elements */
249 /* for dumping NIC-specific statistics */
250 struct ethtool_stats
{
251 __u32 cmd
; /* ETHTOOL_GSTATS */
252 __u32 n_stats
; /* number of u64's being returned */
256 struct ethtool_perm_addr
{
257 __u32 cmd
; /* ETHTOOL_GPERMADDR */
262 /* boolean flags controlling per-interface behavior characteristics.
263 * When reading, the flag indicates whether or not a certain behavior
264 * is enabled/present. When writing, the flag indicates whether
265 * or not the driver should turn on (set) or off (clear) a behavior.
267 * Some behaviors may read-only (unconditionally absent or present).
268 * If such is the case, return EINVAL in the set-flags operation if the
269 * flag differs from the read-only value.
272 ETH_FLAG_LRO
= (1 << 15), /* LRO is enabled */
275 struct ethtool_rxnfc
{
285 /* Some generic methods drivers may use in their ethtool_ops */
286 u32
ethtool_op_get_link(struct net_device
*dev
);
287 u32
ethtool_op_get_tx_csum(struct net_device
*dev
);
288 int ethtool_op_set_tx_csum(struct net_device
*dev
, u32 data
);
289 int ethtool_op_set_tx_hw_csum(struct net_device
*dev
, u32 data
);
290 int ethtool_op_set_tx_ipv6_csum(struct net_device
*dev
, u32 data
);
291 u32
ethtool_op_get_sg(struct net_device
*dev
);
292 int ethtool_op_set_sg(struct net_device
*dev
, u32 data
);
293 u32
ethtool_op_get_tso(struct net_device
*dev
);
294 int ethtool_op_set_tso(struct net_device
*dev
, u32 data
);
295 u32
ethtool_op_get_ufo(struct net_device
*dev
);
296 int ethtool_op_set_ufo(struct net_device
*dev
, u32 data
);
297 u32
ethtool_op_get_flags(struct net_device
*dev
);
298 int ethtool_op_set_flags(struct net_device
*dev
, u32 data
);
301 * ðtool_ops - Alter and report network device settings
302 * get_settings: Get device-specific settings
303 * set_settings: Set device-specific settings
304 * get_drvinfo: Report driver information
305 * get_regs: Get device registers
306 * get_wol: Report whether Wake-on-Lan is enabled
307 * set_wol: Turn Wake-on-Lan on or off
308 * get_msglevel: Report driver message level
309 * set_msglevel: Set driver message level
310 * nway_reset: Restart autonegotiation
311 * get_link: Get link status
312 * get_eeprom: Read data from the device EEPROM
313 * set_eeprom: Write data to the device EEPROM
314 * get_coalesce: Get interrupt coalescing parameters
315 * set_coalesce: Set interrupt coalescing parameters
316 * get_ringparam: Report ring sizes
317 * set_ringparam: Set ring sizes
318 * get_pauseparam: Report pause parameters
319 * set_pauseparam: Set pause parameters
320 * get_rx_csum: Report whether receive checksums are turned on or off
321 * set_rx_csum: Turn receive checksum on or off
322 * get_tx_csum: Report whether transmit checksums are turned on or off
323 * set_tx_csum: Turn transmit checksums on or off
324 * get_sg: Report whether scatter-gather is enabled
325 * set_sg: Turn scatter-gather on or off
326 * get_tso: Report whether TCP segmentation offload is enabled
327 * set_tso: Turn TCP segmentation offload on or off
328 * get_ufo: Report whether UDP fragmentation offload is enabled
329 * set_ufo: Turn UDP fragmentation offload on or off
330 * self_test: Run specified self-tests
331 * get_strings: Return a set of strings that describe the requested objects
332 * phys_id: Identify the device
333 * get_stats: Return statistics about the device
334 * get_flags: get 32-bit flags bitmap
335 * set_flags: set 32-bit flags bitmap
340 * @get_settings is passed an ðtool_cmd to fill in. It returns
341 * an negative errno or zero.
344 * @set_settings is passed an ðtool_cmd and should attempt to set
345 * all the settings this device supports. It may return an error value
346 * if something goes wrong (otherwise 0).
349 * Should fill in the magic field. Don't need to check len for zero
350 * or wraparound. Fill in the data argument with the eeprom values
351 * from offset to offset + len. Update len to the amount read.
352 * Returns an error or zero.
355 * Should validate the magic field. Don't need to check len for zero
356 * or wraparound. Update len to the amount written. Returns an error
360 int (*get_settings
)(struct net_device
*, struct ethtool_cmd
*);
361 int (*set_settings
)(struct net_device
*, struct ethtool_cmd
*);
362 void (*get_drvinfo
)(struct net_device
*, struct ethtool_drvinfo
*);
363 int (*get_regs_len
)(struct net_device
*);
364 void (*get_regs
)(struct net_device
*, struct ethtool_regs
*, void *);
365 void (*get_wol
)(struct net_device
*, struct ethtool_wolinfo
*);
366 int (*set_wol
)(struct net_device
*, struct ethtool_wolinfo
*);
367 u32 (*get_msglevel
)(struct net_device
*);
368 void (*set_msglevel
)(struct net_device
*, u32
);
369 int (*nway_reset
)(struct net_device
*);
370 u32 (*get_link
)(struct net_device
*);
371 int (*get_eeprom_len
)(struct net_device
*);
372 int (*get_eeprom
)(struct net_device
*, struct ethtool_eeprom
*, u8
*);
373 int (*set_eeprom
)(struct net_device
*, struct ethtool_eeprom
*, u8
*);
374 int (*get_coalesce
)(struct net_device
*, struct ethtool_coalesce
*);
375 int (*set_coalesce
)(struct net_device
*, struct ethtool_coalesce
*);
376 void (*get_ringparam
)(struct net_device
*, struct ethtool_ringparam
*);
377 int (*set_ringparam
)(struct net_device
*, struct ethtool_ringparam
*);
378 void (*get_pauseparam
)(struct net_device
*, struct ethtool_pauseparam
*);
379 int (*set_pauseparam
)(struct net_device
*, struct ethtool_pauseparam
*);
380 u32 (*get_rx_csum
)(struct net_device
*);
381 int (*set_rx_csum
)(struct net_device
*, u32
);
382 u32 (*get_tx_csum
)(struct net_device
*);
383 int (*set_tx_csum
)(struct net_device
*, u32
);
384 u32 (*get_sg
)(struct net_device
*);
385 int (*set_sg
)(struct net_device
*, u32
);
386 u32 (*get_tso
)(struct net_device
*);
387 int (*set_tso
)(struct net_device
*, u32
);
388 void (*self_test
)(struct net_device
*, struct ethtool_test
*, u64
*);
389 void (*get_strings
)(struct net_device
*, u32 stringset
, u8
*);
390 int (*phys_id
)(struct net_device
*, u32
);
391 void (*get_ethtool_stats
)(struct net_device
*, struct ethtool_stats
*, u64
*);
392 int (*begin
)(struct net_device
*);
393 void (*complete
)(struct net_device
*);
394 u32 (*get_ufo
)(struct net_device
*);
395 int (*set_ufo
)(struct net_device
*, u32
);
396 u32 (*get_flags
)(struct net_device
*);
397 int (*set_flags
)(struct net_device
*, u32
);
398 u32 (*get_priv_flags
)(struct net_device
*);
399 int (*set_priv_flags
)(struct net_device
*, u32
);
400 int (*get_sset_count
)(struct net_device
*, int);
402 /* the following hooks are obsolete */
403 int (*self_test_count
)(struct net_device
*);/* use get_sset_count */
404 int (*get_stats_count
)(struct net_device
*);/* use get_sset_count */
405 int (*get_rxhash
)(struct net_device
*, struct ethtool_rxnfc
*);
406 int (*set_rxhash
)(struct net_device
*, struct ethtool_rxnfc
*);
408 #endif /* __KERNEL__ */
410 /* CMDs currently supported */
411 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
412 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
413 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
414 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
415 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
416 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
417 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
418 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
419 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
420 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
421 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
422 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
423 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
424 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
425 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
426 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
427 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
428 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
429 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
430 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
431 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
432 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
433 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
435 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
436 * (ethtool_value). */
437 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
438 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
439 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
440 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
441 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
442 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
443 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
444 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
445 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
446 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
447 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
448 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
449 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
450 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
451 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
453 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
454 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
456 /* compatibility with older code */
457 #define SPARC_ETH_GSET ETHTOOL_GSET
458 #define SPARC_ETH_SSET ETHTOOL_SSET
460 /* Indicates what features are supported by the interface. */
461 #define SUPPORTED_10baseT_Half (1 << 0)
462 #define SUPPORTED_10baseT_Full (1 << 1)
463 #define SUPPORTED_100baseT_Half (1 << 2)
464 #define SUPPORTED_100baseT_Full (1 << 3)
465 #define SUPPORTED_1000baseT_Half (1 << 4)
466 #define SUPPORTED_1000baseT_Full (1 << 5)
467 #define SUPPORTED_Autoneg (1 << 6)
468 #define SUPPORTED_TP (1 << 7)
469 #define SUPPORTED_AUI (1 << 8)
470 #define SUPPORTED_MII (1 << 9)
471 #define SUPPORTED_FIBRE (1 << 10)
472 #define SUPPORTED_BNC (1 << 11)
473 #define SUPPORTED_10000baseT_Full (1 << 12)
474 #define SUPPORTED_Pause (1 << 13)
475 #define SUPPORTED_Asym_Pause (1 << 14)
476 #define SUPPORTED_2500baseX_Full (1 << 15)
478 /* Indicates what features are advertised by the interface. */
479 #define ADVERTISED_10baseT_Half (1 << 0)
480 #define ADVERTISED_10baseT_Full (1 << 1)
481 #define ADVERTISED_100baseT_Half (1 << 2)
482 #define ADVERTISED_100baseT_Full (1 << 3)
483 #define ADVERTISED_1000baseT_Half (1 << 4)
484 #define ADVERTISED_1000baseT_Full (1 << 5)
485 #define ADVERTISED_Autoneg (1 << 6)
486 #define ADVERTISED_TP (1 << 7)
487 #define ADVERTISED_AUI (1 << 8)
488 #define ADVERTISED_MII (1 << 9)
489 #define ADVERTISED_FIBRE (1 << 10)
490 #define ADVERTISED_BNC (1 << 11)
491 #define ADVERTISED_10000baseT_Full (1 << 12)
492 #define ADVERTISED_Pause (1 << 13)
493 #define ADVERTISED_Asym_Pause (1 << 14)
494 #define ADVERTISED_2500baseX_Full (1 << 15)
496 /* The following are all involved in forcing a particular link
497 * mode for the device for setting things. When getting the
498 * devices settings, these indicate the current mode and whether
499 * it was foced up into this mode or autonegotiated.
502 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
504 #define SPEED_100 100
505 #define SPEED_1000 1000
506 #define SPEED_2500 2500
507 #define SPEED_10000 10000
509 /* Duplex, half or full. */
510 #define DUPLEX_HALF 0x00
511 #define DUPLEX_FULL 0x01
513 /* Which connector port. */
515 #define PORT_AUI 0x01
516 #define PORT_MII 0x02
517 #define PORT_FIBRE 0x03
518 #define PORT_BNC 0x04
520 /* Which transceiver to use. */
521 #define XCVR_INTERNAL 0x00
522 #define XCVR_EXTERNAL 0x01
523 #define XCVR_DUMMY1 0x02
524 #define XCVR_DUMMY2 0x03
525 #define XCVR_DUMMY3 0x04
527 /* Enable or disable autonegotiation. If this is set to enable,
528 * the forced link modes above are completely ignored.
530 #define AUTONEG_DISABLE 0x00
531 #define AUTONEG_ENABLE 0x01
533 /* Wake-On-Lan options. */
534 #define WAKE_PHY (1 << 0)
535 #define WAKE_UCAST (1 << 1)
536 #define WAKE_MCAST (1 << 2)
537 #define WAKE_BCAST (1 << 3)
538 #define WAKE_ARP (1 << 4)
539 #define WAKE_MAGIC (1 << 5)
540 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
542 /* L3-L4 network traffic flow types */
543 #define TCP_V4_FLOW 0x01
544 #define UDP_V4_FLOW 0x02
545 #define SCTP_V4_FLOW 0x03
546 #define AH_ESP_V4_FLOW 0x04
547 #define TCP_V6_FLOW 0x05
548 #define UDP_V6_FLOW 0x06
549 #define SCTP_V6_FLOW 0x07
550 #define AH_ESP_V6_FLOW 0x08
552 /* L3-L4 network traffic flow hash options */
553 #define RXH_DEV_PORT (1 << 0)
554 #define RXH_L2DA (1 << 1)
555 #define RXH_VLAN (1 << 2)
556 #define RXH_L3_PROTO (1 << 3)
557 #define RXH_IP_SRC (1 << 4)
558 #define RXH_IP_DST (1 << 5)
559 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
560 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
561 #define RXH_DISCARD (1 << 31)
564 #endif /* _LINUX_ETHTOOL_H */