blob: 441bd316b8502dbcf0384389a031b3be1520780d [file] [log] [blame]
David Howells607ca462012-10-13 10:46:48 +01001/*
2 * ethtool.h: Defines for Linux ethtool.
3 *
4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
8 * christopher.leech@intel.com,
9 * scott.feldman@intel.com)
10 * Portions Copyright (C) Sun Microsystems 2008
11 */
12
13#ifndef _UAPI_LINUX_ETHTOOL_H
14#define _UAPI_LINUX_ETHTOOL_H
15
16#include <linux/types.h>
17#include <linux/if_ether.h>
18
Ben Hutchingsbf8fc602014-02-12 22:13:57 +000019/* All structures exposed to userland should be defined such that they
20 * have the same layout for 32-bit and 64-bit userland.
21 */
22
23/**
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.
29 * Read-only.
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
33 * auto-detection.
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.
45 * Read-only.
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
58 * necessary.
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.
62 * Read-only.
63 *
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
66 * access it.
67 *
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.
74 *
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
80 * rejected.
81 *
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.
86 *
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.
90 *
91 * Deprecated fields should be ignored by both users and drivers.
92 */
David Howells607ca462012-10-13 10:46:48 +010093struct ethtool_cmd {
94 __u32 cmd;
Ben Hutchingsbf8fc602014-02-12 22:13:57 +000095 __u32 supported;
96 __u32 advertising;
97 __u16 speed;
98 __u8 duplex;
99 __u8 port;
100 __u8 phy_address;
101 __u8 transceiver;
102 __u8 autoneg;
103 __u8 mdio_support;
104 __u32 maxtxpkt;
105 __u32 maxrxpkt;
106 __u16 speed_hi;
107 __u8 eth_tp_mdix;
108 __u8 eth_tp_mdix_ctrl;
109 __u32 lp_advertising;
David Howells607ca462012-10-13 10:46:48 +0100110 __u32 reserved[2];
111};
112
113static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
114 __u32 speed)
115{
116
117 ep->speed = (__u16)speed;
118 ep->speed_hi = (__u16)(speed >> 16);
119}
120
121static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
122{
123 return (ep->speed_hi << 16) | ep->speed;
124}
125
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.
130 */
131#define ETH_MDIO_SUPPORTS_C22 1
132
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
136 * present.
137 */
138#define ETH_MDIO_SUPPORTS_C45 2
139
140#define ETHTOOL_FWVERS_LEN 32
141#define ETHTOOL_BUSINFO_LEN 32
Ben Hutchingsdaba1b62014-02-12 22:14:03 +0000142
143/**
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
153 * an empty string.
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
164 * command, in bytes
165 *
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).
168 *
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.
172 */
David Howells607ca462012-10-13 10:46:48 +0100173struct ethtool_drvinfo {
174 __u32 cmd;
Ben Hutchingsdaba1b62014-02-12 22:14:03 +0000175 char driver[32];
176 char version[32];
177 char fw_version[ETHTOOL_FWVERS_LEN];
178 char bus_info[ETHTOOL_BUSINFO_LEN];
David Howells607ca462012-10-13 10:46:48 +0100179 char reserved1[32];
180 char reserved2[12];
Ben Hutchingsdaba1b62014-02-12 22:14:03 +0000181 __u32 n_priv_flags;
182 __u32 n_stats;
David Howells607ca462012-10-13 10:46:48 +0100183 __u32 testinfo_len;
Ben Hutchingsdaba1b62014-02-12 22:14:03 +0000184 __u32 eedump_len;
185 __u32 regdump_len;
David Howells607ca462012-10-13 10:46:48 +0100186};
187
188#define SOPASS_MAX 6
Ben Hutchings02d59f32014-02-12 22:14:07 +0000189
190/**
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.
194 * Read-only.
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.
198 */
David Howells607ca462012-10-13 10:46:48 +0100199struct ethtool_wolinfo {
200 __u32 cmd;
201 __u32 supported;
202 __u32 wolopts;
Ben Hutchings02d59f32014-02-12 22:14:07 +0000203 __u8 sopass[SOPASS_MAX];
David Howells607ca462012-10-13 10:46:48 +0100204};
205
206/* for passing single values */
207struct ethtool_value {
208 __u32 cmd;
209 __u32 data;
210};
211
Ben Hutchings09fb8bb2014-02-12 22:14:13 +0000212/**
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
218 * incompatible way.
219 * @len: On entry, the real length of @data. On return, the number of
220 * bytes used.
221 * @data: Buffer for the register dump
222 *
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.
226 */
David Howells607ca462012-10-13 10:46:48 +0100227struct ethtool_regs {
228 __u32 cmd;
Ben Hutchings09fb8bb2014-02-12 22:14:13 +0000229 __u32 version;
230 __u32 len;
David Howells607ca462012-10-13 10:46:48 +0100231 __u8 data[0];
232};
233
234/* for passing EEPROM chunks */
235struct ethtool_eeprom {
236 __u32 cmd;
237 __u32 magic;
238 __u32 offset; /* in bytes */
239 __u32 len; /* in bytes */
240 __u8 data[0];
241};
242
243/**
244 * struct ethtool_eee - Energy Efficient Ethernet information
245 * @cmd: ETHTOOL_{G,S}EEE
246 * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
247 * for which there is EEE support.
248 * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
249 * advertised as eee capable.
250 * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
251 * combinations advertised by the link partner as eee capable.
252 * @eee_active: Result of the eee auto negotiation.
253 * @eee_enabled: EEE configured mode (enabled/disabled).
254 * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
255 * that eee was negotiated.
256 * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
257 * its tx lpi (after reaching 'idle' state). Effective only when eee
258 * was negotiated and tx_lpi_enabled was set.
259 */
260struct ethtool_eee {
261 __u32 cmd;
262 __u32 supported;
263 __u32 advertised;
264 __u32 lp_advertised;
265 __u32 eee_active;
266 __u32 eee_enabled;
267 __u32 tx_lpi_enabled;
268 __u32 tx_lpi_timer;
269 __u32 reserved[2];
270};
271
272/**
273 * struct ethtool_modinfo - plugin module eeprom information
274 * @cmd: %ETHTOOL_GMODULEINFO
275 * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
276 * @eeprom_len: Length of the eeprom
277 *
278 * This structure is used to return the information to
279 * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
280 * The type code indicates the eeprom data format
281 */
282struct ethtool_modinfo {
283 __u32 cmd;
284 __u32 type;
285 __u32 eeprom_len;
286 __u32 reserved[8];
287};
288
289/**
290 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
291 * @cmd: ETHTOOL_{G,S}COALESCE
292 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
293 * a packet arrives.
294 * @rx_max_coalesced_frames: Maximum number of packets to receive
295 * before an RX interrupt.
296 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
297 * this value applies while an IRQ is being serviced by the host.
298 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
299 * except that this value applies while an IRQ is being serviced
300 * by the host.
301 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
302 * a packet is sent.
303 * @tx_max_coalesced_frames: Maximum number of packets to be sent
304 * before a TX interrupt.
305 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
306 * this value applies while an IRQ is being serviced by the host.
307 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
308 * except that this value applies while an IRQ is being serviced
309 * by the host.
310 * @stats_block_coalesce_usecs: How many usecs to delay in-memory
311 * statistics block updates. Some drivers do not have an
312 * in-memory statistic block, and in such cases this value is
313 * ignored. This value must not be zero.
314 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
315 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
316 * @pkt_rate_low: Threshold for low packet rate (packets per second).
317 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
318 * a packet arrives, when the packet rate is below @pkt_rate_low.
319 * @rx_max_coalesced_frames_low: Maximum number of packets to be received
320 * before an RX interrupt, when the packet rate is below @pkt_rate_low.
321 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
322 * a packet is sent, when the packet rate is below @pkt_rate_low.
323 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
324 * a TX interrupt, when the packet rate is below @pkt_rate_low.
325 * @pkt_rate_high: Threshold for high packet rate (packets per second).
326 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
327 * a packet arrives, when the packet rate is above @pkt_rate_high.
328 * @rx_max_coalesced_frames_high: Maximum number of packets to be received
329 * before an RX interrupt, when the packet rate is above @pkt_rate_high.
330 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
331 * a packet is sent, when the packet rate is above @pkt_rate_high.
332 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
333 * a TX interrupt, when the packet rate is above @pkt_rate_high.
334 * @rate_sample_interval: How often to do adaptive coalescing packet rate
335 * sampling, measured in seconds. Must not be zero.
336 *
337 * Each pair of (usecs, max_frames) fields specifies this exit
338 * condition for interrupt coalescing:
339 * (usecs > 0 && time_since_first_completion >= usecs) ||
340 * (max_frames > 0 && completed_frames >= max_frames)
341 * It is illegal to set both usecs and max_frames to zero as this
342 * would cause interrupts to never be generated. To disable
343 * coalescing, set usecs = 0 and max_frames = 1.
344 *
345 * Some implementations ignore the value of max_frames and use the
346 * condition:
347 * time_since_first_completion >= usecs
348 * This is deprecated. Drivers for hardware that does not support
349 * counting completions should validate that max_frames == !rx_usecs.
350 *
351 * Adaptive RX/TX coalescing is an algorithm implemented by some
352 * drivers to improve latency under low packet rates and improve
353 * throughput under high packet rates. Some drivers only implement
354 * one of RX or TX adaptive coalescing. Anything not implemented by
355 * the driver causes these values to be silently ignored.
356 *
357 * When the packet rate is below @pkt_rate_high but above
358 * @pkt_rate_low (both measured in packets per second) the
359 * normal {rx,tx}_* coalescing parameters are used.
360 */
361struct ethtool_coalesce {
362 __u32 cmd;
363 __u32 rx_coalesce_usecs;
364 __u32 rx_max_coalesced_frames;
365 __u32 rx_coalesce_usecs_irq;
366 __u32 rx_max_coalesced_frames_irq;
367 __u32 tx_coalesce_usecs;
368 __u32 tx_max_coalesced_frames;
369 __u32 tx_coalesce_usecs_irq;
370 __u32 tx_max_coalesced_frames_irq;
371 __u32 stats_block_coalesce_usecs;
372 __u32 use_adaptive_rx_coalesce;
373 __u32 use_adaptive_tx_coalesce;
374 __u32 pkt_rate_low;
375 __u32 rx_coalesce_usecs_low;
376 __u32 rx_max_coalesced_frames_low;
377 __u32 tx_coalesce_usecs_low;
378 __u32 tx_max_coalesced_frames_low;
379 __u32 pkt_rate_high;
380 __u32 rx_coalesce_usecs_high;
381 __u32 rx_max_coalesced_frames_high;
382 __u32 tx_coalesce_usecs_high;
383 __u32 tx_max_coalesced_frames_high;
384 __u32 rate_sample_interval;
385};
386
387/* for configuring RX/TX ring parameters */
388struct ethtool_ringparam {
389 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
390
391 /* Read only attributes. These indicate the maximum number
392 * of pending RX/TX ring entries the driver will allow the
393 * user to set.
394 */
395 __u32 rx_max_pending;
396 __u32 rx_mini_max_pending;
397 __u32 rx_jumbo_max_pending;
398 __u32 tx_max_pending;
399
400 /* Values changeable by the user. The valid values are
401 * in the range 1 to the "*_max_pending" counterpart above.
402 */
403 __u32 rx_pending;
404 __u32 rx_mini_pending;
405 __u32 rx_jumbo_pending;
406 __u32 tx_pending;
407};
408
409/**
410 * struct ethtool_channels - configuring number of network channel
411 * @cmd: ETHTOOL_{G,S}CHANNELS
412 * @max_rx: Read only. Maximum number of receive channel the driver support.
413 * @max_tx: Read only. Maximum number of transmit channel the driver support.
414 * @max_other: Read only. Maximum number of other channel the driver support.
415 * @max_combined: Read only. Maximum number of combined channel the driver
416 * support. Set of queues RX, TX or other.
417 * @rx_count: Valid values are in the range 1 to the max_rx.
418 * @tx_count: Valid values are in the range 1 to the max_tx.
419 * @other_count: Valid values are in the range 1 to the max_other.
420 * @combined_count: Valid values are in the range 1 to the max_combined.
421 *
422 * This can be used to configure RX, TX and other channels.
423 */
424
425struct ethtool_channels {
426 __u32 cmd;
427 __u32 max_rx;
428 __u32 max_tx;
429 __u32 max_other;
430 __u32 max_combined;
431 __u32 rx_count;
432 __u32 tx_count;
433 __u32 other_count;
434 __u32 combined_count;
435};
436
437/* for configuring link flow control parameters */
438struct ethtool_pauseparam {
439 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
440
441 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
442 * being true) the user may set 'autoneg' here non-zero to have the
443 * pause parameters be auto-negotiated too. In such a case, the
444 * {rx,tx}_pause values below determine what capabilities are
445 * advertised.
446 *
447 * If 'autoneg' is zero or the link is not being auto-negotiated,
448 * then {rx,tx}_pause force the driver to use/not-use pause
449 * flow control.
450 */
451 __u32 autoneg;
452 __u32 rx_pause;
453 __u32 tx_pause;
454};
455
456#define ETH_GSTRING_LEN 32
457enum ethtool_stringset {
458 ETH_SS_TEST = 0,
459 ETH_SS_STATS,
460 ETH_SS_PRIV_FLAGS,
461 ETH_SS_NTUPLE_FILTERS, /* Do not use, GRXNTUPLE is now deprecated */
462 ETH_SS_FEATURES,
463};
464
465/* for passing string sets for data tagging */
466struct ethtool_gstrings {
467 __u32 cmd; /* ETHTOOL_GSTRINGS */
468 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
469 __u32 len; /* number of strings in the string set */
470 __u8 data[0];
471};
472
473struct ethtool_sset_info {
474 __u32 cmd; /* ETHTOOL_GSSET_INFO */
475 __u32 reserved;
476 __u64 sset_mask; /* input: each bit selects an sset to query */
477 /* output: each bit a returned sset */
478 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits
479 in sset_mask. One bit implies one
480 __u32, two bits implies two
481 __u32's, etc. */
482};
483
484/**
485 * enum ethtool_test_flags - flags definition of ethtool_test
486 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
487 * only online tests.
488 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
489 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
490 * test.
491 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
492 */
493
494enum ethtool_test_flags {
495 ETH_TEST_FL_OFFLINE = (1 << 0),
496 ETH_TEST_FL_FAILED = (1 << 1),
497 ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
498 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
499};
500
501/* for requesting NIC test and getting results*/
502struct ethtool_test {
503 __u32 cmd; /* ETHTOOL_TEST */
504 __u32 flags; /* ETH_TEST_FL_xxx */
505 __u32 reserved;
506 __u32 len; /* result length, in number of u64 elements */
507 __u64 data[0];
508};
509
510/* for dumping NIC-specific statistics */
511struct ethtool_stats {
512 __u32 cmd; /* ETHTOOL_GSTATS */
513 __u32 n_stats; /* number of u64's being returned */
514 __u64 data[0];
515};
516
517struct ethtool_perm_addr {
518 __u32 cmd; /* ETHTOOL_GPERMADDR */
519 __u32 size;
520 __u8 data[0];
521};
522
523/* boolean flags controlling per-interface behavior characteristics.
524 * When reading, the flag indicates whether or not a certain behavior
525 * is enabled/present. When writing, the flag indicates whether
526 * or not the driver should turn on (set) or off (clear) a behavior.
527 *
528 * Some behaviors may read-only (unconditionally absent or present).
529 * If such is the case, return EINVAL in the set-flags operation if the
530 * flag differs from the read-only value.
531 */
532enum ethtool_flags {
533 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
534 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
535 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
536 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
537 ETH_FLAG_RXHASH = (1 << 28),
538};
539
540/* The following structures are for supporting RX network flow
541 * classification and RX n-tuple configuration. Note, all multibyte
542 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
543 * be in network byte order.
544 */
545
546/**
547 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
548 * @ip4src: Source host
549 * @ip4dst: Destination host
550 * @psrc: Source port
551 * @pdst: Destination port
552 * @tos: Type-of-service
553 *
554 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
555 */
556struct ethtool_tcpip4_spec {
557 __be32 ip4src;
558 __be32 ip4dst;
559 __be16 psrc;
560 __be16 pdst;
561 __u8 tos;
562};
563
564/**
565 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
566 * @ip4src: Source host
567 * @ip4dst: Destination host
568 * @spi: Security parameters index
569 * @tos: Type-of-service
570 *
571 * This can be used to specify an IPsec transport or tunnel over IPv4.
572 */
573struct ethtool_ah_espip4_spec {
574 __be32 ip4src;
575 __be32 ip4dst;
576 __be32 spi;
577 __u8 tos;
578};
579
580#define ETH_RX_NFC_IP4 1
581
582/**
583 * struct ethtool_usrip4_spec - general flow specification for IPv4
584 * @ip4src: Source host
585 * @ip4dst: Destination host
586 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
587 * @tos: Type-of-service
588 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
589 * @proto: Transport protocol number; mask must be 0
590 */
591struct ethtool_usrip4_spec {
592 __be32 ip4src;
593 __be32 ip4dst;
594 __be32 l4_4_bytes;
595 __u8 tos;
596 __u8 ip_ver;
597 __u8 proto;
598};
599
600union ethtool_flow_union {
601 struct ethtool_tcpip4_spec tcp_ip4_spec;
602 struct ethtool_tcpip4_spec udp_ip4_spec;
603 struct ethtool_tcpip4_spec sctp_ip4_spec;
604 struct ethtool_ah_espip4_spec ah_ip4_spec;
605 struct ethtool_ah_espip4_spec esp_ip4_spec;
606 struct ethtool_usrip4_spec usr_ip4_spec;
607 struct ethhdr ether_spec;
Yan Burmand4676ea2012-12-12 02:13:17 +0000608 __u8 hdata[52];
David Howells607ca462012-10-13 10:46:48 +0100609};
610
Yan Burmandc2e5732012-12-13 05:20:59 +0000611/**
612 * struct ethtool_flow_ext - additional RX flow fields
613 * @h_dest: destination MAC address
614 * @vlan_etype: VLAN EtherType
615 * @vlan_tci: VLAN tag control information
616 * @data: user defined data
617 *
618 * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
619 * is set in &struct ethtool_rx_flow_spec @flow_type.
620 * @h_dest is valid if %FLOW_MAC_EXT is set.
621 */
David Howells607ca462012-10-13 10:46:48 +0100622struct ethtool_flow_ext {
Yan Burmand4676ea2012-12-12 02:13:17 +0000623 __u8 padding[2];
Yan Burmandc2e5732012-12-13 05:20:59 +0000624 unsigned char h_dest[ETH_ALEN];
Yan Burmand4676ea2012-12-12 02:13:17 +0000625 __be16 vlan_etype;
626 __be16 vlan_tci;
627 __be32 data[2];
David Howells607ca462012-10-13 10:46:48 +0100628};
629
630/**
631 * struct ethtool_rx_flow_spec - classification rule for RX flows
632 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
633 * @h_u: Flow fields to match (dependent on @flow_type)
634 * @h_ext: Additional fields to match
635 * @m_u: Masks for flow field bits to be matched
636 * @m_ext: Masks for additional field bits to be matched
637 * Note, all additional fields must be ignored unless @flow_type
Yan Burmandc2e5732012-12-13 05:20:59 +0000638 * includes the %FLOW_EXT or %FLOW_MAC_EXT flag
639 * (see &struct ethtool_flow_ext description).
David Howells607ca462012-10-13 10:46:48 +0100640 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
641 * if packets should be discarded
642 * @location: Location of rule in the table. Locations must be
643 * numbered such that a flow matching multiple rules will be
644 * classified according to the first (lowest numbered) rule.
645 */
646struct ethtool_rx_flow_spec {
647 __u32 flow_type;
648 union ethtool_flow_union h_u;
649 struct ethtool_flow_ext h_ext;
650 union ethtool_flow_union m_u;
651 struct ethtool_flow_ext m_ext;
652 __u64 ring_cookie;
653 __u32 location;
654};
655
656/**
657 * struct ethtool_rxnfc - command to get or set RX flow classification rules
658 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
659 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
660 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
661 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
662 * @data: Command-dependent value
663 * @fs: Flow classification rule
664 * @rule_cnt: Number of rules to be affected
665 * @rule_locs: Array of used rule locations
666 *
667 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
668 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
669 * structure fields must not be used.
670 *
671 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
672 * on return.
673 *
674 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
675 * rules on return. If @data is non-zero on return then it is the
676 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
677 * driver supports any special location values. If that flag is not
678 * set in @data then special location values should not be used.
679 *
680 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
681 * existing rule on entry and @fs contains the rule on return.
682 *
683 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
684 * user buffer for @rule_locs on entry. On return, @data is the size
685 * of the rule table, @rule_cnt is the number of defined rules, and
686 * @rule_locs contains the locations of the defined rules. Drivers
687 * must use the second parameter to get_rxnfc() instead of @rule_locs.
688 *
689 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
690 * @fs.@location either specifies the location to use or is a special
691 * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
692 * @fs.@location is the actual rule location.
693 *
694 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
695 * existing rule on entry.
696 *
697 * A driver supporting the special location values for
698 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
699 * location, and may remove a rule at a later location (lower
700 * priority) that matches exactly the same set of flows. The special
701 * values are: %RX_CLS_LOC_ANY, selecting any location;
702 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
703 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
704 * location (minimum priority). Additional special values may be
705 * defined in future and drivers must return -%EINVAL for any
706 * unrecognised value.
707 */
708struct ethtool_rxnfc {
709 __u32 cmd;
710 __u32 flow_type;
711 __u64 data;
712 struct ethtool_rx_flow_spec fs;
713 __u32 rule_cnt;
714 __u32 rule_locs[0];
715};
716
717
718/**
719 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
720 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
721 * @size: On entry, the array size of the user buffer, which may be zero.
722 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
723 * indirection table.
724 * @ring_index: RX ring/queue index for each hash value
725 *
726 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
727 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
728 * the table should be reset to default values. This last feature
729 * is not supported by the original implementations.
730 */
731struct ethtool_rxfh_indir {
732 __u32 cmd;
733 __u32 size;
734 __u32 ring_index[0];
735};
736
737/**
738 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
739 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
740 * @h_u: Flow field values to match (dependent on @flow_type)
741 * @m_u: Masks for flow field value bits to be ignored
742 * @vlan_tag: VLAN tag to match
743 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
744 * @data: Driver-dependent data to match
745 * @data_mask: Mask for driver-dependent data bits to be ignored
746 * @action: RX ring/queue index to deliver to (non-negative) or other action
747 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
748 *
749 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
750 * a field value and mask are both zero this is treated as if all mask
751 * bits are set i.e. the field is ignored.
752 */
753struct ethtool_rx_ntuple_flow_spec {
754 __u32 flow_type;
755 union {
756 struct ethtool_tcpip4_spec tcp_ip4_spec;
757 struct ethtool_tcpip4_spec udp_ip4_spec;
758 struct ethtool_tcpip4_spec sctp_ip4_spec;
759 struct ethtool_ah_espip4_spec ah_ip4_spec;
760 struct ethtool_ah_espip4_spec esp_ip4_spec;
761 struct ethtool_usrip4_spec usr_ip4_spec;
762 struct ethhdr ether_spec;
763 __u8 hdata[72];
764 } h_u, m_u;
765
766 __u16 vlan_tag;
767 __u16 vlan_tag_mask;
768 __u64 data;
769 __u64 data_mask;
770
771 __s32 action;
772#define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
773#define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
774};
775
776/**
777 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
778 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
779 * @fs: Flow filter specification
780 */
781struct ethtool_rx_ntuple {
782 __u32 cmd;
783 struct ethtool_rx_ntuple_flow_spec fs;
784};
785
786#define ETHTOOL_FLASH_MAX_FILENAME 128
787enum ethtool_flash_op_type {
788 ETHTOOL_FLASH_ALL_REGIONS = 0,
789};
790
791/* for passing firmware flashing related parameters */
792struct ethtool_flash {
793 __u32 cmd;
794 __u32 region;
795 char data[ETHTOOL_FLASH_MAX_FILENAME];
796};
797
798/**
799 * struct ethtool_dump - used for retrieving, setting device dump
800 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
801 * %ETHTOOL_SET_DUMP
802 * @version: FW version of the dump, filled in by driver
803 * @flag: driver dependent flag for dump setting, filled in by driver during
804 * get and filled in by ethtool for set operation.
805 * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
806 * firmware dump is disabled.
807 * @len: length of dump data, used as the length of the user buffer on entry to
808 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
809 * for %ETHTOOL_GET_DUMP_FLAG command
810 * @data: data collected for get dump data operation
811 */
812
813#define ETH_FW_DUMP_DISABLE 0
814
815struct ethtool_dump {
816 __u32 cmd;
817 __u32 version;
818 __u32 flag;
819 __u32 len;
820 __u8 data[0];
821};
822
823/* for returning and changing feature sets */
824
825/**
826 * struct ethtool_get_features_block - block with state of 32 features
827 * @available: mask of changeable features
828 * @requested: mask of features requested to be enabled if possible
829 * @active: mask of currently enabled features
830 * @never_changed: mask of features not changeable for any device
831 */
832struct ethtool_get_features_block {
833 __u32 available;
834 __u32 requested;
835 __u32 active;
836 __u32 never_changed;
837};
838
839/**
840 * struct ethtool_gfeatures - command to get state of device's features
841 * @cmd: command number = %ETHTOOL_GFEATURES
842 * @size: in: number of elements in the features[] array;
843 * out: number of elements in features[] needed to hold all features
844 * @features: state of features
845 */
846struct ethtool_gfeatures {
847 __u32 cmd;
848 __u32 size;
849 struct ethtool_get_features_block features[0];
850};
851
852/**
853 * struct ethtool_set_features_block - block with request for 32 features
854 * @valid: mask of features to be changed
855 * @requested: values of features to be changed
856 */
857struct ethtool_set_features_block {
858 __u32 valid;
859 __u32 requested;
860};
861
862/**
863 * struct ethtool_sfeatures - command to request change in device's features
864 * @cmd: command number = %ETHTOOL_SFEATURES
865 * @size: array size of the features[] array
866 * @features: feature change masks
867 */
868struct ethtool_sfeatures {
869 __u32 cmd;
870 __u32 size;
871 struct ethtool_set_features_block features[0];
872};
873
874/**
875 * struct ethtool_ts_info - holds a device's timestamping and PHC association
876 * @cmd: command number = %ETHTOOL_GET_TS_INFO
877 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
878 * @phc_index: device index of the associated PHC, or -1 if there is none
879 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
880 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
881 *
882 * The bits in the 'tx_types' and 'rx_filters' fields correspond to
883 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
884 * respectively. For example, if the device supports HWTSTAMP_TX_ON,
885 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
886 */
887struct ethtool_ts_info {
888 __u32 cmd;
889 __u32 so_timestamping;
890 __s32 phc_index;
891 __u32 tx_types;
892 __u32 tx_reserved[3];
893 __u32 rx_filters;
894 __u32 rx_reserved[3];
895};
896
897/*
898 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
899 * values of corresponding bits in features[].requested. Bits in .requested
900 * not set in .valid or not changeable are ignored.
901 *
902 * Returns %EINVAL when .valid contains undefined or never-changeable bits
903 * or size is not equal to required number of features words (32-bit blocks).
904 * Returns >= 0 if request was completed; bits set in the value mean:
905 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
906 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
907 * those bits were ignored.
908 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
909 * resulting state of bits masked by .valid is not equal to .requested.
910 * Probably there are other device-specific constraints on some features
911 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
912 * here as though ignored bits were cleared.
913 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
914 * compatibility functions. Requested offload state cannot be properly
915 * managed by kernel.
916 *
917 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
918 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
919 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
920 * significant bit in features[0] fields. Empty strings mark undefined features.
921 */
922enum ethtool_sfeatures_retval_bits {
923 ETHTOOL_F_UNSUPPORTED__BIT,
924 ETHTOOL_F_WISH__BIT,
925 ETHTOOL_F_COMPAT__BIT,
926};
927
928#define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
929#define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
930#define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
931
932
933/* CMDs currently supported */
934#define ETHTOOL_GSET 0x00000001 /* Get settings. */
935#define ETHTOOL_SSET 0x00000002 /* Set settings. */
936#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
937#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
938#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
939#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
940#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
941#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
942#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
943/* Get link status for host, i.e. whether the interface *and* the
944 * physical port (if there is one) are up (ethtool_value). */
945#define ETHTOOL_GLINK 0x0000000a
946#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
947#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
948#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
949#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
950#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
951#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
952#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
953#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
954#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
955#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
956#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
957#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
958#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
959 * (ethtool_value) */
960#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
961 * (ethtool_value). */
962#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
963#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
964#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
965#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
966#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
967#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
968#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
969#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
970#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
971#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
972#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
973#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
974#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
975#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
976#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
977
978#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
979#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
980#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
981#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
982#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
983#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
984#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
985#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
986#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
987#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
988#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
989#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
990#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
991#define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
992#define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
993#define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
994#define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
995
996#define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
997#define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
998#define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
999#define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
1000#define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1001#define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1002#define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
1003#define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
1004#define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */
1005#define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */
1006#define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */
1007#define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */
1008
1009/* compatibility with older code */
1010#define SPARC_ETH_GSET ETHTOOL_GSET
1011#define SPARC_ETH_SSET ETHTOOL_SSET
1012
David Howells607ca462012-10-13 10:46:48 +01001013#define SUPPORTED_10baseT_Half (1 << 0)
1014#define SUPPORTED_10baseT_Full (1 << 1)
1015#define SUPPORTED_100baseT_Half (1 << 2)
1016#define SUPPORTED_100baseT_Full (1 << 3)
1017#define SUPPORTED_1000baseT_Half (1 << 4)
1018#define SUPPORTED_1000baseT_Full (1 << 5)
1019#define SUPPORTED_Autoneg (1 << 6)
1020#define SUPPORTED_TP (1 << 7)
1021#define SUPPORTED_AUI (1 << 8)
1022#define SUPPORTED_MII (1 << 9)
1023#define SUPPORTED_FIBRE (1 << 10)
1024#define SUPPORTED_BNC (1 << 11)
1025#define SUPPORTED_10000baseT_Full (1 << 12)
1026#define SUPPORTED_Pause (1 << 13)
1027#define SUPPORTED_Asym_Pause (1 << 14)
1028#define SUPPORTED_2500baseX_Full (1 << 15)
1029#define SUPPORTED_Backplane (1 << 16)
1030#define SUPPORTED_1000baseKX_Full (1 << 17)
1031#define SUPPORTED_10000baseKX4_Full (1 << 18)
1032#define SUPPORTED_10000baseKR_Full (1 << 19)
1033#define SUPPORTED_10000baseR_FEC (1 << 20)
1034#define SUPPORTED_20000baseMLD2_Full (1 << 21)
1035#define SUPPORTED_20000baseKR2_Full (1 << 22)
1036#define SUPPORTED_40000baseKR4_Full (1 << 23)
1037#define SUPPORTED_40000baseCR4_Full (1 << 24)
1038#define SUPPORTED_40000baseSR4_Full (1 << 25)
1039#define SUPPORTED_40000baseLR4_Full (1 << 26)
1040
David Howells607ca462012-10-13 10:46:48 +01001041#define ADVERTISED_10baseT_Half (1 << 0)
1042#define ADVERTISED_10baseT_Full (1 << 1)
1043#define ADVERTISED_100baseT_Half (1 << 2)
1044#define ADVERTISED_100baseT_Full (1 << 3)
1045#define ADVERTISED_1000baseT_Half (1 << 4)
1046#define ADVERTISED_1000baseT_Full (1 << 5)
1047#define ADVERTISED_Autoneg (1 << 6)
1048#define ADVERTISED_TP (1 << 7)
1049#define ADVERTISED_AUI (1 << 8)
1050#define ADVERTISED_MII (1 << 9)
1051#define ADVERTISED_FIBRE (1 << 10)
1052#define ADVERTISED_BNC (1 << 11)
1053#define ADVERTISED_10000baseT_Full (1 << 12)
1054#define ADVERTISED_Pause (1 << 13)
1055#define ADVERTISED_Asym_Pause (1 << 14)
1056#define ADVERTISED_2500baseX_Full (1 << 15)
1057#define ADVERTISED_Backplane (1 << 16)
1058#define ADVERTISED_1000baseKX_Full (1 << 17)
1059#define ADVERTISED_10000baseKX4_Full (1 << 18)
1060#define ADVERTISED_10000baseKR_Full (1 << 19)
1061#define ADVERTISED_10000baseR_FEC (1 << 20)
1062#define ADVERTISED_20000baseMLD2_Full (1 << 21)
1063#define ADVERTISED_20000baseKR2_Full (1 << 22)
1064#define ADVERTISED_40000baseKR4_Full (1 << 23)
1065#define ADVERTISED_40000baseCR4_Full (1 << 24)
1066#define ADVERTISED_40000baseSR4_Full (1 << 25)
1067#define ADVERTISED_40000baseLR4_Full (1 << 26)
1068
1069/* The following are all involved in forcing a particular link
1070 * mode for the device for setting things. When getting the
1071 * devices settings, these indicate the current mode and whether
1072 * it was forced up into this mode or autonegotiated.
1073 */
1074
1075/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1076#define SPEED_10 10
1077#define SPEED_100 100
1078#define SPEED_1000 1000
1079#define SPEED_2500 2500
1080#define SPEED_10000 10000
1081#define SPEED_UNKNOWN -1
1082
1083/* Duplex, half or full. */
1084#define DUPLEX_HALF 0x00
1085#define DUPLEX_FULL 0x01
1086#define DUPLEX_UNKNOWN 0xff
1087
1088/* Which connector port. */
1089#define PORT_TP 0x00
1090#define PORT_AUI 0x01
1091#define PORT_MII 0x02
1092#define PORT_FIBRE 0x03
1093#define PORT_BNC 0x04
1094#define PORT_DA 0x05
1095#define PORT_NONE 0xef
1096#define PORT_OTHER 0xff
1097
1098/* Which transceiver to use. */
Florian Fainelli7ec87212013-05-23 01:11:11 +00001099#define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */
1100#define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */
David Howells607ca462012-10-13 10:46:48 +01001101#define XCVR_DUMMY1 0x02
1102#define XCVR_DUMMY2 0x03
1103#define XCVR_DUMMY3 0x04
1104
Ben Hutchingsbf8fc602014-02-12 22:13:57 +00001105/* Enable or disable autonegotiation. */
David Howells607ca462012-10-13 10:46:48 +01001106#define AUTONEG_DISABLE 0x00
1107#define AUTONEG_ENABLE 0x01
1108
1109/* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
1110 * the driver is required to renegotiate link
1111 */
1112#define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */
1113#define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */
1114#define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */
1115#define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */
1116
1117/* Wake-On-Lan options. */
1118#define WAKE_PHY (1 << 0)
1119#define WAKE_UCAST (1 << 1)
1120#define WAKE_MCAST (1 << 2)
1121#define WAKE_BCAST (1 << 3)
1122#define WAKE_ARP (1 << 4)
1123#define WAKE_MAGIC (1 << 5)
1124#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1125
1126/* L2-L4 network traffic flow types */
1127#define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1128#define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1129#define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1130#define AH_ESP_V4_FLOW 0x04 /* hash only */
1131#define TCP_V6_FLOW 0x05 /* hash only */
1132#define UDP_V6_FLOW 0x06 /* hash only */
1133#define SCTP_V6_FLOW 0x07 /* hash only */
1134#define AH_ESP_V6_FLOW 0x08 /* hash only */
1135#define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1136#define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1137#define AH_V6_FLOW 0x0b /* hash only */
1138#define ESP_V6_FLOW 0x0c /* hash only */
1139#define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1140#define IPV4_FLOW 0x10 /* hash only */
1141#define IPV6_FLOW 0x11 /* hash only */
1142#define ETHER_FLOW 0x12 /* spec only (ether_spec) */
1143/* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1144#define FLOW_EXT 0x80000000
Yan Burmand4676ea2012-12-12 02:13:17 +00001145#define FLOW_MAC_EXT 0x40000000
David Howells607ca462012-10-13 10:46:48 +01001146
1147/* L3-L4 network traffic flow hash options */
1148#define RXH_L2DA (1 << 1)
1149#define RXH_VLAN (1 << 2)
1150#define RXH_L3_PROTO (1 << 3)
1151#define RXH_IP_SRC (1 << 4)
1152#define RXH_IP_DST (1 << 5)
1153#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1154#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1155#define RXH_DISCARD (1 << 31)
1156
1157#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
1158
1159/* Special RX classification rule insert location values */
1160#define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
1161#define RX_CLS_LOC_ANY 0xffffffff
1162#define RX_CLS_LOC_FIRST 0xfffffffe
1163#define RX_CLS_LOC_LAST 0xfffffffd
1164
1165/* EEPROM Standards for plug in modules */
1166#define ETH_MODULE_SFF_8079 0x1
1167#define ETH_MODULE_SFF_8079_LEN 256
1168#define ETH_MODULE_SFF_8472 0x2
1169#define ETH_MODULE_SFF_8472_LEN 512
1170
1171/* Reset flags */
1172/* The reset() operation must clear the flags for the components which
1173 * were actually reset. On successful return, the flags indicate the
1174 * components which were not reset, either because they do not exist
1175 * in the hardware or because they cannot be reset independently. The
1176 * driver must never reset any components that were not requested.
1177 */
1178enum ethtool_reset_flags {
1179 /* These flags represent components dedicated to the interface
1180 * the command is addressed to. Shift any flag left by
1181 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1182 * same type.
1183 */
1184 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1185 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1186 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1187 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1188 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1189 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1190 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1191 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1192 * multiple components */
1193
1194 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1195 * this interface */
1196 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1197 * interface, even if shared */
1198};
1199#define ETH_RESET_SHARED_SHIFT 16
1200
1201#endif /* _UAPI_LINUX_ETHTOOL_H */