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 #define ETH_GSTRING_LEN 32 583 584 /** 585 * enum ethtool_stringset - string set ID 586 * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST 587 * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS 588 * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with 589 * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS 590 * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE; 591 * now deprecated 592 * @ETH_SS_FEATURES: Device feature names 593 * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names 594 * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS 595 * @ETH_SS_PHY_TUNABLES: PHY tunable names 596 * @ETH_SS_LINK_MODES: link mode names 597 * @ETH_SS_MSG_CLASSES: debug message class names 598 * @ETH_SS_WOL_MODES: wake-on-lan modes 599 * @ETH_SS_SOF_TIMESTAMPING: SOF_TIMESTAMPING_* flags 600 * @ETH_SS_TS_TX_TYPES: timestamping Tx types 601 * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters 602 */ 603 enum ethtool_stringset { 604 ETH_SS_TEST = 0, 605 ETH_SS_STATS, 606 ETH_SS_PRIV_FLAGS, 607 ETH_SS_NTUPLE_FILTERS, 608 ETH_SS_FEATURES, 609 ETH_SS_RSS_HASH_FUNCS, 610 ETH_SS_TUNABLES, 611 ETH_SS_PHY_STATS, 612 ETH_SS_PHY_TUNABLES, 613 ETH_SS_LINK_MODES, 614 ETH_SS_MSG_CLASSES, 615 ETH_SS_WOL_MODES, 616 ETH_SS_SOF_TIMESTAMPING, 617 ETH_SS_TS_TX_TYPES, 618 ETH_SS_TS_RX_FILTERS, 619 620 /* add new constants above here */ 621 ETH_SS_COUNT 622 }; 623 624 /** 625 * struct ethtool_gstrings - string set for data tagging 626 * @cmd: Command number = %ETHTOOL_GSTRINGS 627 * @string_set: String set ID; one of &enum ethtool_stringset 628 * @len: On return, the number of strings in the string set 629 * @data: Buffer for strings. Each string is null-padded to a size of 630 * %ETH_GSTRING_LEN. 631 * 632 * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in 633 * the string set. They must allocate a buffer of the appropriate 634 * size immediately following this structure. 635 */ 636 struct ethtool_gstrings { 637 uint32_t cmd; 638 uint32_t string_set; 639 uint32_t len; 640 uint8_t data[0]; 641 }; 642 643 /** 644 * struct ethtool_sset_info - string set information 645 * @cmd: Command number = %ETHTOOL_GSSET_INFO 646 * @sset_mask: On entry, a bitmask of string sets to query, with bits 647 * numbered according to &enum ethtool_stringset. On return, a 648 * bitmask of those string sets queried that are supported. 649 * @data: Buffer for string set sizes. On return, this contains the 650 * size of each string set that was queried and supported, in 651 * order of ID. 652 * 653 * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on 654 * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the 655 * size of set 1 and @data[1] contains the size of set 2. 656 * 657 * Users must allocate a buffer of the appropriate size (4 * number of 658 * sets queried) immediately following this structure. 659 */ 660 struct ethtool_sset_info { 661 uint32_t cmd; 662 uint32_t reserved; 663 uint64_t sset_mask; 664 uint32_t data[0]; 665 }; 666 667 /** 668 * enum ethtool_test_flags - flags definition of ethtool_test 669 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise 670 * only online tests. 671 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails. 672 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback 673 * test. 674 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test 675 */ 676 677 enum ethtool_test_flags { 678 ETH_TEST_FL_OFFLINE = (1 << 0), 679 ETH_TEST_FL_FAILED = (1 << 1), 680 ETH_TEST_FL_EXTERNAL_LB = (1 << 2), 681 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3), 682 }; 683 684 /** 685 * struct ethtool_test - device self-test invocation 686 * @cmd: Command number = %ETHTOOL_TEST 687 * @flags: A bitmask of flags from &enum ethtool_test_flags. Some 688 * flags may be set by the user on entry; others may be set by 689 * the driver on return. 690 * @len: On return, the number of test results 691 * @data: Array of test results 692 * 693 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the 694 * number of test results that will be returned. They must allocate a 695 * buffer of the appropriate size (8 * number of results) immediately 696 * following this structure. 697 */ 698 struct ethtool_test { 699 uint32_t cmd; 700 uint32_t flags; 701 uint32_t reserved; 702 uint32_t len; 703 uint64_t data[0]; 704 }; 705 706 /** 707 * struct ethtool_stats - device-specific statistics 708 * @cmd: Command number = %ETHTOOL_GSTATS 709 * @n_stats: On return, the number of statistics 710 * @data: Array of statistics 711 * 712 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the 713 * number of statistics that will be returned. They must allocate a 714 * buffer of the appropriate size (8 * number of statistics) 715 * immediately following this structure. 716 */ 717 struct ethtool_stats { 718 uint32_t cmd; 719 uint32_t n_stats; 720 uint64_t data[0]; 721 }; 722 723 /** 724 * struct ethtool_perm_addr - permanent hardware address 725 * @cmd: Command number = %ETHTOOL_GPERMADDR 726 * @size: On entry, the size of the buffer. On return, the size of the 727 * address. The command fails if the buffer is too small. 728 * @data: Buffer for the address 729 * 730 * Users must allocate the buffer immediately following this structure. 731 * A buffer size of %MAX_ADDR_LEN should be sufficient for any address 732 * type. 733 */ 734 struct ethtool_perm_addr { 735 uint32_t cmd; 736 uint32_t size; 737 uint8_t data[0]; 738 }; 739 740 /* boolean flags controlling per-interface behavior characteristics. 741 * When reading, the flag indicates whether or not a certain behavior 742 * is enabled/present. When writing, the flag indicates whether 743 * or not the driver should turn on (set) or off (clear) a behavior. 744 * 745 * Some behaviors may read-only (unconditionally absent or present). 746 * If such is the case, return EINVAL in the set-flags operation if the 747 * flag differs from the read-only value. 748 */ 749 enum ethtool_flags { 750 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */ 751 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */ 752 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 753 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */ 754 ETH_FLAG_RXHASH = (1 << 28), 755 }; 756 757 /* The following structures are for supporting RX network flow 758 * classification and RX n-tuple configuration. Note, all multibyte 759 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to 760 * be in network byte order. 761 */ 762 763 /** 764 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. 765 * @ip4src: Source host 766 * @ip4dst: Destination host 767 * @psrc: Source port 768 * @pdst: Destination port 769 * @tos: Type-of-service 770 * 771 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. 772 */ 773 struct ethtool_tcpip4_spec { 774 uint32_t ip4src; 775 uint32_t ip4dst; 776 uint16_t psrc; 777 uint16_t pdst; 778 uint8_t tos; 779 }; 780 781 /** 782 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 783 * @ip4src: Source host 784 * @ip4dst: Destination host 785 * @spi: Security parameters index 786 * @tos: Type-of-service 787 * 788 * This can be used to specify an IPsec transport or tunnel over IPv4. 789 */ 790 struct ethtool_ah_espip4_spec { 791 uint32_t ip4src; 792 uint32_t ip4dst; 793 uint32_t spi; 794 uint8_t tos; 795 }; 796 797 #define ETH_RX_NFC_IP4 1 798 799 /** 800 * struct ethtool_usrip4_spec - general flow specification for IPv4 801 * @ip4src: Source host 802 * @ip4dst: Destination host 803 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 804 * @tos: Type-of-service 805 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 806 * @proto: Transport protocol number; mask must be 0 807 */ 808 struct ethtool_usrip4_spec { 809 uint32_t ip4src; 810 uint32_t ip4dst; 811 uint32_t l4_4_bytes; 812 uint8_t tos; 813 uint8_t ip_ver; 814 uint8_t proto; 815 }; 816 817 /** 818 * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc. 819 * @ip6src: Source host 820 * @ip6dst: Destination host 821 * @psrc: Source port 822 * @pdst: Destination port 823 * @tclass: Traffic Class 824 * 825 * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow. 826 */ 827 struct ethtool_tcpip6_spec { 828 uint32_t ip6src[4]; 829 uint32_t ip6dst[4]; 830 uint16_t psrc; 831 uint16_t pdst; 832 uint8_t tclass; 833 }; 834 835 /** 836 * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6 837 * @ip6src: Source host 838 * @ip6dst: Destination host 839 * @spi: Security parameters index 840 * @tclass: Traffic Class 841 * 842 * This can be used to specify an IPsec transport or tunnel over IPv6. 843 */ 844 struct ethtool_ah_espip6_spec { 845 uint32_t ip6src[4]; 846 uint32_t ip6dst[4]; 847 uint32_t spi; 848 uint8_t tclass; 849 }; 850 851 /** 852 * struct ethtool_usrip6_spec - general flow specification for IPv6 853 * @ip6src: Source host 854 * @ip6dst: Destination host 855 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 856 * @tclass: Traffic Class 857 * @l4_proto: Transport protocol number (nexthdr after any Extension Headers) 858 */ 859 struct ethtool_usrip6_spec { 860 uint32_t ip6src[4]; 861 uint32_t ip6dst[4]; 862 uint32_t l4_4_bytes; 863 uint8_t tclass; 864 uint8_t l4_proto; 865 }; 866 867 union ethtool_flow_union { 868 struct ethtool_tcpip4_spec tcp_ip4_spec; 869 struct ethtool_tcpip4_spec udp_ip4_spec; 870 struct ethtool_tcpip4_spec sctp_ip4_spec; 871 struct ethtool_ah_espip4_spec ah_ip4_spec; 872 struct ethtool_ah_espip4_spec esp_ip4_spec; 873 struct ethtool_usrip4_spec usr_ip4_spec; 874 struct ethtool_tcpip6_spec tcp_ip6_spec; 875 struct ethtool_tcpip6_spec udp_ip6_spec; 876 struct ethtool_tcpip6_spec sctp_ip6_spec; 877 struct ethtool_ah_espip6_spec ah_ip6_spec; 878 struct ethtool_ah_espip6_spec esp_ip6_spec; 879 struct ethtool_usrip6_spec usr_ip6_spec; 880 struct eth_header ether_spec; 881 uint8_t hdata[52]; 882 }; 883 884 /** 885 * struct ethtool_flow_ext - additional RX flow fields 886 * @h_dest: destination MAC address 887 * @vlan_etype: VLAN EtherType 888 * @vlan_tci: VLAN tag control information 889 * @data: user defined data 890 * 891 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT 892 * is set in &struct ethtool_rx_flow_spec @flow_type. 893 * @h_dest is valid if %FLOW_MAC_EXT is set. 894 */ 895 struct ethtool_flow_ext { 896 uint8_t padding[2]; 897 unsigned char h_dest[ETH_ALEN]; 898 uint16_t vlan_etype; 899 uint16_t vlan_tci; 900 uint32_t data[2]; 901 }; 902 903 /** 904 * struct ethtool_rx_flow_spec - classification rule for RX flows 905 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 906 * @h_u: Flow fields to match (dependent on @flow_type) 907 * @h_ext: Additional fields to match 908 * @m_u: Masks for flow field bits to be matched 909 * @m_ext: Masks for additional field bits to be matched 910 * Note, all additional fields must be ignored unless @flow_type 911 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag 912 * (see &struct ethtool_flow_ext description). 913 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC 914 * if packets should be discarded, or %RX_CLS_FLOW_WAKE if the 915 * packets should be used for Wake-on-LAN with %WAKE_FILTER 916 * @location: Location of rule in the table. Locations must be 917 * numbered such that a flow matching multiple rules will be 918 * classified according to the first (lowest numbered) rule. 919 */ 920 struct ethtool_rx_flow_spec { 921 uint32_t flow_type; 922 union ethtool_flow_union h_u; 923 struct ethtool_flow_ext h_ext; 924 union ethtool_flow_union m_u; 925 struct ethtool_flow_ext m_ext; 926 uint64_t ring_cookie; 927 uint32_t location; 928 }; 929 930 /* How rings are laid out when accessing virtual functions or 931 * offloaded queues is device specific. To allow users to do flow 932 * steering and specify these queues the ring cookie is partitioned 933 * into a 32bit queue index with an 8 bit virtual function id. 934 * This also leaves the 3bytes for further specifiers. It is possible 935 * future devices may support more than 256 virtual functions if 936 * devices start supporting PCIe w/ARI. However at the moment I 937 * do not know of any devices that support this so I do not reserve 938 * space for this at this time. If a future patch consumes the next 939 * byte it should be aware of this possibility. 940 */ 941 #define ETHTOOL_RX_FLOW_SPEC_RING 0x00000000FFFFFFFFLL 942 #define ETHTOOL_RX_FLOW_SPEC_RING_VF 0x000000FF00000000LL 943 #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32 944 static inline uint64_t ethtool_get_flow_spec_ring(uint64_t ring_cookie) 945 { 946 return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie; 947 } 948 949 static inline uint64_t ethtool_get_flow_spec_ring_vf(uint64_t ring_cookie) 950 { 951 return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >> 952 ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF; 953 } 954 955 /** 956 * struct ethtool_rxnfc - command to get or set RX flow classification rules 957 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, 958 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, 959 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS 960 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW 961 * @data: Command-dependent value 962 * @fs: Flow classification rule 963 * @rss_context: RSS context to be affected 964 * @rule_cnt: Number of rules to be affected 965 * @rule_locs: Array of used rule locations 966 * 967 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating 968 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following 969 * structure fields must not be used, except that if @flow_type includes 970 * the %FLOW_RSS flag, then @rss_context determines which RSS context to 971 * act on. 972 * 973 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues 974 * on return. 975 * 976 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined 977 * rules on return. If @data is non-zero on return then it is the 978 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the 979 * driver supports any special location values. If that flag is not 980 * set in @data then special location values should not be used. 981 * 982 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an 983 * existing rule on entry and @fs contains the rule on return; if 984 * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is 985 * filled with the RSS context ID associated with the rule. 986 * 987 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the 988 * user buffer for @rule_locs on entry. On return, @data is the size 989 * of the rule table, @rule_cnt is the number of defined rules, and 990 * @rule_locs contains the locations of the defined rules. Drivers 991 * must use the second parameter to get_rxnfc() instead of @rule_locs. 992 * 993 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update. 994 * @fs.@location either specifies the location to use or is a special 995 * location value with %RX_CLS_LOC_SPECIAL flag set. On return, 996 * @fs.@location is the actual rule location. If @fs.@flow_type 997 * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to 998 * use for flow spreading traffic which matches this rule. The value 999 * from the rxfh indirection table will be added to @fs.@ring_cookie 1000 * to choose which ring to deliver to. 1001 * 1002 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an 1003 * existing rule on entry. 1004 * 1005 * A driver supporting the special location values for 1006 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused 1007 * location, and may remove a rule at a later location (lower 1008 * priority) that matches exactly the same set of flows. The special 1009 * values are %RX_CLS_LOC_ANY, selecting any location; 1010 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum 1011 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable 1012 * location (minimum priority). Additional special values may be 1013 * defined in future and drivers must return -%EINVAL for any 1014 * unrecognised value. 1015 */ 1016 struct ethtool_rxnfc { 1017 uint32_t cmd; 1018 uint32_t flow_type; 1019 uint64_t data; 1020 struct ethtool_rx_flow_spec fs; 1021 union { 1022 uint32_t rule_cnt; 1023 uint32_t rss_context; 1024 }; 1025 uint32_t rule_locs[0]; 1026 }; 1027 1028 1029 /** 1030 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection 1031 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR 1032 * @size: On entry, the array size of the user buffer, which may be zero. 1033 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware 1034 * indirection table. 1035 * @ring_index: RX ring/queue index for each hash value 1036 * 1037 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size 1038 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means 1039 * the table should be reset to default values. This last feature 1040 * is not supported by the original implementations. 1041 */ 1042 struct ethtool_rxfh_indir { 1043 uint32_t cmd; 1044 uint32_t size; 1045 uint32_t ring_index[0]; 1046 }; 1047 1048 /** 1049 * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key. 1050 * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH 1051 * @rss_context: RSS context identifier. Context 0 is the default for normal 1052 * traffic; other contexts can be referenced as the destination for RX flow 1053 * classification rules. %ETH_RXFH_CONTEXT_ALLOC is used with command 1054 * %ETHTOOL_SRSSH to allocate a new RSS context; on return this field will 1055 * contain the ID of the newly allocated context. 1056 * @indir_size: On entry, the array size of the user buffer for the 1057 * indirection table, which may be zero, or (for %ETHTOOL_SRSSH), 1058 * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH, 1059 * the array size of the hardware indirection table. 1060 * @key_size: On entry, the array size of the user buffer for the hash key, 1061 * which may be zero. On return from %ETHTOOL_GRSSH, the size of the 1062 * hardware hash key. 1063 * @hfunc: Defines the current RSS hash function used by HW (or to be set to). 1064 * Valid values are one of the %ETH_RSS_HASH_*. 1065 * @rsvd: Reserved for future extensions. 1066 * @rss_config: RX ring/queue index for each hash value i.e., indirection table 1067 * of @indir_size uint32_t elements, followed by hash key of @key_size 1068 * bytes. 1069 * 1070 * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the 1071 * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of 1072 * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested 1073 * and a @indir_size of zero means the indir table should be reset to default 1074 * values (if @rss_context == 0) or that the RSS context should be deleted. 1075 * An hfunc of zero means that hash function setting is not requested. 1076 */ 1077 struct ethtool_rxfh { 1078 uint32_t cmd; 1079 uint32_t rss_context; 1080 uint32_t indir_size; 1081 uint32_t key_size; 1082 uint8_t hfunc; 1083 uint8_t rsvd8[3]; 1084 uint32_t rsvd32; 1085 uint32_t rss_config[0]; 1086 }; 1087 #define ETH_RXFH_CONTEXT_ALLOC 0xffffffff 1088 #define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff 1089 1090 /** 1091 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter 1092 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 1093 * @h_u: Flow field values to match (dependent on @flow_type) 1094 * @m_u: Masks for flow field value bits to be ignored 1095 * @vlan_tag: VLAN tag to match 1096 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored 1097 * @data: Driver-dependent data to match 1098 * @data_mask: Mask for driver-dependent data bits to be ignored 1099 * @action: RX ring/queue index to deliver to (non-negative) or other action 1100 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) 1101 * 1102 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where 1103 * a field value and mask are both zero this is treated as if all mask 1104 * bits are set i.e. the field is ignored. 1105 */ 1106 struct ethtool_rx_ntuple_flow_spec { 1107 uint32_t flow_type; 1108 union { 1109 struct ethtool_tcpip4_spec tcp_ip4_spec; 1110 struct ethtool_tcpip4_spec udp_ip4_spec; 1111 struct ethtool_tcpip4_spec sctp_ip4_spec; 1112 struct ethtool_ah_espip4_spec ah_ip4_spec; 1113 struct ethtool_ah_espip4_spec esp_ip4_spec; 1114 struct ethtool_usrip4_spec usr_ip4_spec; 1115 struct eth_header ether_spec; 1116 uint8_t hdata[72]; 1117 } h_u, m_u; 1118 1119 uint16_t vlan_tag; 1120 uint16_t vlan_tag_mask; 1121 uint64_t data; 1122 uint64_t data_mask; 1123 1124 int32_t action; 1125 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */ 1126 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */ 1127 }; 1128 1129 /** 1130 * struct ethtool_rx_ntuple - command to set or clear RX flow filter 1131 * @cmd: Command number - %ETHTOOL_SRXNTUPLE 1132 * @fs: Flow filter specification 1133 */ 1134 struct ethtool_rx_ntuple { 1135 uint32_t cmd; 1136 struct ethtool_rx_ntuple_flow_spec fs; 1137 }; 1138 1139 #define ETHTOOL_FLASH_MAX_FILENAME 128 1140 enum ethtool_flash_op_type { 1141 ETHTOOL_FLASH_ALL_REGIONS = 0, 1142 }; 1143 1144 /* for passing firmware flashing related parameters */ 1145 struct ethtool_flash { 1146 uint32_t cmd; 1147 uint32_t region; 1148 char data[ETHTOOL_FLASH_MAX_FILENAME]; 1149 }; 1150 1151 /** 1152 * struct ethtool_dump - used for retrieving, setting device dump 1153 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or 1154 * %ETHTOOL_SET_DUMP 1155 * @version: FW version of the dump, filled in by driver 1156 * @flag: driver dependent flag for dump setting, filled in by driver during 1157 * get and filled in by ethtool for set operation. 1158 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when 1159 * firmware dump is disabled. 1160 * @len: length of dump data, used as the length of the user buffer on entry to 1161 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver 1162 * for %ETHTOOL_GET_DUMP_FLAG command 1163 * @data: data collected for get dump data operation 1164 */ 1165 struct ethtool_dump { 1166 uint32_t cmd; 1167 uint32_t version; 1168 uint32_t flag; 1169 uint32_t len; 1170 uint8_t data[0]; 1171 }; 1172 1173 #define ETH_FW_DUMP_DISABLE 0 1174 1175 /* for returning and changing feature sets */ 1176 1177 /** 1178 * struct ethtool_get_features_block - block with state of 32 features 1179 * @available: mask of changeable features 1180 * @requested: mask of features requested to be enabled if possible 1181 * @active: mask of currently enabled features 1182 * @never_changed: mask of features not changeable for any device 1183 */ 1184 struct ethtool_get_features_block { 1185 uint32_t available; 1186 uint32_t requested; 1187 uint32_t active; 1188 uint32_t never_changed; 1189 }; 1190 1191 /** 1192 * struct ethtool_gfeatures - command to get state of device's features 1193 * @cmd: command number = %ETHTOOL_GFEATURES 1194 * @size: On entry, the number of elements in the features[] array; 1195 * on return, the number of elements in features[] needed to hold 1196 * all features 1197 * @features: state of features 1198 */ 1199 struct ethtool_gfeatures { 1200 uint32_t cmd; 1201 uint32_t size; 1202 struct ethtool_get_features_block features[0]; 1203 }; 1204 1205 /** 1206 * struct ethtool_set_features_block - block with request for 32 features 1207 * @valid: mask of features to be changed 1208 * @requested: values of features to be changed 1209 */ 1210 struct ethtool_set_features_block { 1211 uint32_t valid; 1212 uint32_t requested; 1213 }; 1214 1215 /** 1216 * struct ethtool_sfeatures - command to request change in device's features 1217 * @cmd: command number = %ETHTOOL_SFEATURES 1218 * @size: array size of the features[] array 1219 * @features: feature change masks 1220 */ 1221 struct ethtool_sfeatures { 1222 uint32_t cmd; 1223 uint32_t size; 1224 struct ethtool_set_features_block features[0]; 1225 }; 1226 1227 /** 1228 * struct ethtool_ts_info - holds a device's timestamping and PHC association 1229 * @cmd: command number = %ETHTOOL_GET_TS_INFO 1230 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags 1231 * @phc_index: device index of the associated PHC, or -1 if there is none 1232 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values 1233 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values 1234 * 1235 * The bits in the 'tx_types' and 'rx_filters' fields correspond to 1236 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values, 1237 * respectively. For example, if the device supports HWTSTAMP_TX_ON, 1238 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set. 1239 * 1240 * Drivers should only report the filters they actually support without 1241 * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for 1242 * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the 1243 * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op. 1244 */ 1245 struct ethtool_ts_info { 1246 uint32_t cmd; 1247 uint32_t so_timestamping; 1248 int32_t phc_index; 1249 uint32_t tx_types; 1250 uint32_t tx_reserved[3]; 1251 uint32_t rx_filters; 1252 uint32_t rx_reserved[3]; 1253 }; 1254 1255 /* 1256 * %ETHTOOL_SFEATURES changes features present in features[].valid to the 1257 * values of corresponding bits in features[].requested. Bits in .requested 1258 * not set in .valid or not changeable are ignored. 1259 * 1260 * Returns %EINVAL when .valid contains undefined or never-changeable bits 1261 * or size is not equal to required number of features words (32-bit blocks). 1262 * Returns >= 0 if request was completed; bits set in the value mean: 1263 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not 1264 * changeable (not present in %ETHTOOL_GFEATURES' features[].available) 1265 * those bits were ignored. 1266 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the 1267 * resulting state of bits masked by .valid is not equal to .requested. 1268 * Probably there are other device-specific constraints on some features 1269 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered 1270 * here as though ignored bits were cleared. 1271 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling 1272 * compatibility functions. Requested offload state cannot be properly 1273 * managed by kernel. 1274 * 1275 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of 1276 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands 1277 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least 1278 * significant bit in features[0] fields. Empty strings mark undefined features. 1279 */ 1280 enum ethtool_sfeatures_retval_bits { 1281 ETHTOOL_F_UNSUPPORTED__BIT, 1282 ETHTOOL_F_WISH__BIT, 1283 ETHTOOL_F_COMPAT__BIT, 1284 }; 1285 1286 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT) 1287 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT) 1288 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT) 1289 1290 #define MAX_NUM_QUEUE 4096 1291 1292 /** 1293 * struct ethtool_per_queue_op - apply sub command to the queues in mask. 1294 * @cmd: ETHTOOL_PERQUEUE 1295 * @sub_command: the sub command which apply to each queues 1296 * @queue_mask: Bitmap of the queues which sub command apply to 1297 * @data: A complete command structure following for each of the queues addressed 1298 */ 1299 struct ethtool_per_queue_op { 1300 uint32_t cmd; 1301 uint32_t sub_command; 1302 uint32_t queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)]; 1303 char data[]; 1304 }; 1305 1306 /** 1307 * struct ethtool_fecparam - Ethernet forward error correction(fec) parameters 1308 * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM 1309 * @active_fec: FEC mode which is active on porte 1310 * @fec: Bitmask of supported/configured FEC modes 1311 * @rsvd: Reserved for future extensions. i.e FEC bypass feature. 1312 * 1313 * Drivers should reject a non-zero setting of @autoneg when 1314 * autoneogotiation is disabled (or not supported) for the link. 1315 * 1316 */ 1317 struct ethtool_fecparam { 1318 uint32_t cmd; 1319 /* bitmask of FEC modes */ 1320 uint32_t active_fec; 1321 uint32_t fec; 1322 uint32_t reserved; 1323 }; 1324 1325 /** 1326 * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration 1327 * @ETHTOOL_FEC_NONE: FEC mode configuration is not supported 1328 * @ETHTOOL_FEC_AUTO: Default/Best FEC mode provided by driver 1329 * @ETHTOOL_FEC_OFF: No FEC Mode 1330 * @ETHTOOL_FEC_RS: Reed-Solomon Forward Error Detection mode 1331 * @ETHTOOL_FEC_BASER: Base-R/Reed-Solomon Forward Error Detection mode 1332 */ 1333 enum ethtool_fec_config_bits { 1334 ETHTOOL_FEC_NONE_BIT, 1335 ETHTOOL_FEC_AUTO_BIT, 1336 ETHTOOL_FEC_OFF_BIT, 1337 ETHTOOL_FEC_RS_BIT, 1338 ETHTOOL_FEC_BASER_BIT, 1339 ETHTOOL_FEC_LLRS_BIT, 1340 }; 1341 1342 #define ETHTOOL_FEC_NONE (1 << ETHTOOL_FEC_NONE_BIT) 1343 #define ETHTOOL_FEC_AUTO (1 << ETHTOOL_FEC_AUTO_BIT) 1344 #define ETHTOOL_FEC_OFF (1 << ETHTOOL_FEC_OFF_BIT) 1345 #define ETHTOOL_FEC_RS (1 << ETHTOOL_FEC_RS_BIT) 1346 #define ETHTOOL_FEC_BASER (1 << ETHTOOL_FEC_BASER_BIT) 1347 #define ETHTOOL_FEC_LLRS (1 << ETHTOOL_FEC_LLRS_BIT) 1348 1349 /* CMDs currently supported */ 1350 #define ETHTOOL_GSET 0x00000001 /* DEPRECATED, Get settings. 1351 * Please use ETHTOOL_GLINKSETTINGS 1352 */ 1353 #define ETHTOOL_SSET 0x00000002 /* DEPRECATED, Set settings. 1354 * Please use ETHTOOL_SLINKSETTINGS 1355 */ 1356 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 1357 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 1358 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 1359 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 1360 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 1361 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 1362 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 1363 /* Get link status for host, i.e. whether the interface *and* the 1364 * physical port (if there is one) are up (ethtool_value). */ 1365 #define ETHTOOL_GLINK 0x0000000a 1366 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 1367 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 1368 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 1369 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 1370 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 1371 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 1372 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 1373 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 1374 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 1375 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 1376 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 1377 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 1378 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 1379 * (ethtool_value) */ 1380 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 1381 * (ethtool_value). */ 1382 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 1383 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 1384 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 1385 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 1386 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 1387 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 1388 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 1389 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 1390 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 1391 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 1392 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 1393 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 1394 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 1395 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 1396 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 1397 1398 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */ 1399 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */ 1400 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */ 1401 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */ 1402 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */ 1403 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */ 1404 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */ 1405 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */ 1406 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */ 1407 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */ 1408 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */ 1409 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */ 1410 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */ 1411 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */ 1412 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */ 1413 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */ 1414 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */ 1415 1416 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */ 1417 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */ 1418 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */ 1419 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */ 1420 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */ 1421 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */ 1422 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */ 1423 #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */ 1424 #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */ 1425 #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */ 1426 #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */ 1427 #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */ 1428 1429 #define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */ 1430 #define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */ 1431 #define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */ 1432 #define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */ 1433 #define ETHTOOL_GPHYSTATS 0x0000004a /* get PHY-specific statistics */ 1434 1435 #define ETHTOOL_PERQUEUE 0x0000004b /* Set per queue options */ 1436 1437 #define ETHTOOL_GLINKSETTINGS 0x0000004c /* Get ethtool_link_settings */ 1438 #define ETHTOOL_SLINKSETTINGS 0x0000004d /* Set ethtool_link_settings */ 1439 #define ETHTOOL_PHY_GTUNABLE 0x0000004e /* Get PHY tunable configuration */ 1440 #define ETHTOOL_PHY_STUNABLE 0x0000004f /* Set PHY tunable configuration */ 1441 #define ETHTOOL_GFECPARAM 0x00000050 /* Get FEC settings */ 1442 #define ETHTOOL_SFECPARAM 0x00000051 /* Set FEC settings */ 1443 1444 /* compatibility with older code */ 1445 #define SPARC_ETH_GSET ETHTOOL_GSET 1446 #define SPARC_ETH_SSET ETHTOOL_SSET 1447 1448 /* Link mode bit indices */ 1449 enum ethtool_link_mode_bit_indices { 1450 ETHTOOL_LINK_MODE_10baseT_Half_BIT = 0, 1451 ETHTOOL_LINK_MODE_10baseT_Full_BIT = 1, 1452 ETHTOOL_LINK_MODE_100baseT_Half_BIT = 2, 1453 ETHTOOL_LINK_MODE_100baseT_Full_BIT = 3, 1454 ETHTOOL_LINK_MODE_1000baseT_Half_BIT = 4, 1455 ETHTOOL_LINK_MODE_1000baseT_Full_BIT = 5, 1456 ETHTOOL_LINK_MODE_Autoneg_BIT = 6, 1457 ETHTOOL_LINK_MODE_TP_BIT = 7, 1458 ETHTOOL_LINK_MODE_AUI_BIT = 8, 1459 ETHTOOL_LINK_MODE_MII_BIT = 9, 1460 ETHTOOL_LINK_MODE_FIBRE_BIT = 10, 1461 ETHTOOL_LINK_MODE_BNC_BIT = 11, 1462 ETHTOOL_LINK_MODE_10000baseT_Full_BIT = 12, 1463 ETHTOOL_LINK_MODE_Pause_BIT = 13, 1464 ETHTOOL_LINK_MODE_Asym_Pause_BIT = 14, 1465 ETHTOOL_LINK_MODE_2500baseX_Full_BIT = 15, 1466 ETHTOOL_LINK_MODE_Backplane_BIT = 16, 1467 ETHTOOL_LINK_MODE_1000baseKX_Full_BIT = 17, 1468 ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT = 18, 1469 ETHTOOL_LINK_MODE_10000baseKR_Full_BIT = 19, 1470 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT = 20, 1471 ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21, 1472 ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT = 22, 1473 ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT = 23, 1474 ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT = 24, 1475 ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT = 25, 1476 ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT = 26, 1477 ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT = 27, 1478 ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT = 28, 1479 ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT = 29, 1480 ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT = 30, 1481 ETHTOOL_LINK_MODE_25000baseCR_Full_BIT = 31, 1482 1483 /* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit 1484 * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_* 1485 * macro for bits > 31. The only way to use indices > 31 is to 1486 * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. 1487 */ 1488 1489 ETHTOOL_LINK_MODE_25000baseKR_Full_BIT = 32, 1490 ETHTOOL_LINK_MODE_25000baseSR_Full_BIT = 33, 1491 ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT = 34, 1492 ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT = 35, 1493 ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT = 36, 1494 ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT = 37, 1495 ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT = 38, 1496 ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT = 39, 1497 ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT = 40, 1498 ETHTOOL_LINK_MODE_1000baseX_Full_BIT = 41, 1499 ETHTOOL_LINK_MODE_10000baseCR_Full_BIT = 42, 1500 ETHTOOL_LINK_MODE_10000baseSR_Full_BIT = 43, 1501 ETHTOOL_LINK_MODE_10000baseLR_Full_BIT = 44, 1502 ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT = 45, 1503 ETHTOOL_LINK_MODE_10000baseER_Full_BIT = 46, 1504 ETHTOOL_LINK_MODE_2500baseT_Full_BIT = 47, 1505 ETHTOOL_LINK_MODE_5000baseT_Full_BIT = 48, 1506 1507 ETHTOOL_LINK_MODE_FEC_NONE_BIT = 49, 1508 ETHTOOL_LINK_MODE_FEC_RS_BIT = 50, 1509 ETHTOOL_LINK_MODE_FEC_BASER_BIT = 51, 1510 ETHTOOL_LINK_MODE_50000baseKR_Full_BIT = 52, 1511 ETHTOOL_LINK_MODE_50000baseSR_Full_BIT = 53, 1512 ETHTOOL_LINK_MODE_50000baseCR_Full_BIT = 54, 1513 ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT = 55, 1514 ETHTOOL_LINK_MODE_50000baseDR_Full_BIT = 56, 1515 ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT = 57, 1516 ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT = 58, 1517 ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT = 59, 1518 ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60, 1519 ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT = 61, 1520 ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT = 62, 1521 ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT = 63, 1522 ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64, 1523 ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT = 65, 1524 ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT = 66, 1525 ETHTOOL_LINK_MODE_100baseT1_Full_BIT = 67, 1526 ETHTOOL_LINK_MODE_1000baseT1_Full_BIT = 68, 1527 ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT = 69, 1528 ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT = 70, 1529 ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71, 1530 ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT = 72, 1531 ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT = 73, 1532 ETHTOOL_LINK_MODE_FEC_LLRS_BIT = 74, 1533 /* must be last entry */ 1534 __ETHTOOL_LINK_MODE_MASK_NBITS 1535 }; 1536 1537 #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name) \ 1538 (1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT)) 1539 1540 /* DEPRECATED macros. Please migrate to 1541 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT 1542 * define any new SUPPORTED_* macro for bits > 31. 1543 */ 1544 #define SUPPORTED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half) 1545 #define SUPPORTED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full) 1546 #define SUPPORTED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half) 1547 #define SUPPORTED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full) 1548 #define SUPPORTED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half) 1549 #define SUPPORTED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full) 1550 #define SUPPORTED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg) 1551 #define SUPPORTED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP) 1552 #define SUPPORTED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI) 1553 #define SUPPORTED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII) 1554 #define SUPPORTED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE) 1555 #define SUPPORTED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC) 1556 #define SUPPORTED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full) 1557 #define SUPPORTED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause) 1558 #define SUPPORTED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause) 1559 #define SUPPORTED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full) 1560 #define SUPPORTED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane) 1561 #define SUPPORTED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full) 1562 #define SUPPORTED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full) 1563 #define SUPPORTED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full) 1564 #define SUPPORTED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC) 1565 #define SUPPORTED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full) 1566 #define SUPPORTED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full) 1567 #define SUPPORTED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full) 1568 #define SUPPORTED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full) 1569 #define SUPPORTED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full) 1570 #define SUPPORTED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full) 1571 #define SUPPORTED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full) 1572 #define SUPPORTED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full) 1573 #define SUPPORTED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full) 1574 #define SUPPORTED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full) 1575 /* Please do not define any new SUPPORTED_* macro for bits > 31, see 1576 * notice above. 1577 */ 1578 1579 /* 1580 * DEPRECATED macros. Please migrate to 1581 * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT 1582 * define any new ADERTISE_* macro for bits > 31. 1583 */ 1584 #define ADVERTISED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half) 1585 #define ADVERTISED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full) 1586 #define ADVERTISED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half) 1587 #define ADVERTISED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full) 1588 #define ADVERTISED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half) 1589 #define ADVERTISED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full) 1590 #define ADVERTISED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg) 1591 #define ADVERTISED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP) 1592 #define ADVERTISED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI) 1593 #define ADVERTISED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII) 1594 #define ADVERTISED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE) 1595 #define ADVERTISED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC) 1596 #define ADVERTISED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full) 1597 #define ADVERTISED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause) 1598 #define ADVERTISED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause) 1599 #define ADVERTISED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full) 1600 #define ADVERTISED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane) 1601 #define ADVERTISED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full) 1602 #define ADVERTISED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full) 1603 #define ADVERTISED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full) 1604 #define ADVERTISED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC) 1605 #define ADVERTISED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full) 1606 #define ADVERTISED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full) 1607 #define ADVERTISED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full) 1608 #define ADVERTISED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full) 1609 #define ADVERTISED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full) 1610 #define ADVERTISED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full) 1611 #define ADVERTISED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full) 1612 #define ADVERTISED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full) 1613 #define ADVERTISED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full) 1614 #define ADVERTISED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full) 1615 /* Please do not define any new ADVERTISED_* macro for bits > 31, see 1616 * notice above. 1617 */ 1618 1619 /* The following are all involved in forcing a particular link 1620 * mode for the device for setting things. When getting the 1621 * devices settings, these indicate the current mode and whether 1622 * it was forced up into this mode or autonegotiated. 1623 */ 1624 1625 /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal. 1626 * Update drivers/net/phy/phy.c:phy_speed_to_str() and 1627 * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values. 1628 */ 1629 #define SPEED_10 10 1630 #define SPEED_100 100 1631 #define SPEED_1000 1000 1632 #define SPEED_2500 2500 1633 #define SPEED_5000 5000 1634 #define SPEED_10000 10000 1635 #define SPEED_14000 14000 1636 #define SPEED_20000 20000 1637 #define SPEED_25000 25000 1638 #define SPEED_40000 40000 1639 #define SPEED_50000 50000 1640 #define SPEED_56000 56000 1641 #define SPEED_100000 100000 1642 #define SPEED_200000 200000 1643 #define SPEED_400000 400000 1644 1645 #define SPEED_UNKNOWN -1 1646 1647 static inline int ethtool_validate_speed(uint32_t speed) 1648 { 1649 return speed <= INT_MAX || speed == (uint32_t)SPEED_UNKNOWN; 1650 } 1651 1652 /* Duplex, half or full. */ 1653 #define DUPLEX_HALF 0x00 1654 #define DUPLEX_FULL 0x01 1655 #define DUPLEX_UNKNOWN 0xff 1656 1657 static inline int ethtool_validate_duplex(uint8_t duplex) 1658 { 1659 switch (duplex) { 1660 case DUPLEX_HALF: 1661 case DUPLEX_FULL: 1662 case DUPLEX_UNKNOWN: 1663 return 1; 1664 } 1665 1666 return 0; 1667 } 1668 1669 /* Which connector port. */ 1670 #define PORT_TP 0x00 1671 #define PORT_AUI 0x01 1672 #define PORT_MII 0x02 1673 #define PORT_FIBRE 0x03 1674 #define PORT_BNC 0x04 1675 #define PORT_DA 0x05 1676 #define PORT_NONE 0xef 1677 #define PORT_OTHER 0xff 1678 1679 /* Which transceiver to use. */ 1680 #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */ 1681 #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */ 1682 #define XCVR_DUMMY1 0x02 1683 #define XCVR_DUMMY2 0x03 1684 #define XCVR_DUMMY3 0x04 1685 1686 /* Enable or disable autonegotiation. */ 1687 #define AUTONEG_DISABLE 0x00 1688 #define AUTONEG_ENABLE 0x01 1689 1690 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then 1691 * the driver is required to renegotiate link 1692 */ 1693 #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */ 1694 #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */ 1695 #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */ 1696 #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */ 1697 1698 /* Wake-On-Lan options. */ 1699 #define WAKE_PHY (1 << 0) 1700 #define WAKE_UCAST (1 << 1) 1701 #define WAKE_MCAST (1 << 2) 1702 #define WAKE_BCAST (1 << 3) 1703 #define WAKE_ARP (1 << 4) 1704 #define WAKE_MAGIC (1 << 5) 1705 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 1706 #define WAKE_FILTER (1 << 7) 1707 1708 #define WOL_MODE_COUNT 8 1709 1710 /* L2-L4 network traffic flow types */ 1711 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */ 1712 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */ 1713 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */ 1714 #define AH_ESP_V4_FLOW 0x04 /* hash only */ 1715 #define TCP_V6_FLOW 0x05 /* hash or spec (tcp_ip6_spec; nfc only) */ 1716 #define UDP_V6_FLOW 0x06 /* hash or spec (udp_ip6_spec; nfc only) */ 1717 #define SCTP_V6_FLOW 0x07 /* hash or spec (sctp_ip6_spec; nfc only) */ 1718 #define AH_ESP_V6_FLOW 0x08 /* hash only */ 1719 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */ 1720 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */ 1721 #define AH_V6_FLOW 0x0b /* hash or spec (ah_ip6_spec; nfc only) */ 1722 #define ESP_V6_FLOW 0x0c /* hash or spec (esp_ip6_spec; nfc only) */ 1723 #define IPV4_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */ 1724 #define IP_USER_FLOW IPV4_USER_FLOW 1725 #define IPV6_USER_FLOW 0x0e /* spec only (usr_ip6_spec; nfc only) */ 1726 #define IPV4_FLOW 0x10 /* hash only */ 1727 #define IPV6_FLOW 0x11 /* hash only */ 1728 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */ 1729 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */ 1730 #define FLOW_EXT 0x80000000 1731 #define FLOW_MAC_EXT 0x40000000 1732 /* Flag to enable RSS spreading of traffic matching rule (nfc only) */ 1733 #define FLOW_RSS 0x20000000 1734 1735 /* L3-L4 network traffic flow hash options */ 1736 #define RXH_L2DA (1 << 1) 1737 #define RXH_VLAN (1 << 2) 1738 #define RXH_L3_PROTO (1 << 3) 1739 #define RXH_IP_SRC (1 << 4) 1740 #define RXH_IP_DST (1 << 5) 1741 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */ 1742 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */ 1743 #define RXH_DISCARD (1 << 31) 1744 1745 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL 1746 #define RX_CLS_FLOW_WAKE 0xfffffffffffffffeULL 1747 1748 /* Special RX classification rule insert location values */ 1749 #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */ 1750 #define RX_CLS_LOC_ANY 0xffffffff 1751 #define RX_CLS_LOC_FIRST 0xfffffffe 1752 #define RX_CLS_LOC_LAST 0xfffffffd 1753 1754 /* EEPROM Standards for plug in modules */ 1755 #define ETH_MODULE_SFF_8079 0x1 1756 #define ETH_MODULE_SFF_8079_LEN 256 1757 #define ETH_MODULE_SFF_8472 0x2 1758 #define ETH_MODULE_SFF_8472_LEN 512 1759 #define ETH_MODULE_SFF_8636 0x3 1760 #define ETH_MODULE_SFF_8636_LEN 256 1761 #define ETH_MODULE_SFF_8436 0x4 1762 #define ETH_MODULE_SFF_8436_LEN 256 1763 1764 #define ETH_MODULE_SFF_8636_MAX_LEN 640 1765 #define ETH_MODULE_SFF_8436_MAX_LEN 640 1766 1767 /* Reset flags */ 1768 /* The reset() operation must clear the flags for the components which 1769 * were actually reset. On successful return, the flags indicate the 1770 * components which were not reset, either because they do not exist 1771 * in the hardware or because they cannot be reset independently. The 1772 * driver must never reset any components that were not requested. 1773 */ 1774 enum ethtool_reset_flags { 1775 /* These flags represent components dedicated to the interface 1776 * the command is addressed to. Shift any flag left by 1777 * ETH_RESET_SHARED_SHIFT to reset a shared component of the 1778 * same type. 1779 */ 1780 ETH_RESET_MGMT = 1 << 0, /* Management processor */ 1781 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */ 1782 ETH_RESET_DMA = 1 << 2, /* DMA engine */ 1783 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */ 1784 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */ 1785 ETH_RESET_MAC = 1 << 5, /* Media access controller */ 1786 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */ 1787 ETH_RESET_RAM = 1 << 7, /* RAM shared between 1788 * multiple components */ 1789 ETH_RESET_AP = 1 << 8, /* Application processor */ 1790 1791 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to 1792 * this interface */ 1793 ETH_RESET_ALL = 0xffffffff, /* All components used by this 1794 * interface, even if shared */ 1795 }; 1796 #define ETH_RESET_SHARED_SHIFT 16 1797 1798 1799 /** 1800 * struct ethtool_link_settings - link control and status 1801 * 1802 * IMPORTANT, Backward compatibility notice: When implementing new 1803 * user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and 1804 * if it succeeds use %ETHTOOL_SLINKSETTINGS to change link 1805 * settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS 1806 * succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in 1807 * that case. Conversely, if %ETHTOOL_GLINKSETTINGS fails, use 1808 * %ETHTOOL_GSET to query and %ETHTOOL_SSET to change link 1809 * settings; do not use %ETHTOOL_SLINKSETTINGS if 1810 * %ETHTOOL_GLINKSETTINGS failed: stick to 1811 * %ETHTOOL_GSET/%ETHTOOL_SSET in that case. 1812 * 1813 * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS 1814 * @speed: Link speed (Mbps) 1815 * @duplex: Duplex mode; one of %DUPLEX_* 1816 * @port: Physical connector type; one of %PORT_* 1817 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not 1818 * applicable. For clause 45 PHYs this is the PRTAD. 1819 * @autoneg: Enable/disable autonegotiation and auto-detection; 1820 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE 1821 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO 1822 * protocols supported by the interface; 0 if unknown. 1823 * Read-only. 1824 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of 1825 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the 1826 * value will be %ETH_TP_MDI_INVALID. Read-only. 1827 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of 1828 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads 1829 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. 1830 * When written successfully, the link should be renegotiated if 1831 * necessary. 1832 * @link_mode_masks_nwords: Number of 32-bit words for each of the 1833 * supported, advertising, lp_advertising link mode bitmaps. For 1834 * %ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user 1835 * (>= 0); on return, if handshake in progress, negative if 1836 * request size unsupported by kernel: absolute value indicates 1837 * kernel expected size and all the other fields but cmd 1838 * are 0; otherwise (handshake completed), strictly positive 1839 * to indicate size used by kernel and cmd field stays 1840 * %ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For 1841 * %ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive 1842 * value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise 1843 * refused. For drivers: ignore this field (use kernel's 1844 * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will 1845 * be overwritten by kernel. 1846 * @supported: Bitmap with each bit meaning given by 1847 * %ethtool_link_mode_bit_indices for the link modes, physical 1848 * connectors and other link features for which the interface 1849 * supports autonegotiation or auto-detection. Read-only. 1850 * @advertising: Bitmap with each bit meaning given by 1851 * %ethtool_link_mode_bit_indices for the link modes, physical 1852 * connectors and other link features that are advertised through 1853 * autonegotiation or enabled for auto-detection. 1854 * @lp_advertising: Bitmap with each bit meaning given by 1855 * %ethtool_link_mode_bit_indices for the link modes, and other 1856 * link features that the link partner advertised through 1857 * autonegotiation; 0 if unknown or not applicable. Read-only. 1858 * @transceiver: Used to distinguish different possible PHY types, 1859 * reported consistently by PHYLIB. Read-only. 1860 * 1861 * If autonegotiation is disabled, the speed and @duplex represent the 1862 * fixed link mode and are writable if the driver supports multiple 1863 * link modes. If it is enabled then they are read-only; if the link 1864 * is up they represent the negotiated link mode; if the link is down, 1865 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and 1866 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. 1867 * 1868 * Some hardware interfaces may have multiple PHYs and/or physical 1869 * connectors fitted or do not allow the driver to detect which are 1870 * fitted. For these interfaces @port and/or @phy_address may be 1871 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. 1872 * Otherwise, attempts to write different values may be ignored or 1873 * rejected. 1874 * 1875 * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt 1876 * are not available in %ethtool_link_settings. These fields will be 1877 * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will 1878 * fail if any of them is set to non-zero value. 1879 * 1880 * Users should assume that all fields not marked read-only are 1881 * writable and subject to validation by the driver. They should use 1882 * %ETHTOOL_GLINKSETTINGS to get the current values before making specific 1883 * changes and then applying them with %ETHTOOL_SLINKSETTINGS. 1884 * 1885 * Drivers that implement %get_link_ksettings and/or 1886 * %set_link_ksettings should ignore the @cmd 1887 * and @link_mode_masks_nwords fields (any change to them overwritten 1888 * by kernel), and rely only on kernel's internal 1889 * %__ETHTOOL_LINK_MODE_MASK_NBITS and 1890 * %ethtool_link_mode_mask_t. Drivers that implement 1891 * %set_link_ksettings() should validate all fields other than @cmd 1892 * and @link_mode_masks_nwords that are not described as read-only or 1893 * deprecated, and must ignore all fields described as read-only. 1894 */ 1895 struct ethtool_link_settings { 1896 uint32_t cmd; 1897 uint32_t speed; 1898 uint8_t duplex; 1899 uint8_t port; 1900 uint8_t phy_address; 1901 uint8_t autoneg; 1902 uint8_t mdio_support; 1903 uint8_t eth_tp_mdix; 1904 uint8_t eth_tp_mdix_ctrl; 1905 int8_t link_mode_masks_nwords; 1906 uint8_t transceiver; 1907 uint8_t reserved1[3]; 1908 uint32_t reserved[7]; 1909 uint32_t link_mode_masks[0]; 1910 /* layout of link_mode_masks fields: 1911 * uint32_t map_supported[link_mode_masks_nwords]; 1912 * uint32_t map_advertising[link_mode_masks_nwords]; 1913 * uint32_t map_lp_advertising[link_mode_masks_nwords]; 1914 */ 1915 }; 1916 #endif /* _LINUX_ETHTOOL_H */ 1917