blob: b33f316bb92e0f984c5ed593ed48e845fb242cba [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
Kirill A. Shutemove621e692008-03-07 11:11:13 -080016#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
18/* This should work for both 32 and 64 bit userland. */
19struct ethtool_cmd {
David Woodhousec3ce7e22006-04-29 01:53:47 +010020 __u32 cmd;
21 __u32 supported; /* Features this interface supports */
22 __u32 advertising; /* Features this interface advertises */
23 __u16 speed; /* The forced speed, 10Mb, 100Mb, gigabit */
24 __u8 duplex; /* Duplex, half or full */
25 __u8 port; /* Which connector port */
26 __u8 phy_address;
27 __u8 transceiver; /* Which transceiver to use */
28 __u8 autoneg; /* Enable or disable autonegotiation */
Ben Hutchings0c09c1a2009-04-29 08:21:53 +000029 __u8 mdio_support;
David Woodhousec3ce7e22006-04-29 01:53:47 +010030 __u32 maxtxpkt; /* Tx pkts before generating tx int */
31 __u32 maxrxpkt; /* Rx pkts before generating rx int */
Brandon Philipsb11f8d82008-07-15 02:18:41 -070032 __u16 speed_hi;
Chaitanya Lala18760f12009-06-08 14:28:54 +000033 __u8 eth_tp_mdix;
34 __u8 reserved2;
Ben Hutchings0c09c1a2009-04-29 08:21:53 +000035 __u32 lp_advertising; /* Features the link partner advertises */
36 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -070037};
38
Brandon Philipsb11f8d82008-07-15 02:18:41 -070039static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
40 __u32 speed)
41{
42
43 ep->speed = (__u16)speed;
44 ep->speed_hi = (__u16)(speed >> 16);
45}
46
47static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep)
48{
49 return (ep->speed_hi << 16) | ep->speed;
50}
51
Matt Carlson141518c2009-12-03 08:36:22 +000052#define ETHTOOL_FWVERS_LEN 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#define ETHTOOL_BUSINFO_LEN 32
54/* these strings are set to whatever the driver author decides... */
55struct ethtool_drvinfo {
David Woodhousec3ce7e22006-04-29 01:53:47 +010056 __u32 cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 char driver[32]; /* driver short name, "tulip", "eepro100" */
58 char version[32]; /* driver version string */
Matt Carlson141518c2009-12-03 08:36:22 +000059 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
61 /* For PCI devices, use pci_name(pci_dev). */
62 char reserved1[32];
Jeff Garzik339bf022007-08-15 16:01:32 -070063 char reserved2[12];
Jeff Garzikd17792e2010-03-04 08:21:53 +000064 /*
65 * Some struct members below are filled in
66 * using ops->get_sset_count(). Obtaining
67 * this info from ethtool_drvinfo is now
68 * deprecated; Use ETHTOOL_GSSET_INFO
69 * instead.
70 */
Jeff Garzik339bf022007-08-15 16:01:32 -070071 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
David Woodhousec3ce7e22006-04-29 01:53:47 +010072 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
73 __u32 testinfo_len;
74 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
75 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076};
77
78#define SOPASS_MAX 6
79/* wake-on-lan settings */
80struct ethtool_wolinfo {
David Woodhousec3ce7e22006-04-29 01:53:47 +010081 __u32 cmd;
82 __u32 supported;
83 __u32 wolopts;
84 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
Linus Torvalds1da177e2005-04-16 15:20:36 -070085};
86
87/* for passing single values */
88struct ethtool_value {
David Woodhousec3ce7e22006-04-29 01:53:47 +010089 __u32 cmd;
90 __u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091};
92
93/* for passing big chunks of data */
94struct ethtool_regs {
David Woodhousec3ce7e22006-04-29 01:53:47 +010095 __u32 cmd;
96 __u32 version; /* driver-specific, indicates different chips/revs */
97 __u32 len; /* bytes */
98 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -070099};
100
101/* for passing EEPROM chunks */
102struct ethtool_eeprom {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100103 __u32 cmd;
104 __u32 magic;
105 __u32 offset; /* in bytes */
106 __u32 len; /* in bytes */
107 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108};
109
110/* for configuring coalescing parameters of chip */
111struct ethtool_coalesce {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100112 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 /* How many usecs to delay an RX interrupt after
115 * a packet arrives. If 0, only rx_max_coalesced_frames
116 * is used.
117 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100118 __u32 rx_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 /* How many packets to delay an RX interrupt after
121 * a packet arrives. If 0, only rx_coalesce_usecs is
122 * used. It is illegal to set both usecs and max frames
123 * to zero as this would cause RX interrupts to never be
124 * generated.
125 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100126 __u32 rx_max_coalesced_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 /* Same as above two parameters, except that these values
129 * apply while an IRQ is being serviced by the host. Not
130 * all cards support this feature and the values are ignored
131 * in that case.
132 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100133 __u32 rx_coalesce_usecs_irq;
134 __u32 rx_max_coalesced_frames_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136 /* How many usecs to delay a TX interrupt after
137 * a packet is sent. If 0, only tx_max_coalesced_frames
138 * is used.
139 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100140 __u32 tx_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 /* How many packets to delay a TX interrupt after
143 * a packet is sent. If 0, only tx_coalesce_usecs is
144 * used. It is illegal to set both usecs and max frames
145 * to zero as this would cause TX interrupts to never be
146 * generated.
147 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100148 __u32 tx_max_coalesced_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 /* Same as above two parameters, except that these values
151 * apply while an IRQ is being serviced by the host. Not
152 * all cards support this feature and the values are ignored
153 * in that case.
154 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100155 __u32 tx_coalesce_usecs_irq;
156 __u32 tx_max_coalesced_frames_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158 /* How many usecs to delay in-memory statistics
159 * block updates. Some drivers do not have an in-memory
160 * statistic block, and in such cases this value is ignored.
161 * This value must not be zero.
162 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100163 __u32 stats_block_coalesce_usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165 /* Adaptive RX/TX coalescing is an algorithm implemented by
166 * some drivers to improve latency under low packet rates and
167 * improve throughput under high packet rates. Some drivers
168 * only implement one of RX or TX adaptive coalescing. Anything
169 * not implemented by the driver causes these values to be
170 * silently ignored.
171 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100172 __u32 use_adaptive_rx_coalesce;
173 __u32 use_adaptive_tx_coalesce;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175 /* When the packet rate (measured in packets per second)
176 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
177 * used.
178 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100179 __u32 pkt_rate_low;
180 __u32 rx_coalesce_usecs_low;
181 __u32 rx_max_coalesced_frames_low;
182 __u32 tx_coalesce_usecs_low;
183 __u32 tx_max_coalesced_frames_low;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 /* When the packet rate is below pkt_rate_high but above
186 * pkt_rate_low (both measured in packets per second) the
187 * normal {rx,tx}_* coalescing parameters are used.
188 */
189
190 /* When the packet rate is (measured in packets per second)
191 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
192 * used.
193 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100194 __u32 pkt_rate_high;
195 __u32 rx_coalesce_usecs_high;
196 __u32 rx_max_coalesced_frames_high;
197 __u32 tx_coalesce_usecs_high;
198 __u32 tx_max_coalesced_frames_high;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 /* How often to do adaptive coalescing packet rate sampling,
201 * measured in seconds. Must not be zero.
202 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100203 __u32 rate_sample_interval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204};
205
206/* for configuring RX/TX ring parameters */
207struct ethtool_ringparam {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100208 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210 /* Read only attributes. These indicate the maximum number
211 * of pending RX/TX ring entries the driver will allow the
212 * user to set.
213 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100214 __u32 rx_max_pending;
215 __u32 rx_mini_max_pending;
216 __u32 rx_jumbo_max_pending;
217 __u32 tx_max_pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219 /* Values changeable by the user. The valid values are
220 * in the range 1 to the "*_max_pending" counterpart above.
221 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100222 __u32 rx_pending;
223 __u32 rx_mini_pending;
224 __u32 rx_jumbo_pending;
225 __u32 tx_pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226};
227
228/* for configuring link flow control parameters */
229struct ethtool_pauseparam {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100230 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
233 * being true) the user may set 'autonet' here non-zero to have the
234 * pause parameters be auto-negotiated too. In such a case, the
235 * {rx,tx}_pause values below determine what capabilities are
236 * advertised.
237 *
238 * If 'autoneg' is zero or the link is not being auto-negotiated,
239 * then {rx,tx}_pause force the driver to use/not-use pause
240 * flow control.
241 */
David Woodhousec3ce7e22006-04-29 01:53:47 +0100242 __u32 autoneg;
243 __u32 rx_pause;
244 __u32 tx_pause;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245};
246
247#define ETH_GSTRING_LEN 32
248enum ethtool_stringset {
249 ETH_SS_TEST = 0,
250 ETH_SS_STATS,
Jeff Garzik339bf022007-08-15 16:01:32 -0700251 ETH_SS_PRIV_FLAGS,
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800252 ETH_SS_NTUPLE_FILTERS,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253};
254
255/* for passing string sets for data tagging */
256struct ethtool_gstrings {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100257 __u32 cmd; /* ETHTOOL_GSTRINGS */
258 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
259 __u32 len; /* number of strings in the string set */
260 __u8 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261};
262
Jeff Garzik723b2f52010-03-03 22:51:50 +0000263struct ethtool_sset_info {
264 __u32 cmd; /* ETHTOOL_GSSET_INFO */
265 __u32 reserved;
266 __u64 sset_mask; /* input: each bit selects an sset to query */
267 /* output: each bit a returned sset */
268 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits
269 in sset_mask. One bit implies one
270 __u32, two bits implies two
271 __u32's, etc. */
272};
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274enum ethtool_test_flags {
275 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
276 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
277};
278
279/* for requesting NIC test and getting results*/
280struct ethtool_test {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100281 __u32 cmd; /* ETHTOOL_TEST */
282 __u32 flags; /* ETH_TEST_FL_xxx */
283 __u32 reserved;
284 __u32 len; /* result length, in number of u64 elements */
285 __u64 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286};
287
288/* for dumping NIC-specific statistics */
289struct ethtool_stats {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100290 __u32 cmd; /* ETHTOOL_GSTATS */
291 __u32 n_stats; /* number of u64's being returned */
292 __u64 data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293};
294
Jon Wetzela6f9a702005-08-20 17:15:54 -0700295struct ethtool_perm_addr {
David Woodhousec3ce7e22006-04-29 01:53:47 +0100296 __u32 cmd; /* ETHTOOL_GPERMADDR */
297 __u32 size;
298 __u8 data[0];
Jon Wetzela6f9a702005-08-20 17:15:54 -0700299};
300
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700301/* boolean flags controlling per-interface behavior characteristics.
302 * When reading, the flag indicates whether or not a certain behavior
303 * is enabled/present. When writing, the flag indicates whether
304 * or not the driver should turn on (set) or off (clear) a behavior.
305 *
306 * Some behaviors may read-only (unconditionally absent or present).
307 * If such is the case, return EINVAL in the set-flags operation if the
308 * flag differs from the read-only value.
309 */
310enum ethtool_flags {
311 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800312 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700313};
314
Santwona Behera59089d82009-02-20 00:58:13 -0800315/* The following structures are for supporting RX network flow
316 * classification configuration. Note, all multibyte fields, e.g.,
317 * ip4src, ip4dst, psrc, pdst, spi, etc. are expected to be in network
318 * byte order.
319 */
320struct ethtool_tcpip4_spec {
321 __be32 ip4src;
322 __be32 ip4dst;
323 __be16 psrc;
324 __be16 pdst;
325 __u8 tos;
326};
327
328struct ethtool_ah_espip4_spec {
329 __be32 ip4src;
330 __be32 ip4dst;
331 __be32 spi;
332 __u8 tos;
333};
334
335struct ethtool_rawip4_spec {
336 __be32 ip4src;
337 __be32 ip4dst;
338 __u8 hdata[64];
339};
340
341struct ethtool_ether_spec {
342 __be16 ether_type;
343 __u8 frame_size;
344 __u8 eframe[16];
345};
346
347#define ETH_RX_NFC_IP4 1
348#define ETH_RX_NFC_IP6 2
349
350struct ethtool_usrip4_spec {
351 __be32 ip4src;
352 __be32 ip4dst;
353 __be32 l4_4_bytes;
354 __u8 tos;
355 __u8 ip_ver;
356 __u8 proto;
357};
358
359struct ethtool_rx_flow_spec {
Santwona Behera0853ad62008-07-02 03:47:41 -0700360 __u32 flow_type;
Santwona Behera59089d82009-02-20 00:58:13 -0800361 union {
362 struct ethtool_tcpip4_spec tcp_ip4_spec;
363 struct ethtool_tcpip4_spec udp_ip4_spec;
364 struct ethtool_tcpip4_spec sctp_ip4_spec;
365 struct ethtool_ah_espip4_spec ah_ip4_spec;
366 struct ethtool_ah_espip4_spec esp_ip4_spec;
367 struct ethtool_rawip4_spec raw_ip4_spec;
368 struct ethtool_ether_spec ether_spec;
369 struct ethtool_usrip4_spec usr_ip4_spec;
370 __u8 hdata[64];
371 } h_u, m_u; /* entry, mask */
372 __u64 ring_cookie;
373 __u32 location;
374};
375
376struct ethtool_rxnfc {
377 __u32 cmd;
378 __u32 flow_type;
379 /* The rx flow hash value or the rule DB size */
380 __u64 data;
381 struct ethtool_rx_flow_spec fs;
382 __u32 rule_cnt;
383 __u32 rule_locs[0];
Santwona Behera0853ad62008-07-02 03:47:41 -0700384};
385
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800386struct ethtool_rx_ntuple_flow_spec {
387 __u32 flow_type;
388 union {
389 struct ethtool_tcpip4_spec tcp_ip4_spec;
390 struct ethtool_tcpip4_spec udp_ip4_spec;
391 struct ethtool_tcpip4_spec sctp_ip4_spec;
392 struct ethtool_ah_espip4_spec ah_ip4_spec;
393 struct ethtool_ah_espip4_spec esp_ip4_spec;
394 struct ethtool_rawip4_spec raw_ip4_spec;
395 struct ethtool_ether_spec ether_spec;
396 struct ethtool_usrip4_spec usr_ip4_spec;
397 __u8 hdata[64];
398 } h_u, m_u; /* entry, mask */
399
400 __u16 vlan_tag;
401 __u16 vlan_tag_mask;
402 __u64 data; /* user-defined flow spec data */
403 __u64 data_mask; /* user-defined flow spec mask */
404
405 /* signed to distinguish between queue and actions (DROP) */
406 __s32 action;
407#define ETHTOOL_RXNTUPLE_ACTION_DROP -1
408};
409
410struct ethtool_rx_ntuple {
411 __u32 cmd;
412 struct ethtool_rx_ntuple_flow_spec fs;
413};
414
Ajit Khaparde05c6a8d2009-09-02 17:02:55 +0000415#define ETHTOOL_FLASH_MAX_FILENAME 128
416enum ethtool_flash_op_type {
417 ETHTOOL_FLASH_ALL_REGIONS = 0,
418};
419
420/* for passing firmware flashing related parameters */
421struct ethtool_flash {
422 __u32 cmd;
423 __u32 region;
424 char data[ETHTOOL_FLASH_MAX_FILENAME];
425};
426
David Woodhousec3ce7e22006-04-29 01:53:47 +0100427#ifdef __KERNEL__
428
David S. Millera1467082010-02-14 22:38:54 -0800429#include <linux/rculist.h>
430
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800431struct ethtool_rx_ntuple_flow_spec_container {
432 struct ethtool_rx_ntuple_flow_spec fs;
433 struct list_head list;
434};
435
436struct ethtool_rx_ntuple_list {
437#define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
438#define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
439 struct list_head list;
440 unsigned int count;
441};
442
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443struct net_device;
444
445/* Some generic methods drivers may use in their ethtool_ops */
446u32 ethtool_op_get_link(struct net_device *dev);
Eric Dumazet8a729fc2009-07-26 23:18:11 +0000447u32 ethtool_op_get_rx_csum(struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448u32 ethtool_op_get_tx_csum(struct net_device *dev);
449int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
Jon Mason69f6a0f2005-05-29 20:27:24 -0700450int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
Michael Chan6460d942007-07-14 19:07:52 -0700451int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452u32 ethtool_op_get_sg(struct net_device *dev);
453int ethtool_op_set_sg(struct net_device *dev, u32 data);
454u32 ethtool_op_get_tso(struct net_device *dev);
455int ethtool_op_set_tso(struct net_device *dev, u32 data);
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700456u32 ethtool_op_get_ufo(struct net_device *dev);
457int ethtool_op_set_ufo(struct net_device *dev, u32 data);
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700458u32 ethtool_op_get_flags(struct net_device *dev);
459int ethtool_op_set_flags(struct net_device *dev, u32 data);
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800460void ethtool_ntuple_flush(struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
462/**
463 * &ethtool_ops - Alter and report network device settings
464 * get_settings: Get device-specific settings
465 * set_settings: Set device-specific settings
466 * get_drvinfo: Report driver information
467 * get_regs: Get device registers
468 * get_wol: Report whether Wake-on-Lan is enabled
469 * set_wol: Turn Wake-on-Lan on or off
470 * get_msglevel: Report driver message level
471 * set_msglevel: Set driver message level
472 * nway_reset: Restart autonegotiation
473 * get_link: Get link status
474 * get_eeprom: Read data from the device EEPROM
475 * set_eeprom: Write data to the device EEPROM
476 * get_coalesce: Get interrupt coalescing parameters
477 * set_coalesce: Set interrupt coalescing parameters
478 * get_ringparam: Report ring sizes
479 * set_ringparam: Set ring sizes
480 * get_pauseparam: Report pause parameters
Joe Perchesfd3f8982008-02-03 17:45:46 +0200481 * set_pauseparam: Set pause parameters
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 * get_rx_csum: Report whether receive checksums are turned on or off
483 * set_rx_csum: Turn receive checksum on or off
484 * get_tx_csum: Report whether transmit checksums are turned on or off
485 * set_tx_csum: Turn transmit checksums on or off
486 * get_sg: Report whether scatter-gather is enabled
487 * set_sg: Turn scatter-gather on or off
488 * get_tso: Report whether TCP segmentation offload is enabled
489 * set_tso: Turn TCP segmentation offload on or off
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700490 * get_ufo: Report whether UDP fragmentation offload is enabled
491 * set_ufo: Turn UDP fragmentation offload on or off
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 * self_test: Run specified self-tests
493 * get_strings: Return a set of strings that describe the requested objects
494 * phys_id: Identify the device
495 * get_stats: Return statistics about the device
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700496 * get_flags: get 32-bit flags bitmap
497 * set_flags: set 32-bit flags bitmap
Jon Wetzela6f9a702005-08-20 17:15:54 -0700498 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 * Description:
500 *
501 * get_settings:
502 * @get_settings is passed an &ethtool_cmd to fill in. It returns
503 * an negative errno or zero.
504 *
505 * set_settings:
506 * @set_settings is passed an &ethtool_cmd and should attempt to set
507 * all the settings this device supports. It may return an error value
508 * if something goes wrong (otherwise 0).
509 *
510 * get_eeprom:
511 * Should fill in the magic field. Don't need to check len for zero
512 * or wraparound. Fill in the data argument with the eeprom values
513 * from offset to offset + len. Update len to the amount read.
514 * Returns an error or zero.
515 *
516 * set_eeprom:
517 * Should validate the magic field. Don't need to check len for zero
518 * or wraparound. Update len to the amount written. Returns an error
519 * or zero.
520 */
521struct ethtool_ops {
522 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
523 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
524 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
525 int (*get_regs_len)(struct net_device *);
526 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
527 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
528 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
529 u32 (*get_msglevel)(struct net_device *);
530 void (*set_msglevel)(struct net_device *, u32);
531 int (*nway_reset)(struct net_device *);
532 u32 (*get_link)(struct net_device *);
533 int (*get_eeprom_len)(struct net_device *);
534 int (*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
535 int (*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
536 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
537 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
538 void (*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
539 int (*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
540 void (*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
541 int (*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
542 u32 (*get_rx_csum)(struct net_device *);
543 int (*set_rx_csum)(struct net_device *, u32);
544 u32 (*get_tx_csum)(struct net_device *);
545 int (*set_tx_csum)(struct net_device *, u32);
546 u32 (*get_sg)(struct net_device *);
547 int (*set_sg)(struct net_device *, u32);
548 u32 (*get_tso)(struct net_device *);
549 int (*set_tso)(struct net_device *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
551 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
552 int (*phys_id)(struct net_device *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 void (*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
554 int (*begin)(struct net_device *);
555 void (*complete)(struct net_device *);
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700556 u32 (*get_ufo)(struct net_device *);
557 int (*set_ufo)(struct net_device *, u32);
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700558 u32 (*get_flags)(struct net_device *);
559 int (*set_flags)(struct net_device *, u32);
Jeff Garzik339bf022007-08-15 16:01:32 -0700560 u32 (*get_priv_flags)(struct net_device *);
561 int (*set_priv_flags)(struct net_device *, u32);
Jeff Garzikff03d492007-08-15 16:01:08 -0700562 int (*get_sset_count)(struct net_device *, int);
Santwona Behera59089d82009-02-20 00:58:13 -0800563 int (*get_rxnfc)(struct net_device *, struct ethtool_rxnfc *, void *);
564 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
Ajit Khaparde05c6a8d2009-09-02 17:02:55 +0000565 int (*flash_device)(struct net_device *, struct ethtool_flash *);
Ben Hutchingsd73d3a82009-10-05 10:59:58 +0000566 int (*reset)(struct net_device *, u32 *);
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800567 int (*set_rx_ntuple)(struct net_device *, struct ethtool_rx_ntuple *);
568 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569};
David Woodhousec3ce7e22006-04-29 01:53:47 +0100570#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
572/* CMDs currently supported */
573#define ETHTOOL_GSET 0x00000001 /* Get settings. */
574#define ETHTOOL_SSET 0x00000002 /* Set settings. */
575#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
576#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
577#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
578#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
579#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
580#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
581#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
582#define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
583#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
584#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
585#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
586#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
587#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
588#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
589#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
590#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
591#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
592#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
593#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
594#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
595#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
596 * (ethtool_value) */
597#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
598 * (ethtool_value). */
599#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
600#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
601#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
602#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
603#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
604#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
Jon Wetzela6f9a702005-08-20 17:15:54 -0700605#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700606#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
607#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
Herbert Xu37c31852006-06-22 03:07:29 -0700608#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
609#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
Jeff Garzik3ae7c0b2007-08-15 16:00:51 -0700610#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
611#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
Jeff Garzik339bf022007-08-15 16:01:32 -0700612#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
613#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Santwona Behera0853ad62008-07-02 03:47:41 -0700615#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
616#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
Herbert Xub240a0e2008-12-15 23:44:31 -0800617#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
618#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
Santwona Behera59089d82009-02-20 00:58:13 -0800619#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
620#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
621#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
622#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
623#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
624#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
Ajit Khaparde05c6a8d2009-09-02 17:02:55 +0000625#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
Ben Hutchingsd73d3a82009-10-05 10:59:58 +0000626#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
Jeff Garzik723b2f52010-03-03 22:51:50 +0000627#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
628#define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */
629#define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
Peter P Waskiewicz Jr15682bc2010-02-10 20:03:05 -0800630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631/* compatibility with older code */
632#define SPARC_ETH_GSET ETHTOOL_GSET
633#define SPARC_ETH_SSET ETHTOOL_SSET
634
635/* Indicates what features are supported by the interface. */
636#define SUPPORTED_10baseT_Half (1 << 0)
637#define SUPPORTED_10baseT_Full (1 << 1)
638#define SUPPORTED_100baseT_Half (1 << 2)
639#define SUPPORTED_100baseT_Full (1 << 3)
640#define SUPPORTED_1000baseT_Half (1 << 4)
641#define SUPPORTED_1000baseT_Full (1 << 5)
642#define SUPPORTED_Autoneg (1 << 6)
643#define SUPPORTED_TP (1 << 7)
644#define SUPPORTED_AUI (1 << 8)
645#define SUPPORTED_MII (1 << 9)
646#define SUPPORTED_FIBRE (1 << 10)
647#define SUPPORTED_BNC (1 << 11)
648#define SUPPORTED_10000baseT_Full (1 << 12)
Andy Fleming00db8182005-07-30 19:31:23 -0400649#define SUPPORTED_Pause (1 << 13)
650#define SUPPORTED_Asym_Pause (1 << 14)
Michael Chan427c2192007-05-03 13:17:25 -0700651#define SUPPORTED_2500baseX_Full (1 << 15)
Ben Hutchings894b19a2009-04-29 08:25:57 +0000652#define SUPPORTED_Backplane (1 << 16)
653#define SUPPORTED_1000baseKX_Full (1 << 17)
654#define SUPPORTED_10000baseKX4_Full (1 << 18)
655#define SUPPORTED_10000baseKR_Full (1 << 19)
656#define SUPPORTED_10000baseR_FEC (1 << 20)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
658/* Indicates what features are advertised by the interface. */
659#define ADVERTISED_10baseT_Half (1 << 0)
660#define ADVERTISED_10baseT_Full (1 << 1)
661#define ADVERTISED_100baseT_Half (1 << 2)
662#define ADVERTISED_100baseT_Full (1 << 3)
663#define ADVERTISED_1000baseT_Half (1 << 4)
664#define ADVERTISED_1000baseT_Full (1 << 5)
665#define ADVERTISED_Autoneg (1 << 6)
666#define ADVERTISED_TP (1 << 7)
667#define ADVERTISED_AUI (1 << 8)
668#define ADVERTISED_MII (1 << 9)
669#define ADVERTISED_FIBRE (1 << 10)
670#define ADVERTISED_BNC (1 << 11)
671#define ADVERTISED_10000baseT_Full (1 << 12)
Andy Fleming00db8182005-07-30 19:31:23 -0400672#define ADVERTISED_Pause (1 << 13)
673#define ADVERTISED_Asym_Pause (1 << 14)
Michael Chan427c2192007-05-03 13:17:25 -0700674#define ADVERTISED_2500baseX_Full (1 << 15)
Ben Hutchings894b19a2009-04-29 08:25:57 +0000675#define ADVERTISED_Backplane (1 << 16)
676#define ADVERTISED_1000baseKX_Full (1 << 17)
677#define ADVERTISED_10000baseKX4_Full (1 << 18)
678#define ADVERTISED_10000baseKR_Full (1 << 19)
679#define ADVERTISED_10000baseR_FEC (1 << 20)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
681/* The following are all involved in forcing a particular link
682 * mode for the device for setting things. When getting the
683 * devices settings, these indicate the current mode and whether
684 * it was foced up into this mode or autonegotiated.
685 */
686
Michael Chan5b0c76a2005-11-04 08:45:49 -0800687/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688#define SPEED_10 10
689#define SPEED_100 100
690#define SPEED_1000 1000
Michael Chan5b0c76a2005-11-04 08:45:49 -0800691#define SPEED_2500 2500
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692#define SPEED_10000 10000
693
694/* Duplex, half or full. */
695#define DUPLEX_HALF 0x00
696#define DUPLEX_FULL 0x01
697
698/* Which connector port. */
699#define PORT_TP 0x00
700#define PORT_AUI 0x01
701#define PORT_MII 0x02
702#define PORT_FIBRE 0x03
703#define PORT_BNC 0x04
PJ Waskiewicz5789d292009-11-25 00:11:30 +0000704#define PORT_DA 0x05
705#define PORT_NONE 0xef
Ben Hutchings0821c712009-04-29 08:02:59 +0000706#define PORT_OTHER 0xff
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708/* Which transceiver to use. */
709#define XCVR_INTERNAL 0x00
710#define XCVR_EXTERNAL 0x01
711#define XCVR_DUMMY1 0x02
712#define XCVR_DUMMY2 0x03
713#define XCVR_DUMMY3 0x04
714
715/* Enable or disable autonegotiation. If this is set to enable,
716 * the forced link modes above are completely ignored.
717 */
718#define AUTONEG_DISABLE 0x00
719#define AUTONEG_ENABLE 0x01
720
Chaitanya Lala18760f12009-06-08 14:28:54 +0000721/* Mode MDI or MDI-X */
722#define ETH_TP_MDI_INVALID 0x00
723#define ETH_TP_MDI 0x01
724#define ETH_TP_MDI_X 0x02
725
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726/* Wake-On-Lan options. */
727#define WAKE_PHY (1 << 0)
728#define WAKE_UCAST (1 << 1)
729#define WAKE_MCAST (1 << 2)
730#define WAKE_BCAST (1 << 3)
731#define WAKE_ARP (1 << 4)
732#define WAKE_MAGIC (1 << 5)
733#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
734
Santwona Behera0853ad62008-07-02 03:47:41 -0700735/* L3-L4 network traffic flow types */
736#define TCP_V4_FLOW 0x01
737#define UDP_V4_FLOW 0x02
738#define SCTP_V4_FLOW 0x03
739#define AH_ESP_V4_FLOW 0x04
740#define TCP_V6_FLOW 0x05
741#define UDP_V6_FLOW 0x06
742#define SCTP_V6_FLOW 0x07
743#define AH_ESP_V6_FLOW 0x08
Santwona Behera59089d82009-02-20 00:58:13 -0800744#define AH_V4_FLOW 0x09
745#define ESP_V4_FLOW 0x0a
746#define AH_V6_FLOW 0x0b
747#define ESP_V6_FLOW 0x0c
748#define IP_USER_FLOW 0x0d
Sandeep Gopalpet7a8b3372009-11-02 07:03:40 +0000749#define IPV4_FLOW 0x10
750#define IPV6_FLOW 0x11
Santwona Behera0853ad62008-07-02 03:47:41 -0700751
752/* L3-L4 network traffic flow hash options */
Santwona Behera0853ad62008-07-02 03:47:41 -0700753#define RXH_L2DA (1 << 1)
754#define RXH_VLAN (1 << 2)
755#define RXH_L3_PROTO (1 << 3)
756#define RXH_IP_SRC (1 << 4)
757#define RXH_IP_DST (1 << 5)
758#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
759#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
760#define RXH_DISCARD (1 << 31)
761
Santwona Behera59089d82009-02-20 00:58:13 -0800762#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
Santwona Behera0853ad62008-07-02 03:47:41 -0700763
Ben Hutchingsd73d3a82009-10-05 10:59:58 +0000764/* Reset flags */
765/* The reset() operation must clear the flags for the components which
766 * were actually reset. On successful return, the flags indicate the
767 * components which were not reset, either because they do not exist
768 * in the hardware or because they cannot be reset independently. The
769 * driver must never reset any components that were not requested.
770 */
771enum ethtool_reset_flags {
772 /* These flags represent components dedicated to the interface
773 * the command is addressed to. Shift any flag left by
774 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
775 * same type.
776 */
777 ETH_RESET_MGMT = 1 << 0, /* Management processor */
778 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
779 ETH_RESET_DMA = 1 << 2, /* DMA engine */
780 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
781 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
782 ETH_RESET_MAC = 1 << 5, /* Media access controller */
783 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
784 ETH_RESET_RAM = 1 << 7, /* RAM shared between
785 * multiple components */
786
787 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
788 * this interface */
789 ETH_RESET_ALL = 0xffffffff, /* All components used by this
790 * interface, even if shared */
791};
792#define ETH_RESET_SHARED_SHIFT 16
793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794#endif /* _LINUX_ETHTOOL_H */