include/linux/ethtool.h

   1 /*
   2  * ethtool.h: Defines for Linux ethtool.
   3  *
   4  * Copyright (C) 1998 David S. Miller (davem@redhat.com)
   5  * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
   6  * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
   7  * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
   8  *                                christopher.leech@intel.com,
   9  *                                scott.feldman@intel.com)
  10  * Portions Copyright (C) Sun Microsystems 2008
  11  */
  12
  13 #ifndef _LINUX_ETHTOOL_H
  14 #define _LINUX_ETHTOOL_H
  15
  16 #ifdef __KERNEL__
  17 #include <linux/compat.h>
  18 #endif
  19 #include <linux/types.h>
  20 #include <linux/if_ether.h>
  21
  22 /* This should work for both 32 and 64 bit userland. */
  23 struct ethtool_cmd {
  24         __u32   cmd;
  25         __u32   supported;      /* Features this interface supports */
  26         __u32   advertising;    /* Features this interface advertises */
  27         __u16   speed;          /* The forced speed (lower bits) in
  28                                  * Mbps. Please use
  29                                  * ethtool_cmd_speed()/_set() to
  30                                  * access it */
  31         __u8    duplex;         /* Duplex, half or full */
  32         __u8    port;           /* Which connector port */
  33         __u8    phy_address;    /* MDIO PHY address (PRTAD for clause 45).
  34                                  * May be read-only or read-write
  35                                  * depending on the driver.
  36                                  */
  37         __u8    transceiver;    /* Which transceiver to use */
  38         __u8    autoneg;        /* Enable or disable autonegotiation */
  39         __u8    mdio_support;   /* MDIO protocols supported.  Read-only.
  40                                  * Not set by all drivers.
  41                                  */
  42         __u32   maxtxpkt;       /* Tx pkts before generating tx int */
  43         __u32   maxrxpkt;       /* Rx pkts before generating rx int */
  44         __u16   speed_hi;       /* The forced speed (upper
  45                                  * bits) in Mbps. Please use
  46                                  * ethtool_cmd_speed()/_set() to
  47                                  * access it */
  48         __u8    eth_tp_mdix;
  49         __u8    reserved2;
  50         __u32   lp_advertising; /* Features the link partner advertises */
  51         __u32   reserved[2];
  52 };
  53
  54 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
  55                                          __u32 speed)
  56 {
  57
  58         ep->speed = (__u16)speed;
  59         ep->speed_hi = (__u16)(speed >> 16);
  60 }
  61
  62 static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
  63 {
  64         return (ep->speed_hi << 16) | ep->speed;
  65 }
  66
  67 /* Device supports clause 22 register access to PHY or peripherals
  68  * using the interface defined in <linux/mii.h>.  This should not be
  69  * set if there are known to be no such peripherals present or if
  70  * the driver only emulates clause 22 registers for compatibility.
  71  */
  72 #define ETH_MDIO_SUPPORTS_C22   1
  73
  74 /* Device supports clause 45 register access to PHY or peripherals
  75  * using the interface defined in <linux/mii.h> and <linux/mdio.h>.
  76  * This should not be set if there are known to be no such peripherals
  77  * present.
  78  */
  79 #define ETH_MDIO_SUPPORTS_C45   2
  80
  81 #define ETHTOOL_FWVERS_LEN      32
  82 #define ETHTOOL_BUSINFO_LEN     32
  83 /* these strings are set to whatever the driver author decides... */
  84 struct ethtool_drvinfo {
  85         __u32   cmd;
  86         char    driver[32];     /* driver short name, "tulip", "eepro100" */
  87         char    version[32];    /* driver version string */
  88         char    fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
  89         char    bus_info[ETHTOOL_BUSINFO_LEN];  /* Bus info for this IF. */
  90                                 /* For PCI devices, use pci_name(pci_dev). */
  91         char    reserved1[32];
  92         char    reserved2[12];
  93                                 /*
  94                                  * Some struct members below are filled in
  95                                  * using ops->get_sset_count().  Obtaining
  96                                  * this info from ethtool_drvinfo is now
  97                                  * deprecated; Use ETHTOOL_GSSET_INFO
  98                                  * instead.
  99                                  */
 100         __u32   n_priv_flags;   /* number of flags valid in ETHTOOL_GPFLAGS */
 101         __u32   n_stats;        /* number of u64's from ETHTOOL_GSTATS */
 102         __u32   testinfo_len;
 103         __u32   eedump_len;     /* Size of data from ETHTOOL_GEEPROM (bytes) */
 104         __u32   regdump_len;    /* Size of data from ETHTOOL_GREGS (bytes) */
 105 };
 106
 107 #define SOPASS_MAX      6
 108 /* wake-on-lan settings */
 109 struct ethtool_wolinfo {
 110         __u32   cmd;
 111         __u32   supported;
 112         __u32   wolopts;
 113         __u8    sopass[SOPASS_MAX]; /* SecureOn(tm) password */
 114 };
 115
 116 /* for passing single values */
 117 struct ethtool_value {
 118         __u32   cmd;
 119         __u32   data;
 120 };
 121
 122 /* for passing big chunks of data */
 123 struct ethtool_regs {
 124         __u32   cmd;
 125         __u32   version; /* driver-specific, indicates different chips/revs */
 126         __u32   len; /* bytes */
 127         __u8    data[0];
 128 };
 129
 130 /* for passing EEPROM chunks */
 131 struct ethtool_eeprom {
 132         __u32   cmd;
 133         __u32   magic;
 134         __u32   offset; /* in bytes */
 135         __u32   len; /* in bytes */
 136         __u8    data[0];
 137 };
 138
 139 /**
 140  * struct ethtool_modinfo - plugin module eeprom information
 141  * @cmd: %ETHTOOL_GMODULEINFO
 142  * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
 143  * @eeprom_len: Length of the eeprom
 144  *
 145  * This structure is used to return the information to
 146  * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
 147  * The type code indicates the eeprom data format
 148  */
 149 struct ethtool_modinfo {
 150         __u32   cmd;
 151         __u32   type;
 152         __u32   eeprom_len;
 153         __u32   reserved[8];
 154 };
 155
 156 /**
 157  * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
 158  * @cmd: ETHTOOL_{G,S}COALESCE
 159  * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
 160  *      a packet arrives.
 161  * @rx_max_coalesced_frames: Maximum number of packets to receive
 162  *      before an RX interrupt.
 163  * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
 164  *      this value applies while an IRQ is being serviced by the host.
 165  * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
 166  *      except that this value applies while an IRQ is being serviced
 167  *      by the host.
 168  * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
 169  *      a packet is sent.
 170  * @tx_max_coalesced_frames: Maximum number of packets to be sent
 171  *      before a TX interrupt.
 172  * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
 173  *      this value applies while an IRQ is being serviced by the host.
 174  * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
 175  *      except that this value applies while an IRQ is being serviced
 176  *      by the host.
 177  * @stats_block_coalesce_usecs: How many usecs to delay in-memory
 178  *      statistics block updates.  Some drivers do not have an
 179  *      in-memory statistic block, and in such cases this value is
 180  *      ignored.  This value must not be zero.
 181  * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
 182  * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
 183  * @pkt_rate_low: Threshold for low packet rate (packets per second).
 184  * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
 185  *      a packet arrives, when the packet rate is below @pkt_rate_low.
 186  * @rx_max_coalesced_frames_low: Maximum number of packets to be received
 187  *      before an RX interrupt, when the packet rate is below @pkt_rate_low.
 188  * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
 189  *      a packet is sent, when the packet rate is below @pkt_rate_low.
 190  * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
 191  *      a TX interrupt, when the packet rate is below @pkt_rate_low.
 192  * @pkt_rate_high: Threshold for high packet rate (packets per second).
 193  * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
 194  *      a packet arrives, when the packet rate is above @pkt_rate_high.
 195  * @rx_max_coalesced_frames_high: Maximum number of packets to be received
 196  *      before an RX interrupt, when the packet rate is above @pkt_rate_high.
 197  * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
 198  *      a packet is sent, when the packet rate is above @pkt_rate_high.
 199  * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
 200  *      a TX interrupt, when the packet rate is above @pkt_rate_high.
 201  * @rate_sample_interval: How often to do adaptive coalescing packet rate
 202  *      sampling, measured in seconds.  Must not be zero.
 203  *
 204  * Each pair of (usecs, max_frames) fields specifies this exit
 205  * condition for interrupt coalescing:
 206  *      (usecs > 0 && time_since_first_completion >= usecs) ||
 207  *      (max_frames > 0 && completed_frames >= max_frames)
 208  * It is illegal to set both usecs and max_frames to zero as this
 209  * would cause interrupts to never be generated.  To disable
 210  * coalescing, set usecs = 0 and max_frames = 1.
 211  *
 212  * Some implementations ignore the value of max_frames and use the
 213  * condition:
 214  *      time_since_first_completion >= usecs
 215  * This is deprecated.  Drivers for hardware that does not support
 216  * counting completions should validate that max_frames == !rx_usecs.
 217  *
 218  * Adaptive RX/TX coalescing is an algorithm implemented by some
 219  * drivers to improve latency under low packet rates and improve
 220  * throughput under high packet rates.  Some drivers only implement
 221  * one of RX or TX adaptive coalescing.  Anything not implemented by
 222  * the driver causes these values to be silently ignored.
 223  *
 224  * When the packet rate is below @pkt_rate_high but above
 225  * @pkt_rate_low (both measured in packets per second) the
 226  * normal {rx,tx}_* coalescing parameters are used.
 227  */
 228 struct ethtool_coalesce {
 229         __u32   cmd;
 230         __u32   rx_coalesce_usecs;
 231         __u32   rx_max_coalesced_frames;
 232         __u32   rx_coalesce_usecs_irq;
 233         __u32   rx_max_coalesced_frames_irq;
 234         __u32   tx_coalesce_usecs;
 235         __u32   tx_max_coalesced_frames;
 236         __u32   tx_coalesce_usecs_irq;
 237         __u32   tx_max_coalesced_frames_irq;
 238         __u32   stats_block_coalesce_usecs;
 239         __u32   use_adaptive_rx_coalesce;
 240         __u32   use_adaptive_tx_coalesce;
 241         __u32   pkt_rate_low;
 242         __u32   rx_coalesce_usecs_low;
 243         __u32   rx_max_coalesced_frames_low;
 244         __u32   tx_coalesce_usecs_low;
 245         __u32   tx_max_coalesced_frames_low;
 246         __u32   pkt_rate_high;
 247         __u32   rx_coalesce_usecs_high;
 248         __u32   rx_max_coalesced_frames_high;
 249         __u32   tx_coalesce_usecs_high;
 250         __u32   tx_max_coalesced_frames_high;
 251         __u32   rate_sample_interval;
 252 };
 253
 254 /* for configuring RX/TX ring parameters */
 255 struct ethtool_ringparam {
 256         __u32   cmd;    /* ETHTOOL_{G,S}RINGPARAM */
 257
 258         /* Read only attributes.  These indicate the maximum number
 259          * of pending RX/TX ring entries the driver will allow the
 260          * user to set.
 261          */
 262         __u32   rx_max_pending;
 263         __u32   rx_mini_max_pending;
 264         __u32   rx_jumbo_max_pending;
 265         __u32   tx_max_pending;
 266
 267         /* Values changeable by the user.  The valid values are
 268          * in the range 1 to the "*_max_pending" counterpart above.
 269          */
 270         __u32   rx_pending;
 271         __u32   rx_mini_pending;
 272         __u32   rx_jumbo_pending;
 273         __u32   tx_pending;
 274 };
 275
 276 /**
 277  * struct ethtool_channels - configuring number of network channel
 278  * @cmd: ETHTOOL_{G,S}CHANNELS
 279  * @max_rx: Read only. Maximum number of receive channel the driver support.
 280  * @max_tx: Read only. Maximum number of transmit channel the driver support.
 281  * @max_other: Read only. Maximum number of other channel the driver support.
 282  * @max_combined: Read only. Maximum number of combined channel the driver
 283  *      support. Set of queues RX, TX or other.
 284  * @rx_count: Valid values are in the range 1 to the max_rx.
 285  * @tx_count: Valid values are in the range 1 to the max_tx.
 286  * @other_count: Valid values are in the range 1 to the max_other.
 287  * @combined_count: Valid values are in the range 1 to the max_combined.
 288  *
 289  * This can be used to configure RX, TX and other channels.
 290  */
 291
 292 struct ethtool_channels {
 293         __u32   cmd;
 294         __u32   max_rx;
 295         __u32   max_tx;
 296         __u32   max_other;
 297         __u32   max_combined;
 298         __u32   rx_count;
 299         __u32   tx_count;
 300         __u32   other_count;
 301         __u32   combined_count;
 302 };
 303
 304 /* for configuring link flow control parameters */
 305 struct ethtool_pauseparam {
 306         __u32   cmd;    /* ETHTOOL_{G,S}PAUSEPARAM */
 307
 308         /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
 309          * being true) the user may set 'autoneg' here non-zero to have the
 310          * pause parameters be auto-negotiated too.  In such a case, the
 311          * {rx,tx}_pause values below determine what capabilities are
 312          * advertised.
 313          *
 314          * If 'autoneg' is zero or the link is not being auto-negotiated,
 315          * then {rx,tx}_pause force the driver to use/not-use pause
 316          * flow control.
 317          */
 318         __u32   autoneg;
 319         __u32   rx_pause;
 320         __u32   tx_pause;
 321 };
 322
 323 #define ETH_GSTRING_LEN         32
 324 enum ethtool_stringset {
 325         ETH_SS_TEST             = 0,
 326         ETH_SS_STATS,
 327         ETH_SS_PRIV_FLAGS,
 328         ETH_SS_NTUPLE_FILTERS,  /* Do not use, GRXNTUPLE is now deprecated */
 329         ETH_SS_FEATURES,
 330 };
 331
 332 /* for passing string sets for data tagging */
 333 struct ethtool_gstrings {
 334         __u32   cmd;            /* ETHTOOL_GSTRINGS */
 335         __u32   string_set;     /* string set id e.c. ETH_SS_TEST, etc*/
 336         __u32   len;            /* number of strings in the string set */
 337         __u8    data[0];
 338 };
 339
 340 struct ethtool_sset_info {
 341         __u32   cmd;            /* ETHTOOL_GSSET_INFO */
 342         __u32   reserved;
 343         __u64   sset_mask;      /* input: each bit selects an sset to query */
 344                                 /* output: each bit a returned sset */
 345         __u32   data[0];        /* ETH_SS_xxx count, in order, based on bits
 346                                    in sset_mask.  One bit implies one
 347                                    __u32, two bits implies two
 348                                    __u32's, etc. */
 349 };
 350
 351 /**
 352  * enum ethtool_test_flags - flags definition of ethtool_test
 353  * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
 354  *      only online tests.
 355  * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
 356  * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
 357  *      test.
 358  * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
 359  */
 360
 361 enum ethtool_test_flags {
 362         ETH_TEST_FL_OFFLINE     = (1 << 0),
 363         ETH_TEST_FL_FAILED      = (1 << 1),
 364         ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
 365         ETH_TEST_FL_EXTERNAL_LB_DONE    = (1 << 3),
 366 };
 367
 368 /* for requesting NIC test and getting results*/
 369 struct ethtool_test {
 370         __u32   cmd;            /* ETHTOOL_TEST */
 371         __u32   flags;          /* ETH_TEST_FL_xxx */
 372         __u32   reserved;
 373         __u32   len;            /* result length, in number of u64 elements */
 374         __u64   data[0];
 375 };
 376
 377 /* for dumping NIC-specific statistics */
 378 struct ethtool_stats {
 379         __u32   cmd;            /* ETHTOOL_GSTATS */
 380         __u32   n_stats;        /* number of u64's being returned */
 381         __u64   data[0];
 382 };
 383
 384 struct ethtool_perm_addr {
 385         __u32   cmd;            /* ETHTOOL_GPERMADDR */
 386         __u32   size;
 387         __u8    data[0];
 388 };
 389
 390 /* boolean flags controlling per-interface behavior characteristics.
 391  * When reading, the flag indicates whether or not a certain behavior
 392  * is enabled/present.  When writing, the flag indicates whether
 393  * or not the driver should turn on (set) or off (clear) a behavior.
 394  *
 395  * Some behaviors may read-only (unconditionally absent or present).
 396  * If such is the case, return EINVAL in the set-flags operation if the
 397  * flag differs from the read-only value.
 398  */
 399 enum ethtool_flags {
 400         ETH_FLAG_TXVLAN         = (1 << 7),     /* TX VLAN offload enabled */
 401         ETH_FLAG_RXVLAN         = (1 << 8),     /* RX VLAN offload enabled */
 402         ETH_FLAG_LRO            = (1 << 15),    /* LRO is enabled */
 403         ETH_FLAG_NTUPLE         = (1 << 27),    /* N-tuple filters enabled */
 404         ETH_FLAG_RXHASH         = (1 << 28),
 405 };
 406
 407 /* The following structures are for supporting RX network flow
 408  * classification and RX n-tuple configuration. Note, all multibyte
 409  * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
 410  * be in network byte order.
 411  */
 412
 413 /**
 414  * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
 415  * @ip4src: Source host
 416  * @ip4dst: Destination host
 417  * @psrc: Source port
 418  * @pdst: Destination port
 419  * @tos: Type-of-service
 420  *
 421  * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
 422  */
 423 struct ethtool_tcpip4_spec {
 424         __be32  ip4src;
 425         __be32  ip4dst;
 426         __be16  psrc;
 427         __be16  pdst;
 428         __u8    tos;
 429 };
 430
 431 /**
 432  * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
 433  * @ip4src: Source host
 434  * @ip4dst: Destination host
 435  * @spi: Security parameters index
 436  * @tos: Type-of-service
 437  *
 438  * This can be used to specify an IPsec transport or tunnel over IPv4.
 439  */
 440 struct ethtool_ah_espip4_spec {
 441         __be32  ip4src;
 442         __be32  ip4dst;
 443         __be32  spi;
 444         __u8    tos;
 445 };
 446
 447 #define ETH_RX_NFC_IP4  1
 448
 449 /**
 450  * struct ethtool_usrip4_spec - general flow specification for IPv4
 451  * @ip4src: Source host
 452  * @ip4dst: Destination host
 453  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
 454  * @tos: Type-of-service
 455  * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
 456  * @proto: Transport protocol number; mask must be 0
 457  */
 458 struct ethtool_usrip4_spec {
 459         __be32  ip4src;
 460         __be32  ip4dst;
 461         __be32  l4_4_bytes;
 462         __u8    tos;
 463         __u8    ip_ver;
 464         __u8    proto;
 465 };
 466
 467 union ethtool_flow_union {
 468         struct ethtool_tcpip4_spec              tcp_ip4_spec;
 469         struct ethtool_tcpip4_spec              udp_ip4_spec;
 470         struct ethtool_tcpip4_spec              sctp_ip4_spec;
 471         struct ethtool_ah_espip4_spec           ah_ip4_spec;
 472         struct ethtool_ah_espip4_spec           esp_ip4_spec;
 473         struct ethtool_usrip4_spec              usr_ip4_spec;
 474         struct ethhdr                           ether_spec;
 475         __u8                                    hdata[60];
 476 };
 477
 478 struct ethtool_flow_ext {
 479         __be16  vlan_etype;
 480         __be16  vlan_tci;
 481         __be32  data[2];
 482 };
 483
 484 /**
 485  * struct ethtool_rx_flow_spec - classification rule for RX flows
 486  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
 487  * @h_u: Flow fields to match (dependent on @flow_type)
 488  * @h_ext: Additional fields to match
 489  * @m_u: Masks for flow field bits to be matched
 490  * @m_ext: Masks for additional field bits to be matched
 491  *      Note, all additional fields must be ignored unless @flow_type
 492  *      includes the %FLOW_EXT flag.
 493  * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
 494  *      if packets should be discarded
 495  * @location: Location of rule in the table.  Locations must be
 496  *      numbered such that a flow matching multiple rules will be
 497  *      classified according to the first (lowest numbered) rule.
 498  */
 499 struct ethtool_rx_flow_spec {
 500         __u32           flow_type;
 501         union ethtool_flow_union h_u;
 502         struct ethtool_flow_ext h_ext;
 503         union ethtool_flow_union m_u;
 504         struct ethtool_flow_ext m_ext;
 505         __u64           ring_cookie;
 506         __u32           location;
 507 };
 508
 509 /**
 510  * struct ethtool_rxnfc - command to get or set RX flow classification rules
 511  * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
 512  *      %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
 513  *      %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
 514  * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
 515  * @data: Command-dependent value
 516  * @fs: Flow classification rule
 517  * @rule_cnt: Number of rules to be affected
 518  * @rule_locs: Array of used rule locations
 519  *
 520  * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
 521  * the fields included in the flow hash, e.g. %RXH_IP_SRC.  The following
 522  * structure fields must not be used.
 523  *
 524  * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
 525  * on return.
 526  *
 527  * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
 528  * rules on return.  If @data is non-zero on return then it is the
 529  * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
 530  * driver supports any special location values.  If that flag is not
 531  * set in @data then special location values should not be used.
 532  *
 533  * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
 534  * existing rule on entry and @fs contains the rule on return.
 535  *
 536  * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
 537  * user buffer for @rule_locs on entry.  On return, @data is the size
 538  * of the rule table, @rule_cnt is the number of defined rules, and
 539  * @rule_locs contains the locations of the defined rules.  Drivers
 540  * must use the second parameter to get_rxnfc() instead of @rule_locs.
 541  *
 542  * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
 543  * @fs.@location either specifies the location to use or is a special
 544  * location value with %RX_CLS_LOC_SPECIAL flag set.  On return,
 545  * @fs.@location is the actual rule location.
 546  *
 547  * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
 548  * existing rule on entry.
 549  *
 550  * A driver supporting the special location values for
 551  * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
 552  * location, and may remove a rule at a later location (lower
 553  * priority) that matches exactly the same set of flows.  The special
 554  * values are: %RX_CLS_LOC_ANY, selecting any location;
 555  * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
 556  * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
 557  * location (minimum priority).  Additional special values may be
 558  * defined in future and drivers must return -%EINVAL for any
 559  * unrecognised value.
 560  */
 561 struct ethtool_rxnfc {
 562         __u32                           cmd;
 563         __u32                           flow_type;
 564         __u64                           data;
 565         struct ethtool_rx_flow_spec     fs;
 566         __u32                           rule_cnt;
 567         __u32                           rule_locs[0];
 568 };
 569
 570 #ifdef __KERNEL__
 571 #ifdef CONFIG_COMPAT
 572
 573 struct compat_ethtool_rx_flow_spec {
 574         u32             flow_type;
 575         union ethtool_flow_union h_u;
 576         struct ethtool_flow_ext h_ext;
 577         union ethtool_flow_union m_u;
 578         struct ethtool_flow_ext m_ext;
 579         compat_u64      ring_cookie;
 580         u32             location;
 581 };
 582
 583 struct compat_ethtool_rxnfc {
 584         u32                             cmd;
 585         u32                             flow_type;
 586         compat_u64                      data;
 587         struct compat_ethtool_rx_flow_spec fs;
 588         u32                             rule_cnt;
 589         u32                             rule_locs[0];
 590 };
 591
 592 #endif /* CONFIG_COMPAT */
 593 #endif /* __KERNEL__ */
 594
 595 /**
 596  * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
 597  * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
 598  * @size: On entry, the array size of the user buffer, which may be zero.
 599  *      On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
 600  *      indirection table.
 601  * @ring_index: RX ring/queue index for each hash value
 602  *
 603  * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
 604  * should be returned.  For %ETHTOOL_SRXFHINDIR, a @size of zero means
 605  * the table should be reset to default values.  This last feature
 606  * is not supported by the original implementations.
 607  */
 608 struct ethtool_rxfh_indir {
 609         __u32   cmd;
 610         __u32   size;
 611         __u32   ring_index[0];
 612 };
 613
 614 /**
 615  * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
 616  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
 617  * @h_u: Flow field values to match (dependent on @flow_type)
 618  * @m_u: Masks for flow field value bits to be ignored
 619  * @vlan_tag: VLAN tag to match
 620  * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
 621  * @data: Driver-dependent data to match
 622  * @data_mask: Mask for driver-dependent data bits to be ignored
 623  * @action: RX ring/queue index to deliver to (non-negative) or other action
 624  *      (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
 625  *
 626  * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
 627  * a field value and mask are both zero this is treated as if all mask
 628  * bits are set i.e. the field is ignored.
 629  */
 630 struct ethtool_rx_ntuple_flow_spec {
 631         __u32            flow_type;
 632         union {
 633                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
 634                 struct ethtool_tcpip4_spec              udp_ip4_spec;
 635                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
 636                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
 637                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
 638                 struct ethtool_usrip4_spec              usr_ip4_spec;
 639                 struct ethhdr                           ether_spec;
 640                 __u8                                    hdata[72];
 641         } h_u, m_u;
 642
 643         __u16           vlan_tag;
 644         __u16           vlan_tag_mask;
 645         __u64           data;
 646         __u64           data_mask;
 647
 648         __s32           action;
 649 #define ETHTOOL_RXNTUPLE_ACTION_DROP    (-1)    /* drop packet */
 650 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR   (-2)    /* clear filter */
 651 };
 652
 653 /**
 654  * struct ethtool_rx_ntuple - command to set or clear RX flow filter
 655  * @cmd: Command number - %ETHTOOL_SRXNTUPLE
 656  * @fs: Flow filter specification
 657  */
 658 struct ethtool_rx_ntuple {
 659         __u32                                   cmd;
 660         struct ethtool_rx_ntuple_flow_spec      fs;
 661 };
 662
 663 #define ETHTOOL_FLASH_MAX_FILENAME      128
 664 enum ethtool_flash_op_type {
 665         ETHTOOL_FLASH_ALL_REGIONS       = 0,
 666 };
 667
 668 /* for passing firmware flashing related parameters */
 669 struct ethtool_flash {
 670         __u32   cmd;
 671         __u32   region;
 672         char    data[ETHTOOL_FLASH_MAX_FILENAME];
 673 };
 674
 675 /**
 676  * struct ethtool_dump - used for retrieving, setting device dump
 677  * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
 678  *      %ETHTOOL_SET_DUMP
 679  * @version: FW version of the dump, filled in by driver
 680  * @flag: driver dependent flag for dump setting, filled in by driver during
 681  *        get and filled in by ethtool for set operation.
 682  *        flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
 683  *        firmware dump is disabled.
 684  * @len: length of dump data, used as the length of the user buffer on entry to
 685  *       %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
 686  *       for %ETHTOOL_GET_DUMP_FLAG command
 687  * @data: data collected for get dump data operation
 688  */
 689
 690 #define ETH_FW_DUMP_DISABLE 0
 691
 692 struct ethtool_dump {
 693         __u32   cmd;
 694         __u32   version;
 695         __u32   flag;
 696         __u32   len;
 697         __u8    data[0];
 698 };
 699
 700 /* for returning and changing feature sets */
 701
 702 /**
 703  * struct ethtool_get_features_block - block with state of 32 features
 704  * @available: mask of changeable features
 705  * @requested: mask of features requested to be enabled if possible
 706  * @active: mask of currently enabled features
 707  * @never_changed: mask of features not changeable for any device
 708  */
 709 struct ethtool_get_features_block {
 710         __u32   available;
 711         __u32   requested;
 712         __u32   active;
 713         __u32   never_changed;
 714 };
 715
 716 /**
 717  * struct ethtool_gfeatures - command to get state of device's features
 718  * @cmd: command number = %ETHTOOL_GFEATURES
 719  * @size: in: number of elements in the features[] array;
 720  *       out: number of elements in features[] needed to hold all features
 721  * @features: state of features
 722  */
 723 struct ethtool_gfeatures {
 724         __u32   cmd;
 725         __u32   size;
 726         struct ethtool_get_features_block features[0];
 727 };
 728
 729 /**
 730  * struct ethtool_set_features_block - block with request for 32 features
 731  * @valid: mask of features to be changed
 732  * @requested: values of features to be changed
 733  */
 734 struct ethtool_set_features_block {
 735         __u32   valid;
 736         __u32   requested;
 737 };
 738
 739 /**
 740  * struct ethtool_sfeatures - command to request change in device's features
 741  * @cmd: command number = %ETHTOOL_SFEATURES
 742  * @size: array size of the features[] array
 743  * @features: feature change masks
 744  */
 745 struct ethtool_sfeatures {
 746         __u32   cmd;
 747         __u32   size;
 748         struct ethtool_set_features_block features[0];
 749 };
 750
 751 /**
 752  * struct ethtool_ts_info - holds a device's timestamping and PHC association
 753  * @cmd: command number = %ETHTOOL_GET_TS_INFO
 754  * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
 755  * @phc_index: device index of the associated PHC, or -1 if there is none
 756  * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
 757  * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
 758  *
 759  * The bits in the 'tx_types' and 'rx_filters' fields correspond to
 760  * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
 761  * respectively.  For example, if the device supports HWTSTAMP_TX_ON,
 762  * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
 763  */
 764 struct ethtool_ts_info {
 765         __u32   cmd;
 766         __u32   so_timestamping;
 767         __s32   phc_index;
 768         __u32   tx_types;
 769         __u32   tx_reserved[3];
 770         __u32   rx_filters;
 771         __u32   rx_reserved[3];
 772 };
 773
 774 /*
 775  * %ETHTOOL_SFEATURES changes features present in features[].valid to the
 776  * values of corresponding bits in features[].requested. Bits in .requested
 777  * not set in .valid or not changeable are ignored.
 778  *
 779  * Returns %EINVAL when .valid contains undefined or never-changeable bits
 780  * or size is not equal to required number of features words (32-bit blocks).
 781  * Returns >= 0 if request was completed; bits set in the value mean:
 782  *   %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
 783  *      changeable (not present in %ETHTOOL_GFEATURES' features[].available)
 784  *      those bits were ignored.
 785  *   %ETHTOOL_F_WISH - some or all changes requested were recorded but the
 786  *      resulting state of bits masked by .valid is not equal to .requested.
 787  *      Probably there are other device-specific constraints on some features
 788  *      in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
 789  *      here as though ignored bits were cleared.
 790  *   %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
 791  *      compatibility functions. Requested offload state cannot be properly
 792  *      managed by kernel.
 793  *
 794  * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
 795  * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
 796  * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
 797  * significant bit in features[0] fields. Empty strings mark undefined features.
 798  */
 799 enum ethtool_sfeatures_retval_bits {
 800         ETHTOOL_F_UNSUPPORTED__BIT,
 801         ETHTOOL_F_WISH__BIT,
 802         ETHTOOL_F_COMPAT__BIT,
 803 };
 804
 805 #define ETHTOOL_F_UNSUPPORTED   (1 << ETHTOOL_F_UNSUPPORTED__BIT)
 806 #define ETHTOOL_F_WISH          (1 << ETHTOOL_F_WISH__BIT)
 807 #define ETHTOOL_F_COMPAT        (1 << ETHTOOL_F_COMPAT__BIT)
 808
 809 #ifdef __KERNEL__
 810
 811 #include <linux/rculist.h>
 812
 813 extern int __ethtool_get_settings(struct net_device *dev,
 814                                   struct ethtool_cmd *cmd);
 815
 816 /**
 817  * enum ethtool_phys_id_state - indicator state for physical identification
 818  * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
 819  * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
 820  * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
 821  *      is not supported)
 822  * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
 823  *      is not supported)
 824  */
 825 enum ethtool_phys_id_state {
 826         ETHTOOL_ID_INACTIVE,
 827         ETHTOOL_ID_ACTIVE,
 828         ETHTOOL_ID_ON,
 829         ETHTOOL_ID_OFF
 830 };
 831
 832 struct net_device;
 833
 834 /* Some generic methods drivers may use in their ethtool_ops */
 835 u32 ethtool_op_get_link(struct net_device *dev);
 836 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
 837
 838 /**
 839  * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
 840  * @index: Index in RX flow hash indirection table
 841  * @n_rx_rings: Number of RX rings to use
 842  *
 843  * This function provides the default policy for RX flow hash indirection.
 844  */
 845 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
 846 {
 847         return index % n_rx_rings;
 848 }
 849
 850 /**
 851  * struct ethtool_ops - optional netdev operations
 852  * @get_settings: Get various device settings including Ethernet link
 853  *      settings. The @cmd parameter is expected to have been cleared
 854  *      before get_settings is called. Returns a negative error code or
 855  *      zero.
 856  * @set_settings: Set various device settings including Ethernet link
 857  *      settings.  Returns a negative error code or zero.
 858  * @get_drvinfo: Report driver/device information.  Should only set the
 859  *      @driver, @version, @fw_version and @bus_info fields.  If not
 860  *      implemented, the @driver and @bus_info fields will be filled in
 861  *      according to the netdev's parent device.
 862  * @get_regs_len: Get buffer length required for @get_regs
 863  * @get_regs: Get device registers
 864  * @get_wol: Report whether Wake-on-Lan is enabled
 865  * @set_wol: Turn Wake-on-Lan on or off.  Returns a negative error code
 866  *      or zero.
 867  * @get_msglevel: Report driver message level.  This should be the value
 868  *      of the @msg_enable field used by netif logging functions.
 869  * @set_msglevel: Set driver message level
 870  * @nway_reset: Restart autonegotiation.  Returns a negative error code
 871  *      or zero.
 872  * @get_link: Report whether physical link is up.  Will only be called if
 873  *      the netdev is up.  Should usually be set to ethtool_op_get_link(),
 874  *      which uses netif_carrier_ok().
 875  * @get_eeprom: Read data from the device EEPROM.
 876  *      Should fill in the magic field.  Don't need to check len for zero
 877  *      or wraparound.  Fill in the data argument with the eeprom values
 878  *      from offset to offset + len.  Update len to the amount read.
 879  *      Returns an error or zero.
 880  * @set_eeprom: Write data to the device EEPROM.
 881  *      Should validate the magic field.  Don't need to check len for zero
 882  *      or wraparound.  Update len to the amount written.  Returns an error
 883  *      or zero.
 884  * @get_coalesce: Get interrupt coalescing parameters.  Returns a negative
 885  *      error code or zero.
 886  * @set_coalesce: Set interrupt coalescing parameters.  Returns a negative
 887  *      error code or zero.
 888  * @get_ringparam: Report ring sizes
 889  * @set_ringparam: Set ring sizes.  Returns a negative error code or zero.
 890  * @get_pauseparam: Report pause parameters
 891  * @set_pauseparam: Set pause parameters.  Returns a negative error code
 892  *      or zero.
 893  * @self_test: Run specified self-tests
 894  * @get_strings: Return a set of strings that describe the requested objects
 895  * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
 896  *      attached to it.  The implementation may update the indicator
 897  *      asynchronously or synchronously, but in either case it must return
 898  *      quickly.  It is initially called with the argument %ETHTOOL_ID_ACTIVE,
 899  *      and must either activate asynchronous updates and return zero, return
 900  *      a negative error or return a positive frequency for synchronous
 901  *      indication (e.g. 1 for one on/off cycle per second).  If it returns
 902  *      a frequency then it will be called again at intervals with the
 903  *      argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
 904  *      the indicator accordingly.  Finally, it is called with the argument
 905  *      %ETHTOOL_ID_INACTIVE and must deactivate the indicator.  Returns a
 906  *      negative error code or zero.
 907  * @get_ethtool_stats: Return extended statistics about the device.
 908  *      This is only useful if the device maintains statistics not
 909  *      included in &struct rtnl_link_stats64.
 910  * @begin: Function to be called before any other operation.  Returns a
 911  *      negative error code or zero.
 912  * @complete: Function to be called after any other operation except
 913  *      @begin.  Will be called even if the other operation failed.
 914  * @get_priv_flags: Report driver-specific feature flags.
 915  * @set_priv_flags: Set driver-specific feature flags.  Returns a negative
 916  *      error code or zero.
 917  * @get_sset_count: Get number of strings that @get_strings will write.
 918  * @get_rxnfc: Get RX flow classification rules.  Returns a negative
 919  *      error code or zero.
 920  * @set_rxnfc: Set RX flow classification rules.  Returns a negative
 921  *      error code or zero.
 922  * @flash_device: Write a firmware image to device's flash memory.
 923  *      Returns a negative error code or zero.
 924  * @reset: Reset (part of) the device, as specified by a bitmask of
 925  *      flags from &enum ethtool_reset_flags.  Returns a negative
 926  *      error code or zero.
 927  * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
 928  *      Returns zero if not supported for this specific device.
 929  * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
 930  *      Will not be called if @get_rxfh_indir_size returns zero.
 931  *      Returns a negative error code or zero.
 932  * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
 933  *      Will not be called if @get_rxfh_indir_size returns zero.
 934  *      Returns a negative error code or zero.
 935  * @get_channels: Get number of channels.
 936  * @set_channels: Set number of channels.  Returns a negative error code or
 937  *      zero.
 938  * @get_dump_flag: Get dump flag indicating current dump length, version,
 939  *                 and flag of the device.
 940  * @get_dump_data: Get dump data.
 941  * @set_dump: Set dump specific flags to the device.
 942  * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
 943  *      Drivers supporting transmit time stamps in software should set this to
 944  *      ethtool_op_get_ts_info().
 945  * @get_module_info: Get the size and type of the eeprom contained within
 946  *      a plug-in module.
 947  * @get_module_eeprom: Get the eeprom information from the plug-in module
 948  *
 949  * All operations are optional (i.e. the function pointer may be set
 950  * to %NULL) and callers must take this into account.  Callers must
 951  * hold the RTNL lock.
 952  *
 953  * See the structures used by these operations for further documentation.
 954  *
 955  * See &struct net_device and &struct net_device_ops for documentation
 956  * of the generic netdev features interface.
 957  */
 958 struct ethtool_ops {
 959         int     (*get_settings)(struct net_device *, struct ethtool_cmd *);
 960         int     (*set_settings)(struct net_device *, struct ethtool_cmd *);
 961         void    (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
 962         int     (*get_regs_len)(struct net_device *);
 963         void    (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
 964         void    (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
 965         int     (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
 966         u32     (*get_msglevel)(struct net_device *);
 967         void    (*set_msglevel)(struct net_device *, u32);
 968         int     (*nway_reset)(struct net_device *);
 969         u32     (*get_link)(struct net_device *);
 970         int     (*get_eeprom_len)(struct net_device *);
 971         int     (*get_eeprom)(struct net_device *,
 972                               struct ethtool_eeprom *, u8 *);
 973         int     (*set_eeprom)(struct net_device *,
 974                               struct ethtool_eeprom *, u8 *);
 975         int     (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
 976         int     (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
 977         void    (*get_ringparam)(struct net_device *,
 978                                  struct ethtool_ringparam *);
 979         int     (*set_ringparam)(struct net_device *,
 980                                  struct ethtool_ringparam *);
 981         void    (*get_pauseparam)(struct net_device *,
 982                                   struct ethtool_pauseparam*);
 983         int     (*set_pauseparam)(struct net_device *,
 984                                   struct ethtool_pauseparam*);
 985         void    (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
 986         void    (*get_strings)(struct net_device *, u32 stringset, u8 *);
 987         int     (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
 988         void    (*get_ethtool_stats)(struct net_device *,
 989                                      struct ethtool_stats *, u64 *);
 990         int     (*begin)(struct net_device *);
 991         void    (*complete)(struct net_device *);
 992         u32     (*get_priv_flags)(struct net_device *);
 993         int     (*set_priv_flags)(struct net_device *, u32);
 994         int     (*get_sset_count)(struct net_device *, int);
 995         int     (*get_rxnfc)(struct net_device *,
 996                              struct ethtool_rxnfc *, u32 *rule_locs);
 997         int     (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
 998         int     (*flash_device)(struct net_device *, struct ethtool_flash *);
 999         int     (*reset)(struct net_device *, u32 *);
1000         u32     (*get_rxfh_indir_size)(struct net_device *);
1001         int     (*get_rxfh_indir)(struct net_device *, u32 *);
1002         int     (*set_rxfh_indir)(struct net_device *, const u32 *);
1003         void    (*get_channels)(struct net_device *, struct ethtool_channels *);
1004         int     (*set_channels)(struct net_device *, struct ethtool_channels *);
1005         int     (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
1006         int     (*get_dump_data)(struct net_device *,
1007                                  struct ethtool_dump *, void *);
1008         int     (*set_dump)(struct net_device *, struct ethtool_dump *);
1009         int     (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
1010         int     (*get_module_info)(struct net_device *,
1011                                    struct ethtool_modinfo *);
1012         int     (*get_module_eeprom)(struct net_device *,
1013                                      struct ethtool_eeprom *, u8 *);
1014
1015
1016 };
1017 #endif /* __KERNEL__ */
1018
1019 /* CMDs currently supported */
1020 #define ETHTOOL_GSET            0x00000001 /* Get settings. */
1021 #define ETHTOOL_SSET            0x00000002 /* Set settings. */
1022 #define ETHTOOL_GDRVINFO        0x00000003 /* Get driver info. */
1023 #define ETHTOOL_GREGS           0x00000004 /* Get NIC registers. */
1024 #define ETHTOOL_GWOL            0x00000005 /* Get wake-on-lan options. */
1025 #define ETHTOOL_SWOL            0x00000006 /* Set wake-on-lan options. */
1026 #define ETHTOOL_GMSGLVL         0x00000007 /* Get driver message level */
1027 #define ETHTOOL_SMSGLVL         0x00000008 /* Set driver msg level. */
1028 #define ETHTOOL_NWAY_RST        0x00000009 /* Restart autonegotiation. */
1029 /* Get link status for host, i.e. whether the interface *and* the
1030  * physical port (if there is one) are up (ethtool_value). */
1031 #define ETHTOOL_GLINK           0x0000000a
1032 #define ETHTOOL_GEEPROM         0x0000000b /* Get EEPROM data */
1033 #define ETHTOOL_SEEPROM         0x0000000c /* Set EEPROM data. */
1034 #define ETHTOOL_GCOALESCE       0x0000000e /* Get coalesce config */
1035 #define ETHTOOL_SCOALESCE       0x0000000f /* Set coalesce config. */
1036 #define ETHTOOL_GRINGPARAM      0x00000010 /* Get ring parameters */
1037 #define ETHTOOL_SRINGPARAM      0x00000011 /* Set ring parameters. */
1038 #define ETHTOOL_GPAUSEPARAM     0x00000012 /* Get pause parameters */
1039 #define ETHTOOL_SPAUSEPARAM     0x00000013 /* Set pause parameters. */
1040 #define ETHTOOL_GRXCSUM         0x00000014 /* Get RX hw csum enable (ethtool_value) */
1041 #define ETHTOOL_SRXCSUM         0x00000015 /* Set RX hw csum enable (ethtool_value) */
1042 #define ETHTOOL_GTXCSUM         0x00000016 /* Get TX hw csum enable (ethtool_value) */
1043 #define ETHTOOL_STXCSUM         0x00000017 /* Set TX hw csum enable (ethtool_value) */
1044 #define ETHTOOL_GSG             0x00000018 /* Get scatter-gather enable
1045                                             * (ethtool_value) */
1046 #define ETHTOOL_SSG             0x00000019 /* Set scatter-gather enable
1047                                             * (ethtool_value). */
1048 #define ETHTOOL_TEST            0x0000001a /* execute NIC self-test. */
1049 #define ETHTOOL_GSTRINGS        0x0000001b /* get specified string set */
1050 #define ETHTOOL_PHYS_ID         0x0000001c /* identify the NIC */
1051 #define ETHTOOL_GSTATS          0x0000001d /* get NIC-specific statistics */
1052 #define ETHTOOL_GTSO            0x0000001e /* Get TSO enable (ethtool_value) */
1053 #define ETHTOOL_STSO            0x0000001f /* Set TSO enable (ethtool_value) */
1054 #define ETHTOOL_GPERMADDR       0x00000020 /* Get permanent hardware address */
1055 #define ETHTOOL_GUFO            0x00000021 /* Get UFO enable (ethtool_value) */
1056 #define ETHTOOL_SUFO            0x00000022 /* Set UFO enable (ethtool_value) */
1057 #define ETHTOOL_GGSO            0x00000023 /* Get GSO enable (ethtool_value) */
1058 #define ETHTOOL_SGSO            0x00000024 /* Set GSO enable (ethtool_value) */
1059 #define ETHTOOL_GFLAGS          0x00000025 /* Get flags bitmap(ethtool_value) */
1060 #define ETHTOOL_SFLAGS          0x00000026 /* Set flags bitmap(ethtool_value) */
1061 #define ETHTOOL_GPFLAGS         0x00000027 /* Get driver-private flags bitmap */
1062 #define ETHTOOL_SPFLAGS         0x00000028 /* Set driver-private flags bitmap */
1063
1064 #define ETHTOOL_GRXFH           0x00000029 /* Get RX flow hash configuration */
1065 #define ETHTOOL_SRXFH           0x0000002a /* Set RX flow hash configuration */
1066 #define ETHTOOL_GGRO            0x0000002b /* Get GRO enable (ethtool_value) */
1067 #define ETHTOOL_SGRO            0x0000002c /* Set GRO enable (ethtool_value) */
1068 #define ETHTOOL_GRXRINGS        0x0000002d /* Get RX rings available for LB */
1069 #define ETHTOOL_GRXCLSRLCNT     0x0000002e /* Get RX class rule count */
1070 #define ETHTOOL_GRXCLSRULE      0x0000002f /* Get RX classification rule */
1071 #define ETHTOOL_GRXCLSRLALL     0x00000030 /* Get all RX classification rule */
1072 #define ETHTOOL_SRXCLSRLDEL     0x00000031 /* Delete RX classification rule */
1073 #define ETHTOOL_SRXCLSRLINS     0x00000032 /* Insert RX classification rule */
1074 #define ETHTOOL_FLASHDEV        0x00000033 /* Flash firmware to device */
1075 #define ETHTOOL_RESET           0x00000034 /* Reset hardware */
1076 #define ETHTOOL_SRXNTUPLE       0x00000035 /* Add an n-tuple filter to device */
1077 #define ETHTOOL_GRXNTUPLE       0x00000036 /* deprecated */
1078 #define ETHTOOL_GSSET_INFO      0x00000037 /* Get string set info */
1079 #define ETHTOOL_GRXFHINDIR      0x00000038 /* Get RX flow hash indir'n table */
1080 #define ETHTOOL_SRXFHINDIR      0x00000039 /* Set RX flow hash indir'n table */
1081
1082 #define ETHTOOL_GFEATURES       0x0000003a /* Get device offload settings */
1083 #define ETHTOOL_SFEATURES       0x0000003b /* Change device offload settings */
1084 #define ETHTOOL_GCHANNELS       0x0000003c /* Get no of channels */
1085 #define ETHTOOL_SCHANNELS       0x0000003d /* Set no of channels */
1086 #define ETHTOOL_SET_DUMP        0x0000003e /* Set dump settings */
1087 #define ETHTOOL_GET_DUMP_FLAG   0x0000003f /* Get dump settings */
1088 #define ETHTOOL_GET_DUMP_DATA   0x00000040 /* Get dump data */
1089 #define ETHTOOL_GET_TS_INFO     0x00000041 /* Get time stamping and PHC info */
1090 #define ETHTOOL_GMODULEINFO     0x00000042 /* Get plug-in module information */
1091 #define ETHTOOL_GMODULEEEPROM   0x00000043 /* Get plug-in module eeprom */
1092
1093 /* compatibility with older code */
1094 #define SPARC_ETH_GSET          ETHTOOL_GSET
1095 #define SPARC_ETH_SSET          ETHTOOL_SSET
1096
1097 /* Indicates what features are supported by the interface. */
1098 #define SUPPORTED_10baseT_Half          (1 << 0)
1099 #define SUPPORTED_10baseT_Full          (1 << 1)
1100 #define SUPPORTED_100baseT_Half         (1 << 2)
1101 #define SUPPORTED_100baseT_Full         (1 << 3)
1102 #define SUPPORTED_1000baseT_Half        (1 << 4)
1103 #define SUPPORTED_1000baseT_Full        (1 << 5)
1104 #define SUPPORTED_Autoneg               (1 << 6)
1105 #define SUPPORTED_TP                    (1 << 7)
1106 #define SUPPORTED_AUI                   (1 << 8)
1107 #define SUPPORTED_MII                   (1 << 9)
1108 #define SUPPORTED_FIBRE                 (1 << 10)
1109 #define SUPPORTED_BNC                   (1 << 11)
1110 #define SUPPORTED_10000baseT_Full       (1 << 12)
1111 #define SUPPORTED_Pause                 (1 << 13)
1112 #define SUPPORTED_Asym_Pause            (1 << 14)
1113 #define SUPPORTED_2500baseX_Full        (1 << 15)
1114 #define SUPPORTED_Backplane             (1 << 16)
1115 #define SUPPORTED_1000baseKX_Full       (1 << 17)
1116 #define SUPPORTED_10000baseKX4_Full     (1 << 18)
1117 #define SUPPORTED_10000baseKR_Full      (1 << 19)
1118 #define SUPPORTED_10000baseR_FEC        (1 << 20)
1119 #define SUPPORTED_20000baseMLD2_Full    (1 << 21)
1120 #define SUPPORTED_20000baseKR2_Full     (1 << 22)
1121
1122 /* Indicates what features are advertised by the interface. */
1123 #define ADVERTISED_10baseT_Half         (1 << 0)
1124 #define ADVERTISED_10baseT_Full         (1 << 1)
1125 #define ADVERTISED_100baseT_Half        (1 << 2)
1126 #define ADVERTISED_100baseT_Full        (1 << 3)
1127 #define ADVERTISED_1000baseT_Half       (1 << 4)
1128 #define ADVERTISED_1000baseT_Full       (1 << 5)
1129 #define ADVERTISED_Autoneg              (1 << 6)
1130 #define ADVERTISED_TP                   (1 << 7)
1131 #define ADVERTISED_AUI                  (1 << 8)
1132 #define ADVERTISED_MII                  (1 << 9)
1133 #define ADVERTISED_FIBRE                (1 << 10)
1134 #define ADVERTISED_BNC                  (1 << 11)
1135 #define ADVERTISED_10000baseT_Full      (1 << 12)
1136 #define ADVERTISED_Pause                (1 << 13)
1137 #define ADVERTISED_Asym_Pause           (1 << 14)
1138 #define ADVERTISED_2500baseX_Full       (1 << 15)
1139 #define ADVERTISED_Backplane            (1 << 16)
1140 #define ADVERTISED_1000baseKX_Full      (1 << 17)
1141 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
1142 #define ADVERTISED_10000baseKR_Full     (1 << 19)
1143 #define ADVERTISED_10000baseR_FEC       (1 << 20)
1144 #define ADVERTISED_20000baseMLD2_Full   (1 << 21)
1145 #define ADVERTISED_20000baseKR2_Full    (1 << 22)
1146
1147 /* The following are all involved in forcing a particular link
1148  * mode for the device for setting things.  When getting the
1149  * devices settings, these indicate the current mode and whether
1150  * it was forced up into this mode or autonegotiated.
1151  */
1152
1153 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1154 #define SPEED_10                10
1155 #define SPEED_100               100
1156 #define SPEED_1000              1000
1157 #define SPEED_2500              2500
1158 #define SPEED_10000             10000
1159 #define SPEED_UNKNOWN           -1
1160
1161 /* Duplex, half or full. */
1162 #define DUPLEX_HALF             0x00
1163 #define DUPLEX_FULL             0x01
1164 #define DUPLEX_UNKNOWN          0xff
1165
1166 /* Which connector port. */
1167 #define PORT_TP                 0x00
1168 #define PORT_AUI                0x01
1169 #define PORT_MII                0x02
1170 #define PORT_FIBRE              0x03
1171 #define PORT_BNC                0x04
1172 #define PORT_DA                 0x05
1173 #define PORT_NONE               0xef
1174 #define PORT_OTHER              0xff
1175
1176 /* Which transceiver to use. */
1177 #define XCVR_INTERNAL           0x00
1178 #define XCVR_EXTERNAL           0x01
1179 #define XCVR_DUMMY1             0x02
1180 #define XCVR_DUMMY2             0x03
1181 #define XCVR_DUMMY3             0x04
1182
1183 /* Enable or disable autonegotiation.  If this is set to enable,
1184  * the forced link modes above are completely ignored.
1185  */
1186 #define AUTONEG_DISABLE         0x00
1187 #define AUTONEG_ENABLE          0x01
1188
1189 /* Mode MDI or MDI-X */
1190 #define ETH_TP_MDI_INVALID      0x00
1191 #define ETH_TP_MDI              0x01
1192 #define ETH_TP_MDI_X            0x02
1193
1194 /* Wake-On-Lan options. */
1195 #define WAKE_PHY                (1 << 0)
1196 #define WAKE_UCAST              (1 << 1)
1197 #define WAKE_MCAST              (1 << 2)
1198 #define WAKE_BCAST              (1 << 3)
1199 #define WAKE_ARP                (1 << 4)
1200 #define WAKE_MAGIC              (1 << 5)
1201 #define WAKE_MAGICSECURE        (1 << 6) /* only meaningful if WAKE_MAGIC */
1202
1203 /* L2-L4 network traffic flow types */
1204 #define TCP_V4_FLOW     0x01    /* hash or spec (tcp_ip4_spec) */
1205 #define UDP_V4_FLOW     0x02    /* hash or spec (udp_ip4_spec) */
1206 #define SCTP_V4_FLOW    0x03    /* hash or spec (sctp_ip4_spec) */
1207 #define AH_ESP_V4_FLOW  0x04    /* hash only */
1208 #define TCP_V6_FLOW     0x05    /* hash only */
1209 #define UDP_V6_FLOW     0x06    /* hash only */
1210 #define SCTP_V6_FLOW    0x07    /* hash only */
1211 #define AH_ESP_V6_FLOW  0x08    /* hash only */
1212 #define AH_V4_FLOW      0x09    /* hash or spec (ah_ip4_spec) */
1213 #define ESP_V4_FLOW     0x0a    /* hash or spec (esp_ip4_spec) */
1214 #define AH_V6_FLOW      0x0b    /* hash only */
1215 #define ESP_V6_FLOW     0x0c    /* hash only */
1216 #define IP_USER_FLOW    0x0d    /* spec only (usr_ip4_spec) */
1217 #define IPV4_FLOW       0x10    /* hash only */
1218 #define IPV6_FLOW       0x11    /* hash only */
1219 #define ETHER_FLOW      0x12    /* spec only (ether_spec) */
1220 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1221 #define FLOW_EXT        0x80000000
1222
1223 /* L3-L4 network traffic flow hash options */
1224 #define RXH_L2DA        (1 << 1)
1225 #define RXH_VLAN        (1 << 2)
1226 #define RXH_L3_PROTO    (1 << 3)
1227 #define RXH_IP_SRC      (1 << 4)
1228 #define RXH_IP_DST      (1 << 5)
1229 #define RXH_L4_B_0_1    (1 << 6) /* src port in case of TCP/UDP/SCTP */
1230 #define RXH_L4_B_2_3    (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1231 #define RXH_DISCARD     (1 << 31)
1232
1233 #define RX_CLS_FLOW_DISC        0xffffffffffffffffULL
1234
1235 /* Special RX classification rule insert location values */
1236 #define RX_CLS_LOC_SPECIAL      0x80000000      /* flag */
1237 #define RX_CLS_LOC_ANY          0xffffffff
1238 #define RX_CLS_LOC_FIRST        0xfffffffe
1239 #define RX_CLS_LOC_LAST         0xfffffffd
1240
1241 /* EEPROM Standards for plug in modules */
1242 #define ETH_MODULE_SFF_8079             0x1
1243 #define ETH_MODULE_SFF_8079_LEN         256
1244 #define ETH_MODULE_SFF_8472             0x2
1245 #define ETH_MODULE_SFF_8472_LEN         512
1246
1247 /* Reset flags */
1248 /* The reset() operation must clear the flags for the components which
1249  * were actually reset.  On successful return, the flags indicate the
1250  * components which were not reset, either because they do not exist
1251  * in the hardware or because they cannot be reset independently.  The
1252  * driver must never reset any components that were not requested.
1253  */
1254 enum ethtool_reset_flags {
1255         /* These flags represent components dedicated to the interface
1256          * the command is addressed to.  Shift any flag left by
1257          * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1258          * same type.
1259          */
1260         ETH_RESET_MGMT          = 1 << 0,       /* Management processor */
1261         ETH_RESET_IRQ           = 1 << 1,       /* Interrupt requester */
1262         ETH_RESET_DMA           = 1 << 2,       /* DMA engine */
1263         ETH_RESET_FILTER        = 1 << 3,       /* Filtering/flow direction */
1264         ETH_RESET_OFFLOAD       = 1 << 4,       /* Protocol offload */
1265         ETH_RESET_MAC           = 1 << 5,       /* Media access controller */
1266         ETH_RESET_PHY           = 1 << 6,       /* Transceiver/PHY */
1267         ETH_RESET_RAM           = 1 << 7,       /* RAM shared between
1268                                                  * multiple components */
1269
1270         ETH_RESET_DEDICATED     = 0x0000ffff,   /* All components dedicated to
1271                                                  * this interface */
1272         ETH_RESET_ALL           = 0xffffffff,   /* All components used by this
1273                                                  * interface, even if shared */
1274 };
1275 #define ETH_RESET_SHARED_SHIFT  16
1276
1277 #endif /* _LINUX_ETHTOOL_H */