1 /* 2 * ethtool.h: Defines for Linux ethtool. 3 * 4 * Copyright (C) 1998 David S. Miller (davem (at) redhat.com) 5 * Copyright 2001 Jeff Garzik <jgarzik (at) pobox.com> 6 * Portions Copyright 2001 Sun Microsystems (thockin (at) sun.com) 7 * Portions Copyright 2002 Intel (eli.kupermann (at) intel.com, 8 * christopher.leech (at) intel.com, 9 * scott.feldman (at) intel.com) 10 */ 11 12 #ifndef _LINUX_ETHTOOL_H 13 #define _LINUX_ETHTOOL_H 14 15 16 /* This should work for both 32 and 64 bit userland. */ 17 struct ethtool_cmd { 18 __u32 cmd; 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 */ 24 __u8 phy_address; 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 */ 29 __u32 reserved[4]; 30 }; 31 32 #define ETHTOOL_BUSINFO_LEN 32 33 /* these strings are set to whatever the driver author decides... */ 34 struct ethtool_drvinfo { 35 __u32 cmd; 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). */ 41 char reserved1[32]; 42 char reserved2[12]; 43 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */ 44 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */ 45 __u32 testinfo_len; 46 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */ 47 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */ 48 }; 49 50 #define SOPASS_MAX 6 51 /* wake-on-lan settings */ 52 struct ethtool_wolinfo { 53 __u32 cmd; 54 __u32 supported; 55 __u32 wolopts; 56 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */ 57 }; 58 59 /* for passing single values */ 60 struct ethtool_value { 61 __u32 cmd; 62 __u32 data; 63 }; 64 65 /* for passing big chunks of data */ 66 struct ethtool_regs { 67 __u32 cmd; 68 __u32 version; /* driver-specific, indicates different chips/revs */ 69 __u32 len; /* bytes */ 70 __u8 data[0]; 71 }; 72 73 /* for passing EEPROM chunks */ 74 struct ethtool_eeprom { 75 __u32 cmd; 76 __u32 magic; 77 __u32 offset; /* in bytes */ 78 __u32 len; /* in bytes */ 79 __u8 data[0]; 80 }; 81 82 /* for configuring coalescing parameters of chip */ 83 struct ethtool_coalesce { 84 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */ 85 86 /* How many usecs to delay an RX interrupt after 87 * a packet arrives. If 0, only rx_max_coalesced_frames 88 * is used. 89 */ 90 __u32 rx_coalesce_usecs; 91 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 96 * generated. 97 */ 98 __u32 rx_max_coalesced_frames; 99 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 103 * in that case. 104 */ 105 __u32 rx_coalesce_usecs_irq; 106 __u32 rx_max_coalesced_frames_irq; 107 108 /* How many usecs to delay a TX interrupt after 109 * a packet is sent. If 0, only tx_max_coalesced_frames 110 * is used. 111 */ 112 __u32 tx_coalesce_usecs; 113 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 118 * generated. 119 */ 120 __u32 tx_max_coalesced_frames; 121 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 125 * in that case. 126 */ 127 __u32 tx_coalesce_usecs_irq; 128 __u32 tx_max_coalesced_frames_irq; 129 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. 134 */ 135 __u32 stats_block_coalesce_usecs; 136 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 142 * silently ignored. 143 */ 144 __u32 use_adaptive_rx_coalesce; 145 __u32 use_adaptive_tx_coalesce; 146 147 /* When the packet rate (measured in packets per second) 148 * is below pkt_rate_low, the {rx,tx}_*_low parameters are 149 * used. 150 */ 151 __u32 pkt_rate_low; 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; 156 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. 160 */ 161 162 /* When the packet rate is (measured in packets per second) 163 * is above pkt_rate_high, the {rx,tx}_*_high parameters are 164 * used. 165 */ 166 __u32 pkt_rate_high; 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; 171 172 /* How often to do adaptive coalescing packet rate sampling, 173 * measured in seconds. Must not be zero. 174 */ 175 __u32 rate_sample_interval; 176 }; 177 178 /* for configuring RX/TX ring parameters */ 179 struct ethtool_ringparam { 180 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */ 181 182 /* Read only attributes. These indicate the maximum number 183 * of pending RX/TX ring entries the driver will allow the 184 * user to set. 185 */ 186 __u32 rx_max_pending; 187 __u32 rx_mini_max_pending; 188 __u32 rx_jumbo_max_pending; 189 __u32 tx_max_pending; 190 191 /* Values changeable by the user. The valid values are 192 * in the range 1 to the "*_max_pending" counterpart above. 193 */ 194 __u32 rx_pending; 195 __u32 rx_mini_pending; 196 __u32 rx_jumbo_pending; 197 __u32 tx_pending; 198 }; 199 200 /* for configuring link flow control parameters */ 201 struct ethtool_pauseparam { 202 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */ 203 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 208 * advertised. 209 * 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 212 * flow control. 213 */ 214 __u32 autoneg; 215 __u32 rx_pause; 216 __u32 tx_pause; 217 }; 218 219 #define ETH_GSTRING_LEN 32 220 enum ethtool_stringset { 221 ETH_SS_TEST = 0, 222 ETH_SS_STATS, 223 ETH_SS_PRIV_FLAGS, 224 }; 225 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 */ 231 __u8 data[0]; 232 }; 233 234 enum ethtool_test_flags { 235 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */ 236 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */ 237 }; 238 239 /* for requesting NIC test and getting results*/ 240 struct ethtool_test { 241 __u32 cmd; /* ETHTOOL_TEST */ 242 __u32 flags; /* ETH_TEST_FL_xxx */ 243 __u32 reserved; 244 __u32 len; /* result length, in number of u64 elements */ 245 __u64 data[0]; 246 }; 247 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 */ 252 __u64 data[0]; 253 }; 254 255 struct ethtool_perm_addr { 256 __u32 cmd; /* ETHTOOL_GPERMADDR */ 257 __u32 size; 258 __u8 data[0]; 259 }; 260 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. 265 * 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. 269 */ 270 enum ethtool_flags { 271 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 272 }; 273 274 275 /* CMDs currently supported */ 276 #define ETHTOOL_GSET 0x00000001 /* Get settings. */ 277 #define ETHTOOL_SSET 0x00000002 /* Set settings. */ 278 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 279 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 280 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 281 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 282 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 283 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 284 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 285 #define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */ 286 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 287 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 288 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 289 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 290 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 291 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 292 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 293 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 294 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 295 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 296 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 297 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 298 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 299 * (ethtool_value) */ 300 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 301 * (ethtool_value). */ 302 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 303 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 304 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 305 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 306 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 307 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 308 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 309 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 310 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 311 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 312 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 313 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 314 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 315 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 316 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 317 318 /* compatibility with older code */ 319 #define SPARC_ETH_GSET ETHTOOL_GSET 320 #define SPARC_ETH_SSET ETHTOOL_SSET 321 322 /* Indicates what features are supported by the interface. */ 323 #define SUPPORTED_10baseT_Half (1 << 0) 324 #define SUPPORTED_10baseT_Full (1 << 1) 325 #define SUPPORTED_100baseT_Half (1 << 2) 326 #define SUPPORTED_100baseT_Full (1 << 3) 327 #define SUPPORTED_1000baseT_Half (1 << 4) 328 #define SUPPORTED_1000baseT_Full (1 << 5) 329 #define SUPPORTED_Autoneg (1 << 6) 330 #define SUPPORTED_TP (1 << 7) 331 #define SUPPORTED_AUI (1 << 8) 332 #define SUPPORTED_MII (1 << 9) 333 #define SUPPORTED_FIBRE (1 << 10) 334 #define SUPPORTED_BNC (1 << 11) 335 #define SUPPORTED_10000baseT_Full (1 << 12) 336 #define SUPPORTED_Pause (1 << 13) 337 #define SUPPORTED_Asym_Pause (1 << 14) 338 #define SUPPORTED_2500baseX_Full (1 << 15) 339 340 /* Indicates what features are advertised by the interface. */ 341 #define ADVERTISED_10baseT_Half (1 << 0) 342 #define ADVERTISED_10baseT_Full (1 << 1) 343 #define ADVERTISED_100baseT_Half (1 << 2) 344 #define ADVERTISED_100baseT_Full (1 << 3) 345 #define ADVERTISED_1000baseT_Half (1 << 4) 346 #define ADVERTISED_1000baseT_Full (1 << 5) 347 #define ADVERTISED_Autoneg (1 << 6) 348 #define ADVERTISED_TP (1 << 7) 349 #define ADVERTISED_AUI (1 << 8) 350 #define ADVERTISED_MII (1 << 9) 351 #define ADVERTISED_FIBRE (1 << 10) 352 #define ADVERTISED_BNC (1 << 11) 353 #define ADVERTISED_10000baseT_Full (1 << 12) 354 #define ADVERTISED_Pause (1 << 13) 355 #define ADVERTISED_Asym_Pause (1 << 14) 356 #define ADVERTISED_2500baseX_Full (1 << 15) 357 358 /* The following are all involved in forcing a particular link 359 * mode for the device for setting things. When getting the 360 * devices settings, these indicate the current mode and whether 361 * it was foced up into this mode or autonegotiated. 362 */ 363 364 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */ 365 #define SPEED_10 10 366 #define SPEED_100 100 367 #define SPEED_1000 1000 368 #define SPEED_2500 2500 369 #define SPEED_10000 10000 370 371 /* Duplex, half or full. */ 372 #define DUPLEX_HALF 0x00 373 #define DUPLEX_FULL 0x01 374 375 /* Which connector port. */ 376 #define PORT_TP 0x00 377 #define PORT_AUI 0x01 378 #define PORT_MII 0x02 379 #define PORT_FIBRE 0x03 380 #define PORT_BNC 0x04 381 382 /* Which transceiver to use. */ 383 #define XCVR_INTERNAL 0x00 384 #define XCVR_EXTERNAL 0x01 385 #define XCVR_DUMMY1 0x02 386 #define XCVR_DUMMY2 0x03 387 #define XCVR_DUMMY3 0x04 388 389 /* Enable or disable autonegotiation. If this is set to enable, 390 * the forced link modes above are completely ignored. 391 */ 392 #define AUTONEG_DISABLE 0x00 393 #define AUTONEG_ENABLE 0x01 394 395 /* Wake-On-Lan options. */ 396 #define WAKE_PHY (1 << 0) 397 #define WAKE_UCAST (1 << 1) 398 #define WAKE_MCAST (1 << 2) 399 #define WAKE_BCAST (1 << 3) 400 #define WAKE_ARP (1 << 4) 401 #define WAKE_MAGIC (1 << 5) 402 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 403 404 #endif /* _LINUX_ETHTOOL_H */ 405
