include/linux/ethtool.h

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