]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/ethtool.h
ethtool: Split ethtool_get_eeprom() to allow for additional EEPROM accessors
[mirror_ubuntu-bionic-kernel.git] / include / linux / ethtool.h
CommitLineData
1da177e4
LT
1/*
2 * ethtool.h: Defines for Linux ethtool.
3 *
4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
8 * christopher.leech@intel.com,
9 * scott.feldman@intel.com)
59089d8d 10 * Portions Copyright (C) Sun Microsystems 2008
1da177e4
LT
11 */
12
13#ifndef _LINUX_ETHTOOL_H
14#define _LINUX_ETHTOOL_H
15
3a7da39d
BH
16#ifdef __KERNEL__
17#include <linux/compat.h>
18#endif
e621e691 19#include <linux/types.h>
6099e3de 20#include <linux/if_ether.h>
1da177e4
LT
21
22/* This should work for both 32 and 64 bit userland. */
23struct ethtool_cmd {
c3ce7e20
DW
24 __u32 cmd;
25 __u32 supported; /* Features this interface supports */
26 __u32 advertising; /* Features this interface advertises */
36504605
DD
27 __u16 speed; /* The forced speed (lower bits) in
28 * Mbps. Please use
29 * ethtool_cmd_speed()/_set() to
30 * access it */
c3ce7e20
DW
31 __u8 duplex; /* Duplex, half or full */
32 __u8 port; /* Which connector port */
9c4df53b
BH
33 __u8 phy_address; /* MDIO PHY address (PRTAD for clause 45).
34 * May be read-only or read-write
35 * depending on the driver.
36 */
c3ce7e20
DW
37 __u8 transceiver; /* Which transceiver to use */
38 __u8 autoneg; /* Enable or disable autonegotiation */
9c4df53b
BH
39 __u8 mdio_support; /* MDIO protocols supported. Read-only.
40 * Not set by all drivers.
41 */
c3ce7e20
DW
42 __u32 maxtxpkt; /* Tx pkts before generating tx int */
43 __u32 maxrxpkt; /* Rx pkts before generating rx int */
36504605
DD
44 __u16 speed_hi; /* The forced speed (upper
45 * bits) in Mbps. Please use
46 * ethtool_cmd_speed()/_set() to
47 * access it */
18760f1e
CL
48 __u8 eth_tp_mdix;
49 __u8 reserved2;
0c09c1a4
BH
50 __u32 lp_advertising; /* Features the link partner advertises */
51 __u32 reserved[2];
1da177e4
LT
52};
53
b11f8d8c 54static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
36504605 55 __u32 speed)
b11f8d8c
BP
56{
57
58 ep->speed = (__u16)speed;
59 ep->speed_hi = (__u16)(speed >> 16);
60}
61
36504605 62static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
b11f8d8c
BP
63{
64 return (ep->speed_hi << 16) | ep->speed;
65}
66
9c4df53b
BH
67/* Device supports clause 22 register access to PHY or peripherals
68 * using the interface defined in <linux/mii.h>. This should not be
69 * set if there are known to be no such peripherals present or if
70 * the driver only emulates clause 22 registers for compatibility.
71 */
72#define ETH_MDIO_SUPPORTS_C22 1
73
74/* Device supports clause 45 register access to PHY or peripherals
75 * using the interface defined in <linux/mii.h> and <linux/mdio.h>.
76 * This should not be set if there are known to be no such peripherals
77 * present.
78 */
79#define ETH_MDIO_SUPPORTS_C45 2
80
141518c9 81#define ETHTOOL_FWVERS_LEN 32
1da177e4
LT
82#define ETHTOOL_BUSINFO_LEN 32
83/* these strings are set to whatever the driver author decides... */
84struct ethtool_drvinfo {
c3ce7e20 85 __u32 cmd;
1da177e4
LT
86 char driver[32]; /* driver short name, "tulip", "eepro100" */
87 char version[32]; /* driver version string */
141518c9 88 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
1da177e4
LT
89 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
90 /* For PCI devices, use pci_name(pci_dev). */
91 char reserved1[32];
339bf024 92 char reserved2[12];
d17792eb
JG
93 /*
94 * Some struct members below are filled in
95 * using ops->get_sset_count(). Obtaining
96 * this info from ethtool_drvinfo is now
97 * deprecated; Use ETHTOOL_GSSET_INFO
98 * instead.
99 */
339bf024 100 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
c3ce7e20
DW
101 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
102 __u32 testinfo_len;
103 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
104 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
1da177e4
LT
105};
106
107#define SOPASS_MAX 6
108/* wake-on-lan settings */
109struct ethtool_wolinfo {
c3ce7e20
DW
110 __u32 cmd;
111 __u32 supported;
112 __u32 wolopts;
113 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
1da177e4
LT
114};
115
116/* for passing single values */
117struct ethtool_value {
c3ce7e20
DW
118 __u32 cmd;
119 __u32 data;
1da177e4
LT
120};
121
122/* for passing big chunks of data */
123struct ethtool_regs {
c3ce7e20
DW
124 __u32 cmd;
125 __u32 version; /* driver-specific, indicates different chips/revs */
126 __u32 len; /* bytes */
127 __u8 data[0];
1da177e4
LT
128};
129
130/* for passing EEPROM chunks */
131struct ethtool_eeprom {
c3ce7e20
DW
132 __u32 cmd;
133 __u32 magic;
134 __u32 offset; /* in bytes */
135 __u32 len; /* in bytes */
136 __u8 data[0];
1da177e4
LT
137};
138
5f308d19 139/**
725b361b 140 * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
5f308d19
BH
141 * @cmd: ETHTOOL_{G,S}COALESCE
142 * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
acf42a2a 143 * a packet arrives.
2d7c7939 144 * @rx_max_coalesced_frames: Maximum number of packets to receive
acf42a2a 145 * before an RX interrupt.
5f308d19
BH
146 * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
147 * this value applies while an IRQ is being serviced by the host.
148 * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
149 * except that this value applies while an IRQ is being serviced
150 * by the host.
151 * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
acf42a2a 152 * a packet is sent.
2d7c7939 153 * @tx_max_coalesced_frames: Maximum number of packets to be sent
acf42a2a 154 * before a TX interrupt.
5f308d19
BH
155 * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
156 * this value applies while an IRQ is being serviced by the host.
157 * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
158 * except that this value applies while an IRQ is being serviced
159 * by the host.
160 * @stats_block_coalesce_usecs: How many usecs to delay in-memory
161 * statistics block updates. Some drivers do not have an
162 * in-memory statistic block, and in such cases this value is
163 * ignored. This value must not be zero.
164 * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
165 * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
166 * @pkt_rate_low: Threshold for low packet rate (packets per second).
167 * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
168 * a packet arrives, when the packet rate is below @pkt_rate_low.
2d7c7939
BH
169 * @rx_max_coalesced_frames_low: Maximum number of packets to be received
170 * before an RX interrupt, when the packet rate is below @pkt_rate_low.
5f308d19
BH
171 * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
172 * a packet is sent, when the packet rate is below @pkt_rate_low.
2d7c7939
BH
173 * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
174 * a TX interrupt, when the packet rate is below @pkt_rate_low.
5f308d19
BH
175 * @pkt_rate_high: Threshold for high packet rate (packets per second).
176 * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
177 * a packet arrives, when the packet rate is above @pkt_rate_high.
2d7c7939
BH
178 * @rx_max_coalesced_frames_high: Maximum number of packets to be received
179 * before an RX interrupt, when the packet rate is above @pkt_rate_high.
5f308d19
BH
180 * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
181 * a packet is sent, when the packet rate is above @pkt_rate_high.
2d7c7939
BH
182 * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
183 * a TX interrupt, when the packet rate is above @pkt_rate_high.
5f308d19
BH
184 * @rate_sample_interval: How often to do adaptive coalescing packet rate
185 * sampling, measured in seconds. Must not be zero.
186 *
acf42a2a
BH
187 * Each pair of (usecs, max_frames) fields specifies this exit
188 * condition for interrupt coalescing:
189 * (usecs > 0 && time_since_first_completion >= usecs) ||
190 * (max_frames > 0 && completed_frames >= max_frames)
191 * It is illegal to set both usecs and max_frames to zero as this
192 * would cause interrupts to never be generated. To disable
193 * coalescing, set usecs = 0 and max_frames = 1.
5f308d19 194 *
a27fc96b
BH
195 * Some implementations ignore the value of max_frames and use the
196 * condition:
197 * time_since_first_completion >= usecs
198 * This is deprecated. Drivers for hardware that does not support
199 * counting completions should validate that max_frames == !rx_usecs.
200 *
5f308d19
BH
201 * Adaptive RX/TX coalescing is an algorithm implemented by some
202 * drivers to improve latency under low packet rates and improve
203 * throughput under high packet rates. Some drivers only implement
204 * one of RX or TX adaptive coalescing. Anything not implemented by
205 * the driver causes these values to be silently ignored.
206 *
207 * When the packet rate is below @pkt_rate_high but above
208 * @pkt_rate_low (both measured in packets per second) the
209 * normal {rx,tx}_* coalescing parameters are used.
210 */
1da177e4 211struct ethtool_coalesce {
5f308d19 212 __u32 cmd;
c3ce7e20 213 __u32 rx_coalesce_usecs;
c3ce7e20 214 __u32 rx_max_coalesced_frames;
c3ce7e20
DW
215 __u32 rx_coalesce_usecs_irq;
216 __u32 rx_max_coalesced_frames_irq;
c3ce7e20 217 __u32 tx_coalesce_usecs;
c3ce7e20 218 __u32 tx_max_coalesced_frames;
c3ce7e20
DW
219 __u32 tx_coalesce_usecs_irq;
220 __u32 tx_max_coalesced_frames_irq;
c3ce7e20 221 __u32 stats_block_coalesce_usecs;
c3ce7e20
DW
222 __u32 use_adaptive_rx_coalesce;
223 __u32 use_adaptive_tx_coalesce;
c3ce7e20
DW
224 __u32 pkt_rate_low;
225 __u32 rx_coalesce_usecs_low;
226 __u32 rx_max_coalesced_frames_low;
227 __u32 tx_coalesce_usecs_low;
228 __u32 tx_max_coalesced_frames_low;
c3ce7e20
DW
229 __u32 pkt_rate_high;
230 __u32 rx_coalesce_usecs_high;
231 __u32 rx_max_coalesced_frames_high;
232 __u32 tx_coalesce_usecs_high;
233 __u32 tx_max_coalesced_frames_high;
c3ce7e20 234 __u32 rate_sample_interval;
1da177e4
LT
235};
236
237/* for configuring RX/TX ring parameters */
238struct ethtool_ringparam {
c3ce7e20 239 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
1da177e4
LT
240
241 /* Read only attributes. These indicate the maximum number
242 * of pending RX/TX ring entries the driver will allow the
243 * user to set.
244 */
c3ce7e20
DW
245 __u32 rx_max_pending;
246 __u32 rx_mini_max_pending;
247 __u32 rx_jumbo_max_pending;
248 __u32 tx_max_pending;
1da177e4
LT
249
250 /* Values changeable by the user. The valid values are
251 * in the range 1 to the "*_max_pending" counterpart above.
252 */
c3ce7e20
DW
253 __u32 rx_pending;
254 __u32 rx_mini_pending;
255 __u32 rx_jumbo_pending;
256 __u32 tx_pending;
1da177e4
LT
257};
258
8b5933c3 259/**
260 * struct ethtool_channels - configuring number of network channel
261 * @cmd: ETHTOOL_{G,S}CHANNELS
262 * @max_rx: Read only. Maximum number of receive channel the driver support.
263 * @max_tx: Read only. Maximum number of transmit channel the driver support.
264 * @max_other: Read only. Maximum number of other channel the driver support.
265 * @max_combined: Read only. Maximum number of combined channel the driver
266 * support. Set of queues RX, TX or other.
267 * @rx_count: Valid values are in the range 1 to the max_rx.
268 * @tx_count: Valid values are in the range 1 to the max_tx.
269 * @other_count: Valid values are in the range 1 to the max_other.
270 * @combined_count: Valid values are in the range 1 to the max_combined.
271 *
272 * This can be used to configure RX, TX and other channels.
273 */
274
275struct ethtool_channels {
276 __u32 cmd;
277 __u32 max_rx;
278 __u32 max_tx;
279 __u32 max_other;
280 __u32 max_combined;
281 __u32 rx_count;
282 __u32 tx_count;
283 __u32 other_count;
284 __u32 combined_count;
285};
286
1da177e4
LT
287/* for configuring link flow control parameters */
288struct ethtool_pauseparam {
c3ce7e20 289 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
1da177e4
LT
290
291 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
b4c8cc88 292 * being true) the user may set 'autoneg' here non-zero to have the
1da177e4
LT
293 * pause parameters be auto-negotiated too. In such a case, the
294 * {rx,tx}_pause values below determine what capabilities are
295 * advertised.
296 *
297 * If 'autoneg' is zero or the link is not being auto-negotiated,
298 * then {rx,tx}_pause force the driver to use/not-use pause
299 * flow control.
300 */
c3ce7e20
DW
301 __u32 autoneg;
302 __u32 rx_pause;
303 __u32 tx_pause;
1da177e4
LT
304};
305
306#define ETH_GSTRING_LEN 32
307enum ethtool_stringset {
308 ETH_SS_TEST = 0,
309 ETH_SS_STATS,
339bf024 310 ETH_SS_PRIV_FLAGS,
bff55273 311 ETH_SS_NTUPLE_FILTERS, /* Do not use, GRXNTUPLE is now deprecated */
5455c699 312 ETH_SS_FEATURES,
1da177e4
LT
313};
314
315/* for passing string sets for data tagging */
316struct ethtool_gstrings {
c3ce7e20
DW
317 __u32 cmd; /* ETHTOOL_GSTRINGS */
318 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
319 __u32 len; /* number of strings in the string set */
320 __u8 data[0];
1da177e4
LT
321};
322
723b2f57
JG
323struct ethtool_sset_info {
324 __u32 cmd; /* ETHTOOL_GSSET_INFO */
325 __u32 reserved;
326 __u64 sset_mask; /* input: each bit selects an sset to query */
327 /* output: each bit a returned sset */
328 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits
329 in sset_mask. One bit implies one
330 __u32, two bits implies two
331 __u32's, etc. */
332};
333
0209bcd4
AKS
334/**
335 * enum ethtool_test_flags - flags definition of ethtool_test
336 * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
337 * only online tests.
338 * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
339 * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
340 * test.
341 * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
342 */
343
1da177e4 344enum ethtool_test_flags {
0209bcd4
AKS
345 ETH_TEST_FL_OFFLINE = (1 << 0),
346 ETH_TEST_FL_FAILED = (1 << 1),
347 ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
348 ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
1da177e4
LT
349};
350
351/* for requesting NIC test and getting results*/
352struct ethtool_test {
c3ce7e20
DW
353 __u32 cmd; /* ETHTOOL_TEST */
354 __u32 flags; /* ETH_TEST_FL_xxx */
355 __u32 reserved;
356 __u32 len; /* result length, in number of u64 elements */
357 __u64 data[0];
1da177e4
LT
358};
359
360/* for dumping NIC-specific statistics */
361struct ethtool_stats {
c3ce7e20
DW
362 __u32 cmd; /* ETHTOOL_GSTATS */
363 __u32 n_stats; /* number of u64's being returned */
364 __u64 data[0];
1da177e4
LT
365};
366
a6f9a705 367struct ethtool_perm_addr {
c3ce7e20
DW
368 __u32 cmd; /* ETHTOOL_GPERMADDR */
369 __u32 size;
370 __u8 data[0];
a6f9a705
JW
371};
372
3ae7c0b2
JG
373/* boolean flags controlling per-interface behavior characteristics.
374 * When reading, the flag indicates whether or not a certain behavior
375 * is enabled/present. When writing, the flag indicates whether
376 * or not the driver should turn on (set) or off (clear) a behavior.
377 *
378 * Some behaviors may read-only (unconditionally absent or present).
379 * If such is the case, return EINVAL in the set-flags operation if the
380 * flag differs from the read-only value.
381 */
382enum ethtool_flags {
d5dbda23
JG
383 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
384 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
3ae7c0b2 385 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
15682bc4 386 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
b00fabb4 387 ETH_FLAG_RXHASH = (1 << 28),
3ae7c0b2
JG
388};
389
59089d8d 390/* The following structures are for supporting RX network flow
e0355873
BH
391 * classification and RX n-tuple configuration. Note, all multibyte
392 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
393 * be in network byte order.
394 */
395
396/**
397 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
398 * @ip4src: Source host
399 * @ip4dst: Destination host
400 * @psrc: Source port
401 * @pdst: Destination port
402 * @tos: Type-of-service
403 *
404 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
59089d8d
SB
405 */
406struct ethtool_tcpip4_spec {
407 __be32 ip4src;
408 __be32 ip4dst;
409 __be16 psrc;
410 __be16 pdst;
411 __u8 tos;
412};
413
e0355873
BH
414/**
415 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
416 * @ip4src: Source host
417 * @ip4dst: Destination host
418 * @spi: Security parameters index
419 * @tos: Type-of-service
420 *
421 * This can be used to specify an IPsec transport or tunnel over IPv4.
422 */
59089d8d
SB
423struct ethtool_ah_espip4_spec {
424 __be32 ip4src;
425 __be32 ip4dst;
426 __be32 spi;
427 __u8 tos;
428};
429
59089d8d 430#define ETH_RX_NFC_IP4 1
59089d8d 431
e0355873
BH
432/**
433 * struct ethtool_usrip4_spec - general flow specification for IPv4
434 * @ip4src: Source host
435 * @ip4dst: Destination host
436 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
437 * @tos: Type-of-service
438 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
439 * @proto: Transport protocol number; mask must be 0
440 */
59089d8d
SB
441struct ethtool_usrip4_spec {
442 __be32 ip4src;
443 __be32 ip4dst;
444 __be32 l4_4_bytes;
445 __u8 tos;
446 __u8 ip_ver;
447 __u8 proto;
448};
449
127fe533
AD
450union ethtool_flow_union {
451 struct ethtool_tcpip4_spec tcp_ip4_spec;
452 struct ethtool_tcpip4_spec udp_ip4_spec;
453 struct ethtool_tcpip4_spec sctp_ip4_spec;
454 struct ethtool_ah_espip4_spec ah_ip4_spec;
455 struct ethtool_ah_espip4_spec esp_ip4_spec;
456 struct ethtool_usrip4_spec usr_ip4_spec;
457 struct ethhdr ether_spec;
458 __u8 hdata[60];
459};
460
461struct ethtool_flow_ext {
462 __be16 vlan_etype;
463 __be16 vlan_tci;
464 __be32 data[2];
465};
466
e0355873 467/**
9927c893 468 * struct ethtool_rx_flow_spec - classification rule for RX flows
e0355873
BH
469 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
470 * @h_u: Flow fields to match (dependent on @flow_type)
127fe533
AD
471 * @h_ext: Additional fields to match
472 * @m_u: Masks for flow field bits to be matched
473 * @m_ext: Masks for additional field bits to be matched
474 * Note, all additional fields must be ignored unless @flow_type
475 * includes the %FLOW_EXT flag.
e0355873
BH
476 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
477 * if packets should be discarded
434495c5
BH
478 * @location: Location of rule in the table. Locations must be
479 * numbered such that a flow matching multiple rules will be
480 * classified according to the first (lowest numbered) rule.
e0355873 481 */
59089d8d 482struct ethtool_rx_flow_spec {
0853ad66 483 __u32 flow_type;
127fe533
AD
484 union ethtool_flow_union h_u;
485 struct ethtool_flow_ext h_ext;
486 union ethtool_flow_union m_u;
487 struct ethtool_flow_ext m_ext;
59089d8d
SB
488 __u64 ring_cookie;
489 __u32 location;
490};
491
e0355873
BH
492/**
493 * struct ethtool_rxnfc - command to get or set RX flow classification rules
494 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
495 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
496 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
497 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
498 * @data: Command-dependent value
9927c893 499 * @fs: Flow classification rule
e0355873 500 * @rule_cnt: Number of rules to be affected
815c7db5 501 * @rule_locs: Array of used rule locations
e0355873
BH
502 *
503 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
504 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
505 * structure fields must not be used.
506 *
507 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
508 * on return.
509 *
510 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
55664f32
BH
511 * rules on return. If @data is non-zero on return then it is the
512 * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
513 * driver supports any special location values. If that flag is not
514 * set in @data then special location values should not be used.
e0355873 515 *
9927c893
BH
516 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
517 * existing rule on entry and @fs contains the rule on return.
e0355873
BH
518 *
519 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
520 * user buffer for @rule_locs on entry. On return, @data is the size
473e64ee
BH
521 * of the rule table, @rule_cnt is the number of defined rules, and
522 * @rule_locs contains the locations of the defined rules. Drivers
523 * must use the second parameter to get_rxnfc() instead of @rule_locs.
e0355873 524 *
9927c893 525 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
55664f32
BH
526 * @fs.@location either specifies the location to use or is a special
527 * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
528 * @fs.@location is the actual rule location.
e0355873 529 *
9927c893
BH
530 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
531 * existing rule on entry.
55664f32
BH
532 *
533 * A driver supporting the special location values for
534 * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
535 * location, and may remove a rule at a later location (lower
536 * priority) that matches exactly the same set of flows. The special
537 * values are: %RX_CLS_LOC_ANY, selecting any location;
538 * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
539 * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
540 * location (minimum priority). Additional special values may be
541 * defined in future and drivers must return -%EINVAL for any
542 * unrecognised value.
e0355873 543 */
59089d8d
SB
544struct ethtool_rxnfc {
545 __u32 cmd;
546 __u32 flow_type;
59089d8d
SB
547 __u64 data;
548 struct ethtool_rx_flow_spec fs;
549 __u32 rule_cnt;
550 __u32 rule_locs[0];
0853ad66
SB
551};
552
3a7da39d
BH
553#ifdef __KERNEL__
554#ifdef CONFIG_COMPAT
555
556struct compat_ethtool_rx_flow_spec {
557 u32 flow_type;
127fe533
AD
558 union ethtool_flow_union h_u;
559 struct ethtool_flow_ext h_ext;
560 union ethtool_flow_union m_u;
561 struct ethtool_flow_ext m_ext;
3a7da39d
BH
562 compat_u64 ring_cookie;
563 u32 location;
564};
565
566struct compat_ethtool_rxnfc {
567 u32 cmd;
568 u32 flow_type;
569 compat_u64 data;
570 struct compat_ethtool_rx_flow_spec fs;
571 u32 rule_cnt;
572 u32 rule_locs[0];
573};
574
575#endif /* CONFIG_COMPAT */
576#endif /* __KERNEL__ */
577
e0355873
BH
578/**
579 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
580 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
278bc429
BH
581 * @size: On entry, the array size of the user buffer, which may be zero.
582 * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
583 * indirection table.
e0355873 584 * @ring_index: RX ring/queue index for each hash value
278bc429
BH
585 *
586 * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
587 * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
588 * the table should be reset to default values. This last feature
589 * is not supported by the original implementations.
e0355873 590 */
a5b6ee29
BH
591struct ethtool_rxfh_indir {
592 __u32 cmd;
a5b6ee29 593 __u32 size;
e0355873 594 __u32 ring_index[0];
a5b6ee29
BH
595};
596
e0355873
BH
597/**
598 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
599 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
600 * @h_u: Flow field values to match (dependent on @flow_type)
601 * @m_u: Masks for flow field value bits to be ignored
602 * @vlan_tag: VLAN tag to match
603 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
604 * @data: Driver-dependent data to match
605 * @data_mask: Mask for driver-dependent data bits to be ignored
606 * @action: RX ring/queue index to deliver to (non-negative) or other action
607 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
608 *
be2902da
BH
609 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
610 * a field value and mask are both zero this is treated as if all mask
611 * bits are set i.e. the field is ignored.
e0355873 612 */
15682bc4
PWJ
613struct ethtool_rx_ntuple_flow_spec {
614 __u32 flow_type;
615 union {
616 struct ethtool_tcpip4_spec tcp_ip4_spec;
617 struct ethtool_tcpip4_spec udp_ip4_spec;
618 struct ethtool_tcpip4_spec sctp_ip4_spec;
619 struct ethtool_ah_espip4_spec ah_ip4_spec;
620 struct ethtool_ah_espip4_spec esp_ip4_spec;
15682bc4 621 struct ethtool_usrip4_spec usr_ip4_spec;
6099e3de 622 struct ethhdr ether_spec;
e0de7c93 623 __u8 hdata[72];
e0355873 624 } h_u, m_u;
15682bc4
PWJ
625
626 __u16 vlan_tag;
627 __u16 vlan_tag_mask;
e0355873
BH
628 __u64 data;
629 __u64 data_mask;
15682bc4 630
15682bc4 631 __s32 action;
c22ab781
BH
632#define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
633#define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
15682bc4
PWJ
634};
635
e0355873 636/**
c22ab781 637 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
e0355873
BH
638 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
639 * @fs: Flow filter specification
640 */
15682bc4
PWJ
641struct ethtool_rx_ntuple {
642 __u32 cmd;
643 struct ethtool_rx_ntuple_flow_spec fs;
644};
645
05c6a8d7
AK
646#define ETHTOOL_FLASH_MAX_FILENAME 128
647enum ethtool_flash_op_type {
648 ETHTOOL_FLASH_ALL_REGIONS = 0,
649};
650
651/* for passing firmware flashing related parameters */
652struct ethtool_flash {
653 __u32 cmd;
654 __u32 region;
655 char data[ETHTOOL_FLASH_MAX_FILENAME];
656};
657
29dd54b7
AC
658/**
659 * struct ethtool_dump - used for retrieving, setting device dump
660 * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
661 * %ETHTOOL_SET_DUMP
662 * @version: FW version of the dump, filled in by driver
663 * @flag: driver dependent flag for dump setting, filled in by driver during
664 * get and filled in by ethtool for set operation
665 * @len: length of dump data, used as the length of the user buffer on entry to
666 * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
667 * for %ETHTOOL_GET_DUMP_FLAG command
668 * @data: data collected for get dump data operation
669 */
670struct ethtool_dump {
671 __u32 cmd;
672 __u32 version;
673 __u32 flag;
674 __u32 len;
675 __u8 data[0];
676};
677
5455c699
MM
678/* for returning and changing feature sets */
679
680/**
681 * struct ethtool_get_features_block - block with state of 32 features
682 * @available: mask of changeable features
683 * @requested: mask of features requested to be enabled if possible
684 * @active: mask of currently enabled features
685 * @never_changed: mask of features not changeable for any device
686 */
687struct ethtool_get_features_block {
688 __u32 available;
689 __u32 requested;
690 __u32 active;
691 __u32 never_changed;
692};
693
694/**
695 * struct ethtool_gfeatures - command to get state of device's features
696 * @cmd: command number = %ETHTOOL_GFEATURES
697 * @size: in: number of elements in the features[] array;
698 * out: number of elements in features[] needed to hold all features
699 * @features: state of features
700 */
701struct ethtool_gfeatures {
702 __u32 cmd;
703 __u32 size;
704 struct ethtool_get_features_block features[0];
705};
706
707/**
708 * struct ethtool_set_features_block - block with request for 32 features
709 * @valid: mask of features to be changed
710 * @requested: values of features to be changed
711 */
712struct ethtool_set_features_block {
713 __u32 valid;
714 __u32 requested;
715};
716
717/**
718 * struct ethtool_sfeatures - command to request change in device's features
719 * @cmd: command number = %ETHTOOL_SFEATURES
720 * @size: array size of the features[] array
721 * @features: feature change masks
722 */
723struct ethtool_sfeatures {
724 __u32 cmd;
725 __u32 size;
726 struct ethtool_set_features_block features[0];
727};
728
c8f3a8c3
RC
729/**
730 * struct ethtool_ts_info - holds a device's timestamping and PHC association
731 * @cmd: command number = %ETHTOOL_GET_TS_INFO
732 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
733 * @phc_index: device index of the associated PHC, or -1 if there is none
734 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
735 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
736 *
737 * The bits in the 'tx_types' and 'rx_filters' fields correspond to
738 * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
739 * respectively. For example, if the device supports HWTSTAMP_TX_ON,
740 * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
741 */
742struct ethtool_ts_info {
743 __u32 cmd;
744 __u32 so_timestamping;
745 __s32 phc_index;
746 __u32 tx_types;
747 __u32 tx_reserved[3];
748 __u32 rx_filters;
749 __u32 rx_reserved[3];
750};
751
5455c699
MM
752/*
753 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
754 * values of corresponding bits in features[].requested. Bits in .requested
755 * not set in .valid or not changeable are ignored.
756 *
25985edc 757 * Returns %EINVAL when .valid contains undefined or never-changeable bits
5455c699
MM
758 * or size is not equal to required number of features words (32-bit blocks).
759 * Returns >= 0 if request was completed; bits set in the value mean:
760 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
761 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
762 * those bits were ignored.
763 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
764 * resulting state of bits masked by .valid is not equal to .requested.
765 * Probably there are other device-specific constraints on some features
766 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
767 * here as though ignored bits were cleared.
39fc0ce5
MM
768 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
769 * compatibility functions. Requested offload state cannot be properly
770 * managed by kernel.
5455c699
MM
771 *
772 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
773 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
774 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
775 * significant bit in features[0] fields. Empty strings mark undefined features.
776 */
777enum ethtool_sfeatures_retval_bits {
778 ETHTOOL_F_UNSUPPORTED__BIT,
779 ETHTOOL_F_WISH__BIT,
39fc0ce5 780 ETHTOOL_F_COMPAT__BIT,
5455c699
MM
781};
782
783#define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
784#define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
39fc0ce5 785#define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
5455c699 786
c3ce7e20
DW
787#ifdef __KERNEL__
788
a1467085
DM
789#include <linux/rculist.h>
790
4bc71cb9
JP
791extern int __ethtool_get_settings(struct net_device *dev,
792 struct ethtool_cmd *cmd);
793
68f512f2
BH
794/**
795 * enum ethtool_phys_id_state - indicator state for physical identification
796 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
797 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
798 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
799 * is not supported)
800 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
801 * is not supported)
802 */
803enum ethtool_phys_id_state {
804 ETHTOOL_ID_INACTIVE,
805 ETHTOOL_ID_ACTIVE,
806 ETHTOOL_ID_ON,
807 ETHTOOL_ID_OFF
808};
809
1da177e4
LT
810struct net_device;
811
812/* Some generic methods drivers may use in their ethtool_ops */
813u32 ethtool_op_get_link(struct net_device *dev);
02eacbd0 814int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
1da177e4 815
278bc429
BH
816/**
817 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
818 * @index: Index in RX flow hash indirection table
819 * @n_rx_rings: Number of RX rings to use
820 *
821 * This function provides the default policy for RX flow hash indirection.
822 */
823static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
824{
825 return index % n_rx_rings;
826}
827
1da177e4 828/**
8717d07b
BH
829 * struct ethtool_ops - optional netdev operations
830 * @get_settings: Get various device settings including Ethernet link
8ae6daca
DD
831 * settings. The @cmd parameter is expected to have been cleared
832 * before get_settings is called. Returns a negative error code or
833 * zero.
8717d07b
BH
834 * @set_settings: Set various device settings including Ethernet link
835 * settings. Returns a negative error code or zero.
836 * @get_drvinfo: Report driver/device information. Should only set the
837 * @driver, @version, @fw_version and @bus_info fields. If not
838 * implemented, the @driver and @bus_info fields will be filled in
839 * according to the netdev's parent device.
840 * @get_regs_len: Get buffer length required for @get_regs
e20b5b61
BH
841 * @get_regs: Get device registers
842 * @get_wol: Report whether Wake-on-Lan is enabled
8717d07b
BH
843 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
844 * or zero.
845 * @get_msglevel: Report driver message level. This should be the value
846 * of the @msg_enable field used by netif logging functions.
e20b5b61 847 * @set_msglevel: Set driver message level
8717d07b
BH
848 * @nway_reset: Restart autonegotiation. Returns a negative error code
849 * or zero.
850 * @get_link: Report whether physical link is up. Will only be called if
851 * the netdev is up. Should usually be set to ethtool_op_get_link(),
852 * which uses netif_carrier_ok().
e20b5b61 853 * @get_eeprom: Read data from the device EEPROM.
1da177e4
LT
854 * Should fill in the magic field. Don't need to check len for zero
855 * or wraparound. Fill in the data argument with the eeprom values
856 * from offset to offset + len. Update len to the amount read.
857 * Returns an error or zero.
e20b5b61 858 * @set_eeprom: Write data to the device EEPROM.
1da177e4
LT
859 * Should validate the magic field. Don't need to check len for zero
860 * or wraparound. Update len to the amount written. Returns an error
861 * or zero.
8717d07b
BH
862 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
863 * error code or zero.
864 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
865 * error code or zero.
e20b5b61 866 * @get_ringparam: Report ring sizes
8717d07b 867 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
e20b5b61 868 * @get_pauseparam: Report pause parameters
8717d07b
BH
869 * @set_pauseparam: Set pause parameters. Returns a negative error code
870 * or zero.
e20b5b61
BH
871 * @self_test: Run specified self-tests
872 * @get_strings: Return a set of strings that describe the requested objects
68f512f2
BH
873 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
874 * attached to it. The implementation may update the indicator
875 * asynchronously or synchronously, but in either case it must return
876 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
fce55922
AB
877 * and must either activate asynchronous updates and return zero, return
878 * a negative error or return a positive frequency for synchronous
879 * indication (e.g. 1 for one on/off cycle per second). If it returns
880 * a frequency then it will be called again at intervals with the
68f512f2
BH
881 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
882 * the indicator accordingly. Finally, it is called with the argument
883 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
884 * negative error code or zero.
8717d07b
BH
885 * @get_ethtool_stats: Return extended statistics about the device.
886 * This is only useful if the device maintains statistics not
887 * included in &struct rtnl_link_stats64.
888 * @begin: Function to be called before any other operation. Returns a
889 * negative error code or zero.
890 * @complete: Function to be called after any other operation except
891 * @begin. Will be called even if the other operation failed.
8717d07b
BH
892 * @get_priv_flags: Report driver-specific feature flags.
893 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
894 * error code or zero.
895 * @get_sset_count: Get number of strings that @get_strings will write.
896 * @get_rxnfc: Get RX flow classification rules. Returns a negative
897 * error code or zero.
898 * @set_rxnfc: Set RX flow classification rules. Returns a negative
899 * error code or zero.
900 * @flash_device: Write a firmware image to device's flash memory.
901 * Returns a negative error code or zero.
902 * @reset: Reset (part of) the device, as specified by a bitmask of
903 * flags from &enum ethtool_reset_flags. Returns a negative
904 * error code or zero.
7850f63f
BH
905 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
906 * Returns zero if not supported for this specific device.
8717d07b 907 * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
7850f63f 908 * Will not be called if @get_rxfh_indir_size returns zero.
8717d07b
BH
909 * Returns a negative error code or zero.
910 * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
7850f63f 911 * Will not be called if @get_rxfh_indir_size returns zero.
8717d07b 912 * Returns a negative error code or zero.
8b5933c3 913 * @get_channels: Get number of channels.
914 * @set_channels: Set number of channels. Returns a negative error code or
915 * zero.
29dd54b7
AC
916 * @get_dump_flag: Get dump flag indicating current dump length, version,
917 * and flag of the device.
918 * @get_dump_data: Get dump data.
919 * @set_dump: Set dump specific flags to the device.
c8f3a8c3
RC
920 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
921 * Drivers supporting transmit time stamps in software should set this to
922 * ethtool_op_get_ts_info().
8717d07b
BH
923 *
924 * All operations are optional (i.e. the function pointer may be set
925 * to %NULL) and callers must take this into account. Callers must
b4f79e5c 926 * hold the RTNL lock.
8717d07b
BH
927 *
928 * See the structures used by these operations for further documentation.
929 *
930 * See &struct net_device and &struct net_device_ops for documentation
931 * of the generic netdev features interface.
1da177e4
LT
932 */
933struct ethtool_ops {
934 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
935 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
936 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
937 int (*get_regs_len)(struct net_device *);
938 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
939 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
940 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
941 u32 (*get_msglevel)(struct net_device *);
942 void (*set_msglevel)(struct net_device *, u32);
943 int (*nway_reset)(struct net_device *);
944 u32 (*get_link)(struct net_device *);
945 int (*get_eeprom_len)(struct net_device *);
97f8aefb 946 int (*get_eeprom)(struct net_device *,
947 struct ethtool_eeprom *, u8 *);
948 int (*set_eeprom)(struct net_device *,
949 struct ethtool_eeprom *, u8 *);
1da177e4
LT
950 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
951 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
97f8aefb 952 void (*get_ringparam)(struct net_device *,
953 struct ethtool_ringparam *);
954 int (*set_ringparam)(struct net_device *,
955 struct ethtool_ringparam *);
956 void (*get_pauseparam)(struct net_device *,
957 struct ethtool_pauseparam*);
958 int (*set_pauseparam)(struct net_device *,
959 struct ethtool_pauseparam*);
1da177e4
LT
960 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
961 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
68f512f2 962 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
97f8aefb 963 void (*get_ethtool_stats)(struct net_device *,
964 struct ethtool_stats *, u64 *);
1da177e4
LT
965 int (*begin)(struct net_device *);
966 void (*complete)(struct net_device *);
97f8aefb 967 u32 (*get_priv_flags)(struct net_device *);
968 int (*set_priv_flags)(struct net_device *, u32);
ff03d49f 969 int (*get_sset_count)(struct net_device *, int);
97f8aefb 970 int (*get_rxnfc)(struct net_device *,
815c7db5 971 struct ethtool_rxnfc *, u32 *rule_locs);
59089d8d 972 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
97f8aefb 973 int (*flash_device)(struct net_device *, struct ethtool_flash *);
d73d3a8c 974 int (*reset)(struct net_device *, u32 *);
7850f63f
BH
975 u32 (*get_rxfh_indir_size)(struct net_device *);
976 int (*get_rxfh_indir)(struct net_device *, u32 *);
977 int (*set_rxfh_indir)(struct net_device *, const u32 *);
8b5933c3 978 void (*get_channels)(struct net_device *, struct ethtool_channels *);
979 int (*set_channels)(struct net_device *, struct ethtool_channels *);
29dd54b7
AC
980 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
981 int (*get_dump_data)(struct net_device *,
982 struct ethtool_dump *, void *);
983 int (*set_dump)(struct net_device *, struct ethtool_dump *);
c8f3a8c3 984 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
8b5933c3 985
1da177e4 986};
c3ce7e20 987#endif /* __KERNEL__ */
1da177e4
LT
988
989/* CMDs currently supported */
990#define ETHTOOL_GSET 0x00000001 /* Get settings. */
991#define ETHTOOL_SSET 0x00000002 /* Set settings. */
992#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
993#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
994#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
995#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
1be3b5fe
BH
996#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
997#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
1da177e4 998#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
e596e6e4
BH
999/* Get link status for host, i.e. whether the interface *and* the
1000 * physical port (if there is one) are up (ethtool_value). */
1001#define ETHTOOL_GLINK 0x0000000a
1be3b5fe
BH
1002#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
1003#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
1da177e4
LT
1004#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
1005#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
1006#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
1007#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
1008#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
1009#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
1be3b5fe
BH
1010#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
1011#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
1012#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
1013#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
1da177e4
LT
1014#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
1015 * (ethtool_value) */
1016#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
1017 * (ethtool_value). */
1018#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
1019#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
1be3b5fe 1020#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
1da177e4
LT
1021#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
1022#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
1023#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
a6f9a705 1024#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
e89e9cf5
AR
1025#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
1026#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
37c3185a
HX
1027#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
1028#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
3ae7c0b2
JG
1029#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
1030#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
1be3b5fe
BH
1031#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
1032#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
1da177e4 1033
97f8aefb 1034#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
1035#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
b240a0e5
HX
1036#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
1037#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
97f8aefb 1038#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
1039#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
1040#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
1041#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
1042#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
1043#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
1044#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
1045#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
1046#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
bff55273 1047#define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
97f8aefb 1048#define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
a5b6ee29
BH
1049#define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1050#define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
15682bc4 1051
5455c699
MM
1052#define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1053#define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
8b5933c3 1054#define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1055#define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
29dd54b7
AC
1056#define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
1057#define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
1058#define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
c8f3a8c3 1059#define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
5455c699 1060
1da177e4
LT
1061/* compatibility with older code */
1062#define SPARC_ETH_GSET ETHTOOL_GSET
1063#define SPARC_ETH_SSET ETHTOOL_SSET
1064
1065/* Indicates what features are supported by the interface. */
1066#define SUPPORTED_10baseT_Half (1 << 0)
1067#define SUPPORTED_10baseT_Full (1 << 1)
1be3b5fe
BH
1068#define SUPPORTED_100baseT_Half (1 << 2)
1069#define SUPPORTED_100baseT_Full (1 << 3)
1da177e4
LT
1070#define SUPPORTED_1000baseT_Half (1 << 4)
1071#define SUPPORTED_1000baseT_Full (1 << 5)
1072#define SUPPORTED_Autoneg (1 << 6)
1073#define SUPPORTED_TP (1 << 7)
1074#define SUPPORTED_AUI (1 << 8)
1075#define SUPPORTED_MII (1 << 9)
1be3b5fe 1076#define SUPPORTED_FIBRE (1 << 10)
1da177e4
LT
1077#define SUPPORTED_BNC (1 << 11)
1078#define SUPPORTED_10000baseT_Full (1 << 12)
1be3b5fe 1079#define SUPPORTED_Pause (1 << 13)
00db8189 1080#define SUPPORTED_Asym_Pause (1 << 14)
427c2196 1081#define SUPPORTED_2500baseX_Full (1 << 15)
894b19a6
BH
1082#define SUPPORTED_Backplane (1 << 16)
1083#define SUPPORTED_1000baseKX_Full (1 << 17)
1084#define SUPPORTED_10000baseKX4_Full (1 << 18)
1085#define SUPPORTED_10000baseKR_Full (1 << 19)
1086#define SUPPORTED_10000baseR_FEC (1 << 20)
57cc71bc
YR
1087#define SUPPORTED_20000baseMLD2_Full (1 << 21)
1088#define SUPPORTED_20000baseKR2_Full (1 << 22)
1da177e4
LT
1089
1090/* Indicates what features are advertised by the interface. */
1be3b5fe
BH
1091#define ADVERTISED_10baseT_Half (1 << 0)
1092#define ADVERTISED_10baseT_Full (1 << 1)
1da177e4
LT
1093#define ADVERTISED_100baseT_Half (1 << 2)
1094#define ADVERTISED_100baseT_Full (1 << 3)
1095#define ADVERTISED_1000baseT_Half (1 << 4)
1096#define ADVERTISED_1000baseT_Full (1 << 5)
1097#define ADVERTISED_Autoneg (1 << 6)
1098#define ADVERTISED_TP (1 << 7)
1099#define ADVERTISED_AUI (1 << 8)
1100#define ADVERTISED_MII (1 << 9)
1101#define ADVERTISED_FIBRE (1 << 10)
1102#define ADVERTISED_BNC (1 << 11)
1103#define ADVERTISED_10000baseT_Full (1 << 12)
00db8189
AF
1104#define ADVERTISED_Pause (1 << 13)
1105#define ADVERTISED_Asym_Pause (1 << 14)
427c2196 1106#define ADVERTISED_2500baseX_Full (1 << 15)
894b19a6
BH
1107#define ADVERTISED_Backplane (1 << 16)
1108#define ADVERTISED_1000baseKX_Full (1 << 17)
1109#define ADVERTISED_10000baseKX4_Full (1 << 18)
1110#define ADVERTISED_10000baseKR_Full (1 << 19)
1111#define ADVERTISED_10000baseR_FEC (1 << 20)
57cc71bc
YR
1112#define ADVERTISED_20000baseMLD2_Full (1 << 21)
1113#define ADVERTISED_20000baseKR2_Full (1 << 22)
1da177e4
LT
1114
1115/* The following are all involved in forcing a particular link
1116 * mode for the device for setting things. When getting the
1117 * devices settings, these indicate the current mode and whether
b4c8cc88 1118 * it was forced up into this mode or autonegotiated.
1da177e4
LT
1119 */
1120
5b0c76ad 1121/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1da177e4
LT
1122#define SPEED_10 10
1123#define SPEED_100 100
1124#define SPEED_1000 1000
5b0c76ad 1125#define SPEED_2500 2500
1da177e4 1126#define SPEED_10000 10000
589665f5 1127#define SPEED_UNKNOWN -1
1da177e4
LT
1128
1129/* Duplex, half or full. */
1130#define DUPLEX_HALF 0x00
1131#define DUPLEX_FULL 0x01
589665f5 1132#define DUPLEX_UNKNOWN 0xff
1da177e4
LT
1133
1134/* Which connector port. */
1be3b5fe 1135#define PORT_TP 0x00
1da177e4
LT
1136#define PORT_AUI 0x01
1137#define PORT_MII 0x02
1138#define PORT_FIBRE 0x03
1139#define PORT_BNC 0x04
1be3b5fe 1140#define PORT_DA 0x05
5789d290 1141#define PORT_NONE 0xef
0821c717 1142#define PORT_OTHER 0xff
1da177e4
LT
1143
1144/* Which transceiver to use. */
1145#define XCVR_INTERNAL 0x00
1146#define XCVR_EXTERNAL 0x01
1147#define XCVR_DUMMY1 0x02
1148#define XCVR_DUMMY2 0x03
1149#define XCVR_DUMMY3 0x04
1150
1151/* Enable or disable autonegotiation. If this is set to enable,
1152 * the forced link modes above are completely ignored.
1153 */
1be3b5fe 1154#define AUTONEG_DISABLE 0x00
1da177e4
LT
1155#define AUTONEG_ENABLE 0x01
1156
18760f1e
CL
1157/* Mode MDI or MDI-X */
1158#define ETH_TP_MDI_INVALID 0x00
1159#define ETH_TP_MDI 0x01
1160#define ETH_TP_MDI_X 0x02
1161
1da177e4
LT
1162/* Wake-On-Lan options. */
1163#define WAKE_PHY (1 << 0)
1164#define WAKE_UCAST (1 << 1)
1165#define WAKE_MCAST (1 << 2)
1166#define WAKE_BCAST (1 << 3)
1167#define WAKE_ARP (1 << 4)
1168#define WAKE_MAGIC (1 << 5)
1169#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1170
6099e3de 1171/* L2-L4 network traffic flow types */
07af7a2b
BH
1172#define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1173#define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1174#define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1175#define AH_ESP_V4_FLOW 0x04 /* hash only */
1176#define TCP_V6_FLOW 0x05 /* hash only */
1177#define UDP_V6_FLOW 0x06 /* hash only */
1178#define SCTP_V6_FLOW 0x07 /* hash only */
1179#define AH_ESP_V6_FLOW 0x08 /* hash only */
1180#define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1181#define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1182#define AH_V6_FLOW 0x0b /* hash only */
1183#define ESP_V6_FLOW 0x0c /* hash only */
1184#define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1185#define IPV4_FLOW 0x10 /* hash only */
1186#define IPV6_FLOW 0x11 /* hash only */
6099e3de 1187#define ETHER_FLOW 0x12 /* spec only (ether_spec) */
127fe533
AD
1188/* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1189#define FLOW_EXT 0x80000000
0853ad66
SB
1190
1191/* L3-L4 network traffic flow hash options */
0853ad66
SB
1192#define RXH_L2DA (1 << 1)
1193#define RXH_VLAN (1 << 2)
1194#define RXH_L3_PROTO (1 << 3)
1195#define RXH_IP_SRC (1 << 4)
1196#define RXH_IP_DST (1 << 5)
1197#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1198#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1199#define RXH_DISCARD (1 << 31)
1200
59089d8d 1201#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
0853ad66 1202
55664f32
BH
1203/* Special RX classification rule insert location values */
1204#define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
1205#define RX_CLS_LOC_ANY 0xffffffff
1206#define RX_CLS_LOC_FIRST 0xfffffffe
1207#define RX_CLS_LOC_LAST 0xfffffffd
1208
d73d3a8c
BH
1209/* Reset flags */
1210/* The reset() operation must clear the flags for the components which
1211 * were actually reset. On successful return, the flags indicate the
1212 * components which were not reset, either because they do not exist
1213 * in the hardware or because they cannot be reset independently. The
1214 * driver must never reset any components that were not requested.
1215 */
1216enum ethtool_reset_flags {
1217 /* These flags represent components dedicated to the interface
1218 * the command is addressed to. Shift any flag left by
1219 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1220 * same type.
1221 */
1222 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1223 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1224 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1225 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1226 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1227 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1228 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1229 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1230 * multiple components */
1231
1232 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1233 * this interface */
1234 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1235 * interface, even if shared */
1236};
1237#define ETH_RESET_SHARED_SHIFT 16
1238
1da177e4 1239#endif /* _LINUX_ETHTOOL_H */