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