ethtool: Remove unimplemented flow specification types
[linux-2.6.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
18 /* This should work for both 32 and 64 bit userland. */
19 struct ethtool_cmd {
20         __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 */
29         __u8    mdio_support;
30         __u32   maxtxpkt;       /* Tx pkts before generating tx int */
31         __u32   maxrxpkt;       /* Rx pkts before generating rx int */
32         __u16   speed_hi;
33         __u8    eth_tp_mdix;
34         __u8    reserved2;
35         __u32   lp_advertising; /* Features the link partner advertises */
36         __u32   reserved[2];
37 };
38
39 static 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
47 static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep)
48 {
49         return (ep->speed_hi << 16) | ep->speed;
50 }
51
52 #define ETHTOOL_FWVERS_LEN      32
53 #define ETHTOOL_BUSINFO_LEN     32
54 /* these strings are set to whatever the driver author decides... */
55 struct ethtool_drvinfo {
56         __u32   cmd;
57         char    driver[32];     /* driver short name, "tulip", "eepro100" */
58         char    version[32];    /* driver version string */
59         char    fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */
60         char    bus_info[ETHTOOL_BUSINFO_LEN];  /* Bus info for this IF. */
61                                 /* For PCI devices, use pci_name(pci_dev). */
62         char    reserved1[32];
63         char    reserved2[12];
64                                 /*
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                                  */
71         __u32   n_priv_flags;   /* number of flags valid in ETHTOOL_GPFLAGS */
72         __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) */
76 };
77
78 #define SOPASS_MAX      6
79 /* wake-on-lan settings */
80 struct ethtool_wolinfo {
81         __u32   cmd;
82         __u32   supported;
83         __u32   wolopts;
84         __u8    sopass[SOPASS_MAX]; /* SecureOn(tm) password */
85 };
86
87 /* for passing single values */
88 struct ethtool_value {
89         __u32   cmd;
90         __u32   data;
91 };
92
93 /* for passing big chunks of data */
94 struct ethtool_regs {
95         __u32   cmd;
96         __u32   version; /* driver-specific, indicates different chips/revs */
97         __u32   len; /* bytes */
98         __u8    data[0];
99 };
100
101 /* for passing EEPROM chunks */
102 struct ethtool_eeprom {
103         __u32   cmd;
104         __u32   magic;
105         __u32   offset; /* in bytes */
106         __u32   len; /* in bytes */
107         __u8    data[0];
108 };
109
110 /* for configuring coalescing parameters of chip */
111 struct ethtool_coalesce {
112         __u32   cmd;    /* ETHTOOL_{G,S}COALESCE */
113
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          */
118         __u32   rx_coalesce_usecs;
119
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          */
126         __u32   rx_max_coalesced_frames;
127
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          */
133         __u32   rx_coalesce_usecs_irq;
134         __u32   rx_max_coalesced_frames_irq;
135
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          */
140         __u32   tx_coalesce_usecs;
141
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          */
148         __u32   tx_max_coalesced_frames;
149
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          */
155         __u32   tx_coalesce_usecs_irq;
156         __u32   tx_max_coalesced_frames_irq;
157
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          */
163         __u32   stats_block_coalesce_usecs;
164
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          */
172         __u32   use_adaptive_rx_coalesce;
173         __u32   use_adaptive_tx_coalesce;
174
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          */
179         __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;
184
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          */
194         __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;
199
200         /* How often to do adaptive coalescing packet rate sampling,
201          * measured in seconds.  Must not be zero.
202          */
203         __u32   rate_sample_interval;
204 };
205
206 /* for configuring RX/TX ring parameters */
207 struct ethtool_ringparam {
208         __u32   cmd;    /* ETHTOOL_{G,S}RINGPARAM */
209
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          */
214         __u32   rx_max_pending;
215         __u32   rx_mini_max_pending;
216         __u32   rx_jumbo_max_pending;
217         __u32   tx_max_pending;
218
219         /* Values changeable by the user.  The valid values are
220          * in the range 1 to the "*_max_pending" counterpart above.
221          */
222         __u32   rx_pending;
223         __u32   rx_mini_pending;
224         __u32   rx_jumbo_pending;
225         __u32   tx_pending;
226 };
227
228 /* for configuring link flow control parameters */
229 struct ethtool_pauseparam {
230         __u32   cmd;    /* ETHTOOL_{G,S}PAUSEPARAM */
231
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          */
242         __u32   autoneg;
243         __u32   rx_pause;
244         __u32   tx_pause;
245 };
246
247 #define ETH_GSTRING_LEN         32
248 enum ethtool_stringset {
249         ETH_SS_TEST             = 0,
250         ETH_SS_STATS,
251         ETH_SS_PRIV_FLAGS,
252         ETH_SS_NTUPLE_FILTERS,
253 };
254
255 /* for passing string sets for data tagging */
256 struct ethtool_gstrings {
257         __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];
261 };
262
263 struct 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
274 enum 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*/
280 struct ethtool_test {
281         __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];
286 };
287
288 /* for dumping NIC-specific statistics */
289 struct ethtool_stats {
290         __u32   cmd;            /* ETHTOOL_GSTATS */
291         __u32   n_stats;        /* number of u64's being returned */
292         __u64   data[0];
293 };
294
295 struct ethtool_perm_addr {
296         __u32   cmd;            /* ETHTOOL_GPERMADDR */
297         __u32   size;
298         __u8    data[0];
299 };
300
301 /* 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  */
310 enum ethtool_flags {
311         ETH_FLAG_LRO            = (1 << 15),    /* LRO is enabled */
312         ETH_FLAG_NTUPLE         = (1 << 27),    /* N-tuple filters enabled */
313         ETH_FLAG_RXHASH         = (1 << 28),
314 };
315
316 /* The following structures are for supporting RX network flow
317  * classification and RX n-tuple configuration. Note, all multibyte
318  * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
319  * be in network byte order.
320  */
321
322 /**
323  * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
324  * @ip4src: Source host
325  * @ip4dst: Destination host
326  * @psrc: Source port
327  * @pdst: Destination port
328  * @tos: Type-of-service
329  *
330  * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
331  */
332 struct ethtool_tcpip4_spec {
333         __be32  ip4src;
334         __be32  ip4dst;
335         __be16  psrc;
336         __be16  pdst;
337         __u8    tos;
338 };
339
340 /**
341  * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
342  * @ip4src: Source host
343  * @ip4dst: Destination host
344  * @spi: Security parameters index
345  * @tos: Type-of-service
346  *
347  * This can be used to specify an IPsec transport or tunnel over IPv4.
348  */
349 struct ethtool_ah_espip4_spec {
350         __be32  ip4src;
351         __be32  ip4dst;
352         __be32  spi;
353         __u8    tos;
354 };
355
356 #define ETH_RX_NFC_IP4  1
357
358 /**
359  * struct ethtool_usrip4_spec - general flow specification for IPv4
360  * @ip4src: Source host
361  * @ip4dst: Destination host
362  * @l4_4_bytes: First 4 bytes of transport (layer 4) header
363  * @tos: Type-of-service
364  * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
365  * @proto: Transport protocol number; mask must be 0
366  */
367 struct ethtool_usrip4_spec {
368         __be32  ip4src;
369         __be32  ip4dst;
370         __be32  l4_4_bytes;
371         __u8    tos;
372         __u8    ip_ver;
373         __u8    proto;
374 };
375
376 /**
377  * struct ethtool_rx_flow_spec - specification for RX flow filter
378  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
379  * @h_u: Flow fields to match (dependent on @flow_type)
380  * @m_u: Masks for flow field bits to be ignored
381  * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
382  *      if packets should be discarded
383  * @location: Index of filter in hardware table
384  */
385 struct ethtool_rx_flow_spec {
386         __u32           flow_type;
387         union {
388                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
389                 struct ethtool_tcpip4_spec              udp_ip4_spec;
390                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
391                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
392                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
393                 struct ethtool_usrip4_spec              usr_ip4_spec;
394                 __u8                                    hdata[72];
395         } h_u, m_u;
396         __u64           ring_cookie;
397         __u32           location;
398 };
399
400 /**
401  * struct ethtool_rxnfc - command to get or set RX flow classification rules
402  * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
403  *      %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
404  *      %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
405  * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
406  * @data: Command-dependent value
407  * @fs: Flow filter specification
408  * @rule_cnt: Number of rules to be affected
409  * @rule_locs: Array of valid rule indices
410  *
411  * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
412  * the fields included in the flow hash, e.g. %RXH_IP_SRC.  The following
413  * structure fields must not be used.
414  *
415  * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
416  * on return.
417  *
418  * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
419  * rules on return.
420  *
421  * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an
422  * existing filter rule on entry and @fs contains the rule on return.
423  *
424  * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
425  * user buffer for @rule_locs on entry.  On return, @data is the size
426  * of the filter table and @rule_locs contains the indices of the
427  * defined rules.
428  *
429  * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or
430  * update.  @fs.@location specifies the index to use and must not be
431  * ignored.
432  *
433  * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an
434  * existing filter rule on entry.
435  *
436  * Implementation of indexed classification rules generally requires a
437  * TCAM.
438  */
439 struct ethtool_rxnfc {
440         __u32                           cmd;
441         __u32                           flow_type;
442         __u64                           data;
443         struct ethtool_rx_flow_spec     fs;
444         __u32                           rule_cnt;
445         __u32                           rule_locs[0];
446 };
447
448 /**
449  * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
450  * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
451  * @size: On entry, the array size of the user buffer.  On return from
452  *      %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table.
453  * @ring_index: RX ring/queue index for each hash value
454  */
455 struct ethtool_rxfh_indir {
456         __u32   cmd;
457         __u32   size;
458         __u32   ring_index[0];
459 };
460
461 /**
462  * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
463  * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
464  * @h_u: Flow field values to match (dependent on @flow_type)
465  * @m_u: Masks for flow field value bits to be ignored
466  * @vlan_tag: VLAN tag to match
467  * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
468  * @data: Driver-dependent data to match
469  * @data_mask: Mask for driver-dependent data bits to be ignored
470  * @action: RX ring/queue index to deliver to (non-negative) or other action
471  *      (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
472  *
473  * Zero values in @h_u may be ignored, as if all the corresponding
474  * mask bits were set.
475  */
476 struct ethtool_rx_ntuple_flow_spec {
477         __u32            flow_type;
478         union {
479                 struct ethtool_tcpip4_spec              tcp_ip4_spec;
480                 struct ethtool_tcpip4_spec              udp_ip4_spec;
481                 struct ethtool_tcpip4_spec              sctp_ip4_spec;
482                 struct ethtool_ah_espip4_spec           ah_ip4_spec;
483                 struct ethtool_ah_espip4_spec           esp_ip4_spec;
484                 struct ethtool_usrip4_spec              usr_ip4_spec;
485                 __u8                                    hdata[72];
486         } h_u, m_u;
487
488         __u16           vlan_tag;
489         __u16           vlan_tag_mask;
490         __u64           data;
491         __u64           data_mask;
492
493         __s32           action;
494 #define ETHTOOL_RXNTUPLE_ACTION_DROP -1         /* drop packet */
495 };
496
497 /**
498  * struct ethtool_rx_ntuple - command to set RX flow filter
499  * @cmd: Command number - %ETHTOOL_SRXNTUPLE
500  * @fs: Flow filter specification
501  */
502 struct ethtool_rx_ntuple {
503         __u32                                   cmd;
504         struct ethtool_rx_ntuple_flow_spec      fs;
505 };
506
507 #define ETHTOOL_FLASH_MAX_FILENAME      128
508 enum ethtool_flash_op_type {
509         ETHTOOL_FLASH_ALL_REGIONS       = 0,
510 };
511
512 /* for passing firmware flashing related parameters */
513 struct ethtool_flash {
514         __u32   cmd;
515         __u32   region;
516         char    data[ETHTOOL_FLASH_MAX_FILENAME];
517 };
518
519 #ifdef __KERNEL__
520
521 #include <linux/rculist.h>
522
523 struct ethtool_rx_ntuple_flow_spec_container {
524         struct ethtool_rx_ntuple_flow_spec fs;
525         struct list_head list;
526 };
527
528 struct ethtool_rx_ntuple_list {
529 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
530 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
531         struct list_head        list;
532         unsigned int            count;
533 };
534
535 struct net_device;
536
537 /* Some generic methods drivers may use in their ethtool_ops */
538 u32 ethtool_op_get_link(struct net_device *dev);
539 u32 ethtool_op_get_rx_csum(struct net_device *dev);
540 u32 ethtool_op_get_tx_csum(struct net_device *dev);
541 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
542 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
543 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
544 u32 ethtool_op_get_sg(struct net_device *dev);
545 int ethtool_op_set_sg(struct net_device *dev, u32 data);
546 u32 ethtool_op_get_tso(struct net_device *dev);
547 int ethtool_op_set_tso(struct net_device *dev, u32 data);
548 u32 ethtool_op_get_ufo(struct net_device *dev);
549 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
550 u32 ethtool_op_get_flags(struct net_device *dev);
551 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
552 void ethtool_ntuple_flush(struct net_device *dev);
553
554 /**
555  * &ethtool_ops - Alter and report network device settings
556  * get_settings: Get device-specific settings
557  * set_settings: Set device-specific settings
558  * get_drvinfo: Report driver information
559  * get_regs: Get device registers
560  * get_wol: Report whether Wake-on-Lan is enabled
561  * set_wol: Turn Wake-on-Lan on or off
562  * get_msglevel: Report driver message level
563  * set_msglevel: Set driver message level
564  * nway_reset: Restart autonegotiation
565  * get_link: Get link status
566  * get_eeprom: Read data from the device EEPROM
567  * set_eeprom: Write data to the device EEPROM
568  * get_coalesce: Get interrupt coalescing parameters
569  * set_coalesce: Set interrupt coalescing parameters
570  * get_ringparam: Report ring sizes
571  * set_ringparam: Set ring sizes
572  * get_pauseparam: Report pause parameters
573  * set_pauseparam: Set pause parameters
574  * get_rx_csum: Report whether receive checksums are turned on or off
575  * set_rx_csum: Turn receive checksum on or off
576  * get_tx_csum: Report whether transmit checksums are turned on or off
577  * set_tx_csum: Turn transmit checksums on or off
578  * get_sg: Report whether scatter-gather is enabled
579  * set_sg: Turn scatter-gather on or off
580  * get_tso: Report whether TCP segmentation offload is enabled
581  * set_tso: Turn TCP segmentation offload on or off
582  * get_ufo: Report whether UDP fragmentation offload is enabled
583  * set_ufo: Turn UDP fragmentation offload on or off
584  * self_test: Run specified self-tests
585  * get_strings: Return a set of strings that describe the requested objects
586  * phys_id: Identify the device
587  * get_stats: Return statistics about the device
588  * get_flags: get 32-bit flags bitmap
589  * set_flags: set 32-bit flags bitmap
590  *
591  * Description:
592  *
593  * get_settings:
594  *      @get_settings is passed an &ethtool_cmd to fill in.  It returns
595  *      an negative errno or zero.
596  *
597  * set_settings:
598  *      @set_settings is passed an &ethtool_cmd and should attempt to set
599  *      all the settings this device supports.  It may return an error value
600  *      if something goes wrong (otherwise 0).
601  *
602  * get_eeprom:
603  *      Should fill in the magic field.  Don't need to check len for zero
604  *      or wraparound.  Fill in the data argument with the eeprom values
605  *      from offset to offset + len.  Update len to the amount read.
606  *      Returns an error or zero.
607  *
608  * set_eeprom:
609  *      Should validate the magic field.  Don't need to check len for zero
610  *      or wraparound.  Update len to the amount written.  Returns an error
611  *      or zero.
612  */
613 struct ethtool_ops {
614         int     (*get_settings)(struct net_device *, struct ethtool_cmd *);
615         int     (*set_settings)(struct net_device *, struct ethtool_cmd *);
616         void    (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
617         int     (*get_regs_len)(struct net_device *);
618         void    (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
619         void    (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
620         int     (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
621         u32     (*get_msglevel)(struct net_device *);
622         void    (*set_msglevel)(struct net_device *, u32);
623         int     (*nway_reset)(struct net_device *);
624         u32     (*get_link)(struct net_device *);
625         int     (*get_eeprom_len)(struct net_device *);
626         int     (*get_eeprom)(struct net_device *,
627                               struct ethtool_eeprom *, u8 *);
628         int     (*set_eeprom)(struct net_device *,
629                               struct ethtool_eeprom *, u8 *);
630         int     (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
631         int     (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
632         void    (*get_ringparam)(struct net_device *,
633                                  struct ethtool_ringparam *);
634         int     (*set_ringparam)(struct net_device *,
635                                  struct ethtool_ringparam *);
636         void    (*get_pauseparam)(struct net_device *,
637                                   struct ethtool_pauseparam*);
638         int     (*set_pauseparam)(struct net_device *,
639                                   struct ethtool_pauseparam*);
640         u32     (*get_rx_csum)(struct net_device *);
641         int     (*set_rx_csum)(struct net_device *, u32);
642         u32     (*get_tx_csum)(struct net_device *);
643         int     (*set_tx_csum)(struct net_device *, u32);
644         u32     (*get_sg)(struct net_device *);
645         int     (*set_sg)(struct net_device *, u32);
646         u32     (*get_tso)(struct net_device *);
647         int     (*set_tso)(struct net_device *, u32);
648         void    (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
649         void    (*get_strings)(struct net_device *, u32 stringset, u8 *);
650         int     (*phys_id)(struct net_device *, u32);
651         void    (*get_ethtool_stats)(struct net_device *,
652                                      struct ethtool_stats *, u64 *);
653         int     (*begin)(struct net_device *);
654         void    (*complete)(struct net_device *);
655         u32     (*get_ufo)(struct net_device *);
656         int     (*set_ufo)(struct net_device *, u32);
657         u32     (*get_flags)(struct net_device *);
658         int     (*set_flags)(struct net_device *, u32);
659         u32     (*get_priv_flags)(struct net_device *);
660         int     (*set_priv_flags)(struct net_device *, u32);
661         int     (*get_sset_count)(struct net_device *, int);
662         int     (*get_rxnfc)(struct net_device *,
663                              struct ethtool_rxnfc *, void *);
664         int     (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
665         int     (*flash_device)(struct net_device *, struct ethtool_flash *);
666         int     (*reset)(struct net_device *, u32 *);
667         int     (*set_rx_ntuple)(struct net_device *,
668                                  struct ethtool_rx_ntuple *);
669         int     (*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
670         int     (*get_rxfh_indir)(struct net_device *,
671                                   struct ethtool_rxfh_indir *);
672         int     (*set_rxfh_indir)(struct net_device *,
673                                   const struct ethtool_rxfh_indir *);
674 };
675 #endif /* __KERNEL__ */
676
677 /* CMDs currently supported */
678 #define ETHTOOL_GSET            0x00000001 /* Get settings. */
679 #define ETHTOOL_SSET            0x00000002 /* Set settings. */
680 #define ETHTOOL_GDRVINFO        0x00000003 /* Get driver info. */
681 #define ETHTOOL_GREGS           0x00000004 /* Get NIC registers. */
682 #define ETHTOOL_GWOL            0x00000005 /* Get wake-on-lan options. */
683 #define ETHTOOL_SWOL            0x00000006 /* Set wake-on-lan options. */
684 #define ETHTOOL_GMSGLVL         0x00000007 /* Get driver message level */
685 #define ETHTOOL_SMSGLVL         0x00000008 /* Set driver msg level. */
686 #define ETHTOOL_NWAY_RST        0x00000009 /* Restart autonegotiation. */
687 #define ETHTOOL_GLINK           0x0000000a /* Get link status (ethtool_value) */
688 #define ETHTOOL_GEEPROM         0x0000000b /* Get EEPROM data */
689 #define ETHTOOL_SEEPROM         0x0000000c /* Set EEPROM data. */
690 #define ETHTOOL_GCOALESCE       0x0000000e /* Get coalesce config */
691 #define ETHTOOL_SCOALESCE       0x0000000f /* Set coalesce config. */
692 #define ETHTOOL_GRINGPARAM      0x00000010 /* Get ring parameters */
693 #define ETHTOOL_SRINGPARAM      0x00000011 /* Set ring parameters. */
694 #define ETHTOOL_GPAUSEPARAM     0x00000012 /* Get pause parameters */
695 #define ETHTOOL_SPAUSEPARAM     0x00000013 /* Set pause parameters. */
696 #define ETHTOOL_GRXCSUM         0x00000014 /* Get RX hw csum enable (ethtool_value) */
697 #define ETHTOOL_SRXCSUM         0x00000015 /* Set RX hw csum enable (ethtool_value) */
698 #define ETHTOOL_GTXCSUM         0x00000016 /* Get TX hw csum enable (ethtool_value) */
699 #define ETHTOOL_STXCSUM         0x00000017 /* Set TX hw csum enable (ethtool_value) */
700 #define ETHTOOL_GSG             0x00000018 /* Get scatter-gather enable
701                                             * (ethtool_value) */
702 #define ETHTOOL_SSG             0x00000019 /* Set scatter-gather enable
703                                             * (ethtool_value). */
704 #define ETHTOOL_TEST            0x0000001a /* execute NIC self-test. */
705 #define ETHTOOL_GSTRINGS        0x0000001b /* get specified string set */
706 #define ETHTOOL_PHYS_ID         0x0000001c /* identify the NIC */
707 #define ETHTOOL_GSTATS          0x0000001d /* get NIC-specific statistics */
708 #define ETHTOOL_GTSO            0x0000001e /* Get TSO enable (ethtool_value) */
709 #define ETHTOOL_STSO            0x0000001f /* Set TSO enable (ethtool_value) */
710 #define ETHTOOL_GPERMADDR       0x00000020 /* Get permanent hardware address */
711 #define ETHTOOL_GUFO            0x00000021 /* Get UFO enable (ethtool_value) */
712 #define ETHTOOL_SUFO            0x00000022 /* Set UFO enable (ethtool_value) */
713 #define ETHTOOL_GGSO            0x00000023 /* Get GSO enable (ethtool_value) */
714 #define ETHTOOL_SGSO            0x00000024 /* Set GSO enable (ethtool_value) */
715 #define ETHTOOL_GFLAGS          0x00000025 /* Get flags bitmap(ethtool_value) */
716 #define ETHTOOL_SFLAGS          0x00000026 /* Set flags bitmap(ethtool_value) */
717 #define ETHTOOL_GPFLAGS         0x00000027 /* Get driver-private flags bitmap */
718 #define ETHTOOL_SPFLAGS         0x00000028 /* Set driver-private flags bitmap */
719
720 #define ETHTOOL_GRXFH           0x00000029 /* Get RX flow hash configuration */
721 #define ETHTOOL_SRXFH           0x0000002a /* Set RX flow hash configuration */
722 #define ETHTOOL_GGRO            0x0000002b /* Get GRO enable (ethtool_value) */
723 #define ETHTOOL_SGRO            0x0000002c /* Set GRO enable (ethtool_value) */
724 #define ETHTOOL_GRXRINGS        0x0000002d /* Get RX rings available for LB */
725 #define ETHTOOL_GRXCLSRLCNT     0x0000002e /* Get RX class rule count */
726 #define ETHTOOL_GRXCLSRULE      0x0000002f /* Get RX classification rule */
727 #define ETHTOOL_GRXCLSRLALL     0x00000030 /* Get all RX classification rule */
728 #define ETHTOOL_SRXCLSRLDEL     0x00000031 /* Delete RX classification rule */
729 #define ETHTOOL_SRXCLSRLINS     0x00000032 /* Insert RX classification rule */
730 #define ETHTOOL_FLASHDEV        0x00000033 /* Flash firmware to device */
731 #define ETHTOOL_RESET           0x00000034 /* Reset hardware */
732 #define ETHTOOL_SRXNTUPLE       0x00000035 /* Add an n-tuple filter to device */
733 #define ETHTOOL_GRXNTUPLE       0x00000036 /* Get n-tuple filters from device */
734 #define ETHTOOL_GSSET_INFO      0x00000037 /* Get string set info */
735 #define ETHTOOL_GRXFHINDIR      0x00000038 /* Get RX flow hash indir'n table */
736 #define ETHTOOL_SRXFHINDIR      0x00000039 /* Set RX flow hash indir'n table */
737
738 /* compatibility with older code */
739 #define SPARC_ETH_GSET          ETHTOOL_GSET
740 #define SPARC_ETH_SSET          ETHTOOL_SSET
741
742 /* Indicates what features are supported by the interface. */
743 #define SUPPORTED_10baseT_Half          (1 << 0)
744 #define SUPPORTED_10baseT_Full          (1 << 1)
745 #define SUPPORTED_100baseT_Half         (1 << 2)
746 #define SUPPORTED_100baseT_Full         (1 << 3)
747 #define SUPPORTED_1000baseT_Half        (1 << 4)
748 #define SUPPORTED_1000baseT_Full        (1 << 5)
749 #define SUPPORTED_Autoneg               (1 << 6)
750 #define SUPPORTED_TP                    (1 << 7)
751 #define SUPPORTED_AUI                   (1 << 8)
752 #define SUPPORTED_MII                   (1 << 9)
753 #define SUPPORTED_FIBRE                 (1 << 10)
754 #define SUPPORTED_BNC                   (1 << 11)
755 #define SUPPORTED_10000baseT_Full       (1 << 12)
756 #define SUPPORTED_Pause                 (1 << 13)
757 #define SUPPORTED_Asym_Pause            (1 << 14)
758 #define SUPPORTED_2500baseX_Full        (1 << 15)
759 #define SUPPORTED_Backplane             (1 << 16)
760 #define SUPPORTED_1000baseKX_Full       (1 << 17)
761 #define SUPPORTED_10000baseKX4_Full     (1 << 18)
762 #define SUPPORTED_10000baseKR_Full      (1 << 19)
763 #define SUPPORTED_10000baseR_FEC        (1 << 20)
764
765 /* Indicates what features are advertised by the interface. */
766 #define ADVERTISED_10baseT_Half         (1 << 0)
767 #define ADVERTISED_10baseT_Full         (1 << 1)
768 #define ADVERTISED_100baseT_Half        (1 << 2)
769 #define ADVERTISED_100baseT_Full        (1 << 3)
770 #define ADVERTISED_1000baseT_Half       (1 << 4)
771 #define ADVERTISED_1000baseT_Full       (1 << 5)
772 #define ADVERTISED_Autoneg              (1 << 6)
773 #define ADVERTISED_TP                   (1 << 7)
774 #define ADVERTISED_AUI                  (1 << 8)
775 #define ADVERTISED_MII                  (1 << 9)
776 #define ADVERTISED_FIBRE                (1 << 10)
777 #define ADVERTISED_BNC                  (1 << 11)
778 #define ADVERTISED_10000baseT_Full      (1 << 12)
779 #define ADVERTISED_Pause                (1 << 13)
780 #define ADVERTISED_Asym_Pause           (1 << 14)
781 #define ADVERTISED_2500baseX_Full       (1 << 15)
782 #define ADVERTISED_Backplane            (1 << 16)
783 #define ADVERTISED_1000baseKX_Full      (1 << 17)
784 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
785 #define ADVERTISED_10000baseKR_Full     (1 << 19)
786 #define ADVERTISED_10000baseR_FEC       (1 << 20)
787
788 /* The following are all involved in forcing a particular link
789  * mode for the device for setting things.  When getting the
790  * devices settings, these indicate the current mode and whether
791  * it was foced up into this mode or autonegotiated.
792  */
793
794 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
795 #define SPEED_10                10
796 #define SPEED_100               100
797 #define SPEED_1000              1000
798 #define SPEED_2500              2500
799 #define SPEED_10000             10000
800
801 /* Duplex, half or full. */
802 #define DUPLEX_HALF             0x00
803 #define DUPLEX_FULL             0x01
804
805 /* Which connector port. */
806 #define PORT_TP                 0x00
807 #define PORT_AUI                0x01
808 #define PORT_MII                0x02
809 #define PORT_FIBRE              0x03
810 #define PORT_BNC                0x04
811 #define PORT_DA                 0x05
812 #define PORT_NONE               0xef
813 #define PORT_OTHER              0xff
814
815 /* Which transceiver to use. */
816 #define XCVR_INTERNAL           0x00
817 #define XCVR_EXTERNAL           0x01
818 #define XCVR_DUMMY1             0x02
819 #define XCVR_DUMMY2             0x03
820 #define XCVR_DUMMY3             0x04
821
822 /* Enable or disable autonegotiation.  If this is set to enable,
823  * the forced link modes above are completely ignored.
824  */
825 #define AUTONEG_DISABLE         0x00
826 #define AUTONEG_ENABLE          0x01
827
828 /* Mode MDI or MDI-X */
829 #define ETH_TP_MDI_INVALID      0x00
830 #define ETH_TP_MDI              0x01
831 #define ETH_TP_MDI_X            0x02
832
833 /* Wake-On-Lan options. */
834 #define WAKE_PHY                (1 << 0)
835 #define WAKE_UCAST              (1 << 1)
836 #define WAKE_MCAST              (1 << 2)
837 #define WAKE_BCAST              (1 << 3)
838 #define WAKE_ARP                (1 << 4)
839 #define WAKE_MAGIC              (1 << 5)
840 #define WAKE_MAGICSECURE        (1 << 6) /* only meaningful if WAKE_MAGIC */
841
842 /* L3-L4 network traffic flow types */
843 #define TCP_V4_FLOW     0x01
844 #define UDP_V4_FLOW     0x02
845 #define SCTP_V4_FLOW    0x03
846 #define AH_ESP_V4_FLOW  0x04
847 #define TCP_V6_FLOW     0x05
848 #define UDP_V6_FLOW     0x06
849 #define SCTP_V6_FLOW    0x07
850 #define AH_ESP_V6_FLOW  0x08
851 #define AH_V4_FLOW      0x09
852 #define ESP_V4_FLOW     0x0a
853 #define AH_V6_FLOW      0x0b
854 #define ESP_V6_FLOW     0x0c
855 #define IP_USER_FLOW    0x0d
856 #define IPV4_FLOW       0x10
857 #define IPV6_FLOW       0x11
858
859 /* L3-L4 network traffic flow hash options */
860 #define RXH_L2DA        (1 << 1)
861 #define RXH_VLAN        (1 << 2)
862 #define RXH_L3_PROTO    (1 << 3)
863 #define RXH_IP_SRC      (1 << 4)
864 #define RXH_IP_DST      (1 << 5)
865 #define RXH_L4_B_0_1    (1 << 6) /* src port in case of TCP/UDP/SCTP */
866 #define RXH_L4_B_2_3    (1 << 7) /* dst port in case of TCP/UDP/SCTP */
867 #define RXH_DISCARD     (1 << 31)
868
869 #define RX_CLS_FLOW_DISC        0xffffffffffffffffULL
870
871 /* Reset flags */
872 /* The reset() operation must clear the flags for the components which
873  * were actually reset.  On successful return, the flags indicate the
874  * components which were not reset, either because they do not exist
875  * in the hardware or because they cannot be reset independently.  The
876  * driver must never reset any components that were not requested.
877  */
878 enum ethtool_reset_flags {
879         /* These flags represent components dedicated to the interface
880          * the command is addressed to.  Shift any flag left by
881          * ETH_RESET_SHARED_SHIFT to reset a shared component of the
882          * same type.
883          */
884         ETH_RESET_MGMT          = 1 << 0,       /* Management processor */
885         ETH_RESET_IRQ           = 1 << 1,       /* Interrupt requester */
886         ETH_RESET_DMA           = 1 << 2,       /* DMA engine */
887         ETH_RESET_FILTER        = 1 << 3,       /* Filtering/flow direction */
888         ETH_RESET_OFFLOAD       = 1 << 4,       /* Protocol offload */
889         ETH_RESET_MAC           = 1 << 5,       /* Media access controller */
890         ETH_RESET_PHY           = 1 << 6,       /* Transceiver/PHY */
891         ETH_RESET_RAM           = 1 << 7,       /* RAM shared between
892                                                  * multiple components */
893
894         ETH_RESET_DEDICATED     = 0x0000ffff,   /* All components dedicated to
895                                                  * this interface */
896         ETH_RESET_ALL           = 0xffffffff,   /* All components used by this
897                                                  * interface, even if shared */
898 };
899 #define ETH_RESET_SHARED_SHIFT  16
900
901 #endif /* _LINUX_ETHTOOL_H */