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