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 12 #ifndef _LINUX_ETHTOOL_H 13 #define _LINUX_ETHTOOL_H 14 15 #include <linux/types.h> 16 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]; 31 }; 32 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) */ 49 }; 50 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 */ 58 }; 59 60 /* for passing single values */ 61 struct ethtool_value { 62 __u32 cmd; 63 __u32 data; 64 }; 65 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]; 72 }; 73 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]; 81 }; 82 83 /* for configuring coalescing parameters of chip */ 84 struct ethtool_coalesce { 85 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */ 86 87 /* How many usecs to delay an RX interrupt after 88 * a packet arrives. If 0, only rx_max_coalesced_frames 89 * is used. 90 */ 91 __u32 rx_coalesce_usecs; 92 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. 98 */ 99 __u32 rx_max_coalesced_frames; 100 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. 105 */ 106 __u32 rx_coalesce_usecs_irq; 107 __u32 rx_max_coalesced_frames_irq; 108 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. 112 */ 113 __u32 tx_coalesce_usecs; 114 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. 120 */ 121 __u32 tx_max_coalesced_frames; 122 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. 127 */ 128 __u32 tx_coalesce_usecs_irq; 129 __u32 tx_max_coalesced_frames_irq; 130 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. 135 */ 136 __u32 stats_block_coalesce_usecs; 137 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. 144 */ 145 __u32 use_adaptive_rx_coalesce; 146 __u32 use_adaptive_tx_coalesce; 147 148 /* When the packet rate (measured in packets per second) 149 * is below pkt_rate_low, the {rx,tx}_*_low parameters are 150 * used. 151 */ 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; 157 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. 161 */ 162 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. 166 */ 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; 172 173 /* How often to do adaptive coalescing packet rate sampling, 174 * measured in seconds. Must not be zero. 175 */ 176 __u32 rate_sample_interval; 177 }; 178 179 /* for configuring RX/TX ring parameters */ 180 struct ethtool_ringparam { 181 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */ 182 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. 186 */ 187 __u32 rx_max_pending; 188 __u32 rx_mini_max_pending; 189 __u32 rx_jumbo_max_pending; 190 __u32 tx_max_pending; 191 192 /* Values changeable by the user. The valid values are 193 * in the range 1 to the "*_max_pending" counterpart above. 194 */ 195 __u32 rx_pending; 196 __u32 rx_mini_pending; 197 __u32 rx_jumbo_pending; 198 __u32 tx_pending; 199 }; 200 201 /* for configuring link flow control parameters */ 202 struct ethtool_pauseparam { 203 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */ 204 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. 210 * 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. 214 */ 215 __u32 autoneg; 216 __u32 rx_pause; 217 __u32 tx_pause; 218 }; 219 220 #define ETH_GSTRING_LEN 32 221 enum ethtool_stringset { 222 ETH_SS_TEST = 0, 223 ETH_SS_STATS, 224 ETH_SS_PRIV_FLAGS, 225 }; 226 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]; 233 }; 234 235 enum ethtool_test_flags { 236 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */ 237 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */ 238 }; 239 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]; 247 }; 248 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]; 254 }; 255 256 struct ethtool_perm_addr { 257 __u32 cmd; /* ETHTOOL_GPERMADDR */ 258 __u32 size; 259 __u8 data[0]; 260 }; 261 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. 266 * 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. 270 */ 271 enum ethtool_flags { 272 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 273 }; 274 275 276 /* CMDs currently supported */ 277 #define ETHTOOL_GSET 0x00000001 /* Get settings. */ 278 #define ETHTOOL_SSET 0x00000002 /* Set settings. */ 279 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 280 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 281 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 282 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 283 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 284 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 285 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 286 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */ 287 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 288 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 289 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 290 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 291 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 292 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 293 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 294 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 295 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 296 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 297 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 298 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 299 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 300 * (ethtool_value) */ 301 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 302 * (ethtool_value). */ 303 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 304 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 305 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 306 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 307 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 308 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 309 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 310 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 311 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 312 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 313 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 314 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 315 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 316 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 317 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 318 319 /* compatibility with older code */ 320 #define SPARC_ETH_GSET ETHTOOL_GSET 321 #define SPARC_ETH_SSET ETHTOOL_SSET 322 323 /* Indicates what features are supported by the interface. */ 324 #define SUPPORTED_10baseT_Half (1 << 0) 325 #define SUPPORTED_10baseT_Full (1 << 1) 326 #define SUPPORTED_100baseT_Half (1 << 2) 327 #define SUPPORTED_100baseT_Full (1 << 3) 328 #define SUPPORTED_1000baseT_Half (1 << 4) 329 #define SUPPORTED_1000baseT_Full (1 << 5) 330 #define SUPPORTED_Autoneg (1 << 6) 331 #define SUPPORTED_TP (1 << 7) 332 #define SUPPORTED_AUI (1 << 8) 333 #define SUPPORTED_MII (1 << 9) 334 #define SUPPORTED_FIBRE (1 << 10) 335 #define SUPPORTED_BNC (1 << 11) 336 #define SUPPORTED_10000baseT_Full (1 << 12) 337 #define SUPPORTED_Pause (1 << 13) 338 #define SUPPORTED_Asym_Pause (1 << 14) 339 #define SUPPORTED_2500baseX_Full (1 << 15) 340 341 /* Indicates what features are advertised by the interface. */ 342 #define ADVERTISED_10baseT_Half (1 << 0) 343 #define ADVERTISED_10baseT_Full (1 << 1) 344 #define ADVERTISED_100baseT_Half (1 << 2) 345 #define ADVERTISED_100baseT_Full (1 << 3) 346 #define ADVERTISED_1000baseT_Half (1 << 4) 347 #define ADVERTISED_1000baseT_Full (1 << 5) 348 #define ADVERTISED_Autoneg (1 << 6) 349 #define ADVERTISED_TP (1 << 7) 350 #define ADVERTISED_AUI (1 << 8) 351 #define ADVERTISED_MII (1 << 9) 352 #define ADVERTISED_FIBRE (1 << 10) 353 #define ADVERTISED_BNC (1 << 11) 354 #define ADVERTISED_10000baseT_Full (1 << 12) 355 #define ADVERTISED_Pause (1 << 13) 356 #define ADVERTISED_Asym_Pause (1 << 14) 357 #define ADVERTISED_2500baseX_Full (1 << 15) 358 359 /* The following are all involved in forcing a particular link 360 * mode for the device for setting things. When getting the 361 * devices settings, these indicate the current mode and whether 362 * it was foced up into this mode or autonegotiated. 363 */ 364 365 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */ 366 #define SPEED_10 10 367 #define SPEED_100 100 368 #define SPEED_1000 1000 369 #define SPEED_2500 2500 370 #define SPEED_10000 10000 371 372 /* Duplex, half or full. */ 373 #define DUPLEX_HALF 0x00 374 #define DUPLEX_FULL 0x01 375 376 /* Which connector port. */ 377 #define PORT_TP 0x00 378 #define PORT_AUI 0x01 379 #define PORT_MII 0x02 380 #define PORT_FIBRE 0x03 381 #define PORT_BNC 0x04 382 383 /* Which transceiver to use. */ 384 #define XCVR_INTERNAL 0x00 385 #define XCVR_EXTERNAL 0x01 386 #define XCVR_DUMMY1 0x02 387 #define XCVR_DUMMY2 0x03 388 #define XCVR_DUMMY3 0x04 389 390 /* Enable or disable autonegotiation. If this is set to enable, 391 * the forced link modes above are completely ignored. 392 */ 393 #define AUTONEG_DISABLE 0x00 394 #define AUTONEG_ENABLE 0x01 395 396 /* Wake-On-Lan options. */ 397 #define WAKE_PHY (1 << 0) 398 #define WAKE_UCAST (1 << 1) 399 #define WAKE_MCAST (1 << 2) 400 #define WAKE_BCAST (1 << 3) 401 #define WAKE_ARP (1 << 4) 402 #define WAKE_MAGIC (1 << 5) 403 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 404 405 #endif /* _LINUX_ETHTOOL_H */ 406