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