2 * ethtool.h: Defines for Linux ethtool.
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
13 #ifndef _LINUX_ETHTOOL_H
14 #define _LINUX_ETHTOOL_H
17 #include <linux/compat.h>
19 #include <linux/types.h>
20 #include <linux/if_ether.h>
22 /* This should work for both 32 and 64 bit userland. */
25 __u32 supported; /* Features this interface supports */
26 __u32 advertising; /* Features this interface advertises */
27 __u16 speed; /* The forced speed (lower bits) in
29 * ethtool_cmd_speed()/_set() to
31 __u8 duplex; /* Duplex, half or full */
32 __u8 port; /* Which connector port */
34 __u8 transceiver; /* Which transceiver to use */
35 __u8 autoneg; /* Enable or disable autonegotiation */
37 __u32 maxtxpkt; /* Tx pkts before generating tx int */
38 __u32 maxrxpkt; /* Rx pkts before generating rx int */
39 __u16 speed_hi; /* The forced speed (upper
40 * bits) in Mbps. Please use
41 * ethtool_cmd_speed()/_set() to
45 __u32 lp_advertising; /* Features the link partner advertises */
49 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
53 ep->speed = (__u16)speed;
54 ep->speed_hi = (__u16)(speed >> 16);
57 static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
59 return (ep->speed_hi << 16) | ep->speed;
62 #define ETHTOOL_FWVERS_LEN 32
63 #define ETHTOOL_BUSINFO_LEN 32
64 /* these strings are set to whatever the driver author decides... */
65 struct ethtool_drvinfo {
67 char driver[32]; /* driver short name, "tulip", "eepro100" */
68 char version[32]; /* driver version string */
69 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
70 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
71 /* For PCI devices, use pci_name(pci_dev). */
75 * Some struct members below are filled in
76 * using ops->get_sset_count(). Obtaining
77 * this info from ethtool_drvinfo is now
78 * deprecated; Use ETHTOOL_GSSET_INFO
81 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
82 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
84 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
85 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
89 /* wake-on-lan settings */
90 struct ethtool_wolinfo {
94 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
97 /* for passing single values */
98 struct ethtool_value {
103 /* for passing big chunks of data */
104 struct ethtool_regs {
106 __u32 version; /* driver-specific, indicates different chips/revs */
107 __u32 len; /* bytes */
111 /* for passing EEPROM chunks */
112 struct ethtool_eeprom {
115 __u32 offset; /* in bytes */
116 __u32 len; /* in bytes */
120 /* for configuring coalescing parameters of chip */
121 struct ethtool_coalesce {
122 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */
124 /* How many usecs to delay an RX interrupt after
125 * a packet arrives. If 0, only rx_max_coalesced_frames
128 __u32 rx_coalesce_usecs;
130 /* How many packets to delay an RX interrupt after
131 * a packet arrives. If 0, only rx_coalesce_usecs is
132 * used. It is illegal to set both usecs and max frames
133 * to zero as this would cause RX interrupts to never be
136 __u32 rx_max_coalesced_frames;
138 /* Same as above two parameters, except that these values
139 * apply while an IRQ is being serviced by the host. Not
140 * all cards support this feature and the values are ignored
143 __u32 rx_coalesce_usecs_irq;
144 __u32 rx_max_coalesced_frames_irq;
146 /* How many usecs to delay a TX interrupt after
147 * a packet is sent. If 0, only tx_max_coalesced_frames
150 __u32 tx_coalesce_usecs;
152 /* How many packets to delay a TX interrupt after
153 * a packet is sent. If 0, only tx_coalesce_usecs is
154 * used. It is illegal to set both usecs and max frames
155 * to zero as this would cause TX interrupts to never be
158 __u32 tx_max_coalesced_frames;
160 /* Same as above two parameters, except that these values
161 * apply while an IRQ is being serviced by the host. Not
162 * all cards support this feature and the values are ignored
165 __u32 tx_coalesce_usecs_irq;
166 __u32 tx_max_coalesced_frames_irq;
168 /* How many usecs to delay in-memory statistics
169 * block updates. Some drivers do not have an in-memory
170 * statistic block, and in such cases this value is ignored.
171 * This value must not be zero.
173 __u32 stats_block_coalesce_usecs;
175 /* Adaptive RX/TX coalescing is an algorithm implemented by
176 * some drivers to improve latency under low packet rates and
177 * improve throughput under high packet rates. Some drivers
178 * only implement one of RX or TX adaptive coalescing. Anything
179 * not implemented by the driver causes these values to be
182 __u32 use_adaptive_rx_coalesce;
183 __u32 use_adaptive_tx_coalesce;
185 /* When the packet rate (measured in packets per second)
186 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
190 __u32 rx_coalesce_usecs_low;
191 __u32 rx_max_coalesced_frames_low;
192 __u32 tx_coalesce_usecs_low;
193 __u32 tx_max_coalesced_frames_low;
195 /* When the packet rate is below pkt_rate_high but above
196 * pkt_rate_low (both measured in packets per second) the
197 * normal {rx,tx}_* coalescing parameters are used.
200 /* When the packet rate is (measured in packets per second)
201 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
205 __u32 rx_coalesce_usecs_high;
206 __u32 rx_max_coalesced_frames_high;
207 __u32 tx_coalesce_usecs_high;
208 __u32 tx_max_coalesced_frames_high;
210 /* How often to do adaptive coalescing packet rate sampling,
211 * measured in seconds. Must not be zero.
213 __u32 rate_sample_interval;
216 /* for configuring RX/TX ring parameters */
217 struct ethtool_ringparam {
218 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
220 /* Read only attributes. These indicate the maximum number
221 * of pending RX/TX ring entries the driver will allow the
224 __u32 rx_max_pending;
225 __u32 rx_mini_max_pending;
226 __u32 rx_jumbo_max_pending;
227 __u32 tx_max_pending;
229 /* Values changeable by the user. The valid values are
230 * in the range 1 to the "*_max_pending" counterpart above.
233 __u32 rx_mini_pending;
234 __u32 rx_jumbo_pending;
239 * struct ethtool_channels - configuring number of network channel
240 * @cmd: ETHTOOL_{G,S}CHANNELS
241 * @max_rx: Read only. Maximum number of receive channel the driver support.
242 * @max_tx: Read only. Maximum number of transmit channel the driver support.
243 * @max_other: Read only. Maximum number of other channel the driver support.
244 * @max_combined: Read only. Maximum number of combined channel the driver
245 * support. Set of queues RX, TX or other.
246 * @rx_count: Valid values are in the range 1 to the max_rx.
247 * @tx_count: Valid values are in the range 1 to the max_tx.
248 * @other_count: Valid values are in the range 1 to the max_other.
249 * @combined_count: Valid values are in the range 1 to the max_combined.
251 * This can be used to configure RX, TX and other channels.
254 struct ethtool_channels {
263 __u32 combined_count;
266 /* for configuring link flow control parameters */
267 struct ethtool_pauseparam {
268 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
270 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
271 * being true) the user may set 'autonet' here non-zero to have the
272 * pause parameters be auto-negotiated too. In such a case, the
273 * {rx,tx}_pause values below determine what capabilities are
276 * If 'autoneg' is zero or the link is not being auto-negotiated,
277 * then {rx,tx}_pause force the driver to use/not-use pause
285 #define ETH_GSTRING_LEN 32
286 enum ethtool_stringset {
290 ETH_SS_NTUPLE_FILTERS,
294 /* for passing string sets for data tagging */
295 struct ethtool_gstrings {
296 __u32 cmd; /* ETHTOOL_GSTRINGS */
297 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
298 __u32 len; /* number of strings in the string set */
302 struct ethtool_sset_info {
303 __u32 cmd; /* ETHTOOL_GSSET_INFO */
305 __u64 sset_mask; /* input: each bit selects an sset to query */
306 /* output: each bit a returned sset */
307 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits
308 in sset_mask. One bit implies one
309 __u32, two bits implies two
313 enum ethtool_test_flags {
314 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
315 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
318 /* for requesting NIC test and getting results*/
319 struct ethtool_test {
320 __u32 cmd; /* ETHTOOL_TEST */
321 __u32 flags; /* ETH_TEST_FL_xxx */
323 __u32 len; /* result length, in number of u64 elements */
327 /* for dumping NIC-specific statistics */
328 struct ethtool_stats {
329 __u32 cmd; /* ETHTOOL_GSTATS */
330 __u32 n_stats; /* number of u64's being returned */
334 struct ethtool_perm_addr {
335 __u32 cmd; /* ETHTOOL_GPERMADDR */
340 /* boolean flags controlling per-interface behavior characteristics.
341 * When reading, the flag indicates whether or not a certain behavior
342 * is enabled/present. When writing, the flag indicates whether
343 * or not the driver should turn on (set) or off (clear) a behavior.
345 * Some behaviors may read-only (unconditionally absent or present).
346 * If such is the case, return EINVAL in the set-flags operation if the
347 * flag differs from the read-only value.
350 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
351 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
352 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
353 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
354 ETH_FLAG_RXHASH = (1 << 28),
357 /* The following structures are for supporting RX network flow
358 * classification and RX n-tuple configuration. Note, all multibyte
359 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
360 * be in network byte order.
364 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
365 * @ip4src: Source host
366 * @ip4dst: Destination host
368 * @pdst: Destination port
369 * @tos: Type-of-service
371 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
373 struct ethtool_tcpip4_spec {
382 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
383 * @ip4src: Source host
384 * @ip4dst: Destination host
385 * @spi: Security parameters index
386 * @tos: Type-of-service
388 * This can be used to specify an IPsec transport or tunnel over IPv4.
390 struct ethtool_ah_espip4_spec {
397 #define ETH_RX_NFC_IP4 1
400 * struct ethtool_usrip4_spec - general flow specification for IPv4
401 * @ip4src: Source host
402 * @ip4dst: Destination host
403 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
404 * @tos: Type-of-service
405 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
406 * @proto: Transport protocol number; mask must be 0
408 struct ethtool_usrip4_spec {
417 union ethtool_flow_union {
418 struct ethtool_tcpip4_spec tcp_ip4_spec;
419 struct ethtool_tcpip4_spec udp_ip4_spec;
420 struct ethtool_tcpip4_spec sctp_ip4_spec;
421 struct ethtool_ah_espip4_spec ah_ip4_spec;
422 struct ethtool_ah_espip4_spec esp_ip4_spec;
423 struct ethtool_usrip4_spec usr_ip4_spec;
424 struct ethhdr ether_spec;
428 struct ethtool_flow_ext {
435 * struct ethtool_rx_flow_spec - specification for RX flow filter
436 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
437 * @h_u: Flow fields to match (dependent on @flow_type)
438 * @h_ext: Additional fields to match
439 * @m_u: Masks for flow field bits to be matched
440 * @m_ext: Masks for additional field bits to be matched
441 * Note, all additional fields must be ignored unless @flow_type
442 * includes the %FLOW_EXT flag.
443 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
444 * if packets should be discarded
445 * @location: Index of filter in hardware table
447 struct ethtool_rx_flow_spec {
449 union ethtool_flow_union h_u;
450 struct ethtool_flow_ext h_ext;
451 union ethtool_flow_union m_u;
452 struct ethtool_flow_ext m_ext;
458 * struct ethtool_rxnfc - command to get or set RX flow classification rules
459 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
460 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
461 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
462 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
463 * @data: Command-dependent value
464 * @fs: Flow filter specification
465 * @rule_cnt: Number of rules to be affected
466 * @rule_locs: Array of valid rule indices
468 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
469 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
470 * structure fields must not be used.
472 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
475 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
478 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an
479 * existing filter rule on entry and @fs contains the rule on return.
481 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
482 * user buffer for @rule_locs on entry. On return, @data is the size
483 * of the filter table and @rule_locs contains the indices of the
486 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or
487 * update. @fs.@location specifies the index to use and must not be
490 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an
491 * existing filter rule on entry.
493 * Implementation of indexed classification rules generally requires a
496 struct ethtool_rxnfc {
500 struct ethtool_rx_flow_spec fs;
508 struct compat_ethtool_rx_flow_spec {
510 union ethtool_flow_union h_u;
511 struct ethtool_flow_ext h_ext;
512 union ethtool_flow_union m_u;
513 struct ethtool_flow_ext m_ext;
514 compat_u64 ring_cookie;
518 struct compat_ethtool_rxnfc {
522 struct compat_ethtool_rx_flow_spec fs;
527 #endif /* CONFIG_COMPAT */
528 #endif /* __KERNEL__ */
531 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
532 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
533 * @size: On entry, the array size of the user buffer. On return from
534 * %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
535 * @ring_index: RX ring/queue index for each hash value
537 struct ethtool_rxfh_indir {
544 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
545 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
546 * @h_u: Flow field values to match (dependent on @flow_type)
547 * @m_u: Masks for flow field value bits to be ignored
548 * @vlan_tag: VLAN tag to match
549 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
550 * @data: Driver-dependent data to match
551 * @data_mask: Mask for driver-dependent data bits to be ignored
552 * @action: RX ring/queue index to deliver to (non-negative) or other action
553 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
555 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
556 * a field value and mask are both zero this is treated as if all mask
557 * bits are set i.e. the field is ignored.
559 struct ethtool_rx_ntuple_flow_spec {
562 struct ethtool_tcpip4_spec tcp_ip4_spec;
563 struct ethtool_tcpip4_spec udp_ip4_spec;
564 struct ethtool_tcpip4_spec sctp_ip4_spec;
565 struct ethtool_ah_espip4_spec ah_ip4_spec;
566 struct ethtool_ah_espip4_spec esp_ip4_spec;
567 struct ethtool_usrip4_spec usr_ip4_spec;
568 struct ethhdr ether_spec;
578 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
579 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
583 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
584 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
585 * @fs: Flow filter specification
587 struct ethtool_rx_ntuple {
589 struct ethtool_rx_ntuple_flow_spec fs;
592 #define ETHTOOL_FLASH_MAX_FILENAME 128
593 enum ethtool_flash_op_type {
594 ETHTOOL_FLASH_ALL_REGIONS = 0,
597 /* for passing firmware flashing related parameters */
598 struct ethtool_flash {
601 char data[ETHTOOL_FLASH_MAX_FILENAME];
604 /* for returning and changing feature sets */
607 * struct ethtool_get_features_block - block with state of 32 features
608 * @available: mask of changeable features
609 * @requested: mask of features requested to be enabled if possible
610 * @active: mask of currently enabled features
611 * @never_changed: mask of features not changeable for any device
613 struct ethtool_get_features_block {
621 * struct ethtool_gfeatures - command to get state of device's features
622 * @cmd: command number = %ETHTOOL_GFEATURES
623 * @size: in: number of elements in the features[] array;
624 * out: number of elements in features[] needed to hold all features
625 * @features: state of features
627 struct ethtool_gfeatures {
630 struct ethtool_get_features_block features[0];
634 * struct ethtool_set_features_block - block with request for 32 features
635 * @valid: mask of features to be changed
636 * @requested: values of features to be changed
638 struct ethtool_set_features_block {
644 * struct ethtool_sfeatures - command to request change in device's features
645 * @cmd: command number = %ETHTOOL_SFEATURES
646 * @size: array size of the features[] array
647 * @features: feature change masks
649 struct ethtool_sfeatures {
652 struct ethtool_set_features_block features[0];
656 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
657 * values of corresponding bits in features[].requested. Bits in .requested
658 * not set in .valid or not changeable are ignored.
660 * Returns %EINVAL when .valid contains undefined or never-changeable bits
661 * or size is not equal to required number of features words (32-bit blocks).
662 * Returns >= 0 if request was completed; bits set in the value mean:
663 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
664 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
665 * those bits were ignored.
666 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
667 * resulting state of bits masked by .valid is not equal to .requested.
668 * Probably there are other device-specific constraints on some features
669 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
670 * here as though ignored bits were cleared.
671 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
672 * compatibility functions. Requested offload state cannot be properly
675 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
676 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
677 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
678 * significant bit in features[0] fields. Empty strings mark undefined features.
680 enum ethtool_sfeatures_retval_bits {
681 ETHTOOL_F_UNSUPPORTED__BIT,
683 ETHTOOL_F_COMPAT__BIT,
686 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
687 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
688 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
692 #include <linux/rculist.h>
694 /* needed by dev_disable_lro() */
695 extern int __ethtool_set_flags(struct net_device *dev, u32 flags);
697 struct ethtool_rx_ntuple_flow_spec_container {
698 struct ethtool_rx_ntuple_flow_spec fs;
699 struct list_head list;
702 struct ethtool_rx_ntuple_list {
703 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
704 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
705 struct list_head list;
710 * enum ethtool_phys_id_state - indicator state for physical identification
711 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
712 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
713 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
715 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
718 enum ethtool_phys_id_state {
727 /* Some generic methods drivers may use in their ethtool_ops */
728 u32 ethtool_op_get_link(struct net_device *dev);
729 u32 ethtool_op_get_tx_csum(struct net_device *dev);
730 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
731 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
732 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
733 u32 ethtool_op_get_sg(struct net_device *dev);
734 int ethtool_op_set_sg(struct net_device *dev, u32 data);
735 u32 ethtool_op_get_tso(struct net_device *dev);
736 int ethtool_op_set_tso(struct net_device *dev, u32 data);
737 u32 ethtool_op_get_ufo(struct net_device *dev);
738 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
739 u32 ethtool_op_get_flags(struct net_device *dev);
740 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
741 void ethtool_ntuple_flush(struct net_device *dev);
742 bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported);
745 * struct ethtool_ops - optional netdev operations
746 * @get_settings: Get various device settings including Ethernet link
747 * settings. The @cmd parameter is expected to have been cleared
748 * before get_settings is called. Returns a negative error code or
750 * @set_settings: Set various device settings including Ethernet link
751 * settings. Returns a negative error code or zero.
752 * @get_drvinfo: Report driver/device information. Should only set the
753 * @driver, @version, @fw_version and @bus_info fields. If not
754 * implemented, the @driver and @bus_info fields will be filled in
755 * according to the netdev's parent device.
756 * @get_regs_len: Get buffer length required for @get_regs
757 * @get_regs: Get device registers
758 * @get_wol: Report whether Wake-on-Lan is enabled
759 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
761 * @get_msglevel: Report driver message level. This should be the value
762 * of the @msg_enable field used by netif logging functions.
763 * @set_msglevel: Set driver message level
764 * @nway_reset: Restart autonegotiation. Returns a negative error code
766 * @get_link: Report whether physical link is up. Will only be called if
767 * the netdev is up. Should usually be set to ethtool_op_get_link(),
768 * which uses netif_carrier_ok().
769 * @get_eeprom: Read data from the device EEPROM.
770 * Should fill in the magic field. Don't need to check len for zero
771 * or wraparound. Fill in the data argument with the eeprom values
772 * from offset to offset + len. Update len to the amount read.
773 * Returns an error or zero.
774 * @set_eeprom: Write data to the device EEPROM.
775 * Should validate the magic field. Don't need to check len for zero
776 * or wraparound. Update len to the amount written. Returns an error
778 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
779 * error code or zero.
780 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
781 * error code or zero.
782 * @get_ringparam: Report ring sizes
783 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
784 * @get_pauseparam: Report pause parameters
785 * @set_pauseparam: Set pause parameters. Returns a negative error code
787 * @get_rx_csum: Deprecated in favour of the netdev feature %NETIF_F_RXCSUM.
788 * Report whether receive checksums are turned on or off.
789 * @set_rx_csum: Deprecated in favour of generic netdev features. Turn
790 * receive checksum on or off. Returns a negative error code or zero.
791 * @get_tx_csum: Deprecated as redundant. Report whether transmit checksums
792 * are turned on or off.
793 * @set_tx_csum: Deprecated in favour of generic netdev features. Turn
794 * transmit checksums on or off. Returns a egative error code or zero.
795 * @get_sg: Deprecated as redundant. Report whether scatter-gather is
797 * @set_sg: Deprecated in favour of generic netdev features. Turn
798 * scatter-gather on or off. Returns a negative error code or zero.
799 * @get_tso: Deprecated as redundant. Report whether TCP segmentation
800 * offload is enabled.
801 * @set_tso: Deprecated in favour of generic netdev features. Turn TCP
802 * segmentation offload on or off. Returns a negative error code or zero.
803 * @self_test: Run specified self-tests
804 * @get_strings: Return a set of strings that describe the requested objects
805 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
806 * attached to it. The implementation may update the indicator
807 * asynchronously or synchronously, but in either case it must return
808 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
809 * and must either activate asynchronous updates and return zero, return
810 * a negative error or return a positive frequency for synchronous
811 * indication (e.g. 1 for one on/off cycle per second). If it returns
812 * a frequency then it will be called again at intervals with the
813 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
814 * the indicator accordingly. Finally, it is called with the argument
815 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
816 * negative error code or zero.
817 * @get_ethtool_stats: Return extended statistics about the device.
818 * This is only useful if the device maintains statistics not
819 * included in &struct rtnl_link_stats64.
820 * @begin: Function to be called before any other operation. Returns a
821 * negative error code or zero.
822 * @complete: Function to be called after any other operation except
823 * @begin. Will be called even if the other operation failed.
824 * @get_ufo: Deprecated as redundant. Report whether UDP fragmentation
825 * offload is enabled.
826 * @set_ufo: Deprecated in favour of generic netdev features. Turn UDP
827 * fragmentation offload on or off. Returns a negative error code or zero.
828 * @get_flags: Deprecated as redundant. Report features included in
829 * &enum ethtool_flags that are enabled.
830 * @set_flags: Deprecated in favour of generic netdev features. Turn
831 * features included in &enum ethtool_flags on or off. Returns a
832 * negative error code or zero.
833 * @get_priv_flags: Report driver-specific feature flags.
834 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
835 * error code or zero.
836 * @get_sset_count: Get number of strings that @get_strings will write.
837 * @get_rxnfc: Get RX flow classification rules. Returns a negative
838 * error code or zero.
839 * @set_rxnfc: Set RX flow classification rules. Returns a negative
840 * error code or zero.
841 * @flash_device: Write a firmware image to device's flash memory.
842 * Returns a negative error code or zero.
843 * @reset: Reset (part of) the device, as specified by a bitmask of
844 * flags from &enum ethtool_reset_flags. Returns a negative
845 * error code or zero.
846 * @set_rx_ntuple: Set an RX n-tuple rule. Returns a negative error code
848 * @get_rx_ntuple: Deprecated.
849 * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
850 * Returns a negative error code or zero.
851 * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
852 * Returns a negative error code or zero.
853 * @get_channels: Get number of channels.
854 * @set_channels: Set number of channels. Returns a negative error code or
857 * All operations are optional (i.e. the function pointer may be set
858 * to %NULL) and callers must take this into account. Callers must
859 * hold the RTNL, except that for @get_drvinfo the caller may or may
862 * See the structures used by these operations for further documentation.
864 * See &struct net_device and &struct net_device_ops for documentation
865 * of the generic netdev features interface.
868 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
869 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
870 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
871 int (*get_regs_len)(struct net_device *);
872 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
873 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
874 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
875 u32 (*get_msglevel)(struct net_device *);
876 void (*set_msglevel)(struct net_device *, u32);
877 int (*nway_reset)(struct net_device *);
878 u32 (*get_link)(struct net_device *);
879 int (*get_eeprom_len)(struct net_device *);
880 int (*get_eeprom)(struct net_device *,
881 struct ethtool_eeprom *, u8 *);
882 int (*set_eeprom)(struct net_device *,
883 struct ethtool_eeprom *, u8 *);
884 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
885 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
886 void (*get_ringparam)(struct net_device *,
887 struct ethtool_ringparam *);
888 int (*set_ringparam)(struct net_device *,
889 struct ethtool_ringparam *);
890 void (*get_pauseparam)(struct net_device *,
891 struct ethtool_pauseparam*);
892 int (*set_pauseparam)(struct net_device *,
893 struct ethtool_pauseparam*);
894 u32 (*get_rx_csum)(struct net_device *);
895 int (*set_rx_csum)(struct net_device *, u32);
896 u32 (*get_tx_csum)(struct net_device *);
897 int (*set_tx_csum)(struct net_device *, u32);
898 u32 (*get_sg)(struct net_device *);
899 int (*set_sg)(struct net_device *, u32);
900 u32 (*get_tso)(struct net_device *);
901 int (*set_tso)(struct net_device *, u32);
902 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
903 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
904 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
905 void (*get_ethtool_stats)(struct net_device *,
906 struct ethtool_stats *, u64 *);
907 int (*begin)(struct net_device *);
908 void (*complete)(struct net_device *);
909 u32 (*get_ufo)(struct net_device *);
910 int (*set_ufo)(struct net_device *, u32);
911 u32 (*get_flags)(struct net_device *);
912 int (*set_flags)(struct net_device *, u32);
913 u32 (*get_priv_flags)(struct net_device *);
914 int (*set_priv_flags)(struct net_device *, u32);
915 int (*get_sset_count)(struct net_device *, int);
916 int (*get_rxnfc)(struct net_device *,
917 struct ethtool_rxnfc *, void *);
918 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
919 int (*flash_device)(struct net_device *, struct ethtool_flash *);
920 int (*reset)(struct net_device *, u32 *);
921 int (*set_rx_ntuple)(struct net_device *,
922 struct ethtool_rx_ntuple *);
923 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
924 int (*get_rxfh_indir)(struct net_device *,
925 struct ethtool_rxfh_indir *);
926 int (*set_rxfh_indir)(struct net_device *,
927 const struct ethtool_rxfh_indir *);
928 void (*get_channels)(struct net_device *, struct ethtool_channels *);
929 int (*set_channels)(struct net_device *, struct ethtool_channels *);
932 #endif /* __KERNEL__ */
934 /* CMDs currently supported */
935 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
936 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
937 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
938 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
939 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
940 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
941 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
942 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
943 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
944 /* Get link status for host, i.e. whether the interface *and* the
945 * physical port (if there is one) are up (ethtool_value). */
946 #define ETHTOOL_GLINK 0x0000000a
947 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
948 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
949 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
950 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
951 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
952 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
953 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
954 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
955 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
956 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
957 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
958 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
959 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
961 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
962 * (ethtool_value). */
963 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
964 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
965 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
966 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
967 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
968 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
969 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
970 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
971 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
972 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
973 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
974 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
975 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
976 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
977 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
979 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
980 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
981 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
982 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
983 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
984 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
985 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
986 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
987 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
988 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
989 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
990 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
991 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
992 #define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */
993 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
994 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
995 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
997 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
998 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
999 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1000 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1002 /* compatibility with older code */
1003 #define SPARC_ETH_GSET ETHTOOL_GSET
1004 #define SPARC_ETH_SSET ETHTOOL_SSET
1006 /* Indicates what features are supported by the interface. */
1007 #define SUPPORTED_10baseT_Half (1 << 0)
1008 #define SUPPORTED_10baseT_Full (1 << 1)
1009 #define SUPPORTED_100baseT_Half (1 << 2)
1010 #define SUPPORTED_100baseT_Full (1 << 3)
1011 #define SUPPORTED_1000baseT_Half (1 << 4)
1012 #define SUPPORTED_1000baseT_Full (1 << 5)
1013 #define SUPPORTED_Autoneg (1 << 6)
1014 #define SUPPORTED_TP (1 << 7)
1015 #define SUPPORTED_AUI (1 << 8)
1016 #define SUPPORTED_MII (1 << 9)
1017 #define SUPPORTED_FIBRE (1 << 10)
1018 #define SUPPORTED_BNC (1 << 11)
1019 #define SUPPORTED_10000baseT_Full (1 << 12)
1020 #define SUPPORTED_Pause (1 << 13)
1021 #define SUPPORTED_Asym_Pause (1 << 14)
1022 #define SUPPORTED_2500baseX_Full (1 << 15)
1023 #define SUPPORTED_Backplane (1 << 16)
1024 #define SUPPORTED_1000baseKX_Full (1 << 17)
1025 #define SUPPORTED_10000baseKX4_Full (1 << 18)
1026 #define SUPPORTED_10000baseKR_Full (1 << 19)
1027 #define SUPPORTED_10000baseR_FEC (1 << 20)
1028 #define SUPPORTED_20000baseMLD2_Full (1 << 21)
1029 #define SUPPORTED_20000baseKR2_Full (1 << 22)
1031 /* Indicates what features are advertised by the interface. */
1032 #define ADVERTISED_10baseT_Half (1 << 0)
1033 #define ADVERTISED_10baseT_Full (1 << 1)
1034 #define ADVERTISED_100baseT_Half (1 << 2)
1035 #define ADVERTISED_100baseT_Full (1 << 3)
1036 #define ADVERTISED_1000baseT_Half (1 << 4)
1037 #define ADVERTISED_1000baseT_Full (1 << 5)
1038 #define ADVERTISED_Autoneg (1 << 6)
1039 #define ADVERTISED_TP (1 << 7)
1040 #define ADVERTISED_AUI (1 << 8)
1041 #define ADVERTISED_MII (1 << 9)
1042 #define ADVERTISED_FIBRE (1 << 10)
1043 #define ADVERTISED_BNC (1 << 11)
1044 #define ADVERTISED_10000baseT_Full (1 << 12)
1045 #define ADVERTISED_Pause (1 << 13)
1046 #define ADVERTISED_Asym_Pause (1 << 14)
1047 #define ADVERTISED_2500baseX_Full (1 << 15)
1048 #define ADVERTISED_Backplane (1 << 16)
1049 #define ADVERTISED_1000baseKX_Full (1 << 17)
1050 #define ADVERTISED_10000baseKX4_Full (1 << 18)
1051 #define ADVERTISED_10000baseKR_Full (1 << 19)
1052 #define ADVERTISED_10000baseR_FEC (1 << 20)
1053 #define ADVERTISED_20000baseMLD2_Full (1 << 21)
1054 #define ADVERTISED_20000baseKR2_Full (1 << 22)
1056 /* The following are all involved in forcing a particular link
1057 * mode for the device for setting things. When getting the
1058 * devices settings, these indicate the current mode and whether
1059 * it was foced up into this mode or autonegotiated.
1062 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1064 #define SPEED_100 100
1065 #define SPEED_1000 1000
1066 #define SPEED_2500 2500
1067 #define SPEED_10000 10000
1069 /* Duplex, half or full. */
1070 #define DUPLEX_HALF 0x00
1071 #define DUPLEX_FULL 0x01
1073 /* Which connector port. */
1074 #define PORT_TP 0x00
1075 #define PORT_AUI 0x01
1076 #define PORT_MII 0x02
1077 #define PORT_FIBRE 0x03
1078 #define PORT_BNC 0x04
1079 #define PORT_DA 0x05
1080 #define PORT_NONE 0xef
1081 #define PORT_OTHER 0xff
1083 /* Which transceiver to use. */
1084 #define XCVR_INTERNAL 0x00
1085 #define XCVR_EXTERNAL 0x01
1086 #define XCVR_DUMMY1 0x02
1087 #define XCVR_DUMMY2 0x03
1088 #define XCVR_DUMMY3 0x04
1090 /* Enable or disable autonegotiation. If this is set to enable,
1091 * the forced link modes above are completely ignored.
1093 #define AUTONEG_DISABLE 0x00
1094 #define AUTONEG_ENABLE 0x01
1096 /* Mode MDI or MDI-X */
1097 #define ETH_TP_MDI_INVALID 0x00
1098 #define ETH_TP_MDI 0x01
1099 #define ETH_TP_MDI_X 0x02
1101 /* Wake-On-Lan options. */
1102 #define WAKE_PHY (1 << 0)
1103 #define WAKE_UCAST (1 << 1)
1104 #define WAKE_MCAST (1 << 2)
1105 #define WAKE_BCAST (1 << 3)
1106 #define WAKE_ARP (1 << 4)
1107 #define WAKE_MAGIC (1 << 5)
1108 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1110 /* L2-L4 network traffic flow types */
1111 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1112 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1113 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1114 #define AH_ESP_V4_FLOW 0x04 /* hash only */
1115 #define TCP_V6_FLOW 0x05 /* hash only */
1116 #define UDP_V6_FLOW 0x06 /* hash only */
1117 #define SCTP_V6_FLOW 0x07 /* hash only */
1118 #define AH_ESP_V6_FLOW 0x08 /* hash only */
1119 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1120 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1121 #define AH_V6_FLOW 0x0b /* hash only */
1122 #define ESP_V6_FLOW 0x0c /* hash only */
1123 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1124 #define IPV4_FLOW 0x10 /* hash only */
1125 #define IPV6_FLOW 0x11 /* hash only */
1126 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */
1127 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1128 #define FLOW_EXT 0x80000000
1130 /* L3-L4 network traffic flow hash options */
1131 #define RXH_L2DA (1 << 1)
1132 #define RXH_VLAN (1 << 2)
1133 #define RXH_L3_PROTO (1 << 3)
1134 #define RXH_IP_SRC (1 << 4)
1135 #define RXH_IP_DST (1 << 5)
1136 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1137 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1138 #define RXH_DISCARD (1 << 31)
1140 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
1143 /* The reset() operation must clear the flags for the components which
1144 * were actually reset. On successful return, the flags indicate the
1145 * components which were not reset, either because they do not exist
1146 * in the hardware or because they cannot be reset independently. The
1147 * driver must never reset any components that were not requested.
1149 enum ethtool_reset_flags {
1150 /* These flags represent components dedicated to the interface
1151 * the command is addressed to. Shift any flag left by
1152 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1155 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1156 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1157 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1158 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1159 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1160 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1161 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1162 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1163 * multiple components */
1165 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1167 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1168 * interface, even if shared */
1170 #define ETH_RESET_SHARED_SHIFT 16
1172 #endif /* _LINUX_ETHTOOL_H */