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 #include <linux/types.h>
  17
  18 /* This should work for both 32 and 64 bit userland. */
  19 struct ethtool_cmd {
  20         __u32   cmd;
  21         __u32   supported;      /* Features this interface supports */
  22         __u32   advertising;    /* Features this interface advertises */
  23         __u16   speed;          /* The forced speed, 10Mb, 100Mb, gigabit */
  24         __u8    duplex;         /* Duplex, half or full */
  25         __u8    port;           /* Which connector port */
  26         __u8    phy_address;
  27         __u8    transceiver;    /* Which transceiver to use */
  28         __u8    autoneg;        /* Enable or disable autonegotiation */
  29         __u8    mdio_support;
  30         __u32   maxtxpkt;       /* Tx pkts before generating tx int */
  31         __u32   maxrxpkt;       /* Rx pkts before generating rx int */
  32         __u16   speed_hi;
  33         __u8    eth_tp_mdix;
  34         __u8    reserved2;
  35         __u32   lp_advertising; /* Features the link partner advertises */
  36         __u32   reserved[2];
  37 };
  38
  39 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
  40                                                 __u32 speed)
  41 {
  42
  43         ep->speed = (__u16)speed;
  44         ep->speed_hi = (__u16)(speed >> 16);
  45 }
  46
  47 static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep)
  48 {
  49         return (ep->speed_hi << 16) | ep->speed;
  50 }
  51
  52 #define ETHTOOL_FWVERS_LEN      32
  53 #define ETHTOOL_BUSINFO_LEN     32
  54 /* these strings are set to whatever the driver author decides... */
  55 struct ethtool_drvinfo {
  56         __u32   cmd;
  57         char    driver[32];     /* driver short name, "tulip", "eepro100" */
  58         char    version[32];    /* driver version string */
  59         char    fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
  60         char    bus_info[ETHTOOL_BUSINFO_LEN];  /* Bus info for this IF. */
  61                                 /* For PCI devices, use pci_name(pci_dev). */
  62         char    reserved1[32];
  63         char    reserved2[12];
  64         __u32   n_priv_flags;   /* number of flags valid in ETHTOOL_GPFLAGS */
  65         __u32   n_stats;        /* number of u64's from ETHTOOL_GSTATS */
  66         __u32   testinfo_len;
  67         __u32   eedump_len;     /* Size of data from ETHTOOL_GEEPROM (bytes) */
  68         __u32   regdump_len;    /* Size of data from ETHTOOL_GREGS (bytes) */
  69 };
  70
  71 #define SOPASS_MAX      6
  72 /* wake-on-lan settings */
  73 struct ethtool_wolinfo {
  74         __u32   cmd;
  75         __u32   supported;
  76         __u32   wolopts;
  77         __u8    sopass[SOPASS_MAX]; /* SecureOn(tm) password */
  78 };
  79
  80 /* for passing single values */
  81 struct ethtool_value {
  82         __u32   cmd;
  83         __u32   data;
  84 };
  85
  86 /* for passing big chunks of data */
  87 struct ethtool_regs {
  88         __u32   cmd;
  89         __u32   version; /* driver-specific, indicates different chips/revs */
  90         __u32   len; /* bytes */
  91         __u8    data[0];
  92 };
  93
  94 /* for passing EEPROM chunks */
  95 struct ethtool_eeprom {
  96         __u32   cmd;
  97         __u32   magic;
  98         __u32   offset; /* in bytes */
  99         __u32   len; /* in bytes */
 100         __u8    data[0];
 101 };
 102
 103 /* for configuring coalescing parameters of chip */
 104 struct ethtool_coalesce {
 105         __u32   cmd;    /* ETHTOOL_{G,S}COALESCE */
 106
 107         /* How many usecs to delay an RX interrupt after
 108          * a packet arrives.  If 0, only rx_max_coalesced_frames
 109          * is used.
 110          */
 111         __u32   rx_coalesce_usecs;
 112
 113         /* How many packets to delay an RX interrupt after
 114          * a packet arrives.  If 0, only rx_coalesce_usecs is
 115          * used.  It is illegal to set both usecs and max frames
 116          * to zero as this would cause RX interrupts to never be
 117          * generated.
 118          */
 119         __u32   rx_max_coalesced_frames;
 120
 121         /* Same as above two parameters, except that these values
 122          * apply while an IRQ is being serviced by the host.  Not
 123          * all cards support this feature and the values are ignored
 124          * in that case.
 125          */
 126         __u32   rx_coalesce_usecs_irq;
 127         __u32   rx_max_coalesced_frames_irq;
 128
 129         /* How many usecs to delay a TX interrupt after
 130          * a packet is sent.  If 0, only tx_max_coalesced_frames
 131          * is used.
 132          */
 133         __u32   tx_coalesce_usecs;
 134
 135         /* How many packets to delay a TX interrupt after
 136          * a packet is sent.  If 0, only tx_coalesce_usecs is
 137          * used.  It is illegal to set both usecs and max frames
 138          * to zero as this would cause TX interrupts to never be
 139          * generated.
 140          */
 141         __u32   tx_max_coalesced_frames;
 142
 143         /* Same as above two parameters, except that these values
 144          * apply while an IRQ is being serviced by the host.  Not
 145          * all cards support this feature and the values are ignored
 146          * in that case.
 147          */
 148         __u32   tx_coalesce_usecs_irq;
 149         __u32   tx_max_coalesced_frames_irq;
 150
 151         /* How many usecs to delay in-memory statistics
 152          * block updates.  Some drivers do not have an in-memory
 153          * statistic block, and in such cases this value is ignored.
 154          * This value must not be zero.
 155          */
 156         __u32   stats_block_coalesce_usecs;
 157
 158         /* Adaptive RX/TX coalescing is an algorithm implemented by
 159          * some drivers to improve latency under low packet rates and
 160          * improve throughput under high packet rates.  Some drivers
 161          * only implement one of RX or TX adaptive coalescing.  Anything
 162          * not implemented by the driver causes these values to be
 163          * silently ignored.
 164          */
 165         __u32   use_adaptive_rx_coalesce;
 166         __u32   use_adaptive_tx_coalesce;
 167
 168         /* When the packet rate (measured in packets per second)
 169          * is below pkt_rate_low, the {rx,tx}_*_low parameters are
 170          * used.
 171          */
 172         __u32   pkt_rate_low;
 173         __u32   rx_coalesce_usecs_low;
 174         __u32   rx_max_coalesced_frames_low;
 175         __u32   tx_coalesce_usecs_low;
 176         __u32   tx_max_coalesced_frames_low;
 177
 178         /* When the packet rate is below pkt_rate_high but above
 179          * pkt_rate_low (both measured in packets per second) the
 180          * normal {rx,tx}_* coalescing parameters are used.
 181          */
 182
 183         /* When the packet rate is (measured in packets per second)
 184          * is above pkt_rate_high, the {rx,tx}_*_high parameters are
 185          * used.
 186          */
 187         __u32   pkt_rate_high;
 188         __u32   rx_coalesce_usecs_high;
 189         __u32   rx_max_coalesced_frames_high;
 190         __u32   tx_coalesce_usecs_high;
 191         __u32   tx_max_coalesced_frames_high;
 192
 193         /* How often to do adaptive coalescing packet rate sampling,
 194          * measured in seconds.  Must not be zero.
 195          */
 196         __u32   rate_sample_interval;
 197 };
 198
 199 /* for configuring RX/TX ring parameters */
 200 struct ethtool_ringparam {
 201         __u32   cmd;    /* ETHTOOL_{G,S}RINGPARAM */
 202
 203         /* Read only attributes.  These indicate the maximum number
 204          * of pending RX/TX ring entries the driver will allow the
 205          * user to set.
 206          */
 207         __u32   rx_max_pending;
 208         __u32   rx_mini_max_pending;
 209         __u32   rx_jumbo_max_pending;
 210         __u32   tx_max_pending;
 211
 212         /* Values changeable by the user.  The valid values are
 213          * in the range 1 to the "*_max_pending" counterpart above.
 214          */
 215         __u32   rx_pending;
 216         __u32   rx_mini_pending;
 217         __u32   rx_jumbo_pending;
 218         __u32   tx_pending;
 219 };
 220
 221 /* for configuring link flow control parameters */
 222 struct ethtool_pauseparam {
 223         __u32   cmd;    /* ETHTOOL_{G,S}PAUSEPARAM */
 224
 225         /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
 226          * being true) the user may set 'autonet' here non-zero to have the
 227          * pause parameters be auto-negotiated too.  In such a case, the
 228          * {rx,tx}_pause values below determine what capabilities are
 229          * advertised.
 230          *
 231          * If 'autoneg' is zero or the link is not being auto-negotiated,
 232          * then {rx,tx}_pause force the driver to use/not-use pause
 233          * flow control.
 234          */
 235         __u32   autoneg;
 236         __u32   rx_pause;
 237         __u32   tx_pause;
 238 };
 239
 240 #define ETH_GSTRING_LEN         32
 241 enum ethtool_stringset {
 242         ETH_SS_TEST             = 0,
 243         ETH_SS_STATS,
 244         ETH_SS_PRIV_FLAGS,
 245         ETH_SS_NTUPLE_FILTERS,
 246 };
 247
 248 /* for passing string sets for data tagging */
 249 struct ethtool_gstrings {
 250         __u32   cmd;            /* ETHTOOL_GSTRINGS */
 251         __u32   string_set;     /* string set id e.c. ETH_SS_TEST, etc*/
 252         __u32   len;            /* number of strings in the string set */
 253         __u8    data[0];
 254 };
 255
 256 struct ethtool_sset_info {
 257         __u32   cmd;            /* ETHTOOL_GSSET_INFO */
 258         __u32   reserved;
 259         __u64   sset_mask;      /* input: each bit selects an sset to query */
 260                                 /* output: each bit a returned sset */
 261         __u32   data[0];        /* ETH_SS_xxx count, in order, based on bits
 262                                    in sset_mask.  One bit implies one
 263                                    __u32, two bits implies two
 264                                    __u32's, etc. */
 265 };
 266
 267 enum ethtool_test_flags {
 268         ETH_TEST_FL_OFFLINE     = (1 << 0),     /* online / offline */
 269         ETH_TEST_FL_FAILED      = (1 << 1),     /* test passed / failed */
 270 };
 271
 272 /* for requesting NIC test and getting results*/
 273 struct ethtool_test {
 274         __u32   cmd;            /* ETHTOOL_TEST */
 275         __u32   flags;          /* ETH_TEST_FL_xxx */
 276         __u32   reserved;
 277         __u32   len;            /* result length, in number of u64 elements */
 278         __u64   data[0];
 279 };
 280
 281 /* for dumping NIC-specific statistics */
 282 struct ethtool_stats {
 283         __u32   cmd;            /* ETHTOOL_GSTATS */
 284         __u32   n_stats;        /* number of u64's being returned */
 285         __u64   data[0];
 286 };
 287
 288 struct ethtool_perm_addr {
 289         __u32   cmd;            /* ETHTOOL_GPERMADDR */
 290         __u32   size;
 291         __u8    data[0];
 292 };
 293
 294 /* boolean flags controlling per-interface behavior characteristics.
 295  * When reading, the flag indicates whether or not a certain behavior
 296  * is enabled/present.  When writing, the flag indicates whether
 297  * or not the driver should turn on (set) or off (clear) a behavior.
 298  *
 299  * Some behaviors may read-only (unconditionally absent or present).
 300  * If such is the case, return EINVAL in the set-flags operation if the
 301  * flag differs from the read-only value.
 302  */
 303 enum ethtool_flags {
 304         ETH_FLAG_LRO            = (1 << 15),    /* LRO is enabled */
 305         ETH_FLAG_NTUPLE         = (1 << 27),    /* N-tuple filters enabled */
 306 };
 307
 308 /* The following structures are for supporting RX network flow
 309  * classification configuration. Note, all multibyte fields, e.g.,
 310  * ip4src, ip4dst, psrc, pdst, spi, etc. are expected to be in network
 311  * byte order.
 312  */
 313 struct ethtool_tcpip4_spec {
 314         __be32  ip4src;
 315         __be32  ip4dst;
 316         __be16  psrc;
 317         __be16  pdst;
 318         __u8    tos;
 319 };
 320
 321 struct ethtool_ah_espip4_spec {
 322         __be32  ip4src;
 323         __be32  ip4dst;
 324         __be32  spi;
 325         __u8    tos;
 326 };
 327
 328 struct ethtool_rawip4_spec {
 329         __be32  ip4src;
 330         __be32  ip4dst;
 331         __u8    hdata[64];
 332 };
 333
 334 struct ethtool_ether_spec {
 335         __be16  ether_type;
 336         __u8    frame_size;
 337         __u8    eframe[16];
 338 };
 339
 340 #define ETH_RX_NFC_IP4  1
 341 #define ETH_RX_NFC_IP6  2
 342
 343 struct ethtool_usrip4_spec {
 344         __be32  ip4src;
 345         __be32  ip4dst;
 346         __be32  l4_4_bytes;
 347         __u8    tos;
 348         __u8    ip_ver;
 349         __u8    proto;
 350 };
 351
 352 struct ethtool_rx_flow_spec {
 353         __u32           flow_type;
 354         union {
 355                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
 356                 struct ethtool_tcpip4_spec              udp_ip4_spec;
 357                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
 358                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
 359                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
 360                 struct ethtool_rawip4_spec              raw_ip4_spec;
 361                 struct ethtool_ether_spec               ether_spec;
 362                 struct ethtool_usrip4_spec              usr_ip4_spec;
 363                 __u8                                    hdata[64];
 364         } h_u, m_u; /* entry, mask */
 365         __u64           ring_cookie;
 366         __u32           location;
 367 };
 368
 369 struct ethtool_rxnfc {
 370         __u32                           cmd;
 371         __u32                           flow_type;
 372         /* The rx flow hash value or the rule DB size */
 373         __u64                           data;
 374         struct ethtool_rx_flow_spec     fs;
 375         __u32                           rule_cnt;
 376         __u32                           rule_locs[0];
 377 };
 378
 379 struct ethtool_rx_ntuple_flow_spec {
 380         __u32            flow_type;
 381         union {
 382                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
 383                 struct ethtool_tcpip4_spec              udp_ip4_spec;
 384                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
 385                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
 386                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
 387                 struct ethtool_rawip4_spec              raw_ip4_spec;
 388                 struct ethtool_ether_spec               ether_spec;
 389                 struct ethtool_usrip4_spec              usr_ip4_spec;
 390                 __u8                                    hdata[64];
 391         } h_u, m_u; /* entry, mask */
 392
 393         __u16           vlan_tag;
 394         __u16           vlan_tag_mask;
 395         __u64           data;      /* user-defined flow spec data */
 396         __u64           data_mask; /* user-defined flow spec mask */
 397
 398         /* signed to distinguish between queue and actions (DROP) */
 399         __s32           action;
 400 #define ETHTOOL_RXNTUPLE_ACTION_DROP -1
 401 };
 402
 403 struct ethtool_rx_ntuple {
 404         __u32                                   cmd;
 405         struct ethtool_rx_ntuple_flow_spec      fs;
 406 };
 407
 408 #define ETHTOOL_FLASH_MAX_FILENAME      128
 409 enum ethtool_flash_op_type {
 410         ETHTOOL_FLASH_ALL_REGIONS       = 0,
 411 };
 412
 413 /* for passing firmware flashing related parameters */
 414 struct ethtool_flash {
 415         __u32   cmd;
 416         __u32   region;
 417         char    data[ETHTOOL_FLASH_MAX_FILENAME];
 418 };
 419
 420 #ifdef __KERNEL__
 421
 422 #include <linux/rculist.h>
 423
 424 struct ethtool_rx_ntuple_flow_spec_container {
 425         struct ethtool_rx_ntuple_flow_spec fs;
 426         struct list_head list;
 427 };
 428
 429 struct ethtool_rx_ntuple_list {
 430 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
 431 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
 432         struct list_head        list;
 433         unsigned int            count;
 434 };
 435
 436 struct net_device;
 437
 438 /* Some generic methods drivers may use in their ethtool_ops */
 439 u32 ethtool_op_get_link(struct net_device *dev);
 440 u32 ethtool_op_get_rx_csum(struct net_device *dev);
 441 u32 ethtool_op_get_tx_csum(struct net_device *dev);
 442 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
 443 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
 444 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
 445 u32 ethtool_op_get_sg(struct net_device *dev);
 446 int ethtool_op_set_sg(struct net_device *dev, u32 data);
 447 u32 ethtool_op_get_tso(struct net_device *dev);
 448 int ethtool_op_set_tso(struct net_device *dev, u32 data);
 449 u32 ethtool_op_get_ufo(struct net_device *dev);
 450 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
 451 u32 ethtool_op_get_flags(struct net_device *dev);
 452 int ethtool_op_set_flags(struct net_device *dev, u32 data);
 453 void ethtool_ntuple_flush(struct net_device *dev);
 454
 455 /**
 456  * &ethtool_ops - Alter and report network device settings
 457  * get_settings: Get device-specific settings
 458  * set_settings: Set device-specific settings
 459  * get_drvinfo: Report driver information
 460  * get_regs: Get device registers
 461  * get_wol: Report whether Wake-on-Lan is enabled
 462  * set_wol: Turn Wake-on-Lan on or off
 463  * get_msglevel: Report driver message level
 464  * set_msglevel: Set driver message level
 465  * nway_reset: Restart autonegotiation
 466  * get_link: Get link status
 467  * get_eeprom: Read data from the device EEPROM
 468  * set_eeprom: Write data to the device EEPROM
 469  * get_coalesce: Get interrupt coalescing parameters
 470  * set_coalesce: Set interrupt coalescing parameters
 471  * get_ringparam: Report ring sizes
 472  * set_ringparam: Set ring sizes
 473  * get_pauseparam: Report pause parameters
 474  * set_pauseparam: Set pause parameters
 475  * get_rx_csum: Report whether receive checksums are turned on or off
 476  * set_rx_csum: Turn receive checksum on or off
 477  * get_tx_csum: Report whether transmit checksums are turned on or off
 478  * set_tx_csum: Turn transmit checksums on or off
 479  * get_sg: Report whether scatter-gather is enabled
 480  * set_sg: Turn scatter-gather on or off
 481  * get_tso: Report whether TCP segmentation offload is enabled
 482  * set_tso: Turn TCP segmentation offload on or off
 483  * get_ufo: Report whether UDP fragmentation offload is enabled
 484  * set_ufo: Turn UDP fragmentation offload on or off
 485  * self_test: Run specified self-tests
 486  * get_strings: Return a set of strings that describe the requested objects
 487  * phys_id: Identify the device
 488  * get_stats: Return statistics about the device
 489  * get_flags: get 32-bit flags bitmap
 490  * set_flags: set 32-bit flags bitmap
 491  *
 492  * Description:
 493  *
 494  * get_settings:
 495  *      @get_settings is passed an &ethtool_cmd to fill in.  It returns
 496  *      an negative errno or zero.
 497  *
 498  * set_settings:
 499  *      @set_settings is passed an &ethtool_cmd and should attempt to set
 500  *      all the settings this device supports.  It may return an error value
 501  *      if something goes wrong (otherwise 0).
 502  *
 503  * get_eeprom:
 504  *      Should fill in the magic field.  Don't need to check len for zero
 505  *      or wraparound.  Fill in the data argument with the eeprom values
 506  *      from offset to offset + len.  Update len to the amount read.
 507  *      Returns an error or zero.
 508  *
 509  * set_eeprom:
 510  *      Should validate the magic field.  Don't need to check len for zero
 511  *      or wraparound.  Update len to the amount written.  Returns an error
 512  *      or zero.
 513  */
 514 struct ethtool_ops {
 515         int     (*get_settings)(struct net_device *, struct ethtool_cmd *);
 516         int     (*set_settings)(struct net_device *, struct ethtool_cmd *);
 517         void    (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
 518         int     (*get_regs_len)(struct net_device *);
 519         void    (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
 520         void    (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
 521         int     (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
 522         u32     (*get_msglevel)(struct net_device *);
 523         void    (*set_msglevel)(struct net_device *, u32);
 524         int     (*nway_reset)(struct net_device *);
 525         u32     (*get_link)(struct net_device *);
 526         int     (*get_eeprom_len)(struct net_device *);
 527         int     (*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
 528         int     (*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
 529         int     (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
 530         int     (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
 531         void    (*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
 532         int     (*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
 533         void    (*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
 534         int     (*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
 535         u32     (*get_rx_csum)(struct net_device *);
 536         int     (*set_rx_csum)(struct net_device *, u32);
 537         u32     (*get_tx_csum)(struct net_device *);
 538         int     (*set_tx_csum)(struct net_device *, u32);
 539         u32     (*get_sg)(struct net_device *);
 540         int     (*set_sg)(struct net_device *, u32);
 541         u32     (*get_tso)(struct net_device *);
 542         int     (*set_tso)(struct net_device *, u32);
 543         void    (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
 544         void    (*get_strings)(struct net_device *, u32 stringset, u8 *);
 545         int     (*phys_id)(struct net_device *, u32);
 546         void    (*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
 547         int     (*begin)(struct net_device *);
 548         void    (*complete)(struct net_device *);
 549         u32     (*get_ufo)(struct net_device *);
 550         int     (*set_ufo)(struct net_device *, u32);
 551         u32     (*get_flags)(struct net_device *);
 552         int     (*set_flags)(struct net_device *, u32);
 553         u32     (*get_priv_flags)(struct net_device *);
 554         int     (*set_priv_flags)(struct net_device *, u32);
 555         int     (*get_sset_count)(struct net_device *, int);
 556         int     (*get_rxnfc)(struct net_device *, struct ethtool_rxnfc *, void *);
 557         int     (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
 558         int     (*flash_device)(struct net_device *, struct ethtool_flash *);
 559         int     (*reset)(struct net_device *, u32 *);
 560         int     (*set_rx_ntuple)(struct net_device *, struct ethtool_rx_ntuple *);
 561         int     (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
 562 };
 563 #endif /* __KERNEL__ */
 564
 565 /* CMDs currently supported */
 566 #define ETHTOOL_GSET            0x00000001 /* Get settings. */
 567 #define ETHTOOL_SSET            0x00000002 /* Set settings. */
 568 #define ETHTOOL_GDRVINFO        0x00000003 /* Get driver info. */
 569 #define ETHTOOL_GREGS           0x00000004 /* Get NIC registers. */
 570 #define ETHTOOL_GWOL            0x00000005 /* Get wake-on-lan options. */
 571 #define ETHTOOL_SWOL            0x00000006 /* Set wake-on-lan options. */
 572 #define ETHTOOL_GMSGLVL         0x00000007 /* Get driver message level */
 573 #define ETHTOOL_SMSGLVL         0x00000008 /* Set driver msg level. */
 574 #define ETHTOOL_NWAY_RST        0x00000009 /* Restart autonegotiation. */
 575 #define ETHTOOL_GLINK           0x0000000a /* Get link status (ethtool_value) */
 576 #define ETHTOOL_GEEPROM         0x0000000b /* Get EEPROM data */
 577 #define ETHTOOL_SEEPROM         0x0000000c /* Set EEPROM data. */
 578 #define ETHTOOL_GCOALESCE       0x0000000e /* Get coalesce config */
 579 #define ETHTOOL_SCOALESCE       0x0000000f /* Set coalesce config. */
 580 #define ETHTOOL_GRINGPARAM      0x00000010 /* Get ring parameters */
 581 #define ETHTOOL_SRINGPARAM      0x00000011 /* Set ring parameters. */
 582 #define ETHTOOL_GPAUSEPARAM     0x00000012 /* Get pause parameters */
 583 #define ETHTOOL_SPAUSEPARAM     0x00000013 /* Set pause parameters. */
 584 #define ETHTOOL_GRXCSUM         0x00000014 /* Get RX hw csum enable (ethtool_value) */
 585 #define ETHTOOL_SRXCSUM         0x00000015 /* Set RX hw csum enable (ethtool_value) */
 586 #define ETHTOOL_GTXCSUM         0x00000016 /* Get TX hw csum enable (ethtool_value) */
 587 #define ETHTOOL_STXCSUM         0x00000017 /* Set TX hw csum enable (ethtool_value) */
 588 #define ETHTOOL_GSG             0x00000018 /* Get scatter-gather enable
 589                                             * (ethtool_value) */
 590 #define ETHTOOL_SSG             0x00000019 /* Set scatter-gather enable
 591                                             * (ethtool_value). */
 592 #define ETHTOOL_TEST            0x0000001a /* execute NIC self-test. */
 593 #define ETHTOOL_GSTRINGS        0x0000001b /* get specified string set */
 594 #define ETHTOOL_PHYS_ID         0x0000001c /* identify the NIC */
 595 #define ETHTOOL_GSTATS          0x0000001d /* get NIC-specific statistics */
 596 #define ETHTOOL_GTSO            0x0000001e /* Get TSO enable (ethtool_value) */
 597 #define ETHTOOL_STSO            0x0000001f /* Set TSO enable (ethtool_value) */
 598 #define ETHTOOL_GPERMADDR       0x00000020 /* Get permanent hardware address */
 599 #define ETHTOOL_GUFO            0x00000021 /* Get UFO enable (ethtool_value) */
 600 #define ETHTOOL_SUFO            0x00000022 /* Set UFO enable (ethtool_value) */
 601 #define ETHTOOL_GGSO            0x00000023 /* Get GSO enable (ethtool_value) */
 602 #define ETHTOOL_SGSO            0x00000024 /* Set GSO enable (ethtool_value) */
 603 #define ETHTOOL_GFLAGS          0x00000025 /* Get flags bitmap(ethtool_value) */
 604 #define ETHTOOL_SFLAGS          0x00000026 /* Set flags bitmap(ethtool_value) */
 605 #define ETHTOOL_GPFLAGS         0x00000027 /* Get driver-private flags bitmap */
 606 #define ETHTOOL_SPFLAGS         0x00000028 /* Set driver-private flags bitmap */
 607
 608 #define ETHTOOL_GRXFH           0x00000029 /* Get RX flow hash configuration */
 609 #define ETHTOOL_SRXFH           0x0000002a /* Set RX flow hash configuration */
 610 #define ETHTOOL_GGRO            0x0000002b /* Get GRO enable (ethtool_value) */
 611 #define ETHTOOL_SGRO            0x0000002c /* Set GRO enable (ethtool_value) */
 612 #define ETHTOOL_GRXRINGS        0x0000002d /* Get RX rings available for LB */
 613 #define ETHTOOL_GRXCLSRLCNT     0x0000002e /* Get RX class rule count */
 614 #define ETHTOOL_GRXCLSRULE      0x0000002f /* Get RX classification rule */
 615 #define ETHTOOL_GRXCLSRLALL     0x00000030 /* Get all RX classification rule */
 616 #define ETHTOOL_SRXCLSRLDEL     0x00000031 /* Delete RX classification rule */
 617 #define ETHTOOL_SRXCLSRLINS     0x00000032 /* Insert RX classification rule */
 618 #define ETHTOOL_FLASHDEV        0x00000033 /* Flash firmware to device */
 619 #define ETHTOOL_RESET           0x00000034 /* Reset hardware */
 620 #define ETHTOOL_SRXNTUPLE       0x00000035 /* Add an n-tuple filter to device */
 621 #define ETHTOOL_GRXNTUPLE       0x00000036 /* Get n-tuple filters from device */
 622 #define ETHTOOL_GSSET_INFO      0x00000037 /* Get string set info */
 623
 624 /* compatibility with older code */
 625 #define SPARC_ETH_GSET          ETHTOOL_GSET
 626 #define SPARC_ETH_SSET          ETHTOOL_SSET
 627
 628 /* Indicates what features are supported by the interface. */
 629 #define SUPPORTED_10baseT_Half          (1 << 0)
 630 #define SUPPORTED_10baseT_Full          (1 << 1)
 631 #define SUPPORTED_100baseT_Half         (1 << 2)
 632 #define SUPPORTED_100baseT_Full         (1 << 3)
 633 #define SUPPORTED_1000baseT_Half        (1 << 4)
 634 #define SUPPORTED_1000baseT_Full        (1 << 5)
 635 #define SUPPORTED_Autoneg               (1 << 6)
 636 #define SUPPORTED_TP                    (1 << 7)
 637 #define SUPPORTED_AUI                   (1 << 8)
 638 #define SUPPORTED_MII                   (1 << 9)
 639 #define SUPPORTED_FIBRE                 (1 << 10)
 640 #define SUPPORTED_BNC                   (1 << 11)
 641 #define SUPPORTED_10000baseT_Full       (1 << 12)
 642 #define SUPPORTED_Pause                 (1 << 13)
 643 #define SUPPORTED_Asym_Pause            (1 << 14)
 644 #define SUPPORTED_2500baseX_Full        (1 << 15)
 645 #define SUPPORTED_Backplane             (1 << 16)
 646 #define SUPPORTED_1000baseKX_Full       (1 << 17)
 647 #define SUPPORTED_10000baseKX4_Full     (1 << 18)
 648 #define SUPPORTED_10000baseKR_Full      (1 << 19)
 649 #define SUPPORTED_10000baseR_FEC        (1 << 20)
 650
 651 /* Indicates what features are advertised by the interface. */
 652 #define ADVERTISED_10baseT_Half         (1 << 0)
 653 #define ADVERTISED_10baseT_Full         (1 << 1)
 654 #define ADVERTISED_100baseT_Half        (1 << 2)
 655 #define ADVERTISED_100baseT_Full        (1 << 3)
 656 #define ADVERTISED_1000baseT_Half       (1 << 4)
 657 #define ADVERTISED_1000baseT_Full       (1 << 5)
 658 #define ADVERTISED_Autoneg              (1 << 6)
 659 #define ADVERTISED_TP                   (1 << 7)
 660 #define ADVERTISED_AUI                  (1 << 8)
 661 #define ADVERTISED_MII                  (1 << 9)
 662 #define ADVERTISED_FIBRE                (1 << 10)
 663 #define ADVERTISED_BNC                  (1 << 11)
 664 #define ADVERTISED_10000baseT_Full      (1 << 12)
 665 #define ADVERTISED_Pause                (1 << 13)
 666 #define ADVERTISED_Asym_Pause           (1 << 14)
 667 #define ADVERTISED_2500baseX_Full       (1 << 15)
 668 #define ADVERTISED_Backplane            (1 << 16)
 669 #define ADVERTISED_1000baseKX_Full      (1 << 17)
 670 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
 671 #define ADVERTISED_10000baseKR_Full     (1 << 19)
 672 #define ADVERTISED_10000baseR_FEC       (1 << 20)
 673
 674 /* The following are all involved in forcing a particular link
 675  * mode for the device for setting things.  When getting the
 676  * devices settings, these indicate the current mode and whether
 677  * it was foced up into this mode or autonegotiated.
 678  */
 679
 680 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
 681 #define SPEED_10                10
 682 #define SPEED_100               100
 683 #define SPEED_1000              1000
 684 #define SPEED_2500              2500
 685 #define SPEED_10000             10000
 686
 687 /* Duplex, half or full. */
 688 #define DUPLEX_HALF             0x00
 689 #define DUPLEX_FULL             0x01
 690
 691 /* Which connector port. */
 692 #define PORT_TP                 0x00
 693 #define PORT_AUI                0x01
 694 #define PORT_MII                0x02
 695 #define PORT_FIBRE              0x03
 696 #define PORT_BNC                0x04
 697 #define PORT_DA                 0x05
 698 #define PORT_NONE               0xef
 699 #define PORT_OTHER              0xff
 700
 701 /* Which transceiver to use. */
 702 #define XCVR_INTERNAL           0x00
 703 #define XCVR_EXTERNAL           0x01
 704 #define XCVR_DUMMY1             0x02
 705 #define XCVR_DUMMY2             0x03
 706 #define XCVR_DUMMY3             0x04
 707
 708 /* Enable or disable autonegotiation.  If this is set to enable,
 709  * the forced link modes above are completely ignored.
 710  */
 711 #define AUTONEG_DISABLE         0x00
 712 #define AUTONEG_ENABLE          0x01
 713
 714 /* Mode MDI or MDI-X */
 715 #define ETH_TP_MDI_INVALID      0x00
 716 #define ETH_TP_MDI              0x01
 717 #define ETH_TP_MDI_X            0x02
 718
 719 /* Wake-On-Lan options. */
 720 #define WAKE_PHY                (1 << 0)
 721 #define WAKE_UCAST              (1 << 1)
 722 #define WAKE_MCAST              (1 << 2)
 723 #define WAKE_BCAST              (1 << 3)
 724 #define WAKE_ARP                (1 << 4)
 725 #define WAKE_MAGIC              (1 << 5)
 726 #define WAKE_MAGICSECURE        (1 << 6) /* only meaningful if WAKE_MAGIC */
 727
 728 /* L3-L4 network traffic flow types */
 729 #define TCP_V4_FLOW     0x01
 730 #define UDP_V4_FLOW     0x02
 731 #define SCTP_V4_FLOW    0x03
 732 #define AH_ESP_V4_FLOW  0x04
 733 #define TCP_V6_FLOW     0x05
 734 #define UDP_V6_FLOW     0x06
 735 #define SCTP_V6_FLOW    0x07
 736 #define AH_ESP_V6_FLOW  0x08
 737 #define AH_V4_FLOW      0x09
 738 #define ESP_V4_FLOW     0x0a
 739 #define AH_V6_FLOW      0x0b
 740 #define ESP_V6_FLOW     0x0c
 741 #define IP_USER_FLOW    0x0d
 742 #define IPV4_FLOW       0x10
 743 #define IPV6_FLOW       0x11
 744
 745 /* L3-L4 network traffic flow hash options */
 746 #define RXH_L2DA        (1 << 1)
 747 #define RXH_VLAN        (1 << 2)
 748 #define RXH_L3_PROTO    (1 << 3)
 749 #define RXH_IP_SRC      (1 << 4)
 750 #define RXH_IP_DST      (1 << 5)
 751 #define RXH_L4_B_0_1    (1 << 6) /* src port in case of TCP/UDP/SCTP */
 752 #define RXH_L4_B_2_3    (1 << 7) /* dst port in case of TCP/UDP/SCTP */
 753 #define RXH_DISCARD     (1 << 31)
 754
 755 #define RX_CLS_FLOW_DISC        0xffffffffffffffffULL
 756
 757 /* Reset flags */
 758 /* The reset() operation must clear the flags for the components which
 759  * were actually reset.  On successful return, the flags indicate the
 760  * components which were not reset, either because they do not exist
 761  * in the hardware or because they cannot be reset independently.  The
 762  * driver must never reset any components that were not requested.
 763  */
 764 enum ethtool_reset_flags {
 765         /* These flags represent components dedicated to the interface
 766          * the command is addressed to.  Shift any flag left by
 767          * ETH_RESET_SHARED_SHIFT to reset a shared component of the
 768          * same type.
 769          */
 770         ETH_RESET_MGMT          = 1 << 0,       /* Management processor */
 771         ETH_RESET_IRQ           = 1 << 1,       /* Interrupt requester */
 772         ETH_RESET_DMA           = 1 << 2,       /* DMA engine */
 773         ETH_RESET_FILTER        = 1 << 3,       /* Filtering/flow direction */
 774         ETH_RESET_OFFLOAD       = 1 << 4,       /* Protocol offload */
 775         ETH_RESET_MAC           = 1 << 5,       /* Media access controller */
 776         ETH_RESET_PHY           = 1 << 6,       /* Transceiver/PHY */
 777         ETH_RESET_RAM           = 1 << 7,       /* RAM shared between
 778                                                  * multiple components */
 779
 780         ETH_RESET_DEDICATED     = 0x0000ffff,   /* All components dedicated to
 781                                                  * this interface */
 782         ETH_RESET_ALL           = 0xffffffff,   /* All components used by this
 783                                                  * interface, even if shared */
 784 };
 785 #define ETH_RESET_SHARED_SHIFT  16
 786
 787 #endif /* _LINUX_ETHTOOL_H */