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
16 /* This should work for both 32 and 64 bit userland. */
19 __u32 supported
; /* Features this interface supports */
20 __u32 advertising
; /* Features this interface advertises */
21 __u16 speed
; /* The forced speed, 10Mb, 100Mb, gigabit */
22 __u8 duplex
; /* Duplex, half or full */
23 __u8 port
; /* Which connector port */
25 __u8 transceiver
; /* Which transceiver to use */
26 __u8 autoneg
; /* Enable or disable autonegotiation */
27 __u32 maxtxpkt
; /* Tx pkts before generating tx int */
28 __u32 maxrxpkt
; /* Rx pkts before generating rx int */
32 #define ETHTOOL_BUSINFO_LEN 32
33 /* these strings are set to whatever the driver author decides... */
34 struct ethtool_drvinfo
{
36 char driver
[32]; /* driver short name, "tulip", "eepro100" */
37 char version
[32]; /* driver version string */
38 char fw_version
[32]; /* firmware version string, if applicable */
39 char bus_info
[ETHTOOL_BUSINFO_LEN
]; /* Bus info for this IF. */
40 /* For PCI devices, use pci_name(pci_dev). */
43 __u32 n_stats
; /* number of u64's from ETHTOOL_GSTATS */
45 __u32 eedump_len
; /* Size of data from ETHTOOL_GEEPROM (bytes) */
46 __u32 regdump_len
; /* Size of data from ETHTOOL_GREGS (bytes) */
50 /* wake-on-lan settings */
51 struct ethtool_wolinfo
{
55 __u8 sopass
[SOPASS_MAX
]; /* SecureOn(tm) password */
58 /* for passing single values */
59 struct ethtool_value
{
64 /* for passing big chunks of data */
67 __u32 version
; /* driver-specific, indicates different chips/revs */
68 __u32 len
; /* bytes */
72 /* for passing EEPROM chunks */
73 struct ethtool_eeprom
{
76 __u32 offset
; /* in bytes */
77 __u32 len
; /* in bytes */
81 /* for configuring coalescing parameters of chip */
82 struct ethtool_coalesce
{
83 __u32 cmd
; /* ETHTOOL_{G,S}COALESCE */
85 /* How many usecs to delay an RX interrupt after
86 * a packet arrives. If 0, only rx_max_coalesced_frames
89 __u32 rx_coalesce_usecs
;
91 /* How many packets to delay an RX interrupt after
92 * a packet arrives. If 0, only rx_coalesce_usecs is
93 * used. It is illegal to set both usecs and max frames
94 * to zero as this would cause RX interrupts to never be
97 __u32 rx_max_coalesced_frames
;
99 /* Same as above two parameters, except that these values
100 * apply while an IRQ is being serviced by the host. Not
101 * all cards support this feature and the values are ignored
104 __u32 rx_coalesce_usecs_irq
;
105 __u32 rx_max_coalesced_frames_irq
;
107 /* How many usecs to delay a TX interrupt after
108 * a packet is sent. If 0, only tx_max_coalesced_frames
111 __u32 tx_coalesce_usecs
;
113 /* How many packets to delay a TX interrupt after
114 * a packet is sent. If 0, only tx_coalesce_usecs is
115 * used. It is illegal to set both usecs and max frames
116 * to zero as this would cause TX interrupts to never be
119 __u32 tx_max_coalesced_frames
;
121 /* Same as above two parameters, except that these values
122 * apply while an IRQ is being serviced by the host. Not
123 * all cards support this feature and the values are ignored
126 __u32 tx_coalesce_usecs_irq
;
127 __u32 tx_max_coalesced_frames_irq
;
129 /* How many usecs to delay in-memory statistics
130 * block updates. Some drivers do not have an in-memory
131 * statistic block, and in such cases this value is ignored.
132 * This value must not be zero.
134 __u32 stats_block_coalesce_usecs
;
136 /* Adaptive RX/TX coalescing is an algorithm implemented by
137 * some drivers to improve latency under low packet rates and
138 * improve throughput under high packet rates. Some drivers
139 * only implement one of RX or TX adaptive coalescing. Anything
140 * not implemented by the driver causes these values to be
143 __u32 use_adaptive_rx_coalesce
;
144 __u32 use_adaptive_tx_coalesce
;
146 /* When the packet rate (measured in packets per second)
147 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
151 __u32 rx_coalesce_usecs_low
;
152 __u32 rx_max_coalesced_frames_low
;
153 __u32 tx_coalesce_usecs_low
;
154 __u32 tx_max_coalesced_frames_low
;
156 /* When the packet rate is below pkt_rate_high but above
157 * pkt_rate_low (both measured in packets per second) the
158 * normal {rx,tx}_* coalescing parameters are used.
161 /* When the packet rate is (measured in packets per second)
162 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
166 __u32 rx_coalesce_usecs_high
;
167 __u32 rx_max_coalesced_frames_high
;
168 __u32 tx_coalesce_usecs_high
;
169 __u32 tx_max_coalesced_frames_high
;
171 /* How often to do adaptive coalescing packet rate sampling,
172 * measured in seconds. Must not be zero.
174 __u32 rate_sample_interval
;
177 /* for configuring RX/TX ring parameters */
178 struct ethtool_ringparam
{
179 __u32 cmd
; /* ETHTOOL_{G,S}RINGPARAM */
181 /* Read only attributes. These indicate the maximum number
182 * of pending RX/TX ring entries the driver will allow the
185 __u32 rx_max_pending
;
186 __u32 rx_mini_max_pending
;
187 __u32 rx_jumbo_max_pending
;
188 __u32 tx_max_pending
;
190 /* Values changeable by the user. The valid values are
191 * in the range 1 to the "*_max_pending" counterpart above.
194 __u32 rx_mini_pending
;
195 __u32 rx_jumbo_pending
;
199 /* for configuring link flow control parameters */
200 struct ethtool_pauseparam
{
201 __u32 cmd
; /* ETHTOOL_{G,S}PAUSEPARAM */
203 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
204 * being true) the user may set 'autonet' here non-zero to have the
205 * pause parameters be auto-negotiated too. In such a case, the
206 * {rx,tx}_pause values below determine what capabilities are
209 * If 'autoneg' is zero or the link is not being auto-negotiated,
210 * then {rx,tx}_pause force the driver to use/not-use pause
218 #define ETH_GSTRING_LEN 32
219 enum ethtool_stringset
{
224 /* for passing string sets for data tagging */
225 struct ethtool_gstrings
{
226 __u32 cmd
; /* ETHTOOL_GSTRINGS */
227 __u32 string_set
; /* string set id e.c. ETH_SS_TEST, etc*/
228 __u32 len
; /* number of strings in the string set */
232 enum ethtool_test_flags
{
233 ETH_TEST_FL_OFFLINE
= (1 << 0), /* online / offline */
234 ETH_TEST_FL_FAILED
= (1 << 1), /* test passed / failed */
237 /* for requesting NIC test and getting results*/
238 struct ethtool_test
{
239 __u32 cmd
; /* ETHTOOL_TEST */
240 __u32 flags
; /* ETH_TEST_FL_xxx */
242 __u32 len
; /* result length, in number of u64 elements */
246 /* for dumping NIC-specific statistics */
247 struct ethtool_stats
{
248 __u32 cmd
; /* ETHTOOL_GSTATS */
249 __u32 n_stats
; /* number of u64's being returned */
253 struct ethtool_perm_addr
{
254 __u32 cmd
; /* ETHTOOL_GPERMADDR */
259 /* boolean flags controlling per-interface behavior characteristics.
260 * When reading, the flag indicates whether or not a certain behavior
261 * is enabled/present. When writing, the flag indicates whether
262 * or not the driver should turn on (set) or off (clear) a behavior.
264 * Some behaviors may read-only (unconditionally absent or present).
265 * If such is the case, return EINVAL in the set-flags operation if the
266 * flag differs from the read-only value.
269 ETH_FLAG_LRO
= (1 << 15), /* LRO is enabled */
276 /* Some generic methods drivers may use in their ethtool_ops */
277 u32
ethtool_op_get_link(struct net_device
*dev
);
278 u32
ethtool_op_get_tx_csum(struct net_device
*dev
);
279 int ethtool_op_set_tx_csum(struct net_device
*dev
, u32 data
);
280 int ethtool_op_set_tx_hw_csum(struct net_device
*dev
, u32 data
);
281 int ethtool_op_set_tx_ipv6_csum(struct net_device
*dev
, u32 data
);
282 u32
ethtool_op_get_sg(struct net_device
*dev
);
283 int ethtool_op_set_sg(struct net_device
*dev
, u32 data
);
284 u32
ethtool_op_get_tso(struct net_device
*dev
);
285 int ethtool_op_set_tso(struct net_device
*dev
, u32 data
);
286 u32
ethtool_op_get_ufo(struct net_device
*dev
);
287 int ethtool_op_set_ufo(struct net_device
*dev
, u32 data
);
288 u32
ethtool_op_get_flags(struct net_device
*dev
);
289 int ethtool_op_set_flags(struct net_device
*dev
, u32 data
);
292 * ðtool_ops - Alter and report network device settings
293 * get_settings: Get device-specific settings
294 * set_settings: Set device-specific settings
295 * get_drvinfo: Report driver information
296 * get_regs: Get device registers
297 * get_wol: Report whether Wake-on-Lan is enabled
298 * set_wol: Turn Wake-on-Lan on or off
299 * get_msglevel: Report driver message level
300 * set_msglevel: Set driver message level
301 * nway_reset: Restart autonegotiation
302 * get_link: Get link status
303 * get_eeprom: Read data from the device EEPROM
304 * set_eeprom: Write data to the device EEPROM
305 * get_coalesce: Get interrupt coalescing parameters
306 * set_coalesce: Set interrupt coalescing parameters
307 * get_ringparam: Report ring sizes
308 * set_ringparam: Set ring sizes
309 * get_pauseparam: Report pause parameters
310 * set_pauseparam: Set pause paramters
311 * get_rx_csum: Report whether receive checksums are turned on or off
312 * set_rx_csum: Turn receive checksum on or off
313 * get_tx_csum: Report whether transmit checksums are turned on or off
314 * set_tx_csum: Turn transmit checksums on or off
315 * get_sg: Report whether scatter-gather is enabled
316 * set_sg: Turn scatter-gather on or off
317 * get_tso: Report whether TCP segmentation offload is enabled
318 * set_tso: Turn TCP segmentation offload on or off
319 * get_ufo: Report whether UDP fragmentation offload is enabled
320 * set_ufo: Turn UDP fragmentation offload on or off
321 * self_test: Run specified self-tests
322 * get_strings: Return a set of strings that describe the requested objects
323 * phys_id: Identify the device
324 * get_stats: Return statistics about the device
325 * get_flags: get 32-bit flags bitmap
326 * set_flags: set 32-bit flags bitmap
331 * @get_settings is passed an ðtool_cmd to fill in. It returns
332 * an negative errno or zero.
335 * @set_settings is passed an ðtool_cmd and should attempt to set
336 * all the settings this device supports. It may return an error value
337 * if something goes wrong (otherwise 0).
340 * Should fill in the magic field. Don't need to check len for zero
341 * or wraparound. Fill in the data argument with the eeprom values
342 * from offset to offset + len. Update len to the amount read.
343 * Returns an error or zero.
346 * Should validate the magic field. Don't need to check len for zero
347 * or wraparound. Update len to the amount written. Returns an error
351 int (*get_settings
)(struct net_device
*, struct ethtool_cmd
*);
352 int (*set_settings
)(struct net_device
*, struct ethtool_cmd
*);
353 void (*get_drvinfo
)(struct net_device
*, struct ethtool_drvinfo
*);
354 int (*get_regs_len
)(struct net_device
*);
355 void (*get_regs
)(struct net_device
*, struct ethtool_regs
*, void *);
356 void (*get_wol
)(struct net_device
*, struct ethtool_wolinfo
*);
357 int (*set_wol
)(struct net_device
*, struct ethtool_wolinfo
*);
358 u32 (*get_msglevel
)(struct net_device
*);
359 void (*set_msglevel
)(struct net_device
*, u32
);
360 int (*nway_reset
)(struct net_device
*);
361 u32 (*get_link
)(struct net_device
*);
362 int (*get_eeprom_len
)(struct net_device
*);
363 int (*get_eeprom
)(struct net_device
*, struct ethtool_eeprom
*, u8
*);
364 int (*set_eeprom
)(struct net_device
*, struct ethtool_eeprom
*, u8
*);
365 int (*get_coalesce
)(struct net_device
*, struct ethtool_coalesce
*);
366 int (*set_coalesce
)(struct net_device
*, struct ethtool_coalesce
*);
367 void (*get_ringparam
)(struct net_device
*, struct ethtool_ringparam
*);
368 int (*set_ringparam
)(struct net_device
*, struct ethtool_ringparam
*);
369 void (*get_pauseparam
)(struct net_device
*, struct ethtool_pauseparam
*);
370 int (*set_pauseparam
)(struct net_device
*, struct ethtool_pauseparam
*);
371 u32 (*get_rx_csum
)(struct net_device
*);
372 int (*set_rx_csum
)(struct net_device
*, u32
);
373 u32 (*get_tx_csum
)(struct net_device
*);
374 int (*set_tx_csum
)(struct net_device
*, u32
);
375 u32 (*get_sg
)(struct net_device
*);
376 int (*set_sg
)(struct net_device
*, u32
);
377 u32 (*get_tso
)(struct net_device
*);
378 int (*set_tso
)(struct net_device
*, u32
);
379 void (*self_test
)(struct net_device
*, struct ethtool_test
*, u64
*);
380 void (*get_strings
)(struct net_device
*, u32 stringset
, u8
*);
381 int (*phys_id
)(struct net_device
*, u32
);
382 void (*get_ethtool_stats
)(struct net_device
*, struct ethtool_stats
*, u64
*);
383 int (*begin
)(struct net_device
*);
384 void (*complete
)(struct net_device
*);
385 u32 (*get_ufo
)(struct net_device
*);
386 int (*set_ufo
)(struct net_device
*, u32
);
387 u32 (*get_flags
)(struct net_device
*);
388 int (*set_flags
)(struct net_device
*, u32
);
389 int (*get_sset_count
)(struct net_device
*, int);
391 /* the following hooks are obsolete */
392 int (*self_test_count
)(struct net_device
*);/* use get_sset_count */
393 int (*get_stats_count
)(struct net_device
*);/* use get_sset_count */
395 #endif /* __KERNEL__ */
397 /* CMDs currently supported */
398 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
399 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
400 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
401 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
402 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
403 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
404 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
405 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
406 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
407 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
408 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
409 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
410 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
411 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
412 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
413 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
414 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
415 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
416 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
417 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
418 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
419 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
420 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
422 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
423 * (ethtool_value). */
424 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
425 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
426 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
427 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
428 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
429 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
430 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
431 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
432 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
433 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
434 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
435 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
436 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
438 /* compatibility with older code */
439 #define SPARC_ETH_GSET ETHTOOL_GSET
440 #define SPARC_ETH_SSET ETHTOOL_SSET
442 /* Indicates what features are supported by the interface. */
443 #define SUPPORTED_10baseT_Half (1 << 0)
444 #define SUPPORTED_10baseT_Full (1 << 1)
445 #define SUPPORTED_100baseT_Half (1 << 2)
446 #define SUPPORTED_100baseT_Full (1 << 3)
447 #define SUPPORTED_1000baseT_Half (1 << 4)
448 #define SUPPORTED_1000baseT_Full (1 << 5)
449 #define SUPPORTED_Autoneg (1 << 6)
450 #define SUPPORTED_TP (1 << 7)
451 #define SUPPORTED_AUI (1 << 8)
452 #define SUPPORTED_MII (1 << 9)
453 #define SUPPORTED_FIBRE (1 << 10)
454 #define SUPPORTED_BNC (1 << 11)
455 #define SUPPORTED_10000baseT_Full (1 << 12)
456 #define SUPPORTED_Pause (1 << 13)
457 #define SUPPORTED_Asym_Pause (1 << 14)
458 #define SUPPORTED_2500baseX_Full (1 << 15)
460 /* Indicates what features are advertised by the interface. */
461 #define ADVERTISED_10baseT_Half (1 << 0)
462 #define ADVERTISED_10baseT_Full (1 << 1)
463 #define ADVERTISED_100baseT_Half (1 << 2)
464 #define ADVERTISED_100baseT_Full (1 << 3)
465 #define ADVERTISED_1000baseT_Half (1 << 4)
466 #define ADVERTISED_1000baseT_Full (1 << 5)
467 #define ADVERTISED_Autoneg (1 << 6)
468 #define ADVERTISED_TP (1 << 7)
469 #define ADVERTISED_AUI (1 << 8)
470 #define ADVERTISED_MII (1 << 9)
471 #define ADVERTISED_FIBRE (1 << 10)
472 #define ADVERTISED_BNC (1 << 11)
473 #define ADVERTISED_10000baseT_Full (1 << 12)
474 #define ADVERTISED_Pause (1 << 13)
475 #define ADVERTISED_Asym_Pause (1 << 14)
476 #define ADVERTISED_2500baseX_Full (1 << 15)
478 /* The following are all involved in forcing a particular link
479 * mode for the device for setting things. When getting the
480 * devices settings, these indicate the current mode and whether
481 * it was foced up into this mode or autonegotiated.
484 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
486 #define SPEED_100 100
487 #define SPEED_1000 1000
488 #define SPEED_2500 2500
489 #define SPEED_10000 10000
491 /* Duplex, half or full. */
492 #define DUPLEX_HALF 0x00
493 #define DUPLEX_FULL 0x01
495 /* Which connector port. */
497 #define PORT_AUI 0x01
498 #define PORT_MII 0x02
499 #define PORT_FIBRE 0x03
500 #define PORT_BNC 0x04
502 /* Which transceiver to use. */
503 #define XCVR_INTERNAL 0x00
504 #define XCVR_EXTERNAL 0x01
505 #define XCVR_DUMMY1 0x02
506 #define XCVR_DUMMY2 0x03
507 #define XCVR_DUMMY3 0x04
509 /* Enable or disable autonegotiation. If this is set to enable,
510 * the forced link modes above are completely ignored.
512 #define AUTONEG_DISABLE 0x00
513 #define AUTONEG_ENABLE 0x01
515 /* Wake-On-Lan options. */
516 #define WAKE_PHY (1 << 0)
517 #define WAKE_UCAST (1 << 1)
518 #define WAKE_MCAST (1 << 2)
519 #define WAKE_BCAST (1 << 3)
520 #define WAKE_ARP (1 << 4)
521 #define WAKE_MAGIC (1 << 5)
522 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
524 #endif /* _LINUX_ETHTOOL_H */