~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/uapi/linux/ethtool.h

Version: ~ [ linux-5.4-rc7 ] ~ [ linux-5.3.11 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.84 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.154 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.201 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.201 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.77 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp