blob: 7e6e0a89ca26b89d51f6f64fc080b710ca0d1be3 [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 */
David Decotigny36504602011-04-27 18:32:37 +000027 __u16 speed; /* The forced speed (lower bits) in
28 * Mbps. Please use
29 * ethtool_cmd_speed()/_set() to
30 * access it */
David Woodhousec3ce7e22006-04-29 01:53:47 +010031 __u8 duplex; /* Duplex, half or full */
32 __u8 port; /* Which connector port */
33 __u8 phy_address;
34 __u8 transceiver; /* Which transceiver to use */
35 __u8 autoneg; /* Enable or disable autonegotiation */
Ben Hutchings0c09c1a2009-04-29 08:21:53 +000036 __u8 mdio_support;
David Woodhousec3ce7e22006-04-29 01:53:47 +010037 __u32 maxtxpkt; /* Tx pkts before generating tx int */
38 __u32 maxrxpkt; /* Rx pkts before generating rx int */
David Decotigny36504602011-04-27 18:32:37 +000039 __u16 speed_hi; /* The forced speed (upper
40 * bits) in Mbps. Please use
41 * ethtool_cmd_speed()/_set() to
42 * access it */
Chaitanya Lala18760f12009-06-08 14:28:54 +000043 __u8 eth_tp_mdix;
44 __u8 reserved2;
Ben Hutchings0c09c1a2009-04-29 08:21:53 +000045 __u32 lp_advertising; /* Features the link partner advertises */
46 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -070047};
48
Brandon Philipsb11f8d82008-07-15 02:18:41 -070049static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
David Decotigny36504602011-04-27 18:32:37 +000050 __u32 speed)
Brandon Philipsb11f8d82008-07-15 02:18:41 -070051{
52
53 ep->speed = (__u16)speed;
54 ep->speed_hi = (__u16)(speed >> 16);
55}
56
David Decotigny36504602011-04-27 18:32:37 +000057static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep)
Brandon Philipsb11f8d82008-07-15 02:18:41 -070058{
59 return (ep->speed_hi << 16) | ep->speed;
60}
61
Matt Carlson141518c2009-12-03 08:36:22 +000062#define ETHTOOL_FWVERS_LEN 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#define ETHTOOL_BUSINFO_LEN 32
64/* these strings are set to whatever the driver author decides... */
65struct ethtool_drvinfo {
David Woodhousec3ce7e22006-04-29 01:53:47 +010066 __u32 cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 char driver[32]; /* driver short name, "tulip", "eepro100" */
68 char version[32]; /* driver version string */
Matt Carlson141518c2009-12-03 08:36:22 +000069 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
71 /* For PCI devices, use pci_name(pci_dev). */
72 char reserved1[32];
Jeff Garzik339bf022007-08-15 16:01:32 -070073 char reserved2[12];
Jeff Garzikd17792e2010-03-04 08:21:53 +000074 /*
75 * Some struct members below are filled in
76 * using ops->get_sset_count(). Obtaining
77 * this info from ethtool_drvinfo is now
78 * deprecated; Use ETHTOOL_GSSET_INFO
79 * instead.
80 */
Jeff Garzik339bf022007-08-15 16:01:32 -070081 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
David Woodhousec3ce7e22006-04-29 01:53:47 +010082 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
83 __u32 testinfo_len;
84 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
85 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086};
87
88#define SOPASS_MAX 6
89/* wake-on-lan settings */
90struct ethtool_wolinfo {
David Woodhousec3ce7e22006-04-29 01:53:47 +010091 __u32 cmd;
92 __u32 supported;
93 __u32 wolopts;
94 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095};
96
97/* for passing single values */
98struct ethtool_value {
David Woodhousec3ce7e22006-04-29 01:53:47 +010099 __u32 cmd;
100 __u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101};
102
103/* for passing big chunks of data */
104struct ethtool_regs {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100105 __u32 cmd;
106 __u32 version; /* driver-specific, indicates different chips/revs */
107 __u32 len; /* bytes */
108 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109};
110
111/* for passing EEPROM chunks */
112struct ethtool_eeprom {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100113 __u32 cmd;
114 __u32 magic;
115 __u32 offset; /* in bytes */
116 __u32 len; /* in bytes */
117 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118};
119
120/* for configuring coalescing parameters of chip */
121struct ethtool_coalesce {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100122 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124 /* How many usecs to delay an RX interrupt after
125 * a packet arrives. If 0, only rx_max_coalesced_frames
126 * is used.
127 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100128 __u32 rx_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130 /* How many packets to delay an RX interrupt after
131 * a packet arrives. If 0, only rx_coalesce_usecs is
132 * used. It is illegal to set both usecs and max frames
133 * to zero as this would cause RX interrupts to never be
134 * generated.
135 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100136 __u32 rx_max_coalesced_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138 /* Same as above two parameters, except that these values
139 * apply while an IRQ is being serviced by the host. Not
140 * all cards support this feature and the values are ignored
141 * in that case.
142 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100143 __u32 rx_coalesce_usecs_irq;
144 __u32 rx_max_coalesced_frames_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146 /* How many usecs to delay a TX interrupt after
147 * a packet is sent. If 0, only tx_max_coalesced_frames
148 * is used.
149 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100150 __u32 tx_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152 /* How many packets to delay a TX interrupt after
153 * a packet is sent. If 0, only tx_coalesce_usecs is
154 * used. It is illegal to set both usecs and max frames
155 * to zero as this would cause TX interrupts to never be
156 * generated.
157 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100158 __u32 tx_max_coalesced_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160 /* Same as above two parameters, except that these values
161 * apply while an IRQ is being serviced by the host. Not
162 * all cards support this feature and the values are ignored
163 * in that case.
164 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100165 __u32 tx_coalesce_usecs_irq;
166 __u32 tx_max_coalesced_frames_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168 /* How many usecs to delay in-memory statistics
169 * block updates. Some drivers do not have an in-memory
170 * statistic block, and in such cases this value is ignored.
171 * This value must not be zero.
172 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100173 __u32 stats_block_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175 /* Adaptive RX/TX coalescing is an algorithm implemented by
176 * some drivers to improve latency under low packet rates and
177 * improve throughput under high packet rates. Some drivers
178 * only implement one of RX or TX adaptive coalescing. Anything
179 * not implemented by the driver causes these values to be
180 * silently ignored.
181 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100182 __u32 use_adaptive_rx_coalesce;
183 __u32 use_adaptive_tx_coalesce;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 /* When the packet rate (measured in packets per second)
186 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
187 * used.
188 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100189 __u32 pkt_rate_low;
190 __u32 rx_coalesce_usecs_low;
191 __u32 rx_max_coalesced_frames_low;
192 __u32 tx_coalesce_usecs_low;
193 __u32 tx_max_coalesced_frames_low;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
195 /* When the packet rate is below pkt_rate_high but above
196 * pkt_rate_low (both measured in packets per second) the
197 * normal {rx,tx}_* coalescing parameters are used.
198 */
199
200 /* When the packet rate is (measured in packets per second)
201 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
202 * used.
203 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100204 __u32 pkt_rate_high;
205 __u32 rx_coalesce_usecs_high;
206 __u32 rx_max_coalesced_frames_high;
207 __u32 tx_coalesce_usecs_high;
208 __u32 tx_max_coalesced_frames_high;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210 /* How often to do adaptive coalescing packet rate sampling,
211 * measured in seconds. Must not be zero.
212 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100213 __u32 rate_sample_interval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214};
215
216/* for configuring RX/TX ring parameters */
217struct ethtool_ringparam {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100218 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220 /* Read only attributes. These indicate the maximum number
221 * of pending RX/TX ring entries the driver will allow the
222 * user to set.
223 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100224 __u32 rx_max_pending;
225 __u32 rx_mini_max_pending;
226 __u32 rx_jumbo_max_pending;
227 __u32 tx_max_pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229 /* Values changeable by the user. The valid values are
230 * in the range 1 to the "*_max_pending" counterpart above.
231 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100232 __u32 rx_pending;
233 __u32 rx_mini_pending;
234 __u32 rx_jumbo_pending;
235 __u32 tx_pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236};
237
amit salecha8b5933c2011-04-07 01:58:42 +0000238/**
239 * struct ethtool_channels - configuring number of network channel
240 * @cmd: ETHTOOL_{G,S}CHANNELS
241 * @max_rx: Read only. Maximum number of receive channel the driver support.
242 * @max_tx: Read only. Maximum number of transmit channel the driver support.
243 * @max_other: Read only. Maximum number of other channel the driver support.
244 * @max_combined: Read only. Maximum number of combined channel the driver
245 * support. Set of queues RX, TX or other.
246 * @rx_count: Valid values are in the range 1 to the max_rx.
247 * @tx_count: Valid values are in the range 1 to the max_tx.
248 * @other_count: Valid values are in the range 1 to the max_other.
249 * @combined_count: Valid values are in the range 1 to the max_combined.
250 *
251 * This can be used to configure RX, TX and other channels.
252 */
253
254struct ethtool_channels {
255 __u32 cmd;
256 __u32 max_rx;
257 __u32 max_tx;
258 __u32 max_other;
259 __u32 max_combined;
260 __u32 rx_count;
261 __u32 tx_count;
262 __u32 other_count;
263 __u32 combined_count;
264};
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266/* for configuring link flow control parameters */
267struct ethtool_pauseparam {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100268 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
271 * being true) the user may set 'autonet' here non-zero to have the
272 * pause parameters be auto-negotiated too. In such a case, the
273 * {rx,tx}_pause values below determine what capabilities are
274 * advertised.
275 *
276 * If 'autoneg' is zero or the link is not being auto-negotiated,
277 * then {rx,tx}_pause force the driver to use/not-use pause
278 * flow control.
279 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100280 __u32 autoneg;
281 __u32 rx_pause;
282 __u32 tx_pause;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283};
284
285#define ETH_GSTRING_LEN 32
286enum ethtool_stringset {
287 ETH_SS_TEST = 0,
288 ETH_SS_STATS,
Jeff Garzik339bf022007-08-15 16:01:32 -0700289 ETH_SS_PRIV_FLAGS,
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800290 ETH_SS_NTUPLE_FILTERS,
Michał Mirosław5455c692011-02-15 16:59:17 +0000291 ETH_SS_FEATURES,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292};
293
294/* for passing string sets for data tagging */
295struct ethtool_gstrings {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100296 __u32 cmd; /* ETHTOOL_GSTRINGS */
297 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
298 __u32 len; /* number of strings in the string set */
299 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300};
301
Jeff Garzik723b2f52010-03-03 22:51:50 +0000302struct ethtool_sset_info {
303 __u32 cmd; /* ETHTOOL_GSSET_INFO */
304 __u32 reserved;
305 __u64 sset_mask; /* input: each bit selects an sset to query */
306 /* output: each bit a returned sset */
307 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits
308 in sset_mask. One bit implies one
309 __u32, two bits implies two
310 __u32's, etc. */
311};
312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313enum ethtool_test_flags {
314 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
315 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
316};
317
318/* for requesting NIC test and getting results*/
319struct ethtool_test {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100320 __u32 cmd; /* ETHTOOL_TEST */
321 __u32 flags; /* ETH_TEST_FL_xxx */
322 __u32 reserved;
323 __u32 len; /* result length, in number of u64 elements */
324 __u64 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325};
326
327/* for dumping NIC-specific statistics */
328struct ethtool_stats {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100329 __u32 cmd; /* ETHTOOL_GSTATS */
330 __u32 n_stats; /* number of u64's being returned */
331 __u64 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332};
333
Jon Wetzela6f9a702005-08-20 17:15:54 -0700334struct ethtool_perm_addr {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100335 __u32 cmd; /* ETHTOOL_GPERMADDR */
336 __u32 size;
337 __u8 data[0];
Jon Wetzela6f9a702005-08-20 17:15:54 -0700338};
339
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700340/* boolean flags controlling per-interface behavior characteristics.
341 * When reading, the flag indicates whether or not a certain behavior
342 * is enabled/present. When writing, the flag indicates whether
343 * or not the driver should turn on (set) or off (clear) a behavior.
344 *
345 * Some behaviors may read-only (unconditionally absent or present).
346 * If such is the case, return EINVAL in the set-flags operation if the
347 * flag differs from the read-only value.
348 */
349enum ethtool_flags {
Jesse Grossd5dbda22010-10-20 13:56:07 +0000350 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
351 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700352 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800353 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
stephen hemmingerb00fabb2010-03-29 14:47:27 +0000354 ETH_FLAG_RXHASH = (1 << 28),
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700355};
356
Santwona Behera59089d82009-02-20 00:58:13 -0800357/* The following structures are for supporting RX network flow
Ben Hutchingse0355872010-09-14 09:10:03 +0000358 * classification and RX n-tuple configuration. Note, all multibyte
359 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
360 * be in network byte order.
361 */
362
363/**
364 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
365 * @ip4src: Source host
366 * @ip4dst: Destination host
367 * @psrc: Source port
368 * @pdst: Destination port
369 * @tos: Type-of-service
370 *
371 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
Santwona Behera59089d82009-02-20 00:58:13 -0800372 */
373struct ethtool_tcpip4_spec {
374 __be32 ip4src;
375 __be32 ip4dst;
376 __be16 psrc;
377 __be16 pdst;
378 __u8 tos;
379};
380
Ben Hutchingse0355872010-09-14 09:10:03 +0000381/**
382 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
383 * @ip4src: Source host
384 * @ip4dst: Destination host
385 * @spi: Security parameters index
386 * @tos: Type-of-service
387 *
388 * This can be used to specify an IPsec transport or tunnel over IPv4.
389 */
Santwona Behera59089d82009-02-20 00:58:13 -0800390struct ethtool_ah_espip4_spec {
391 __be32 ip4src;
392 __be32 ip4dst;
393 __be32 spi;
394 __u8 tos;
395};
396
Santwona Behera59089d82009-02-20 00:58:13 -0800397#define ETH_RX_NFC_IP4 1
Santwona Behera59089d82009-02-20 00:58:13 -0800398
Ben Hutchingse0355872010-09-14 09:10:03 +0000399/**
400 * struct ethtool_usrip4_spec - general flow specification for IPv4
401 * @ip4src: Source host
402 * @ip4dst: Destination host
403 * @l4_4_bytes: First 4 bytes of transport (layer 4) header
404 * @tos: Type-of-service
405 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
406 * @proto: Transport protocol number; mask must be 0
407 */
Santwona Behera59089d82009-02-20 00:58:13 -0800408struct ethtool_usrip4_spec {
409 __be32 ip4src;
410 __be32 ip4dst;
411 __be32 l4_4_bytes;
412 __u8 tos;
413 __u8 ip_ver;
414 __u8 proto;
415};
416
Alexander Duyck127fe532011-04-08 18:01:59 +0000417union ethtool_flow_union {
418 struct ethtool_tcpip4_spec tcp_ip4_spec;
419 struct ethtool_tcpip4_spec udp_ip4_spec;
420 struct ethtool_tcpip4_spec sctp_ip4_spec;
421 struct ethtool_ah_espip4_spec ah_ip4_spec;
422 struct ethtool_ah_espip4_spec esp_ip4_spec;
423 struct ethtool_usrip4_spec usr_ip4_spec;
424 struct ethhdr ether_spec;
425 __u8 hdata[60];
426};
427
428struct ethtool_flow_ext {
429 __be16 vlan_etype;
430 __be16 vlan_tci;
431 __be32 data[2];
432};
433
Ben Hutchingse0355872010-09-14 09:10:03 +0000434/**
435 * struct ethtool_rx_flow_spec - specification for RX flow filter
436 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
437 * @h_u: Flow fields to match (dependent on @flow_type)
Alexander Duyck127fe532011-04-08 18:01:59 +0000438 * @h_ext: Additional fields to match
439 * @m_u: Masks for flow field bits to be matched
440 * @m_ext: Masks for additional field bits to be matched
441 * Note, all additional fields must be ignored unless @flow_type
442 * includes the %FLOW_EXT flag.
Ben Hutchingse0355872010-09-14 09:10:03 +0000443 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
444 * if packets should be discarded
445 * @location: Index of filter in hardware table
446 */
Santwona Behera59089d82009-02-20 00:58:13 -0800447struct ethtool_rx_flow_spec {
Santwona Behera0853ad62008-07-02 03:47:41 -0700448 __u32 flow_type;
Alexander Duyck127fe532011-04-08 18:01:59 +0000449 union ethtool_flow_union h_u;
450 struct ethtool_flow_ext h_ext;
451 union ethtool_flow_union m_u;
452 struct ethtool_flow_ext m_ext;
Santwona Behera59089d82009-02-20 00:58:13 -0800453 __u64 ring_cookie;
454 __u32 location;
455};
456
Ben Hutchingse0355872010-09-14 09:10:03 +0000457/**
458 * struct ethtool_rxnfc - command to get or set RX flow classification rules
459 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
460 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
461 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
462 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
463 * @data: Command-dependent value
464 * @fs: Flow filter specification
465 * @rule_cnt: Number of rules to be affected
466 * @rule_locs: Array of valid rule indices
467 *
468 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
469 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
470 * structure fields must not be used.
471 *
472 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
473 * on return.
474 *
475 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
476 * rules on return.
477 *
478 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an
479 * existing filter rule on entry and @fs contains the rule on return.
480 *
481 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
482 * user buffer for @rule_locs on entry. On return, @data is the size
483 * of the filter table and @rule_locs contains the indices of the
484 * defined rules.
485 *
486 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or
487 * update. @fs.@location specifies the index to use and must not be
488 * ignored.
489 *
490 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an
491 * existing filter rule on entry.
492 *
493 * Implementation of indexed classification rules generally requires a
494 * TCAM.
495 */
Santwona Behera59089d82009-02-20 00:58:13 -0800496struct ethtool_rxnfc {
497 __u32 cmd;
498 __u32 flow_type;
Santwona Behera59089d82009-02-20 00:58:13 -0800499 __u64 data;
500 struct ethtool_rx_flow_spec fs;
501 __u32 rule_cnt;
502 __u32 rule_locs[0];
Santwona Behera0853ad62008-07-02 03:47:41 -0700503};
504
Ben Hutchings3a7da392011-03-17 07:34:32 +0000505#ifdef __KERNEL__
506#ifdef CONFIG_COMPAT
507
508struct compat_ethtool_rx_flow_spec {
509 u32 flow_type;
Alexander Duyck127fe532011-04-08 18:01:59 +0000510 union ethtool_flow_union h_u;
511 struct ethtool_flow_ext h_ext;
512 union ethtool_flow_union m_u;
513 struct ethtool_flow_ext m_ext;
Ben Hutchings3a7da392011-03-17 07:34:32 +0000514 compat_u64 ring_cookie;
515 u32 location;
516};
517
518struct compat_ethtool_rxnfc {
519 u32 cmd;
520 u32 flow_type;
521 compat_u64 data;
522 struct compat_ethtool_rx_flow_spec fs;
523 u32 rule_cnt;
524 u32 rule_locs[0];
525};
526
527#endif /* CONFIG_COMPAT */
528#endif /* __KERNEL__ */
529
Ben Hutchingse0355872010-09-14 09:10:03 +0000530/**
531 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
532 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
533 * @size: On entry, the array size of the user buffer. On return from
534 * %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
535 * @ring_index: RX ring/queue index for each hash value
536 */
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000537struct ethtool_rxfh_indir {
538 __u32 cmd;
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000539 __u32 size;
Ben Hutchingse0355872010-09-14 09:10:03 +0000540 __u32 ring_index[0];
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000541};
542
Ben Hutchingse0355872010-09-14 09:10:03 +0000543/**
544 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
545 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
546 * @h_u: Flow field values to match (dependent on @flow_type)
547 * @m_u: Masks for flow field value bits to be ignored
548 * @vlan_tag: VLAN tag to match
549 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
550 * @data: Driver-dependent data to match
551 * @data_mask: Mask for driver-dependent data bits to be ignored
552 * @action: RX ring/queue index to deliver to (non-negative) or other action
553 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
554 *
Ben Hutchingsbe2902d2010-09-16 11:28:07 +0000555 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
556 * a field value and mask are both zero this is treated as if all mask
557 * bits are set i.e. the field is ignored.
Ben Hutchingse0355872010-09-14 09:10:03 +0000558 */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800559struct ethtool_rx_ntuple_flow_spec {
560 __u32 flow_type;
561 union {
562 struct ethtool_tcpip4_spec tcp_ip4_spec;
563 struct ethtool_tcpip4_spec udp_ip4_spec;
564 struct ethtool_tcpip4_spec sctp_ip4_spec;
565 struct ethtool_ah_espip4_spec ah_ip4_spec;
566 struct ethtool_ah_espip4_spec esp_ip4_spec;
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800567 struct ethtool_usrip4_spec usr_ip4_spec;
Ben Hutchings6099e3d2010-09-20 08:42:08 +0000568 struct ethhdr ether_spec;
Ben Hutchingse0de7c92010-09-14 09:13:08 +0000569 __u8 hdata[72];
Ben Hutchingse0355872010-09-14 09:10:03 +0000570 } h_u, m_u;
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800571
572 __u16 vlan_tag;
573 __u16 vlan_tag_mask;
Ben Hutchingse0355872010-09-14 09:10:03 +0000574 __u64 data;
575 __u64 data_mask;
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800576
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800577 __s32 action;
Ben Hutchingsc22ab782010-09-20 08:41:47 +0000578#define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
579#define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800580};
581
Ben Hutchingse0355872010-09-14 09:10:03 +0000582/**
Ben Hutchingsc22ab782010-09-20 08:41:47 +0000583 * struct ethtool_rx_ntuple - command to set or clear RX flow filter
Ben Hutchingse0355872010-09-14 09:10:03 +0000584 * @cmd: Command number - %ETHTOOL_SRXNTUPLE
585 * @fs: Flow filter specification
586 */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800587struct ethtool_rx_ntuple {
588 __u32 cmd;
589 struct ethtool_rx_ntuple_flow_spec fs;
590};
591
Ajit Khaparde05c6a8d2009-09-02 17:02:55 +0000592#define ETHTOOL_FLASH_MAX_FILENAME 128
593enum ethtool_flash_op_type {
594 ETHTOOL_FLASH_ALL_REGIONS = 0,
595};
596
597/* for passing firmware flashing related parameters */
598struct ethtool_flash {
599 __u32 cmd;
600 __u32 region;
601 char data[ETHTOOL_FLASH_MAX_FILENAME];
602};
603
Michał Mirosław5455c692011-02-15 16:59:17 +0000604/* for returning and changing feature sets */
605
606/**
607 * struct ethtool_get_features_block - block with state of 32 features
608 * @available: mask of changeable features
609 * @requested: mask of features requested to be enabled if possible
610 * @active: mask of currently enabled features
611 * @never_changed: mask of features not changeable for any device
612 */
613struct ethtool_get_features_block {
614 __u32 available;
615 __u32 requested;
616 __u32 active;
617 __u32 never_changed;
618};
619
620/**
621 * struct ethtool_gfeatures - command to get state of device's features
622 * @cmd: command number = %ETHTOOL_GFEATURES
623 * @size: in: number of elements in the features[] array;
624 * out: number of elements in features[] needed to hold all features
625 * @features: state of features
626 */
627struct ethtool_gfeatures {
628 __u32 cmd;
629 __u32 size;
630 struct ethtool_get_features_block features[0];
631};
632
633/**
634 * struct ethtool_set_features_block - block with request for 32 features
635 * @valid: mask of features to be changed
636 * @requested: values of features to be changed
637 */
638struct ethtool_set_features_block {
639 __u32 valid;
640 __u32 requested;
641};
642
643/**
644 * struct ethtool_sfeatures - command to request change in device's features
645 * @cmd: command number = %ETHTOOL_SFEATURES
646 * @size: array size of the features[] array
647 * @features: feature change masks
648 */
649struct ethtool_sfeatures {
650 __u32 cmd;
651 __u32 size;
652 struct ethtool_set_features_block features[0];
653};
654
655/*
656 * %ETHTOOL_SFEATURES changes features present in features[].valid to the
657 * values of corresponding bits in features[].requested. Bits in .requested
658 * not set in .valid or not changeable are ignored.
659 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300660 * Returns %EINVAL when .valid contains undefined or never-changeable bits
Michał Mirosław5455c692011-02-15 16:59:17 +0000661 * or size is not equal to required number of features words (32-bit blocks).
662 * Returns >= 0 if request was completed; bits set in the value mean:
663 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
664 * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
665 * those bits were ignored.
666 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
667 * resulting state of bits masked by .valid is not equal to .requested.
668 * Probably there are other device-specific constraints on some features
669 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
670 * here as though ignored bits were cleared.
Michał Mirosław39fc0ce2011-02-22 16:52:29 +0000671 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
672 * compatibility functions. Requested offload state cannot be properly
673 * managed by kernel.
Michał Mirosław5455c692011-02-15 16:59:17 +0000674 *
675 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
676 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
677 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
678 * significant bit in features[0] fields. Empty strings mark undefined features.
679 */
680enum ethtool_sfeatures_retval_bits {
681 ETHTOOL_F_UNSUPPORTED__BIT,
682 ETHTOOL_F_WISH__BIT,
Michał Mirosław39fc0ce2011-02-22 16:52:29 +0000683 ETHTOOL_F_COMPAT__BIT,
Michał Mirosław5455c692011-02-15 16:59:17 +0000684};
685
686#define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
687#define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
Michał Mirosław39fc0ce2011-02-22 16:52:29 +0000688#define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
Michał Mirosław5455c692011-02-15 16:59:17 +0000689
David Woodhousec3ce7e22006-04-29 01:53:47 +0100690#ifdef __KERNEL__
691
David S. Millera1467082010-02-14 22:38:54 -0800692#include <linux/rculist.h>
693
Michał Mirosław27660512011-03-18 16:56:34 +0000694/* needed by dev_disable_lro() */
695extern int __ethtool_set_flags(struct net_device *dev, u32 flags);
696
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800697struct ethtool_rx_ntuple_flow_spec_container {
698 struct ethtool_rx_ntuple_flow_spec fs;
699 struct list_head list;
700};
701
702struct ethtool_rx_ntuple_list {
703#define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
704#define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
705 struct list_head list;
706 unsigned int count;
707};
708
Ben Hutchings68f512f2011-04-02 00:35:15 +0100709/**
710 * enum ethtool_phys_id_state - indicator state for physical identification
711 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
712 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
713 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
714 * is not supported)
715 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
716 * is not supported)
717 */
718enum ethtool_phys_id_state {
719 ETHTOOL_ID_INACTIVE,
720 ETHTOOL_ID_ACTIVE,
721 ETHTOOL_ID_ON,
722 ETHTOOL_ID_OFF
723};
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725struct net_device;
726
727/* Some generic methods drivers may use in their ethtool_ops */
728u32 ethtool_op_get_link(struct net_device *dev);
729u32 ethtool_op_get_tx_csum(struct net_device *dev);
730int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
Jon Mason69f6a0f2005-05-29 20:27:24 -0700731int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
Michael Chan6460d942007-07-14 19:07:52 -0700732int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733u32 ethtool_op_get_sg(struct net_device *dev);
734int ethtool_op_set_sg(struct net_device *dev, u32 data);
735u32 ethtool_op_get_tso(struct net_device *dev);
736int ethtool_op_set_tso(struct net_device *dev, u32 data);
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700737u32 ethtool_op_get_ufo(struct net_device *dev);
738int ethtool_op_set_ufo(struct net_device *dev, u32 data);
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700739u32 ethtool_op_get_flags(struct net_device *dev);
Ben Hutchings1437ce32010-06-30 02:44:32 +0000740int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800741void ethtool_ntuple_flush(struct net_device *dev);
Stanislaw Gruszka673e63c2011-03-22 23:54:49 +0000742bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744/**
Ben Hutchings8717d072011-04-01 23:57:41 +0100745 * struct ethtool_ops - optional netdev operations
746 * @get_settings: Get various device settings including Ethernet link
747 * settings. Returns a negative error code or zero.
748 * @set_settings: Set various device settings including Ethernet link
749 * settings. Returns a negative error code or zero.
750 * @get_drvinfo: Report driver/device information. Should only set the
751 * @driver, @version, @fw_version and @bus_info fields. If not
752 * implemented, the @driver and @bus_info fields will be filled in
753 * according to the netdev's parent device.
754 * @get_regs_len: Get buffer length required for @get_regs
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100755 * @get_regs: Get device registers
756 * @get_wol: Report whether Wake-on-Lan is enabled
Ben Hutchings8717d072011-04-01 23:57:41 +0100757 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
758 * or zero.
759 * @get_msglevel: Report driver message level. This should be the value
760 * of the @msg_enable field used by netif logging functions.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100761 * @set_msglevel: Set driver message level
Ben Hutchings8717d072011-04-01 23:57:41 +0100762 * @nway_reset: Restart autonegotiation. Returns a negative error code
763 * or zero.
764 * @get_link: Report whether physical link is up. Will only be called if
765 * the netdev is up. Should usually be set to ethtool_op_get_link(),
766 * which uses netif_carrier_ok().
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100767 * @get_eeprom: Read data from the device EEPROM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 * Should fill in the magic field. Don't need to check len for zero
769 * or wraparound. Fill in the data argument with the eeprom values
770 * from offset to offset + len. Update len to the amount read.
771 * Returns an error or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100772 * @set_eeprom: Write data to the device EEPROM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 * Should validate the magic field. Don't need to check len for zero
774 * or wraparound. Update len to the amount written. Returns an error
775 * or zero.
Ben Hutchings8717d072011-04-01 23:57:41 +0100776 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
777 * error code or zero.
778 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
779 * error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100780 * @get_ringparam: Report ring sizes
Ben Hutchings8717d072011-04-01 23:57:41 +0100781 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100782 * @get_pauseparam: Report pause parameters
Ben Hutchings8717d072011-04-01 23:57:41 +0100783 * @set_pauseparam: Set pause parameters. Returns a negative error code
784 * or zero.
785 * @get_rx_csum: Deprecated in favour of the netdev feature %NETIF_F_RXCSUM.
786 * Report whether receive checksums are turned on or off.
787 * @set_rx_csum: Deprecated in favour of generic netdev features. Turn
788 * receive checksum on or off. Returns a negative error code or zero.
789 * @get_tx_csum: Deprecated as redundant. Report whether transmit checksums
790 * are turned on or off.
791 * @set_tx_csum: Deprecated in favour of generic netdev features. Turn
792 * transmit checksums on or off. Returns a egative error code or zero.
793 * @get_sg: Deprecated as redundant. Report whether scatter-gather is
794 * enabled.
795 * @set_sg: Deprecated in favour of generic netdev features. Turn
796 * scatter-gather on or off. Returns a negative error code or zero.
797 * @get_tso: Deprecated as redundant. Report whether TCP segmentation
798 * offload is enabled.
799 * @set_tso: Deprecated in favour of generic netdev features. Turn TCP
800 * segmentation offload on or off. Returns a negative error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100801 * @self_test: Run specified self-tests
802 * @get_strings: Return a set of strings that describe the requested objects
Ben Hutchings68f512f2011-04-02 00:35:15 +0100803 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
804 * attached to it. The implementation may update the indicator
805 * asynchronously or synchronously, but in either case it must return
806 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
Allan, Bruce Wfce55922011-04-13 13:09:10 +0000807 * and must either activate asynchronous updates and return zero, return
808 * a negative error or return a positive frequency for synchronous
809 * indication (e.g. 1 for one on/off cycle per second). If it returns
810 * a frequency then it will be called again at intervals with the
Ben Hutchings68f512f2011-04-02 00:35:15 +0100811 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
812 * the indicator accordingly. Finally, it is called with the argument
813 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
814 * negative error code or zero.
815 * @phys_id: Deprecated in favour of @set_phys_id.
816 * Identify the physical device, e.g. by flashing an LED
Ben Hutchings8717d072011-04-01 23:57:41 +0100817 * attached to it until interrupted by a signal or the given time
818 * (in seconds) elapses. If the given time is zero, use a default
819 * time limit. Returns a negative error code or zero. Being
820 * interrupted by a signal is not an error.
821 * @get_ethtool_stats: Return extended statistics about the device.
822 * This is only useful if the device maintains statistics not
823 * included in &struct rtnl_link_stats64.
824 * @begin: Function to be called before any other operation. Returns a
825 * negative error code or zero.
826 * @complete: Function to be called after any other operation except
827 * @begin. Will be called even if the other operation failed.
828 * @get_ufo: Deprecated as redundant. Report whether UDP fragmentation
829 * offload is enabled.
830 * @set_ufo: Deprecated in favour of generic netdev features. Turn UDP
831 * fragmentation offload on or off. Returns a negative error code or zero.
832 * @get_flags: Deprecated as redundant. Report features included in
833 * &enum ethtool_flags that are enabled.
834 * @set_flags: Deprecated in favour of generic netdev features. Turn
835 * features included in &enum ethtool_flags on or off. Returns a
836 * negative error code or zero.
837 * @get_priv_flags: Report driver-specific feature flags.
838 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
839 * error code or zero.
840 * @get_sset_count: Get number of strings that @get_strings will write.
841 * @get_rxnfc: Get RX flow classification rules. Returns a negative
842 * error code or zero.
843 * @set_rxnfc: Set RX flow classification rules. Returns a negative
844 * error code or zero.
845 * @flash_device: Write a firmware image to device's flash memory.
846 * Returns a negative error code or zero.
847 * @reset: Reset (part of) the device, as specified by a bitmask of
848 * flags from &enum ethtool_reset_flags. Returns a negative
849 * error code or zero.
850 * @set_rx_ntuple: Set an RX n-tuple rule. Returns a negative error code
851 * or zero.
852 * @get_rx_ntuple: Deprecated.
853 * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
854 * Returns a negative error code or zero.
855 * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
856 * Returns a negative error code or zero.
amit salecha8b5933c2011-04-07 01:58:42 +0000857 * @get_channels: Get number of channels.
858 * @set_channels: Set number of channels. Returns a negative error code or
859 * zero.
Ben Hutchings8717d072011-04-01 23:57:41 +0100860 *
861 * All operations are optional (i.e. the function pointer may be set
862 * to %NULL) and callers must take this into account. Callers must
863 * hold the RTNL, except that for @get_drvinfo the caller may or may
864 * not hold the RTNL.
865 *
866 * See the structures used by these operations for further documentation.
867 *
868 * See &struct net_device and &struct net_device_ops for documentation
869 * of the generic netdev features interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 */
871struct ethtool_ops {
872 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
873 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
874 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
875 int (*get_regs_len)(struct net_device *);
876 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
877 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
878 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
879 u32 (*get_msglevel)(struct net_device *);
880 void (*set_msglevel)(struct net_device *, u32);
881 int (*nway_reset)(struct net_device *);
882 u32 (*get_link)(struct net_device *);
883 int (*get_eeprom_len)(struct net_device *);
chavey97f8aef2010-04-07 21:54:42 -0700884 int (*get_eeprom)(struct net_device *,
885 struct ethtool_eeprom *, u8 *);
886 int (*set_eeprom)(struct net_device *,
887 struct ethtool_eeprom *, u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
889 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
chavey97f8aef2010-04-07 21:54:42 -0700890 void (*get_ringparam)(struct net_device *,
891 struct ethtool_ringparam *);
892 int (*set_ringparam)(struct net_device *,
893 struct ethtool_ringparam *);
894 void (*get_pauseparam)(struct net_device *,
895 struct ethtool_pauseparam*);
896 int (*set_pauseparam)(struct net_device *,
897 struct ethtool_pauseparam*);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 u32 (*get_rx_csum)(struct net_device *);
899 int (*set_rx_csum)(struct net_device *, u32);
900 u32 (*get_tx_csum)(struct net_device *);
901 int (*set_tx_csum)(struct net_device *, u32);
902 u32 (*get_sg)(struct net_device *);
903 int (*set_sg)(struct net_device *, u32);
904 u32 (*get_tso)(struct net_device *);
905 int (*set_tso)(struct net_device *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
907 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
Ben Hutchings68f512f2011-04-02 00:35:15 +0100908 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 int (*phys_id)(struct net_device *, u32);
chavey97f8aef2010-04-07 21:54:42 -0700910 void (*get_ethtool_stats)(struct net_device *,
911 struct ethtool_stats *, u64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 int (*begin)(struct net_device *);
913 void (*complete)(struct net_device *);
chavey97f8aef2010-04-07 21:54:42 -0700914 u32 (*get_ufo)(struct net_device *);
915 int (*set_ufo)(struct net_device *, u32);
916 u32 (*get_flags)(struct net_device *);
917 int (*set_flags)(struct net_device *, u32);
918 u32 (*get_priv_flags)(struct net_device *);
919 int (*set_priv_flags)(struct net_device *, u32);
Jeff Garzikff03d492007-08-15 16:01:08 -0700920 int (*get_sset_count)(struct net_device *, int);
chavey97f8aef2010-04-07 21:54:42 -0700921 int (*get_rxnfc)(struct net_device *,
922 struct ethtool_rxnfc *, void *);
Santwona Behera59089d82009-02-20 00:58:13 -0800923 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
chavey97f8aef2010-04-07 21:54:42 -0700924 int (*flash_device)(struct net_device *, struct ethtool_flash *);
Ben Hutchingsd73d3a82009-10-05 10:59:58 +0000925 int (*reset)(struct net_device *, u32 *);
chavey97f8aef2010-04-07 21:54:42 -0700926 int (*set_rx_ntuple)(struct net_device *,
927 struct ethtool_rx_ntuple *);
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800928 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000929 int (*get_rxfh_indir)(struct net_device *,
930 struct ethtool_rxfh_indir *);
931 int (*set_rxfh_indir)(struct net_device *,
932 const struct ethtool_rxfh_indir *);
amit salecha8b5933c2011-04-07 01:58:42 +0000933 void (*get_channels)(struct net_device *, struct ethtool_channels *);
934 int (*set_channels)(struct net_device *, struct ethtool_channels *);
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936};
David Woodhousec3ce7e22006-04-29 01:53:47 +0100937#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
939/* CMDs currently supported */
940#define ETHTOOL_GSET 0x00000001 /* Get settings. */
941#define ETHTOOL_SSET 0x00000002 /* Set settings. */
942#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
943#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
944#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
945#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000946#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
947#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
Ben Hutchingse596e6e2010-12-09 12:08:35 +0000949/* Get link status for host, i.e. whether the interface *and* the
950 * physical port (if there is one) are up (ethtool_value). */
951#define ETHTOOL_GLINK 0x0000000a
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000952#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
953#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
955#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
956#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
957#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
958#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
959#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000960#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
961#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
962#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
963#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
965 * (ethtool_value) */
966#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
967 * (ethtool_value). */
968#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
969#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000970#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
972#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
973#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
Jon Wetzela6f9a702005-08-20 17:15:54 -0700974#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700975#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
976#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
Herbert Xu37c31852006-06-22 03:07:29 -0700977#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
978#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700979#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
980#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +0000981#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
982#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
chavey97f8aef2010-04-07 21:54:42 -0700984#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
985#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
Herbert Xub240a0e2008-12-15 23:44:31 -0800986#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
987#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
chavey97f8aef2010-04-07 21:54:42 -0700988#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
989#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
990#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
991#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
992#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
993#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
994#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
995#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
996#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
997#define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */
998#define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
Ben Hutchingsa5b6ee22010-06-30 05:05:23 +0000999#define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
1000#define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -08001001
Michał Mirosław5455c692011-02-15 16:59:17 +00001002#define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
1003#define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
amit salecha8b5933c2011-04-07 01:58:42 +00001004#define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
1005#define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
Michał Mirosław5455c692011-02-15 16:59:17 +00001006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007/* compatibility with older code */
1008#define SPARC_ETH_GSET ETHTOOL_GSET
1009#define SPARC_ETH_SSET ETHTOOL_SSET
1010
1011/* Indicates what features are supported by the interface. */
1012#define SUPPORTED_10baseT_Half (1 << 0)
1013#define SUPPORTED_10baseT_Full (1 << 1)
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001014#define SUPPORTED_100baseT_Half (1 << 2)
1015#define SUPPORTED_100baseT_Full (1 << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016#define SUPPORTED_1000baseT_Half (1 << 4)
1017#define SUPPORTED_1000baseT_Full (1 << 5)
1018#define SUPPORTED_Autoneg (1 << 6)
1019#define SUPPORTED_TP (1 << 7)
1020#define SUPPORTED_AUI (1 << 8)
1021#define SUPPORTED_MII (1 << 9)
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001022#define SUPPORTED_FIBRE (1 << 10)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023#define SUPPORTED_BNC (1 << 11)
1024#define SUPPORTED_10000baseT_Full (1 << 12)
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001025#define SUPPORTED_Pause (1 << 13)
Andy Fleming00db8182005-07-30 19:31:23 -04001026#define SUPPORTED_Asym_Pause (1 << 14)
Michael Chan427c2192007-05-03 13:17:25 -07001027#define SUPPORTED_2500baseX_Full (1 << 15)
Ben Hutchings894b19a2009-04-29 08:25:57 +00001028#define SUPPORTED_Backplane (1 << 16)
1029#define SUPPORTED_1000baseKX_Full (1 << 17)
1030#define SUPPORTED_10000baseKX4_Full (1 << 18)
1031#define SUPPORTED_10000baseKR_Full (1 << 19)
1032#define SUPPORTED_10000baseR_FEC (1 << 20)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
1034/* Indicates what features are advertised by the interface. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001035#define ADVERTISED_10baseT_Half (1 << 0)
1036#define ADVERTISED_10baseT_Full (1 << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037#define ADVERTISED_100baseT_Half (1 << 2)
1038#define ADVERTISED_100baseT_Full (1 << 3)
1039#define ADVERTISED_1000baseT_Half (1 << 4)
1040#define ADVERTISED_1000baseT_Full (1 << 5)
1041#define ADVERTISED_Autoneg (1 << 6)
1042#define ADVERTISED_TP (1 << 7)
1043#define ADVERTISED_AUI (1 << 8)
1044#define ADVERTISED_MII (1 << 9)
1045#define ADVERTISED_FIBRE (1 << 10)
1046#define ADVERTISED_BNC (1 << 11)
1047#define ADVERTISED_10000baseT_Full (1 << 12)
Andy Fleming00db8182005-07-30 19:31:23 -04001048#define ADVERTISED_Pause (1 << 13)
1049#define ADVERTISED_Asym_Pause (1 << 14)
Michael Chan427c2192007-05-03 13:17:25 -07001050#define ADVERTISED_2500baseX_Full (1 << 15)
Ben Hutchings894b19a2009-04-29 08:25:57 +00001051#define ADVERTISED_Backplane (1 << 16)
1052#define ADVERTISED_1000baseKX_Full (1 << 17)
1053#define ADVERTISED_10000baseKX4_Full (1 << 18)
1054#define ADVERTISED_10000baseKR_Full (1 << 19)
1055#define ADVERTISED_10000baseR_FEC (1 << 20)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056
1057/* The following are all involved in forcing a particular link
1058 * mode for the device for setting things. When getting the
1059 * devices settings, these indicate the current mode and whether
1060 * it was foced up into this mode or autonegotiated.
1061 */
1062
Michael Chan5b0c76a2005-11-04 08:45:49 -08001063/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064#define SPEED_10 10
1065#define SPEED_100 100
1066#define SPEED_1000 1000
Michael Chan5b0c76a2005-11-04 08:45:49 -08001067#define SPEED_2500 2500
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068#define SPEED_10000 10000
1069
1070/* Duplex, half or full. */
1071#define DUPLEX_HALF 0x00
1072#define DUPLEX_FULL 0x01
1073
1074/* Which connector port. */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001075#define PORT_TP 0x00
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076#define PORT_AUI 0x01
1077#define PORT_MII 0x02
1078#define PORT_FIBRE 0x03
1079#define PORT_BNC 0x04
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001080#define PORT_DA 0x05
PJ Waskiewicz5789d292009-11-25 00:11:30 +00001081#define PORT_NONE 0xef
Ben Hutchings0821c712009-04-29 08:02:59 +00001082#define PORT_OTHER 0xff
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
1084/* Which transceiver to use. */
1085#define XCVR_INTERNAL 0x00
1086#define XCVR_EXTERNAL 0x01
1087#define XCVR_DUMMY1 0x02
1088#define XCVR_DUMMY2 0x03
1089#define XCVR_DUMMY3 0x04
1090
1091/* Enable or disable autonegotiation. If this is set to enable,
1092 * the forced link modes above are completely ignored.
1093 */
Ben Hutchings1be3b5f2010-06-14 08:53:26 +00001094#define AUTONEG_DISABLE 0x00
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095#define AUTONEG_ENABLE 0x01
1096
Chaitanya Lala18760f12009-06-08 14:28:54 +00001097/* Mode MDI or MDI-X */
1098#define ETH_TP_MDI_INVALID 0x00
1099#define ETH_TP_MDI 0x01
1100#define ETH_TP_MDI_X 0x02
1101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102/* Wake-On-Lan options. */
1103#define WAKE_PHY (1 << 0)
1104#define WAKE_UCAST (1 << 1)
1105#define WAKE_MCAST (1 << 2)
1106#define WAKE_BCAST (1 << 3)
1107#define WAKE_ARP (1 << 4)
1108#define WAKE_MAGIC (1 << 5)
1109#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
1110
Ben Hutchings6099e3d2010-09-20 08:42:08 +00001111/* L2-L4 network traffic flow types */
Ben Hutchings07af7a22010-09-16 11:34:26 +00001112#define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
1113#define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
1114#define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
1115#define AH_ESP_V4_FLOW 0x04 /* hash only */
1116#define TCP_V6_FLOW 0x05 /* hash only */
1117#define UDP_V6_FLOW 0x06 /* hash only */
1118#define SCTP_V6_FLOW 0x07 /* hash only */
1119#define AH_ESP_V6_FLOW 0x08 /* hash only */
1120#define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
1121#define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
1122#define AH_V6_FLOW 0x0b /* hash only */
1123#define ESP_V6_FLOW 0x0c /* hash only */
1124#define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
1125#define IPV4_FLOW 0x10 /* hash only */
1126#define IPV6_FLOW 0x11 /* hash only */
Ben Hutchings6099e3d2010-09-20 08:42:08 +00001127#define ETHER_FLOW 0x12 /* spec only (ether_spec) */
Alexander Duyck127fe532011-04-08 18:01:59 +00001128/* Flag to enable additional fields in struct ethtool_rx_flow_spec */
1129#define FLOW_EXT 0x80000000
Santwona Behera0853ad62008-07-02 03:47:41 -07001130
1131/* L3-L4 network traffic flow hash options */
Santwona Behera0853ad62008-07-02 03:47:41 -07001132#define RXH_L2DA (1 << 1)
1133#define RXH_VLAN (1 << 2)
1134#define RXH_L3_PROTO (1 << 3)
1135#define RXH_IP_SRC (1 << 4)
1136#define RXH_IP_DST (1 << 5)
1137#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
1138#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
1139#define RXH_DISCARD (1 << 31)
1140
Santwona Behera59089d82009-02-20 00:58:13 -08001141#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
Santwona Behera0853ad62008-07-02 03:47:41 -07001142
Ben Hutchingsd73d3a82009-10-05 10:59:58 +00001143/* Reset flags */
1144/* The reset() operation must clear the flags for the components which
1145 * were actually reset. On successful return, the flags indicate the
1146 * components which were not reset, either because they do not exist
1147 * in the hardware or because they cannot be reset independently. The
1148 * driver must never reset any components that were not requested.
1149 */
1150enum ethtool_reset_flags {
1151 /* These flags represent components dedicated to the interface
1152 * the command is addressed to. Shift any flag left by
1153 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
1154 * same type.
1155 */
1156 ETH_RESET_MGMT = 1 << 0, /* Management processor */
1157 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
1158 ETH_RESET_DMA = 1 << 2, /* DMA engine */
1159 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
1160 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
1161 ETH_RESET_MAC = 1 << 5, /* Media access controller */
1162 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
1163 ETH_RESET_RAM = 1 << 7, /* RAM shared between
1164 * multiple components */
1165
1166 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
1167 * this interface */
1168 ETH_RESET_ALL = 0xffffffff, /* All components used by this
1169 * interface, even if shared */
1170};
1171#define ETH_RESET_SHARED_SHIFT 16
1172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173#endif /* _LINUX_ETHTOOL_H */