blob: c7eff13d2f3473c9bc9cfb8efe36f2be7f928bfa [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * ethtool.h: Defines for Linux ethtool.
3 *
4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
8 * christopher.leech@intel.com,
9 * scott.feldman@intel.com)
Santwona Behera59089d82009-02-20 00:58:13 -080010 * Portions Copyright (C) Sun Microsystems 2008
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 */
12
13#ifndef _LINUX_ETHTOOL_H
14#define _LINUX_ETHTOOL_H
15
Ben Hutchings3a7da392011-03-17 07:34:32 +000016#ifdef __KERNEL__
17#include <linux/compat.h>
18#endif
Kirill A. Shutemove621e692008-03-07 11:11:13 -080019#include <linux/types.h>
Ben Hutchings6099e3d2010-09-20 08:42:08 +000020#include <linux/if_ether.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22/* This should work for both 32 and 64 bit userland. */
23struct ethtool_cmd {
David Woodhousec3ce7e22006-04-29 01:53:47 +010024 __u32 cmd;
25 __u32 supported; /* Features this interface supports */
26 __u32 advertising; /* Features this interface advertises */
27 __u16 speed; /* The forced speed, 10Mb, 100Mb, gigabit */
28 __u8 duplex; /* Duplex, half or full */
29 __u8 port; /* Which connector port */
30 __u8 phy_address;
31 __u8 transceiver; /* Which transceiver to use */
32 __u8 autoneg; /* Enable or disable autonegotiation */
Ben Hutchings0c09c1a2009-04-29 08:21:53 +000033 __u8 mdio_support;
David Woodhousec3ce7e22006-04-29 01:53:47 +010034 __u32 maxtxpkt; /* Tx pkts before generating tx int */
35 __u32 maxrxpkt; /* Rx pkts before generating rx int */
Brandon Philipsb11f8d82008-07-15 02:18:41 -070036 __u16 speed_hi;
Chaitanya Lala18760f12009-06-08 14:28:54 +000037 __u8 eth_tp_mdix;
38 __u8 reserved2;
Ben Hutchings0c09c1a2009-04-29 08:21:53 +000039 __u32 lp_advertising; /* Features the link partner advertises */
40 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -070041};
42
Brandon Philipsb11f8d82008-07-15 02:18:41 -070043static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
44 __u32 speed)
45{
46
47 ep->speed = (__u16)speed;
48 ep->speed_hi = (__u16)(speed >> 16);
49}
50
51static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep)
52{
53 return (ep->speed_hi << 16) | ep->speed;
54}
55
Matt Carlson141518c2009-12-03 08:36:22 +000056#define ETHTOOL_FWVERS_LEN 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#define ETHTOOL_BUSINFO_LEN 32
58/* these strings are set to whatever the driver author decides... */
59struct ethtool_drvinfo {
David Woodhousec3ce7e22006-04-29 01:53:47 +010060 __u32 cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 char driver[32]; /* driver short name, "tulip", "eepro100" */
62 char version[32]; /* driver version string */
Matt Carlson141518c2009-12-03 08:36:22 +000063 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
65 /* For PCI devices, use pci_name(pci_dev). */
66 char reserved1[32];
Jeff Garzik339bf022007-08-15 16:01:32 -070067 char reserved2[12];
Jeff Garzikd17792e2010-03-04 08:21:53 +000068 /*
69 * Some struct members below are filled in
70 * using ops->get_sset_count(). Obtaining
71 * this info from ethtool_drvinfo is now
72 * deprecated; Use ETHTOOL_GSSET_INFO
73 * instead.
74 */
Jeff Garzik339bf022007-08-15 16:01:32 -070075 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
David Woodhousec3ce7e22006-04-29 01:53:47 +010076 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
77 __u32 testinfo_len;
78 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
79 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080};
81
82#define SOPASS_MAX 6
83/* wake-on-lan settings */
84struct ethtool_wolinfo {
David Woodhousec3ce7e22006-04-29 01:53:47 +010085 __u32 cmd;
86 __u32 supported;
87 __u32 wolopts;
88 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089};
90
91/* for passing single values */
92struct ethtool_value {
David Woodhousec3ce7e22006-04-29 01:53:47 +010093 __u32 cmd;
94 __u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095};
96
97/* for passing big chunks of data */
98struct ethtool_regs {
David Woodhousec3ce7e22006-04-29 01:53:47 +010099 __u32 cmd;
100 __u32 version; /* driver-specific, indicates different chips/revs */
101 __u32 len; /* bytes */
102 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103};
104
105/* for passing EEPROM chunks */
106struct ethtool_eeprom {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100107 __u32 cmd;
108 __u32 magic;
109 __u32 offset; /* in bytes */
110 __u32 len; /* in bytes */
111 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112};
113
114/* for configuring coalescing parameters of chip */
115struct ethtool_coalesce {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100116 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118 /* How many usecs to delay an RX interrupt after
119 * a packet arrives. If 0, only rx_max_coalesced_frames
120 * is used.
121 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100122 __u32 rx_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124 /* How many packets to delay an RX interrupt after
125 * a packet arrives. If 0, only rx_coalesce_usecs is
126 * used. It is illegal to set both usecs and max frames
127 * to zero as this would cause RX interrupts to never be
128 * generated.
129 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100130 __u32 rx_max_coalesced_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132 /* Same as above two parameters, except that these values
133 * apply while an IRQ is being serviced by the host. Not
134 * all cards support this feature and the values are ignored
135 * in that case.
136 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100137 __u32 rx_coalesce_usecs_irq;
138 __u32 rx_max_coalesced_frames_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140 /* How many usecs to delay a TX interrupt after
141 * a packet is sent. If 0, only tx_max_coalesced_frames
142 * is used.
143 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100144 __u32 tx_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146 /* How many packets to delay a TX interrupt after
147 * a packet is sent. If 0, only tx_coalesce_usecs is
148 * used. It is illegal to set both usecs and max frames
149 * to zero as this would cause TX interrupts to never be
150 * generated.
151 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100152 __u32 tx_max_coalesced_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
154 /* Same as above two parameters, except that these values
155 * apply while an IRQ is being serviced by the host. Not
156 * all cards support this feature and the values are ignored
157 * in that case.
158 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100159 __u32 tx_coalesce_usecs_irq;
160 __u32 tx_max_coalesced_frames_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162 /* How many usecs to delay in-memory statistics
163 * block updates. Some drivers do not have an in-memory
164 * statistic block, and in such cases this value is ignored.
165 * This value must not be zero.
166 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100167 __u32 stats_block_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169 /* Adaptive RX/TX coalescing is an algorithm implemented by
170 * some drivers to improve latency under low packet rates and
171 * improve throughput under high packet rates. Some drivers
172 * only implement one of RX or TX adaptive coalescing. Anything
173 * not implemented by the driver causes these values to be
174 * silently ignored.
175 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100176 __u32 use_adaptive_rx_coalesce;
177 __u32 use_adaptive_tx_coalesce;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179 /* When the packet rate (measured in packets per second)
180 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
181 * used.
182 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100183 __u32 pkt_rate_low;
184 __u32 rx_coalesce_usecs_low;
185 __u32 rx_max_coalesced_frames_low;
186 __u32 tx_coalesce_usecs_low;
187 __u32 tx_max_coalesced_frames_low;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 /* When the packet rate is below pkt_rate_high but above
190 * pkt_rate_low (both measured in packets per second) the
191 * normal {rx,tx}_* coalescing parameters are used.
192 */
193
194 /* When the packet rate is (measured in packets per second)
195 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
196 * used.
197 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100198 __u32 pkt_rate_high;
199 __u32 rx_coalesce_usecs_high;
200 __u32 rx_max_coalesced_frames_high;
201 __u32 tx_coalesce_usecs_high;
202 __u32 tx_max_coalesced_frames_high;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204 /* How often to do adaptive coalescing packet rate sampling,
205 * measured in seconds. Must not be zero.
206 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100207 __u32 rate_sample_interval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208};
209
210/* for configuring RX/TX ring parameters */
211struct ethtool_ringparam {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100212 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214 /* Read only attributes. These indicate the maximum number
215 * of pending RX/TX ring entries the driver will allow the
216 * user to set.
217 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100218 __u32 rx_max_pending;
219 __u32 rx_mini_max_pending;
220 __u32 rx_jumbo_max_pending;
221 __u32 tx_max_pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 /* Values changeable by the user. The valid values are
224 * in the range 1 to the "*_max_pending" counterpart above.
225 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100226 __u32 rx_pending;
227 __u32 rx_mini_pending;
228 __u32 rx_jumbo_pending;
229 __u32 tx_pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230};
231
232/* for configuring link flow control parameters */
233struct ethtool_pauseparam {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100234 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
237 * being true) the user may set 'autonet' here non-zero to have the
238 * pause parameters be auto-negotiated too. In such a case, the
239 * {rx,tx}_pause values below determine what capabilities are
240 * advertised.
241 *
242 * If 'autoneg' is zero or the link is not being auto-negotiated,
243 * then {rx,tx}_pause force the driver to use/not-use pause
244 * flow control.
245 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100246 __u32 autoneg;
247 __u32 rx_pause;
248 __u32 tx_pause;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249};
250
251#define ETH_GSTRING_LEN 32
252enum ethtool_stringset {
253 ETH_SS_TEST = 0,
254 ETH_SS_STATS,
Jeff Garzik339bf022007-08-15 16:01:32 -0700255 ETH_SS_PRIV_FLAGS,
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800256 ETH_SS_NTUPLE_FILTERS,
Michał Mirosław5455c692011-02-15 16:59:17 +0000257 ETH_SS_FEATURES,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258};
259
260/* for passing string sets for data tagging */
261struct ethtool_gstrings {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100262 __u32 cmd; /* ETHTOOL_GSTRINGS */
263 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
264 __u32 len; /* number of strings in the string set */
265 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266};
267
Jeff Garzik723b2f52010-03-03 22:51:50 +0000268struct ethtool_sset_info {
269 __u32 cmd; /* ETHTOOL_GSSET_INFO */
270 __u32 reserved;
271 __u64 sset_mask; /* input: each bit selects an sset to query */
272 /* output: each bit a returned sset */
273 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits
274 in sset_mask. One bit implies one
275 __u32, two bits implies two
276 __u32's, etc. */
277};
278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279enum ethtool_test_flags {
280 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
281 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
282};
283
284/* for requesting NIC test and getting results*/
285struct ethtool_test {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100286 __u32 cmd; /* ETHTOOL_TEST */
287 __u32 flags; /* ETH_TEST_FL_xxx */
288 __u32 reserved;
289 __u32 len; /* result length, in number of u64 elements */
290 __u64 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291};
292
293/* for dumping NIC-specific statistics */
294struct ethtool_stats {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100295 __u32 cmd; /* ETHTOOL_GSTATS */
296 __u32 n_stats; /* number of u64's being returned */
297 __u64 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298};
299
Jon Wetzela6f9a702005-08-20 17:15:54 -0700300struct ethtool_perm_addr {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100301 __u32 cmd; /* ETHTOOL_GPERMADDR */
302 __u32 size;
303 __u8 data[0];
Jon Wetzela6f9a702005-08-20 17:15:54 -0700304};
305
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700306/* boolean flags controlling per-interface behavior characteristics.
307 * When reading, the flag indicates whether or not a certain behavior
308 * is enabled/present. When writing, the flag indicates whether
309 * or not the driver should turn on (set) or off (clear) a behavior.
310 *
311 * Some behaviors may read-only (unconditionally absent or present).
312 * If such is the case, return EINVAL in the set-flags operation if the
313 * flag differs from the read-only value.
314 */
315enum ethtool_flags {
Jesse Grossd5dbda22010-10-20 13:56:07 +0000316 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
317 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700318 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800319 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
stephen hemmingerb00fabb2010-03-29 14:47:27 +0000320 ETH_FLAG_RXHASH = (1 << 28),
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700321};
322
Santwona Behera59089d82009-02-20 00:58:13 -0800323/* The following structures are for supporting RX network flow
Ben Hutchingse0355872010-09-14 09:10:03 +0000324 * classification and RX n-tuple configuration. Note, all multibyte
325 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
326 * be in network byte order.
327 */
328
329/**
330 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
331 * @ip4src: Source host
332 * @ip4dst: Destination host
333 * @psrc: Source port
334 * @pdst: Destination port
335 * @tos: Type-of-service
336 *
337 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
Santwona Behera59089d82009-02-20 00:58:13 -0800338 */
339struct ethtool_tcpip4_spec {
340 __be32 ip4src;
341 __be32 ip4dst;
342 __be16 psrc;
343 __be16 pdst;
344 __u8 tos;
345};
346
Ben Hutchingse0355872010-09-14 09:10:03 +0000347/**
348 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
349 * @ip4src: Source host
350 * @ip4dst: Destination host
351 * @spi: Security parameters index
352 * @tos: Type-of-service
353 *
354 * This can be used to specify an IPsec transport or tunnel over IPv4.
355 */
Santwona Behera59089d82009-02-20 00:58:13 -0800356struct ethtool_ah_espip4_spec {
357 __be32 ip4src;
358 __be32 ip4dst;
359 __be32 spi;
360 __u8 tos;
361};
362
Santwona Behera59089d82009-02-20 00:58:13 -0800363#define ETH_RX_NFC_IP4 1
Santwona Behera59089d82009-02-20 00:58:13 -0800364
Ben Hutchingse0355872010-09-14 09:10:03 +0000365/**
366 * struct ethtool_usrip4_spec - general flow specification for IPv4
367 * @ip4src: Source host
368 * @ip4dst: Destination host
369 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
370 * @tos: Type-of-service
371 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
372 * @proto: Transport protocol number; mask must be 0
373 */
Santwona Behera59089d82009-02-20 00:58:13 -0800374struct ethtool_usrip4_spec {
375 __be32 ip4src;
376 __be32 ip4dst;
377 __be32 l4_4_bytes;
378 __u8 tos;
379 __u8 ip_ver;
380 __u8 proto;
381};
382
Alexander Duyck127fe532011-04-08 18:01:59 +0000383union ethtool_flow_union {
384 struct ethtool_tcpip4_spec tcp_ip4_spec;
385 struct ethtool_tcpip4_spec udp_ip4_spec;
386 struct ethtool_tcpip4_spec sctp_ip4_spec;
387 struct ethtool_ah_espip4_spec ah_ip4_spec;
388 struct ethtool_ah_espip4_spec esp_ip4_spec;
389 struct ethtool_usrip4_spec usr_ip4_spec;
390 struct ethhdr ether_spec;
391 __u8 hdata[60];
392};
393
394struct ethtool_flow_ext {
395 __be16 vlan_etype;
396 __be16 vlan_tci;
397 __be32 data[2];
398};
399
Ben Hutchingse0355872010-09-14 09:10:03 +0000400/**
401 * struct ethtool_rx_flow_spec - specification for RX flow filter
402 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
403 * @h_u: Flow fields to match (dependent on @flow_type)
Alexander Duyck127fe532011-04-08 18:01:59 +0000404 * @h_ext: Additional fields to match
405 * @m_u: Masks for flow field bits to be matched
406 * @m_ext: Masks for additional field bits to be matched
407 * Note, all additional fields must be ignored unless @flow_type
408 * includes the %FLOW_EXT flag.
Ben Hutchingse0355872010-09-14 09:10:03 +0000409 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
410 * if packets should be discarded
411 * @location: Index of filter in hardware table
412 */
Santwona Behera59089d82009-02-20 00:58:13 -0800413struct ethtool_rx_flow_spec {
Santwona Behera0853ad62008-07-02 03:47:41 -0700414 __u32 flow_type;
Alexander Duyck127fe532011-04-08 18:01:59 +0000415 union ethtool_flow_union h_u;
416 struct ethtool_flow_ext h_ext;
417 union ethtool_flow_union m_u;
418 struct ethtool_flow_ext m_ext;
Santwona Behera59089d82009-02-20 00:58:13 -0800419 __u64 ring_cookie;
420 __u32 location;
421};
422
Ben Hutchingse0355872010-09-14 09:10:03 +0000423/**
424 * struct ethtool_rxnfc - command to get or set RX flow classification rules
425 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
426 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
427 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
428 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
429 * @data: Command-dependent value
430 * @fs: Flow filter specification
431 * @rule_cnt: Number of rules to be affected
432 * @rule_locs: Array of valid rule indices
433 *
434 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
435 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
436 * structure fields must not be used.
437 *
438 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
439 * on return.
440 *
441 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
442 * rules on return.
443 *
444 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an
445 * existing filter rule on entry and @fs contains the rule on return.
446 *
447 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
448 * user buffer for @rule_locs on entry. On return, @data is the size
449 * of the filter table and @rule_locs contains the indices of the
450 * defined rules.
451 *
452 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or
453 * update. @fs.@location specifies the index to use and must not be
454 * ignored.
455 *
456 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an
457 * existing filter rule on entry.
458 *
459 * Implementation of indexed classification rules generally requires a
460 * TCAM.
461 */
Santwona Behera59089d82009-02-20 00:58:13 -0800462struct ethtool_rxnfc {
463 __u32 cmd;
464 __u32 flow_type;
Santwona Behera59089d82009-02-20 00:58:13 -0800465 __u64 data;
466 struct ethtool_rx_flow_spec fs;
467 __u32 rule_cnt;
468 __u32 rule_locs[0];
Santwona Behera0853ad62008-07-02 03:47:41 -0700469};
470
Ben Hutchings3a7da392011-03-17 07:34:32 +0000471#ifdef __KERNEL__
472#ifdef CONFIG_COMPAT
473
474struct compat_ethtool_rx_flow_spec {
475 u32 flow_type;
Alexander Duyck127fe532011-04-08 18:01:59 +0000476 union ethtool_flow_union h_u;
477 struct ethtool_flow_ext h_ext;
478 union ethtool_flow_union m_u;
479 struct ethtool_flow_ext m_ext;
Ben Hutchings3a7da392011-03-17 07:34:32 +0000480 compat_u64 ring_cookie;
481 u32 location;
482};
483
484struct compat_ethtool_rxnfc {
485 u32 cmd;
486 u32 flow_type;
487 compat_u64 data;
488 struct compat_ethtool_rx_flow_spec fs;
489 u32 rule_cnt;
490 u32 rule_locs[0];
491};
492
493#endif /* CONFIG_COMPAT */
494#endif /* __KERNEL__ */
495
Ben Hutchingse0355872010-09-14 09:10:03 +0000496/**
497 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
498 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
499 * @size: On entry, the array size of the user buffer. On return from
500 * %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
501 * @ring_index: RX ring/queue index for each hash value
502 */
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000503struct ethtool_rxfh_indir {
504 __u32 cmd;
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000505 __u32 size;
Ben Hutchingse0355872010-09-14 09:10:03 +0000506 __u32 ring_index[0];
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000507};
508
Ben Hutchingse0355872010-09-14 09:10:03 +0000509/**
510 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
511 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
512 * @h_u: Flow field values to match (dependent on @flow_type)
513 * @m_u: Masks for flow field value bits to be ignored
514 * @vlan_tag: VLAN tag to match
515 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
516 * @data: Driver-dependent data to match
517 * @data_mask: Mask for driver-dependent data bits to be ignored
518 * @action: RX ring/queue index to deliver to (non-negative) or other action
519 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
520 *
Ben Hutchingsbe2902d2010-09-16 11:28:07 +0000521 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
522 * a field value and mask are both zero this is treated as if all mask
523 * bits are set i.e. the field is ignored.
Ben Hutchingse0355872010-09-14 09:10:03 +0000524 */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800525struct ethtool_rx_ntuple_flow_spec {
526 __u32 flow_type;
527 union {
528 struct ethtool_tcpip4_spec tcp_ip4_spec;
529 struct ethtool_tcpip4_spec udp_ip4_spec;
530 struct ethtool_tcpip4_spec sctp_ip4_spec;
531 struct ethtool_ah_espip4_spec ah_ip4_spec;
532 struct ethtool_ah_espip4_spec esp_ip4_spec;
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800533 struct ethtool_usrip4_spec usr_ip4_spec;
Ben Hutchings6099e3d2010-09-20 08:42:08 +0000534 struct ethhdr ether_spec;
Ben Hutchingse0de7c92010-09-14 09:13:08 +0000535 __u8 hdata[72];
Ben Hutchingse0355872010-09-14 09:10:03 +0000536 } h_u, m_u;
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800537
538 __u16 vlan_tag;
539 __u16 vlan_tag_mask;
Ben Hutchingse0355872010-09-14 09:10:03 +0000540 __u64 data;
541 __u64 data_mask;
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800542
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800543 __s32 action;
Ben Hutchingsc22ab782010-09-20 08:41:47 +0000544#define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
545#define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800546};
547
Ben Hutchingse0355872010-09-14 09:10:03 +0000548/**
Ben Hutchingsc22ab782010-09-20 08:41:47 +0000549 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
Ben Hutchingse0355872010-09-14 09:10:03 +0000550 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
551 * @fs: Flow filter specification
552 */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800553struct ethtool_rx_ntuple {
554 __u32 cmd;
555 struct ethtool_rx_ntuple_flow_spec fs;
556};
557
Ajit Khaparde05c6a8d2009-09-02 17:02:55 +0000558#define ETHTOOL_FLASH_MAX_FILENAME 128
559enum ethtool_flash_op_type {
560 ETHTOOL_FLASH_ALL_REGIONS = 0,
561};
562
563/* for passing firmware flashing related parameters */
564struct ethtool_flash {
565 __u32 cmd;
566 __u32 region;
567 char data[ETHTOOL_FLASH_MAX_FILENAME];
568};
569
Michał Mirosław5455c692011-02-15 16:59:17 +0000570/* for returning and changing feature sets */
571
572/**
573 * struct ethtool_get_features_block - block with state of 32 features
574 * @available: mask of changeable features
575 * @requested: mask of features requested to be enabled if possible
576 * @active: mask of currently enabled features
577 * @never_changed: mask of features not changeable for any device
578 */
579struct ethtool_get_features_block {
580 __u32 available;
581 __u32 requested;
582 __u32 active;
583 __u32 never_changed;
584};
585
586/**
587 * struct ethtool_gfeatures - command to get state of device's features
588 * @cmd: command number = %ETHTOOL_GFEATURES
589 * @size: in: number of elements in the features[] array;
590 * out: number of elements in features[] needed to hold all features
591 * @features: state of features
592 */
593struct ethtool_gfeatures {
594 __u32 cmd;
595 __u32 size;
596 struct ethtool_get_features_block features[0];
597};
598
599/**
600 * struct ethtool_set_features_block - block with request for 32 features
601 * @valid: mask of features to be changed
602 * @requested: values of features to be changed
603 */
604struct ethtool_set_features_block {
605 __u32 valid;
606 __u32 requested;
607};
608
609/**
610 * struct ethtool_sfeatures - command to request change in device's features
611 * @cmd: command number = %ETHTOOL_SFEATURES
612 * @size: array size of the features[] array
613 * @features: feature change masks
614 */
615struct ethtool_sfeatures {
616 __u32 cmd;
617 __u32 size;
618 struct ethtool_set_features_block features[0];
619};
620
621/*
622 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
623 * values of corresponding bits in features[].requested. Bits in .requested
624 * not set in .valid or not changeable are ignored.
625 *
626 * Returns %EINVAL when .valid contains undefined or never-changable bits
627 * or size is not equal to required number of features words (32-bit blocks).
628 * Returns >= 0 if request was completed; bits set in the value mean:
629 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
630 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
631 * those bits were ignored.
632 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
633 * resulting state of bits masked by .valid is not equal to .requested.
634 * Probably there are other device-specific constraints on some features
635 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
636 * here as though ignored bits were cleared.
Michał Mirosław39fc0ce2011-02-22 16:52:29 +0000637 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
638 * compatibility functions. Requested offload state cannot be properly
639 * managed by kernel.
Michał Mirosław5455c692011-02-15 16:59:17 +0000640 *
641 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
642 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
643 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
644 * significant bit in features[0] fields. Empty strings mark undefined features.
645 */
646enum ethtool_sfeatures_retval_bits {
647 ETHTOOL_F_UNSUPPORTED__BIT,
648 ETHTOOL_F_WISH__BIT,
Michał Mirosław39fc0ce2011-02-22 16:52:29 +0000649 ETHTOOL_F_COMPAT__BIT,
Michał Mirosław5455c692011-02-15 16:59:17 +0000650};
651
652#define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
653#define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
Michał Mirosław39fc0ce2011-02-22 16:52:29 +0000654#define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
Michał Mirosław5455c692011-02-15 16:59:17 +0000655
David Woodhousec3ce7e22006-04-29 01:53:47 +0100656#ifdef __KERNEL__
657
David S. Millera1467082010-02-14 22:38:54 -0800658#include <linux/rculist.h>
659
Michał Mirosław27660512011-03-18 16:56:34 +0000660/* needed by dev_disable_lro() */
661extern int __ethtool_set_flags(struct net_device *dev, u32 flags);
662
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800663struct ethtool_rx_ntuple_flow_spec_container {
664 struct ethtool_rx_ntuple_flow_spec fs;
665 struct list_head list;
666};
667
668struct ethtool_rx_ntuple_list {
669#define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
670#define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
671 struct list_head list;
672 unsigned int count;
673};
674
Ben Hutchings68f512f2011-04-02 00:35:15 +0100675/**
676 * enum ethtool_phys_id_state - indicator state for physical identification
677 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
678 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
679 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
680 * is not supported)
681 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
682 * is not supported)
683 */
684enum ethtool_phys_id_state {
685 ETHTOOL_ID_INACTIVE,
686 ETHTOOL_ID_ACTIVE,
687 ETHTOOL_ID_ON,
688 ETHTOOL_ID_OFF
689};
690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691struct net_device;
692
693/* Some generic methods drivers may use in their ethtool_ops */
694u32 ethtool_op_get_link(struct net_device *dev);
695u32 ethtool_op_get_tx_csum(struct net_device *dev);
696int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
Jon Mason69f6a0f2005-05-29 20:27:24 -0700697int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
Michael Chan6460d942007-07-14 19:07:52 -0700698int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699u32 ethtool_op_get_sg(struct net_device *dev);
700int ethtool_op_set_sg(struct net_device *dev, u32 data);
701u32 ethtool_op_get_tso(struct net_device *dev);
702int ethtool_op_set_tso(struct net_device *dev, u32 data);
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700703u32 ethtool_op_get_ufo(struct net_device *dev);
704int ethtool_op_set_ufo(struct net_device *dev, u32 data);
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700705u32 ethtool_op_get_flags(struct net_device *dev);
Ben Hutchings1437ce32010-06-30 02:44:32 +0000706int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800707void ethtool_ntuple_flush(struct net_device *dev);
Stanislaw Gruszka673e63c2011-03-22 23:54:49 +0000708bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710/**
Ben Hutchings8717d072011-04-01 23:57:41 +0100711 * struct ethtool_ops - optional netdev operations
712 * @get_settings: Get various device settings including Ethernet link
713 * settings. Returns a negative error code or zero.
714 * @set_settings: Set various device settings including Ethernet link
715 * settings. Returns a negative error code or zero.
716 * @get_drvinfo: Report driver/device information. Should only set the
717 * @driver, @version, @fw_version and @bus_info fields. If not
718 * implemented, the @driver and @bus_info fields will be filled in
719 * according to the netdev's parent device.
720 * @get_regs_len: Get buffer length required for @get_regs
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100721 * @get_regs: Get device registers
722 * @get_wol: Report whether Wake-on-Lan is enabled
Ben Hutchings8717d072011-04-01 23:57:41 +0100723 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
724 * or zero.
725 * @get_msglevel: Report driver message level. This should be the value
726 * of the @msg_enable field used by netif logging functions.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100727 * @set_msglevel: Set driver message level
Ben Hutchings8717d072011-04-01 23:57:41 +0100728 * @nway_reset: Restart autonegotiation. Returns a negative error code
729 * or zero.
730 * @get_link: Report whether physical link is up. Will only be called if
731 * the netdev is up. Should usually be set to ethtool_op_get_link(),
732 * which uses netif_carrier_ok().
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100733 * @get_eeprom: Read data from the device EEPROM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 * Should fill in the magic field. Don't need to check len for zero
735 * or wraparound. Fill in the data argument with the eeprom values
736 * from offset to offset + len. Update len to the amount read.
737 * Returns an error or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100738 * @set_eeprom: Write data to the device EEPROM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 * Should validate the magic field. Don't need to check len for zero
740 * or wraparound. Update len to the amount written. Returns an error
741 * or zero.
Ben Hutchings8717d072011-04-01 23:57:41 +0100742 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
743 * error code or zero.
744 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
745 * error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100746 * @get_ringparam: Report ring sizes
Ben Hutchings8717d072011-04-01 23:57:41 +0100747 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100748 * @get_pauseparam: Report pause parameters
Ben Hutchings8717d072011-04-01 23:57:41 +0100749 * @set_pauseparam: Set pause parameters. Returns a negative error code
750 * or zero.
751 * @get_rx_csum: Deprecated in favour of the netdev feature %NETIF_F_RXCSUM.
752 * Report whether receive checksums are turned on or off.
753 * @set_rx_csum: Deprecated in favour of generic netdev features. Turn
754 * receive checksum on or off. Returns a negative error code or zero.
755 * @get_tx_csum: Deprecated as redundant. Report whether transmit checksums
756 * are turned on or off.
757 * @set_tx_csum: Deprecated in favour of generic netdev features. Turn
758 * transmit checksums on or off. Returns a egative error code or zero.
759 * @get_sg: Deprecated as redundant. Report whether scatter-gather is
760 * enabled.
761 * @set_sg: Deprecated in favour of generic netdev features. Turn
762 * scatter-gather on or off. Returns a negative error code or zero.
763 * @get_tso: Deprecated as redundant. Report whether TCP segmentation
764 * offload is enabled.
765 * @set_tso: Deprecated in favour of generic netdev features. Turn TCP
766 * segmentation offload on or off. Returns a negative error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100767 * @self_test: Run specified self-tests
768 * @get_strings: Return a set of strings that describe the requested objects
Ben Hutchings68f512f2011-04-02 00:35:15 +0100769 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
770 * attached to it. The implementation may update the indicator
771 * asynchronously or synchronously, but in either case it must return
772 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
773 * and must either activate asynchronous updates or return -%EINVAL.
774 * If it returns -%EINVAL then it will be called again at intervals with
775 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
776 * the indicator accordingly. Finally, it is called with the argument
777 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
778 * negative error code or zero.
779 * @phys_id: Deprecated in favour of @set_phys_id.
780 * Identify the physical device, e.g. by flashing an LED
Ben Hutchings8717d072011-04-01 23:57:41 +0100781 * attached to it until interrupted by a signal or the given time
782 * (in seconds) elapses. If the given time is zero, use a default
783 * time limit. Returns a negative error code or zero. Being
784 * interrupted by a signal is not an error.
785 * @get_ethtool_stats: Return extended statistics about the device.
786 * This is only useful if the device maintains statistics not
787 * included in &struct rtnl_link_stats64.
788 * @begin: Function to be called before any other operation. Returns a
789 * negative error code or zero.
790 * @complete: Function to be called after any other operation except
791 * @begin. Will be called even if the other operation failed.
792 * @get_ufo: Deprecated as redundant. Report whether UDP fragmentation
793 * offload is enabled.
794 * @set_ufo: Deprecated in favour of generic netdev features. Turn UDP
795 * fragmentation offload on or off. Returns a negative error code or zero.
796 * @get_flags: Deprecated as redundant. Report features included in
797 * &enum ethtool_flags that are enabled.
798 * @set_flags: Deprecated in favour of generic netdev features. Turn
799 * features included in &enum ethtool_flags on or off. Returns a
800 * negative error code or zero.
801 * @get_priv_flags: Report driver-specific feature flags.
802 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
803 * error code or zero.
804 * @get_sset_count: Get number of strings that @get_strings will write.
805 * @get_rxnfc: Get RX flow classification rules. Returns a negative
806 * error code or zero.
807 * @set_rxnfc: Set RX flow classification rules. Returns a negative
808 * error code or zero.
809 * @flash_device: Write a firmware image to device's flash memory.
810 * Returns a negative error code or zero.
811 * @reset: Reset (part of) the device, as specified by a bitmask of
812 * flags from &enum ethtool_reset_flags. Returns a negative
813 * error code or zero.
814 * @set_rx_ntuple: Set an RX n-tuple rule. Returns a negative error code
815 * or zero.
816 * @get_rx_ntuple: Deprecated.
817 * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
818 * Returns a negative error code or zero.
819 * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
820 * Returns a negative error code or zero.
821 *
822 * All operations are optional (i.e. the function pointer may be set
823 * to %NULL) and callers must take this into account. Callers must
824 * hold the RTNL, except that for @get_drvinfo the caller may or may
825 * not hold the RTNL.
826 *
827 * See the structures used by these operations for further documentation.
828 *
829 * See &struct net_device and &struct net_device_ops for documentation
830 * of the generic netdev features interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
832struct ethtool_ops {
833 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
834 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
835 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
836 int (*get_regs_len)(struct net_device *);
837 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
838 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
839 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
840 u32 (*get_msglevel)(struct net_device *);
841 void (*set_msglevel)(struct net_device *, u32);
842 int (*nway_reset)(struct net_device *);
843 u32 (*get_link)(struct net_device *);
844 int (*get_eeprom_len)(struct net_device *);
chavey97f8aef2010-04-07 21:54:42 -0700845 int (*get_eeprom)(struct net_device *,
846 struct ethtool_eeprom *, u8 *);
847 int (*set_eeprom)(struct net_device *,
848 struct ethtool_eeprom *, u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
850 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
chavey97f8aef2010-04-07 21:54:42 -0700851 void (*get_ringparam)(struct net_device *,
852 struct ethtool_ringparam *);
853 int (*set_ringparam)(struct net_device *,
854 struct ethtool_ringparam *);
855 void (*get_pauseparam)(struct net_device *,
856 struct ethtool_pauseparam*);
857 int (*set_pauseparam)(struct net_device *,
858 struct ethtool_pauseparam*);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 u32 (*get_rx_csum)(struct net_device *);
860 int (*set_rx_csum)(struct net_device *, u32);
861 u32 (*get_tx_csum)(struct net_device *);
862 int (*set_tx_csum)(struct net_device *, u32);
863 u32 (*get_sg)(struct net_device *);
864 int (*set_sg)(struct net_device *, u32);
865 u32 (*get_tso)(struct net_device *);
866 int (*set_tso)(struct net_device *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
868 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
Ben Hutchings68f512f2011-04-02 00:35:15 +0100869 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 int (*phys_id)(struct net_device *, u32);
chavey97f8aef2010-04-07 21:54:42 -0700871 void (*get_ethtool_stats)(struct net_device *,
872 struct ethtool_stats *, u64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 int (*begin)(struct net_device *);
874 void (*complete)(struct net_device *);
chavey97f8aef2010-04-07 21:54:42 -0700875 u32 (*get_ufo)(struct net_device *);
876 int (*set_ufo)(struct net_device *, u32);
877 u32 (*get_flags)(struct net_device *);
878 int (*set_flags)(struct net_device *, u32);
879 u32 (*get_priv_flags)(struct net_device *);
880 int (*set_priv_flags)(struct net_device *, u32);
Jeff Garzikff03d492007-08-15 16:01:08 -0700881 int (*get_sset_count)(struct net_device *, int);
chavey97f8aef2010-04-07 21:54:42 -0700882 int (*get_rxnfc)(struct net_device *,
883 struct ethtool_rxnfc *, void *);
Santwona Behera59089d82009-02-20 00:58:13 -0800884 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
chavey97f8aef2010-04-07 21:54:42 -0700885 int (*flash_device)(struct net_device *, struct ethtool_flash *);
Ben Hutchingsd73d3a82009-10-05 10:59:58 +0000886 int (*reset)(struct net_device *, u32 *);
chavey97f8aef2010-04-07 21:54:42 -0700887 int (*set_rx_ntuple)(struct net_device *,
888 struct ethtool_rx_ntuple *);
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800889 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000890 int (*get_rxfh_indir)(struct net_device *,
891 struct ethtool_rxfh_indir *);
892 int (*set_rxfh_indir)(struct net_device *,
893 const struct ethtool_rxfh_indir *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894};
David Woodhousec3ce7e22006-04-29 01:53:47 +0100895#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
897/* CMDs currently supported */
898#define ETHTOOL_GSET 0x00000001 /* Get settings. */
899#define ETHTOOL_SSET 0x00000002 /* Set settings. */
900#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
901#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
902#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
903#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000904#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
905#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
Ben Hutchingse596e6e2010-12-09 12:08:35 +0000907/* Get link status for host, i.e. whether the interface *and* the
908 * physical port (if there is one) are up (ethtool_value). */
909#define ETHTOOL_GLINK 0x0000000a
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000910#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
911#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
913#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
914#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
915#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
916#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
917#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000918#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
919#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
920#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
921#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
923 * (ethtool_value) */
924#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
925 * (ethtool_value). */
926#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
927#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000928#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
930#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
931#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
Jon Wetzela6f9a702005-08-20 17:15:54 -0700932#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700933#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
934#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
Herbert Xu37c31852006-06-22 03:07:29 -0700935#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
936#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700937#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
938#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000939#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
940#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
chavey97f8aef2010-04-07 21:54:42 -0700942#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
943#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
Herbert Xub240a0e2008-12-15 23:44:31 -0800944#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
945#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
chavey97f8aef2010-04-07 21:54:42 -0700946#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
947#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
948#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
949#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
950#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
951#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
952#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
953#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
954#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
955#define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */
956#define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000957#define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
958#define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800959
Michał Mirosław5455c692011-02-15 16:59:17 +0000960#define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
961#define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
962
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963/* compatibility with older code */
964#define SPARC_ETH_GSET ETHTOOL_GSET
965#define SPARC_ETH_SSET ETHTOOL_SSET
966
967/* Indicates what features are supported by the interface. */
968#define SUPPORTED_10baseT_Half (1 << 0)
969#define SUPPORTED_10baseT_Full (1 << 1)
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000970#define SUPPORTED_100baseT_Half (1 << 2)
971#define SUPPORTED_100baseT_Full (1 << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972#define SUPPORTED_1000baseT_Half (1 << 4)
973#define SUPPORTED_1000baseT_Full (1 << 5)
974#define SUPPORTED_Autoneg (1 << 6)
975#define SUPPORTED_TP (1 << 7)
976#define SUPPORTED_AUI (1 << 8)
977#define SUPPORTED_MII (1 << 9)
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000978#define SUPPORTED_FIBRE (1 << 10)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979#define SUPPORTED_BNC (1 << 11)
980#define SUPPORTED_10000baseT_Full (1 << 12)
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000981#define SUPPORTED_Pause (1 << 13)
Andy Fleming00db8182005-07-30 19:31:23 -0400982#define SUPPORTED_Asym_Pause (1 << 14)
Michael Chan427c2192007-05-03 13:17:25 -0700983#define SUPPORTED_2500baseX_Full (1 << 15)
Ben Hutchings894b19a2009-04-29 08:25:57 +0000984#define SUPPORTED_Backplane (1 << 16)
985#define SUPPORTED_1000baseKX_Full (1 << 17)
986#define SUPPORTED_10000baseKX4_Full (1 << 18)
987#define SUPPORTED_10000baseKR_Full (1 << 19)
988#define SUPPORTED_10000baseR_FEC (1 << 20)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
990/* Indicates what features are advertised by the interface. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000991#define ADVERTISED_10baseT_Half (1 << 0)
992#define ADVERTISED_10baseT_Full (1 << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993#define ADVERTISED_100baseT_Half (1 << 2)
994#define ADVERTISED_100baseT_Full (1 << 3)
995#define ADVERTISED_1000baseT_Half (1 << 4)
996#define ADVERTISED_1000baseT_Full (1 << 5)
997#define ADVERTISED_Autoneg (1 << 6)
998#define ADVERTISED_TP (1 << 7)
999#define ADVERTISED_AUI (1 << 8)
1000#define ADVERTISED_MII (1 << 9)
1001#define ADVERTISED_FIBRE (1 << 10)
1002#define ADVERTISED_BNC (1 << 11)
1003#define ADVERTISED_10000baseT_Full (1 << 12)
Andy Fleming00db8182005-07-30 19:31:23 -04001004#define ADVERTISED_Pause (1 << 13)
1005#define ADVERTISED_Asym_Pause (1 << 14)
Michael Chan427c2192007-05-03 13:17:25 -07001006#define ADVERTISED_2500baseX_Full (1 << 15)
Ben Hutchings894b19a2009-04-29 08:25:57 +00001007#define ADVERTISED_Backplane (1 << 16)
1008#define ADVERTISED_1000baseKX_Full (1 << 17)
1009#define ADVERTISED_10000baseKX4_Full (1 << 18)
1010#define ADVERTISED_10000baseKR_Full (1 << 19)
1011#define ADVERTISED_10000baseR_FEC (1 << 20)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013/* The following are all involved in forcing a particular link
1014 * mode for the device for setting things. When getting the
1015 * devices settings, these indicate the current mode and whether
1016 * it was foced up into this mode or autonegotiated.
1017 */
1018
Michael Chan5b0c76a2005-11-04 08:45:49 -08001019/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020#define SPEED_10 10
1021#define SPEED_100 100
1022#define SPEED_1000 1000
Michael Chan5b0c76a2005-11-04 08:45:49 -08001023#define SPEED_2500 2500
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024#define SPEED_10000 10000
1025
1026/* Duplex, half or full. */
1027#define DUPLEX_HALF 0x00
1028#define DUPLEX_FULL 0x01
1029
1030/* Which connector port. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001031#define PORT_TP 0x00
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032#define PORT_AUI 0x01
1033#define PORT_MII 0x02
1034#define PORT_FIBRE 0x03
1035#define PORT_BNC 0x04
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001036#define PORT_DA 0x05
PJ Waskiewicz5789d292009-11-25 00:11:30 +00001037#define PORT_NONE 0xef
Ben Hutchings0821c712009-04-29 08:02:59 +00001038#define PORT_OTHER 0xff
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
1040/* Which transceiver to use. */
1041#define XCVR_INTERNAL 0x00
1042#define XCVR_EXTERNAL 0x01
1043#define XCVR_DUMMY1 0x02
1044#define XCVR_DUMMY2 0x03
1045#define XCVR_DUMMY3 0x04
1046
1047/* Enable or disable autonegotiation. If this is set to enable,
1048 * the forced link modes above are completely ignored.
1049 */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001050#define AUTONEG_DISABLE 0x00
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051#define AUTONEG_ENABLE 0x01
1052
Chaitanya Lala18760f12009-06-08 14:28:54 +00001053/* Mode MDI or MDI-X */
1054#define ETH_TP_MDI_INVALID 0x00
1055#define ETH_TP_MDI 0x01
1056#define ETH_TP_MDI_X 0x02
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058/* Wake-On-Lan options. */
1059#define WAKE_PHY (1 << 0)
1060#define WAKE_UCAST (1 << 1)
1061#define WAKE_MCAST (1 << 2)
1062#define WAKE_BCAST (1 << 3)
1063#define WAKE_ARP (1 << 4)
1064#define WAKE_MAGIC (1 << 5)
1065#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1066
Ben Hutchings6099e3d2010-09-20 08:42:08 +00001067/* L2-L4 network traffic flow types */
Ben Hutchings07af7a22010-09-16 11:34:26 +00001068#define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1069#define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1070#define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1071#define AH_ESP_V4_FLOW 0x04 /* hash only */
1072#define TCP_V6_FLOW 0x05 /* hash only */
1073#define UDP_V6_FLOW 0x06 /* hash only */
1074#define SCTP_V6_FLOW 0x07 /* hash only */
1075#define AH_ESP_V6_FLOW 0x08 /* hash only */
1076#define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1077#define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1078#define AH_V6_FLOW 0x0b /* hash only */
1079#define ESP_V6_FLOW 0x0c /* hash only */
1080#define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1081#define IPV4_FLOW 0x10 /* hash only */
1082#define IPV6_FLOW 0x11 /* hash only */
Ben Hutchings6099e3d2010-09-20 08:42:08 +00001083#define ETHER_FLOW 0x12 /* spec only (ether_spec) */
Alexander Duyck127fe532011-04-08 18:01:59 +00001084/* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1085#define FLOW_EXT 0x80000000
Santwona Behera0853ad62008-07-02 03:47:41 -07001086
1087/* L3-L4 network traffic flow hash options */
Santwona Behera0853ad62008-07-02 03:47:41 -07001088#define RXH_L2DA (1 << 1)
1089#define RXH_VLAN (1 << 2)
1090#define RXH_L3_PROTO (1 << 3)
1091#define RXH_IP_SRC (1 << 4)
1092#define RXH_IP_DST (1 << 5)
1093#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1094#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1095#define RXH_DISCARD (1 << 31)
1096
Santwona Behera59089d82009-02-20 00:58:13 -08001097#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
Santwona Behera0853ad62008-07-02 03:47:41 -07001098
Ben Hutchingsd73d3a82009-10-05 10:59:58 +00001099/* Reset flags */
1100/* The reset() operation must clear the flags for the components which
1101 * were actually reset. On successful return, the flags indicate the
1102 * components which were not reset, either because they do not exist
1103 * in the hardware or because they cannot be reset independently. The
1104 * driver must never reset any components that were not requested.
1105 */
1106enum ethtool_reset_flags {
1107 /* These flags represent components dedicated to the interface
1108 * the command is addressed to. Shift any flag left by
1109 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1110 * same type.
1111 */
1112 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1113 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1114 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1115 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1116 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1117 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1118 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1119 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1120 * multiple components */
1121
1122 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1123 * this interface */
1124 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1125 * interface, even if shared */
1126};
1127#define ETH_RESET_SHARED_SHIFT 16
1128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129#endif /* _LINUX_ETHTOOL_H */