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