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