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