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