ethtool.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:17k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * ethtool.h: Defines for Linux ethtool.
  3.  *
  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.  */
  11. #ifndef _LINUX_ETHTOOL_H
  12. #define _LINUX_ETHTOOL_H
  13. /* This should work for both 32 and 64 bit userland. */
  14. struct ethtool_cmd {
  15. u32 cmd;
  16. u32 supported; /* Features this interface supports */
  17. u32 advertising; /* Features this interface advertises */
  18. u16 speed; /* The forced speed, 10Mb, 100Mb, gigabit */
  19. u8 duplex; /* Duplex, half or full */
  20. u8 port; /* Which connector port */
  21. u8 phy_address;
  22. u8 transceiver; /* Which transceiver to use */
  23. u8 autoneg; /* Enable or disable autonegotiation */
  24. u32 maxtxpkt; /* Tx pkts before generating tx int */
  25. u32 maxrxpkt; /* Rx pkts before generating rx int */
  26. u32 reserved[4];
  27. };
  28. #define ETHTOOL_BUSINFO_LEN 32
  29. /* these strings are set to whatever the driver author decides... */
  30. struct ethtool_drvinfo {
  31. u32 cmd;
  32. char driver[32]; /* driver short name, "tulip", "eepro100" */
  33. char version[32]; /* driver version string */
  34. char fw_version[32]; /* firmware version string, if applicable */
  35. char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
  36. /* For PCI devices, use pci_name(pci_dev). */
  37. char reserved1[32];
  38. char reserved2[16];
  39. u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
  40. u32 testinfo_len;
  41. u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
  42. u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
  43. };
  44. #define SOPASS_MAX 6
  45. /* wake-on-lan settings */
  46. struct ethtool_wolinfo {
  47. u32 cmd;
  48. u32 supported;
  49. u32 wolopts;
  50. u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
  51. };
  52. /* for passing single values */
  53. struct ethtool_value {
  54. u32 cmd;
  55. u32 data;
  56. };
  57. /* for passing big chunks of data */
  58. struct ethtool_regs {
  59. u32 cmd;
  60. u32 version; /* driver-specific, indicates different chips/revs */
  61. u32 len; /* bytes */
  62. u8 data[0];
  63. };
  64. /* for passing EEPROM chunks */
  65. struct ethtool_eeprom {
  66. u32 cmd;
  67. u32 magic;
  68. u32 offset; /* in bytes */
  69. u32 len; /* in bytes */
  70. u8 data[0];
  71. };
  72. /* for configuring coalescing parameters of chip */
  73. struct ethtool_coalesce {
  74. u32 cmd; /* ETHTOOL_{G,S}COALESCE */
  75. /* How many usecs to delay an RX interrupt after
  76.  * a packet arrives.  If 0, only rx_max_coalesced_frames
  77.  * is used.
  78.  */
  79. u32 rx_coalesce_usecs;
  80. /* How many packets to delay an RX interrupt after
  81.  * a packet arrives.  If 0, only rx_coalesce_usecs is
  82.  * used.  It is illegal to set both usecs and max frames
  83.  * to zero as this would cause RX interrupts to never be
  84.  * generated.
  85.  */
  86. u32 rx_max_coalesced_frames;
  87. /* Same as above two parameters, except that these values
  88.  * apply while an IRQ is being serviced by the host.  Not
  89.  * all cards support this feature and the values are ignored
  90.  * in that case.
  91.  */
  92. u32 rx_coalesce_usecs_irq;
  93. u32 rx_max_coalesced_frames_irq;
  94. /* How many usecs to delay a TX interrupt after
  95.  * a packet is sent.  If 0, only tx_max_coalesced_frames
  96.  * is used.
  97.  */
  98. u32 tx_coalesce_usecs;
  99. /* How many packets to delay a TX interrupt after
  100.  * a packet is sent.  If 0, only tx_coalesce_usecs is
  101.  * used.  It is illegal to set both usecs and max frames
  102.  * to zero as this would cause TX interrupts to never be
  103.  * generated.
  104.  */
  105. u32 tx_max_coalesced_frames;
  106. /* Same as above two parameters, except that these values
  107.  * apply while an IRQ is being serviced by the host.  Not
  108.  * all cards support this feature and the values are ignored
  109.  * in that case.
  110.  */
  111. u32 tx_coalesce_usecs_irq;
  112. u32 tx_max_coalesced_frames_irq;
  113. /* How many usecs to delay in-memory statistics
  114.  * block updates.  Some drivers do not have an in-memory
  115.  * statistic block, and in such cases this value is ignored.
  116.  * This value must not be zero.
  117.  */
  118. u32 stats_block_coalesce_usecs;
  119. /* Adaptive RX/TX coalescing is an algorithm implemented by
  120.  * some drivers to improve latency under low packet rates and
  121.  * improve throughput under high packet rates.  Some drivers
  122.  * only implement one of RX or TX adaptive coalescing.  Anything
  123.  * not implemented by the driver causes these values to be
  124.  * silently ignored.
  125.  */
  126. u32 use_adaptive_rx_coalesce;
  127. u32 use_adaptive_tx_coalesce;
  128. /* When the packet rate (measured in packets per second)
  129.  * is below pkt_rate_low, the {rx,tx}_*_low parameters are
  130.  * used.
  131.  */
  132. u32 pkt_rate_low;
  133. u32 rx_coalesce_usecs_low;
  134. u32 rx_max_coalesced_frames_low;
  135. u32 tx_coalesce_usecs_low;
  136. u32 tx_max_coalesced_frames_low;
  137. /* When the packet rate is below pkt_rate_high but above
  138.  * pkt_rate_low (both measured in packets per second) the
  139.  * normal {rx,tx}_* coalescing parameters are used.
  140.  */
  141. /* When the packet rate is (measured in packets per second)
  142.  * is above pkt_rate_high, the {rx,tx}_*_high parameters are
  143.  * used.
  144.  */
  145. u32 pkt_rate_high;
  146. u32 rx_coalesce_usecs_high;
  147. u32 rx_max_coalesced_frames_high;
  148. u32 tx_coalesce_usecs_high;
  149. u32 tx_max_coalesced_frames_high;
  150. /* How often to do adaptive coalescing packet rate sampling,
  151.  * measured in seconds.  Must not be zero.
  152.  */
  153. u32 rate_sample_interval;
  154. };
  155. /* for configuring RX/TX ring parameters */
  156. struct ethtool_ringparam {
  157. u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
  158. /* Read only attributes.  These indicate the maximum number
  159.  * of pending RX/TX ring entries the driver will allow the
  160.  * user to set.
  161.  */
  162. u32 rx_max_pending;
  163. u32 rx_mini_max_pending;
  164. u32 rx_jumbo_max_pending;
  165. u32 tx_max_pending;
  166. /* Values changeable by the user.  The valid values are
  167.  * in the range 1 to the "*_max_pending" counterpart above.
  168.  */
  169. u32 rx_pending;
  170. u32 rx_mini_pending;
  171. u32 rx_jumbo_pending;
  172. u32 tx_pending;
  173. };
  174. /* for configuring link flow control parameters */
  175. struct ethtool_pauseparam {
  176. u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
  177. /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
  178.  * being true) the user may set 'autonet' here non-zero to have the
  179.  * pause parameters be auto-negotiated too.  In such a case, the
  180.  * {rx,tx}_pause values below determine what capabilities are
  181.  * advertised.
  182.  *
  183.  * If 'autoneg' is zero or the link is not being auto-negotiated,
  184.  * then {rx,tx}_pause force the driver to use/not-use pause
  185.  * flow control.
  186.  */
  187. u32 autoneg;
  188. u32 rx_pause;
  189. u32 tx_pause;
  190. };
  191. #define ETH_GSTRING_LEN 32
  192. enum ethtool_stringset {
  193. ETH_SS_TEST = 0,
  194. ETH_SS_STATS,
  195. };
  196. /* for passing string sets for data tagging */
  197. struct ethtool_gstrings {
  198. u32 cmd; /* ETHTOOL_GSTRINGS */
  199. u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
  200. u32 len; /* number of strings in the string set */
  201. u8 data[0];
  202. };
  203. enum ethtool_test_flags {
  204. ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
  205. ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
  206. };
  207. /* for requesting NIC test and getting results*/
  208. struct ethtool_test {
  209. u32 cmd; /* ETHTOOL_TEST */
  210. u32 flags; /* ETH_TEST_FL_xxx */
  211. u32 reserved;
  212. u32 len; /* result length, in number of u64 elements */
  213. u64 data[0];
  214. };
  215. /* for dumping NIC-specific statistics */
  216. struct ethtool_stats {
  217. u32 cmd; /* ETHTOOL_GSTATS */
  218. u32 n_stats; /* number of u64's being returned */
  219. u64 data[0];
  220. };
  221. struct ethtool_perm_addr {
  222. u32 cmd; /* ETHTOOL_GPERMADDR */
  223. u32 size;
  224. u8 data[0];
  225. };
  226. struct net_device;
  227. /* Some generic methods drivers may use in their ethtool_ops */
  228. u32 ethtool_op_get_link(struct net_device *dev);
  229. u32 ethtool_op_get_tx_csum(struct net_device *dev);
  230. int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
  231. int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
  232. u32 ethtool_op_get_sg(struct net_device *dev);
  233. int ethtool_op_set_sg(struct net_device *dev, u32 data);
  234. u32 ethtool_op_get_tso(struct net_device *dev);
  235. int ethtool_op_set_tso(struct net_device *dev, u32 data);
  236. int ethtool_op_get_perm_addr(struct net_device *dev, 
  237.      struct ethtool_perm_addr *addr, u8 *data);
  238. /**
  239.  * &ethtool_ops - Alter and report network device settings
  240.  * get_settings: Get device-specific settings
  241.  * set_settings: Set device-specific settings
  242.  * get_drvinfo: Report driver information
  243.  * get_regs: Get device registers
  244.  * get_wol: Report whether Wake-on-Lan is enabled
  245.  * set_wol: Turn Wake-on-Lan on or off
  246.  * get_msglevel: Report driver message level
  247.  * set_msglevel: Set driver message level
  248.  * nway_reset: Restart autonegotiation
  249.  * get_link: Get link status
  250.  * get_eeprom: Read data from the device EEPROM
  251.  * set_eeprom: Write data to the device EEPROM
  252.  * get_coalesce: Get interrupt coalescing parameters
  253.  * set_coalesce: Set interrupt coalescing parameters
  254.  * get_ringparam: Report ring sizes
  255.  * set_ringparam: Set ring sizes
  256.  * get_pauseparam: Report pause parameters
  257.  * set_pauseparam: Set pause paramters
  258.  * get_rx_csum: Report whether receive checksums are turned on or off
  259.  * set_rx_csum: Turn receive checksum on or off
  260.  * get_tx_csum: Report whether transmit checksums are turned on or off
  261.  * set_tx_csum: Turn transmit checksums on or off
  262.  * get_sg: Report whether scatter-gather is enabled
  263.  * set_sg: Turn scatter-gather on or off
  264.  * get_tso: Report whether TCP segmentation offload is enabled
  265.  * set_tso: Turn TCP segmentation offload on or off
  266.  * self_test: Run specified self-tests
  267.  * get_strings: Return a set of strings that describe the requested objects 
  268.  * phys_id: Identify the device
  269.  * get_stats: Return statistics about the device
  270.  * get_perm_addr: Gets the permanent hardware address
  271.  * 
  272.  * Description:
  273.  *
  274.  * get_settings:
  275.  * @get_settings is passed an &ethtool_cmd to fill in.  It returns
  276.  * an negative errno or zero.
  277.  *
  278.  * set_settings:
  279.  * @set_settings is passed an &ethtool_cmd and should attempt to set
  280.  * all the settings this device supports.  It may return an error value
  281.  * if something goes wrong (otherwise 0).
  282.  *
  283.  * get_eeprom:
  284.  * Should fill in the magic field.  Don't need to check len for zero
  285.  * or wraparound.  Fill in the data argument with the eeprom values
  286.  * from offset to offset + len.  Update len to the amount read.
  287.  * Returns an error or zero.
  288.  *
  289.  * set_eeprom:
  290.  * Should validate the magic field.  Don't need to check len for zero
  291.  * or wraparound.  Update len to the amount written.  Returns an error
  292.  * or zero.
  293.  */
  294. struct ethtool_ops {
  295. int (*get_settings)(struct net_device *, struct ethtool_cmd *);
  296. int (*set_settings)(struct net_device *, struct ethtool_cmd *);
  297. void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
  298. int (*get_regs_len)(struct net_device *);
  299. void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
  300. void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
  301. int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
  302. u32 (*get_msglevel)(struct net_device *);
  303. void (*set_msglevel)(struct net_device *, u32);
  304. int (*nway_reset)(struct net_device *);
  305. u32 (*get_link)(struct net_device *);
  306. int (*get_eeprom_len)(struct net_device *);
  307. int (*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
  308. int (*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
  309. int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
  310. int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
  311. void (*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
  312. int (*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
  313. void (*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
  314. int (*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
  315. u32 (*get_rx_csum)(struct net_device *);
  316. int (*set_rx_csum)(struct net_device *, u32);
  317. u32 (*get_tx_csum)(struct net_device *);
  318. int (*set_tx_csum)(struct net_device *, u32);
  319. u32 (*get_sg)(struct net_device *);
  320. int (*set_sg)(struct net_device *, u32);
  321. u32 (*get_tso)(struct net_device *);
  322. int (*set_tso)(struct net_device *, u32);
  323. int (*self_test_count)(struct net_device *);
  324. void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
  325. void (*get_strings)(struct net_device *, u32 stringset, u8 *);
  326. int (*phys_id)(struct net_device *, u32);
  327. int (*get_stats_count)(struct net_device *);
  328. void (*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
  329. int (*get_perm_addr)(struct net_device *, struct ethtool_perm_addr *, u8 *);
  330. int (*begin)(struct net_device *);
  331. void (*complete)(struct net_device *);
  332. };
  333. /* CMDs currently supported */
  334. #define ETHTOOL_GSET 0x00000001 /* Get settings. */
  335. #define ETHTOOL_SSET 0x00000002 /* Set settings. */
  336. #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
  337. #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
  338. #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
  339. #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
  340. #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
  341. #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
  342. #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
  343. #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
  344. #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
  345. #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
  346. #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
  347. #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
  348. #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
  349. #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
  350. #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
  351. #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
  352. #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
  353. #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
  354. #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
  355. #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
  356. #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
  357.     * (ethtool_value) */
  358. #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
  359.     * (ethtool_value). */
  360. #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
  361. #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
  362. #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
  363. #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
  364. #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
  365. #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
  366. #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
  367. /* compatibility with older code */
  368. #define SPARC_ETH_GSET ETHTOOL_GSET
  369. #define SPARC_ETH_SSET ETHTOOL_SSET
  370. /* Indicates what features are supported by the interface. */
  371. #define SUPPORTED_10baseT_Half (1 << 0)
  372. #define SUPPORTED_10baseT_Full (1 << 1)
  373. #define SUPPORTED_100baseT_Half (1 << 2)
  374. #define SUPPORTED_100baseT_Full (1 << 3)
  375. #define SUPPORTED_1000baseT_Half (1 << 4)
  376. #define SUPPORTED_1000baseT_Full (1 << 5)
  377. #define SUPPORTED_Autoneg (1 << 6)
  378. #define SUPPORTED_TP (1 << 7)
  379. #define SUPPORTED_AUI (1 << 8)
  380. #define SUPPORTED_MII (1 << 9)
  381. #define SUPPORTED_FIBRE (1 << 10)
  382. #define SUPPORTED_BNC (1 << 11)
  383. #define SUPPORTED_10000baseT_Full (1 << 12)
  384. #define SUPPORTED_Pause (1 << 13)
  385. #define SUPPORTED_Asym_Pause (1 << 14)
  386. /* Indicates what features are advertised by the interface. */
  387. #define ADVERTISED_10baseT_Half (1 << 0)
  388. #define ADVERTISED_10baseT_Full (1 << 1)
  389. #define ADVERTISED_100baseT_Half (1 << 2)
  390. #define ADVERTISED_100baseT_Full (1 << 3)
  391. #define ADVERTISED_1000baseT_Half (1 << 4)
  392. #define ADVERTISED_1000baseT_Full (1 << 5)
  393. #define ADVERTISED_Autoneg (1 << 6)
  394. #define ADVERTISED_TP (1 << 7)
  395. #define ADVERTISED_AUI (1 << 8)
  396. #define ADVERTISED_MII (1 << 9)
  397. #define ADVERTISED_FIBRE (1 << 10)
  398. #define ADVERTISED_BNC (1 << 11)
  399. #define ADVERTISED_10000baseT_Full (1 << 12)
  400. #define ADVERTISED_Pause (1 << 13)
  401. #define ADVERTISED_Asym_Pause (1 << 14)
  402. /* The following are all involved in forcing a particular link
  403.  * mode for the device for setting things.  When getting the
  404.  * devices settings, these indicate the current mode and whether
  405.  * it was foced up into this mode or autonegotiated.
  406.  */
  407. /* The forced speed, 10Mb, 100Mb, gigabit, 10GbE. */
  408. #define SPEED_10 10
  409. #define SPEED_100 100
  410. #define SPEED_1000 1000
  411. #define SPEED_10000 10000
  412. /* Duplex, half or full. */
  413. #define DUPLEX_HALF 0x00
  414. #define DUPLEX_FULL 0x01
  415. /* Which connector port. */
  416. #define PORT_TP 0x00
  417. #define PORT_AUI 0x01
  418. #define PORT_MII 0x02
  419. #define PORT_FIBRE 0x03
  420. #define PORT_BNC 0x04
  421. /* Which transceiver to use. */
  422. #define XCVR_INTERNAL 0x00
  423. #define XCVR_EXTERNAL 0x01
  424. #define XCVR_DUMMY1 0x02
  425. #define XCVR_DUMMY2 0x03
  426. #define XCVR_DUMMY3 0x04
  427. /* Enable or disable autonegotiation.  If this is set to enable,
  428.  * the forced link modes above are completely ignored.
  429.  */
  430. #define AUTONEG_DISABLE 0x00
  431. #define AUTONEG_ENABLE 0x01
  432. /* Wake-On-Lan options. */
  433. #define WAKE_PHY (1 << 0)
  434. #define WAKE_UCAST (1 << 1)
  435. #define WAKE_MCAST (1 << 2)
  436. #define WAKE_BCAST (1 << 3)
  437. #define WAKE_ARP (1 << 4)
  438. #define WAKE_MAGIC (1 << 5)
  439. #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
  440. #endif /* _LINUX_ETHTOOL_H */