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
142 #define ETHTOOL_EROMVERS_LEN 32
145 * struct ethtool_drvinfo - general driver and device information
146 * @cmd: Command number = %ETHTOOL_GDRVINFO
147 * @driver: Driver short name. This should normally match the name
148 * in its bus driver structure (e.g. pci_driver::name). Must
149 * not be an empty string.
150 * @version: Driver version string; may be an empty string
151 * @fw_version: Firmware version string; may be an empty string
152 * @erom_version: Expansion ROM version string; may be an empty string
153 * @bus_info: Device bus address. This should match the dev_name()
154 * string for the underlying bus device, if there is one. May be
156 * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and
157 * %ETHTOOL_SPFLAGS commands; also the number of strings in the
158 * %ETH_SS_PRIV_FLAGS set
159 * @n_stats: Number of u64 statistics returned by the %ETHTOOL_GSTATS
160 * command; also the number of strings in the %ETH_SS_STATS set
161 * @testinfo_len: Number of results returned by the %ETHTOOL_TEST
162 * command; also the number of strings in the %ETH_SS_TEST set
163 * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM
164 * and %ETHTOOL_SEEPROM commands, in bytes
165 * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS
168 * Users can use the %ETHTOOL_GSSET_INFO command to get the number of
169 * strings in any string set (from Linux 2.6.34).
171 * Drivers should set at most @driver, @version, @fw_version and
172 * @bus_info in their get_drvinfo() implementation. The ethtool
173 * core fills in the other fields using other driver operations.
175 struct ethtool_drvinfo {
179 char fw_version[ETHTOOL_FWVERS_LEN];
180 char bus_info[ETHTOOL_BUSINFO_LEN];
181 char erom_version[ETHTOOL_EROMVERS_LEN];
193 * struct ethtool_wolinfo - Wake-On-Lan configuration
194 * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL
195 * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes.
197 * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
198 * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE
199 * is set in @wolopts.
201 struct ethtool_wolinfo {
205 __u8 sopass[SOPASS_MAX];
208 /* for passing single values */
209 struct ethtool_value {
216 ETHTOOL_RX_COPYBREAK,
217 ETHTOOL_TX_COPYBREAK,
220 enum tunable_type_id {
221 ETHTOOL_TUNABLE_UNSPEC,
226 ETHTOOL_TUNABLE_STRING,
233 struct ethtool_tunable {
242 * struct ethtool_regs - hardware register dump
243 * @cmd: Command number = %ETHTOOL_GREGS
244 * @version: Dump format version. This is driver-specific and may
245 * distinguish different chips/revisions. Drivers must use new
246 * version numbers whenever the dump format changes in an
248 * @len: On entry, the real length of @data. On return, the number of
250 * @data: Buffer for the register dump
252 * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
253 * a register dump for the interface. They must allocate the buffer
254 * immediately following this structure.
256 struct ethtool_regs {
264 * struct ethtool_eeprom - EEPROM dump
265 * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or
267 * @magic: A 'magic cookie' value to guard against accidental changes.
268 * The value passed in to %ETHTOOL_SEEPROM must match the value
269 * returned by %ETHTOOL_GEEPROM for the same device. This is
270 * unused when @cmd is %ETHTOOL_GMODULEEEPROM.
271 * @offset: Offset within the EEPROM to begin reading/writing, in bytes
272 * @len: On entry, number of bytes to read/write. On successful
273 * return, number of bytes actually read/written. In case of
274 * error, this may indicate at what point the error occurred.
275 * @data: Buffer to read/write from
277 * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find
278 * the length of an on-board or module EEPROM, respectively. They
279 * must allocate the buffer immediately following this structure.
281 struct ethtool_eeprom {
290 * struct ethtool_eee - Energy Efficient Ethernet information
291 * @cmd: ETHTOOL_{G,S}EEE
292 * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
293 * for which there is EEE support.
294 * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
295 * advertised as eee capable.
296 * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
297 * combinations advertised by the link partner as eee capable.
298 * @eee_active: Result of the eee auto negotiation.
299 * @eee_enabled: EEE configured mode (enabled/disabled).
300 * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
301 * that eee was negotiated.
302 * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
303 * its tx lpi (after reaching 'idle' state). Effective only when eee
304 * was negotiated and tx_lpi_enabled was set.
313 __u32 tx_lpi_enabled;
319 * struct ethtool_modinfo - plugin module eeprom information
320 * @cmd: %ETHTOOL_GMODULEINFO
321 * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
322 * @eeprom_len: Length of the eeprom
324 * This structure is used to return the information to
325 * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
326 * The type code indicates the eeprom data format
328 struct ethtool_modinfo {
336 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
337 * @cmd: ETHTOOL_{G,S}COALESCE
338 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
340 * @rx_max_coalesced_frames: Maximum number of packets to receive
341 * before an RX interrupt.
342 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
343 * this value applies while an IRQ is being serviced by the host.
344 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
345 * except that this value applies while an IRQ is being serviced
347 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
349 * @tx_max_coalesced_frames: Maximum number of packets to be sent
350 * before a TX interrupt.
351 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
352 * this value applies while an IRQ is being serviced by the host.
353 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
354 * except that this value applies while an IRQ is being serviced
356 * @stats_block_coalesce_usecs: How many usecs to delay in-memory
357 * statistics block updates. Some drivers do not have an
358 * in-memory statistic block, and in such cases this value is
359 * ignored. This value must not be zero.
360 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
361 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
362 * @pkt_rate_low: Threshold for low packet rate (packets per second).
363 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
364 * a packet arrives, when the packet rate is below @pkt_rate_low.
365 * @rx_max_coalesced_frames_low: Maximum number of packets to be received
366 * before an RX interrupt, when the packet rate is below @pkt_rate_low.
367 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
368 * a packet is sent, when the packet rate is below @pkt_rate_low.
369 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
370 * a TX interrupt, when the packet rate is below @pkt_rate_low.
371 * @pkt_rate_high: Threshold for high packet rate (packets per second).
372 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
373 * a packet arrives, when the packet rate is above @pkt_rate_high.
374 * @rx_max_coalesced_frames_high: Maximum number of packets to be received
375 * before an RX interrupt, when the packet rate is above @pkt_rate_high.
376 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
377 * a packet is sent, when the packet rate is above @pkt_rate_high.
378 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
379 * a TX interrupt, when the packet rate is above @pkt_rate_high.
380 * @rate_sample_interval: How often to do adaptive coalescing packet rate
381 * sampling, measured in seconds. Must not be zero.
383 * Each pair of (usecs, max_frames) fields specifies that interrupts
384 * should be coalesced until
385 * (usecs > 0 && time_since_first_completion >= usecs) ||
386 * (max_frames > 0 && completed_frames >= max_frames)
388 * It is illegal to set both usecs and max_frames to zero as this
389 * would cause interrupts to never be generated. To disable
390 * coalescing, set usecs = 0 and max_frames = 1.
392 * Some implementations ignore the value of max_frames and use the
393 * condition time_since_first_completion >= usecs
395 * This is deprecated. Drivers for hardware that does not support
396 * counting completions should validate that max_frames == !rx_usecs.
398 * Adaptive RX/TX coalescing is an algorithm implemented by some
399 * drivers to improve latency under low packet rates and improve
400 * throughput under high packet rates. Some drivers only implement
401 * one of RX or TX adaptive coalescing. Anything not implemented by
402 * the driver causes these values to be silently ignored.
404 * When the packet rate is below @pkt_rate_high but above
405 * @pkt_rate_low (both measured in packets per second) the
406 * normal {rx,tx}_* coalescing parameters are used.
408 struct ethtool_coalesce {
410 __u32 rx_coalesce_usecs;
411 __u32 rx_max_coalesced_frames;
412 __u32 rx_coalesce_usecs_irq;
413 __u32 rx_max_coalesced_frames_irq;
414 __u32 tx_coalesce_usecs;
415 __u32 tx_max_coalesced_frames;
416 __u32 tx_coalesce_usecs_irq;
417 __u32 tx_max_coalesced_frames_irq;
418 __u32 stats_block_coalesce_usecs;
419 __u32 use_adaptive_rx_coalesce;
420 __u32 use_adaptive_tx_coalesce;
422 __u32 rx_coalesce_usecs_low;
423 __u32 rx_max_coalesced_frames_low;
424 __u32 tx_coalesce_usecs_low;
425 __u32 tx_max_coalesced_frames_low;
427 __u32 rx_coalesce_usecs_high;
428 __u32 rx_max_coalesced_frames_high;
429 __u32 tx_coalesce_usecs_high;
430 __u32 tx_max_coalesced_frames_high;
431 __u32 rate_sample_interval;
435 * struct ethtool_ringparam - RX/TX ring parameters
436 * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM
437 * @rx_max_pending: Maximum supported number of pending entries per
438 * RX ring. Read-only.
439 * @rx_mini_max_pending: Maximum supported number of pending entries
440 * per RX mini ring. Read-only.
441 * @rx_jumbo_max_pending: Maximum supported number of pending entries
442 * per RX jumbo ring. Read-only.
443 * @tx_max_pending: Maximum supported number of pending entries per
444 * TX ring. Read-only.
445 * @rx_pending: Current maximum number of pending entries per RX ring
446 * @rx_mini_pending: Current maximum number of pending entries per RX
448 * @rx_jumbo_pending: Current maximum number of pending entries per RX
450 * @tx_pending: Current maximum supported number of pending entries
453 * If the interface does not have separate RX mini and/or jumbo rings,
454 * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0.
456 * There may also be driver-dependent minimum values for the number
457 * of entries per ring.
459 struct ethtool_ringparam {
461 __u32 rx_max_pending;
462 __u32 rx_mini_max_pending;
463 __u32 rx_jumbo_max_pending;
464 __u32 tx_max_pending;
466 __u32 rx_mini_pending;
467 __u32 rx_jumbo_pending;
472 * struct ethtool_channels - configuring number of network channel
473 * @cmd: ETHTOOL_{G,S}CHANNELS
474 * @max_rx: Read only. Maximum number of receive channel the driver support.
475 * @max_tx: Read only. Maximum number of transmit channel the driver support.
476 * @max_other: Read only. Maximum number of other channel the driver support.
477 * @max_combined: Read only. Maximum number of combined channel the driver
478 * support. Set of queues RX, TX or other.
479 * @rx_count: Valid values are in the range 1 to the max_rx.
480 * @tx_count: Valid values are in the range 1 to the max_tx.
481 * @other_count: Valid values are in the range 1 to the max_other.
482 * @combined_count: Valid values are in the range 1 to the max_combined.
484 * This can be used to configure RX, TX and other channels.
487 struct ethtool_channels {
496 __u32 combined_count;
500 * struct ethtool_pauseparam - Ethernet pause (flow control) parameters
501 * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM
502 * @autoneg: Flag to enable autonegotiation of pause frame use
503 * @rx_pause: Flag to enable reception of pause frames
504 * @tx_pause: Flag to enable transmission of pause frames
506 * Drivers should reject a non-zero setting of @autoneg when
507 * autoneogotiation is disabled (or not supported) for the link.
509 * If the link is autonegotiated, drivers should use
510 * mii_advertise_flowctrl() or similar code to set the advertised
511 * pause frame capabilities based on the @rx_pause and @tx_pause flags,
512 * even if @autoneg is zero. They should also allow the advertised
513 * pause frame capabilities to be controlled directly through the
514 * advertising field of &struct ethtool_cmd.
516 * If @autoneg is non-zero, the MAC is configured to send and/or
517 * receive pause frames according to the result of autonegotiation.
518 * Otherwise, it is configured directly based on the @rx_pause and
521 struct ethtool_pauseparam {
528 #define ETH_GSTRING_LEN 32
531 * enum ethtool_stringset - string set ID
532 * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST
533 * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS
534 * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with
535 * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS
536 * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE;
538 * @ETH_SS_FEATURES: Device feature names
539 * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names
541 enum ethtool_stringset {
545 ETH_SS_NTUPLE_FILTERS,
547 ETH_SS_RSS_HASH_FUNCS,
551 * struct ethtool_gstrings - string set for data tagging
552 * @cmd: Command number = %ETHTOOL_GSTRINGS
553 * @string_set: String set ID; one of &enum ethtool_stringset
554 * @len: On return, the number of strings in the string set
555 * @data: Buffer for strings. Each string is null-padded to a size of
558 * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in
559 * the string set. They must allocate a buffer of the appropriate
560 * size immediately following this structure.
562 struct ethtool_gstrings {
570 * struct ethtool_sset_info - string set information
571 * @cmd: Command number = %ETHTOOL_GSSET_INFO
572 * @sset_mask: On entry, a bitmask of string sets to query, with bits
573 * numbered according to &enum ethtool_stringset. On return, a
574 * bitmask of those string sets queried that are supported.
575 * @data: Buffer for string set sizes. On return, this contains the
576 * size of each string set that was queried and supported, in
579 * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on
580 * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the
581 * size of set 1 and @data[1] contains the size of set 2.
583 * Users must allocate a buffer of the appropriate size (4 * number of
584 * sets queried) immediately following this structure.
586 struct ethtool_sset_info {
594 * enum ethtool_test_flags - flags definition of ethtool_test
595 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
597 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
598 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
600 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
603 enum ethtool_test_flags {
604 ETH_TEST_FL_OFFLINE = (1 << 0),
605 ETH_TEST_FL_FAILED = (1 << 1),
606 ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
607 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
611 * struct ethtool_test - device self-test invocation
612 * @cmd: Command number = %ETHTOOL_TEST
613 * @flags: A bitmask of flags from &enum ethtool_test_flags. Some
614 * flags may be set by the user on entry; others may be set by
615 * the driver on return.
616 * @len: On return, the number of test results
617 * @data: Array of test results
619 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
620 * number of test results that will be returned. They must allocate a
621 * buffer of the appropriate size (8 * number of results) immediately
622 * following this structure.
624 struct ethtool_test {
633 * struct ethtool_stats - device-specific statistics
634 * @cmd: Command number = %ETHTOOL_GSTATS
635 * @n_stats: On return, the number of statistics
636 * @data: Array of statistics
638 * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
639 * number of statistics that will be returned. They must allocate a
640 * buffer of the appropriate size (8 * number of statistics)
641 * immediately following this structure.
643 struct ethtool_stats {
650 * struct ethtool_perm_addr - permanent hardware address
651 * @cmd: Command number = %ETHTOOL_GPERMADDR
652 * @size: On entry, the size of the buffer. On return, the size of the
653 * address. The command fails if the buffer is too small.
654 * @data: Buffer for the address
656 * Users must allocate the buffer immediately following this structure.
657 * A buffer size of %MAX_ADDR_LEN should be sufficient for any address
660 struct ethtool_perm_addr {
666 /* boolean flags controlling per-interface behavior characteristics.
667 * When reading, the flag indicates whether or not a certain behavior
668 * is enabled/present. When writing, the flag indicates whether
669 * or not the driver should turn on (set) or off (clear) a behavior.
671 * Some behaviors may read-only (unconditionally absent or present).
672 * If such is the case, return EINVAL in the set-flags operation if the
673 * flag differs from the read-only value.
676 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
677 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
678 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
679 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
680 ETH_FLAG_RXHASH = (1 << 28),
683 /* The following structures are for supporting RX network flow
684 * classification and RX n-tuple configuration. Note, all multibyte
685 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
686 * be in network byte order.
690 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
691 * @ip4src: Source host
692 * @ip4dst: Destination host
694 * @pdst: Destination port
695 * @tos: Type-of-service
697 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
699 struct ethtool_tcpip4_spec {
708 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
709 * @ip4src: Source host
710 * @ip4dst: Destination host
711 * @spi: Security parameters index
712 * @tos: Type-of-service
714 * This can be used to specify an IPsec transport or tunnel over IPv4.
716 struct ethtool_ah_espip4_spec {
723 #define ETH_RX_NFC_IP4 1
726 * struct ethtool_usrip4_spec - general flow specification for IPv4
727 * @ip4src: Source host
728 * @ip4dst: Destination host
729 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
730 * @tos: Type-of-service
731 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
732 * @proto: Transport protocol number; mask must be 0
734 struct ethtool_usrip4_spec {
743 union ethtool_flow_union {
744 struct ethtool_tcpip4_spec tcp_ip4_spec;
745 struct ethtool_tcpip4_spec udp_ip4_spec;
746 struct ethtool_tcpip4_spec sctp_ip4_spec;
747 struct ethtool_ah_espip4_spec ah_ip4_spec;
748 struct ethtool_ah_espip4_spec esp_ip4_spec;
749 struct ethtool_usrip4_spec usr_ip4_spec;
750 struct ethhdr ether_spec;
755 * struct ethtool_flow_ext - additional RX flow fields
756 * @h_dest: destination MAC address
757 * @vlan_etype: VLAN EtherType
758 * @vlan_tci: VLAN tag control information
759 * @data: user defined data
761 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
762 * is set in &struct ethtool_rx_flow_spec @flow_type.
763 * @h_dest is valid if %FLOW_MAC_EXT is set.
765 struct ethtool_flow_ext {
767 unsigned char h_dest[ETH_ALEN];
774 * struct ethtool_rx_flow_spec - classification rule for RX flows
775 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
776 * @h_u: Flow fields to match (dependent on @flow_type)
777 * @h_ext: Additional fields to match
778 * @m_u: Masks for flow field bits to be matched
779 * @m_ext: Masks for additional field bits to be matched
780 * Note, all additional fields must be ignored unless @flow_type
781 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag
782 * (see &struct ethtool_flow_ext description).
783 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
784 * if packets should be discarded
785 * @location: Location of rule in the table. Locations must be
786 * numbered such that a flow matching multiple rules will be
787 * classified according to the first (lowest numbered) rule.
789 struct ethtool_rx_flow_spec {
791 union ethtool_flow_union h_u;
792 struct ethtool_flow_ext h_ext;
793 union ethtool_flow_union m_u;
794 struct ethtool_flow_ext m_ext;
799 /* How rings are layed out when accessing virtual functions or
800 * offloaded queues is device specific. To allow users to do flow
801 * steering and specify these queues the ring cookie is partitioned
802 * into a 32bit queue index with an 8 bit virtual function id.
803 * This also leaves the 3bytes for further specifiers. It is possible
804 * future devices may support more than 256 virtual functions if
805 * devices start supporting PCIe w/ARI. However at the moment I
806 * do not know of any devices that support this so I do not reserve
807 * space for this at this time. If a future patch consumes the next
808 * byte it should be aware of this possiblity.
810 #define ETHTOOL_RX_FLOW_SPEC_RING 0x00000000FFFFFFFFLL
811 #define ETHTOOL_RX_FLOW_SPEC_RING_VF 0x000000FF00000000LL
812 #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32
813 static inline __u64 ethtool_get_flow_spec_ring(__u64 ring_cookie)
815 return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie;
818 static inline __u64 ethtool_get_flow_spec_ring_vf(__u64 ring_cookie)
820 return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >>
821 ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF;
825 * struct ethtool_rxnfc - command to get or set RX flow classification rules
826 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
827 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
828 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
829 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
830 * @data: Command-dependent value
831 * @fs: Flow classification rule
832 * @rule_cnt: Number of rules to be affected
833 * @rule_locs: Array of used rule locations
835 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
836 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
837 * structure fields must not be used.
839 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
842 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
843 * rules on return. If @data is non-zero on return then it is the
844 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
845 * driver supports any special location values. If that flag is not
846 * set in @data then special location values should not be used.
848 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
849 * existing rule on entry and @fs contains the rule on return.
851 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
852 * user buffer for @rule_locs on entry. On return, @data is the size
853 * of the rule table, @rule_cnt is the number of defined rules, and
854 * @rule_locs contains the locations of the defined rules. Drivers
855 * must use the second parameter to get_rxnfc() instead of @rule_locs.
857 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
858 * @fs.@location either specifies the location to use or is a special
859 * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
860 * @fs.@location is the actual rule location.
862 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
863 * existing rule on entry.
865 * A driver supporting the special location values for
866 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
867 * location, and may remove a rule at a later location (lower
868 * priority) that matches exactly the same set of flows. The special
869 * values are %RX_CLS_LOC_ANY, selecting any location;
870 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
871 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
872 * location (minimum priority). Additional special values may be
873 * defined in future and drivers must return -%EINVAL for any
874 * unrecognised value.
876 struct ethtool_rxnfc {
880 struct ethtool_rx_flow_spec fs;
887 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
888 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
889 * @size: On entry, the array size of the user buffer, which may be zero.
890 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
892 * @ring_index: RX ring/queue index for each hash value
894 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
895 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
896 * the table should be reset to default values. This last feature
897 * is not supported by the original implementations.
899 struct ethtool_rxfh_indir {
906 * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key.
907 * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH
908 * @rss_context: RSS context identifier.
909 * @indir_size: On entry, the array size of the user buffer for the
910 * indirection table, which may be zero, or (for %ETHTOOL_SRSSH),
911 * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH,
912 * the array size of the hardware indirection table.
913 * @key_size: On entry, the array size of the user buffer for the hash key,
914 * which may be zero. On return from %ETHTOOL_GRSSH, the size of the
916 * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
917 * Valid values are one of the %ETH_RSS_HASH_*.
918 * @rsvd: Reserved for future extensions.
919 * @rss_config: RX ring/queue index for each hash value i.e., indirection table
920 * of @indir_size __u32 elements, followed by hash key of @key_size
923 * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the
924 * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of
925 * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested
926 * and a @indir_size of zero means the indir table should be reset to default
927 * values. An hfunc of zero means that hash function setting is not requested.
929 struct ethtool_rxfh {
939 #define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff
942 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
943 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
944 * @h_u: Flow field values to match (dependent on @flow_type)
945 * @m_u: Masks for flow field value bits to be ignored
946 * @vlan_tag: VLAN tag to match
947 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
948 * @data: Driver-dependent data to match
949 * @data_mask: Mask for driver-dependent data bits to be ignored
950 * @action: RX ring/queue index to deliver to (non-negative) or other action
951 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
953 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
954 * a field value and mask are both zero this is treated as if all mask
955 * bits are set i.e. the field is ignored.
957 struct ethtool_rx_ntuple_flow_spec {
960 struct ethtool_tcpip4_spec tcp_ip4_spec;
961 struct ethtool_tcpip4_spec udp_ip4_spec;
962 struct ethtool_tcpip4_spec sctp_ip4_spec;
963 struct ethtool_ah_espip4_spec ah_ip4_spec;
964 struct ethtool_ah_espip4_spec esp_ip4_spec;
965 struct ethtool_usrip4_spec usr_ip4_spec;
966 struct ethhdr ether_spec;
976 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
977 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
981 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
982 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
983 * @fs: Flow filter specification
985 struct ethtool_rx_ntuple {
987 struct ethtool_rx_ntuple_flow_spec fs;
990 #define ETHTOOL_FLASH_MAX_FILENAME 128
991 enum ethtool_flash_op_type {
992 ETHTOOL_FLASH_ALL_REGIONS = 0,
995 /* for passing firmware flashing related parameters */
996 struct ethtool_flash {
999 char data[ETHTOOL_FLASH_MAX_FILENAME];
1003 * struct ethtool_dump - used for retrieving, setting device dump
1004 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
1006 * @version: FW version of the dump, filled in by driver
1007 * @flag: driver dependent flag for dump setting, filled in by driver during
1008 * get and filled in by ethtool for set operation.
1009 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
1010 * firmware dump is disabled.
1011 * @len: length of dump data, used as the length of the user buffer on entry to
1012 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
1013 * for %ETHTOOL_GET_DUMP_FLAG command
1014 * @data: data collected for get dump data operation
1016 struct ethtool_dump {
1024 #define ETH_FW_DUMP_DISABLE 0
1026 /* for returning and changing feature sets */
1029 * struct ethtool_get_features_block - block with state of 32 features
1030 * @available: mask of changeable features
1031 * @requested: mask of features requested to be enabled if possible
1032 * @active: mask of currently enabled features
1033 * @never_changed: mask of features not changeable for any device
1035 struct ethtool_get_features_block {
1039 __u32 never_changed;
1043 * struct ethtool_gfeatures - command to get state of device's features
1044 * @cmd: command number = %ETHTOOL_GFEATURES
1045 * @size: On entry, the number of elements in the features[] array;
1046 * on return, the number of elements in features[] needed to hold
1048 * @features: state of features
1050 struct ethtool_gfeatures {
1053 struct ethtool_get_features_block features[0];
1057 * struct ethtool_set_features_block - block with request for 32 features
1058 * @valid: mask of features to be changed
1059 * @requested: values of features to be changed
1061 struct ethtool_set_features_block {
1067 * struct ethtool_sfeatures - command to request change in device's features
1068 * @cmd: command number = %ETHTOOL_SFEATURES
1069 * @size: array size of the features[] array
1070 * @features: feature change masks
1072 struct ethtool_sfeatures {
1075 struct ethtool_set_features_block features[0];
1079 * struct ethtool_ts_info - holds a device's timestamping and PHC association
1080 * @cmd: command number = %ETHTOOL_GET_TS_INFO
1081 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
1082 * @phc_index: device index of the associated PHC, or -1 if there is none
1083 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
1084 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
1086 * The bits in the 'tx_types' and 'rx_filters' fields correspond to
1087 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
1088 * respectively. For example, if the device supports HWTSTAMP_TX_ON,
1089 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
1091 struct ethtool_ts_info {
1093 __u32 so_timestamping;
1096 __u32 tx_reserved[3];
1098 __u32 rx_reserved[3];
1102 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
1103 * values of corresponding bits in features[].requested. Bits in .requested
1104 * not set in .valid or not changeable are ignored.
1106 * Returns %EINVAL when .valid contains undefined or never-changeable bits
1107 * or size is not equal to required number of features words (32-bit blocks).
1108 * Returns >= 0 if request was completed; bits set in the value mean:
1109 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
1110 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
1111 * those bits were ignored.
1112 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
1113 * resulting state of bits masked by .valid is not equal to .requested.
1114 * Probably there are other device-specific constraints on some features
1115 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
1116 * here as though ignored bits were cleared.
1117 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
1118 * compatibility functions. Requested offload state cannot be properly
1119 * managed by kernel.
1121 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
1122 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
1123 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
1124 * significant bit in features[0] fields. Empty strings mark undefined features.
1126 enum ethtool_sfeatures_retval_bits {
1127 ETHTOOL_F_UNSUPPORTED__BIT,
1128 ETHTOOL_F_WISH__BIT,
1129 ETHTOOL_F_COMPAT__BIT,
1132 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
1133 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
1134 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
1137 /* CMDs currently supported */
1138 #define ETHTOOL_GSET 0x00000001 /* Get settings. */
1139 #define ETHTOOL_SSET 0x00000002 /* Set settings. */
1140 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
1141 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
1142 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
1143 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
1144 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
1145 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
1146 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
1147 /* Get link status for host, i.e. whether the interface *and* the
1148 * physical port (if there is one) are up (ethtool_value). */
1149 #define ETHTOOL_GLINK 0x0000000a
1150 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
1151 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
1152 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
1153 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
1154 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
1155 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
1156 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
1157 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
1158 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
1159 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
1160 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
1161 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
1162 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
1163 * (ethtool_value) */
1164 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
1165 * (ethtool_value). */
1166 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
1167 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
1168 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
1169 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
1170 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
1171 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
1172 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
1173 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
1174 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
1175 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
1176 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
1177 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
1178 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
1179 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
1180 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
1182 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
1183 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
1184 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
1185 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
1186 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
1187 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
1188 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
1189 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
1190 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
1191 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
1192 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
1193 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
1194 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
1195 #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
1196 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
1197 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1198 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
1200 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1201 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
1202 #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1203 #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1204 #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1205 #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1206 #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
1207 #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
1208 #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */
1209 #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */
1210 #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */
1211 #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */
1213 #define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */
1214 #define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */
1215 #define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */
1216 #define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */
1218 /* compatibility with older code */
1219 #define SPARC_ETH_GSET ETHTOOL_GSET
1220 #define SPARC_ETH_SSET ETHTOOL_SSET
1222 #define SUPPORTED_10baseT_Half (1 << 0)
1223 #define SUPPORTED_10baseT_Full (1 << 1)
1224 #define SUPPORTED_100baseT_Half (1 << 2)
1225 #define SUPPORTED_100baseT_Full (1 << 3)
1226 #define SUPPORTED_1000baseT_Half (1 << 4)
1227 #define SUPPORTED_1000baseT_Full (1 << 5)
1228 #define SUPPORTED_Autoneg (1 << 6)
1229 #define SUPPORTED_TP (1 << 7)
1230 #define SUPPORTED_AUI (1 << 8)
1231 #define SUPPORTED_MII (1 << 9)
1232 #define SUPPORTED_FIBRE (1 << 10)
1233 #define SUPPORTED_BNC (1 << 11)
1234 #define SUPPORTED_10000baseT_Full (1 << 12)
1235 #define SUPPORTED_Pause (1 << 13)
1236 #define SUPPORTED_Asym_Pause (1 << 14)
1237 #define SUPPORTED_2500baseX_Full (1 << 15)
1238 #define SUPPORTED_Backplane (1 << 16)
1239 #define SUPPORTED_1000baseKX_Full (1 << 17)
1240 #define SUPPORTED_10000baseKX4_Full (1 << 18)
1241 #define SUPPORTED_10000baseKR_Full (1 << 19)
1242 #define SUPPORTED_10000baseR_FEC (1 << 20)
1243 #define SUPPORTED_20000baseMLD2_Full (1 << 21)
1244 #define SUPPORTED_20000baseKR2_Full (1 << 22)
1245 #define SUPPORTED_40000baseKR4_Full (1 << 23)
1246 #define SUPPORTED_40000baseCR4_Full (1 << 24)
1247 #define SUPPORTED_40000baseSR4_Full (1 << 25)
1248 #define SUPPORTED_40000baseLR4_Full (1 << 26)
1249 #define SUPPORTED_56000baseKR4_Full (1 << 27)
1250 #define SUPPORTED_56000baseCR4_Full (1 << 28)
1251 #define SUPPORTED_56000baseSR4_Full (1 << 29)
1252 #define SUPPORTED_56000baseLR4_Full (1 << 30)
1254 #define ADVERTISED_10baseT_Half (1 << 0)
1255 #define ADVERTISED_10baseT_Full (1 << 1)
1256 #define ADVERTISED_100baseT_Half (1 << 2)
1257 #define ADVERTISED_100baseT_Full (1 << 3)
1258 #define ADVERTISED_1000baseT_Half (1 << 4)
1259 #define ADVERTISED_1000baseT_Full (1 << 5)
1260 #define ADVERTISED_Autoneg (1 << 6)
1261 #define ADVERTISED_TP (1 << 7)
1262 #define ADVERTISED_AUI (1 << 8)
1263 #define ADVERTISED_MII (1 << 9)
1264 #define ADVERTISED_FIBRE (1 << 10)
1265 #define ADVERTISED_BNC (1 << 11)
1266 #define ADVERTISED_10000baseT_Full (1 << 12)
1267 #define ADVERTISED_Pause (1 << 13)
1268 #define ADVERTISED_Asym_Pause (1 << 14)
1269 #define ADVERTISED_2500baseX_Full (1 << 15)
1270 #define ADVERTISED_Backplane (1 << 16)
1271 #define ADVERTISED_1000baseKX_Full (1 << 17)
1272 #define ADVERTISED_10000baseKX4_Full (1 << 18)
1273 #define ADVERTISED_10000baseKR_Full (1 << 19)
1274 #define ADVERTISED_10000baseR_FEC (1 << 20)
1275 #define ADVERTISED_20000baseMLD2_Full (1 << 21)
1276 #define ADVERTISED_20000baseKR2_Full (1 << 22)
1277 #define ADVERTISED_40000baseKR4_Full (1 << 23)
1278 #define ADVERTISED_40000baseCR4_Full (1 << 24)
1279 #define ADVERTISED_40000baseSR4_Full (1 << 25)
1280 #define ADVERTISED_40000baseLR4_Full (1 << 26)
1281 #define ADVERTISED_56000baseKR4_Full (1 << 27)
1282 #define ADVERTISED_56000baseCR4_Full (1 << 28)
1283 #define ADVERTISED_56000baseSR4_Full (1 << 29)
1284 #define ADVERTISED_56000baseLR4_Full (1 << 30)
1286 /* The following are all involved in forcing a particular link
1287 * mode for the device for setting things. When getting the
1288 * devices settings, these indicate the current mode and whether
1289 * it was forced up into this mode or autonegotiated.
1292 /* The forced speed, 10Mb, 100Mb, gigabit, [2.5|5|10|20|25|40|50|56|100]GbE. */
1294 #define SPEED_100 100
1295 #define SPEED_1000 1000
1296 #define SPEED_2500 2500
1297 #define SPEED_5000 5000
1298 #define SPEED_10000 10000
1299 #define SPEED_20000 20000
1300 #define SPEED_25000 25000
1301 #define SPEED_40000 40000
1302 #define SPEED_50000 50000
1303 #define SPEED_56000 56000
1304 #define SPEED_100000 100000
1306 #define SPEED_UNKNOWN -1
1308 /* Duplex, half or full. */
1309 #define DUPLEX_HALF 0x00
1310 #define DUPLEX_FULL 0x01
1311 #define DUPLEX_UNKNOWN 0xff
1313 /* Which connector port. */
1314 #define PORT_TP 0x00
1315 #define PORT_AUI 0x01
1316 #define PORT_MII 0x02
1317 #define PORT_FIBRE 0x03
1318 #define PORT_BNC 0x04
1319 #define PORT_DA 0x05
1320 #define PORT_NONE 0xef
1321 #define PORT_OTHER 0xff
1323 /* Which transceiver to use. */
1324 #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */
1325 #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */
1326 #define XCVR_DUMMY1 0x02
1327 #define XCVR_DUMMY2 0x03
1328 #define XCVR_DUMMY3 0x04
1330 /* Enable or disable autonegotiation. */
1331 #define AUTONEG_DISABLE 0x00
1332 #define AUTONEG_ENABLE 0x01
1334 /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
1335 * the driver is required to renegotiate link
1337 #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */
1338 #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */
1339 #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */
1340 #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */
1342 /* Wake-On-Lan options. */
1343 #define WAKE_PHY (1 << 0)
1344 #define WAKE_UCAST (1 << 1)
1345 #define WAKE_MCAST (1 << 2)
1346 #define WAKE_BCAST (1 << 3)
1347 #define WAKE_ARP (1 << 4)
1348 #define WAKE_MAGIC (1 << 5)
1349 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1351 /* L2-L4 network traffic flow types */
1352 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1353 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1354 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1355 #define AH_ESP_V4_FLOW 0x04 /* hash only */
1356 #define TCP_V6_FLOW 0x05 /* hash only */
1357 #define UDP_V6_FLOW 0x06 /* hash only */
1358 #define SCTP_V6_FLOW 0x07 /* hash only */
1359 #define AH_ESP_V6_FLOW 0x08 /* hash only */
1360 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1361 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1362 #define AH_V6_FLOW 0x0b /* hash only */
1363 #define ESP_V6_FLOW 0x0c /* hash only */
1364 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1365 #define IPV4_FLOW 0x10 /* hash only */
1366 #define IPV6_FLOW 0x11 /* hash only */
1367 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */
1368 /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1369 #define FLOW_EXT 0x80000000
1370 #define FLOW_MAC_EXT 0x40000000
1372 /* L3-L4 network traffic flow hash options */
1373 #define RXH_L2DA (1 << 1)
1374 #define RXH_VLAN (1 << 2)
1375 #define RXH_L3_PROTO (1 << 3)
1376 #define RXH_IP_SRC (1 << 4)
1377 #define RXH_IP_DST (1 << 5)
1378 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1379 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1380 #define RXH_DISCARD (1 << 31)
1382 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
1384 /* Special RX classification rule insert location values */
1385 #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
1386 #define RX_CLS_LOC_ANY 0xffffffff
1387 #define RX_CLS_LOC_FIRST 0xfffffffe
1388 #define RX_CLS_LOC_LAST 0xfffffffd
1390 /* EEPROM Standards for plug in modules */
1391 #define ETH_MODULE_SFF_8079 0x1
1392 #define ETH_MODULE_SFF_8079_LEN 256
1393 #define ETH_MODULE_SFF_8472 0x2
1394 #define ETH_MODULE_SFF_8472_LEN 512
1395 #define ETH_MODULE_SFF_8636 0x3
1396 #define ETH_MODULE_SFF_8636_LEN 256
1397 #define ETH_MODULE_SFF_8436 0x4
1398 #define ETH_MODULE_SFF_8436_LEN 256
1401 /* The reset() operation must clear the flags for the components which
1402 * were actually reset. On successful return, the flags indicate the
1403 * components which were not reset, either because they do not exist
1404 * in the hardware or because they cannot be reset independently. The
1405 * driver must never reset any components that were not requested.
1407 enum ethtool_reset_flags {
1408 /* These flags represent components dedicated to the interface
1409 * the command is addressed to. Shift any flag left by
1410 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1413 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1414 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1415 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1416 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1417 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1418 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1419 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1420 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1421 * multiple components */
1423 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1425 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1426 * interface, even if shared */
1428 #define ETH_RESET_SHARED_SHIFT 16
1430 #endif /* _UAPI_LINUX_ETHTOOL_H */