net: Implement SFEATURES compatibility for not updated drivers
[pandora-kernel.git] / include / linux / ethtool.h
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)
10  * Portions Copyright (C) Sun Microsystems 2008
11  */
12
13 #ifndef _LINUX_ETHTOOL_H
14 #define _LINUX_ETHTOOL_H
15
16 #include <linux/types.h>
17 #include <linux/if_ether.h>
18
19 /* This should work for both 32 and 64 bit userland. */
20 struct ethtool_cmd {
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 */
30         __u8    mdio_support;
31         __u32   maxtxpkt;       /* Tx pkts before generating tx int */
32         __u32   maxrxpkt;       /* Rx pkts before generating rx int */
33         __u16   speed_hi;
34         __u8    eth_tp_mdix;
35         __u8    reserved2;
36         __u32   lp_advertising; /* Features the link partner advertises */
37         __u32   reserved[2];
38 };
39
40 static 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
48 static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep)
49 {
50         return (ep->speed_hi << 16) | ep->speed;
51 }
52
53 #define ETHTOOL_FWVERS_LEN      32
54 #define ETHTOOL_BUSINFO_LEN     32
55 /* these strings are set to whatever the driver author decides... */
56 struct ethtool_drvinfo {
57         __u32   cmd;
58         char    driver[32];     /* driver short name, "tulip", "eepro100" */
59         char    version[32];    /* driver version string */
60         char    fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
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];
64         char    reserved2[12];
65                                 /*
66                                  * Some struct members below are filled in
67                                  * using ops->get_sset_count().  Obtaining
68                                  * this info from ethtool_drvinfo is now
69                                  * deprecated; Use ETHTOOL_GSSET_INFO
70                                  * instead.
71                                  */
72         __u32   n_priv_flags;   /* number of flags valid in ETHTOOL_GPFLAGS */
73         __u32   n_stats;        /* number of u64's from ETHTOOL_GSTATS */
74         __u32   testinfo_len;
75         __u32   eedump_len;     /* Size of data from ETHTOOL_GEEPROM (bytes) */
76         __u32   regdump_len;    /* Size of data from ETHTOOL_GREGS (bytes) */
77 };
78
79 #define SOPASS_MAX      6
80 /* wake-on-lan settings */
81 struct ethtool_wolinfo {
82         __u32   cmd;
83         __u32   supported;
84         __u32   wolopts;
85         __u8    sopass[SOPASS_MAX]; /* SecureOn(tm) password */
86 };
87
88 /* for passing single values */
89 struct ethtool_value {
90         __u32   cmd;
91         __u32   data;
92 };
93
94 /* for passing big chunks of data */
95 struct ethtool_regs {
96         __u32   cmd;
97         __u32   version; /* driver-specific, indicates different chips/revs */
98         __u32   len; /* bytes */
99         __u8    data[0];
100 };
101
102 /* for passing EEPROM chunks */
103 struct ethtool_eeprom {
104         __u32   cmd;
105         __u32   magic;
106         __u32   offset; /* in bytes */
107         __u32   len; /* in bytes */
108         __u8    data[0];
109 };
110
111 /* for configuring coalescing parameters of chip */
112 struct ethtool_coalesce {
113         __u32   cmd;    /* ETHTOOL_{G,S}COALESCE */
114
115         /* How many usecs to delay an RX interrupt after
116          * a packet arrives.  If 0, only rx_max_coalesced_frames
117          * is used.
118          */
119         __u32   rx_coalesce_usecs;
120
121         /* How many packets to delay an RX interrupt after
122          * a packet arrives.  If 0, only rx_coalesce_usecs is
123          * used.  It is illegal to set both usecs and max frames
124          * to zero as this would cause RX interrupts to never be
125          * generated.
126          */
127         __u32   rx_max_coalesced_frames;
128
129         /* Same as above two parameters, except that these values
130          * apply while an IRQ is being serviced by the host.  Not
131          * all cards support this feature and the values are ignored
132          * in that case.
133          */
134         __u32   rx_coalesce_usecs_irq;
135         __u32   rx_max_coalesced_frames_irq;
136
137         /* How many usecs to delay a TX interrupt after
138          * a packet is sent.  If 0, only tx_max_coalesced_frames
139          * is used.
140          */
141         __u32   tx_coalesce_usecs;
142
143         /* How many packets to delay a TX interrupt after
144          * a packet is sent.  If 0, only tx_coalesce_usecs is
145          * used.  It is illegal to set both usecs and max frames
146          * to zero as this would cause TX interrupts to never be
147          * generated.
148          */
149         __u32   tx_max_coalesced_frames;
150
151         /* Same as above two parameters, except that these values
152          * apply while an IRQ is being serviced by the host.  Not
153          * all cards support this feature and the values are ignored
154          * in that case.
155          */
156         __u32   tx_coalesce_usecs_irq;
157         __u32   tx_max_coalesced_frames_irq;
158
159         /* How many usecs to delay in-memory statistics
160          * block updates.  Some drivers do not have an in-memory
161          * statistic block, and in such cases this value is ignored.
162          * This value must not be zero.
163          */
164         __u32   stats_block_coalesce_usecs;
165
166         /* Adaptive RX/TX coalescing is an algorithm implemented by
167          * some drivers to improve latency under low packet rates and
168          * improve throughput under high packet rates.  Some drivers
169          * only implement one of RX or TX adaptive coalescing.  Anything
170          * not implemented by the driver causes these values to be
171          * silently ignored.
172          */
173         __u32   use_adaptive_rx_coalesce;
174         __u32   use_adaptive_tx_coalesce;
175
176         /* When the packet rate (measured in packets per second)
177          * is below pkt_rate_low, the {rx,tx}_*_low parameters are
178          * used.
179          */
180         __u32   pkt_rate_low;
181         __u32   rx_coalesce_usecs_low;
182         __u32   rx_max_coalesced_frames_low;
183         __u32   tx_coalesce_usecs_low;
184         __u32   tx_max_coalesced_frames_low;
185
186         /* When the packet rate is below pkt_rate_high but above
187          * pkt_rate_low (both measured in packets per second) the
188          * normal {rx,tx}_* coalescing parameters are used.
189          */
190
191         /* When the packet rate is (measured in packets per second)
192          * is above pkt_rate_high, the {rx,tx}_*_high parameters are
193          * used.
194          */
195         __u32   pkt_rate_high;
196         __u32   rx_coalesce_usecs_high;
197         __u32   rx_max_coalesced_frames_high;
198         __u32   tx_coalesce_usecs_high;
199         __u32   tx_max_coalesced_frames_high;
200
201         /* How often to do adaptive coalescing packet rate sampling,
202          * measured in seconds.  Must not be zero.
203          */
204         __u32   rate_sample_interval;
205 };
206
207 /* for configuring RX/TX ring parameters */
208 struct ethtool_ringparam {
209         __u32   cmd;    /* ETHTOOL_{G,S}RINGPARAM */
210
211         /* Read only attributes.  These indicate the maximum number
212          * of pending RX/TX ring entries the driver will allow the
213          * user to set.
214          */
215         __u32   rx_max_pending;
216         __u32   rx_mini_max_pending;
217         __u32   rx_jumbo_max_pending;
218         __u32   tx_max_pending;
219
220         /* Values changeable by the user.  The valid values are
221          * in the range 1 to the "*_max_pending" counterpart above.
222          */
223         __u32   rx_pending;
224         __u32   rx_mini_pending;
225         __u32   rx_jumbo_pending;
226         __u32   tx_pending;
227 };
228
229 /* for configuring link flow control parameters */
230 struct ethtool_pauseparam {
231         __u32   cmd;    /* ETHTOOL_{G,S}PAUSEPARAM */
232
233         /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
234          * being true) the user may set 'autonet' here non-zero to have the
235          * pause parameters be auto-negotiated too.  In such a case, the
236          * {rx,tx}_pause values below determine what capabilities are
237          * advertised.
238          *
239          * If 'autoneg' is zero or the link is not being auto-negotiated,
240          * then {rx,tx}_pause force the driver to use/not-use pause
241          * flow control.
242          */
243         __u32   autoneg;
244         __u32   rx_pause;
245         __u32   tx_pause;
246 };
247
248 #define ETH_GSTRING_LEN         32
249 enum ethtool_stringset {
250         ETH_SS_TEST             = 0,
251         ETH_SS_STATS,
252         ETH_SS_PRIV_FLAGS,
253         ETH_SS_NTUPLE_FILTERS,
254         ETH_SS_FEATURES,
255 };
256
257 /* for passing string sets for data tagging */
258 struct ethtool_gstrings {
259         __u32   cmd;            /* ETHTOOL_GSTRINGS */
260         __u32   string_set;     /* string set id e.c. ETH_SS_TEST, etc*/
261         __u32   len;            /* number of strings in the string set */
262         __u8    data[0];
263 };
264
265 struct ethtool_sset_info {
266         __u32   cmd;            /* ETHTOOL_GSSET_INFO */
267         __u32   reserved;
268         __u64   sset_mask;      /* input: each bit selects an sset to query */
269                                 /* output: each bit a returned sset */
270         __u32   data[0];        /* ETH_SS_xxx count, in order, based on bits
271                                    in sset_mask.  One bit implies one
272                                    __u32, two bits implies two
273                                    __u32's, etc. */
274 };
275
276 enum ethtool_test_flags {
277         ETH_TEST_FL_OFFLINE     = (1 << 0),     /* online / offline */
278         ETH_TEST_FL_FAILED      = (1 << 1),     /* test passed / failed */
279 };
280
281 /* for requesting NIC test and getting results*/
282 struct ethtool_test {
283         __u32   cmd;            /* ETHTOOL_TEST */
284         __u32   flags;          /* ETH_TEST_FL_xxx */
285         __u32   reserved;
286         __u32   len;            /* result length, in number of u64 elements */
287         __u64   data[0];
288 };
289
290 /* for dumping NIC-specific statistics */
291 struct ethtool_stats {
292         __u32   cmd;            /* ETHTOOL_GSTATS */
293         __u32   n_stats;        /* number of u64's being returned */
294         __u64   data[0];
295 };
296
297 struct ethtool_perm_addr {
298         __u32   cmd;            /* ETHTOOL_GPERMADDR */
299         __u32   size;
300         __u8    data[0];
301 };
302
303 /* boolean flags controlling per-interface behavior characteristics.
304  * When reading, the flag indicates whether or not a certain behavior
305  * is enabled/present.  When writing, the flag indicates whether
306  * or not the driver should turn on (set) or off (clear) a behavior.
307  *
308  * Some behaviors may read-only (unconditionally absent or present).
309  * If such is the case, return EINVAL in the set-flags operation if the
310  * flag differs from the read-only value.
311  */
312 enum ethtool_flags {
313         ETH_FLAG_TXVLAN         = (1 << 7),     /* TX VLAN offload enabled */
314         ETH_FLAG_RXVLAN         = (1 << 8),     /* RX VLAN offload enabled */
315         ETH_FLAG_LRO            = (1 << 15),    /* LRO is enabled */
316         ETH_FLAG_NTUPLE         = (1 << 27),    /* N-tuple filters enabled */
317         ETH_FLAG_RXHASH         = (1 << 28),
318 };
319
320 /* The following structures are for supporting RX network flow
321  * classification and RX n-tuple configuration. Note, all multibyte
322  * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
323  * be in network byte order.
324  */
325
326 /**
327  * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
328  * @ip4src: Source host
329  * @ip4dst: Destination host
330  * @psrc: Source port
331  * @pdst: Destination port
332  * @tos: Type-of-service
333  *
334  * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
335  */
336 struct ethtool_tcpip4_spec {
337         __be32  ip4src;
338         __be32  ip4dst;
339         __be16  psrc;
340         __be16  pdst;
341         __u8    tos;
342 };
343
344 /**
345  * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
346  * @ip4src: Source host
347  * @ip4dst: Destination host
348  * @spi: Security parameters index
349  * @tos: Type-of-service
350  *
351  * This can be used to specify an IPsec transport or tunnel over IPv4.
352  */
353 struct ethtool_ah_espip4_spec {
354         __be32  ip4src;
355         __be32  ip4dst;
356         __be32  spi;
357         __u8    tos;
358 };
359
360 #define ETH_RX_NFC_IP4  1
361
362 /**
363  * struct ethtool_usrip4_spec - general flow specification for IPv4
364  * @ip4src: Source host
365  * @ip4dst: Destination host
366  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
367  * @tos: Type-of-service
368  * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
369  * @proto: Transport protocol number; mask must be 0
370  */
371 struct ethtool_usrip4_spec {
372         __be32  ip4src;
373         __be32  ip4dst;
374         __be32  l4_4_bytes;
375         __u8    tos;
376         __u8    ip_ver;
377         __u8    proto;
378 };
379
380 /**
381  * struct ethtool_rx_flow_spec - specification for RX flow filter
382  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
383  * @h_u: Flow fields to match (dependent on @flow_type)
384  * @m_u: Masks for flow field bits to be ignored
385  * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
386  *      if packets should be discarded
387  * @location: Index of filter in hardware table
388  */
389 struct ethtool_rx_flow_spec {
390         __u32           flow_type;
391         union {
392                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
393                 struct ethtool_tcpip4_spec              udp_ip4_spec;
394                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
395                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
396                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
397                 struct ethtool_usrip4_spec              usr_ip4_spec;
398                 struct ethhdr                           ether_spec;
399                 __u8                                    hdata[72];
400         } h_u, m_u;
401         __u64           ring_cookie;
402         __u32           location;
403 };
404
405 /**
406  * struct ethtool_rxnfc - command to get or set RX flow classification rules
407  * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
408  *      %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
409  *      %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
410  * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
411  * @data: Command-dependent value
412  * @fs: Flow filter specification
413  * @rule_cnt: Number of rules to be affected
414  * @rule_locs: Array of valid rule indices
415  *
416  * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
417  * the fields included in the flow hash, e.g. %RXH_IP_SRC.  The following
418  * structure fields must not be used.
419  *
420  * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
421  * on return.
422  *
423  * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
424  * rules on return.
425  *
426  * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an
427  * existing filter rule on entry and @fs contains the rule on return.
428  *
429  * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
430  * user buffer for @rule_locs on entry.  On return, @data is the size
431  * of the filter table and @rule_locs contains the indices of the
432  * defined rules.
433  *
434  * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or
435  * update.  @fs.@location specifies the index to use and must not be
436  * ignored.
437  *
438  * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an
439  * existing filter rule on entry.
440  *
441  * Implementation of indexed classification rules generally requires a
442  * TCAM.
443  */
444 struct ethtool_rxnfc {
445         __u32                           cmd;
446         __u32                           flow_type;
447         __u64                           data;
448         struct ethtool_rx_flow_spec     fs;
449         __u32                           rule_cnt;
450         __u32                           rule_locs[0];
451 };
452
453 /**
454  * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
455  * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
456  * @size: On entry, the array size of the user buffer.  On return from
457  *      %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
458  * @ring_index: RX ring/queue index for each hash value
459  */
460 struct ethtool_rxfh_indir {
461         __u32   cmd;
462         __u32   size;
463         __u32   ring_index[0];
464 };
465
466 /**
467  * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
468  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
469  * @h_u: Flow field values to match (dependent on @flow_type)
470  * @m_u: Masks for flow field value bits to be ignored
471  * @vlan_tag: VLAN tag to match
472  * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
473  * @data: Driver-dependent data to match
474  * @data_mask: Mask for driver-dependent data bits to be ignored
475  * @action: RX ring/queue index to deliver to (non-negative) or other action
476  *      (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
477  *
478  * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
479  * a field value and mask are both zero this is treated as if all mask
480  * bits are set i.e. the field is ignored.
481  */
482 struct ethtool_rx_ntuple_flow_spec {
483         __u32            flow_type;
484         union {
485                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
486                 struct ethtool_tcpip4_spec              udp_ip4_spec;
487                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
488                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
489                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
490                 struct ethtool_usrip4_spec              usr_ip4_spec;
491                 struct ethhdr                           ether_spec;
492                 __u8                                    hdata[72];
493         } h_u, m_u;
494
495         __u16           vlan_tag;
496         __u16           vlan_tag_mask;
497         __u64           data;
498         __u64           data_mask;
499
500         __s32           action;
501 #define ETHTOOL_RXNTUPLE_ACTION_DROP    (-1)    /* drop packet */
502 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR   (-2)    /* clear filter */
503 };
504
505 /**
506  * struct ethtool_rx_ntuple - command to set or clear RX flow filter
507  * @cmd: Command number - %ETHTOOL_SRXNTUPLE
508  * @fs: Flow filter specification
509  */
510 struct ethtool_rx_ntuple {
511         __u32                                   cmd;
512         struct ethtool_rx_ntuple_flow_spec      fs;
513 };
514
515 #define ETHTOOL_FLASH_MAX_FILENAME      128
516 enum ethtool_flash_op_type {
517         ETHTOOL_FLASH_ALL_REGIONS       = 0,
518 };
519
520 /* for passing firmware flashing related parameters */
521 struct ethtool_flash {
522         __u32   cmd;
523         __u32   region;
524         char    data[ETHTOOL_FLASH_MAX_FILENAME];
525 };
526
527 /* for returning and changing feature sets */
528
529 /**
530  * struct ethtool_get_features_block - block with state of 32 features
531  * @available: mask of changeable features
532  * @requested: mask of features requested to be enabled if possible
533  * @active: mask of currently enabled features
534  * @never_changed: mask of features not changeable for any device
535  */
536 struct ethtool_get_features_block {
537         __u32   available;
538         __u32   requested;
539         __u32   active;
540         __u32   never_changed;
541 };
542
543 /**
544  * struct ethtool_gfeatures - command to get state of device's features
545  * @cmd: command number = %ETHTOOL_GFEATURES
546  * @size: in: number of elements in the features[] array;
547  *       out: number of elements in features[] needed to hold all features
548  * @features: state of features
549  */
550 struct ethtool_gfeatures {
551         __u32   cmd;
552         __u32   size;
553         struct ethtool_get_features_block features[0];
554 };
555
556 /**
557  * struct ethtool_set_features_block - block with request for 32 features
558  * @valid: mask of features to be changed
559  * @requested: values of features to be changed
560  */
561 struct ethtool_set_features_block {
562         __u32   valid;
563         __u32   requested;
564 };
565
566 /**
567  * struct ethtool_sfeatures - command to request change in device's features
568  * @cmd: command number = %ETHTOOL_SFEATURES
569  * @size: array size of the features[] array
570  * @features: feature change masks
571  */
572 struct ethtool_sfeatures {
573         __u32   cmd;
574         __u32   size;
575         struct ethtool_set_features_block features[0];
576 };
577
578 /*
579  * %ETHTOOL_SFEATURES changes features present in features[].valid to the
580  * values of corresponding bits in features[].requested. Bits in .requested
581  * not set in .valid or not changeable are ignored.
582  *
583  * Returns %EINVAL when .valid contains undefined or never-changable bits
584  * or size is not equal to required number of features words (32-bit blocks).
585  * Returns >= 0 if request was completed; bits set in the value mean:
586  *   %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
587  *      changeable (not present in %ETHTOOL_GFEATURES' features[].available)
588  *      those bits were ignored.
589  *   %ETHTOOL_F_WISH - some or all changes requested were recorded but the
590  *      resulting state of bits masked by .valid is not equal to .requested.
591  *      Probably there are other device-specific constraints on some features
592  *      in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
593  *      here as though ignored bits were cleared.
594  *   %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
595  *      compatibility functions. Requested offload state cannot be properly
596  *      managed by kernel.
597  *
598  * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
599  * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
600  * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
601  * significant bit in features[0] fields. Empty strings mark undefined features.
602  */
603 enum ethtool_sfeatures_retval_bits {
604         ETHTOOL_F_UNSUPPORTED__BIT,
605         ETHTOOL_F_WISH__BIT,
606         ETHTOOL_F_COMPAT__BIT,
607 };
608
609 #define ETHTOOL_F_UNSUPPORTED   (1 << ETHTOOL_F_UNSUPPORTED__BIT)
610 #define ETHTOOL_F_WISH          (1 << ETHTOOL_F_WISH__BIT)
611 #define ETHTOOL_F_COMPAT        (1 << ETHTOOL_F_COMPAT__BIT)
612
613 #ifdef __KERNEL__
614
615 #include <linux/rculist.h>
616
617 struct ethtool_rx_ntuple_flow_spec_container {
618         struct ethtool_rx_ntuple_flow_spec fs;
619         struct list_head list;
620 };
621
622 struct ethtool_rx_ntuple_list {
623 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
624 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
625         struct list_head        list;
626         unsigned int            count;
627 };
628
629 struct net_device;
630
631 /* Some generic methods drivers may use in their ethtool_ops */
632 u32 ethtool_op_get_link(struct net_device *dev);
633 u32 ethtool_op_get_tx_csum(struct net_device *dev);
634 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
635 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
636 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
637 u32 ethtool_op_get_sg(struct net_device *dev);
638 int ethtool_op_set_sg(struct net_device *dev, u32 data);
639 u32 ethtool_op_get_tso(struct net_device *dev);
640 int ethtool_op_set_tso(struct net_device *dev, u32 data);
641 u32 ethtool_op_get_ufo(struct net_device *dev);
642 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
643 u32 ethtool_op_get_flags(struct net_device *dev);
644 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
645 void ethtool_ntuple_flush(struct net_device *dev);
646
647 /**
648  * &ethtool_ops - Alter and report network device settings
649  * get_settings: Get device-specific settings
650  * set_settings: Set device-specific settings
651  * get_drvinfo: Report driver information
652  * get_regs: Get device registers
653  * get_wol: Report whether Wake-on-Lan is enabled
654  * set_wol: Turn Wake-on-Lan on or off
655  * get_msglevel: Report driver message level
656  * set_msglevel: Set driver message level
657  * nway_reset: Restart autonegotiation
658  * get_link: Get link status
659  * get_eeprom: Read data from the device EEPROM
660  * set_eeprom: Write data to the device EEPROM
661  * get_coalesce: Get interrupt coalescing parameters
662  * set_coalesce: Set interrupt coalescing parameters
663  * get_ringparam: Report ring sizes
664  * set_ringparam: Set ring sizes
665  * get_pauseparam: Report pause parameters
666  * set_pauseparam: Set pause parameters
667  * get_rx_csum: Report whether receive checksums are turned on or off
668  * set_rx_csum: Turn receive checksum on or off
669  * get_tx_csum: Report whether transmit checksums are turned on or off
670  * set_tx_csum: Turn transmit checksums on or off
671  * get_sg: Report whether scatter-gather is enabled
672  * set_sg: Turn scatter-gather on or off
673  * get_tso: Report whether TCP segmentation offload is enabled
674  * set_tso: Turn TCP segmentation offload on or off
675  * get_ufo: Report whether UDP fragmentation offload is enabled
676  * set_ufo: Turn UDP fragmentation offload on or off
677  * self_test: Run specified self-tests
678  * get_strings: Return a set of strings that describe the requested objects
679  * phys_id: Identify the device
680  * get_stats: Return statistics about the device
681  * get_flags: get 32-bit flags bitmap
682  * set_flags: set 32-bit flags bitmap
683  *
684  * Description:
685  *
686  * get_settings:
687  *      @get_settings is passed an &ethtool_cmd to fill in.  It returns
688  *      an negative errno or zero.
689  *
690  * set_settings:
691  *      @set_settings is passed an &ethtool_cmd and should attempt to set
692  *      all the settings this device supports.  It may return an error value
693  *      if something goes wrong (otherwise 0).
694  *
695  * get_eeprom:
696  *      Should fill in the magic field.  Don't need to check len for zero
697  *      or wraparound.  Fill in the data argument with the eeprom values
698  *      from offset to offset + len.  Update len to the amount read.
699  *      Returns an error or zero.
700  *
701  * set_eeprom:
702  *      Should validate the magic field.  Don't need to check len for zero
703  *      or wraparound.  Update len to the amount written.  Returns an error
704  *      or zero.
705  */
706 struct ethtool_ops {
707         int     (*get_settings)(struct net_device *, struct ethtool_cmd *);
708         int     (*set_settings)(struct net_device *, struct ethtool_cmd *);
709         void    (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
710         int     (*get_regs_len)(struct net_device *);
711         void    (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
712         void    (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
713         int     (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
714         u32     (*get_msglevel)(struct net_device *);
715         void    (*set_msglevel)(struct net_device *, u32);
716         int     (*nway_reset)(struct net_device *);
717         u32     (*get_link)(struct net_device *);
718         int     (*get_eeprom_len)(struct net_device *);
719         int     (*get_eeprom)(struct net_device *,
720                               struct ethtool_eeprom *, u8 *);
721         int     (*set_eeprom)(struct net_device *,
722                               struct ethtool_eeprom *, u8 *);
723         int     (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
724         int     (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
725         void    (*get_ringparam)(struct net_device *,
726                                  struct ethtool_ringparam *);
727         int     (*set_ringparam)(struct net_device *,
728                                  struct ethtool_ringparam *);
729         void    (*get_pauseparam)(struct net_device *,
730                                   struct ethtool_pauseparam*);
731         int     (*set_pauseparam)(struct net_device *,
732                                   struct ethtool_pauseparam*);
733         u32     (*get_rx_csum)(struct net_device *);
734         int     (*set_rx_csum)(struct net_device *, u32);
735         u32     (*get_tx_csum)(struct net_device *);
736         int     (*set_tx_csum)(struct net_device *, u32);
737         u32     (*get_sg)(struct net_device *);
738         int     (*set_sg)(struct net_device *, u32);
739         u32     (*get_tso)(struct net_device *);
740         int     (*set_tso)(struct net_device *, u32);
741         void    (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
742         void    (*get_strings)(struct net_device *, u32 stringset, u8 *);
743         int     (*phys_id)(struct net_device *, u32);
744         void    (*get_ethtool_stats)(struct net_device *,
745                                      struct ethtool_stats *, u64 *);
746         int     (*begin)(struct net_device *);
747         void    (*complete)(struct net_device *);
748         u32     (*get_ufo)(struct net_device *);
749         int     (*set_ufo)(struct net_device *, u32);
750         u32     (*get_flags)(struct net_device *);
751         int     (*set_flags)(struct net_device *, u32);
752         u32     (*get_priv_flags)(struct net_device *);
753         int     (*set_priv_flags)(struct net_device *, u32);
754         int     (*get_sset_count)(struct net_device *, int);
755         int     (*get_rxnfc)(struct net_device *,
756                              struct ethtool_rxnfc *, void *);
757         int     (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
758         int     (*flash_device)(struct net_device *, struct ethtool_flash *);
759         int     (*reset)(struct net_device *, u32 *);
760         int     (*set_rx_ntuple)(struct net_device *,
761                                  struct ethtool_rx_ntuple *);
762         int     (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
763         int     (*get_rxfh_indir)(struct net_device *,
764                                   struct ethtool_rxfh_indir *);
765         int     (*set_rxfh_indir)(struct net_device *,
766                                   const struct ethtool_rxfh_indir *);
767 };
768 #endif /* __KERNEL__ */
769
770 /* CMDs currently supported */
771 #define ETHTOOL_GSET            0x00000001 /* Get settings. */
772 #define ETHTOOL_SSET            0x00000002 /* Set settings. */
773 #define ETHTOOL_GDRVINFO        0x00000003 /* Get driver info. */
774 #define ETHTOOL_GREGS           0x00000004 /* Get NIC registers. */
775 #define ETHTOOL_GWOL            0x00000005 /* Get wake-on-lan options. */
776 #define ETHTOOL_SWOL            0x00000006 /* Set wake-on-lan options. */
777 #define ETHTOOL_GMSGLVL         0x00000007 /* Get driver message level */
778 #define ETHTOOL_SMSGLVL         0x00000008 /* Set driver msg level. */
779 #define ETHTOOL_NWAY_RST        0x00000009 /* Restart autonegotiation. */
780 /* Get link status for host, i.e. whether the interface *and* the
781  * physical port (if there is one) are up (ethtool_value). */
782 #define ETHTOOL_GLINK           0x0000000a
783 #define ETHTOOL_GEEPROM         0x0000000b /* Get EEPROM data */
784 #define ETHTOOL_SEEPROM         0x0000000c /* Set EEPROM data. */
785 #define ETHTOOL_GCOALESCE       0x0000000e /* Get coalesce config */
786 #define ETHTOOL_SCOALESCE       0x0000000f /* Set coalesce config. */
787 #define ETHTOOL_GRINGPARAM      0x00000010 /* Get ring parameters */
788 #define ETHTOOL_SRINGPARAM      0x00000011 /* Set ring parameters. */
789 #define ETHTOOL_GPAUSEPARAM     0x00000012 /* Get pause parameters */
790 #define ETHTOOL_SPAUSEPARAM     0x00000013 /* Set pause parameters. */
791 #define ETHTOOL_GRXCSUM         0x00000014 /* Get RX hw csum enable (ethtool_value) */
792 #define ETHTOOL_SRXCSUM         0x00000015 /* Set RX hw csum enable (ethtool_value) */
793 #define ETHTOOL_GTXCSUM         0x00000016 /* Get TX hw csum enable (ethtool_value) */
794 #define ETHTOOL_STXCSUM         0x00000017 /* Set TX hw csum enable (ethtool_value) */
795 #define ETHTOOL_GSG             0x00000018 /* Get scatter-gather enable
796                                             * (ethtool_value) */
797 #define ETHTOOL_SSG             0x00000019 /* Set scatter-gather enable
798                                             * (ethtool_value). */
799 #define ETHTOOL_TEST            0x0000001a /* execute NIC self-test. */
800 #define ETHTOOL_GSTRINGS        0x0000001b /* get specified string set */
801 #define ETHTOOL_PHYS_ID         0x0000001c /* identify the NIC */
802 #define ETHTOOL_GSTATS          0x0000001d /* get NIC-specific statistics */
803 #define ETHTOOL_GTSO            0x0000001e /* Get TSO enable (ethtool_value) */
804 #define ETHTOOL_STSO            0x0000001f /* Set TSO enable (ethtool_value) */
805 #define ETHTOOL_GPERMADDR       0x00000020 /* Get permanent hardware address */
806 #define ETHTOOL_GUFO            0x00000021 /* Get UFO enable (ethtool_value) */
807 #define ETHTOOL_SUFO            0x00000022 /* Set UFO enable (ethtool_value) */
808 #define ETHTOOL_GGSO            0x00000023 /* Get GSO enable (ethtool_value) */
809 #define ETHTOOL_SGSO            0x00000024 /* Set GSO enable (ethtool_value) */
810 #define ETHTOOL_GFLAGS          0x00000025 /* Get flags bitmap(ethtool_value) */
811 #define ETHTOOL_SFLAGS          0x00000026 /* Set flags bitmap(ethtool_value) */
812 #define ETHTOOL_GPFLAGS         0x00000027 /* Get driver-private flags bitmap */
813 #define ETHTOOL_SPFLAGS         0x00000028 /* Set driver-private flags bitmap */
814
815 #define ETHTOOL_GRXFH           0x00000029 /* Get RX flow hash configuration */
816 #define ETHTOOL_SRXFH           0x0000002a /* Set RX flow hash configuration */
817 #define ETHTOOL_GGRO            0x0000002b /* Get GRO enable (ethtool_value) */
818 #define ETHTOOL_SGRO            0x0000002c /* Set GRO enable (ethtool_value) */
819 #define ETHTOOL_GRXRINGS        0x0000002d /* Get RX rings available for LB */
820 #define ETHTOOL_GRXCLSRLCNT     0x0000002e /* Get RX class rule count */
821 #define ETHTOOL_GRXCLSRULE      0x0000002f /* Get RX classification rule */
822 #define ETHTOOL_GRXCLSRLALL     0x00000030 /* Get all RX classification rule */
823 #define ETHTOOL_SRXCLSRLDEL     0x00000031 /* Delete RX classification rule */
824 #define ETHTOOL_SRXCLSRLINS     0x00000032 /* Insert RX classification rule */
825 #define ETHTOOL_FLASHDEV        0x00000033 /* Flash firmware to device */
826 #define ETHTOOL_RESET           0x00000034 /* Reset hardware */
827 #define ETHTOOL_SRXNTUPLE       0x00000035 /* Add an n-tuple filter to device */
828 #define ETHTOOL_GRXNTUPLE       0x00000036 /* Get n-tuple filters from device */
829 #define ETHTOOL_GSSET_INFO      0x00000037 /* Get string set info */
830 #define ETHTOOL_GRXFHINDIR      0x00000038 /* Get RX flow hash indir'n table */
831 #define ETHTOOL_SRXFHINDIR      0x00000039 /* Set RX flow hash indir'n table */
832
833 #define ETHTOOL_GFEATURES       0x0000003a /* Get device offload settings */
834 #define ETHTOOL_SFEATURES       0x0000003b /* Change device offload settings */
835
836 /* compatibility with older code */
837 #define SPARC_ETH_GSET          ETHTOOL_GSET
838 #define SPARC_ETH_SSET          ETHTOOL_SSET
839
840 /* Indicates what features are supported by the interface. */
841 #define SUPPORTED_10baseT_Half          (1 << 0)
842 #define SUPPORTED_10baseT_Full          (1 << 1)
843 #define SUPPORTED_100baseT_Half         (1 << 2)
844 #define SUPPORTED_100baseT_Full         (1 << 3)
845 #define SUPPORTED_1000baseT_Half        (1 << 4)
846 #define SUPPORTED_1000baseT_Full        (1 << 5)
847 #define SUPPORTED_Autoneg               (1 << 6)
848 #define SUPPORTED_TP                    (1 << 7)
849 #define SUPPORTED_AUI                   (1 << 8)
850 #define SUPPORTED_MII                   (1 << 9)
851 #define SUPPORTED_FIBRE                 (1 << 10)
852 #define SUPPORTED_BNC                   (1 << 11)
853 #define SUPPORTED_10000baseT_Full       (1 << 12)
854 #define SUPPORTED_Pause                 (1 << 13)
855 #define SUPPORTED_Asym_Pause            (1 << 14)
856 #define SUPPORTED_2500baseX_Full        (1 << 15)
857 #define SUPPORTED_Backplane             (1 << 16)
858 #define SUPPORTED_1000baseKX_Full       (1 << 17)
859 #define SUPPORTED_10000baseKX4_Full     (1 << 18)
860 #define SUPPORTED_10000baseKR_Full      (1 << 19)
861 #define SUPPORTED_10000baseR_FEC        (1 << 20)
862
863 /* Indicates what features are advertised by the interface. */
864 #define ADVERTISED_10baseT_Half         (1 << 0)
865 #define ADVERTISED_10baseT_Full         (1 << 1)
866 #define ADVERTISED_100baseT_Half        (1 << 2)
867 #define ADVERTISED_100baseT_Full        (1 << 3)
868 #define ADVERTISED_1000baseT_Half       (1 << 4)
869 #define ADVERTISED_1000baseT_Full       (1 << 5)
870 #define ADVERTISED_Autoneg              (1 << 6)
871 #define ADVERTISED_TP                   (1 << 7)
872 #define ADVERTISED_AUI                  (1 << 8)
873 #define ADVERTISED_MII                  (1 << 9)
874 #define ADVERTISED_FIBRE                (1 << 10)
875 #define ADVERTISED_BNC                  (1 << 11)
876 #define ADVERTISED_10000baseT_Full      (1 << 12)
877 #define ADVERTISED_Pause                (1 << 13)
878 #define ADVERTISED_Asym_Pause           (1 << 14)
879 #define ADVERTISED_2500baseX_Full       (1 << 15)
880 #define ADVERTISED_Backplane            (1 << 16)
881 #define ADVERTISED_1000baseKX_Full      (1 << 17)
882 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
883 #define ADVERTISED_10000baseKR_Full     (1 << 19)
884 #define ADVERTISED_10000baseR_FEC       (1 << 20)
885
886 /* The following are all involved in forcing a particular link
887  * mode for the device for setting things.  When getting the
888  * devices settings, these indicate the current mode and whether
889  * it was foced up into this mode or autonegotiated.
890  */
891
892 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
893 #define SPEED_10                10
894 #define SPEED_100               100
895 #define SPEED_1000              1000
896 #define SPEED_2500              2500
897 #define SPEED_10000             10000
898
899 /* Duplex, half or full. */
900 #define DUPLEX_HALF             0x00
901 #define DUPLEX_FULL             0x01
902
903 /* Which connector port. */
904 #define PORT_TP                 0x00
905 #define PORT_AUI                0x01
906 #define PORT_MII                0x02
907 #define PORT_FIBRE              0x03
908 #define PORT_BNC                0x04
909 #define PORT_DA                 0x05
910 #define PORT_NONE               0xef
911 #define PORT_OTHER              0xff
912
913 /* Which transceiver to use. */
914 #define XCVR_INTERNAL           0x00
915 #define XCVR_EXTERNAL           0x01
916 #define XCVR_DUMMY1             0x02
917 #define XCVR_DUMMY2             0x03
918 #define XCVR_DUMMY3             0x04
919
920 /* Enable or disable autonegotiation.  If this is set to enable,
921  * the forced link modes above are completely ignored.
922  */
923 #define AUTONEG_DISABLE         0x00
924 #define AUTONEG_ENABLE          0x01
925
926 /* Mode MDI or MDI-X */
927 #define ETH_TP_MDI_INVALID      0x00
928 #define ETH_TP_MDI              0x01
929 #define ETH_TP_MDI_X            0x02
930
931 /* Wake-On-Lan options. */
932 #define WAKE_PHY                (1 << 0)
933 #define WAKE_UCAST              (1 << 1)
934 #define WAKE_MCAST              (1 << 2)
935 #define WAKE_BCAST              (1 << 3)
936 #define WAKE_ARP                (1 << 4)
937 #define WAKE_MAGIC              (1 << 5)
938 #define WAKE_MAGICSECURE        (1 << 6) /* only meaningful if WAKE_MAGIC */
939
940 /* L2-L4 network traffic flow types */
941 #define TCP_V4_FLOW     0x01    /* hash or spec (tcp_ip4_spec) */
942 #define UDP_V4_FLOW     0x02    /* hash or spec (udp_ip4_spec) */
943 #define SCTP_V4_FLOW    0x03    /* hash or spec (sctp_ip4_spec) */
944 #define AH_ESP_V4_FLOW  0x04    /* hash only */
945 #define TCP_V6_FLOW     0x05    /* hash only */
946 #define UDP_V6_FLOW     0x06    /* hash only */
947 #define SCTP_V6_FLOW    0x07    /* hash only */
948 #define AH_ESP_V6_FLOW  0x08    /* hash only */
949 #define AH_V4_FLOW      0x09    /* hash or spec (ah_ip4_spec) */
950 #define ESP_V4_FLOW     0x0a    /* hash or spec (esp_ip4_spec) */
951 #define AH_V6_FLOW      0x0b    /* hash only */
952 #define ESP_V6_FLOW     0x0c    /* hash only */
953 #define IP_USER_FLOW    0x0d    /* spec only (usr_ip4_spec) */
954 #define IPV4_FLOW       0x10    /* hash only */
955 #define IPV6_FLOW       0x11    /* hash only */
956 #define ETHER_FLOW      0x12    /* spec only (ether_spec) */
957
958 /* L3-L4 network traffic flow hash options */
959 #define RXH_L2DA        (1 << 1)
960 #define RXH_VLAN        (1 << 2)
961 #define RXH_L3_PROTO    (1 << 3)
962 #define RXH_IP_SRC      (1 << 4)
963 #define RXH_IP_DST      (1 << 5)
964 #define RXH_L4_B_0_1    (1 << 6) /* src port in case of TCP/UDP/SCTP */
965 #define RXH_L4_B_2_3    (1 << 7) /* dst port in case of TCP/UDP/SCTP */
966 #define RXH_DISCARD     (1 << 31)
967
968 #define RX_CLS_FLOW_DISC        0xffffffffffffffffULL
969
970 /* Reset flags */
971 /* The reset() operation must clear the flags for the components which
972  * were actually reset.  On successful return, the flags indicate the
973  * components which were not reset, either because they do not exist
974  * in the hardware or because they cannot be reset independently.  The
975  * driver must never reset any components that were not requested.
976  */
977 enum ethtool_reset_flags {
978         /* These flags represent components dedicated to the interface
979          * the command is addressed to.  Shift any flag left by
980          * ETH_RESET_SHARED_SHIFT to reset a shared component of the
981          * same type.
982          */
983         ETH_RESET_MGMT          = 1 << 0,       /* Management processor */
984         ETH_RESET_IRQ           = 1 << 1,       /* Interrupt requester */
985         ETH_RESET_DMA           = 1 << 2,       /* DMA engine */
986         ETH_RESET_FILTER        = 1 << 3,       /* Filtering/flow direction */
987         ETH_RESET_OFFLOAD       = 1 << 4,       /* Protocol offload */
988         ETH_RESET_MAC           = 1 << 5,       /* Media access controller */
989         ETH_RESET_PHY           = 1 << 6,       /* Transceiver/PHY */
990         ETH_RESET_RAM           = 1 << 7,       /* RAM shared between
991                                                  * multiple components */
992
993         ETH_RESET_DEDICATED     = 0x0000ffff,   /* All components dedicated to
994                                                  * this interface */
995         ETH_RESET_ALL           = 0xffffffff,   /* All components used by this
996                                                  * interface, even if shared */
997 };
998 #define ETH_RESET_SHARED_SHIFT  16
999
1000 #endif /* _LINUX_ETHTOOL_H */