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