e1000e: don't return half-read eeprom on error
[linux-2.6/mini2440.git] / include / linux / ethtool.h
blobc8d216357865dda3e22bd503df478055b3d888b9
1 /*
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. */
18 struct ethtool_cmd {
19 __u32 cmd;
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 */
25 __u8 phy_address;
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 */
30 __u32 reserved[4];
33 #define ETHTOOL_BUSINFO_LEN 32
34 /* these strings are set to whatever the driver author decides... */
35 struct ethtool_drvinfo {
36 __u32 cmd;
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). */
42 char reserved1[32];
43 char reserved2[12];
44 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
45 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
46 __u32 testinfo_len;
47 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
48 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
51 #define SOPASS_MAX 6
52 /* wake-on-lan settings */
53 struct ethtool_wolinfo {
54 __u32 cmd;
55 __u32 supported;
56 __u32 wolopts;
57 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
60 /* for passing single values */
61 struct ethtool_value {
62 __u32 cmd;
63 __u32 data;
66 /* for passing big chunks of data */
67 struct ethtool_regs {
68 __u32 cmd;
69 __u32 version; /* driver-specific, indicates different chips/revs */
70 __u32 len; /* bytes */
71 __u8 data[0];
74 /* for passing EEPROM chunks */
75 struct ethtool_eeprom {
76 __u32 cmd;
77 __u32 magic;
78 __u32 offset; /* in bytes */
79 __u32 len; /* in bytes */
80 __u8 data[0];
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
89 * is used.
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
97 * generated.
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
104 * in that case.
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
111 * is used.
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
119 * generated.
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
126 * in that case.
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
143 * silently ignored.
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
150 * used.
152 __u32 pkt_rate_low;
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
165 * used.
167 __u32 pkt_rate_high;
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
185 * user to set.
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.
195 __u32 rx_pending;
196 __u32 rx_mini_pending;
197 __u32 rx_jumbo_pending;
198 __u32 tx_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
209 * advertised.
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
213 * flow control.
215 __u32 autoneg;
216 __u32 rx_pause;
217 __u32 tx_pause;
220 #define ETH_GSTRING_LEN 32
221 enum ethtool_stringset {
222 ETH_SS_TEST = 0,
223 ETH_SS_STATS,
224 ETH_SS_PRIV_FLAGS,
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 */
232 __u8 data[0];
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 */
244 __u32 reserved;
245 __u32 len; /* result length, in number of u64 elements */
246 __u64 data[0];
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 */
253 __u64 data[0];
256 struct ethtool_perm_addr {
257 __u32 cmd; /* ETHTOOL_GPERMADDR */
258 __u32 size;
259 __u8 data[0];
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.
271 enum ethtool_flags {
272 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
275 #ifdef __KERNEL__
277 struct net_device;
279 /* Some generic methods drivers may use in their ethtool_ops */
280 u32 ethtool_op_get_link(struct net_device *dev);
281 u32 ethtool_op_get_tx_csum(struct net_device *dev);
282 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
283 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
284 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
285 u32 ethtool_op_get_sg(struct net_device *dev);
286 int ethtool_op_set_sg(struct net_device *dev, u32 data);
287 u32 ethtool_op_get_tso(struct net_device *dev);
288 int ethtool_op_set_tso(struct net_device *dev, u32 data);
289 u32 ethtool_op_get_ufo(struct net_device *dev);
290 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
291 u32 ethtool_op_get_flags(struct net_device *dev);
292 int ethtool_op_set_flags(struct net_device *dev, u32 data);
295 * &ethtool_ops - Alter and report network device settings
296 * get_settings: Get device-specific settings
297 * set_settings: Set device-specific settings
298 * get_drvinfo: Report driver information
299 * get_regs: Get device registers
300 * get_wol: Report whether Wake-on-Lan is enabled
301 * set_wol: Turn Wake-on-Lan on or off
302 * get_msglevel: Report driver message level
303 * set_msglevel: Set driver message level
304 * nway_reset: Restart autonegotiation
305 * get_link: Get link status
306 * get_eeprom: Read data from the device EEPROM
307 * set_eeprom: Write data to the device EEPROM
308 * get_coalesce: Get interrupt coalescing parameters
309 * set_coalesce: Set interrupt coalescing parameters
310 * get_ringparam: Report ring sizes
311 * set_ringparam: Set ring sizes
312 * get_pauseparam: Report pause parameters
313 * set_pauseparam: Set pause parameters
314 * get_rx_csum: Report whether receive checksums are turned on or off
315 * set_rx_csum: Turn receive checksum on or off
316 * get_tx_csum: Report whether transmit checksums are turned on or off
317 * set_tx_csum: Turn transmit checksums on or off
318 * get_sg: Report whether scatter-gather is enabled
319 * set_sg: Turn scatter-gather on or off
320 * get_tso: Report whether TCP segmentation offload is enabled
321 * set_tso: Turn TCP segmentation offload on or off
322 * get_ufo: Report whether UDP fragmentation offload is enabled
323 * set_ufo: Turn UDP fragmentation offload on or off
324 * self_test: Run specified self-tests
325 * get_strings: Return a set of strings that describe the requested objects
326 * phys_id: Identify the device
327 * get_stats: Return statistics about the device
328 * get_flags: get 32-bit flags bitmap
329 * set_flags: set 32-bit flags bitmap
331 * Description:
333 * get_settings:
334 * @get_settings is passed an &ethtool_cmd to fill in. It returns
335 * an negative errno or zero.
337 * set_settings:
338 * @set_settings is passed an &ethtool_cmd and should attempt to set
339 * all the settings this device supports. It may return an error value
340 * if something goes wrong (otherwise 0).
342 * get_eeprom:
343 * Should fill in the magic field. Don't need to check len for zero
344 * or wraparound. Fill in the data argument with the eeprom values
345 * from offset to offset + len. Update len to the amount read.
346 * Returns an error or zero.
348 * set_eeprom:
349 * Should validate the magic field. Don't need to check len for zero
350 * or wraparound. Update len to the amount written. Returns an error
351 * or zero.
353 struct ethtool_ops {
354 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
355 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
356 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
357 int (*get_regs_len)(struct net_device *);
358 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
359 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
360 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
361 u32 (*get_msglevel)(struct net_device *);
362 void (*set_msglevel)(struct net_device *, u32);
363 int (*nway_reset)(struct net_device *);
364 u32 (*get_link)(struct net_device *);
365 int (*get_eeprom_len)(struct net_device *);
366 int (*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
367 int (*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
368 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
369 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
370 void (*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
371 int (*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
372 void (*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
373 int (*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
374 u32 (*get_rx_csum)(struct net_device *);
375 int (*set_rx_csum)(struct net_device *, u32);
376 u32 (*get_tx_csum)(struct net_device *);
377 int (*set_tx_csum)(struct net_device *, u32);
378 u32 (*get_sg)(struct net_device *);
379 int (*set_sg)(struct net_device *, u32);
380 u32 (*get_tso)(struct net_device *);
381 int (*set_tso)(struct net_device *, u32);
382 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
383 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
384 int (*phys_id)(struct net_device *, u32);
385 void (*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
386 int (*begin)(struct net_device *);
387 void (*complete)(struct net_device *);
388 u32 (*get_ufo)(struct net_device *);
389 int (*set_ufo)(struct net_device *, u32);
390 u32 (*get_flags)(struct net_device *);
391 int (*set_flags)(struct net_device *, u32);
392 u32 (*get_priv_flags)(struct net_device *);
393 int (*set_priv_flags)(struct net_device *, u32);
394 int (*get_sset_count)(struct net_device *, int);
396 /* the following hooks are obsolete */
397 int (*self_test_count)(struct net_device *);/* use get_sset_count */
398 int (*get_stats_count)(struct net_device *);/* use get_sset_count */
400 #endif /* __KERNEL__ */
402 /* CMDs currently supported */
403 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
404 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
405 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
406 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
407 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
408 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
409 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
410 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
411 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
412 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
413 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
414 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
415 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
416 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
417 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
418 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
419 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
420 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
421 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
422 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
423 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
424 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
425 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
426 * (ethtool_value) */
427 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
428 * (ethtool_value). */
429 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
430 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
431 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
432 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
433 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
434 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
435 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
436 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
437 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
438 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
439 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
440 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
441 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
442 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
443 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
445 /* compatibility with older code */
446 #define SPARC_ETH_GSET ETHTOOL_GSET
447 #define SPARC_ETH_SSET ETHTOOL_SSET
449 /* Indicates what features are supported by the interface. */
450 #define SUPPORTED_10baseT_Half (1 << 0)
451 #define SUPPORTED_10baseT_Full (1 << 1)
452 #define SUPPORTED_100baseT_Half (1 << 2)
453 #define SUPPORTED_100baseT_Full (1 << 3)
454 #define SUPPORTED_1000baseT_Half (1 << 4)
455 #define SUPPORTED_1000baseT_Full (1 << 5)
456 #define SUPPORTED_Autoneg (1 << 6)
457 #define SUPPORTED_TP (1 << 7)
458 #define SUPPORTED_AUI (1 << 8)
459 #define SUPPORTED_MII (1 << 9)
460 #define SUPPORTED_FIBRE (1 << 10)
461 #define SUPPORTED_BNC (1 << 11)
462 #define SUPPORTED_10000baseT_Full (1 << 12)
463 #define SUPPORTED_Pause (1 << 13)
464 #define SUPPORTED_Asym_Pause (1 << 14)
465 #define SUPPORTED_2500baseX_Full (1 << 15)
467 /* Indicates what features are advertised by the interface. */
468 #define ADVERTISED_10baseT_Half (1 << 0)
469 #define ADVERTISED_10baseT_Full (1 << 1)
470 #define ADVERTISED_100baseT_Half (1 << 2)
471 #define ADVERTISED_100baseT_Full (1 << 3)
472 #define ADVERTISED_1000baseT_Half (1 << 4)
473 #define ADVERTISED_1000baseT_Full (1 << 5)
474 #define ADVERTISED_Autoneg (1 << 6)
475 #define ADVERTISED_TP (1 << 7)
476 #define ADVERTISED_AUI (1 << 8)
477 #define ADVERTISED_MII (1 << 9)
478 #define ADVERTISED_FIBRE (1 << 10)
479 #define ADVERTISED_BNC (1 << 11)
480 #define ADVERTISED_10000baseT_Full (1 << 12)
481 #define ADVERTISED_Pause (1 << 13)
482 #define ADVERTISED_Asym_Pause (1 << 14)
483 #define ADVERTISED_2500baseX_Full (1 << 15)
485 /* The following are all involved in forcing a particular link
486 * mode for the device for setting things. When getting the
487 * devices settings, these indicate the current mode and whether
488 * it was foced up into this mode or autonegotiated.
491 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
492 #define SPEED_10 10
493 #define SPEED_100 100
494 #define SPEED_1000 1000
495 #define SPEED_2500 2500
496 #define SPEED_10000 10000
498 /* Duplex, half or full. */
499 #define DUPLEX_HALF 0x00
500 #define DUPLEX_FULL 0x01
502 /* Which connector port. */
503 #define PORT_TP 0x00
504 #define PORT_AUI 0x01
505 #define PORT_MII 0x02
506 #define PORT_FIBRE 0x03
507 #define PORT_BNC 0x04
509 /* Which transceiver to use. */
510 #define XCVR_INTERNAL 0x00
511 #define XCVR_EXTERNAL 0x01
512 #define XCVR_DUMMY1 0x02
513 #define XCVR_DUMMY2 0x03
514 #define XCVR_DUMMY3 0x04
516 /* Enable or disable autonegotiation. If this is set to enable,
517 * the forced link modes above are completely ignored.
519 #define AUTONEG_DISABLE 0x00
520 #define AUTONEG_ENABLE 0x01
522 /* Wake-On-Lan options. */
523 #define WAKE_PHY (1 << 0)
524 #define WAKE_UCAST (1 << 1)
525 #define WAKE_MCAST (1 << 2)
526 #define WAKE_BCAST (1 << 3)
527 #define WAKE_ARP (1 << 4)
528 #define WAKE_MAGIC (1 << 5)
529 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
531 #endif /* _LINUX_ETHTOOL_H */