1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* 3 * ethtool.h: Defines for Linux ethtool. 4 * 5 * Copyright (C) 1998 David S. Miller (davem@redhat.com) 6 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com> 7 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com) 8 * Portions Copyright 2002 Intel (eli.kupermann@intel.com, 9 * christopher.leech@intel.com, 10 * scott.feldman@intel.com) 11 * Portions Copyright (C) Sun Microsystems 2008 12 */ 13 14 #ifndef _LINUX_ETHTOOL_H 15 #define _LINUX_ETHTOOL_H 16 17 #include "net/eth.h" 18 19 #include "standard-headers/linux/const.h" 20 #include "standard-headers/linux/types.h" 21 #include "standard-headers/linux/if_ether.h" 22 23 #include <limits.h> /* for INT_MAX */ 24 25 /* All structures exposed to userland should be defined such that they 26 * have the same layout for 32-bit and 64-bit userland. 27 */ 28 29 /* Note on reserved space. 30 * Reserved fields must not be accessed directly by user space because 31 * they may be replaced by a different field in the future. They must 32 * be initialized to zero before making the request, e.g. via memset 33 * of the entire structure or implicitly by not being set in a structure 34 * initializer. 35 */ 36 37 /** 38 * struct ethtool_cmd - DEPRECATED, link control and status 39 * This structure is DEPRECATED, please use struct ethtool_link_settings. 40 * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET 41 * @supported: Bitmask of %SUPPORTED_* flags for the link modes, 42 * physical connectors and other link features for which the 43 * interface supports autonegotiation or auto-detection. 44 * Read-only. 45 * @advertising: Bitmask of %ADVERTISED_* flags for the link modes, 46 * physical connectors and other link features that are 47 * advertised through autonegotiation or enabled for 48 * auto-detection. 49 * @speed: Low bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN 50 * @duplex: Duplex mode; one of %DUPLEX_* 51 * @port: Physical connector type; one of %PORT_* 52 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not 53 * applicable. For clause 45 PHYs this is the PRTAD. 54 * @transceiver: Historically used to distinguish different possible 55 * PHY types, but not in a consistent way. Deprecated. 56 * @autoneg: Enable/disable autonegotiation and auto-detection; 57 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE 58 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO 59 * protocols supported by the interface; 0 if unknown. 60 * Read-only. 61 * @maxtxpkt: Historically used to report TX IRQ coalescing; now 62 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. 63 * @maxrxpkt: Historically used to report RX IRQ coalescing; now 64 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. 65 * @speed_hi: High bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN 66 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of 67 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the 68 * value will be %ETH_TP_MDI_INVALID. Read-only. 69 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of 70 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads 71 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. 72 * When written successfully, the link should be renegotiated if 73 * necessary. 74 * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes 75 * and other link features that the link partner advertised 76 * through autonegotiation; 0 if unknown or not applicable. 77 * Read-only. 78 * @reserved: Reserved for future use; see the note on reserved space. 79 * 80 * The link speed in Mbps is split between @speed and @speed_hi. Use 81 * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to 82 * access it. 83 * 84 * If autonegotiation is disabled, the speed and @duplex represent the 85 * fixed link mode and are writable if the driver supports multiple 86 * link modes. If it is enabled then they are read-only; if the link 87 * is up they represent the negotiated link mode; if the link is down, 88 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and 89 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. 90 * 91 * Some hardware interfaces may have multiple PHYs and/or physical 92 * connectors fitted or do not allow the driver to detect which are 93 * fitted. For these interfaces @port and/or @phy_address may be 94 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. 95 * Otherwise, attempts to write different values may be ignored or 96 * rejected. 97 * 98 * Users should assume that all fields not marked read-only are 99 * writable and subject to validation by the driver. They should use 100 * %ETHTOOL_GSET to get the current values before making specific 101 * changes and then applying them with %ETHTOOL_SSET. 102 * 103 * Deprecated fields should be ignored by both users and drivers. 104 */ 105 struct ethtool_cmd { 106 uint32_t cmd; 107 uint32_t supported; 108 uint32_t advertising; 109 uint16_t speed; 110 uint8_t duplex; 111 uint8_t port; 112 uint8_t phy_address; 113 uint8_t transceiver; 114 uint8_t autoneg; 115 uint8_t mdio_support; 116 uint32_t maxtxpkt; 117 uint32_t maxrxpkt; 118 uint16_t speed_hi; 119 uint8_t eth_tp_mdix; 120 uint8_t eth_tp_mdix_ctrl; 121 uint32_t lp_advertising; 122 uint32_t reserved[2]; 123 }; 124 125 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep, 126 uint32_t speed) 127 { 128 ep->speed = (uint16_t)(speed & 0xFFFF); 129 ep->speed_hi = (uint16_t)(speed >> 16); 130 } 131 132 static inline uint32_t ethtool_cmd_speed(const struct ethtool_cmd *ep) 133 { 134 return (ep->speed_hi << 16) | ep->speed; 135 } 136 137 /* Device supports clause 22 register access to PHY or peripherals 138 * using the interface defined in "standard-headers/linux/mii.h". This should not be 139 * set if there are known to be no such peripherals present or if 140 * the driver only emulates clause 22 registers for compatibility. 141 */ 142 #define ETH_MDIO_SUPPORTS_C22 1 143 144 /* Device supports clause 45 register access to PHY or peripherals 145 * using the interface defined in "standard-headers/linux/mii.h" and <linux/mdio.h>. 146 * This should not be set if there are known to be no such peripherals 147 * present. 148 */ 149 #define ETH_MDIO_SUPPORTS_C45 2 150 151 #define ETHTOOL_FWVERS_LEN 32 152 #define ETHTOOL_BUSINFO_LEN 32 153 #define ETHTOOL_EROMVERS_LEN 32 154 155 /** 156 * struct ethtool_drvinfo - general driver and device information 157 * @cmd: Command number = %ETHTOOL_GDRVINFO 158 * @driver: Driver short name. This should normally match the name 159 * in its bus driver structure (e.g. pci_driver::name). Must 160 * not be an empty string. 161 * @version: Driver version string; may be an empty string 162 * @fw_version: Firmware version string; driver defined; may be an 163 * empty string 164 * @erom_version: Expansion ROM version string; driver defined; may be 165 * an empty string 166 * @bus_info: Device bus address. This should match the dev_name() 167 * string for the underlying bus device, if there is one. May be 168 * an empty string. 169 * @reserved2: Reserved for future use; see the note on reserved space. 170 * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and 171 * %ETHTOOL_SPFLAGS commands; also the number of strings in the 172 * %ETH_SS_PRIV_FLAGS set 173 * @n_stats: Number of uint64_t statistics returned by the %ETHTOOL_GSTATS 174 * command; also the number of strings in the %ETH_SS_STATS set 175 * @testinfo_len: Number of results returned by the %ETHTOOL_TEST 176 * command; also the number of strings in the %ETH_SS_TEST set 177 * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM 178 * and %ETHTOOL_SEEPROM commands, in bytes 179 * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS 180 * command, in bytes 181 * 182 * Users can use the %ETHTOOL_GSSET_INFO command to get the number of 183 * strings in any string set (from Linux 2.6.34). 184 */ 185 struct ethtool_drvinfo { 186 uint32_t cmd; 187 char driver[32]; 188 char version[32]; 189 char fw_version[ETHTOOL_FWVERS_LEN]; 190 char bus_info[ETHTOOL_BUSINFO_LEN]; 191 char erom_version[ETHTOOL_EROMVERS_LEN]; 192 char reserved2[12]; 193 uint32_t n_priv_flags; 194 uint32_t n_stats; 195 uint32_t testinfo_len; 196 uint32_t eedump_len; 197 uint32_t regdump_len; 198 }; 199 200 #define SOPASS_MAX 6 201 202 /** 203 * struct ethtool_wolinfo - Wake-On-Lan configuration 204 * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL 205 * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes. 206 * Read-only. 207 * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes. 208 * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE 209 * is set in @wolopts. 210 */ 211 struct ethtool_wolinfo { 212 uint32_t cmd; 213 uint32_t supported; 214 uint32_t wolopts; 215 uint8_t sopass[SOPASS_MAX]; 216 }; 217 218 /* for passing single values */ 219 struct ethtool_value { 220 uint32_t cmd; 221 uint32_t data; 222 }; 223 224 #define PFC_STORM_PREVENTION_AUTO 0xffff 225 #define PFC_STORM_PREVENTION_DISABLE 0 226 227 enum tunable_id { 228 ETHTOOL_ID_UNSPEC, 229 ETHTOOL_RX_COPYBREAK, 230 ETHTOOL_TX_COPYBREAK, 231 ETHTOOL_PFC_PREVENTION_TOUT, /* timeout in msecs */ 232 ETHTOOL_TX_COPYBREAK_BUF_SIZE, 233 /* 234 * Add your fresh new tunable attribute above and remember to update 235 * tunable_strings[] in net/ethtool/common.c 236 */ 237 __ETHTOOL_TUNABLE_COUNT, 238 }; 239 240 enum tunable_type_id { 241 ETHTOOL_TUNABLE_UNSPEC, 242 ETHTOOL_TUNABLE_U8, 243 ETHTOOL_TUNABLE_U16, 244 ETHTOOL_TUNABLE_U32, 245 ETHTOOL_TUNABLE_U64, 246 ETHTOOL_TUNABLE_STRING, 247 ETHTOOL_TUNABLE_S8, 248 ETHTOOL_TUNABLE_S16, 249 ETHTOOL_TUNABLE_S32, 250 ETHTOOL_TUNABLE_S64, 251 }; 252 253 struct ethtool_tunable { 254 uint32_t cmd; 255 uint32_t id; 256 uint32_t type_id; 257 uint32_t len; 258 void *data[]; 259 }; 260 261 #define DOWNSHIFT_DEV_DEFAULT_COUNT 0xff 262 #define DOWNSHIFT_DEV_DISABLE 0 263 264 /* Time in msecs after which link is reported as down 265 * 0 = lowest time supported by the PHY 266 * 0xff = off, link down detection according to standard 267 */ 268 #define ETHTOOL_PHY_FAST_LINK_DOWN_ON 0 269 #define ETHTOOL_PHY_FAST_LINK_DOWN_OFF 0xff 270 271 /* Energy Detect Power Down (EDPD) is a feature supported by some PHYs, where 272 * the PHY's RX & TX blocks are put into a low-power mode when there is no 273 * link detected (typically cable is un-plugged). For RX, only a minimal 274 * link-detection is available, and for TX the PHY wakes up to send link pulses 275 * to avoid any lock-ups in case the peer PHY may also be running in EDPD mode. 276 * 277 * Some PHYs may support configuration of the wake-up interval for TX pulses, 278 * and some PHYs may support only disabling TX pulses entirely. For the latter 279 * a special value is required (ETHTOOL_PHY_EDPD_NO_TX) so that this can be 280 * configured from userspace (should the user want it). 281 * 282 * The interval units for TX wake-up are in milliseconds, since this should 283 * cover a reasonable range of intervals: 284 * - from 1 millisecond, which does not sound like much of a power-saver 285 * - to ~65 seconds which is quite a lot to wait for a link to come up when 286 * plugging a cable 287 */ 288 #define ETHTOOL_PHY_EDPD_DFLT_TX_MSECS 0xffff 289 #define ETHTOOL_PHY_EDPD_NO_TX 0xfffe 290 #define ETHTOOL_PHY_EDPD_DISABLE 0 291 292 enum phy_tunable_id { 293 ETHTOOL_PHY_ID_UNSPEC, 294 ETHTOOL_PHY_DOWNSHIFT, 295 ETHTOOL_PHY_FAST_LINK_DOWN, 296 ETHTOOL_PHY_EDPD, 297 /* 298 * Add your fresh new phy tunable attribute above and remember to update 299 * phy_tunable_strings[] in net/ethtool/common.c 300 */ 301 __ETHTOOL_PHY_TUNABLE_COUNT, 302 }; 303 304 /** 305 * struct ethtool_regs - hardware register dump 306 * @cmd: Command number = %ETHTOOL_GREGS 307 * @version: Dump format version. This is driver-specific and may 308 * distinguish different chips/revisions. Drivers must use new 309 * version numbers whenever the dump format changes in an 310 * incompatible way. 311 * @len: On entry, the real length of @data. On return, the number of 312 * bytes used. 313 * @data: Buffer for the register dump 314 * 315 * Users should use %ETHTOOL_GDRVINFO to find the maximum length of 316 * a register dump for the interface. They must allocate the buffer 317 * immediately following this structure. 318 */ 319 struct ethtool_regs { 320 uint32_t cmd; 321 uint32_t version; 322 uint32_t len; 323 uint8_t data[]; 324 }; 325 326 /** 327 * struct ethtool_eeprom - EEPROM dump 328 * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or 329 * %ETHTOOL_SEEPROM 330 * @magic: A 'magic cookie' value to guard against accidental changes. 331 * The value passed in to %ETHTOOL_SEEPROM must match the value 332 * returned by %ETHTOOL_GEEPROM for the same device. This is 333 * unused when @cmd is %ETHTOOL_GMODULEEEPROM. 334 * @offset: Offset within the EEPROM to begin reading/writing, in bytes 335 * @len: On entry, number of bytes to read/write. On successful 336 * return, number of bytes actually read/written. In case of 337 * error, this may indicate at what point the error occurred. 338 * @data: Buffer to read/write from 339 * 340 * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find 341 * the length of an on-board or module EEPROM, respectively. They 342 * must allocate the buffer immediately following this structure. 343 */ 344 struct ethtool_eeprom { 345 uint32_t cmd; 346 uint32_t magic; 347 uint32_t offset; 348 uint32_t len; 349 uint8_t data[]; 350 }; 351 352 /** 353 * struct ethtool_eee - Energy Efficient Ethernet information 354 * @cmd: ETHTOOL_{G,S}EEE 355 * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations 356 * for which there is EEE support. 357 * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations 358 * advertised as eee capable. 359 * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex 360 * combinations advertised by the link partner as eee capable. 361 * @eee_active: Result of the eee auto negotiation. 362 * @eee_enabled: EEE configured mode (enabled/disabled). 363 * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given 364 * that eee was negotiated. 365 * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting 366 * its tx lpi (after reaching 'idle' state). Effective only when eee 367 * was negotiated and tx_lpi_enabled was set. 368 * @reserved: Reserved for future use; see the note on reserved space. 369 */ 370 struct ethtool_eee { 371 uint32_t cmd; 372 uint32_t supported; 373 uint32_t advertised; 374 uint32_t lp_advertised; 375 uint32_t eee_active; 376 uint32_t eee_enabled; 377 uint32_t tx_lpi_enabled; 378 uint32_t tx_lpi_timer; 379 uint32_t reserved[2]; 380 }; 381 382 /** 383 * struct ethtool_modinfo - plugin module eeprom information 384 * @cmd: %ETHTOOL_GMODULEINFO 385 * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx 386 * @eeprom_len: Length of the eeprom 387 * @reserved: Reserved for future use; see the note on reserved space. 388 * 389 * This structure is used to return the information to 390 * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM. 391 * The type code indicates the eeprom data format 392 */ 393 struct ethtool_modinfo { 394 uint32_t cmd; 395 uint32_t type; 396 uint32_t eeprom_len; 397 uint32_t reserved[8]; 398 }; 399 400 /** 401 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates 402 * @cmd: ETHTOOL_{G,S}COALESCE 403 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after 404 * a packet arrives. 405 * @rx_max_coalesced_frames: Maximum number of packets to receive 406 * before an RX interrupt. 407 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that 408 * this value applies while an IRQ is being serviced by the host. 409 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames, 410 * except that this value applies while an IRQ is being serviced 411 * by the host. 412 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after 413 * a packet is sent. 414 * @tx_max_coalesced_frames: Maximum number of packets to be sent 415 * before a TX interrupt. 416 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that 417 * this value applies while an IRQ is being serviced by the host. 418 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames, 419 * except that this value applies while an IRQ is being serviced 420 * by the host. 421 * @stats_block_coalesce_usecs: How many usecs to delay in-memory 422 * statistics block updates. Some drivers do not have an 423 * in-memory statistic block, and in such cases this value is 424 * ignored. This value must not be zero. 425 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing. 426 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing. 427 * @pkt_rate_low: Threshold for low packet rate (packets per second). 428 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after 429 * a packet arrives, when the packet rate is below @pkt_rate_low. 430 * @rx_max_coalesced_frames_low: Maximum number of packets to be received 431 * before an RX interrupt, when the packet rate is below @pkt_rate_low. 432 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after 433 * a packet is sent, when the packet rate is below @pkt_rate_low. 434 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before 435 * a TX interrupt, when the packet rate is below @pkt_rate_low. 436 * @pkt_rate_high: Threshold for high packet rate (packets per second). 437 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after 438 * a packet arrives, when the packet rate is above @pkt_rate_high. 439 * @rx_max_coalesced_frames_high: Maximum number of packets to be received 440 * before an RX interrupt, when the packet rate is above @pkt_rate_high. 441 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after 442 * a packet is sent, when the packet rate is above @pkt_rate_high. 443 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before 444 * a TX interrupt, when the packet rate is above @pkt_rate_high. 445 * @rate_sample_interval: How often to do adaptive coalescing packet rate 446 * sampling, measured in seconds. Must not be zero. 447 * 448 * Each pair of (usecs, max_frames) fields specifies that interrupts 449 * should be coalesced until 450 * (usecs > 0 && time_since_first_completion >= usecs) || 451 * (max_frames > 0 && completed_frames >= max_frames) 452 * 453 * It is illegal to set both usecs and max_frames to zero as this 454 * would cause interrupts to never be generated. To disable 455 * coalescing, set usecs = 0 and max_frames = 1. 456 * 457 * Some implementations ignore the value of max_frames and use the 458 * condition time_since_first_completion >= usecs 459 * 460 * This is deprecated. Drivers for hardware that does not support 461 * counting completions should validate that max_frames == !rx_usecs. 462 * 463 * Adaptive RX/TX coalescing is an algorithm implemented by some 464 * drivers to improve latency under low packet rates and improve 465 * throughput under high packet rates. Some drivers only implement 466 * one of RX or TX adaptive coalescing. Anything not implemented by 467 * the driver causes these values to be silently ignored. 468 * 469 * When the packet rate is below @pkt_rate_high but above 470 * @pkt_rate_low (both measured in packets per second) the 471 * normal {rx,tx}_* coalescing parameters are used. 472 */ 473 struct ethtool_coalesce { 474 uint32_t cmd; 475 uint32_t rx_coalesce_usecs; 476 uint32_t rx_max_coalesced_frames; 477 uint32_t rx_coalesce_usecs_irq; 478 uint32_t rx_max_coalesced_frames_irq; 479 uint32_t tx_coalesce_usecs; 480 uint32_t tx_max_coalesced_frames; 481 uint32_t tx_coalesce_usecs_irq; 482 uint32_t tx_max_coalesced_frames_irq; 483 uint32_t stats_block_coalesce_usecs; 484 uint32_t use_adaptive_rx_coalesce; 485 uint32_t use_adaptive_tx_coalesce; 486 uint32_t pkt_rate_low; 487 uint32_t rx_coalesce_usecs_low; 488 uint32_t rx_max_coalesced_frames_low; 489 uint32_t tx_coalesce_usecs_low; 490 uint32_t tx_max_coalesced_frames_low; 491 uint32_t pkt_rate_high; 492 uint32_t rx_coalesce_usecs_high; 493 uint32_t rx_max_coalesced_frames_high; 494 uint32_t tx_coalesce_usecs_high; 495 uint32_t tx_max_coalesced_frames_high; 496 uint32_t rate_sample_interval; 497 }; 498 499 /** 500 * struct ethtool_ringparam - RX/TX ring parameters 501 * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM 502 * @rx_max_pending: Maximum supported number of pending entries per 503 * RX ring. Read-only. 504 * @rx_mini_max_pending: Maximum supported number of pending entries 505 * per RX mini ring. Read-only. 506 * @rx_jumbo_max_pending: Maximum supported number of pending entries 507 * per RX jumbo ring. Read-only. 508 * @tx_max_pending: Maximum supported number of pending entries per 509 * TX ring. Read-only. 510 * @rx_pending: Current maximum number of pending entries per RX ring 511 * @rx_mini_pending: Current maximum number of pending entries per RX 512 * mini ring 513 * @rx_jumbo_pending: Current maximum number of pending entries per RX 514 * jumbo ring 515 * @tx_pending: Current maximum supported number of pending entries 516 * per TX ring 517 * 518 * If the interface does not have separate RX mini and/or jumbo rings, 519 * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0. 520 * 521 * There may also be driver-dependent minimum values for the number 522 * of entries per ring. 523 */ 524 struct ethtool_ringparam { 525 uint32_t cmd; 526 uint32_t rx_max_pending; 527 uint32_t rx_mini_max_pending; 528 uint32_t rx_jumbo_max_pending; 529 uint32_t tx_max_pending; 530 uint32_t rx_pending; 531 uint32_t rx_mini_pending; 532 uint32_t rx_jumbo_pending; 533 uint32_t tx_pending; 534 }; 535 536 /** 537 * struct ethtool_channels - configuring number of network channel 538 * @cmd: ETHTOOL_{G,S}CHANNELS 539 * @max_rx: Read only. Maximum number of receive channel the driver support. 540 * @max_tx: Read only. Maximum number of transmit channel the driver support. 541 * @max_other: Read only. Maximum number of other channel the driver support. 542 * @max_combined: Read only. Maximum number of combined channel the driver 543 * support. Set of queues RX, TX or other. 544 * @rx_count: Valid values are in the range 1 to the max_rx. 545 * @tx_count: Valid values are in the range 1 to the max_tx. 546 * @other_count: Valid values are in the range 1 to the max_other. 547 * @combined_count: Valid values are in the range 1 to the max_combined. 548 * 549 * This can be used to configure RX, TX and other channels. 550 */ 551 552 struct ethtool_channels { 553 uint32_t cmd; 554 uint32_t max_rx; 555 uint32_t max_tx; 556 uint32_t max_other; 557 uint32_t max_combined; 558 uint32_t rx_count; 559 uint32_t tx_count; 560 uint32_t other_count; 561 uint32_t combined_count; 562 }; 563 564 /** 565 * struct ethtool_pauseparam - Ethernet pause (flow control) parameters 566 * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM 567 * @autoneg: Flag to enable autonegotiation of pause frame use 568 * @rx_pause: Flag to enable reception of pause frames 569 * @tx_pause: Flag to enable transmission of pause frames 570 * 571 * Drivers should reject a non-zero setting of @autoneg when 572 * autoneogotiation is disabled (or not supported) for the link. 573 * 574 * If the link is autonegotiated, drivers should use 575 * mii_advertise_flowctrl() or similar code to set the advertised 576 * pause frame capabilities based on the @rx_pause and @tx_pause flags, 577 * even if @autoneg is zero. They should also allow the advertised 578 * pause frame capabilities to be controlled directly through the 579 * advertising field of &struct ethtool_cmd. 580 * 581 * If @autoneg is non-zero, the MAC is configured to send and/or 582 * receive pause frames according to the result of autonegotiation. 583 * Otherwise, it is configured directly based on the @rx_pause and 584 * @tx_pause flags. 585 */ 586 struct ethtool_pauseparam { 587 uint32_t cmd; 588 uint32_t autoneg; 589 uint32_t rx_pause; 590 uint32_t tx_pause; 591 }; 592 593 /* Link extended state */ 594 enum ethtool_link_ext_state { 595 ETHTOOL_LINK_EXT_STATE_AUTONEG, 596 ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE, 597 ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH, 598 ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY, 599 ETHTOOL_LINK_EXT_STATE_NO_CABLE, 600 ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE, 601 ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE, 602 ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE, 603 ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED, 604 ETHTOOL_LINK_EXT_STATE_OVERHEAT, 605 ETHTOOL_LINK_EXT_STATE_MODULE, 606 }; 607 608 /* More information in addition to ETHTOOL_LINK_EXT_STATE_AUTONEG. */ 609 enum ethtool_link_ext_substate_autoneg { 610 ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED = 1, 611 ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED, 612 ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED, 613 ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE, 614 ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE, 615 ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD, 616 }; 617 618 /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE. 619 */ 620 enum ethtool_link_ext_substate_link_training { 621 ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED = 1, 622 ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT, 623 ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY, 624 ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT, 625 }; 626 627 /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH. 628 */ 629 enum ethtool_link_ext_substate_link_logical_mismatch { 630 ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK = 1, 631 ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK, 632 ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS, 633 ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED, 634 ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED, 635 }; 636 637 /* More information in addition to ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY. 638 */ 639 enum ethtool_link_ext_substate_bad_signal_integrity { 640 ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS = 1, 641 ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE, 642 ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST, 643 ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS, 644 }; 645 646 /* More information in addition to ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE. */ 647 enum ethtool_link_ext_substate_cable_issue { 648 ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE = 1, 649 ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE, 650 }; 651 652 /* More information in addition to ETHTOOL_LINK_EXT_STATE_MODULE. */ 653 enum ethtool_link_ext_substate_module { 654 ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY = 1, 655 }; 656 657 #define ETH_GSTRING_LEN 32 658 659 /** 660 * enum ethtool_stringset - string set ID 661 * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST 662 * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS 663 * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with 664 * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS 665 * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE; 666 * now deprecated 667 * @ETH_SS_FEATURES: Device feature names 668 * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names 669 * @ETH_SS_TUNABLES: tunable names 670 * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS 671 * @ETH_SS_PHY_TUNABLES: PHY tunable names 672 * @ETH_SS_LINK_MODES: link mode names 673 * @ETH_SS_MSG_CLASSES: debug message class names 674 * @ETH_SS_WOL_MODES: wake-on-lan modes 675 * @ETH_SS_SOF_TIMESTAMPING: SOF_TIMESTAMPING_* flags 676 * @ETH_SS_TS_TX_TYPES: timestamping Tx types 677 * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters 678 * @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types 679 * @ETH_SS_STATS_STD: standardized stats 680 * @ETH_SS_STATS_ETH_PHY: names of IEEE 802.3 PHY statistics 681 * @ETH_SS_STATS_ETH_MAC: names of IEEE 802.3 MAC statistics 682 * @ETH_SS_STATS_ETH_CTRL: names of IEEE 802.3 MAC Control statistics 683 * @ETH_SS_STATS_RMON: names of RMON statistics 684 * 685 * @ETH_SS_COUNT: number of defined string sets 686 */ 687 enum ethtool_stringset { 688 ETH_SS_TEST = 0, 689 ETH_SS_STATS, 690 ETH_SS_PRIV_FLAGS, 691 ETH_SS_NTUPLE_FILTERS, 692 ETH_SS_FEATURES, 693 ETH_SS_RSS_HASH_FUNCS, 694 ETH_SS_TUNABLES, 695 ETH_SS_PHY_STATS, 696 ETH_SS_PHY_TUNABLES, 697 ETH_SS_LINK_MODES, 698 ETH_SS_MSG_CLASSES, 699 ETH_SS_WOL_MODES, 700 ETH_SS_SOF_TIMESTAMPING, 701 ETH_SS_TS_TX_TYPES, 702 ETH_SS_TS_RX_FILTERS, 703 ETH_SS_UDP_TUNNEL_TYPES, 704 ETH_SS_STATS_STD, 705 ETH_SS_STATS_ETH_PHY, 706 ETH_SS_STATS_ETH_MAC, 707 ETH_SS_STATS_ETH_CTRL, 708 ETH_SS_STATS_RMON, 709 710 /* add new constants above here */ 711 ETH_SS_COUNT 712 }; 713 714 /** 715 * enum ethtool_module_power_mode_policy - plug-in module power mode policy 716 * @ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH: Module is always in high power mode. 717 * @ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO: Module is transitioned by the host 718 * to high power mode when the first port using it is put administratively 719 * up and to low power mode when the last port using it is put 720 * administratively down. 721 */ 722 enum ethtool_module_power_mode_policy { 723 ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH = 1, 724 ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO, 725 }; 726 727 /** 728 * enum ethtool_module_power_mode - plug-in module power mode 729 * @ETHTOOL_MODULE_POWER_MODE_LOW: Module is in low power mode. 730 * @ETHTOOL_MODULE_POWER_MODE_HIGH: Module is in high power mode. 731 */ 732 enum ethtool_module_power_mode { 733 ETHTOOL_MODULE_POWER_MODE_LOW = 1, 734 ETHTOOL_MODULE_POWER_MODE_HIGH, 735 }; 736 737 /** 738 * enum ethtool_podl_pse_admin_state - operational state of the PoDL PSE 739 * functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState 740 * @ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN: state of PoDL PSE functions are 741 * unknown 742 * @ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED: PoDL PSE functions are disabled 743 * @ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED: PoDL PSE functions are enabled 744 */ 745 enum ethtool_podl_pse_admin_state { 746 ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN = 1, 747 ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED, 748 ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED, 749 }; 750 751 /** 752 * enum ethtool_podl_pse_pw_d_status - power detection status of the PoDL PSE. 753 * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus: 754 * @ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN: PoDL PSE 755 * @ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED: "The enumeration “disabled” is 756 * asserted true when the PoDL PSE state diagram variable mr_pse_enable is 757 * false" 758 * @ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING: "The enumeration “searching” is 759 * asserted true when either of the PSE state diagram variables 760 * pi_detecting or pi_classifying is true." 761 * @ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING: "The enumeration “deliveringPower” 762 * is asserted true when the PoDL PSE state diagram variable pi_powered is 763 * true." 764 * @ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP: "The enumeration “sleep” is asserted 765 * true when the PoDL PSE state diagram variable pi_sleeping is true." 766 * @ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE: "The enumeration “idle” is asserted true 767 * when the logical combination of the PoDL PSE state diagram variables 768 * pi_prebiased*!pi_sleeping is true." 769 * @ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR: "The enumeration “error” is asserted 770 * true when the PoDL PSE state diagram variable overload_held is true." 771 */ 772 enum ethtool_podl_pse_pw_d_status { 773 ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN = 1, 774 ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED, 775 ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING, 776 ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING, 777 ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP, 778 ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE, 779 ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR, 780 }; 781 782 /** 783 * struct ethtool_gstrings - string set for data tagging 784 * @cmd: Command number = %ETHTOOL_GSTRINGS 785 * @string_set: String set ID; one of &enum ethtool_stringset 786 * @len: On return, the number of strings in the string set 787 * @data: Buffer for strings. Each string is null-padded to a size of 788 * %ETH_GSTRING_LEN. 789 * 790 * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in 791 * the string set. They must allocate a buffer of the appropriate 792 * size immediately following this structure. 793 */ 794 struct ethtool_gstrings { 795 uint32_t cmd; 796 uint32_t string_set; 797 uint32_t len; 798 uint8_t data[]; 799 }; 800 801 /** 802 * struct ethtool_sset_info - string set information 803 * @cmd: Command number = %ETHTOOL_GSSET_INFO 804 * @reserved: Reserved for future use; see the note on reserved space. 805 * @sset_mask: On entry, a bitmask of string sets to query, with bits 806 * numbered according to &enum ethtool_stringset. On return, a 807 * bitmask of those string sets queried that are supported. 808 * @data: Buffer for string set sizes. On return, this contains the 809 * size of each string set that was queried and supported, in 810 * order of ID. 811 * 812 * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on 813 * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the 814 * size of set 1 and @data[1] contains the size of set 2. 815 * 816 * Users must allocate a buffer of the appropriate size (4 * number of 817 * sets queried) immediately following this structure. 818 */ 819 struct ethtool_sset_info { 820 uint32_t cmd; 821 uint32_t reserved; 822 uint64_t sset_mask; 823 uint32_t data[]; 824 }; 825 826 /** 827 * enum ethtool_test_flags - flags definition of ethtool_test 828 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise 829 * only online tests. 830 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails. 831 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback 832 * test. 833 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test 834 */ 835 836 enum ethtool_test_flags { 837 ETH_TEST_FL_OFFLINE = (1 << 0), 838 ETH_TEST_FL_FAILED = (1 << 1), 839 ETH_TEST_FL_EXTERNAL_LB = (1 << 2), 840 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3), 841 }; 842 843 /** 844 * struct ethtool_test - device self-test invocation 845 * @cmd: Command number = %ETHTOOL_TEST 846 * @flags: A bitmask of flags from &enum ethtool_test_flags. Some 847 * flags may be set by the user on entry; others may be set by 848 * the driver on return. 849 * @reserved: Reserved for future use; see the note on reserved space. 850 * @len: On return, the number of test results 851 * @data: Array of test results 852 * 853 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the 854 * number of test results that will be returned. They must allocate a 855 * buffer of the appropriate size (8 * number of results) immediately 856 * following this structure. 857 */ 858 struct ethtool_test { 859 uint32_t cmd; 860 uint32_t flags; 861 uint32_t reserved; 862 uint32_t len; 863 uint64_t data[]; 864 }; 865 866 /** 867 * struct ethtool_stats - device-specific statistics 868 * @cmd: Command number = %ETHTOOL_GSTATS 869 * @n_stats: On return, the number of statistics 870 * @data: Array of statistics 871 * 872 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the 873 * number of statistics that will be returned. They must allocate a 874 * buffer of the appropriate size (8 * number of statistics) 875 * immediately following this structure. 876 */ 877 struct ethtool_stats { 878 uint32_t cmd; 879 uint32_t n_stats; 880 uint64_t data[]; 881 }; 882 883 /** 884 * struct ethtool_perm_addr - permanent hardware address 885 * @cmd: Command number = %ETHTOOL_GPERMADDR 886 * @size: On entry, the size of the buffer. On return, the size of the 887 * address. The command fails if the buffer is too small. 888 * @data: Buffer for the address 889 * 890 * Users must allocate the buffer immediately following this structure. 891 * A buffer size of %MAX_ADDR_LEN should be sufficient for any address 892 * type. 893 */ 894 struct ethtool_perm_addr { 895 uint32_t cmd; 896 uint32_t size; 897 uint8_t data[]; 898 }; 899 900 /* boolean flags controlling per-interface behavior characteristics. 901 * When reading, the flag indicates whether or not a certain behavior 902 * is enabled/present. When writing, the flag indicates whether 903 * or not the driver should turn on (set) or off (clear) a behavior. 904 * 905 * Some behaviors may read-only (unconditionally absent or present). 906 * If such is the case, return EINVAL in the set-flags operation if the 907 * flag differs from the read-only value. 908 */ 909 enum ethtool_flags { 910 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */ 911 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */ 912 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 913 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */ 914 ETH_FLAG_RXHASH = (1 << 28), 915 }; 916 917 /* The following structures are for supporting RX network flow 918 * classification and RX n-tuple configuration. Note, all multibyte 919 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to 920 * be in network byte order. 921 */ 922 923 /** 924 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. 925 * @ip4src: Source host 926 * @ip4dst: Destination host 927 * @psrc: Source port 928 * @pdst: Destination port 929 * @tos: Type-of-service 930 * 931 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. 932 */ 933 struct ethtool_tcpip4_spec { 934 uint32_t ip4src; 935 uint32_t ip4dst; 936 uint16_t psrc; 937 uint16_t pdst; 938 uint8_t tos; 939 }; 940 941 /** 942 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 943 * @ip4src: Source host 944 * @ip4dst: Destination host 945 * @spi: Security parameters index 946 * @tos: Type-of-service 947 * 948 * This can be used to specify an IPsec transport or tunnel over IPv4. 949 */ 950 struct ethtool_ah_espip4_spec { 951 uint32_t ip4src; 952 uint32_t ip4dst; 953 uint32_t spi; 954 uint8_t tos; 955 }; 956 957 #define ETH_RX_NFC_IP4 1 958 959 /** 960 * struct ethtool_usrip4_spec - general flow specification for IPv4 961 * @ip4src: Source host 962 * @ip4dst: Destination host 963 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 964 * @tos: Type-of-service 965 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 966 * @proto: Transport protocol number; mask must be 0 967 */ 968 struct ethtool_usrip4_spec { 969 uint32_t ip4src; 970 uint32_t ip4dst; 971 uint32_t l4_4_bytes; 972 uint8_t tos; 973 uint8_t ip_ver; 974 uint8_t proto; 975 }; 976 977 /** 978 * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc. 979 * @ip6src: Source host 980 * @ip6dst: Destination host 981 * @psrc: Source port 982 * @pdst: Destination port 983 * @tclass: Traffic Class 984 * 985 * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow. 986 */ 987 struct ethtool_tcpip6_spec { 988 uint32_t ip6src[4]; 989 uint32_t ip6dst[4]; 990 uint16_t psrc; 991 uint16_t pdst; 992 uint8_t tclass; 993 }; 994 995 /** 996 * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6 997 * @ip6src: Source host 998 * @ip6dst: Destination host 999 * @spi: Security parameters index 1000 * @tclass: Traffic Class 1001 * 1002 * This can be used to specify an IPsec transport or tunnel over IPv6. 1003 */ 1004 struct ethtool_ah_espip6_spec { 1005 uint32_t ip6src[4]; 1006 uint32_t ip6dst[4]; 1007 uint32_t spi; 1008 uint8_t tclass; 1009 }; 1010 1011 /** 1012 * struct ethtool_usrip6_spec - general flow specification for IPv6 1013 * @ip6src: Source host 1014 * @ip6dst: Destination host 1015 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 1016 * @tclass: Traffic Class 1017 * @l4_proto: Transport protocol number (nexthdr after any Extension Headers) 1018 */ 1019 struct ethtool_usrip6_spec { 1020 uint32_t ip6src[4]; 1021 uint32_t ip6dst[4]; 1022 uint32_t l4_4_bytes; 1023 uint8_t tclass; 1024 uint8_t l4_proto; 1025 }; 1026 1027 union ethtool_flow_union { 1028 struct ethtool_tcpip4_spec tcp_ip4_spec; 1029 struct ethtool_tcpip4_spec udp_ip4_spec; 1030 struct ethtool_tcpip4_spec sctp_ip4_spec; 1031 struct ethtool_ah_espip4_spec ah_ip4_spec; 1032 struct ethtool_ah_espip4_spec esp_ip4_spec; 1033 struct ethtool_usrip4_spec usr_ip4_spec; 1034 struct ethtool_tcpip6_spec tcp_ip6_spec; 1035 struct ethtool_tcpip6_spec udp_ip6_spec; 1036 struct ethtool_tcpip6_spec sctp_ip6_spec; 1037 struct ethtool_ah_espip6_spec ah_ip6_spec; 1038 struct ethtool_ah_espip6_spec esp_ip6_spec; 1039 struct ethtool_usrip6_spec usr_ip6_spec; 1040 struct eth_header ether_spec; 1041 uint8_t hdata[52]; 1042 }; 1043 1044 /** 1045 * struct ethtool_flow_ext - additional RX flow fields 1046 * @h_dest: destination MAC address 1047 * @vlan_etype: VLAN EtherType 1048 * @vlan_tci: VLAN tag control information 1049 * @data: user defined data 1050 * @padding: Reserved for future use; see the note on reserved space. 1051 * 1052 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT 1053 * is set in &struct ethtool_rx_flow_spec @flow_type. 1054 * @h_dest is valid if %FLOW_MAC_EXT is set. 1055 */ 1056 struct ethtool_flow_ext { 1057 uint8_t padding[2]; 1058 unsigned char h_dest[ETH_ALEN]; 1059 uint16_t vlan_etype; 1060 uint16_t vlan_tci; 1061 uint32_t data[2]; 1062 }; 1063 1064 /** 1065 * struct ethtool_rx_flow_spec - classification rule for RX flows 1066 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 1067 * @h_u: Flow fields to match (dependent on @flow_type) 1068 * @h_ext: Additional fields to match 1069 * @m_u: Masks for flow field bits to be matched 1070 * @m_ext: Masks for additional field bits to be matched 1071 * Note, all additional fields must be ignored unless @flow_type 1072 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag 1073 * (see &struct ethtool_flow_ext description). 1074 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC 1075 * if packets should be discarded, or %RX_CLS_FLOW_WAKE if the 1076 * packets should be used for Wake-on-LAN with %WAKE_FILTER 1077 * @location: Location of rule in the table. Locations must be 1078 * numbered such that a flow matching multiple rules will be 1079 * classified according to the first (lowest numbered) rule. 1080 */ 1081 struct ethtool_rx_flow_spec { 1082 uint32_t flow_type; 1083 union ethtool_flow_union h_u; 1084 struct ethtool_flow_ext h_ext; 1085 union ethtool_flow_union m_u; 1086 struct ethtool_flow_ext m_ext; 1087 uint64_t ring_cookie; 1088 uint32_t location; 1089 }; 1090 1091 /* How rings are laid out when accessing virtual functions or 1092 * offloaded queues is device specific. To allow users to do flow 1093 * steering and specify these queues the ring cookie is partitioned 1094 * into a 32bit queue index with an 8 bit virtual function id. 1095 * This also leaves the 3bytes for further specifiers. It is possible 1096 * future devices may support more than 256 virtual functions if 1097 * devices start supporting PCIe w/ARI. However at the moment I 1098 * do not know of any devices that support this so I do not reserve 1099 * space for this at this time. If a future patch consumes the next 1100 * byte it should be aware of this possibility. 1101 */ 1102 #define ETHTOOL_RX_FLOW_SPEC_RING 0x00000000FFFFFFFFLL 1103 #define ETHTOOL_RX_FLOW_SPEC_RING_VF 0x000000FF00000000LL 1104 #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32 1105 static inline uint64_t ethtool_get_flow_spec_ring(uint64_t ring_cookie) 1106 { 1107 return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie; 1108 } 1109 1110 static inline uint64_t ethtool_get_flow_spec_ring_vf(uint64_t ring_cookie) 1111 { 1112 return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >> 1113 ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF; 1114 } 1115 1116 /** 1117 * struct ethtool_rxnfc - command to get or set RX flow classification rules 1118 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, 1119 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, 1120 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS 1121 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW 1122 * @data: Command-dependent value 1123 * @fs: Flow classification rule 1124 * @rss_context: RSS context to be affected 1125 * @rule_cnt: Number of rules to be affected 1126 * @rule_locs: Array of used rule locations 1127 * 1128 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating 1129 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following 1130 * structure fields must not be used, except that if @flow_type includes 1131 * the %FLOW_RSS flag, then @rss_context determines which RSS context to 1132 * act on. 1133 * 1134 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues 1135 * on return. 1136 * 1137 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined 1138 * rules on return. If @data is non-zero on return then it is the 1139 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the 1140 * driver supports any special location values. If that flag is not 1141 * set in @data then special location values should not be used. 1142 * 1143 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an 1144 * existing rule on entry and @fs contains the rule on return; if 1145 * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is 1146 * filled with the RSS context ID associated with the rule. 1147 * 1148 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the 1149 * user buffer for @rule_locs on entry. On return, @data is the size 1150 * of the rule table, @rule_cnt is the number of defined rules, and 1151 * @rule_locs contains the locations of the defined rules. Drivers 1152 * must use the second parameter to get_rxnfc() instead of @rule_locs. 1153 * 1154 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update. 1155 * @fs.@location either specifies the location to use or is a special 1156 * location value with %RX_CLS_LOC_SPECIAL flag set. On return, 1157 * @fs.@location is the actual rule location. If @fs.@flow_type 1158 * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to 1159 * use for flow spreading traffic which matches this rule. The value 1160 * from the rxfh indirection table will be added to @fs.@ring_cookie 1161 * to choose which ring to deliver to. 1162 * 1163 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an 1164 * existing rule on entry. 1165 * 1166 * A driver supporting the special location values for 1167 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused 1168 * location, and may remove a rule at a later location (lower 1169 * priority) that matches exactly the same set of flows. The special 1170 * values are %RX_CLS_LOC_ANY, selecting any location; 1171 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum 1172 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable 1173 * location (minimum priority). Additional special values may be 1174 * defined in future and drivers must return -%EINVAL for any 1175 * unrecognised value. 1176 */ 1177 struct ethtool_rxnfc { 1178 uint32_t cmd; 1179 uint32_t flow_type; 1180 uint64_t data; 1181 struct ethtool_rx_flow_spec fs; 1182 union { 1183 uint32_t rule_cnt; 1184 uint32_t rss_context; 1185 }; 1186 uint32_t rule_locs[0]; 1187 }; 1188 1189 1190 /** 1191 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection 1192 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR 1193 * @size: On entry, the array size of the user buffer, which may be zero. 1194 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware 1195 * indirection table. 1196 * @ring_index: RX ring/queue index for each hash value 1197 * 1198 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size 1199 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means 1200 * the table should be reset to default values. This last feature 1201 * is not supported by the original implementations. 1202 */ 1203 struct ethtool_rxfh_indir { 1204 uint32_t cmd; 1205 uint32_t size; 1206 uint32_t ring_index[]; 1207 }; 1208 1209 /** 1210 * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key. 1211 * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH 1212 * @rss_context: RSS context identifier. Context 0 is the default for normal 1213 * traffic; other contexts can be referenced as the destination for RX flow 1214 * classification rules. %ETH_RXFH_CONTEXT_ALLOC is used with command 1215 * %ETHTOOL_SRSSH to allocate a new RSS context; on return this field will 1216 * contain the ID of the newly allocated context. 1217 * @indir_size: On entry, the array size of the user buffer for the 1218 * indirection table, which may be zero, or (for %ETHTOOL_SRSSH), 1219 * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH, 1220 * the array size of the hardware indirection table. 1221 * @key_size: On entry, the array size of the user buffer for the hash key, 1222 * which may be zero. On return from %ETHTOOL_GRSSH, the size of the 1223 * hardware hash key. 1224 * @hfunc: Defines the current RSS hash function used by HW (or to be set to). 1225 * Valid values are one of the %ETH_RSS_HASH_*. 1226 * @rsvd8: Reserved for future use; see the note on reserved space. 1227 * @rsvd32: Reserved for future use; see the note on reserved space. 1228 * @rss_config: RX ring/queue index for each hash value i.e., indirection table 1229 * of @indir_size uint32_t elements, followed by hash key of @key_size 1230 * bytes. 1231 * 1232 * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the 1233 * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of 1234 * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested 1235 * and a @indir_size of zero means the indir table should be reset to default 1236 * values (if @rss_context == 0) or that the RSS context should be deleted. 1237 * An hfunc of zero means that hash function setting is not requested. 1238 */ 1239 struct ethtool_rxfh { 1240 uint32_t cmd; 1241 uint32_t rss_context; 1242 uint32_t indir_size; 1243 uint32_t key_size; 1244 uint8_t hfunc; 1245 uint8_t rsvd8[3]; 1246 uint32_t rsvd32; 1247 uint32_t rss_config[]; 1248 }; 1249 #define ETH_RXFH_CONTEXT_ALLOC 0xffffffff 1250 #define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff 1251 1252 /** 1253 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter 1254 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 1255 * @h_u: Flow field values to match (dependent on @flow_type) 1256 * @m_u: Masks for flow field value bits to be ignored 1257 * @vlan_tag: VLAN tag to match 1258 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored 1259 * @data: Driver-dependent data to match 1260 * @data_mask: Mask for driver-dependent data bits to be ignored 1261 * @action: RX ring/queue index to deliver to (non-negative) or other action 1262 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) 1263 * 1264 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where 1265 * a field value and mask are both zero this is treated as if all mask 1266 * bits are set i.e. the field is ignored. 1267 */ 1268 struct ethtool_rx_ntuple_flow_spec { 1269 uint32_t flow_type; 1270 union { 1271 struct ethtool_tcpip4_spec tcp_ip4_spec; 1272 struct ethtool_tcpip4_spec udp_ip4_spec; 1273 struct ethtool_tcpip4_spec sctp_ip4_spec; 1274 struct ethtool_ah_espip4_spec ah_ip4_spec; 1275 struct ethtool_ah_espip4_spec esp_ip4_spec; 1276 struct ethtool_usrip4_spec usr_ip4_spec; 1277 struct eth_header ether_spec; 1278 uint8_t hdata[72]; 1279 } h_u, m_u; 1280 1281 uint16_t vlan_tag; 1282 uint16_t vlan_tag_mask; 1283 uint64_t data; 1284 uint64_t data_mask; 1285 1286 int32_t action; 1287 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */ 1288 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */ 1289 }; 1290 1291 /** 1292 * struct ethtool_rx_ntuple - command to set or clear RX flow filter 1293 * @cmd: Command number - %ETHTOOL_SRXNTUPLE 1294 * @fs: Flow filter specification 1295 */ 1296 struct ethtool_rx_ntuple { 1297 uint32_t cmd; 1298 struct ethtool_rx_ntuple_flow_spec fs; 1299 }; 1300 1301 #define ETHTOOL_FLASH_MAX_FILENAME 128 1302 enum ethtool_flash_op_type { 1303 ETHTOOL_FLASH_ALL_REGIONS = 0, 1304 }; 1305 1306 /* for passing firmware flashing related parameters */ 1307 struct ethtool_flash { 1308 uint32_t cmd; 1309 uint32_t region; 1310 char data[ETHTOOL_FLASH_MAX_FILENAME]; 1311 }; 1312 1313 /** 1314 * struct ethtool_dump - used for retrieving, setting device dump 1315 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or 1316 * %ETHTOOL_SET_DUMP 1317 * @version: FW version of the dump, filled in by driver 1318 * @flag: driver dependent flag for dump setting, filled in by driver during 1319 * get and filled in by ethtool for set operation. 1320 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when 1321 * firmware dump is disabled. 1322 * @len: length of dump data, used as the length of the user buffer on entry to 1323 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver 1324 * for %ETHTOOL_GET_DUMP_FLAG command 1325 * @data: data collected for get dump data operation 1326 */ 1327 struct ethtool_dump { 1328 uint32_t cmd; 1329 uint32_t version; 1330 uint32_t flag; 1331 uint32_t len; 1332 uint8_t data[]; 1333 }; 1334 1335 #define ETH_FW_DUMP_DISABLE 0 1336 1337 /* for returning and changing feature sets */ 1338 1339 /** 1340 * struct ethtool_get_features_block - block with state of 32 features 1341 * @available: mask of changeable features 1342 * @requested: mask of features requested to be enabled if possible 1343 * @active: mask of currently enabled features 1344 * @never_changed: mask of features not changeable for any device 1345 */ 1346 struct ethtool_get_features_block { 1347 uint32_t available; 1348 uint32_t requested; 1349 uint32_t active; 1350 uint32_t never_changed; 1351 }; 1352 1353 /** 1354 * struct ethtool_gfeatures - command to get state of device's features 1355 * @cmd: command number = %ETHTOOL_GFEATURES 1356 * @size: On entry, the number of elements in the features[] array; 1357 * on return, the number of elements in features[] needed to hold 1358 * all features 1359 * @features: state of features 1360 */ 1361 struct ethtool_gfeatures { 1362 uint32_t cmd; 1363 uint32_t size; 1364 struct ethtool_get_features_block features[]; 1365 }; 1366 1367 /** 1368 * struct ethtool_set_features_block - block with request for 32 features 1369 * @valid: mask of features to be changed 1370 * @requested: values of features to be changed 1371 */ 1372 struct ethtool_set_features_block { 1373 uint32_t valid; 1374 uint32_t requested; 1375 }; 1376 1377 /** 1378 * struct ethtool_sfeatures - command to request change in device's features 1379 * @cmd: command number = %ETHTOOL_SFEATURES 1380 * @size: array size of the features[] array 1381 * @features: feature change masks 1382 */ 1383 struct ethtool_sfeatures { 1384 uint32_t cmd; 1385 uint32_t size; 1386 struct ethtool_set_features_block features[]; 1387 }; 1388 1389 /** 1390 * struct ethtool_ts_info - holds a device's timestamping and PHC association 1391 * @cmd: command number = %ETHTOOL_GET_TS_INFO 1392 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags 1393 * @phc_index: device index of the associated PHC, or -1 if there is none 1394 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values 1395 * @tx_reserved: Reserved for future use; see the note on reserved space. 1396 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values 1397 * @rx_reserved: Reserved for future use; see the note on reserved space. 1398 * 1399 * The bits in the 'tx_types' and 'rx_filters' fields correspond to 1400 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values, 1401 * respectively. For example, if the device supports HWTSTAMP_TX_ON, 1402 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set. 1403 * 1404 * Drivers should only report the filters they actually support without 1405 * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for 1406 * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the 1407 * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op. 1408 */ 1409 struct ethtool_ts_info { 1410 uint32_t cmd; 1411 uint32_t so_timestamping; 1412 int32_t phc_index; 1413 uint32_t tx_types; 1414 uint32_t tx_reserved[3]; 1415 uint32_t rx_filters; 1416 uint32_t rx_reserved[3]; 1417 }; 1418 1419 /* 1420 * %ETHTOOL_SFEATURES changes features present in features[].valid to the 1421 * values of corresponding bits in features[].requested. Bits in .requested 1422 * not set in .valid or not changeable are ignored. 1423 * 1424 * Returns %EINVAL when .valid contains undefined or never-changeable bits 1425 * or size is not equal to required number of features words (32-bit blocks). 1426 * Returns >= 0 if request was completed; bits set in the value mean: 1427 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not 1428 * changeable (not present in %ETHTOOL_GFEATURES' features[].available) 1429 * those bits were ignored. 1430 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the 1431 * resulting state of bits masked by .valid is not equal to .requested. 1432 * Probably there are other device-specific constraints on some features 1433 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered 1434 * here as though ignored bits were cleared. 1435 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling 1436 * compatibility functions. Requested offload state cannot be properly 1437 * managed by kernel. 1438 * 1439 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of 1440 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands 1441 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least 1442 * significant bit in features[0] fields. Empty strings mark undefined features. 1443 */ 1444 enum ethtool_sfeatures_retval_bits { 1445 ETHTOOL_F_UNSUPPORTED__BIT, 1446 ETHTOOL_F_WISH__BIT, 1447 ETHTOOL_F_COMPAT__BIT, 1448 }; 1449 1450 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT) 1451 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT) 1452 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT) 1453 1454 #define MAX_NUM_QUEUE 4096 1455 1456 /** 1457 * struct ethtool_per_queue_op - apply sub command to the queues in mask. 1458 * @cmd: ETHTOOL_PERQUEUE 1459 * @sub_command: the sub command which apply to each queues 1460 * @queue_mask: Bitmap of the queues which sub command apply to 1461 * @data: A complete command structure following for each of the queues addressed 1462 */ 1463 struct ethtool_per_queue_op { 1464 uint32_t cmd; 1465 uint32_t sub_command; 1466 uint32_t queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)]; 1467 char data[]; 1468 }; 1469 1470 /** 1471 * struct ethtool_fecparam - Ethernet Forward Error Correction parameters 1472 * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM 1473 * @active_fec: FEC mode which is active on the port, single bit set, GET only. 1474 * @fec: Bitmask of configured FEC modes. 1475 * @reserved: Reserved for future extensions, ignore on GET, write 0 for SET. 1476 * 1477 * Note that @reserved was never validated on input and ethtool user space 1478 * left it uninitialized when calling SET. Hence going forward it can only be 1479 * used to return a value to userspace with GET. 1480 * 1481 * FEC modes supported by the device can be read via %ETHTOOL_GLINKSETTINGS. 1482 * FEC settings are configured by link autonegotiation whenever it's enabled. 1483 * With autoneg on %ETHTOOL_GFECPARAM can be used to read the current mode. 1484 * 1485 * When autoneg is disabled %ETHTOOL_SFECPARAM controls the FEC settings. 1486 * It is recommended that drivers only accept a single bit set in @fec. 1487 * When multiple bits are set in @fec drivers may pick mode in an implementation 1488 * dependent way. Drivers should reject mixing %ETHTOOL_FEC_AUTO_BIT with other 1489 * FEC modes, because it's unclear whether in this case other modes constrain 1490 * AUTO or are independent choices. 1491 * Drivers must reject SET requests if they support none of the requested modes. 1492 * 1493 * If device does not support FEC drivers may use %ETHTOOL_FEC_NONE instead 1494 * of returning %EOPNOTSUPP from %ETHTOOL_GFECPARAM. 1495 * 1496 * See enum ethtool_fec_config_bits for definition of valid bits for both 1497 * @fec and @active_fec. 1498 */ 1499 struct ethtool_fecparam { 1500 uint32_t cmd; 1501 /* bitmask of FEC modes */ 1502 uint32_t active_fec; 1503 uint32_t fec; 1504 uint32_t reserved; 1505 }; 1506 1507 /** 1508 * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration 1509 * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not 1510 * be used together with other bits. GET only. 1511 * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually 1512 * based link mode and SFP parameters read from module's 1513 * EEPROM. This bit does _not_ mean autonegotiation. 1514 * @ETHTOOL_FEC_OFF_BIT: No FEC Mode 1515 * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode 1516 * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode 1517 * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet 1518 * Consortium) 1519 */ 1520 enum ethtool_fec_config_bits { 1521 ETHTOOL_FEC_NONE_BIT, 1522 ETHTOOL_FEC_AUTO_BIT, 1523 ETHTOOL_FEC_OFF_BIT, 1524 ETHTOOL_FEC_RS_BIT, 1525 ETHTOOL_FEC_BASER_BIT, 1526 ETHTOOL_FEC_LLRS_BIT, 1527 }; 1528 1529 #define ETHTOOL_FEC_NONE (1 << ETHTOOL_FEC_NONE_BIT) 1530 #define ETHTOOL_FEC_AUTO (1 << ETHTOOL_FEC_AUTO_BIT) 1531 #define ETHTOOL_FEC_OFF (1 << ETHTOOL_FEC_OFF_BIT) 1532 #define ETHTOOL_FEC_RS (1 << ETHTOOL_FEC_RS_BIT) 1533 #define ETHTOOL_FEC_BASER (1 << ETHTOOL_FEC_BASER_BIT) 1534 #define ETHTOOL_FEC_LLRS (1 << ETHTOOL_FEC_LLRS_BIT) 1535 1536 /* CMDs currently supported */ 1537 #define ETHTOOL_GSET 0x00000001 /* DEPRECATED, Get settings. 1538 * Please use ETHTOOL_GLINKSETTINGS 1539 */ 1540 #define ETHTOOL_SSET 0x00000002 /* DEPRECATED, Set settings. 1541 * Please use ETHTOOL_SLINKSETTINGS 1542 */ 1543 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 1544 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 1545 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 1546 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 1547 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 1548 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 1549 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 1550 /* Get link status for host, i.e. whether the interface *and* the 1551 * physical port (if there is one) are up (ethtool_value). */ 1552 #define ETHTOOL_GLINK 0x0000000a 1553 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 1554 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 1555 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 1556 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 1557 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 1558 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 1559 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 1560 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 1561 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 1562 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 1563 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 1564 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 1565 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 1566 * (ethtool_value) */ 1567 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 1568 * (ethtool_value). */ 1569 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 1570 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 1571 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 1572 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 1573 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 1574 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 1575 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 1576 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 1577 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 1578 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 1579 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 1580 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 1581 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 1582 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 1583 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 1584 1585 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */ 1586 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */ 1587 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */ 1588 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */ 1589 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */ 1590 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */ 1591 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */ 1592 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */ 1593 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */ 1594 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */ 1595 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */ 1596 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */ 1597 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */ 1598 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */ 1599 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */ 1600 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */ 1601 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */ 1602 1603 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */ 1604 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */ 1605 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */ 1606 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */ 1607 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */ 1608 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */ 1609 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */ 1610 #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */ 1611 #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */ 1612 #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */ 1613 #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */ 1614 #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */ 1615 1616 #define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */ 1617 #define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */ 1618 #define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */ 1619 #define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */ 1620 #define ETHTOOL_GPHYSTATS 0x0000004a /* get PHY-specific statistics */ 1621 1622 #define ETHTOOL_PERQUEUE 0x0000004b /* Set per queue options */ 1623 1624 #define ETHTOOL_GLINKSETTINGS 0x0000004c /* Get ethtool_link_settings */ 1625 #define ETHTOOL_SLINKSETTINGS 0x0000004d /* Set ethtool_link_settings */ 1626 #define ETHTOOL_PHY_GTUNABLE 0x0000004e /* Get PHY tunable configuration */ 1627 #define ETHTOOL_PHY_STUNABLE 0x0000004f /* Set PHY tunable configuration */ 1628 #define ETHTOOL_GFECPARAM 0x00000050 /* Get FEC settings */ 1629 #define ETHTOOL_SFECPARAM 0x00000051 /* Set FEC settings */ 1630 1631 /* compatibility with older code */ 1632 #define SPARC_ETH_GSET ETHTOOL_GSET 1633 #define SPARC_ETH_SSET ETHTOOL_SSET 1634 1635 /* Link mode bit indices */ 1636 enum ethtool_link_mode_bit_indices { 1637 ETHTOOL_LINK_MODE_10baseT_Half_BIT = 0, 1638 ETHTOOL_LINK_MODE_10baseT_Full_BIT = 1, 1639 ETHTOOL_LINK_MODE_100baseT_Half_BIT = 2, 1640 ETHTOOL_LINK_MODE_100baseT_Full_BIT = 3, 1641 ETHTOOL_LINK_MODE_1000baseT_Half_BIT = 4, 1642 ETHTOOL_LINK_MODE_1000baseT_Full_BIT = 5, 1643 ETHTOOL_LINK_MODE_Autoneg_BIT = 6, 1644 ETHTOOL_LINK_MODE_TP_BIT = 7, 1645 ETHTOOL_LINK_MODE_AUI_BIT = 8, 1646 ETHTOOL_LINK_MODE_MII_BIT = 9, 1647 ETHTOOL_LINK_MODE_FIBRE_BIT = 10, 1648 ETHTOOL_LINK_MODE_BNC_BIT = 11, 1649 ETHTOOL_LINK_MODE_10000baseT_Full_BIT = 12, 1650 ETHTOOL_LINK_MODE_Pause_BIT = 13, 1651 ETHTOOL_LINK_MODE_Asym_Pause_BIT = 14, 1652 ETHTOOL_LINK_MODE_2500baseX_Full_BIT = 15, 1653 ETHTOOL_LINK_MODE_Backplane_BIT = 16, 1654 ETHTOOL_LINK_MODE_1000baseKX_Full_BIT = 17, 1655 ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT = 18, 1656 ETHTOOL_LINK_MODE_10000baseKR_Full_BIT = 19, 1657 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT = 20, 1658 ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21, 1659 ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT = 22, 1660 ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT = 23, 1661 ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT = 24, 1662 ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT = 25, 1663 ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT = 26, 1664 ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT = 27, 1665 ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT = 28, 1666 ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT = 29, 1667 ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT = 30, 1668 ETHTOOL_LINK_MODE_25000baseCR_Full_BIT = 31, 1669 1670 /* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit 1671 * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_* 1672 * macro for bits > 31. The only way to use indices > 31 is to 1673 * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. 1674 */ 1675 1676 ETHTOOL_LINK_MODE_25000baseKR_Full_BIT = 32, 1677 ETHTOOL_LINK_MODE_25000baseSR_Full_BIT = 33, 1678 ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT = 34, 1679 ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT = 35, 1680 ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT = 36, 1681 ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT = 37, 1682 ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT = 38, 1683 ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT = 39, 1684 ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT = 40, 1685 ETHTOOL_LINK_MODE_1000baseX_Full_BIT = 41, 1686 ETHTOOL_LINK_MODE_10000baseCR_Full_BIT = 42, 1687 ETHTOOL_LINK_MODE_10000baseSR_Full_BIT = 43, 1688 ETHTOOL_LINK_MODE_10000baseLR_Full_BIT = 44, 1689 ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT = 45, 1690 ETHTOOL_LINK_MODE_10000baseER_Full_BIT = 46, 1691 ETHTOOL_LINK_MODE_2500baseT_Full_BIT = 47, 1692 ETHTOOL_LINK_MODE_5000baseT_Full_BIT = 48, 1693 1694 ETHTOOL_LINK_MODE_FEC_NONE_BIT = 49, 1695 ETHTOOL_LINK_MODE_FEC_RS_BIT = 50, 1696 ETHTOOL_LINK_MODE_FEC_BASER_BIT = 51, 1697 ETHTOOL_LINK_MODE_50000baseKR_Full_BIT = 52, 1698 ETHTOOL_LINK_MODE_50000baseSR_Full_BIT = 53, 1699 ETHTOOL_LINK_MODE_50000baseCR_Full_BIT = 54, 1700 ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT = 55, 1701 ETHTOOL_LINK_MODE_50000baseDR_Full_BIT = 56, 1702 ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT = 57, 1703 ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT = 58, 1704 ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT = 59, 1705 ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60, 1706 ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT = 61, 1707 ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT = 62, 1708 ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT = 63, 1709 ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64, 1710 ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT = 65, 1711 ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT = 66, 1712 ETHTOOL_LINK_MODE_100baseT1_Full_BIT = 67, 1713 ETHTOOL_LINK_MODE_1000baseT1_Full_BIT = 68, 1714 ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT = 69, 1715 ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT = 70, 1716 ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71, 1717 ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT = 72, 1718 ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT = 73, 1719 ETHTOOL_LINK_MODE_FEC_LLRS_BIT = 74, 1720 ETHTOOL_LINK_MODE_100000baseKR_Full_BIT = 75, 1721 ETHTOOL_LINK_MODE_100000baseSR_Full_BIT = 76, 1722 ETHTOOL_LINK_MODE_100000baseLR_ER_FR_Full_BIT = 77, 1723 ETHTOOL_LINK_MODE_100000baseCR_Full_BIT = 78, 1724 ETHTOOL_LINK_MODE_100000baseDR_Full_BIT = 79, 1725 ETHTOOL_LINK_MODE_200000baseKR2_Full_BIT = 80, 1726 ETHTOOL_LINK_MODE_200000baseSR2_Full_BIT = 81, 1727 ETHTOOL_LINK_MODE_200000baseLR2_ER2_FR2_Full_BIT = 82, 1728 ETHTOOL_LINK_MODE_200000baseDR2_Full_BIT = 83, 1729 ETHTOOL_LINK_MODE_200000baseCR2_Full_BIT = 84, 1730 ETHTOOL_LINK_MODE_400000baseKR4_Full_BIT = 85, 1731 ETHTOOL_LINK_MODE_400000baseSR4_Full_BIT = 86, 1732 ETHTOOL_LINK_MODE_400000baseLR4_ER4_FR4_Full_BIT = 87, 1733 ETHTOOL_LINK_MODE_400000baseDR4_Full_BIT = 88, 1734 ETHTOOL_LINK_MODE_400000baseCR4_Full_BIT = 89, 1735 ETHTOOL_LINK_MODE_100baseFX_Half_BIT = 90, 1736 ETHTOOL_LINK_MODE_100baseFX_Full_BIT = 91, 1737 ETHTOOL_LINK_MODE_10baseT1L_Full_BIT = 92, 1738 ETHTOOL_LINK_MODE_800000baseCR8_Full_BIT = 93, 1739 ETHTOOL_LINK_MODE_800000baseKR8_Full_BIT = 94, 1740 ETHTOOL_LINK_MODE_800000baseDR8_Full_BIT = 95, 1741 ETHTOOL_LINK_MODE_800000baseDR8_2_Full_BIT = 96, 1742 ETHTOOL_LINK_MODE_800000baseSR8_Full_BIT = 97, 1743 ETHTOOL_LINK_MODE_800000baseVR8_Full_BIT = 98, 1744 1745 /* must be last entry */ 1746 __ETHTOOL_LINK_MODE_MASK_NBITS 1747 }; 1748 1749 #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name) \ 1750 (1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT)) 1751 1752 /* DEPRECATED macros. Please migrate to 1753 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT 1754 * define any new SUPPORTED_* macro for bits > 31. 1755 */ 1756 #define SUPPORTED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half) 1757 #define SUPPORTED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full) 1758 #define SUPPORTED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half) 1759 #define SUPPORTED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full) 1760 #define SUPPORTED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half) 1761 #define SUPPORTED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full) 1762 #define SUPPORTED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg) 1763 #define SUPPORTED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP) 1764 #define SUPPORTED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI) 1765 #define SUPPORTED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII) 1766 #define SUPPORTED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE) 1767 #define SUPPORTED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC) 1768 #define SUPPORTED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full) 1769 #define SUPPORTED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause) 1770 #define SUPPORTED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause) 1771 #define SUPPORTED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full) 1772 #define SUPPORTED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane) 1773 #define SUPPORTED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full) 1774 #define SUPPORTED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full) 1775 #define SUPPORTED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full) 1776 #define SUPPORTED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC) 1777 #define SUPPORTED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full) 1778 #define SUPPORTED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full) 1779 #define SUPPORTED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full) 1780 #define SUPPORTED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full) 1781 #define SUPPORTED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full) 1782 #define SUPPORTED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full) 1783 #define SUPPORTED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full) 1784 #define SUPPORTED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full) 1785 #define SUPPORTED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full) 1786 #define SUPPORTED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full) 1787 /* Please do not define any new SUPPORTED_* macro for bits > 31, see 1788 * notice above. 1789 */ 1790 1791 /* 1792 * DEPRECATED macros. Please migrate to 1793 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT 1794 * define any new ADERTISE_* macro for bits > 31. 1795 */ 1796 #define ADVERTISED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half) 1797 #define ADVERTISED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full) 1798 #define ADVERTISED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half) 1799 #define ADVERTISED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full) 1800 #define ADVERTISED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half) 1801 #define ADVERTISED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full) 1802 #define ADVERTISED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg) 1803 #define ADVERTISED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP) 1804 #define ADVERTISED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI) 1805 #define ADVERTISED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII) 1806 #define ADVERTISED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE) 1807 #define ADVERTISED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC) 1808 #define ADVERTISED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full) 1809 #define ADVERTISED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause) 1810 #define ADVERTISED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause) 1811 #define ADVERTISED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full) 1812 #define ADVERTISED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane) 1813 #define ADVERTISED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full) 1814 #define ADVERTISED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full) 1815 #define ADVERTISED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full) 1816 #define ADVERTISED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC) 1817 #define ADVERTISED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full) 1818 #define ADVERTISED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full) 1819 #define ADVERTISED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full) 1820 #define ADVERTISED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full) 1821 #define ADVERTISED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full) 1822 #define ADVERTISED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full) 1823 #define ADVERTISED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full) 1824 #define ADVERTISED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full) 1825 #define ADVERTISED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full) 1826 #define ADVERTISED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full) 1827 /* Please do not define any new ADVERTISED_* macro for bits > 31, see 1828 * notice above. 1829 */ 1830 1831 /* The following are all involved in forcing a particular link 1832 * mode for the device for setting things. When getting the 1833 * devices settings, these indicate the current mode and whether 1834 * it was forced up into this mode or autonegotiated. 1835 */ 1836 1837 /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal. 1838 * Update drivers/net/phy/phy.c:phy_speed_to_str() and 1839 * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values. 1840 */ 1841 #define SPEED_10 10 1842 #define SPEED_100 100 1843 #define SPEED_1000 1000 1844 #define SPEED_2500 2500 1845 #define SPEED_5000 5000 1846 #define SPEED_10000 10000 1847 #define SPEED_14000 14000 1848 #define SPEED_20000 20000 1849 #define SPEED_25000 25000 1850 #define SPEED_40000 40000 1851 #define SPEED_50000 50000 1852 #define SPEED_56000 56000 1853 #define SPEED_100000 100000 1854 #define SPEED_200000 200000 1855 #define SPEED_400000 400000 1856 #define SPEED_800000 800000 1857 1858 #define SPEED_UNKNOWN -1 1859 1860 static inline int ethtool_validate_speed(uint32_t speed) 1861 { 1862 return speed <= INT_MAX || speed == (uint32_t)SPEED_UNKNOWN; 1863 } 1864 1865 /* Duplex, half or full. */ 1866 #define DUPLEX_HALF 0x00 1867 #define DUPLEX_FULL 0x01 1868 #define DUPLEX_UNKNOWN 0xff 1869 1870 static inline int ethtool_validate_duplex(uint8_t duplex) 1871 { 1872 switch (duplex) { 1873 case DUPLEX_HALF: 1874 case DUPLEX_FULL: 1875 case DUPLEX_UNKNOWN: 1876 return 1; 1877 } 1878 1879 return 0; 1880 } 1881 1882 #define MASTER_SLAVE_CFG_UNSUPPORTED 0 1883 #define MASTER_SLAVE_CFG_UNKNOWN 1 1884 #define MASTER_SLAVE_CFG_MASTER_PREFERRED 2 1885 #define MASTER_SLAVE_CFG_SLAVE_PREFERRED 3 1886 #define MASTER_SLAVE_CFG_MASTER_FORCE 4 1887 #define MASTER_SLAVE_CFG_SLAVE_FORCE 5 1888 #define MASTER_SLAVE_STATE_UNSUPPORTED 0 1889 #define MASTER_SLAVE_STATE_UNKNOWN 1 1890 #define MASTER_SLAVE_STATE_MASTER 2 1891 #define MASTER_SLAVE_STATE_SLAVE 3 1892 #define MASTER_SLAVE_STATE_ERR 4 1893 1894 /* These are used to throttle the rate of data on the phy interface when the 1895 * native speed of the interface is higher than the link speed. These should 1896 * not be used for phy interfaces which natively support multiple speeds (e.g. 1897 * MII or SGMII). 1898 */ 1899 /* No rate matching performed. */ 1900 #define RATE_MATCH_NONE 0 1901 /* The phy sends pause frames to throttle the MAC. */ 1902 #define RATE_MATCH_PAUSE 1 1903 /* The phy asserts CRS to prevent the MAC from transmitting. */ 1904 #define RATE_MATCH_CRS 2 1905 /* The MAC is programmed with a sufficiently-large IPG. */ 1906 #define RATE_MATCH_OPEN_LOOP 3 1907 1908 /* Which connector port. */ 1909 #define PORT_TP 0x00 1910 #define PORT_AUI 0x01 1911 #define PORT_MII 0x02 1912 #define PORT_FIBRE 0x03 1913 #define PORT_BNC 0x04 1914 #define PORT_DA 0x05 1915 #define PORT_NONE 0xef 1916 #define PORT_OTHER 0xff 1917 1918 /* Which transceiver to use. */ 1919 #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */ 1920 #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */ 1921 #define XCVR_DUMMY1 0x02 1922 #define XCVR_DUMMY2 0x03 1923 #define XCVR_DUMMY3 0x04 1924 1925 /* Enable or disable autonegotiation. */ 1926 #define AUTONEG_DISABLE 0x00 1927 #define AUTONEG_ENABLE 0x01 1928 1929 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then 1930 * the driver is required to renegotiate link 1931 */ 1932 #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */ 1933 #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */ 1934 #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */ 1935 #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */ 1936 1937 /* Wake-On-Lan options. */ 1938 #define WAKE_PHY (1 << 0) 1939 #define WAKE_UCAST (1 << 1) 1940 #define WAKE_MCAST (1 << 2) 1941 #define WAKE_BCAST (1 << 3) 1942 #define WAKE_ARP (1 << 4) 1943 #define WAKE_MAGIC (1 << 5) 1944 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 1945 #define WAKE_FILTER (1 << 7) 1946 1947 #define WOL_MODE_COUNT 8 1948 1949 /* L2-L4 network traffic flow types */ 1950 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */ 1951 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */ 1952 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */ 1953 #define AH_ESP_V4_FLOW 0x04 /* hash only */ 1954 #define TCP_V6_FLOW 0x05 /* hash or spec (tcp_ip6_spec; nfc only) */ 1955 #define UDP_V6_FLOW 0x06 /* hash or spec (udp_ip6_spec; nfc only) */ 1956 #define SCTP_V6_FLOW 0x07 /* hash or spec (sctp_ip6_spec; nfc only) */ 1957 #define AH_ESP_V6_FLOW 0x08 /* hash only */ 1958 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */ 1959 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */ 1960 #define AH_V6_FLOW 0x0b /* hash or spec (ah_ip6_spec; nfc only) */ 1961 #define ESP_V6_FLOW 0x0c /* hash or spec (esp_ip6_spec; nfc only) */ 1962 #define IPV4_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */ 1963 #define IP_USER_FLOW IPV4_USER_FLOW 1964 #define IPV6_USER_FLOW 0x0e /* spec only (usr_ip6_spec; nfc only) */ 1965 #define IPV4_FLOW 0x10 /* hash only */ 1966 #define IPV6_FLOW 0x11 /* hash only */ 1967 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */ 1968 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */ 1969 #define FLOW_EXT 0x80000000 1970 #define FLOW_MAC_EXT 0x40000000 1971 /* Flag to enable RSS spreading of traffic matching rule (nfc only) */ 1972 #define FLOW_RSS 0x20000000 1973 1974 /* L3-L4 network traffic flow hash options */ 1975 #define RXH_L2DA (1 << 1) 1976 #define RXH_VLAN (1 << 2) 1977 #define RXH_L3_PROTO (1 << 3) 1978 #define RXH_IP_SRC (1 << 4) 1979 #define RXH_IP_DST (1 << 5) 1980 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */ 1981 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */ 1982 #define RXH_DISCARD (1 << 31) 1983 1984 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL 1985 #define RX_CLS_FLOW_WAKE 0xfffffffffffffffeULL 1986 1987 /* Special RX classification rule insert location values */ 1988 #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */ 1989 #define RX_CLS_LOC_ANY 0xffffffff 1990 #define RX_CLS_LOC_FIRST 0xfffffffe 1991 #define RX_CLS_LOC_LAST 0xfffffffd 1992 1993 /* EEPROM Standards for plug in modules */ 1994 #define ETH_MODULE_SFF_8079 0x1 1995 #define ETH_MODULE_SFF_8079_LEN 256 1996 #define ETH_MODULE_SFF_8472 0x2 1997 #define ETH_MODULE_SFF_8472_LEN 512 1998 #define ETH_MODULE_SFF_8636 0x3 1999 #define ETH_MODULE_SFF_8636_LEN 256 2000 #define ETH_MODULE_SFF_8436 0x4 2001 #define ETH_MODULE_SFF_8436_LEN 256 2002 2003 #define ETH_MODULE_SFF_8636_MAX_LEN 640 2004 #define ETH_MODULE_SFF_8436_MAX_LEN 640 2005 2006 /* Reset flags */ 2007 /* The reset() operation must clear the flags for the components which 2008 * were actually reset. On successful return, the flags indicate the 2009 * components which were not reset, either because they do not exist 2010 * in the hardware or because they cannot be reset independently. The 2011 * driver must never reset any components that were not requested. 2012 */ 2013 enum ethtool_reset_flags { 2014 /* These flags represent components dedicated to the interface 2015 * the command is addressed to. Shift any flag left by 2016 * ETH_RESET_SHARED_SHIFT to reset a shared component of the 2017 * same type. 2018 */ 2019 ETH_RESET_MGMT = 1 << 0, /* Management processor */ 2020 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */ 2021 ETH_RESET_DMA = 1 << 2, /* DMA engine */ 2022 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */ 2023 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */ 2024 ETH_RESET_MAC = 1 << 5, /* Media access controller */ 2025 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */ 2026 ETH_RESET_RAM = 1 << 7, /* RAM shared between 2027 * multiple components */ 2028 ETH_RESET_AP = 1 << 8, /* Application processor */ 2029 2030 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to 2031 * this interface */ 2032 ETH_RESET_ALL = 0xffffffff, /* All components used by this 2033 * interface, even if shared */ 2034 }; 2035 #define ETH_RESET_SHARED_SHIFT 16 2036 2037 2038 /** 2039 * struct ethtool_link_settings - link control and status 2040 * 2041 * IMPORTANT, Backward compatibility notice: When implementing new 2042 * user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and 2043 * if it succeeds use %ETHTOOL_SLINKSETTINGS to change link 2044 * settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS 2045 * succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in 2046 * that case. Conversely, if %ETHTOOL_GLINKSETTINGS fails, use 2047 * %ETHTOOL_GSET to query and %ETHTOOL_SSET to change link 2048 * settings; do not use %ETHTOOL_SLINKSETTINGS if 2049 * %ETHTOOL_GLINKSETTINGS failed: stick to 2050 * %ETHTOOL_GSET/%ETHTOOL_SSET in that case. 2051 * 2052 * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS 2053 * @speed: Link speed (Mbps) 2054 * @duplex: Duplex mode; one of %DUPLEX_* 2055 * @port: Physical connector type; one of %PORT_* 2056 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not 2057 * applicable. For clause 45 PHYs this is the PRTAD. 2058 * @autoneg: Enable/disable autonegotiation and auto-detection; 2059 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE 2060 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO 2061 * protocols supported by the interface; 0 if unknown. 2062 * Read-only. 2063 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of 2064 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the 2065 * value will be %ETH_TP_MDI_INVALID. Read-only. 2066 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of 2067 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads 2068 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. 2069 * When written successfully, the link should be renegotiated if 2070 * necessary. 2071 * @link_mode_masks_nwords: Number of 32-bit words for each of the 2072 * supported, advertising, lp_advertising link mode bitmaps. For 2073 * %ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user 2074 * (>= 0); on return, if handshake in progress, negative if 2075 * request size unsupported by kernel: absolute value indicates 2076 * kernel expected size and all the other fields but cmd 2077 * are 0; otherwise (handshake completed), strictly positive 2078 * to indicate size used by kernel and cmd field stays 2079 * %ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For 2080 * %ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive 2081 * value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise 2082 * refused. For drivers: ignore this field (use kernel's 2083 * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will 2084 * be overwritten by kernel. 2085 * @supported: Bitmap with each bit meaning given by 2086 * %ethtool_link_mode_bit_indices for the link modes, physical 2087 * connectors and other link features for which the interface 2088 * supports autonegotiation or auto-detection. Read-only. 2089 * @advertising: Bitmap with each bit meaning given by 2090 * %ethtool_link_mode_bit_indices for the link modes, physical 2091 * connectors and other link features that are advertised through 2092 * autonegotiation or enabled for auto-detection. 2093 * @lp_advertising: Bitmap with each bit meaning given by 2094 * %ethtool_link_mode_bit_indices for the link modes, and other 2095 * link features that the link partner advertised through 2096 * autonegotiation; 0 if unknown or not applicable. Read-only. 2097 * @transceiver: Used to distinguish different possible PHY types, 2098 * reported consistently by PHYLIB. Read-only. 2099 * @master_slave_cfg: Master/slave port mode. 2100 * @master_slave_state: Master/slave port state. 2101 * @rate_matching: Rate adaptation performed by the PHY 2102 * @reserved: Reserved for future use; see the note on reserved space. 2103 * @link_mode_masks: Variable length bitmaps. 2104 * 2105 * If autonegotiation is disabled, the speed and @duplex represent the 2106 * fixed link mode and are writable if the driver supports multiple 2107 * link modes. If it is enabled then they are read-only; if the link 2108 * is up they represent the negotiated link mode; if the link is down, 2109 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and 2110 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. 2111 * 2112 * Some hardware interfaces may have multiple PHYs and/or physical 2113 * connectors fitted or do not allow the driver to detect which are 2114 * fitted. For these interfaces @port and/or @phy_address may be 2115 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. 2116 * Otherwise, attempts to write different values may be ignored or 2117 * rejected. 2118 * 2119 * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt 2120 * are not available in %ethtool_link_settings. These fields will be 2121 * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will 2122 * fail if any of them is set to non-zero value. 2123 * 2124 * Users should assume that all fields not marked read-only are 2125 * writable and subject to validation by the driver. They should use 2126 * %ETHTOOL_GLINKSETTINGS to get the current values before making specific 2127 * changes and then applying them with %ETHTOOL_SLINKSETTINGS. 2128 * 2129 * Drivers that implement %get_link_ksettings and/or 2130 * %set_link_ksettings should ignore the @cmd 2131 * and @link_mode_masks_nwords fields (any change to them overwritten 2132 * by kernel), and rely only on kernel's internal 2133 * %__ETHTOOL_LINK_MODE_MASK_NBITS and 2134 * %ethtool_link_mode_mask_t. Drivers that implement 2135 * %set_link_ksettings() should validate all fields other than @cmd 2136 * and @link_mode_masks_nwords that are not described as read-only or 2137 * deprecated, and must ignore all fields described as read-only. 2138 */ 2139 struct ethtool_link_settings { 2140 uint32_t cmd; 2141 uint32_t speed; 2142 uint8_t duplex; 2143 uint8_t port; 2144 uint8_t phy_address; 2145 uint8_t autoneg; 2146 uint8_t mdio_support; 2147 uint8_t eth_tp_mdix; 2148 uint8_t eth_tp_mdix_ctrl; 2149 int8_t link_mode_masks_nwords; 2150 uint8_t transceiver; 2151 uint8_t master_slave_cfg; 2152 uint8_t master_slave_state; 2153 uint8_t rate_matching; 2154 uint32_t reserved[7]; 2155 uint32_t link_mode_masks[]; 2156 /* layout of link_mode_masks fields: 2157 * uint32_t map_supported[link_mode_masks_nwords]; 2158 * uint32_t map_advertising[link_mode_masks_nwords]; 2159 * uint32_t map_lp_advertising[link_mode_masks_nwords]; 2160 */ 2161 }; 2162 #endif /* _LINUX_ETHTOOL_H */ 2163