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