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