]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/ethtool.h
net: Fix first line of kernel-doc for a few functions
[mirror_ubuntu-artful-kernel.git] / include / linux / ethtool.h
CommitLineData
1da177e4
LT
1/*
2 * ethtool.h: Defines for Linux ethtool.
3 *
4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
8 * christopher.leech@intel.com,
9 * scott.feldman@intel.com)
59089d8d 10 * Portions Copyright (C) Sun Microsystems 2008
1da177e4
LT
11 */
12
13#ifndef _LINUX_ETHTOOL_H
14#define _LINUX_ETHTOOL_H
15
e621e691 16#include <linux/types.h>
15682bc4 17#include <linux/rculist.h>
1da177e4
LT
18
19/* This should work for both 32 and 64 bit userland. */
20struct ethtool_cmd {
c3ce7e20
DW
21 __u32 cmd;
22 __u32 supported; /* Features this interface supports */
23 __u32 advertising; /* Features this interface advertises */
24 __u16 speed; /* The forced speed, 10Mb, 100Mb, gigabit */
25 __u8 duplex; /* Duplex, half or full */
26 __u8 port; /* Which connector port */
27 __u8 phy_address;
28 __u8 transceiver; /* Which transceiver to use */
29 __u8 autoneg; /* Enable or disable autonegotiation */
0c09c1a4 30 __u8 mdio_support;
c3ce7e20
DW
31 __u32 maxtxpkt; /* Tx pkts before generating tx int */
32 __u32 maxrxpkt; /* Rx pkts before generating rx int */
b11f8d8c 33 __u16 speed_hi;
18760f1e
CL
34 __u8 eth_tp_mdix;
35 __u8 reserved2;
0c09c1a4
BH
36 __u32 lp_advertising; /* Features the link partner advertises */
37 __u32 reserved[2];
1da177e4
LT
38};
39
b11f8d8c
BP
40static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
41 __u32 speed)
42{
43
44 ep->speed = (__u16)speed;
45 ep->speed_hi = (__u16)(speed >> 16);
46}
47
48static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep)
49{
50 return (ep->speed_hi << 16) | ep->speed;
51}
52
141518c9 53#define ETHTOOL_FWVERS_LEN 32
1da177e4
LT
54#define ETHTOOL_BUSINFO_LEN 32
55/* these strings are set to whatever the driver author decides... */
56struct ethtool_drvinfo {
c3ce7e20 57 __u32 cmd;
1da177e4
LT
58 char driver[32]; /* driver short name, "tulip", "eepro100" */
59 char version[32]; /* driver version string */
141518c9 60 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
1da177e4
LT
61 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
62 /* For PCI devices, use pci_name(pci_dev). */
63 char reserved1[32];
339bf024
JG
64 char reserved2[12];
65 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */
c3ce7e20
DW
66 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
67 __u32 testinfo_len;
68 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
69 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
1da177e4
LT
70};
71
72#define SOPASS_MAX 6
73/* wake-on-lan settings */
74struct ethtool_wolinfo {
c3ce7e20
DW
75 __u32 cmd;
76 __u32 supported;
77 __u32 wolopts;
78 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
1da177e4
LT
79};
80
81/* for passing single values */
82struct ethtool_value {
c3ce7e20
DW
83 __u32 cmd;
84 __u32 data;
1da177e4
LT
85};
86
87/* for passing big chunks of data */
88struct ethtool_regs {
c3ce7e20
DW
89 __u32 cmd;
90 __u32 version; /* driver-specific, indicates different chips/revs */
91 __u32 len; /* bytes */
92 __u8 data[0];
1da177e4
LT
93};
94
95/* for passing EEPROM chunks */
96struct ethtool_eeprom {
c3ce7e20
DW
97 __u32 cmd;
98 __u32 magic;
99 __u32 offset; /* in bytes */
100 __u32 len; /* in bytes */
101 __u8 data[0];
1da177e4
LT
102};
103
104/* for configuring coalescing parameters of chip */
105struct ethtool_coalesce {
c3ce7e20 106 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */
1da177e4
LT
107
108 /* How many usecs to delay an RX interrupt after
109 * a packet arrives. If 0, only rx_max_coalesced_frames
110 * is used.
111 */
c3ce7e20 112 __u32 rx_coalesce_usecs;
1da177e4
LT
113
114 /* How many packets to delay an RX interrupt after
115 * a packet arrives. If 0, only rx_coalesce_usecs is
116 * used. It is illegal to set both usecs and max frames
117 * to zero as this would cause RX interrupts to never be
118 * generated.
119 */
c3ce7e20 120 __u32 rx_max_coalesced_frames;
1da177e4
LT
121
122 /* Same as above two parameters, except that these values
123 * apply while an IRQ is being serviced by the host. Not
124 * all cards support this feature and the values are ignored
125 * in that case.
126 */
c3ce7e20
DW
127 __u32 rx_coalesce_usecs_irq;
128 __u32 rx_max_coalesced_frames_irq;
1da177e4
LT
129
130 /* How many usecs to delay a TX interrupt after
131 * a packet is sent. If 0, only tx_max_coalesced_frames
132 * is used.
133 */
c3ce7e20 134 __u32 tx_coalesce_usecs;
1da177e4
LT
135
136 /* How many packets to delay a TX interrupt after
137 * a packet is sent. If 0, only tx_coalesce_usecs is
138 * used. It is illegal to set both usecs and max frames
139 * to zero as this would cause TX interrupts to never be
140 * generated.
141 */
c3ce7e20 142 __u32 tx_max_coalesced_frames;
1da177e4
LT
143
144 /* Same as above two parameters, except that these values
145 * apply while an IRQ is being serviced by the host. Not
146 * all cards support this feature and the values are ignored
147 * in that case.
148 */
c3ce7e20
DW
149 __u32 tx_coalesce_usecs_irq;
150 __u32 tx_max_coalesced_frames_irq;
1da177e4
LT
151
152 /* How many usecs to delay in-memory statistics
153 * block updates. Some drivers do not have an in-memory
154 * statistic block, and in such cases this value is ignored.
155 * This value must not be zero.
156 */
c3ce7e20 157 __u32 stats_block_coalesce_usecs;
1da177e4
LT
158
159 /* Adaptive RX/TX coalescing is an algorithm implemented by
160 * some drivers to improve latency under low packet rates and
161 * improve throughput under high packet rates. Some drivers
162 * only implement one of RX or TX adaptive coalescing. Anything
163 * not implemented by the driver causes these values to be
164 * silently ignored.
165 */
c3ce7e20
DW
166 __u32 use_adaptive_rx_coalesce;
167 __u32 use_adaptive_tx_coalesce;
1da177e4
LT
168
169 /* When the packet rate (measured in packets per second)
170 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
171 * used.
172 */
c3ce7e20
DW
173 __u32 pkt_rate_low;
174 __u32 rx_coalesce_usecs_low;
175 __u32 rx_max_coalesced_frames_low;
176 __u32 tx_coalesce_usecs_low;
177 __u32 tx_max_coalesced_frames_low;
1da177e4
LT
178
179 /* When the packet rate is below pkt_rate_high but above
180 * pkt_rate_low (both measured in packets per second) the
181 * normal {rx,tx}_* coalescing parameters are used.
182 */
183
184 /* When the packet rate is (measured in packets per second)
185 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
186 * used.
187 */
c3ce7e20
DW
188 __u32 pkt_rate_high;
189 __u32 rx_coalesce_usecs_high;
190 __u32 rx_max_coalesced_frames_high;
191 __u32 tx_coalesce_usecs_high;
192 __u32 tx_max_coalesced_frames_high;
1da177e4
LT
193
194 /* How often to do adaptive coalescing packet rate sampling,
195 * measured in seconds. Must not be zero.
196 */
c3ce7e20 197 __u32 rate_sample_interval;
1da177e4
LT
198};
199
200/* for configuring RX/TX ring parameters */
201struct ethtool_ringparam {
c3ce7e20 202 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
1da177e4
LT
203
204 /* Read only attributes. These indicate the maximum number
205 * of pending RX/TX ring entries the driver will allow the
206 * user to set.
207 */
c3ce7e20
DW
208 __u32 rx_max_pending;
209 __u32 rx_mini_max_pending;
210 __u32 rx_jumbo_max_pending;
211 __u32 tx_max_pending;
1da177e4
LT
212
213 /* Values changeable by the user. The valid values are
214 * in the range 1 to the "*_max_pending" counterpart above.
215 */
c3ce7e20
DW
216 __u32 rx_pending;
217 __u32 rx_mini_pending;
218 __u32 rx_jumbo_pending;
219 __u32 tx_pending;
1da177e4
LT
220};
221
222/* for configuring link flow control parameters */
223struct ethtool_pauseparam {
c3ce7e20 224 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
1da177e4
LT
225
226 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
227 * being true) the user may set 'autonet' here non-zero to have the
228 * pause parameters be auto-negotiated too. In such a case, the
229 * {rx,tx}_pause values below determine what capabilities are
230 * advertised.
231 *
232 * If 'autoneg' is zero or the link is not being auto-negotiated,
233 * then {rx,tx}_pause force the driver to use/not-use pause
234 * flow control.
235 */
c3ce7e20
DW
236 __u32 autoneg;
237 __u32 rx_pause;
238 __u32 tx_pause;
1da177e4
LT
239};
240
241#define ETH_GSTRING_LEN 32
242enum ethtool_stringset {
243 ETH_SS_TEST = 0,
244 ETH_SS_STATS,
339bf024 245 ETH_SS_PRIV_FLAGS,
15682bc4 246 ETH_SS_NTUPLE_FILTERS,
1da177e4
LT
247};
248
249/* for passing string sets for data tagging */
250struct ethtool_gstrings {
c3ce7e20
DW
251 __u32 cmd; /* ETHTOOL_GSTRINGS */
252 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
253 __u32 len; /* number of strings in the string set */
254 __u8 data[0];
1da177e4
LT
255};
256
257enum ethtool_test_flags {
258 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
259 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
260};
261
262/* for requesting NIC test and getting results*/
263struct ethtool_test {
c3ce7e20
DW
264 __u32 cmd; /* ETHTOOL_TEST */
265 __u32 flags; /* ETH_TEST_FL_xxx */
266 __u32 reserved;
267 __u32 len; /* result length, in number of u64 elements */
268 __u64 data[0];
1da177e4
LT
269};
270
271/* for dumping NIC-specific statistics */
272struct ethtool_stats {
c3ce7e20
DW
273 __u32 cmd; /* ETHTOOL_GSTATS */
274 __u32 n_stats; /* number of u64's being returned */
275 __u64 data[0];
1da177e4
LT
276};
277
a6f9a705 278struct ethtool_perm_addr {
c3ce7e20
DW
279 __u32 cmd; /* ETHTOOL_GPERMADDR */
280 __u32 size;
281 __u8 data[0];
a6f9a705
JW
282};
283
3ae7c0b2
JG
284/* boolean flags controlling per-interface behavior characteristics.
285 * When reading, the flag indicates whether or not a certain behavior
286 * is enabled/present. When writing, the flag indicates whether
287 * or not the driver should turn on (set) or off (clear) a behavior.
288 *
289 * Some behaviors may read-only (unconditionally absent or present).
290 * If such is the case, return EINVAL in the set-flags operation if the
291 * flag differs from the read-only value.
292 */
293enum ethtool_flags {
294 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
15682bc4 295 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
3ae7c0b2
JG
296};
297
59089d8d
SB
298/* The following structures are for supporting RX network flow
299 * classification configuration. Note, all multibyte fields, e.g.,
300 * ip4src, ip4dst, psrc, pdst, spi, etc. are expected to be in network
301 * byte order.
302 */
303struct ethtool_tcpip4_spec {
304 __be32 ip4src;
305 __be32 ip4dst;
306 __be16 psrc;
307 __be16 pdst;
308 __u8 tos;
309};
310
311struct ethtool_ah_espip4_spec {
312 __be32 ip4src;
313 __be32 ip4dst;
314 __be32 spi;
315 __u8 tos;
316};
317
318struct ethtool_rawip4_spec {
319 __be32 ip4src;
320 __be32 ip4dst;
321 __u8 hdata[64];
322};
323
324struct ethtool_ether_spec {
325 __be16 ether_type;
326 __u8 frame_size;
327 __u8 eframe[16];
328};
329
330#define ETH_RX_NFC_IP4 1
331#define ETH_RX_NFC_IP6 2
332
333struct ethtool_usrip4_spec {
334 __be32 ip4src;
335 __be32 ip4dst;
336 __be32 l4_4_bytes;
337 __u8 tos;
338 __u8 ip_ver;
339 __u8 proto;
340};
341
342struct ethtool_rx_flow_spec {
0853ad66 343 __u32 flow_type;
59089d8d
SB
344 union {
345 struct ethtool_tcpip4_spec tcp_ip4_spec;
346 struct ethtool_tcpip4_spec udp_ip4_spec;
347 struct ethtool_tcpip4_spec sctp_ip4_spec;
348 struct ethtool_ah_espip4_spec ah_ip4_spec;
349 struct ethtool_ah_espip4_spec esp_ip4_spec;
350 struct ethtool_rawip4_spec raw_ip4_spec;
351 struct ethtool_ether_spec ether_spec;
352 struct ethtool_usrip4_spec usr_ip4_spec;
353 __u8 hdata[64];
354 } h_u, m_u; /* entry, mask */
355 __u64 ring_cookie;
356 __u32 location;
357};
358
359struct ethtool_rxnfc {
360 __u32 cmd;
361 __u32 flow_type;
362 /* The rx flow hash value or the rule DB size */
363 __u64 data;
364 struct ethtool_rx_flow_spec fs;
365 __u32 rule_cnt;
366 __u32 rule_locs[0];
0853ad66
SB
367};
368
15682bc4
PWJ
369struct ethtool_rx_ntuple_flow_spec {
370 __u32 flow_type;
371 union {
372 struct ethtool_tcpip4_spec tcp_ip4_spec;
373 struct ethtool_tcpip4_spec udp_ip4_spec;
374 struct ethtool_tcpip4_spec sctp_ip4_spec;
375 struct ethtool_ah_espip4_spec ah_ip4_spec;
376 struct ethtool_ah_espip4_spec esp_ip4_spec;
377 struct ethtool_rawip4_spec raw_ip4_spec;
378 struct ethtool_ether_spec ether_spec;
379 struct ethtool_usrip4_spec usr_ip4_spec;
380 __u8 hdata[64];
381 } h_u, m_u; /* entry, mask */
382
383 __u16 vlan_tag;
384 __u16 vlan_tag_mask;
385 __u64 data; /* user-defined flow spec data */
386 __u64 data_mask; /* user-defined flow spec mask */
387
388 /* signed to distinguish between queue and actions (DROP) */
389 __s32 action;
390#define ETHTOOL_RXNTUPLE_ACTION_DROP -1
391};
392
393struct ethtool_rx_ntuple {
394 __u32 cmd;
395 struct ethtool_rx_ntuple_flow_spec fs;
396};
397
05c6a8d7
AK
398#define ETHTOOL_FLASH_MAX_FILENAME 128
399enum ethtool_flash_op_type {
400 ETHTOOL_FLASH_ALL_REGIONS = 0,
401};
402
403/* for passing firmware flashing related parameters */
404struct ethtool_flash {
405 __u32 cmd;
406 __u32 region;
407 char data[ETHTOOL_FLASH_MAX_FILENAME];
408};
409
c3ce7e20
DW
410#ifdef __KERNEL__
411
15682bc4
PWJ
412struct ethtool_rx_ntuple_flow_spec_container {
413 struct ethtool_rx_ntuple_flow_spec fs;
414 struct list_head list;
415};
416
417struct ethtool_rx_ntuple_list {
418#define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
419#define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
420 struct list_head list;
421 unsigned int count;
422};
423
1da177e4
LT
424struct net_device;
425
426/* Some generic methods drivers may use in their ethtool_ops */
427u32 ethtool_op_get_link(struct net_device *dev);
8a729fce 428u32 ethtool_op_get_rx_csum(struct net_device *dev);
1da177e4
LT
429u32 ethtool_op_get_tx_csum(struct net_device *dev);
430int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
69f6a0fa 431int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
6460d948 432int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
1da177e4
LT
433u32 ethtool_op_get_sg(struct net_device *dev);
434int ethtool_op_set_sg(struct net_device *dev, u32 data);
435u32 ethtool_op_get_tso(struct net_device *dev);
436int ethtool_op_set_tso(struct net_device *dev, u32 data);
e89e9cf5
AR
437u32 ethtool_op_get_ufo(struct net_device *dev);
438int ethtool_op_set_ufo(struct net_device *dev, u32 data);
3ae7c0b2
JG
439u32 ethtool_op_get_flags(struct net_device *dev);
440int ethtool_op_set_flags(struct net_device *dev, u32 data);
15682bc4 441void ethtool_ntuple_flush(struct net_device *dev);
1da177e4
LT
442
443/**
444 * &ethtool_ops - Alter and report network device settings
445 * get_settings: Get device-specific settings
446 * set_settings: Set device-specific settings
447 * get_drvinfo: Report driver information
448 * get_regs: Get device registers
449 * get_wol: Report whether Wake-on-Lan is enabled
450 * set_wol: Turn Wake-on-Lan on or off
451 * get_msglevel: Report driver message level
452 * set_msglevel: Set driver message level
453 * nway_reset: Restart autonegotiation
454 * get_link: Get link status
455 * get_eeprom: Read data from the device EEPROM
456 * set_eeprom: Write data to the device EEPROM
457 * get_coalesce: Get interrupt coalescing parameters
458 * set_coalesce: Set interrupt coalescing parameters
459 * get_ringparam: Report ring sizes
460 * set_ringparam: Set ring sizes
461 * get_pauseparam: Report pause parameters
fd3f8984 462 * set_pauseparam: Set pause parameters
1da177e4
LT
463 * get_rx_csum: Report whether receive checksums are turned on or off
464 * set_rx_csum: Turn receive checksum on or off
465 * get_tx_csum: Report whether transmit checksums are turned on or off
466 * set_tx_csum: Turn transmit checksums on or off
467 * get_sg: Report whether scatter-gather is enabled
468 * set_sg: Turn scatter-gather on or off
469 * get_tso: Report whether TCP segmentation offload is enabled
470 * set_tso: Turn TCP segmentation offload on or off
e89e9cf5
AR
471 * get_ufo: Report whether UDP fragmentation offload is enabled
472 * set_ufo: Turn UDP fragmentation offload on or off
1da177e4
LT
473 * self_test: Run specified self-tests
474 * get_strings: Return a set of strings that describe the requested objects
475 * phys_id: Identify the device
476 * get_stats: Return statistics about the device
3ae7c0b2
JG
477 * get_flags: get 32-bit flags bitmap
478 * set_flags: set 32-bit flags bitmap
a6f9a705 479 *
1da177e4
LT
480 * Description:
481 *
482 * get_settings:
483 * @get_settings is passed an &ethtool_cmd to fill in. It returns
484 * an negative errno or zero.
485 *
486 * set_settings:
487 * @set_settings is passed an &ethtool_cmd and should attempt to set
488 * all the settings this device supports. It may return an error value
489 * if something goes wrong (otherwise 0).
490 *
491 * get_eeprom:
492 * Should fill in the magic field. Don't need to check len for zero
493 * or wraparound. Fill in the data argument with the eeprom values
494 * from offset to offset + len. Update len to the amount read.
495 * Returns an error or zero.
496 *
497 * set_eeprom:
498 * Should validate the magic field. Don't need to check len for zero
499 * or wraparound. Update len to the amount written. Returns an error
500 * or zero.
501 */
502struct ethtool_ops {
503 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
504 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
505 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
506 int (*get_regs_len)(struct net_device *);
507 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
508 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
509 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
510 u32 (*get_msglevel)(struct net_device *);
511 void (*set_msglevel)(struct net_device *, u32);
512 int (*nway_reset)(struct net_device *);
513 u32 (*get_link)(struct net_device *);
514 int (*get_eeprom_len)(struct net_device *);
515 int (*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
516 int (*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
517 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
518 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
519 void (*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
520 int (*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
521 void (*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
522 int (*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
523 u32 (*get_rx_csum)(struct net_device *);
524 int (*set_rx_csum)(struct net_device *, u32);
525 u32 (*get_tx_csum)(struct net_device *);
526 int (*set_tx_csum)(struct net_device *, u32);
527 u32 (*get_sg)(struct net_device *);
528 int (*set_sg)(struct net_device *, u32);
529 u32 (*get_tso)(struct net_device *);
530 int (*set_tso)(struct net_device *, u32);
1da177e4
LT
531 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
532 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
533 int (*phys_id)(struct net_device *, u32);
1da177e4
LT
534 void (*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
535 int (*begin)(struct net_device *);
536 void (*complete)(struct net_device *);
e89e9cf5
AR
537 u32 (*get_ufo)(struct net_device *);
538 int (*set_ufo)(struct net_device *, u32);
3ae7c0b2
JG
539 u32 (*get_flags)(struct net_device *);
540 int (*set_flags)(struct net_device *, u32);
339bf024
JG
541 u32 (*get_priv_flags)(struct net_device *);
542 int (*set_priv_flags)(struct net_device *, u32);
ff03d49f 543 int (*get_sset_count)(struct net_device *, int);
59089d8d
SB
544 int (*get_rxnfc)(struct net_device *, struct ethtool_rxnfc *, void *);
545 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
05c6a8d7 546 int (*flash_device)(struct net_device *, struct ethtool_flash *);
d73d3a8c 547 int (*reset)(struct net_device *, u32 *);
15682bc4
PWJ
548 int (*set_rx_ntuple)(struct net_device *, struct ethtool_rx_ntuple *);
549 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
1da177e4 550};
c3ce7e20 551#endif /* __KERNEL__ */
1da177e4
LT
552
553/* CMDs currently supported */
554#define ETHTOOL_GSET 0x00000001 /* Get settings. */
555#define ETHTOOL_SSET 0x00000002 /* Set settings. */
556#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
557#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
558#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
559#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
560#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
561#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
562#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
563#define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
564#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
565#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
566#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
567#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
568#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
569#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
570#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
571#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
572#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
573#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
574#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
575#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
576#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
577 * (ethtool_value) */
578#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
579 * (ethtool_value). */
580#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
581#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
582#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
583#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
584#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
585#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
a6f9a705 586#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
e89e9cf5
AR
587#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
588#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
37c3185a
HX
589#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
590#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
3ae7c0b2
JG
591#define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
592#define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
339bf024
JG
593#define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
594#define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
1da177e4 595
0853ad66
SB
596#define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
597#define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
b240a0e5
HX
598#define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
599#define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
59089d8d
SB
600#define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
601#define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
602#define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
603#define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
604#define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
605#define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
05c6a8d7 606#define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
d73d3a8c 607#define ETHTOOL_RESET 0x00000034 /* Reset hardware */
0853ad66 608
15682bc4
PWJ
609#define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
610#define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */
611
1da177e4
LT
612/* compatibility with older code */
613#define SPARC_ETH_GSET ETHTOOL_GSET
614#define SPARC_ETH_SSET ETHTOOL_SSET
615
616/* Indicates what features are supported by the interface. */
617#define SUPPORTED_10baseT_Half (1 << 0)
618#define SUPPORTED_10baseT_Full (1 << 1)
619#define SUPPORTED_100baseT_Half (1 << 2)
620#define SUPPORTED_100baseT_Full (1 << 3)
621#define SUPPORTED_1000baseT_Half (1 << 4)
622#define SUPPORTED_1000baseT_Full (1 << 5)
623#define SUPPORTED_Autoneg (1 << 6)
624#define SUPPORTED_TP (1 << 7)
625#define SUPPORTED_AUI (1 << 8)
626#define SUPPORTED_MII (1 << 9)
627#define SUPPORTED_FIBRE (1 << 10)
628#define SUPPORTED_BNC (1 << 11)
629#define SUPPORTED_10000baseT_Full (1 << 12)
00db8189
AF
630#define SUPPORTED_Pause (1 << 13)
631#define SUPPORTED_Asym_Pause (1 << 14)
427c2196 632#define SUPPORTED_2500baseX_Full (1 << 15)
894b19a6
BH
633#define SUPPORTED_Backplane (1 << 16)
634#define SUPPORTED_1000baseKX_Full (1 << 17)
635#define SUPPORTED_10000baseKX4_Full (1 << 18)
636#define SUPPORTED_10000baseKR_Full (1 << 19)
637#define SUPPORTED_10000baseR_FEC (1 << 20)
1da177e4
LT
638
639/* Indicates what features are advertised by the interface. */
640#define ADVERTISED_10baseT_Half (1 << 0)
641#define ADVERTISED_10baseT_Full (1 << 1)
642#define ADVERTISED_100baseT_Half (1 << 2)
643#define ADVERTISED_100baseT_Full (1 << 3)
644#define ADVERTISED_1000baseT_Half (1 << 4)
645#define ADVERTISED_1000baseT_Full (1 << 5)
646#define ADVERTISED_Autoneg (1 << 6)
647#define ADVERTISED_TP (1 << 7)
648#define ADVERTISED_AUI (1 << 8)
649#define ADVERTISED_MII (1 << 9)
650#define ADVERTISED_FIBRE (1 << 10)
651#define ADVERTISED_BNC (1 << 11)
652#define ADVERTISED_10000baseT_Full (1 << 12)
00db8189
AF
653#define ADVERTISED_Pause (1 << 13)
654#define ADVERTISED_Asym_Pause (1 << 14)
427c2196 655#define ADVERTISED_2500baseX_Full (1 << 15)
894b19a6
BH
656#define ADVERTISED_Backplane (1 << 16)
657#define ADVERTISED_1000baseKX_Full (1 << 17)
658#define ADVERTISED_10000baseKX4_Full (1 << 18)
659#define ADVERTISED_10000baseKR_Full (1 << 19)
660#define ADVERTISED_10000baseR_FEC (1 << 20)
1da177e4
LT
661
662/* The following are all involved in forcing a particular link
663 * mode for the device for setting things. When getting the
664 * devices settings, these indicate the current mode and whether
665 * it was foced up into this mode or autonegotiated.
666 */
667
5b0c76ad 668/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1da177e4
LT
669#define SPEED_10 10
670#define SPEED_100 100
671#define SPEED_1000 1000
5b0c76ad 672#define SPEED_2500 2500
1da177e4
LT
673#define SPEED_10000 10000
674
675/* Duplex, half or full. */
676#define DUPLEX_HALF 0x00
677#define DUPLEX_FULL 0x01
678
679/* Which connector port. */
680#define PORT_TP 0x00
681#define PORT_AUI 0x01
682#define PORT_MII 0x02
683#define PORT_FIBRE 0x03
684#define PORT_BNC 0x04
5789d290
PW
685#define PORT_DA 0x05
686#define PORT_NONE 0xef
0821c717 687#define PORT_OTHER 0xff
1da177e4
LT
688
689/* Which transceiver to use. */
690#define XCVR_INTERNAL 0x00
691#define XCVR_EXTERNAL 0x01
692#define XCVR_DUMMY1 0x02
693#define XCVR_DUMMY2 0x03
694#define XCVR_DUMMY3 0x04
695
696/* Enable or disable autonegotiation. If this is set to enable,
697 * the forced link modes above are completely ignored.
698 */
699#define AUTONEG_DISABLE 0x00
700#define AUTONEG_ENABLE 0x01
701
18760f1e
CL
702/* Mode MDI or MDI-X */
703#define ETH_TP_MDI_INVALID 0x00
704#define ETH_TP_MDI 0x01
705#define ETH_TP_MDI_X 0x02
706
1da177e4
LT
707/* Wake-On-Lan options. */
708#define WAKE_PHY (1 << 0)
709#define WAKE_UCAST (1 << 1)
710#define WAKE_MCAST (1 << 2)
711#define WAKE_BCAST (1 << 3)
712#define WAKE_ARP (1 << 4)
713#define WAKE_MAGIC (1 << 5)
714#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
715
0853ad66
SB
716/* L3-L4 network traffic flow types */
717#define TCP_V4_FLOW 0x01
718#define UDP_V4_FLOW 0x02
719#define SCTP_V4_FLOW 0x03
720#define AH_ESP_V4_FLOW 0x04
721#define TCP_V6_FLOW 0x05
722#define UDP_V6_FLOW 0x06
723#define SCTP_V6_FLOW 0x07
724#define AH_ESP_V6_FLOW 0x08
59089d8d
SB
725#define AH_V4_FLOW 0x09
726#define ESP_V4_FLOW 0x0a
727#define AH_V6_FLOW 0x0b
728#define ESP_V6_FLOW 0x0c
729#define IP_USER_FLOW 0x0d
7a8b3372
SG
730#define IPV4_FLOW 0x10
731#define IPV6_FLOW 0x11
0853ad66
SB
732
733/* L3-L4 network traffic flow hash options */
0853ad66
SB
734#define RXH_L2DA (1 << 1)
735#define RXH_VLAN (1 << 2)
736#define RXH_L3_PROTO (1 << 3)
737#define RXH_IP_SRC (1 << 4)
738#define RXH_IP_DST (1 << 5)
739#define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
740#define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
741#define RXH_DISCARD (1 << 31)
742
59089d8d 743#define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
0853ad66 744
d73d3a8c
BH
745/* Reset flags */
746/* The reset() operation must clear the flags for the components which
747 * were actually reset. On successful return, the flags indicate the
748 * components which were not reset, either because they do not exist
749 * in the hardware or because they cannot be reset independently. The
750 * driver must never reset any components that were not requested.
751 */
752enum ethtool_reset_flags {
753 /* These flags represent components dedicated to the interface
754 * the command is addressed to. Shift any flag left by
755 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
756 * same type.
757 */
758 ETH_RESET_MGMT = 1 << 0, /* Management processor */
759 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
760 ETH_RESET_DMA = 1 << 2, /* DMA engine */
761 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
762 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
763 ETH_RESET_MAC = 1 << 5, /* Media access controller */
764 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
765 ETH_RESET_RAM = 1 << 7, /* RAM shared between
766 * multiple components */
767
768 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
769 * this interface */
770 ETH_RESET_ALL = 0xffffffff, /* All components used by this
771 * interface, even if shared */
772};
773#define ETH_RESET_SHARED_SHIFT 16
774
1da177e4 775#endif /* _LINUX_ETHTOOL_H */