i686-linux-gnu-4.7/usr/include/linux/ethtool.h

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