include: replace linux/module.h with "struct module" wherever possible
[linux-2.6/next.git] / include / linux / ethtool.h
blobc6e427ab65fe0a802878d1ebac438364956a44bf
1 /*
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
16 #ifdef __KERNEL__
17 #include <linux/compat.h>
18 #endif
19 #include <linux/types.h>
20 #include <linux/if_ether.h>
22 /* This should work for both 32 and 64 bit userland. */
23 struct ethtool_cmd {
24 __u32 cmd;
25 __u32 supported; /* Features this interface supports */
26 __u32 advertising; /* Features this interface advertises */
27 __u16 speed; /* The forced speed (lower bits) in
28 * Mbps. Please use
29 * ethtool_cmd_speed()/_set() to
30 * access it */
31 __u8 duplex; /* Duplex, half or full */
32 __u8 port; /* Which connector port */
33 __u8 phy_address;
34 __u8 transceiver; /* Which transceiver to use */
35 __u8 autoneg; /* Enable or disable autonegotiation */
36 __u8 mdio_support;
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
42 * access it */
43 __u8 eth_tp_mdix;
44 __u8 reserved2;
45 __u32 lp_advertising; /* Features the link partner advertises */
46 __u32 reserved[2];
49 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
50 __u32 speed)
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 {
66 __u32 cmd;
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). */
72 char reserved1[32];
73 char reserved2[12];
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
79 * instead.
81 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
82 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
83 __u32 testinfo_len;
84 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
85 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
88 #define SOPASS_MAX 6
89 /* wake-on-lan settings */
90 struct ethtool_wolinfo {
91 __u32 cmd;
92 __u32 supported;
93 __u32 wolopts;
94 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
97 /* for passing single values */
98 struct ethtool_value {
99 __u32 cmd;
100 __u32 data;
103 /* for passing big chunks of data */
104 struct ethtool_regs {
105 __u32 cmd;
106 __u32 version; /* driver-specific, indicates different chips/revs */
107 __u32 len; /* bytes */
108 __u8 data[0];
111 /* for passing EEPROM chunks */
112 struct ethtool_eeprom {
113 __u32 cmd;
114 __u32 magic;
115 __u32 offset; /* in bytes */
116 __u32 len; /* in bytes */
117 __u8 data[0];
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
126 * is used.
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
134 * generated.
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
141 * in that case.
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
148 * is used.
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
156 * generated.
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
163 * in that case.
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
180 * silently ignored.
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
187 * used.
189 __u32 pkt_rate_low;
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
202 * used.
204 __u32 pkt_rate_high;
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
222 * user to set.
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.
232 __u32 rx_pending;
233 __u32 rx_mini_pending;
234 __u32 rx_jumbo_pending;
235 __u32 tx_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 {
255 __u32 cmd;
256 __u32 max_rx;
257 __u32 max_tx;
258 __u32 max_other;
259 __u32 max_combined;
260 __u32 rx_count;
261 __u32 tx_count;
262 __u32 other_count;
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 'autoneg' 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
274 * advertised.
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
278 * flow control.
280 __u32 autoneg;
281 __u32 rx_pause;
282 __u32 tx_pause;
285 #define ETH_GSTRING_LEN 32
286 enum ethtool_stringset {
287 ETH_SS_TEST = 0,
288 ETH_SS_STATS,
289 ETH_SS_PRIV_FLAGS,
290 ETH_SS_NTUPLE_FILTERS, /* Do not use, GRXNTUPLE is now deprecated */
291 ETH_SS_FEATURES,
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 */
299 __u8 data[0];
302 struct ethtool_sset_info {
303 __u32 cmd; /* ETHTOOL_GSSET_INFO */
304 __u32 reserved;
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
310 __u32's, etc. */
314 * enum ethtool_test_flags - flags definition of ethtool_test
315 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
316 * only online tests.
317 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
318 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
319 * test.
320 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
323 enum ethtool_test_flags {
324 ETH_TEST_FL_OFFLINE = (1 << 0),
325 ETH_TEST_FL_FAILED = (1 << 1),
326 ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
327 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
330 /* for requesting NIC test and getting results*/
331 struct ethtool_test {
332 __u32 cmd; /* ETHTOOL_TEST */
333 __u32 flags; /* ETH_TEST_FL_xxx */
334 __u32 reserved;
335 __u32 len; /* result length, in number of u64 elements */
336 __u64 data[0];
339 /* for dumping NIC-specific statistics */
340 struct ethtool_stats {
341 __u32 cmd; /* ETHTOOL_GSTATS */
342 __u32 n_stats; /* number of u64's being returned */
343 __u64 data[0];
346 struct ethtool_perm_addr {
347 __u32 cmd; /* ETHTOOL_GPERMADDR */
348 __u32 size;
349 __u8 data[0];
352 /* boolean flags controlling per-interface behavior characteristics.
353 * When reading, the flag indicates whether or not a certain behavior
354 * is enabled/present. When writing, the flag indicates whether
355 * or not the driver should turn on (set) or off (clear) a behavior.
357 * Some behaviors may read-only (unconditionally absent or present).
358 * If such is the case, return EINVAL in the set-flags operation if the
359 * flag differs from the read-only value.
361 enum ethtool_flags {
362 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
363 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
364 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
365 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
366 ETH_FLAG_RXHASH = (1 << 28),
369 /* The following structures are for supporting RX network flow
370 * classification and RX n-tuple configuration. Note, all multibyte
371 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
372 * be in network byte order.
376 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
377 * @ip4src: Source host
378 * @ip4dst: Destination host
379 * @psrc: Source port
380 * @pdst: Destination port
381 * @tos: Type-of-service
383 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
385 struct ethtool_tcpip4_spec {
386 __be32 ip4src;
387 __be32 ip4dst;
388 __be16 psrc;
389 __be16 pdst;
390 __u8 tos;
394 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
395 * @ip4src: Source host
396 * @ip4dst: Destination host
397 * @spi: Security parameters index
398 * @tos: Type-of-service
400 * This can be used to specify an IPsec transport or tunnel over IPv4.
402 struct ethtool_ah_espip4_spec {
403 __be32 ip4src;
404 __be32 ip4dst;
405 __be32 spi;
406 __u8 tos;
409 #define ETH_RX_NFC_IP4 1
412 * struct ethtool_usrip4_spec - general flow specification for IPv4
413 * @ip4src: Source host
414 * @ip4dst: Destination host
415 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
416 * @tos: Type-of-service
417 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
418 * @proto: Transport protocol number; mask must be 0
420 struct ethtool_usrip4_spec {
421 __be32 ip4src;
422 __be32 ip4dst;
423 __be32 l4_4_bytes;
424 __u8 tos;
425 __u8 ip_ver;
426 __u8 proto;
429 union ethtool_flow_union {
430 struct ethtool_tcpip4_spec tcp_ip4_spec;
431 struct ethtool_tcpip4_spec udp_ip4_spec;
432 struct ethtool_tcpip4_spec sctp_ip4_spec;
433 struct ethtool_ah_espip4_spec ah_ip4_spec;
434 struct ethtool_ah_espip4_spec esp_ip4_spec;
435 struct ethtool_usrip4_spec usr_ip4_spec;
436 struct ethhdr ether_spec;
437 __u8 hdata[60];
440 struct ethtool_flow_ext {
441 __be16 vlan_etype;
442 __be16 vlan_tci;
443 __be32 data[2];
447 * struct ethtool_rx_flow_spec - specification for RX flow filter
448 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
449 * @h_u: Flow fields to match (dependent on @flow_type)
450 * @h_ext: Additional fields to match
451 * @m_u: Masks for flow field bits to be matched
452 * @m_ext: Masks for additional field bits to be matched
453 * Note, all additional fields must be ignored unless @flow_type
454 * includes the %FLOW_EXT flag.
455 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
456 * if packets should be discarded
457 * @location: Index of filter in hardware table
459 struct ethtool_rx_flow_spec {
460 __u32 flow_type;
461 union ethtool_flow_union h_u;
462 struct ethtool_flow_ext h_ext;
463 union ethtool_flow_union m_u;
464 struct ethtool_flow_ext m_ext;
465 __u64 ring_cookie;
466 __u32 location;
470 * struct ethtool_rxnfc - command to get or set RX flow classification rules
471 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
472 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
473 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
474 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
475 * @data: Command-dependent value
476 * @fs: Flow filter specification
477 * @rule_cnt: Number of rules to be affected
478 * @rule_locs: Array of valid rule indices
480 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
481 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
482 * structure fields must not be used.
484 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
485 * on return.
487 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
488 * rules on return.
490 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an
491 * existing filter rule on entry and @fs contains the rule on return.
493 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
494 * user buffer for @rule_locs on entry. On return, @data is the size
495 * of the filter table and @rule_locs contains the indices of the
496 * defined rules.
498 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or
499 * update. @fs.@location specifies the index to use and must not be
500 * ignored.
502 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an
503 * existing filter rule on entry.
505 * Implementation of indexed classification rules generally requires a
506 * TCAM.
508 struct ethtool_rxnfc {
509 __u32 cmd;
510 __u32 flow_type;
511 __u64 data;
512 struct ethtool_rx_flow_spec fs;
513 __u32 rule_cnt;
514 __u32 rule_locs[0];
517 #ifdef __KERNEL__
518 #ifdef CONFIG_COMPAT
520 struct compat_ethtool_rx_flow_spec {
521 u32 flow_type;
522 union ethtool_flow_union h_u;
523 struct ethtool_flow_ext h_ext;
524 union ethtool_flow_union m_u;
525 struct ethtool_flow_ext m_ext;
526 compat_u64 ring_cookie;
527 u32 location;
530 struct compat_ethtool_rxnfc {
531 u32 cmd;
532 u32 flow_type;
533 compat_u64 data;
534 struct compat_ethtool_rx_flow_spec fs;
535 u32 rule_cnt;
536 u32 rule_locs[0];
539 #endif /* CONFIG_COMPAT */
540 #endif /* __KERNEL__ */
543 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
544 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
545 * @size: On entry, the array size of the user buffer. On return from
546 * %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
547 * @ring_index: RX ring/queue index for each hash value
549 struct ethtool_rxfh_indir {
550 __u32 cmd;
551 __u32 size;
552 __u32 ring_index[0];
556 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
557 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
558 * @h_u: Flow field values to match (dependent on @flow_type)
559 * @m_u: Masks for flow field value bits to be ignored
560 * @vlan_tag: VLAN tag to match
561 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
562 * @data: Driver-dependent data to match
563 * @data_mask: Mask for driver-dependent data bits to be ignored
564 * @action: RX ring/queue index to deliver to (non-negative) or other action
565 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
567 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
568 * a field value and mask are both zero this is treated as if all mask
569 * bits are set i.e. the field is ignored.
571 struct ethtool_rx_ntuple_flow_spec {
572 __u32 flow_type;
573 union {
574 struct ethtool_tcpip4_spec tcp_ip4_spec;
575 struct ethtool_tcpip4_spec udp_ip4_spec;
576 struct ethtool_tcpip4_spec sctp_ip4_spec;
577 struct ethtool_ah_espip4_spec ah_ip4_spec;
578 struct ethtool_ah_espip4_spec esp_ip4_spec;
579 struct ethtool_usrip4_spec usr_ip4_spec;
580 struct ethhdr ether_spec;
581 __u8 hdata[72];
582 } h_u, m_u;
584 __u16 vlan_tag;
585 __u16 vlan_tag_mask;
586 __u64 data;
587 __u64 data_mask;
589 __s32 action;
590 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
591 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
595 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
596 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
597 * @fs: Flow filter specification
599 struct ethtool_rx_ntuple {
600 __u32 cmd;
601 struct ethtool_rx_ntuple_flow_spec fs;
604 #define ETHTOOL_FLASH_MAX_FILENAME 128
605 enum ethtool_flash_op_type {
606 ETHTOOL_FLASH_ALL_REGIONS = 0,
609 /* for passing firmware flashing related parameters */
610 struct ethtool_flash {
611 __u32 cmd;
612 __u32 region;
613 char data[ETHTOOL_FLASH_MAX_FILENAME];
617 * struct ethtool_dump - used for retrieving, setting device dump
618 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
619 * %ETHTOOL_SET_DUMP
620 * @version: FW version of the dump, filled in by driver
621 * @flag: driver dependent flag for dump setting, filled in by driver during
622 * get and filled in by ethtool for set operation
623 * @len: length of dump data, used as the length of the user buffer on entry to
624 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
625 * for %ETHTOOL_GET_DUMP_FLAG command
626 * @data: data collected for get dump data operation
628 struct ethtool_dump {
629 __u32 cmd;
630 __u32 version;
631 __u32 flag;
632 __u32 len;
633 __u8 data[0];
636 /* for returning and changing feature sets */
639 * struct ethtool_get_features_block - block with state of 32 features
640 * @available: mask of changeable features
641 * @requested: mask of features requested to be enabled if possible
642 * @active: mask of currently enabled features
643 * @never_changed: mask of features not changeable for any device
645 struct ethtool_get_features_block {
646 __u32 available;
647 __u32 requested;
648 __u32 active;
649 __u32 never_changed;
653 * struct ethtool_gfeatures - command to get state of device's features
654 * @cmd: command number = %ETHTOOL_GFEATURES
655 * @size: in: number of elements in the features[] array;
656 * out: number of elements in features[] needed to hold all features
657 * @features: state of features
659 struct ethtool_gfeatures {
660 __u32 cmd;
661 __u32 size;
662 struct ethtool_get_features_block features[0];
666 * struct ethtool_set_features_block - block with request for 32 features
667 * @valid: mask of features to be changed
668 * @requested: values of features to be changed
670 struct ethtool_set_features_block {
671 __u32 valid;
672 __u32 requested;
676 * struct ethtool_sfeatures - command to request change in device's features
677 * @cmd: command number = %ETHTOOL_SFEATURES
678 * @size: array size of the features[] array
679 * @features: feature change masks
681 struct ethtool_sfeatures {
682 __u32 cmd;
683 __u32 size;
684 struct ethtool_set_features_block features[0];
688 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
689 * values of corresponding bits in features[].requested. Bits in .requested
690 * not set in .valid or not changeable are ignored.
692 * Returns %EINVAL when .valid contains undefined or never-changeable bits
693 * or size is not equal to required number of features words (32-bit blocks).
694 * Returns >= 0 if request was completed; bits set in the value mean:
695 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
696 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
697 * those bits were ignored.
698 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
699 * resulting state of bits masked by .valid is not equal to .requested.
700 * Probably there are other device-specific constraints on some features
701 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
702 * here as though ignored bits were cleared.
703 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
704 * compatibility functions. Requested offload state cannot be properly
705 * managed by kernel.
707 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
708 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
709 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
710 * significant bit in features[0] fields. Empty strings mark undefined features.
712 enum ethtool_sfeatures_retval_bits {
713 ETHTOOL_F_UNSUPPORTED__BIT,
714 ETHTOOL_F_WISH__BIT,
715 ETHTOOL_F_COMPAT__BIT,
718 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
719 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
720 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
722 #ifdef __KERNEL__
724 #include <linux/rculist.h>
726 /* needed by dev_disable_lro() */
727 extern int __ethtool_set_flags(struct net_device *dev, u32 flags);
730 * enum ethtool_phys_id_state - indicator state for physical identification
731 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
732 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
733 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
734 * is not supported)
735 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
736 * is not supported)
738 enum ethtool_phys_id_state {
739 ETHTOOL_ID_INACTIVE,
740 ETHTOOL_ID_ACTIVE,
741 ETHTOOL_ID_ON,
742 ETHTOOL_ID_OFF
745 struct net_device;
747 /* Some generic methods drivers may use in their ethtool_ops */
748 u32 ethtool_op_get_link(struct net_device *dev);
749 u32 ethtool_op_get_tx_csum(struct net_device *dev);
750 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
751 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
752 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
753 u32 ethtool_op_get_sg(struct net_device *dev);
754 int ethtool_op_set_sg(struct net_device *dev, u32 data);
755 u32 ethtool_op_get_tso(struct net_device *dev);
756 int ethtool_op_set_tso(struct net_device *dev, u32 data);
757 u32 ethtool_op_get_ufo(struct net_device *dev);
758 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
759 u32 ethtool_op_get_flags(struct net_device *dev);
760 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
761 bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported);
764 * struct ethtool_ops - optional netdev operations
765 * @get_settings: Get various device settings including Ethernet link
766 * settings. The @cmd parameter is expected to have been cleared
767 * before get_settings is called. Returns a negative error code or
768 * zero.
769 * @set_settings: Set various device settings including Ethernet link
770 * settings. Returns a negative error code or zero.
771 * @get_drvinfo: Report driver/device information. Should only set the
772 * @driver, @version, @fw_version and @bus_info fields. If not
773 * implemented, the @driver and @bus_info fields will be filled in
774 * according to the netdev's parent device.
775 * @get_regs_len: Get buffer length required for @get_regs
776 * @get_regs: Get device registers
777 * @get_wol: Report whether Wake-on-Lan is enabled
778 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
779 * or zero.
780 * @get_msglevel: Report driver message level. This should be the value
781 * of the @msg_enable field used by netif logging functions.
782 * @set_msglevel: Set driver message level
783 * @nway_reset: Restart autonegotiation. Returns a negative error code
784 * or zero.
785 * @get_link: Report whether physical link is up. Will only be called if
786 * the netdev is up. Should usually be set to ethtool_op_get_link(),
787 * which uses netif_carrier_ok().
788 * @get_eeprom: Read data from the device EEPROM.
789 * Should fill in the magic field. Don't need to check len for zero
790 * or wraparound. Fill in the data argument with the eeprom values
791 * from offset to offset + len. Update len to the amount read.
792 * Returns an error or zero.
793 * @set_eeprom: Write data to the device EEPROM.
794 * Should validate the magic field. Don't need to check len for zero
795 * or wraparound. Update len to the amount written. Returns an error
796 * or zero.
797 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
798 * error code or zero.
799 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
800 * error code or zero.
801 * @get_ringparam: Report ring sizes
802 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
803 * @get_pauseparam: Report pause parameters
804 * @set_pauseparam: Set pause parameters. Returns a negative error code
805 * or zero.
806 * @get_rx_csum: Deprecated in favour of the netdev feature %NETIF_F_RXCSUM.
807 * Report whether receive checksums are turned on or off.
808 * @set_rx_csum: Deprecated in favour of generic netdev features. Turn
809 * receive checksum on or off. Returns a negative error code or zero.
810 * @get_tx_csum: Deprecated as redundant. Report whether transmit checksums
811 * are turned on or off.
812 * @set_tx_csum: Deprecated in favour of generic netdev features. Turn
813 * transmit checksums on or off. Returns a negative error code or zero.
814 * @get_sg: Deprecated as redundant. Report whether scatter-gather is
815 * enabled.
816 * @set_sg: Deprecated in favour of generic netdev features. Turn
817 * scatter-gather on or off. Returns a negative error code or zero.
818 * @get_tso: Deprecated as redundant. Report whether TCP segmentation
819 * offload is enabled.
820 * @set_tso: Deprecated in favour of generic netdev features. Turn TCP
821 * segmentation offload on or off. Returns a negative error code or zero.
822 * @self_test: Run specified self-tests
823 * @get_strings: Return a set of strings that describe the requested objects
824 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
825 * attached to it. The implementation may update the indicator
826 * asynchronously or synchronously, but in either case it must return
827 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
828 * and must either activate asynchronous updates and return zero, return
829 * a negative error or return a positive frequency for synchronous
830 * indication (e.g. 1 for one on/off cycle per second). If it returns
831 * a frequency then it will be called again at intervals with the
832 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
833 * the indicator accordingly. Finally, it is called with the argument
834 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
835 * negative error code or zero.
836 * @get_ethtool_stats: Return extended statistics about the device.
837 * This is only useful if the device maintains statistics not
838 * included in &struct rtnl_link_stats64.
839 * @begin: Function to be called before any other operation. Returns a
840 * negative error code or zero.
841 * @complete: Function to be called after any other operation except
842 * @begin. Will be called even if the other operation failed.
843 * @get_ufo: Deprecated as redundant. Report whether UDP fragmentation
844 * offload is enabled.
845 * @set_ufo: Deprecated in favour of generic netdev features. Turn UDP
846 * fragmentation offload on or off. Returns a negative error code or zero.
847 * @get_flags: Deprecated as redundant. Report features included in
848 * &enum ethtool_flags that are enabled.
849 * @set_flags: Deprecated in favour of generic netdev features. Turn
850 * features included in &enum ethtool_flags on or off. Returns a
851 * negative error code or zero.
852 * @get_priv_flags: Report driver-specific feature flags.
853 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
854 * error code or zero.
855 * @get_sset_count: Get number of strings that @get_strings will write.
856 * @get_rxnfc: Get RX flow classification rules. Returns a negative
857 * error code or zero.
858 * @set_rxnfc: Set RX flow classification rules. Returns a negative
859 * error code or zero.
860 * @flash_device: Write a firmware image to device's flash memory.
861 * Returns a negative error code or zero.
862 * @reset: Reset (part of) the device, as specified by a bitmask of
863 * flags from &enum ethtool_reset_flags. Returns a negative
864 * error code or zero.
865 * @set_rx_ntuple: Set an RX n-tuple rule. Returns a negative error code
866 * or zero.
867 * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
868 * Returns a negative error code or zero.
869 * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
870 * Returns a negative error code or zero.
871 * @get_channels: Get number of channels.
872 * @set_channels: Set number of channels. Returns a negative error code or
873 * zero.
874 * @get_dump_flag: Get dump flag indicating current dump length, version,
875 * and flag of the device.
876 * @get_dump_data: Get dump data.
877 * @set_dump: Set dump specific flags to the device.
879 * All operations are optional (i.e. the function pointer may be set
880 * to %NULL) and callers must take this into account. Callers must
881 * hold the RTNL, except that for @get_drvinfo the caller may or may
882 * not hold the RTNL.
884 * See the structures used by these operations for further documentation.
886 * See &struct net_device and &struct net_device_ops for documentation
887 * of the generic netdev features interface.
889 struct ethtool_ops {
890 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
891 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
892 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
893 int (*get_regs_len)(struct net_device *);
894 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
895 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
896 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
897 u32 (*get_msglevel)(struct net_device *);
898 void (*set_msglevel)(struct net_device *, u32);
899 int (*nway_reset)(struct net_device *);
900 u32 (*get_link)(struct net_device *);
901 int (*get_eeprom_len)(struct net_device *);
902 int (*get_eeprom)(struct net_device *,
903 struct ethtool_eeprom *, u8 *);
904 int (*set_eeprom)(struct net_device *,
905 struct ethtool_eeprom *, u8 *);
906 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
907 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
908 void (*get_ringparam)(struct net_device *,
909 struct ethtool_ringparam *);
910 int (*set_ringparam)(struct net_device *,
911 struct ethtool_ringparam *);
912 void (*get_pauseparam)(struct net_device *,
913 struct ethtool_pauseparam*);
914 int (*set_pauseparam)(struct net_device *,
915 struct ethtool_pauseparam*);
916 u32 (*get_rx_csum)(struct net_device *);
917 int (*set_rx_csum)(struct net_device *, u32);
918 u32 (*get_tx_csum)(struct net_device *);
919 int (*set_tx_csum)(struct net_device *, u32);
920 u32 (*get_sg)(struct net_device *);
921 int (*set_sg)(struct net_device *, u32);
922 u32 (*get_tso)(struct net_device *);
923 int (*set_tso)(struct net_device *, u32);
924 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
925 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
926 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
927 void (*get_ethtool_stats)(struct net_device *,
928 struct ethtool_stats *, u64 *);
929 int (*begin)(struct net_device *);
930 void (*complete)(struct net_device *);
931 u32 (*get_ufo)(struct net_device *);
932 int (*set_ufo)(struct net_device *, u32);
933 u32 (*get_flags)(struct net_device *);
934 int (*set_flags)(struct net_device *, u32);
935 u32 (*get_priv_flags)(struct net_device *);
936 int (*set_priv_flags)(struct net_device *, u32);
937 int (*get_sset_count)(struct net_device *, int);
938 int (*get_rxnfc)(struct net_device *,
939 struct ethtool_rxnfc *, void *);
940 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
941 int (*flash_device)(struct net_device *, struct ethtool_flash *);
942 int (*reset)(struct net_device *, u32 *);
943 int (*set_rx_ntuple)(struct net_device *,
944 struct ethtool_rx_ntuple *);
945 int (*get_rxfh_indir)(struct net_device *,
946 struct ethtool_rxfh_indir *);
947 int (*set_rxfh_indir)(struct net_device *,
948 const struct ethtool_rxfh_indir *);
949 void (*get_channels)(struct net_device *, struct ethtool_channels *);
950 int (*set_channels)(struct net_device *, struct ethtool_channels *);
951 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
952 int (*get_dump_data)(struct net_device *,
953 struct ethtool_dump *, void *);
954 int (*set_dump)(struct net_device *, struct ethtool_dump *);
957 #endif /* __KERNEL__ */
959 /* CMDs currently supported */
960 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
961 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
962 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
963 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
964 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
965 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
966 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
967 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
968 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
969 /* Get link status for host, i.e. whether the interface *and* the
970 * physical port (if there is one) are up (ethtool_value). */
971 #define ETHTOOL_GLINK 0x0000000a
972 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
973 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
974 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
975 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
976 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
977 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
978 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
979 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
980 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
981 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
982 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
983 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
984 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
985 * (ethtool_value) */
986 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
987 * (ethtool_value). */
988 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
989 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
990 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
991 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
992 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
993 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
994 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
995 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
996 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
997 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
998 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
999 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
1000 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
1001 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
1002 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
1004 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
1005 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
1006 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
1007 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
1008 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
1009 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
1010 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
1011 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
1012 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
1013 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
1014 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
1015 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
1016 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
1017 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
1018 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
1019 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1020 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
1022 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1023 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
1024 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1025 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1026 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1027 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1028 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
1030 /* compatibility with older code */
1031 #define SPARC_ETH_GSET ETHTOOL_GSET
1032 #define SPARC_ETH_SSET ETHTOOL_SSET
1034 /* Indicates what features are supported by the interface. */
1035 #define SUPPORTED_10baseT_Half (1 << 0)
1036 #define SUPPORTED_10baseT_Full (1 << 1)
1037 #define SUPPORTED_100baseT_Half (1 << 2)
1038 #define SUPPORTED_100baseT_Full (1 << 3)
1039 #define SUPPORTED_1000baseT_Half (1 << 4)
1040 #define SUPPORTED_1000baseT_Full (1 << 5)
1041 #define SUPPORTED_Autoneg (1 << 6)
1042 #define SUPPORTED_TP (1 << 7)
1043 #define SUPPORTED_AUI (1 << 8)
1044 #define SUPPORTED_MII (1 << 9)
1045 #define SUPPORTED_FIBRE (1 << 10)
1046 #define SUPPORTED_BNC (1 << 11)
1047 #define SUPPORTED_10000baseT_Full (1 << 12)
1048 #define SUPPORTED_Pause (1 << 13)
1049 #define SUPPORTED_Asym_Pause (1 << 14)
1050 #define SUPPORTED_2500baseX_Full (1 << 15)
1051 #define SUPPORTED_Backplane (1 << 16)
1052 #define SUPPORTED_1000baseKX_Full (1 << 17)
1053 #define SUPPORTED_10000baseKX4_Full (1 << 18)
1054 #define SUPPORTED_10000baseKR_Full (1 << 19)
1055 #define SUPPORTED_10000baseR_FEC (1 << 20)
1056 #define SUPPORTED_20000baseMLD2_Full (1 << 21)
1057 #define SUPPORTED_20000baseKR2_Full (1 << 22)
1059 /* Indicates what features are advertised by the interface. */
1060 #define ADVERTISED_10baseT_Half (1 << 0)
1061 #define ADVERTISED_10baseT_Full (1 << 1)
1062 #define ADVERTISED_100baseT_Half (1 << 2)
1063 #define ADVERTISED_100baseT_Full (1 << 3)
1064 #define ADVERTISED_1000baseT_Half (1 << 4)
1065 #define ADVERTISED_1000baseT_Full (1 << 5)
1066 #define ADVERTISED_Autoneg (1 << 6)
1067 #define ADVERTISED_TP (1 << 7)
1068 #define ADVERTISED_AUI (1 << 8)
1069 #define ADVERTISED_MII (1 << 9)
1070 #define ADVERTISED_FIBRE (1 << 10)
1071 #define ADVERTISED_BNC (1 << 11)
1072 #define ADVERTISED_10000baseT_Full (1 << 12)
1073 #define ADVERTISED_Pause (1 << 13)
1074 #define ADVERTISED_Asym_Pause (1 << 14)
1075 #define ADVERTISED_2500baseX_Full (1 << 15)
1076 #define ADVERTISED_Backplane (1 << 16)
1077 #define ADVERTISED_1000baseKX_Full (1 << 17)
1078 #define ADVERTISED_10000baseKX4_Full (1 << 18)
1079 #define ADVERTISED_10000baseKR_Full (1 << 19)
1080 #define ADVERTISED_10000baseR_FEC (1 << 20)
1081 #define ADVERTISED_20000baseMLD2_Full (1 << 21)
1082 #define ADVERTISED_20000baseKR2_Full (1 << 22)
1084 /* The following are all involved in forcing a particular link
1085 * mode for the device for setting things. When getting the
1086 * devices settings, these indicate the current mode and whether
1087 * it was forced up into this mode or autonegotiated.
1090 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1091 #define SPEED_10 10
1092 #define SPEED_100 100
1093 #define SPEED_1000 1000
1094 #define SPEED_2500 2500
1095 #define SPEED_10000 10000
1097 /* Duplex, half or full. */
1098 #define DUPLEX_HALF 0x00
1099 #define DUPLEX_FULL 0x01
1101 /* Which connector port. */
1102 #define PORT_TP 0x00
1103 #define PORT_AUI 0x01
1104 #define PORT_MII 0x02
1105 #define PORT_FIBRE 0x03
1106 #define PORT_BNC 0x04
1107 #define PORT_DA 0x05
1108 #define PORT_NONE 0xef
1109 #define PORT_OTHER 0xff
1111 /* Which transceiver to use. */
1112 #define XCVR_INTERNAL 0x00
1113 #define XCVR_EXTERNAL 0x01
1114 #define XCVR_DUMMY1 0x02
1115 #define XCVR_DUMMY2 0x03
1116 #define XCVR_DUMMY3 0x04
1118 /* Enable or disable autonegotiation. If this is set to enable,
1119 * the forced link modes above are completely ignored.
1121 #define AUTONEG_DISABLE 0x00
1122 #define AUTONEG_ENABLE 0x01
1124 /* Mode MDI or MDI-X */
1125 #define ETH_TP_MDI_INVALID 0x00
1126 #define ETH_TP_MDI 0x01
1127 #define ETH_TP_MDI_X 0x02
1129 /* Wake-On-Lan options. */
1130 #define WAKE_PHY (1 << 0)
1131 #define WAKE_UCAST (1 << 1)
1132 #define WAKE_MCAST (1 << 2)
1133 #define WAKE_BCAST (1 << 3)
1134 #define WAKE_ARP (1 << 4)
1135 #define WAKE_MAGIC (1 << 5)
1136 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1138 /* L2-L4 network traffic flow types */
1139 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1140 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1141 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1142 #define AH_ESP_V4_FLOW 0x04 /* hash only */
1143 #define TCP_V6_FLOW 0x05 /* hash only */
1144 #define UDP_V6_FLOW 0x06 /* hash only */
1145 #define SCTP_V6_FLOW 0x07 /* hash only */
1146 #define AH_ESP_V6_FLOW 0x08 /* hash only */
1147 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1148 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1149 #define AH_V6_FLOW 0x0b /* hash only */
1150 #define ESP_V6_FLOW 0x0c /* hash only */
1151 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1152 #define IPV4_FLOW 0x10 /* hash only */
1153 #define IPV6_FLOW 0x11 /* hash only */
1154 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */
1155 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1156 #define FLOW_EXT 0x80000000
1158 /* L3-L4 network traffic flow hash options */
1159 #define RXH_L2DA (1 << 1)
1160 #define RXH_VLAN (1 << 2)
1161 #define RXH_L3_PROTO (1 << 3)
1162 #define RXH_IP_SRC (1 << 4)
1163 #define RXH_IP_DST (1 << 5)
1164 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1165 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1166 #define RXH_DISCARD (1 << 31)
1168 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
1170 /* Reset flags */
1171 /* The reset() operation must clear the flags for the components which
1172 * were actually reset. On successful return, the flags indicate the
1173 * components which were not reset, either because they do not exist
1174 * in the hardware or because they cannot be reset independently. The
1175 * driver must never reset any components that were not requested.
1177 enum ethtool_reset_flags {
1178 /* These flags represent components dedicated to the interface
1179 * the command is addressed to. Shift any flag left by
1180 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1181 * same type.
1183 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1184 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1185 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1186 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1187 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1188 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1189 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1190 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1191 * multiple components */
1193 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1194 * this interface */
1195 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1196 * interface, even if shared */
1198 #define ETH_RESET_SHARED_SHIFT 16
1200 #endif /* _LINUX_ETHTOOL_H */