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