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 * Portions Copyright (C) Sun Microsystems 2008 11 */ 12 13 #ifndef _UAPI_LINUX_ETHTOOL_H 14 #define _UAPI_LINUX_ETHTOOL_H 15 16 #include <linux/types.h> 17 #include <linux/if_ether.h> 18 19 /* All structures exposed to userland should be defined such that they 20 * have the same layout for 32-bit and 64-bit userland. 21 */ 22 23 /** 24 * struct ethtool_cmd - link control and status 25 * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET 26 * @supported: Bitmask of %SUPPORTED_* flags for the link modes, 27 * physical connectors and other link features for which the 28 * interface supports autonegotiation or auto-detection. 29 * Read-only. 30 * @advertising: Bitmask of %ADVERTISED_* flags for the link modes, 31 * physical connectors and other link features that are 32 * advertised through autonegotiation or enabled for 33 * auto-detection. 34 * @speed: Low bits of the speed 35 * @duplex: Duplex mode; one of %DUPLEX_* 36 * @port: Physical connector type; one of %PORT_* 37 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not 38 * applicable. For clause 45 PHYs this is the PRTAD. 39 * @transceiver: Historically used to distinguish different possible 40 * PHY types, but not in a consistent way. Deprecated. 41 * @autoneg: Enable/disable autonegotiation and auto-detection; 42 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE 43 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO 44 * protocols supported by the interface; 0 if unknown. 45 * Read-only. 46 * @maxtxpkt: Historically used to report TX IRQ coalescing; now 47 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. 48 * @maxrxpkt: Historically used to report RX IRQ coalescing; now 49 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. 50 * @speed_hi: High bits of the speed 51 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of 52 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the 53 * value will be %ETH_TP_MDI_INVALID. Read-only. 54 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of 55 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads 56 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. 57 * When written successfully, the link should be renegotiated if 58 * necessary. 59 * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes 60 * and other link features that the link partner advertised 61 * through autonegotiation; 0 if unknown or not applicable. 62 * Read-only. 63 * 64 * The link speed in Mbps is split between @speed and @speed_hi. Use 65 * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to 66 * access it. 67 * 68 * If autonegotiation is disabled, the speed and @duplex represent the 69 * fixed link mode and are writable if the driver supports multiple 70 * link modes. If it is enabled then they are read-only; if the link 71 * is up they represent the negotiated link mode; if the link is down, 72 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and 73 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. 74 * 75 * Some hardware interfaces may have multiple PHYs and/or physical 76 * connectors fitted or do not allow the driver to detect which are 77 * fitted. For these interfaces @port and/or @phy_address may be 78 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. 79 * Otherwise, attempts to write different values may be ignored or 80 * rejected. 81 * 82 * Users should assume that all fields not marked read-only are 83 * writable and subject to validation by the driver. They should use 84 * %ETHTOOL_GSET to get the current values before making specific 85 * changes and then applying them with %ETHTOOL_SSET. 86 * 87 * Drivers that implement set_settings() should validate all fields 88 * other than @cmd that are not described as read-only or deprecated, 89 * and must ignore all fields described as read-only. 90 * 91 * Deprecated fields should be ignored by both users and drivers. 92 */ 93 struct ethtool_cmd { 94 __u32 cmd; 95 __u32 supported; 96 __u32 advertising; 97 __u16 speed; 98 __u8 duplex; 99 __u8 port; 100 __u8 phy_address; 101 __u8 transceiver; 102 __u8 autoneg; 103 __u8 mdio_support; 104 __u32 maxtxpkt; 105 __u32 maxrxpkt; 106 __u16 speed_hi; 107 __u8 eth_tp_mdix; 108 __u8 eth_tp_mdix_ctrl; 109 __u32 lp_advertising; 110 __u32 reserved[2]; 111 }; 112 113 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep, 114 __u32 speed) 115 { 116 117 ep->speed = (__u16)speed; 118 ep->speed_hi = (__u16)(speed >> 16); 119 } 120 121 static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep) 122 { 123 return (ep->speed_hi << 16) | ep->speed; 124 } 125 126 /* Device supports clause 22 register access to PHY or peripherals 127 * using the interface defined in <linux/mii.h>. This should not be 128 * set if there are known to be no such peripherals present or if 129 * the driver only emulates clause 22 registers for compatibility. 130 */ 131 #define ETH_MDIO_SUPPORTS_C22 1 132 133 /* Device supports clause 45 register access to PHY or peripherals 134 * using the interface defined in <linux/mii.h> and <linux/mdio.h>. 135 * This should not be set if there are known to be no such peripherals 136 * present. 137 */ 138 #define ETH_MDIO_SUPPORTS_C45 2 139 140 #define ETHTOOL_FWVERS_LEN 32 141 #define ETHTOOL_BUSINFO_LEN 32 142 143 /** 144 * struct ethtool_drvinfo - general driver and device information 145 * @cmd: Command number = %ETHTOOL_GDRVINFO 146 * @driver: Driver short name. This should normally match the name 147 * in its bus driver structure (e.g. pci_driver::name). Must 148 * not be an empty string. 149 * @version: Driver version string; may be an empty string 150 * @fw_version: Firmware version string; may be an empty string 151 * @bus_info: Device bus address. This should match the dev_name() 152 * string for the underlying bus device, if there is one. May be 153 * an empty string. 154 * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and 155 * %ETHTOOL_SPFLAGS commands; also the number of strings in the 156 * %ETH_SS_PRIV_FLAGS set 157 * @n_stats: Number of u64 statistics returned by the %ETHTOOL_GSTATS 158 * command; also the number of strings in the %ETH_SS_STATS set 159 * @testinfo_len: Number of results returned by the %ETHTOOL_TEST 160 * command; also the number of strings in the %ETH_SS_TEST set 161 * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM 162 * and %ETHTOOL_SEEPROM commands, in bytes 163 * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS 164 * command, in bytes 165 * 166 * Users can use the %ETHTOOL_GSSET_INFO command to get the number of 167 * strings in any string set (from Linux 2.6.34). 168 * 169 * Drivers should set at most @driver, @version, @fw_version and 170 * @bus_info in their get_drvinfo() implementation. The ethtool 171 * core fills in the other fields using other driver operations. 172 */ 173 struct ethtool_drvinfo { 174 __u32 cmd; 175 char driver[32]; 176 char version[32]; 177 char fw_version[ETHTOOL_FWVERS_LEN]; 178 char bus_info[ETHTOOL_BUSINFO_LEN]; 179 char reserved1[32]; 180 char reserved2[12]; 181 __u32 n_priv_flags; 182 __u32 n_stats; 183 __u32 testinfo_len; 184 __u32 eedump_len; 185 __u32 regdump_len; 186 }; 187 188 #define SOPASS_MAX 6 189 190 /** 191 * struct ethtool_wolinfo - Wake-On-Lan configuration 192 * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL 193 * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes. 194 * Read-only. 195 * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes. 196 * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE 197 * is set in @wolopts. 198 */ 199 struct ethtool_wolinfo { 200 __u32 cmd; 201 __u32 supported; 202 __u32 wolopts; 203 __u8 sopass[SOPASS_MAX]; 204 }; 205 206 /* for passing single values */ 207 struct ethtool_value { 208 __u32 cmd; 209 __u32 data; 210 }; 211 212 enum tunable_id { 213 ETHTOOL_ID_UNSPEC, 214 ETHTOOL_RX_COPYBREAK, 215 ETHTOOL_TX_COPYBREAK, 216 }; 217 218 enum tunable_type_id { 219 ETHTOOL_TUNABLE_UNSPEC, 220 ETHTOOL_TUNABLE_U8, 221 ETHTOOL_TUNABLE_U16, 222 ETHTOOL_TUNABLE_U32, 223 ETHTOOL_TUNABLE_U64, 224 ETHTOOL_TUNABLE_STRING, 225 ETHTOOL_TUNABLE_S8, 226 ETHTOOL_TUNABLE_S16, 227 ETHTOOL_TUNABLE_S32, 228 ETHTOOL_TUNABLE_S64, 229 }; 230 231 struct ethtool_tunable { 232 __u32 cmd; 233 __u32 id; 234 __u32 type_id; 235 __u32 len; 236 void *data[0]; 237 }; 238 239 /** 240 * struct ethtool_regs - hardware register dump 241 * @cmd: Command number = %ETHTOOL_GREGS 242 * @version: Dump format version. This is driver-specific and may 243 * distinguish different chips/revisions. Drivers must use new 244 * version numbers whenever the dump format changes in an 245 * incompatible way. 246 * @len: On entry, the real length of @data. On return, the number of 247 * bytes used. 248 * @data: Buffer for the register dump 249 * 250 * Users should use %ETHTOOL_GDRVINFO to find the maximum length of 251 * a register dump for the interface. They must allocate the buffer 252 * immediately following this structure. 253 */ 254 struct ethtool_regs { 255 __u32 cmd; 256 __u32 version; 257 __u32 len; 258 __u8 data[0]; 259 }; 260 261 /** 262 * struct ethtool_eeprom - EEPROM dump 263 * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or 264 * %ETHTOOL_SEEPROM 265 * @magic: A 'magic cookie' value to guard against accidental changes. 266 * The value passed in to %ETHTOOL_SEEPROM must match the value 267 * returned by %ETHTOOL_GEEPROM for the same device. This is 268 * unused when @cmd is %ETHTOOL_GMODULEEEPROM. 269 * @offset: Offset within the EEPROM to begin reading/writing, in bytes 270 * @len: On entry, number of bytes to read/write. On successful 271 * return, number of bytes actually read/written. In case of 272 * error, this may indicate at what point the error occurred. 273 * @data: Buffer to read/write from 274 * 275 * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find 276 * the length of an on-board or module EEPROM, respectively. They 277 * must allocate the buffer immediately following this structure. 278 */ 279 struct ethtool_eeprom { 280 __u32 cmd; 281 __u32 magic; 282 __u32 offset; 283 __u32 len; 284 __u8 data[0]; 285 }; 286 287 /** 288 * struct ethtool_eee - Energy Efficient Ethernet information 289 * @cmd: ETHTOOL_{G,S}EEE 290 * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations 291 * for which there is EEE support. 292 * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations 293 * advertised as eee capable. 294 * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex 295 * combinations advertised by the link partner as eee capable. 296 * @eee_active: Result of the eee auto negotiation. 297 * @eee_enabled: EEE configured mode (enabled/disabled). 298 * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given 299 * that eee was negotiated. 300 * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting 301 * its tx lpi (after reaching 'idle' state). Effective only when eee 302 * was negotiated and tx_lpi_enabled was set. 303 */ 304 struct ethtool_eee { 305 __u32 cmd; 306 __u32 supported; 307 __u32 advertised; 308 __u32 lp_advertised; 309 __u32 eee_active; 310 __u32 eee_enabled; 311 __u32 tx_lpi_enabled; 312 __u32 tx_lpi_timer; 313 __u32 reserved[2]; 314 }; 315 316 /** 317 * struct ethtool_modinfo - plugin module eeprom information 318 * @cmd: %ETHTOOL_GMODULEINFO 319 * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx 320 * @eeprom_len: Length of the eeprom 321 * 322 * This structure is used to return the information to 323 * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM. 324 * The type code indicates the eeprom data format 325 */ 326 struct ethtool_modinfo { 327 __u32 cmd; 328 __u32 type; 329 __u32 eeprom_len; 330 __u32 reserved[8]; 331 }; 332 333 /** 334 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates 335 * @cmd: ETHTOOL_{G,S}COALESCE 336 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after 337 * a packet arrives. 338 * @rx_max_coalesced_frames: Maximum number of packets to receive 339 * before an RX interrupt. 340 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that 341 * this value applies while an IRQ is being serviced by the host. 342 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames, 343 * except that this value applies while an IRQ is being serviced 344 * by the host. 345 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after 346 * a packet is sent. 347 * @tx_max_coalesced_frames: Maximum number of packets to be sent 348 * before a TX interrupt. 349 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that 350 * this value applies while an IRQ is being serviced by the host. 351 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames, 352 * except that this value applies while an IRQ is being serviced 353 * by the host. 354 * @stats_block_coalesce_usecs: How many usecs to delay in-memory 355 * statistics block updates. Some drivers do not have an 356 * in-memory statistic block, and in such cases this value is 357 * ignored. This value must not be zero. 358 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing. 359 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing. 360 * @pkt_rate_low: Threshold for low packet rate (packets per second). 361 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after 362 * a packet arrives, when the packet rate is below @pkt_rate_low. 363 * @rx_max_coalesced_frames_low: Maximum number of packets to be received 364 * before an RX interrupt, when the packet rate is below @pkt_rate_low. 365 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after 366 * a packet is sent, when the packet rate is below @pkt_rate_low. 367 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before 368 * a TX interrupt, when the packet rate is below @pkt_rate_low. 369 * @pkt_rate_high: Threshold for high packet rate (packets per second). 370 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after 371 * a packet arrives, when the packet rate is above @pkt_rate_high. 372 * @rx_max_coalesced_frames_high: Maximum number of packets to be received 373 * before an RX interrupt, when the packet rate is above @pkt_rate_high. 374 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after 375 * a packet is sent, when the packet rate is above @pkt_rate_high. 376 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before 377 * a TX interrupt, when the packet rate is above @pkt_rate_high. 378 * @rate_sample_interval: How often to do adaptive coalescing packet rate 379 * sampling, measured in seconds. Must not be zero. 380 * 381 * Each pair of (usecs, max_frames) fields specifies that interrupts 382 * should be coalesced until 383 * (usecs > 0 && time_since_first_completion >= usecs) || 384 * (max_frames > 0 && completed_frames >= max_frames) 385 * 386 * It is illegal to set both usecs and max_frames to zero as this 387 * would cause interrupts to never be generated. To disable 388 * coalescing, set usecs = 0 and max_frames = 1. 389 * 390 * Some implementations ignore the value of max_frames and use the 391 * condition time_since_first_completion >= usecs 392 * 393 * This is deprecated. Drivers for hardware that does not support 394 * counting completions should validate that max_frames == !rx_usecs. 395 * 396 * Adaptive RX/TX coalescing is an algorithm implemented by some 397 * drivers to improve latency under low packet rates and improve 398 * throughput under high packet rates. Some drivers only implement 399 * one of RX or TX adaptive coalescing. Anything not implemented by 400 * the driver causes these values to be silently ignored. 401 * 402 * When the packet rate is below @pkt_rate_high but above 403 * @pkt_rate_low (both measured in packets per second) the 404 * normal {rx,tx}_* coalescing parameters are used. 405 */ 406 struct ethtool_coalesce { 407 __u32 cmd; 408 __u32 rx_coalesce_usecs; 409 __u32 rx_max_coalesced_frames; 410 __u32 rx_coalesce_usecs_irq; 411 __u32 rx_max_coalesced_frames_irq; 412 __u32 tx_coalesce_usecs; 413 __u32 tx_max_coalesced_frames; 414 __u32 tx_coalesce_usecs_irq; 415 __u32 tx_max_coalesced_frames_irq; 416 __u32 stats_block_coalesce_usecs; 417 __u32 use_adaptive_rx_coalesce; 418 __u32 use_adaptive_tx_coalesce; 419 __u32 pkt_rate_low; 420 __u32 rx_coalesce_usecs_low; 421 __u32 rx_max_coalesced_frames_low; 422 __u32 tx_coalesce_usecs_low; 423 __u32 tx_max_coalesced_frames_low; 424 __u32 pkt_rate_high; 425 __u32 rx_coalesce_usecs_high; 426 __u32 rx_max_coalesced_frames_high; 427 __u32 tx_coalesce_usecs_high; 428 __u32 tx_max_coalesced_frames_high; 429 __u32 rate_sample_interval; 430 }; 431 432 /** 433 * struct ethtool_ringparam - RX/TX ring parameters 434 * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM 435 * @rx_max_pending: Maximum supported number of pending entries per 436 * RX ring. Read-only. 437 * @rx_mini_max_pending: Maximum supported number of pending entries 438 * per RX mini ring. Read-only. 439 * @rx_jumbo_max_pending: Maximum supported number of pending entries 440 * per RX jumbo ring. Read-only. 441 * @tx_max_pending: Maximum supported number of pending entries per 442 * TX ring. Read-only. 443 * @rx_pending: Current maximum number of pending entries per RX ring 444 * @rx_mini_pending: Current maximum number of pending entries per RX 445 * mini ring 446 * @rx_jumbo_pending: Current maximum number of pending entries per RX 447 * jumbo ring 448 * @tx_pending: Current maximum supported number of pending entries 449 * per TX ring 450 * 451 * If the interface does not have separate RX mini and/or jumbo rings, 452 * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0. 453 * 454 * There may also be driver-dependent minimum values for the number 455 * of entries per ring. 456 */ 457 struct ethtool_ringparam { 458 __u32 cmd; 459 __u32 rx_max_pending; 460 __u32 rx_mini_max_pending; 461 __u32 rx_jumbo_max_pending; 462 __u32 tx_max_pending; 463 __u32 rx_pending; 464 __u32 rx_mini_pending; 465 __u32 rx_jumbo_pending; 466 __u32 tx_pending; 467 }; 468 469 /** 470 * struct ethtool_channels - configuring number of network channel 471 * @cmd: ETHTOOL_{G,S}CHANNELS 472 * @max_rx: Read only. Maximum number of receive channel the driver support. 473 * @max_tx: Read only. Maximum number of transmit channel the driver support. 474 * @max_other: Read only. Maximum number of other channel the driver support. 475 * @max_combined: Read only. Maximum number of combined channel the driver 476 * support. Set of queues RX, TX or other. 477 * @rx_count: Valid values are in the range 1 to the max_rx. 478 * @tx_count: Valid values are in the range 1 to the max_tx. 479 * @other_count: Valid values are in the range 1 to the max_other. 480 * @combined_count: Valid values are in the range 1 to the max_combined. 481 * 482 * This can be used to configure RX, TX and other channels. 483 */ 484 485 struct ethtool_channels { 486 __u32 cmd; 487 __u32 max_rx; 488 __u32 max_tx; 489 __u32 max_other; 490 __u32 max_combined; 491 __u32 rx_count; 492 __u32 tx_count; 493 __u32 other_count; 494 __u32 combined_count; 495 }; 496 497 /** 498 * struct ethtool_pauseparam - Ethernet pause (flow control) parameters 499 * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM 500 * @autoneg: Flag to enable autonegotiation of pause frame use 501 * @rx_pause: Flag to enable reception of pause frames 502 * @tx_pause: Flag to enable transmission of pause frames 503 * 504 * Drivers should reject a non-zero setting of @autoneg when 505 * autoneogotiation is disabled (or not supported) for the link. 506 * 507 * If the link is autonegotiated, drivers should use 508 * mii_advertise_flowctrl() or similar code to set the advertised 509 * pause frame capabilities based on the @rx_pause and @tx_pause flags, 510 * even if @autoneg is zero. They should also allow the advertised 511 * pause frame capabilities to be controlled directly through the 512 * advertising field of &struct ethtool_cmd. 513 * 514 * If @autoneg is non-zero, the MAC is configured to send and/or 515 * receive pause frames according to the result of autonegotiation. 516 * Otherwise, it is configured directly based on the @rx_pause and 517 * @tx_pause flags. 518 */ 519 struct ethtool_pauseparam { 520 __u32 cmd; 521 __u32 autoneg; 522 __u32 rx_pause; 523 __u32 tx_pause; 524 }; 525 526 #define ETH_GSTRING_LEN 32 527 528 /** 529 * enum ethtool_stringset - string set ID 530 * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST 531 * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS 532 * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with 533 * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS 534 * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE; 535 * now deprecated 536 * @ETH_SS_FEATURES: Device feature names 537 */ 538 enum ethtool_stringset { 539 ETH_SS_TEST = 0, 540 ETH_SS_STATS, 541 ETH_SS_PRIV_FLAGS, 542 ETH_SS_NTUPLE_FILTERS, 543 ETH_SS_FEATURES, 544 }; 545 546 /** 547 * struct ethtool_gstrings - string set for data tagging 548 * @cmd: Command number = %ETHTOOL_GSTRINGS 549 * @string_set: String set ID; one of &enum ethtool_stringset 550 * @len: On return, the number of strings in the string set 551 * @data: Buffer for strings. Each string is null-padded to a size of 552 * %ETH_GSTRING_LEN. 553 * 554 * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in 555 * the string set. They must allocate a buffer of the appropriate 556 * size immediately following this structure. 557 */ 558 struct ethtool_gstrings { 559 __u32 cmd; 560 __u32 string_set; 561 __u32 len; 562 __u8 data[0]; 563 }; 564 565 /** 566 * struct ethtool_sset_info - string set information 567 * @cmd: Command number = %ETHTOOL_GSSET_INFO 568 * @sset_mask: On entry, a bitmask of string sets to query, with bits 569 * numbered according to &enum ethtool_stringset. On return, a 570 * bitmask of those string sets queried that are supported. 571 * @data: Buffer for string set sizes. On return, this contains the 572 * size of each string set that was queried and supported, in 573 * order of ID. 574 * 575 * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on 576 * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the 577 * size of set 1 and @data[1] contains the size of set 2. 578 * 579 * Users must allocate a buffer of the appropriate size (4 * number of 580 * sets queried) immediately following this structure. 581 */ 582 struct ethtool_sset_info { 583 __u32 cmd; 584 __u32 reserved; 585 __u64 sset_mask; 586 __u32 data[0]; 587 }; 588 589 /** 590 * enum ethtool_test_flags - flags definition of ethtool_test 591 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise 592 * only online tests. 593 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails. 594 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback 595 * test. 596 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test 597 */ 598 599 enum ethtool_test_flags { 600 ETH_TEST_FL_OFFLINE = (1 << 0), 601 ETH_TEST_FL_FAILED = (1 << 1), 602 ETH_TEST_FL_EXTERNAL_LB = (1 << 2), 603 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3), 604 }; 605 606 /** 607 * struct ethtool_test - device self-test invocation 608 * @cmd: Command number = %ETHTOOL_TEST 609 * @flags: A bitmask of flags from &enum ethtool_test_flags. Some 610 * flags may be set by the user on entry; others may be set by 611 * the driver on return. 612 * @len: On return, the number of test results 613 * @data: Array of test results 614 * 615 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the 616 * number of test results that will be returned. They must allocate a 617 * buffer of the appropriate size (8 * number of results) immediately 618 * following this structure. 619 */ 620 struct ethtool_test { 621 __u32 cmd; 622 __u32 flags; 623 __u32 reserved; 624 __u32 len; 625 __u64 data[0]; 626 }; 627 628 /** 629 * struct ethtool_stats - device-specific statistics 630 * @cmd: Command number = %ETHTOOL_GSTATS 631 * @n_stats: On return, the number of statistics 632 * @data: Array of statistics 633 * 634 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the 635 * number of statistics that will be returned. They must allocate a 636 * buffer of the appropriate size (8 * number of statistics) 637 * immediately following this structure. 638 */ 639 struct ethtool_stats { 640 __u32 cmd; 641 __u32 n_stats; 642 __u64 data[0]; 643 }; 644 645 /** 646 * struct ethtool_perm_addr - permanent hardware address 647 * @cmd: Command number = %ETHTOOL_GPERMADDR 648 * @size: On entry, the size of the buffer. On return, the size of the 649 * address. The command fails if the buffer is too small. 650 * @data: Buffer for the address 651 * 652 * Users must allocate the buffer immediately following this structure. 653 * A buffer size of %MAX_ADDR_LEN should be sufficient for any address 654 * type. 655 */ 656 struct ethtool_perm_addr { 657 __u32 cmd; 658 __u32 size; 659 __u8 data[0]; 660 }; 661 662 /* boolean flags controlling per-interface behavior characteristics. 663 * When reading, the flag indicates whether or not a certain behavior 664 * is enabled/present. When writing, the flag indicates whether 665 * or not the driver should turn on (set) or off (clear) a behavior. 666 * 667 * Some behaviors may read-only (unconditionally absent or present). 668 * If such is the case, return EINVAL in the set-flags operation if the 669 * flag differs from the read-only value. 670 */ 671 enum ethtool_flags { 672 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */ 673 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */ 674 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 675 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */ 676 ETH_FLAG_RXHASH = (1 << 28), 677 }; 678 679 /* The following structures are for supporting RX network flow 680 * classification and RX n-tuple configuration. Note, all multibyte 681 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to 682 * be in network byte order. 683 */ 684 685 /** 686 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. 687 * @ip4src: Source host 688 * @ip4dst: Destination host 689 * @psrc: Source port 690 * @pdst: Destination port 691 * @tos: Type-of-service 692 * 693 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. 694 */ 695 struct ethtool_tcpip4_spec { 696 __be32 ip4src; 697 __be32 ip4dst; 698 __be16 psrc; 699 __be16 pdst; 700 __u8 tos; 701 }; 702 703 /** 704 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 705 * @ip4src: Source host 706 * @ip4dst: Destination host 707 * @spi: Security parameters index 708 * @tos: Type-of-service 709 * 710 * This can be used to specify an IPsec transport or tunnel over IPv4. 711 */ 712 struct ethtool_ah_espip4_spec { 713 __be32 ip4src; 714 __be32 ip4dst; 715 __be32 spi; 716 __u8 tos; 717 }; 718 719 #define ETH_RX_NFC_IP4 1 720 721 /** 722 * struct ethtool_usrip4_spec - general flow specification for IPv4 723 * @ip4src: Source host 724 * @ip4dst: Destination host 725 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 726 * @tos: Type-of-service 727 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 728 * @proto: Transport protocol number; mask must be 0 729 */ 730 struct ethtool_usrip4_spec { 731 __be32 ip4src; 732 __be32 ip4dst; 733 __be32 l4_4_bytes; 734 __u8 tos; 735 __u8 ip_ver; 736 __u8 proto; 737 }; 738 739 union ethtool_flow_union { 740 struct ethtool_tcpip4_spec tcp_ip4_spec; 741 struct ethtool_tcpip4_spec udp_ip4_spec; 742 struct ethtool_tcpip4_spec sctp_ip4_spec; 743 struct ethtool_ah_espip4_spec ah_ip4_spec; 744 struct ethtool_ah_espip4_spec esp_ip4_spec; 745 struct ethtool_usrip4_spec usr_ip4_spec; 746 struct ethhdr ether_spec; 747 __u8 hdata[52]; 748 }; 749 750 /** 751 * struct ethtool_flow_ext - additional RX flow fields 752 * @h_dest: destination MAC address 753 * @vlan_etype: VLAN EtherType 754 * @vlan_tci: VLAN tag control information 755 * @data: user defined data 756 * 757 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT 758 * is set in &struct ethtool_rx_flow_spec @flow_type. 759 * @h_dest is valid if %FLOW_MAC_EXT is set. 760 */ 761 struct ethtool_flow_ext { 762 __u8 padding[2]; 763 unsigned char h_dest[ETH_ALEN]; 764 __be16 vlan_etype; 765 __be16 vlan_tci; 766 __be32 data[2]; 767 }; 768 769 /** 770 * struct ethtool_rx_flow_spec - classification rule for RX flows 771 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 772 * @h_u: Flow fields to match (dependent on @flow_type) 773 * @h_ext: Additional fields to match 774 * @m_u: Masks for flow field bits to be matched 775 * @m_ext: Masks for additional field bits to be matched 776 * Note, all additional fields must be ignored unless @flow_type 777 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag 778 * (see &struct ethtool_flow_ext description). 779 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC 780 * if packets should be discarded 781 * @location: Location of rule in the table. Locations must be 782 * numbered such that a flow matching multiple rules will be 783 * classified according to the first (lowest numbered) rule. 784 */ 785 struct ethtool_rx_flow_spec { 786 __u32 flow_type; 787 union ethtool_flow_union h_u; 788 struct ethtool_flow_ext h_ext; 789 union ethtool_flow_union m_u; 790 struct ethtool_flow_ext m_ext; 791 __u64 ring_cookie; 792 __u32 location; 793 }; 794 795 /** 796 * struct ethtool_rxnfc - command to get or set RX flow classification rules 797 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, 798 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, 799 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS 800 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW 801 * @data: Command-dependent value 802 * @fs: Flow classification rule 803 * @rule_cnt: Number of rules to be affected 804 * @rule_locs: Array of used rule locations 805 * 806 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating 807 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following 808 * structure fields must not be used. 809 * 810 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues 811 * on return. 812 * 813 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined 814 * rules on return. If @data is non-zero on return then it is the 815 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the 816 * driver supports any special location values. If that flag is not 817 * set in @data then special location values should not be used. 818 * 819 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an 820 * existing rule on entry and @fs contains the rule on return. 821 * 822 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the 823 * user buffer for @rule_locs on entry. On return, @data is the size 824 * of the rule table, @rule_cnt is the number of defined rules, and 825 * @rule_locs contains the locations of the defined rules. Drivers 826 * must use the second parameter to get_rxnfc() instead of @rule_locs. 827 * 828 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update. 829 * @fs.@location either specifies the location to use or is a special 830 * location value with %RX_CLS_LOC_SPECIAL flag set. On return, 831 * @fs.@location is the actual rule location. 832 * 833 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an 834 * existing rule on entry. 835 * 836 * A driver supporting the special location values for 837 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused 838 * location, and may remove a rule at a later location (lower 839 * priority) that matches exactly the same set of flows. The special 840 * values are %RX_CLS_LOC_ANY, selecting any location; 841 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum 842 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable 843 * location (minimum priority). Additional special values may be 844 * defined in future and drivers must return -%EINVAL for any 845 * unrecognised value. 846 */ 847 struct ethtool_rxnfc { 848 __u32 cmd; 849 __u32 flow_type; 850 __u64 data; 851 struct ethtool_rx_flow_spec fs; 852 __u32 rule_cnt; 853 __u32 rule_locs[0]; 854 }; 855 856 857 /** 858 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection 859 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR 860 * @size: On entry, the array size of the user buffer, which may be zero. 861 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware 862 * indirection table. 863 * @ring_index: RX ring/queue index for each hash value 864 * 865 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size 866 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means 867 * the table should be reset to default values. This last feature 868 * is not supported by the original implementations. 869 */ 870 struct ethtool_rxfh_indir { 871 __u32 cmd; 872 __u32 size; 873 __u32 ring_index[0]; 874 }; 875 876 /** 877 * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key. 878 * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH 879 * @rss_context: RSS context identifier. 880 * @indir_size: On entry, the array size of the user buffer for the 881 * indirection table, which may be zero, or (for %ETHTOOL_SRSSH), 882 * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH, 883 * the array size of the hardware indirection table. 884 * @key_size: On entry, the array size of the user buffer for the hash key, 885 * which may be zero. On return from %ETHTOOL_GRSSH, the size of the 886 * hardware hash key. 887 * @rsvd: Reserved for future extensions. 888 * @rss_config: RX ring/queue index for each hash value i.e., indirection table 889 * of @indir_size __u32 elements, followed by hash key of @key_size 890 * bytes. 891 * 892 * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the 893 * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of 894 * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested 895 * and a @indir_size of zero means the indir table should be reset to default 896 * values. 897 */ 898 struct ethtool_rxfh { 899 __u32 cmd; 900 __u32 rss_context; 901 __u32 indir_size; 902 __u32 key_size; 903 __u32 rsvd[2]; 904 __u32 rss_config[0]; 905 }; 906 #define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff 907 908 /** 909 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter 910 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 911 * @h_u: Flow field values to match (dependent on @flow_type) 912 * @m_u: Masks for flow field value bits to be ignored 913 * @vlan_tag: VLAN tag to match 914 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored 915 * @data: Driver-dependent data to match 916 * @data_mask: Mask for driver-dependent data bits to be ignored 917 * @action: RX ring/queue index to deliver to (non-negative) or other action 918 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) 919 * 920 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where 921 * a field value and mask are both zero this is treated as if all mask 922 * bits are set i.e. the field is ignored. 923 */ 924 struct ethtool_rx_ntuple_flow_spec { 925 __u32 flow_type; 926 union { 927 struct ethtool_tcpip4_spec tcp_ip4_spec; 928 struct ethtool_tcpip4_spec udp_ip4_spec; 929 struct ethtool_tcpip4_spec sctp_ip4_spec; 930 struct ethtool_ah_espip4_spec ah_ip4_spec; 931 struct ethtool_ah_espip4_spec esp_ip4_spec; 932 struct ethtool_usrip4_spec usr_ip4_spec; 933 struct ethhdr ether_spec; 934 __u8 hdata[72]; 935 } h_u, m_u; 936 937 __u16 vlan_tag; 938 __u16 vlan_tag_mask; 939 __u64 data; 940 __u64 data_mask; 941 942 __s32 action; 943 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */ 944 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */ 945 }; 946 947 /** 948 * struct ethtool_rx_ntuple - command to set or clear RX flow filter 949 * @cmd: Command number - %ETHTOOL_SRXNTUPLE 950 * @fs: Flow filter specification 951 */ 952 struct ethtool_rx_ntuple { 953 __u32 cmd; 954 struct ethtool_rx_ntuple_flow_spec fs; 955 }; 956 957 #define ETHTOOL_FLASH_MAX_FILENAME 128 958 enum ethtool_flash_op_type { 959 ETHTOOL_FLASH_ALL_REGIONS = 0, 960 }; 961 962 /* for passing firmware flashing related parameters */ 963 struct ethtool_flash { 964 __u32 cmd; 965 __u32 region; 966 char data[ETHTOOL_FLASH_MAX_FILENAME]; 967 }; 968 969 /** 970 * struct ethtool_dump - used for retrieving, setting device dump 971 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or 972 * %ETHTOOL_SET_DUMP 973 * @version: FW version of the dump, filled in by driver 974 * @flag: driver dependent flag for dump setting, filled in by driver during 975 * get and filled in by ethtool for set operation. 976 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when 977 * firmware dump is disabled. 978 * @len: length of dump data, used as the length of the user buffer on entry to 979 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver 980 * for %ETHTOOL_GET_DUMP_FLAG command 981 * @data: data collected for get dump data operation 982 */ 983 struct ethtool_dump { 984 __u32 cmd; 985 __u32 version; 986 __u32 flag; 987 __u32 len; 988 __u8 data[0]; 989 }; 990 991 #define ETH_FW_DUMP_DISABLE 0 992 993 /* for returning and changing feature sets */ 994 995 /** 996 * struct ethtool_get_features_block - block with state of 32 features 997 * @available: mask of changeable features 998 * @requested: mask of features requested to be enabled if possible 999 * @active: mask of currently enabled features 1000 * @never_changed: mask of features not changeable for any device 1001 */ 1002 struct ethtool_get_features_block { 1003 __u32 available; 1004 __u32 requested; 1005 __u32 active; 1006 __u32 never_changed; 1007 }; 1008 1009 /** 1010 * struct ethtool_gfeatures - command to get state of device's features 1011 * @cmd: command number = %ETHTOOL_GFEATURES 1012 * @size: On entry, the number of elements in the features[] array; 1013 * on return, the number of elements in features[] needed to hold 1014 * all features 1015 * @features: state of features 1016 */ 1017 struct ethtool_gfeatures { 1018 __u32 cmd; 1019 __u32 size; 1020 struct ethtool_get_features_block features[0]; 1021 }; 1022 1023 /** 1024 * struct ethtool_set_features_block - block with request for 32 features 1025 * @valid: mask of features to be changed 1026 * @requested: values of features to be changed 1027 */ 1028 struct ethtool_set_features_block { 1029 __u32 valid; 1030 __u32 requested; 1031 }; 1032 1033 /** 1034 * struct ethtool_sfeatures - command to request change in device's features 1035 * @cmd: command number = %ETHTOOL_SFEATURES 1036 * @size: array size of the features[] array 1037 * @features: feature change masks 1038 */ 1039 struct ethtool_sfeatures { 1040 __u32 cmd; 1041 __u32 size; 1042 struct ethtool_set_features_block features[0]; 1043 }; 1044 1045 /** 1046 * struct ethtool_ts_info - holds a device's timestamping and PHC association 1047 * @cmd: command number = %ETHTOOL_GET_TS_INFO 1048 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags 1049 * @phc_index: device index of the associated PHC, or -1 if there is none 1050 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values 1051 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values 1052 * 1053 * The bits in the 'tx_types' and 'rx_filters' fields correspond to 1054 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values, 1055 * respectively. For example, if the device supports HWTSTAMP_TX_ON, 1056 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set. 1057 */ 1058 struct ethtool_ts_info { 1059 __u32 cmd; 1060 __u32 so_timestamping; 1061 __s32 phc_index; 1062 __u32 tx_types; 1063 __u32 tx_reserved[3]; 1064 __u32 rx_filters; 1065 __u32 rx_reserved[3]; 1066 }; 1067 1068 /* 1069 * %ETHTOOL_SFEATURES changes features present in features[].valid to the 1070 * values of corresponding bits in features[].requested. Bits in .requested 1071 * not set in .valid or not changeable are ignored. 1072 * 1073 * Returns %EINVAL when .valid contains undefined or never-changeable bits 1074 * or size is not equal to required number of features words (32-bit blocks). 1075 * Returns >= 0 if request was completed; bits set in the value mean: 1076 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not 1077 * changeable (not present in %ETHTOOL_GFEATURES' features[].available) 1078 * those bits were ignored. 1079 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the 1080 * resulting state of bits masked by .valid is not equal to .requested. 1081 * Probably there are other device-specific constraints on some features 1082 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered 1083 * here as though ignored bits were cleared. 1084 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling 1085 * compatibility functions. Requested offload state cannot be properly 1086 * managed by kernel. 1087 * 1088 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of 1089 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands 1090 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least 1091 * significant bit in features[0] fields. Empty strings mark undefined features. 1092 */ 1093 enum ethtool_sfeatures_retval_bits { 1094 ETHTOOL_F_UNSUPPORTED__BIT, 1095 ETHTOOL_F_WISH__BIT, 1096 ETHTOOL_F_COMPAT__BIT, 1097 }; 1098 1099 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT) 1100 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT) 1101 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT) 1102 1103 1104 /* CMDs currently supported */ 1105 #define ETHTOOL_GSET 0x00000001 /* Get settings. */ 1106 #define ETHTOOL_SSET 0x00000002 /* Set settings. */ 1107 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 1108 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 1109 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 1110 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 1111 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 1112 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 1113 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 1114 /* Get link status for host, i.e. whether the interface *and* the 1115 * physical port (if there is one) are up (ethtool_value). */ 1116 #define ETHTOOL_GLINK 0x0000000a 1117 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 1118 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 1119 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 1120 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 1121 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 1122 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 1123 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 1124 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 1125 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 1126 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 1127 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 1128 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 1129 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 1130 * (ethtool_value) */ 1131 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 1132 * (ethtool_value). */ 1133 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 1134 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 1135 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 1136 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 1137 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 1138 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 1139 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 1140 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 1141 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 1142 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 1143 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 1144 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 1145 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 1146 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 1147 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 1148 1149 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */ 1150 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */ 1151 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */ 1152 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */ 1153 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */ 1154 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */ 1155 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */ 1156 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */ 1157 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */ 1158 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */ 1159 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */ 1160 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */ 1161 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */ 1162 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */ 1163 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */ 1164 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */ 1165 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */ 1166 1167 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */ 1168 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */ 1169 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */ 1170 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */ 1171 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */ 1172 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */ 1173 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */ 1174 #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */ 1175 #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */ 1176 #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */ 1177 #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */ 1178 #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */ 1179 1180 #define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */ 1181 #define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */ 1182 #define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */ 1183 #define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */ 1184 1185 /* compatibility with older code */ 1186 #define SPARC_ETH_GSET ETHTOOL_GSET 1187 #define SPARC_ETH_SSET ETHTOOL_SSET 1188 1189 #define SUPPORTED_10baseT_Half (1 << 0) 1190 #define SUPPORTED_10baseT_Full (1 << 1) 1191 #define SUPPORTED_100baseT_Half (1 << 2) 1192 #define SUPPORTED_100baseT_Full (1 << 3) 1193 #define SUPPORTED_1000baseT_Half (1 << 4) 1194 #define SUPPORTED_1000baseT_Full (1 << 5) 1195 #define SUPPORTED_Autoneg (1 << 6) 1196 #define SUPPORTED_TP (1 << 7) 1197 #define SUPPORTED_AUI (1 << 8) 1198 #define SUPPORTED_MII (1 << 9) 1199 #define SUPPORTED_FIBRE (1 << 10) 1200 #define SUPPORTED_BNC (1 << 11) 1201 #define SUPPORTED_10000baseT_Full (1 << 12) 1202 #define SUPPORTED_Pause (1 << 13) 1203 #define SUPPORTED_Asym_Pause (1 << 14) 1204 #define SUPPORTED_2500baseX_Full (1 << 15) 1205 #define SUPPORTED_Backplane (1 << 16) 1206 #define SUPPORTED_1000baseKX_Full (1 << 17) 1207 #define SUPPORTED_10000baseKX4_Full (1 << 18) 1208 #define SUPPORTED_10000baseKR_Full (1 << 19) 1209 #define SUPPORTED_10000baseR_FEC (1 << 20) 1210 #define SUPPORTED_20000baseMLD2_Full (1 << 21) 1211 #define SUPPORTED_20000baseKR2_Full (1 << 22) 1212 #define SUPPORTED_40000baseKR4_Full (1 << 23) 1213 #define SUPPORTED_40000baseCR4_Full (1 << 24) 1214 #define SUPPORTED_40000baseSR4_Full (1 << 25) 1215 #define SUPPORTED_40000baseLR4_Full (1 << 26) 1216 1217 #define ADVERTISED_10baseT_Half (1 << 0) 1218 #define ADVERTISED_10baseT_Full (1 << 1) 1219 #define ADVERTISED_100baseT_Half (1 << 2) 1220 #define ADVERTISED_100baseT_Full (1 << 3) 1221 #define ADVERTISED_1000baseT_Half (1 << 4) 1222 #define ADVERTISED_1000baseT_Full (1 << 5) 1223 #define ADVERTISED_Autoneg (1 << 6) 1224 #define ADVERTISED_TP (1 << 7) 1225 #define ADVERTISED_AUI (1 << 8) 1226 #define ADVERTISED_MII (1 << 9) 1227 #define ADVERTISED_FIBRE (1 << 10) 1228 #define ADVERTISED_BNC (1 << 11) 1229 #define ADVERTISED_10000baseT_Full (1 << 12) 1230 #define ADVERTISED_Pause (1 << 13) 1231 #define ADVERTISED_Asym_Pause (1 << 14) 1232 #define ADVERTISED_2500baseX_Full (1 << 15) 1233 #define ADVERTISED_Backplane (1 << 16) 1234 #define ADVERTISED_1000baseKX_Full (1 << 17) 1235 #define ADVERTISED_10000baseKX4_Full (1 << 18) 1236 #define ADVERTISED_10000baseKR_Full (1 << 19) 1237 #define ADVERTISED_10000baseR_FEC (1 << 20) 1238 #define ADVERTISED_20000baseMLD2_Full (1 << 21) 1239 #define ADVERTISED_20000baseKR2_Full (1 << 22) 1240 #define ADVERTISED_40000baseKR4_Full (1 << 23) 1241 #define ADVERTISED_40000baseCR4_Full (1 << 24) 1242 #define ADVERTISED_40000baseSR4_Full (1 << 25) 1243 #define ADVERTISED_40000baseLR4_Full (1 << 26) 1244 1245 /* The following are all involved in forcing a particular link 1246 * mode for the device for setting things. When getting the 1247 * devices settings, these indicate the current mode and whether 1248 * it was forced up into this mode or autonegotiated. 1249 */ 1250 1251 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */ 1252 #define SPEED_10 10 1253 #define SPEED_100 100 1254 #define SPEED_1000 1000 1255 #define SPEED_2500 2500 1256 #define SPEED_10000 10000 1257 #define SPEED_UNKNOWN -1 1258 1259 /* Duplex, half or full. */ 1260 #define DUPLEX_HALF 0x00 1261 #define DUPLEX_FULL 0x01 1262 #define DUPLEX_UNKNOWN 0xff 1263 1264 /* Which connector port. */ 1265 #define PORT_TP 0x00 1266 #define PORT_AUI 0x01 1267 #define PORT_MII 0x02 1268 #define PORT_FIBRE 0x03 1269 #define PORT_BNC 0x04 1270 #define PORT_DA 0x05 1271 #define PORT_NONE 0xef 1272 #define PORT_OTHER 0xff 1273 1274 /* Which transceiver to use. */ 1275 #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */ 1276 #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */ 1277 #define XCVR_DUMMY1 0x02 1278 #define XCVR_DUMMY2 0x03 1279 #define XCVR_DUMMY3 0x04 1280 1281 /* Enable or disable autonegotiation. */ 1282 #define AUTONEG_DISABLE 0x00 1283 #define AUTONEG_ENABLE 0x01 1284 1285 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then 1286 * the driver is required to renegotiate link 1287 */ 1288 #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */ 1289 #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */ 1290 #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */ 1291 #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */ 1292 1293 /* Wake-On-Lan options. */ 1294 #define WAKE_PHY (1 << 0) 1295 #define WAKE_UCAST (1 << 1) 1296 #define WAKE_MCAST (1 << 2) 1297 #define WAKE_BCAST (1 << 3) 1298 #define WAKE_ARP (1 << 4) 1299 #define WAKE_MAGIC (1 << 5) 1300 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 1301 1302 /* L2-L4 network traffic flow types */ 1303 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */ 1304 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */ 1305 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */ 1306 #define AH_ESP_V4_FLOW 0x04 /* hash only */ 1307 #define TCP_V6_FLOW 0x05 /* hash only */ 1308 #define UDP_V6_FLOW 0x06 /* hash only */ 1309 #define SCTP_V6_FLOW 0x07 /* hash only */ 1310 #define AH_ESP_V6_FLOW 0x08 /* hash only */ 1311 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */ 1312 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */ 1313 #define AH_V6_FLOW 0x0b /* hash only */ 1314 #define ESP_V6_FLOW 0x0c /* hash only */ 1315 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */ 1316 #define IPV4_FLOW 0x10 /* hash only */ 1317 #define IPV6_FLOW 0x11 /* hash only */ 1318 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */ 1319 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */ 1320 #define FLOW_EXT 0x80000000 1321 #define FLOW_MAC_EXT 0x40000000 1322 1323 /* L3-L4 network traffic flow hash options */ 1324 #define RXH_L2DA (1 << 1) 1325 #define RXH_VLAN (1 << 2) 1326 #define RXH_L3_PROTO (1 << 3) 1327 #define RXH_IP_SRC (1 << 4) 1328 #define RXH_IP_DST (1 << 5) 1329 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */ 1330 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */ 1331 #define RXH_DISCARD (1 << 31) 1332 1333 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL 1334 1335 /* Special RX classification rule insert location values */ 1336 #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */ 1337 #define RX_CLS_LOC_ANY 0xffffffff 1338 #define RX_CLS_LOC_FIRST 0xfffffffe 1339 #define RX_CLS_LOC_LAST 0xfffffffd 1340 1341 /* EEPROM Standards for plug in modules */ 1342 #define ETH_MODULE_SFF_8079 0x1 1343 #define ETH_MODULE_SFF_8079_LEN 256 1344 #define ETH_MODULE_SFF_8472 0x2 1345 #define ETH_MODULE_SFF_8472_LEN 512 1346 1347 /* Reset flags */ 1348 /* The reset() operation must clear the flags for the components which 1349 * were actually reset. On successful return, the flags indicate the 1350 * components which were not reset, either because they do not exist 1351 * in the hardware or because they cannot be reset independently. The 1352 * driver must never reset any components that were not requested. 1353 */ 1354 enum ethtool_reset_flags { 1355 /* These flags represent components dedicated to the interface 1356 * the command is addressed to. Shift any flag left by 1357 * ETH_RESET_SHARED_SHIFT to reset a shared component of the 1358 * same type. 1359 */ 1360 ETH_RESET_MGMT = 1 << 0, /* Management processor */ 1361 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */ 1362 ETH_RESET_DMA = 1 << 2, /* DMA engine */ 1363 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */ 1364 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */ 1365 ETH_RESET_MAC = 1 << 5, /* Media access controller */ 1366 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */ 1367 ETH_RESET_RAM = 1 << 7, /* RAM shared between 1368 * multiple components */ 1369 1370 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to 1371 * this interface */ 1372 ETH_RESET_ALL = 0xffffffff, /* All components used by this 1373 * interface, even if shared */ 1374 }; 1375 #define ETH_RESET_SHARED_SHIFT 16 1376 1377 #endif /* _UAPI_LINUX_ETHTOOL_H */ 1378
