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