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_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
44 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
46 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
47 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
51 /* wake-on-lan settings */
52 struct ethtool_wolinfo {
56 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
59 /* for passing single values */
60 struct ethtool_value {
65 /* for passing big chunks of data */
68 __u32 version; /* driver-specific, indicates different chips/revs */
69 __u32 len; /* bytes */
73 /* for passing EEPROM chunks */
74 struct ethtool_eeprom {
77 __u32 offset; /* in bytes */
78 __u32 len; /* in bytes */
82 /* for configuring coalescing parameters of chip */
83 struct ethtool_coalesce {
84 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */
86 /* How many usecs to delay an RX interrupt after
87 * a packet arrives. If 0, only rx_max_coalesced_frames
90 __u32 rx_coalesce_usecs;
92 /* How many packets to delay an RX interrupt after
93 * a packet arrives. If 0, only rx_coalesce_usecs is
94 * used. It is illegal to set both usecs and max frames
95 * to zero as this would cause RX interrupts to never be
98 __u32 rx_max_coalesced_frames;
100 /* Same as above two parameters, except that these values
101 * apply while an IRQ is being serviced by the host. Not
102 * all cards support this feature and the values are ignored
105 __u32 rx_coalesce_usecs_irq;
106 __u32 rx_max_coalesced_frames_irq;
108 /* How many usecs to delay a TX interrupt after
109 * a packet is sent. If 0, only tx_max_coalesced_frames
112 __u32 tx_coalesce_usecs;
114 /* How many packets to delay a TX interrupt after
115 * a packet is sent. If 0, only tx_coalesce_usecs is
116 * used. It is illegal to set both usecs and max frames
117 * to zero as this would cause TX interrupts to never be
120 __u32 tx_max_coalesced_frames;
122 /* Same as above two parameters, except that these values
123 * apply while an IRQ is being serviced by the host. Not
124 * all cards support this feature and the values are ignored
127 __u32 tx_coalesce_usecs_irq;
128 __u32 tx_max_coalesced_frames_irq;
130 /* How many usecs to delay in-memory statistics
131 * block updates. Some drivers do not have an in-memory
132 * statistic block, and in such cases this value is ignored.
133 * This value must not be zero.
135 __u32 stats_block_coalesce_usecs;
137 /* Adaptive RX/TX coalescing is an algorithm implemented by
138 * some drivers to improve latency under low packet rates and
139 * improve throughput under high packet rates. Some drivers
140 * only implement one of RX or TX adaptive coalescing. Anything
141 * not implemented by the driver causes these values to be
144 __u32 use_adaptive_rx_coalesce;
145 __u32 use_adaptive_tx_coalesce;
147 /* When the packet rate (measured in packets per second)
148 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
152 __u32 rx_coalesce_usecs_low;
153 __u32 rx_max_coalesced_frames_low;
154 __u32 tx_coalesce_usecs_low;
155 __u32 tx_max_coalesced_frames_low;
157 /* When the packet rate is below pkt_rate_high but above
158 * pkt_rate_low (both measured in packets per second) the
159 * normal {rx,tx}_* coalescing parameters are used.
162 /* When the packet rate is (measured in packets per second)
163 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
167 __u32 rx_coalesce_usecs_high;
168 __u32 rx_max_coalesced_frames_high;
169 __u32 tx_coalesce_usecs_high;
170 __u32 tx_max_coalesced_frames_high;
172 /* How often to do adaptive coalescing packet rate sampling,
173 * measured in seconds. Must not be zero.
175 __u32 rate_sample_interval;
178 /* for configuring RX/TX ring parameters */
179 struct ethtool_ringparam {
180 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
182 /* Read only attributes. These indicate the maximum number
183 * of pending RX/TX ring entries the driver will allow the
186 __u32 rx_max_pending;
187 __u32 rx_mini_max_pending;
188 __u32 rx_jumbo_max_pending;
189 __u32 tx_max_pending;
191 /* Values changeable by the user. The valid values are
192 * in the range 1 to the "*_max_pending" counterpart above.
195 __u32 rx_mini_pending;
196 __u32 rx_jumbo_pending;
200 /* for configuring link flow control parameters */
201 struct ethtool_pauseparam {
202 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
204 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
205 * being true) the user may set 'autonet' here non-zero to have the
206 * pause parameters be auto-negotiated too. In such a case, the
207 * {rx,tx}_pause values below determine what capabilities are
210 * If 'autoneg' is zero or the link is not being auto-negotiated,
211 * then {rx,tx}_pause force the driver to use/not-use pause
219 #define ETH_GSTRING_LEN 32
220 enum ethtool_stringset {
226 /* for passing string sets for data tagging */
227 struct ethtool_gstrings {
228 __u32 cmd; /* ETHTOOL_GSTRINGS */
229 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
230 __u32 len; /* number of strings in the string set */
234 enum ethtool_test_flags {
235 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
236 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
239 /* for requesting NIC test and getting results*/
240 struct ethtool_test {
241 __u32 cmd; /* ETHTOOL_TEST */
242 __u32 flags; /* ETH_TEST_FL_xxx */
244 __u32 len; /* result length, in number of u64 elements */
248 /* for dumping NIC-specific statistics */
249 struct ethtool_stats {
250 __u32 cmd; /* ETHTOOL_GSTATS */
251 __u32 n_stats; /* number of u64's being returned */
255 struct ethtool_perm_addr {
256 __u32 cmd; /* ETHTOOL_GPERMADDR */
261 /* boolean flags controlling per-interface behavior characteristics.
262 * When reading, the flag indicates whether or not a certain behavior
263 * is enabled/present. When writing, the flag indicates whether
264 * or not the driver should turn on (set) or off (clear) a behavior.
266 * Some behaviors may read-only (unconditionally absent or present).
267 * If such is the case, return EINVAL in the set-flags operation if the
268 * flag differs from the read-only value.
271 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
278 /* Some generic methods drivers may use in their ethtool_ops */
279 u32 ethtool_op_get_link(struct net_device *dev);
280 u32 ethtool_op_get_tx_csum(struct net_device *dev);
281 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
282 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
283 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
284 u32 ethtool_op_get_sg(struct net_device *dev);
285 int ethtool_op_set_sg(struct net_device *dev, u32 data);
286 u32 ethtool_op_get_tso(struct net_device *dev);
287 int ethtool_op_set_tso(struct net_device *dev, u32 data);
288 u32 ethtool_op_get_ufo(struct net_device *dev);
289 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
290 u32 ethtool_op_get_flags(struct net_device *dev);
291 int ethtool_op_set_flags(struct net_device *dev, u32 data);
294 * ðtool_ops - Alter and report network device settings
295 * get_settings: Get device-specific settings
296 * set_settings: Set device-specific settings
297 * get_drvinfo: Report driver information
298 * get_regs: Get device registers
299 * get_wol: Report whether Wake-on-Lan is enabled
300 * set_wol: Turn Wake-on-Lan on or off
301 * get_msglevel: Report driver message level
302 * set_msglevel: Set driver message level
303 * nway_reset: Restart autonegotiation
304 * get_link: Get link status
305 * get_eeprom: Read data from the device EEPROM
306 * set_eeprom: Write data to the device EEPROM
307 * get_coalesce: Get interrupt coalescing parameters
308 * set_coalesce: Set interrupt coalescing parameters
309 * get_ringparam: Report ring sizes
310 * set_ringparam: Set ring sizes
311 * get_pauseparam: Report pause parameters
312 * set_pauseparam: Set pause parameters
313 * get_rx_csum: Report whether receive checksums are turned on or off
314 * set_rx_csum: Turn receive checksum on or off
315 * get_tx_csum: Report whether transmit checksums are turned on or off
316 * set_tx_csum: Turn transmit checksums on or off
317 * get_sg: Report whether scatter-gather is enabled
318 * set_sg: Turn scatter-gather on or off
319 * get_tso: Report whether TCP segmentation offload is enabled
320 * set_tso: Turn TCP segmentation offload on or off
321 * get_ufo: Report whether UDP fragmentation offload is enabled
322 * set_ufo: Turn UDP fragmentation offload on or off
323 * self_test: Run specified self-tests
324 * get_strings: Return a set of strings that describe the requested objects
325 * phys_id: Identify the device
326 * get_stats: Return statistics about the device
327 * get_flags: get 32-bit flags bitmap
328 * set_flags: set 32-bit flags bitmap
333 * @get_settings is passed an ðtool_cmd to fill in. It returns
334 * an negative errno or zero.
337 * @set_settings is passed an ðtool_cmd and should attempt to set
338 * all the settings this device supports. It may return an error value
339 * if something goes wrong (otherwise 0).
342 * Should fill in the magic field. Don't need to check len for zero
343 * or wraparound. Fill in the data argument with the eeprom values
344 * from offset to offset + len. Update len to the amount read.
345 * Returns an error or zero.
348 * Should validate the magic field. Don't need to check len for zero
349 * or wraparound. Update len to the amount written. Returns an error
353 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
354 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
355 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
356 int (*get_regs_len)(struct net_device *);
357 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
358 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
359 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
360 u32 (*get_msglevel)(struct net_device *);
361 void (*set_msglevel)(struct net_device *, u32);
362 int (*nway_reset)(struct net_device *);
363 u32 (*get_link)(struct net_device *);
364 int (*get_eeprom_len)(struct net_device *);
365 int (*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
366 int (*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
367 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
368 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
369 void (*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
370 int (*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
371 void (*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
372 int (*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
373 u32 (*get_rx_csum)(struct net_device *);
374 int (*set_rx_csum)(struct net_device *, u32);
375 u32 (*get_tx_csum)(struct net_device *);
376 int (*set_tx_csum)(struct net_device *, u32);
377 u32 (*get_sg)(struct net_device *);
378 int (*set_sg)(struct net_device *, u32);
379 u32 (*get_tso)(struct net_device *);
380 int (*set_tso)(struct net_device *, u32);
381 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
382 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
383 int (*phys_id)(struct net_device *, u32);
384 void (*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
385 int (*begin)(struct net_device *);
386 void (*complete)(struct net_device *);
387 u32 (*get_ufo)(struct net_device *);
388 int (*set_ufo)(struct net_device *, u32);
389 u32 (*get_flags)(struct net_device *);
390 int (*set_flags)(struct net_device *, u32);
391 u32 (*get_priv_flags)(struct net_device *);
392 int (*set_priv_flags)(struct net_device *, u32);
393 int (*get_sset_count)(struct net_device *, int);
395 /* the following hooks are obsolete */
396 int (*self_test_count)(struct net_device *);/* use get_sset_count */
397 int (*get_stats_count)(struct net_device *);/* use get_sset_count */
399 #endif /* __KERNEL__ */
401 /* CMDs currently supported */
402 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
403 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
404 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
405 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
406 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
407 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
408 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
409 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
410 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
411 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
412 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
413 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
414 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
415 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
416 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
417 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
418 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
419 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
420 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
421 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
422 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
423 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
424 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
426 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
427 * (ethtool_value). */
428 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
429 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
430 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
431 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
432 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
433 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
434 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
435 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
436 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
437 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
438 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
439 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
440 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
441 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
442 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
444 /* compatibility with older code */
445 #define SPARC_ETH_GSET ETHTOOL_GSET
446 #define SPARC_ETH_SSET ETHTOOL_SSET
448 /* Indicates what features are supported by the interface. */
449 #define SUPPORTED_10baseT_Half (1 << 0)
450 #define SUPPORTED_10baseT_Full (1 << 1)
451 #define SUPPORTED_100baseT_Half (1 << 2)
452 #define SUPPORTED_100baseT_Full (1 << 3)
453 #define SUPPORTED_1000baseT_Half (1 << 4)
454 #define SUPPORTED_1000baseT_Full (1 << 5)
455 #define SUPPORTED_Autoneg (1 << 6)
456 #define SUPPORTED_TP (1 << 7)
457 #define SUPPORTED_AUI (1 << 8)
458 #define SUPPORTED_MII (1 << 9)
459 #define SUPPORTED_FIBRE (1 << 10)
460 #define SUPPORTED_BNC (1 << 11)
461 #define SUPPORTED_10000baseT_Full (1 << 12)
462 #define SUPPORTED_Pause (1 << 13)
463 #define SUPPORTED_Asym_Pause (1 << 14)
464 #define SUPPORTED_2500baseX_Full (1 << 15)
466 /* Indicates what features are advertised by the interface. */
467 #define ADVERTISED_10baseT_Half (1 << 0)
468 #define ADVERTISED_10baseT_Full (1 << 1)
469 #define ADVERTISED_100baseT_Half (1 << 2)
470 #define ADVERTISED_100baseT_Full (1 << 3)
471 #define ADVERTISED_1000baseT_Half (1 << 4)
472 #define ADVERTISED_1000baseT_Full (1 << 5)
473 #define ADVERTISED_Autoneg (1 << 6)
474 #define ADVERTISED_TP (1 << 7)
475 #define ADVERTISED_AUI (1 << 8)
476 #define ADVERTISED_MII (1 << 9)
477 #define ADVERTISED_FIBRE (1 << 10)
478 #define ADVERTISED_BNC (1 << 11)
479 #define ADVERTISED_10000baseT_Full (1 << 12)
480 #define ADVERTISED_Pause (1 << 13)
481 #define ADVERTISED_Asym_Pause (1 << 14)
482 #define ADVERTISED_2500baseX_Full (1 << 15)
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 /* Which transceiver to use. */
509 #define XCVR_INTERNAL 0x00
510 #define XCVR_EXTERNAL 0x01
511 #define XCVR_DUMMY1 0x02
512 #define XCVR_DUMMY2 0x03
513 #define XCVR_DUMMY3 0x04
515 /* Enable or disable autonegotiation. If this is set to enable,
516 * the forced link modes above are completely ignored.
518 #define AUTONEG_DISABLE 0x00
519 #define AUTONEG_ENABLE 0x01
521 /* Wake-On-Lan options. */
522 #define WAKE_PHY (1 << 0)
523 #define WAKE_UCAST (1 << 1)
524 #define WAKE_MCAST (1 << 2)
525 #define WAKE_BCAST (1 << 3)
526 #define WAKE_ARP (1 << 4)
527 #define WAKE_MAGIC (1 << 5)
528 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
530 #endif /* _LINUX_ETHTOOL_H */