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