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