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