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