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 _UAPI_LINUX_ETHTOOL_H
14 #define _UAPI_LINUX_ETHTOOL_H
16 #include <linux/types.h>
17 #include <linux/if_ether.h>
19 /* All structures exposed to userland should be defined such that they
20 * have the same layout for 32-bit and 64-bit userland.
24 * struct ethtool_cmd - link control and status
25 * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET
26 * @supported: Bitmask of %SUPPORTED_* flags for the link modes,
27 * physical connectors and other link features for which the
28 * interface supports autonegotiation or auto-detection.
30 * @advertising: Bitmask of %ADVERTISED_* flags for the link modes,
31 * physical connectors and other link features that are
32 * advertised through autonegotiation or enabled for
34 * @speed: Low bits of the speed
35 * @duplex: Duplex mode; one of %DUPLEX_*
36 * @port: Physical connector type; one of %PORT_*
37 * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
38 * applicable. For clause 45 PHYs this is the PRTAD.
39 * @transceiver: Historically used to distinguish different possible
40 * PHY types, but not in a consistent way. Deprecated.
41 * @autoneg: Enable/disable autonegotiation and auto-detection;
42 * either %AUTONEG_DISABLE or %AUTONEG_ENABLE
43 * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
44 * protocols supported by the interface; 0 if unknown.
46 * @maxtxpkt: Historically used to report TX IRQ coalescing; now
47 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated.
48 * @maxrxpkt: Historically used to report RX IRQ coalescing; now
49 * obsoleted by &struct ethtool_coalesce. Read-only; deprecated.
50 * @speed_hi: High bits of the speed
51 * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
52 * %ETH_TP_MDI_*. If the status is unknown or not applicable, the
53 * value will be %ETH_TP_MDI_INVALID. Read-only.
54 * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
55 * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads
56 * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
57 * When written successfully, the link should be renegotiated if
59 * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes
60 * and other link features that the link partner advertised
61 * through autonegotiation; 0 if unknown or not applicable.
64 * The link speed in Mbps is split between @speed and @speed_hi. Use
65 * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to
68 * If autonegotiation is disabled, the speed and @duplex represent the
69 * fixed link mode and are writable if the driver supports multiple
70 * link modes. If it is enabled then they are read-only; if the link
71 * is up they represent the negotiated link mode; if the link is down,
72 * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
73 * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
75 * Some hardware interfaces may have multiple PHYs and/or physical
76 * connectors fitted or do not allow the driver to detect which are
77 * fitted. For these interfaces @port and/or @phy_address may be
78 * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
79 * Otherwise, attempts to write different values may be ignored or
82 * Users should assume that all fields not marked read-only are
83 * writable and subject to validation by the driver. They should use
84 * %ETHTOOL_GSET to get the current values before making specific
85 * changes and then applying them with %ETHTOOL_SSET.
87 * Drivers that implement set_settings() should validate all fields
88 * other than @cmd that are not described as read-only or deprecated,
89 * and must ignore all fields described as read-only.
91 * Deprecated fields should be ignored by both users and drivers.
108 __u8 eth_tp_mdix_ctrl
;
109 __u32 lp_advertising
;
113 static inline void ethtool_cmd_speed_set(struct ethtool_cmd
*ep
,
117 ep
->speed
= (__u16
)speed
;
118 ep
->speed_hi
= (__u16
)(speed
>> 16);
121 static inline __u32
ethtool_cmd_speed(const struct ethtool_cmd
*ep
)
123 return (ep
->speed_hi
<< 16) | ep
->speed
;
126 /* Device supports clause 22 register access to PHY or peripherals
127 * using the interface defined in <linux/mii.h>. This should not be
128 * set if there are known to be no such peripherals present or if
129 * the driver only emulates clause 22 registers for compatibility.
131 #define ETH_MDIO_SUPPORTS_C22 1
133 /* Device supports clause 45 register access to PHY or peripherals
134 * using the interface defined in <linux/mii.h> and <linux/mdio.h>.
135 * This should not be set if there are known to be no such peripherals
138 #define ETH_MDIO_SUPPORTS_C45 2
140 #define ETHTOOL_FWVERS_LEN 32
141 #define ETHTOOL_BUSINFO_LEN 32
144 * struct ethtool_drvinfo - general driver and device information
145 * @cmd: Command number = %ETHTOOL_GDRVINFO
146 * @driver: Driver short name. This should normally match the name
147 * in its bus driver structure (e.g. pci_driver::name). Must
148 * not be an empty string.
149 * @version: Driver version string; may be an empty string
150 * @fw_version: Firmware version string; may be an empty string
151 * @bus_info: Device bus address. This should match the dev_name()
152 * string for the underlying bus device, if there is one. May be
154 * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and
155 * %ETHTOOL_SPFLAGS commands; also the number of strings in the
156 * %ETH_SS_PRIV_FLAGS set
157 * @n_stats: Number of u64 statistics returned by the %ETHTOOL_GSTATS
158 * command; also the number of strings in the %ETH_SS_STATS set
159 * @testinfo_len: Number of results returned by the %ETHTOOL_TEST
160 * command; also the number of strings in the %ETH_SS_TEST set
161 * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM
162 * and %ETHTOOL_SEEPROM commands, in bytes
163 * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS
166 * Users can use the %ETHTOOL_GSSET_INFO command to get the number of
167 * strings in any string set (from Linux 2.6.34).
169 * Drivers should set at most @driver, @version, @fw_version and
170 * @bus_info in their get_drvinfo() implementation. The ethtool
171 * core fills in the other fields using other driver operations.
173 struct ethtool_drvinfo
{
177 char fw_version
[ETHTOOL_FWVERS_LEN
];
178 char bus_info
[ETHTOOL_BUSINFO_LEN
];
191 * struct ethtool_wolinfo - Wake-On-Lan configuration
192 * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL
193 * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes.
195 * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
196 * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE
197 * is set in @wolopts.
199 struct ethtool_wolinfo
{
203 __u8 sopass
[SOPASS_MAX
];
206 /* for passing single values */
207 struct ethtool_value
{
213 * struct ethtool_regs - hardware register dump
214 * @cmd: Command number = %ETHTOOL_GREGS
215 * @version: Dump format version. This is driver-specific and may
216 * distinguish different chips/revisions. Drivers must use new
217 * version numbers whenever the dump format changes in an
219 * @len: On entry, the real length of @data. On return, the number of
221 * @data: Buffer for the register dump
223 * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
224 * a register dump for the interface. They must allocate the buffer
225 * immediately following this structure.
227 struct ethtool_regs
{
235 * struct ethtool_eeprom - EEPROM dump
236 * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or
238 * @magic: A 'magic cookie' value to guard against accidental changes.
239 * The value passed in to %ETHTOOL_SEEPROM must match the value
240 * returned by %ETHTOOL_GEEPROM for the same device. This is
241 * unused when @cmd is %ETHTOOL_GMODULEEEPROM.
242 * @offset: Offset within the EEPROM to begin reading/writing, in bytes
243 * @len: On entry, number of bytes to read/write. On successful
244 * return, number of bytes actually read/written. In case of
245 * error, this may indicate at what point the error occurred.
246 * @data: Buffer to read/write from
248 * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find
249 * the length of an on-board or module EEPROM, respectively. They
250 * must allocate the buffer immediately following this structure.
252 struct ethtool_eeprom
{
261 * struct ethtool_eee - Energy Efficient Ethernet information
262 * @cmd: ETHTOOL_{G,S}EEE
263 * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
264 * for which there is EEE support.
265 * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
266 * advertised as eee capable.
267 * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
268 * combinations advertised by the link partner as eee capable.
269 * @eee_active: Result of the eee auto negotiation.
270 * @eee_enabled: EEE configured mode (enabled/disabled).
271 * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
272 * that eee was negotiated.
273 * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
274 * its tx lpi (after reaching 'idle' state). Effective only when eee
275 * was negotiated and tx_lpi_enabled was set.
284 __u32 tx_lpi_enabled
;
290 * struct ethtool_modinfo - plugin module eeprom information
291 * @cmd: %ETHTOOL_GMODULEINFO
292 * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
293 * @eeprom_len: Length of the eeprom
295 * This structure is used to return the information to
296 * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
297 * The type code indicates the eeprom data format
299 struct ethtool_modinfo
{
307 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
308 * @cmd: ETHTOOL_{G,S}COALESCE
309 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
311 * @rx_max_coalesced_frames: Maximum number of packets to receive
312 * before an RX interrupt.
313 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
314 * this value applies while an IRQ is being serviced by the host.
315 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
316 * except that this value applies while an IRQ is being serviced
318 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
320 * @tx_max_coalesced_frames: Maximum number of packets to be sent
321 * before a TX interrupt.
322 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
323 * this value applies while an IRQ is being serviced by the host.
324 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
325 * except that this value applies while an IRQ is being serviced
327 * @stats_block_coalesce_usecs: How many usecs to delay in-memory
328 * statistics block updates. Some drivers do not have an
329 * in-memory statistic block, and in such cases this value is
330 * ignored. This value must not be zero.
331 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
332 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
333 * @pkt_rate_low: Threshold for low packet rate (packets per second).
334 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
335 * a packet arrives, when the packet rate is below @pkt_rate_low.
336 * @rx_max_coalesced_frames_low: Maximum number of packets to be received
337 * before an RX interrupt, when the packet rate is below @pkt_rate_low.
338 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
339 * a packet is sent, when the packet rate is below @pkt_rate_low.
340 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
341 * a TX interrupt, when the packet rate is below @pkt_rate_low.
342 * @pkt_rate_high: Threshold for high packet rate (packets per second).
343 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
344 * a packet arrives, when the packet rate is above @pkt_rate_high.
345 * @rx_max_coalesced_frames_high: Maximum number of packets to be received
346 * before an RX interrupt, when the packet rate is above @pkt_rate_high.
347 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
348 * a packet is sent, when the packet rate is above @pkt_rate_high.
349 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
350 * a TX interrupt, when the packet rate is above @pkt_rate_high.
351 * @rate_sample_interval: How often to do adaptive coalescing packet rate
352 * sampling, measured in seconds. Must not be zero.
354 * Each pair of (usecs, max_frames) fields specifies this exit
355 * condition for interrupt coalescing:
356 * (usecs > 0 && time_since_first_completion >= usecs) ||
357 * (max_frames > 0 && completed_frames >= max_frames)
358 * It is illegal to set both usecs and max_frames to zero as this
359 * would cause interrupts to never be generated. To disable
360 * coalescing, set usecs = 0 and max_frames = 1.
362 * Some implementations ignore the value of max_frames and use the
364 * time_since_first_completion >= usecs
365 * This is deprecated. Drivers for hardware that does not support
366 * counting completions should validate that max_frames == !rx_usecs.
368 * Adaptive RX/TX coalescing is an algorithm implemented by some
369 * drivers to improve latency under low packet rates and improve
370 * throughput under high packet rates. Some drivers only implement
371 * one of RX or TX adaptive coalescing. Anything not implemented by
372 * the driver causes these values to be silently ignored.
374 * When the packet rate is below @pkt_rate_high but above
375 * @pkt_rate_low (both measured in packets per second) the
376 * normal {rx,tx}_* coalescing parameters are used.
378 struct ethtool_coalesce
{
380 __u32 rx_coalesce_usecs
;
381 __u32 rx_max_coalesced_frames
;
382 __u32 rx_coalesce_usecs_irq
;
383 __u32 rx_max_coalesced_frames_irq
;
384 __u32 tx_coalesce_usecs
;
385 __u32 tx_max_coalesced_frames
;
386 __u32 tx_coalesce_usecs_irq
;
387 __u32 tx_max_coalesced_frames_irq
;
388 __u32 stats_block_coalesce_usecs
;
389 __u32 use_adaptive_rx_coalesce
;
390 __u32 use_adaptive_tx_coalesce
;
392 __u32 rx_coalesce_usecs_low
;
393 __u32 rx_max_coalesced_frames_low
;
394 __u32 tx_coalesce_usecs_low
;
395 __u32 tx_max_coalesced_frames_low
;
397 __u32 rx_coalesce_usecs_high
;
398 __u32 rx_max_coalesced_frames_high
;
399 __u32 tx_coalesce_usecs_high
;
400 __u32 tx_max_coalesced_frames_high
;
401 __u32 rate_sample_interval
;
404 /* for configuring RX/TX ring parameters */
405 struct ethtool_ringparam
{
406 __u32 cmd
; /* ETHTOOL_{G,S}RINGPARAM */
408 /* Read only attributes. These indicate the maximum number
409 * of pending RX/TX ring entries the driver will allow the
412 __u32 rx_max_pending
;
413 __u32 rx_mini_max_pending
;
414 __u32 rx_jumbo_max_pending
;
415 __u32 tx_max_pending
;
417 /* Values changeable by the user. The valid values are
418 * in the range 1 to the "*_max_pending" counterpart above.
421 __u32 rx_mini_pending
;
422 __u32 rx_jumbo_pending
;
427 * struct ethtool_channels - configuring number of network channel
428 * @cmd: ETHTOOL_{G,S}CHANNELS
429 * @max_rx: Read only. Maximum number of receive channel the driver support.
430 * @max_tx: Read only. Maximum number of transmit channel the driver support.
431 * @max_other: Read only. Maximum number of other channel the driver support.
432 * @max_combined: Read only. Maximum number of combined channel the driver
433 * support. Set of queues RX, TX or other.
434 * @rx_count: Valid values are in the range 1 to the max_rx.
435 * @tx_count: Valid values are in the range 1 to the max_tx.
436 * @other_count: Valid values are in the range 1 to the max_other.
437 * @combined_count: Valid values are in the range 1 to the max_combined.
439 * This can be used to configure RX, TX and other channels.
442 struct ethtool_channels
{
451 __u32 combined_count
;
454 /* for configuring link flow control parameters */
455 struct ethtool_pauseparam
{
456 __u32 cmd
; /* ETHTOOL_{G,S}PAUSEPARAM */
458 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
459 * being true) the user may set 'autoneg' here non-zero to have the
460 * pause parameters be auto-negotiated too. In such a case, the
461 * {rx,tx}_pause values below determine what capabilities are
464 * If 'autoneg' is zero or the link is not being auto-negotiated,
465 * then {rx,tx}_pause force the driver to use/not-use pause
473 #define ETH_GSTRING_LEN 32
474 enum ethtool_stringset
{
478 ETH_SS_NTUPLE_FILTERS
, /* Do not use, GRXNTUPLE is now deprecated */
482 /* for passing string sets for data tagging */
483 struct ethtool_gstrings
{
484 __u32 cmd
; /* ETHTOOL_GSTRINGS */
485 __u32 string_set
; /* string set id e.c. ETH_SS_TEST, etc*/
486 __u32 len
; /* number of strings in the string set */
490 struct ethtool_sset_info
{
491 __u32 cmd
; /* ETHTOOL_GSSET_INFO */
493 __u64 sset_mask
; /* input: each bit selects an sset to query */
494 /* output: each bit a returned sset */
495 __u32 data
[0]; /* ETH_SS_xxx count, in order, based on bits
496 in sset_mask. One bit implies one
497 __u32, two bits implies two
502 * enum ethtool_test_flags - flags definition of ethtool_test
503 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
505 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
506 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
508 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
511 enum ethtool_test_flags
{
512 ETH_TEST_FL_OFFLINE
= (1 << 0),
513 ETH_TEST_FL_FAILED
= (1 << 1),
514 ETH_TEST_FL_EXTERNAL_LB
= (1 << 2),
515 ETH_TEST_FL_EXTERNAL_LB_DONE
= (1 << 3),
518 /* for requesting NIC test and getting results*/
519 struct ethtool_test
{
520 __u32 cmd
; /* ETHTOOL_TEST */
521 __u32 flags
; /* ETH_TEST_FL_xxx */
523 __u32 len
; /* result length, in number of u64 elements */
527 /* for dumping NIC-specific statistics */
528 struct ethtool_stats
{
529 __u32 cmd
; /* ETHTOOL_GSTATS */
530 __u32 n_stats
; /* number of u64's being returned */
534 struct ethtool_perm_addr
{
535 __u32 cmd
; /* ETHTOOL_GPERMADDR */
540 /* boolean flags controlling per-interface behavior characteristics.
541 * When reading, the flag indicates whether or not a certain behavior
542 * is enabled/present. When writing, the flag indicates whether
543 * or not the driver should turn on (set) or off (clear) a behavior.
545 * Some behaviors may read-only (unconditionally absent or present).
546 * If such is the case, return EINVAL in the set-flags operation if the
547 * flag differs from the read-only value.
550 ETH_FLAG_TXVLAN
= (1 << 7), /* TX VLAN offload enabled */
551 ETH_FLAG_RXVLAN
= (1 << 8), /* RX VLAN offload enabled */
552 ETH_FLAG_LRO
= (1 << 15), /* LRO is enabled */
553 ETH_FLAG_NTUPLE
= (1 << 27), /* N-tuple filters enabled */
554 ETH_FLAG_RXHASH
= (1 << 28),
557 /* The following structures are for supporting RX network flow
558 * classification and RX n-tuple configuration. Note, all multibyte
559 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
560 * be in network byte order.
564 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
565 * @ip4src: Source host
566 * @ip4dst: Destination host
568 * @pdst: Destination port
569 * @tos: Type-of-service
571 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
573 struct ethtool_tcpip4_spec
{
582 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
583 * @ip4src: Source host
584 * @ip4dst: Destination host
585 * @spi: Security parameters index
586 * @tos: Type-of-service
588 * This can be used to specify an IPsec transport or tunnel over IPv4.
590 struct ethtool_ah_espip4_spec
{
597 #define ETH_RX_NFC_IP4 1
600 * struct ethtool_usrip4_spec - general flow specification for IPv4
601 * @ip4src: Source host
602 * @ip4dst: Destination host
603 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
604 * @tos: Type-of-service
605 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
606 * @proto: Transport protocol number; mask must be 0
608 struct ethtool_usrip4_spec
{
617 union ethtool_flow_union
{
618 struct ethtool_tcpip4_spec tcp_ip4_spec
;
619 struct ethtool_tcpip4_spec udp_ip4_spec
;
620 struct ethtool_tcpip4_spec sctp_ip4_spec
;
621 struct ethtool_ah_espip4_spec ah_ip4_spec
;
622 struct ethtool_ah_espip4_spec esp_ip4_spec
;
623 struct ethtool_usrip4_spec usr_ip4_spec
;
624 struct ethhdr ether_spec
;
629 * struct ethtool_flow_ext - additional RX flow fields
630 * @h_dest: destination MAC address
631 * @vlan_etype: VLAN EtherType
632 * @vlan_tci: VLAN tag control information
633 * @data: user defined data
635 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
636 * is set in &struct ethtool_rx_flow_spec @flow_type.
637 * @h_dest is valid if %FLOW_MAC_EXT is set.
639 struct ethtool_flow_ext
{
641 unsigned char h_dest
[ETH_ALEN
];
648 * struct ethtool_rx_flow_spec - classification rule for RX flows
649 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
650 * @h_u: Flow fields to match (dependent on @flow_type)
651 * @h_ext: Additional fields to match
652 * @m_u: Masks for flow field bits to be matched
653 * @m_ext: Masks for additional field bits to be matched
654 * Note, all additional fields must be ignored unless @flow_type
655 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag
656 * (see &struct ethtool_flow_ext description).
657 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
658 * if packets should be discarded
659 * @location: Location of rule in the table. Locations must be
660 * numbered such that a flow matching multiple rules will be
661 * classified according to the first (lowest numbered) rule.
663 struct ethtool_rx_flow_spec
{
665 union ethtool_flow_union h_u
;
666 struct ethtool_flow_ext h_ext
;
667 union ethtool_flow_union m_u
;
668 struct ethtool_flow_ext m_ext
;
674 * struct ethtool_rxnfc - command to get or set RX flow classification rules
675 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
676 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
677 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
678 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
679 * @data: Command-dependent value
680 * @fs: Flow classification rule
681 * @rule_cnt: Number of rules to be affected
682 * @rule_locs: Array of used rule locations
684 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
685 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
686 * structure fields must not be used.
688 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
691 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
692 * rules on return. If @data is non-zero on return then it is the
693 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
694 * driver supports any special location values. If that flag is not
695 * set in @data then special location values should not be used.
697 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
698 * existing rule on entry and @fs contains the rule on return.
700 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
701 * user buffer for @rule_locs on entry. On return, @data is the size
702 * of the rule table, @rule_cnt is the number of defined rules, and
703 * @rule_locs contains the locations of the defined rules. Drivers
704 * must use the second parameter to get_rxnfc() instead of @rule_locs.
706 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
707 * @fs.@location either specifies the location to use or is a special
708 * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
709 * @fs.@location is the actual rule location.
711 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
712 * existing rule on entry.
714 * A driver supporting the special location values for
715 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
716 * location, and may remove a rule at a later location (lower
717 * priority) that matches exactly the same set of flows. The special
718 * values are: %RX_CLS_LOC_ANY, selecting any location;
719 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
720 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
721 * location (minimum priority). Additional special values may be
722 * defined in future and drivers must return -%EINVAL for any
723 * unrecognised value.
725 struct ethtool_rxnfc
{
729 struct ethtool_rx_flow_spec fs
;
736 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
737 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
738 * @size: On entry, the array size of the user buffer, which may be zero.
739 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
741 * @ring_index: RX ring/queue index for each hash value
743 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
744 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
745 * the table should be reset to default values. This last feature
746 * is not supported by the original implementations.
748 struct ethtool_rxfh_indir
{
755 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
756 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
757 * @h_u: Flow field values to match (dependent on @flow_type)
758 * @m_u: Masks for flow field value bits to be ignored
759 * @vlan_tag: VLAN tag to match
760 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
761 * @data: Driver-dependent data to match
762 * @data_mask: Mask for driver-dependent data bits to be ignored
763 * @action: RX ring/queue index to deliver to (non-negative) or other action
764 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
766 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
767 * a field value and mask are both zero this is treated as if all mask
768 * bits are set i.e. the field is ignored.
770 struct ethtool_rx_ntuple_flow_spec
{
773 struct ethtool_tcpip4_spec tcp_ip4_spec
;
774 struct ethtool_tcpip4_spec udp_ip4_spec
;
775 struct ethtool_tcpip4_spec sctp_ip4_spec
;
776 struct ethtool_ah_espip4_spec ah_ip4_spec
;
777 struct ethtool_ah_espip4_spec esp_ip4_spec
;
778 struct ethtool_usrip4_spec usr_ip4_spec
;
779 struct ethhdr ether_spec
;
789 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
790 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
794 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
795 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
796 * @fs: Flow filter specification
798 struct ethtool_rx_ntuple
{
800 struct ethtool_rx_ntuple_flow_spec fs
;
803 #define ETHTOOL_FLASH_MAX_FILENAME 128
804 enum ethtool_flash_op_type
{
805 ETHTOOL_FLASH_ALL_REGIONS
= 0,
808 /* for passing firmware flashing related parameters */
809 struct ethtool_flash
{
812 char data
[ETHTOOL_FLASH_MAX_FILENAME
];
816 * struct ethtool_dump - used for retrieving, setting device dump
817 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
819 * @version: FW version of the dump, filled in by driver
820 * @flag: driver dependent flag for dump setting, filled in by driver during
821 * get and filled in by ethtool for set operation.
822 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
823 * firmware dump is disabled.
824 * @len: length of dump data, used as the length of the user buffer on entry to
825 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
826 * for %ETHTOOL_GET_DUMP_FLAG command
827 * @data: data collected for get dump data operation
830 #define ETH_FW_DUMP_DISABLE 0
832 struct ethtool_dump
{
840 /* for returning and changing feature sets */
843 * struct ethtool_get_features_block - block with state of 32 features
844 * @available: mask of changeable features
845 * @requested: mask of features requested to be enabled if possible
846 * @active: mask of currently enabled features
847 * @never_changed: mask of features not changeable for any device
849 struct ethtool_get_features_block
{
857 * struct ethtool_gfeatures - command to get state of device's features
858 * @cmd: command number = %ETHTOOL_GFEATURES
859 * @size: in: number of elements in the features[] array;
860 * out: number of elements in features[] needed to hold all features
861 * @features: state of features
863 struct ethtool_gfeatures
{
866 struct ethtool_get_features_block features
[0];
870 * struct ethtool_set_features_block - block with request for 32 features
871 * @valid: mask of features to be changed
872 * @requested: values of features to be changed
874 struct ethtool_set_features_block
{
880 * struct ethtool_sfeatures - command to request change in device's features
881 * @cmd: command number = %ETHTOOL_SFEATURES
882 * @size: array size of the features[] array
883 * @features: feature change masks
885 struct ethtool_sfeatures
{
888 struct ethtool_set_features_block features
[0];
892 * struct ethtool_ts_info - holds a device's timestamping and PHC association
893 * @cmd: command number = %ETHTOOL_GET_TS_INFO
894 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
895 * @phc_index: device index of the associated PHC, or -1 if there is none
896 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
897 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
899 * The bits in the 'tx_types' and 'rx_filters' fields correspond to
900 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
901 * respectively. For example, if the device supports HWTSTAMP_TX_ON,
902 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
904 struct ethtool_ts_info
{
906 __u32 so_timestamping
;
909 __u32 tx_reserved
[3];
911 __u32 rx_reserved
[3];
915 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
916 * values of corresponding bits in features[].requested. Bits in .requested
917 * not set in .valid or not changeable are ignored.
919 * Returns %EINVAL when .valid contains undefined or never-changeable bits
920 * or size is not equal to required number of features words (32-bit blocks).
921 * Returns >= 0 if request was completed; bits set in the value mean:
922 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
923 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
924 * those bits were ignored.
925 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
926 * resulting state of bits masked by .valid is not equal to .requested.
927 * Probably there are other device-specific constraints on some features
928 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
929 * here as though ignored bits were cleared.
930 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
931 * compatibility functions. Requested offload state cannot be properly
934 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
935 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
936 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
937 * significant bit in features[0] fields. Empty strings mark undefined features.
939 enum ethtool_sfeatures_retval_bits
{
940 ETHTOOL_F_UNSUPPORTED__BIT
,
942 ETHTOOL_F_COMPAT__BIT
,
945 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
946 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
947 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
950 /* CMDs currently supported */
951 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
952 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
953 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
954 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
955 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
956 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
957 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
958 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
959 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
960 /* Get link status for host, i.e. whether the interface *and* the
961 * physical port (if there is one) are up (ethtool_value). */
962 #define ETHTOOL_GLINK 0x0000000a
963 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
964 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
965 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
966 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
967 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
968 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
969 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
970 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
971 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
972 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
973 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
974 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
975 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
977 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
978 * (ethtool_value). */
979 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
980 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
981 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
982 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
983 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
984 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
985 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
986 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
987 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
988 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
989 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
990 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
991 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
992 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
993 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
995 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
996 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
997 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
998 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
999 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
1000 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
1001 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
1002 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
1003 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
1004 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
1005 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
1006 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
1007 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
1008 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
1009 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
1010 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1011 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
1013 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1014 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
1015 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1016 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1017 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1018 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1019 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
1020 #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
1021 #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */
1022 #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */
1023 #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */
1024 #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */
1026 /* compatibility with older code */
1027 #define SPARC_ETH_GSET ETHTOOL_GSET
1028 #define SPARC_ETH_SSET ETHTOOL_SSET
1030 #define SUPPORTED_10baseT_Half (1 << 0)
1031 #define SUPPORTED_10baseT_Full (1 << 1)
1032 #define SUPPORTED_100baseT_Half (1 << 2)
1033 #define SUPPORTED_100baseT_Full (1 << 3)
1034 #define SUPPORTED_1000baseT_Half (1 << 4)
1035 #define SUPPORTED_1000baseT_Full (1 << 5)
1036 #define SUPPORTED_Autoneg (1 << 6)
1037 #define SUPPORTED_TP (1 << 7)
1038 #define SUPPORTED_AUI (1 << 8)
1039 #define SUPPORTED_MII (1 << 9)
1040 #define SUPPORTED_FIBRE (1 << 10)
1041 #define SUPPORTED_BNC (1 << 11)
1042 #define SUPPORTED_10000baseT_Full (1 << 12)
1043 #define SUPPORTED_Pause (1 << 13)
1044 #define SUPPORTED_Asym_Pause (1 << 14)
1045 #define SUPPORTED_2500baseX_Full (1 << 15)
1046 #define SUPPORTED_Backplane (1 << 16)
1047 #define SUPPORTED_1000baseKX_Full (1 << 17)
1048 #define SUPPORTED_10000baseKX4_Full (1 << 18)
1049 #define SUPPORTED_10000baseKR_Full (1 << 19)
1050 #define SUPPORTED_10000baseR_FEC (1 << 20)
1051 #define SUPPORTED_20000baseMLD2_Full (1 << 21)
1052 #define SUPPORTED_20000baseKR2_Full (1 << 22)
1053 #define SUPPORTED_40000baseKR4_Full (1 << 23)
1054 #define SUPPORTED_40000baseCR4_Full (1 << 24)
1055 #define SUPPORTED_40000baseSR4_Full (1 << 25)
1056 #define SUPPORTED_40000baseLR4_Full (1 << 26)
1058 #define ADVERTISED_10baseT_Half (1 << 0)
1059 #define ADVERTISED_10baseT_Full (1 << 1)
1060 #define ADVERTISED_100baseT_Half (1 << 2)
1061 #define ADVERTISED_100baseT_Full (1 << 3)
1062 #define ADVERTISED_1000baseT_Half (1 << 4)
1063 #define ADVERTISED_1000baseT_Full (1 << 5)
1064 #define ADVERTISED_Autoneg (1 << 6)
1065 #define ADVERTISED_TP (1 << 7)
1066 #define ADVERTISED_AUI (1 << 8)
1067 #define ADVERTISED_MII (1 << 9)
1068 #define ADVERTISED_FIBRE (1 << 10)
1069 #define ADVERTISED_BNC (1 << 11)
1070 #define ADVERTISED_10000baseT_Full (1 << 12)
1071 #define ADVERTISED_Pause (1 << 13)
1072 #define ADVERTISED_Asym_Pause (1 << 14)
1073 #define ADVERTISED_2500baseX_Full (1 << 15)
1074 #define ADVERTISED_Backplane (1 << 16)
1075 #define ADVERTISED_1000baseKX_Full (1 << 17)
1076 #define ADVERTISED_10000baseKX4_Full (1 << 18)
1077 #define ADVERTISED_10000baseKR_Full (1 << 19)
1078 #define ADVERTISED_10000baseR_FEC (1 << 20)
1079 #define ADVERTISED_20000baseMLD2_Full (1 << 21)
1080 #define ADVERTISED_20000baseKR2_Full (1 << 22)
1081 #define ADVERTISED_40000baseKR4_Full (1 << 23)
1082 #define ADVERTISED_40000baseCR4_Full (1 << 24)
1083 #define ADVERTISED_40000baseSR4_Full (1 << 25)
1084 #define ADVERTISED_40000baseLR4_Full (1 << 26)
1086 /* The following are all involved in forcing a particular link
1087 * mode for the device for setting things. When getting the
1088 * devices settings, these indicate the current mode and whether
1089 * it was forced up into this mode or autonegotiated.
1092 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1094 #define SPEED_100 100
1095 #define SPEED_1000 1000
1096 #define SPEED_2500 2500
1097 #define SPEED_10000 10000
1098 #define SPEED_UNKNOWN -1
1100 /* Duplex, half or full. */
1101 #define DUPLEX_HALF 0x00
1102 #define DUPLEX_FULL 0x01
1103 #define DUPLEX_UNKNOWN 0xff
1105 /* Which connector port. */
1106 #define PORT_TP 0x00
1107 #define PORT_AUI 0x01
1108 #define PORT_MII 0x02
1109 #define PORT_FIBRE 0x03
1110 #define PORT_BNC 0x04
1111 #define PORT_DA 0x05
1112 #define PORT_NONE 0xef
1113 #define PORT_OTHER 0xff
1115 /* Which transceiver to use. */
1116 #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */
1117 #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */
1118 #define XCVR_DUMMY1 0x02
1119 #define XCVR_DUMMY2 0x03
1120 #define XCVR_DUMMY3 0x04
1122 /* Enable or disable autonegotiation. */
1123 #define AUTONEG_DISABLE 0x00
1124 #define AUTONEG_ENABLE 0x01
1126 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
1127 * the driver is required to renegotiate link
1129 #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */
1130 #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */
1131 #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */
1132 #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */
1134 /* Wake-On-Lan options. */
1135 #define WAKE_PHY (1 << 0)
1136 #define WAKE_UCAST (1 << 1)
1137 #define WAKE_MCAST (1 << 2)
1138 #define WAKE_BCAST (1 << 3)
1139 #define WAKE_ARP (1 << 4)
1140 #define WAKE_MAGIC (1 << 5)
1141 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1143 /* L2-L4 network traffic flow types */
1144 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1145 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1146 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1147 #define AH_ESP_V4_FLOW 0x04 /* hash only */
1148 #define TCP_V6_FLOW 0x05 /* hash only */
1149 #define UDP_V6_FLOW 0x06 /* hash only */
1150 #define SCTP_V6_FLOW 0x07 /* hash only */
1151 #define AH_ESP_V6_FLOW 0x08 /* hash only */
1152 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1153 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1154 #define AH_V6_FLOW 0x0b /* hash only */
1155 #define ESP_V6_FLOW 0x0c /* hash only */
1156 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1157 #define IPV4_FLOW 0x10 /* hash only */
1158 #define IPV6_FLOW 0x11 /* hash only */
1159 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */
1160 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1161 #define FLOW_EXT 0x80000000
1162 #define FLOW_MAC_EXT 0x40000000
1164 /* L3-L4 network traffic flow hash options */
1165 #define RXH_L2DA (1 << 1)
1166 #define RXH_VLAN (1 << 2)
1167 #define RXH_L3_PROTO (1 << 3)
1168 #define RXH_IP_SRC (1 << 4)
1169 #define RXH_IP_DST (1 << 5)
1170 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1171 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1172 #define RXH_DISCARD (1 << 31)
1174 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
1176 /* Special RX classification rule insert location values */
1177 #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
1178 #define RX_CLS_LOC_ANY 0xffffffff
1179 #define RX_CLS_LOC_FIRST 0xfffffffe
1180 #define RX_CLS_LOC_LAST 0xfffffffd
1182 /* EEPROM Standards for plug in modules */
1183 #define ETH_MODULE_SFF_8079 0x1
1184 #define ETH_MODULE_SFF_8079_LEN 256
1185 #define ETH_MODULE_SFF_8472 0x2
1186 #define ETH_MODULE_SFF_8472_LEN 512
1189 /* The reset() operation must clear the flags for the components which
1190 * were actually reset. On successful return, the flags indicate the
1191 * components which were not reset, either because they do not exist
1192 * in the hardware or because they cannot be reset independently. The
1193 * driver must never reset any components that were not requested.
1195 enum ethtool_reset_flags
{
1196 /* These flags represent components dedicated to the interface
1197 * the command is addressed to. Shift any flag left by
1198 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1201 ETH_RESET_MGMT
= 1 << 0, /* Management processor */
1202 ETH_RESET_IRQ
= 1 << 1, /* Interrupt requester */
1203 ETH_RESET_DMA
= 1 << 2, /* DMA engine */
1204 ETH_RESET_FILTER
= 1 << 3, /* Filtering/flow direction */
1205 ETH_RESET_OFFLOAD
= 1 << 4, /* Protocol offload */
1206 ETH_RESET_MAC
= 1 << 5, /* Media access controller */
1207 ETH_RESET_PHY
= 1 << 6, /* Transceiver/PHY */
1208 ETH_RESET_RAM
= 1 << 7, /* RAM shared between
1209 * multiple components */
1211 ETH_RESET_DEDICATED
= 0x0000ffff, /* All components dedicated to
1213 ETH_RESET_ALL
= 0xffffffff, /* All components used by this
1214 * interface, even if shared */
1216 #define ETH_RESET_SHARED_SHIFT 16
1218 #endif /* _UAPI_LINUX_ETHTOOL_H */