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