xref: /linux-6.15/include/linux/ethtool.h (revision cdb13808)
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 #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 configuration. Note, all multibyte fields, e.g.,
318  * ip4src, ip4dst, psrc, pdst, spi, etc. are expected to be in network
319  * byte order.
320  */
321 struct ethtool_tcpip4_spec {
322 	__be32	ip4src;
323 	__be32	ip4dst;
324 	__be16	psrc;
325 	__be16	pdst;
326 	__u8    tos;
327 };
328 
329 struct ethtool_ah_espip4_spec {
330 	__be32	ip4src;
331 	__be32	ip4dst;
332 	__be32	spi;
333 	__u8    tos;
334 };
335 
336 struct ethtool_rawip4_spec {
337 	__be32	ip4src;
338 	__be32	ip4dst;
339 	__u8	hdata[64];
340 };
341 
342 struct ethtool_ether_spec {
343 	__be16	ether_type;
344 	__u8	frame_size;
345 	__u8	eframe[16];
346 };
347 
348 #define	ETH_RX_NFC_IP4	1
349 #define	ETH_RX_NFC_IP6	2
350 
351 struct ethtool_usrip4_spec {
352 	__be32	ip4src;
353 	__be32	ip4dst;
354 	__be32	l4_4_bytes;
355 	__u8    tos;
356 	__u8    ip_ver;
357 	__u8    proto;
358 };
359 
360 struct ethtool_rx_flow_spec {
361 	__u32		flow_type;
362 	union {
363 		struct ethtool_tcpip4_spec		tcp_ip4_spec;
364 		struct ethtool_tcpip4_spec		udp_ip4_spec;
365 		struct ethtool_tcpip4_spec		sctp_ip4_spec;
366 		struct ethtool_ah_espip4_spec		ah_ip4_spec;
367 		struct ethtool_ah_espip4_spec		esp_ip4_spec;
368 		struct ethtool_rawip4_spec		raw_ip4_spec;
369 		struct ethtool_ether_spec		ether_spec;
370 		struct ethtool_usrip4_spec		usr_ip4_spec;
371 		__u8					hdata[64];
372 	} h_u, m_u; /* entry, mask */
373 	__u64		ring_cookie;
374 	__u32		location;
375 };
376 
377 struct ethtool_rxnfc {
378 	__u32				cmd;
379 	__u32				flow_type;
380 	/* The rx flow hash value or the rule DB size */
381 	__u64				data;
382 	/* The following fields are not valid and must not be used for
383 	 * the ETHTOOL_{G,X}RXFH commands. */
384 	struct ethtool_rx_flow_spec	fs;
385 	__u32				rule_cnt;
386 	__u32				rule_locs[0];
387 };
388 
389 struct ethtool_rxfh_indir {
390 	__u32	cmd;
391 	/* On entry, this is the array size of the user buffer.  On
392 	 * return from ETHTOOL_GRXFHINDIR, this is the array size of
393 	 * the hardware indirection table. */
394 	__u32	size;
395 	__u32	ring_index[0];	/* ring/queue index for each hash value */
396 };
397 
398 struct ethtool_rx_ntuple_flow_spec {
399 	__u32		 flow_type;
400 	union {
401 		struct ethtool_tcpip4_spec		tcp_ip4_spec;
402 		struct ethtool_tcpip4_spec		udp_ip4_spec;
403 		struct ethtool_tcpip4_spec		sctp_ip4_spec;
404 		struct ethtool_ah_espip4_spec		ah_ip4_spec;
405 		struct ethtool_ah_espip4_spec		esp_ip4_spec;
406 		struct ethtool_rawip4_spec		raw_ip4_spec;
407 		struct ethtool_ether_spec		ether_spec;
408 		struct ethtool_usrip4_spec		usr_ip4_spec;
409 		__u8					hdata[64];
410 	} h_u, m_u; /* entry, mask */
411 
412 	__u16	        vlan_tag;
413 	__u16	        vlan_tag_mask;
414 	__u64		data;      /* user-defined flow spec data */
415 	__u64		data_mask; /* user-defined flow spec mask */
416 
417 	/* signed to distinguish between queue and actions (DROP) */
418 	__s32		action;
419 #define ETHTOOL_RXNTUPLE_ACTION_DROP -1
420 };
421 
422 struct ethtool_rx_ntuple {
423 	__u32					cmd;
424 	struct ethtool_rx_ntuple_flow_spec	fs;
425 };
426 
427 #define ETHTOOL_FLASH_MAX_FILENAME	128
428 enum ethtool_flash_op_type {
429 	ETHTOOL_FLASH_ALL_REGIONS	= 0,
430 };
431 
432 /* for passing firmware flashing related parameters */
433 struct ethtool_flash {
434 	__u32	cmd;
435 	__u32	region;
436 	char	data[ETHTOOL_FLASH_MAX_FILENAME];
437 };
438 
439 #ifdef __KERNEL__
440 
441 #include <linux/rculist.h>
442 
443 struct ethtool_rx_ntuple_flow_spec_container {
444 	struct ethtool_rx_ntuple_flow_spec fs;
445 	struct list_head list;
446 };
447 
448 struct ethtool_rx_ntuple_list {
449 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024
450 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14
451 	struct list_head	list;
452 	unsigned int		count;
453 };
454 
455 struct net_device;
456 
457 /* Some generic methods drivers may use in their ethtool_ops */
458 u32 ethtool_op_get_link(struct net_device *dev);
459 u32 ethtool_op_get_rx_csum(struct net_device *dev);
460 u32 ethtool_op_get_tx_csum(struct net_device *dev);
461 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
462 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
463 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data);
464 u32 ethtool_op_get_sg(struct net_device *dev);
465 int ethtool_op_set_sg(struct net_device *dev, u32 data);
466 u32 ethtool_op_get_tso(struct net_device *dev);
467 int ethtool_op_set_tso(struct net_device *dev, u32 data);
468 u32 ethtool_op_get_ufo(struct net_device *dev);
469 int ethtool_op_set_ufo(struct net_device *dev, u32 data);
470 u32 ethtool_op_get_flags(struct net_device *dev);
471 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported);
472 void ethtool_ntuple_flush(struct net_device *dev);
473 
474 /**
475  * &ethtool_ops - Alter and report network device settings
476  * get_settings: Get device-specific settings
477  * set_settings: Set device-specific settings
478  * get_drvinfo: Report driver information
479  * get_regs: Get device registers
480  * get_wol: Report whether Wake-on-Lan is enabled
481  * set_wol: Turn Wake-on-Lan on or off
482  * get_msglevel: Report driver message level
483  * set_msglevel: Set driver message level
484  * nway_reset: Restart autonegotiation
485  * get_link: Get link status
486  * get_eeprom: Read data from the device EEPROM
487  * set_eeprom: Write data to the device EEPROM
488  * get_coalesce: Get interrupt coalescing parameters
489  * set_coalesce: Set interrupt coalescing parameters
490  * get_ringparam: Report ring sizes
491  * set_ringparam: Set ring sizes
492  * get_pauseparam: Report pause parameters
493  * set_pauseparam: Set pause parameters
494  * get_rx_csum: Report whether receive checksums are turned on or off
495  * set_rx_csum: Turn receive checksum on or off
496  * get_tx_csum: Report whether transmit checksums are turned on or off
497  * set_tx_csum: Turn transmit checksums on or off
498  * get_sg: Report whether scatter-gather is enabled
499  * set_sg: Turn scatter-gather on or off
500  * get_tso: Report whether TCP segmentation offload is enabled
501  * set_tso: Turn TCP segmentation offload on or off
502  * get_ufo: Report whether UDP fragmentation offload is enabled
503  * set_ufo: Turn UDP fragmentation offload on or off
504  * self_test: Run specified self-tests
505  * get_strings: Return a set of strings that describe the requested objects
506  * phys_id: Identify the device
507  * get_stats: Return statistics about the device
508  * get_flags: get 32-bit flags bitmap
509  * set_flags: set 32-bit flags bitmap
510  *
511  * Description:
512  *
513  * get_settings:
514  *	@get_settings is passed an &ethtool_cmd to fill in.  It returns
515  *	an negative errno or zero.
516  *
517  * set_settings:
518  *	@set_settings is passed an &ethtool_cmd and should attempt to set
519  *	all the settings this device supports.  It may return an error value
520  *	if something goes wrong (otherwise 0).
521  *
522  * get_eeprom:
523  *	Should fill in the magic field.  Don't need to check len for zero
524  *	or wraparound.  Fill in the data argument with the eeprom values
525  *	from offset to offset + len.  Update len to the amount read.
526  *	Returns an error or zero.
527  *
528  * set_eeprom:
529  *	Should validate the magic field.  Don't need to check len for zero
530  *	or wraparound.  Update len to the amount written.  Returns an error
531  *	or zero.
532  */
533 struct ethtool_ops {
534 	int	(*get_settings)(struct net_device *, struct ethtool_cmd *);
535 	int	(*set_settings)(struct net_device *, struct ethtool_cmd *);
536 	void	(*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
537 	int	(*get_regs_len)(struct net_device *);
538 	void	(*get_regs)(struct net_device *, struct ethtool_regs *, void *);
539 	void	(*get_wol)(struct net_device *, struct ethtool_wolinfo *);
540 	int	(*set_wol)(struct net_device *, struct ethtool_wolinfo *);
541 	u32	(*get_msglevel)(struct net_device *);
542 	void	(*set_msglevel)(struct net_device *, u32);
543 	int	(*nway_reset)(struct net_device *);
544 	u32	(*get_link)(struct net_device *);
545 	int	(*get_eeprom_len)(struct net_device *);
546 	int	(*get_eeprom)(struct net_device *,
547 			      struct ethtool_eeprom *, u8 *);
548 	int	(*set_eeprom)(struct net_device *,
549 			      struct ethtool_eeprom *, u8 *);
550 	int	(*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
551 	int	(*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
552 	void	(*get_ringparam)(struct net_device *,
553 				 struct ethtool_ringparam *);
554 	int	(*set_ringparam)(struct net_device *,
555 				 struct ethtool_ringparam *);
556 	void	(*get_pauseparam)(struct net_device *,
557 				  struct ethtool_pauseparam*);
558 	int	(*set_pauseparam)(struct net_device *,
559 				  struct ethtool_pauseparam*);
560 	u32	(*get_rx_csum)(struct net_device *);
561 	int	(*set_rx_csum)(struct net_device *, u32);
562 	u32	(*get_tx_csum)(struct net_device *);
563 	int	(*set_tx_csum)(struct net_device *, u32);
564 	u32	(*get_sg)(struct net_device *);
565 	int	(*set_sg)(struct net_device *, u32);
566 	u32	(*get_tso)(struct net_device *);
567 	int	(*set_tso)(struct net_device *, u32);
568 	void	(*self_test)(struct net_device *, struct ethtool_test *, u64 *);
569 	void	(*get_strings)(struct net_device *, u32 stringset, u8 *);
570 	int	(*phys_id)(struct net_device *, u32);
571 	void	(*get_ethtool_stats)(struct net_device *,
572 				     struct ethtool_stats *, u64 *);
573 	int	(*begin)(struct net_device *);
574 	void	(*complete)(struct net_device *);
575 	u32	(*get_ufo)(struct net_device *);
576 	int	(*set_ufo)(struct net_device *, u32);
577 	u32	(*get_flags)(struct net_device *);
578 	int	(*set_flags)(struct net_device *, u32);
579 	u32	(*get_priv_flags)(struct net_device *);
580 	int	(*set_priv_flags)(struct net_device *, u32);
581 	int	(*get_sset_count)(struct net_device *, int);
582 	int	(*get_rxnfc)(struct net_device *,
583 			     struct ethtool_rxnfc *, void *);
584 	int	(*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
585 	int	(*flash_device)(struct net_device *, struct ethtool_flash *);
586 	int	(*reset)(struct net_device *, u32 *);
587 	int	(*set_rx_ntuple)(struct net_device *,
588 				 struct ethtool_rx_ntuple *);
589 	int	(*get_rx_ntuple)(struct net_device *, u32 stringset, void *);
590 	int	(*get_rxfh_indir)(struct net_device *,
591 				  struct ethtool_rxfh_indir *);
592 	int	(*set_rxfh_indir)(struct net_device *,
593 				  const struct ethtool_rxfh_indir *);
594 };
595 #endif /* __KERNEL__ */
596 
597 /* CMDs currently supported */
598 #define ETHTOOL_GSET		0x00000001 /* Get settings. */
599 #define ETHTOOL_SSET		0x00000002 /* Set settings. */
600 #define ETHTOOL_GDRVINFO	0x00000003 /* Get driver info. */
601 #define ETHTOOL_GREGS		0x00000004 /* Get NIC registers. */
602 #define ETHTOOL_GWOL		0x00000005 /* Get wake-on-lan options. */
603 #define ETHTOOL_SWOL		0x00000006 /* Set wake-on-lan options. */
604 #define ETHTOOL_GMSGLVL		0x00000007 /* Get driver message level */
605 #define ETHTOOL_SMSGLVL		0x00000008 /* Set driver msg level. */
606 #define ETHTOOL_NWAY_RST	0x00000009 /* Restart autonegotiation. */
607 #define ETHTOOL_GLINK		0x0000000a /* Get link status (ethtool_value) */
608 #define ETHTOOL_GEEPROM		0x0000000b /* Get EEPROM data */
609 #define ETHTOOL_SEEPROM		0x0000000c /* Set EEPROM data. */
610 #define ETHTOOL_GCOALESCE	0x0000000e /* Get coalesce config */
611 #define ETHTOOL_SCOALESCE	0x0000000f /* Set coalesce config. */
612 #define ETHTOOL_GRINGPARAM	0x00000010 /* Get ring parameters */
613 #define ETHTOOL_SRINGPARAM	0x00000011 /* Set ring parameters. */
614 #define ETHTOOL_GPAUSEPARAM	0x00000012 /* Get pause parameters */
615 #define ETHTOOL_SPAUSEPARAM	0x00000013 /* Set pause parameters. */
616 #define ETHTOOL_GRXCSUM		0x00000014 /* Get RX hw csum enable (ethtool_value) */
617 #define ETHTOOL_SRXCSUM		0x00000015 /* Set RX hw csum enable (ethtool_value) */
618 #define ETHTOOL_GTXCSUM		0x00000016 /* Get TX hw csum enable (ethtool_value) */
619 #define ETHTOOL_STXCSUM		0x00000017 /* Set TX hw csum enable (ethtool_value) */
620 #define ETHTOOL_GSG		0x00000018 /* Get scatter-gather enable
621 					    * (ethtool_value) */
622 #define ETHTOOL_SSG		0x00000019 /* Set scatter-gather enable
623 					    * (ethtool_value). */
624 #define ETHTOOL_TEST		0x0000001a /* execute NIC self-test. */
625 #define ETHTOOL_GSTRINGS	0x0000001b /* get specified string set */
626 #define ETHTOOL_PHYS_ID		0x0000001c /* identify the NIC */
627 #define ETHTOOL_GSTATS		0x0000001d /* get NIC-specific statistics */
628 #define ETHTOOL_GTSO		0x0000001e /* Get TSO enable (ethtool_value) */
629 #define ETHTOOL_STSO		0x0000001f /* Set TSO enable (ethtool_value) */
630 #define ETHTOOL_GPERMADDR	0x00000020 /* Get permanent hardware address */
631 #define ETHTOOL_GUFO		0x00000021 /* Get UFO enable (ethtool_value) */
632 #define ETHTOOL_SUFO		0x00000022 /* Set UFO enable (ethtool_value) */
633 #define ETHTOOL_GGSO		0x00000023 /* Get GSO enable (ethtool_value) */
634 #define ETHTOOL_SGSO		0x00000024 /* Set GSO enable (ethtool_value) */
635 #define ETHTOOL_GFLAGS		0x00000025 /* Get flags bitmap(ethtool_value) */
636 #define ETHTOOL_SFLAGS		0x00000026 /* Set flags bitmap(ethtool_value) */
637 #define ETHTOOL_GPFLAGS		0x00000027 /* Get driver-private flags bitmap */
638 #define ETHTOOL_SPFLAGS		0x00000028 /* Set driver-private flags bitmap */
639 
640 #define ETHTOOL_GRXFH		0x00000029 /* Get RX flow hash configuration */
641 #define ETHTOOL_SRXFH		0x0000002a /* Set RX flow hash configuration */
642 #define ETHTOOL_GGRO		0x0000002b /* Get GRO enable (ethtool_value) */
643 #define ETHTOOL_SGRO		0x0000002c /* Set GRO enable (ethtool_value) */
644 #define ETHTOOL_GRXRINGS	0x0000002d /* Get RX rings available for LB */
645 #define ETHTOOL_GRXCLSRLCNT	0x0000002e /* Get RX class rule count */
646 #define ETHTOOL_GRXCLSRULE	0x0000002f /* Get RX classification rule */
647 #define ETHTOOL_GRXCLSRLALL	0x00000030 /* Get all RX classification rule */
648 #define ETHTOOL_SRXCLSRLDEL	0x00000031 /* Delete RX classification rule */
649 #define ETHTOOL_SRXCLSRLINS	0x00000032 /* Insert RX classification rule */
650 #define ETHTOOL_FLASHDEV	0x00000033 /* Flash firmware to device */
651 #define ETHTOOL_RESET		0x00000034 /* Reset hardware */
652 #define ETHTOOL_SRXNTUPLE	0x00000035 /* Add an n-tuple filter to device */
653 #define ETHTOOL_GRXNTUPLE	0x00000036 /* Get n-tuple filters from device */
654 #define ETHTOOL_GSSET_INFO	0x00000037 /* Get string set info */
655 #define ETHTOOL_GRXFHINDIR	0x00000038 /* Get RX flow hash indir'n table */
656 #define ETHTOOL_SRXFHINDIR	0x00000039 /* Set RX flow hash indir'n table */
657 
658 /* compatibility with older code */
659 #define SPARC_ETH_GSET		ETHTOOL_GSET
660 #define SPARC_ETH_SSET		ETHTOOL_SSET
661 
662 /* Indicates what features are supported by the interface. */
663 #define SUPPORTED_10baseT_Half		(1 << 0)
664 #define SUPPORTED_10baseT_Full		(1 << 1)
665 #define SUPPORTED_100baseT_Half		(1 << 2)
666 #define SUPPORTED_100baseT_Full		(1 << 3)
667 #define SUPPORTED_1000baseT_Half	(1 << 4)
668 #define SUPPORTED_1000baseT_Full	(1 << 5)
669 #define SUPPORTED_Autoneg		(1 << 6)
670 #define SUPPORTED_TP			(1 << 7)
671 #define SUPPORTED_AUI			(1 << 8)
672 #define SUPPORTED_MII			(1 << 9)
673 #define SUPPORTED_FIBRE			(1 << 10)
674 #define SUPPORTED_BNC			(1 << 11)
675 #define SUPPORTED_10000baseT_Full	(1 << 12)
676 #define SUPPORTED_Pause			(1 << 13)
677 #define SUPPORTED_Asym_Pause		(1 << 14)
678 #define SUPPORTED_2500baseX_Full	(1 << 15)
679 #define SUPPORTED_Backplane		(1 << 16)
680 #define SUPPORTED_1000baseKX_Full	(1 << 17)
681 #define SUPPORTED_10000baseKX4_Full	(1 << 18)
682 #define SUPPORTED_10000baseKR_Full	(1 << 19)
683 #define SUPPORTED_10000baseR_FEC	(1 << 20)
684 
685 /* Indicates what features are advertised by the interface. */
686 #define ADVERTISED_10baseT_Half		(1 << 0)
687 #define ADVERTISED_10baseT_Full		(1 << 1)
688 #define ADVERTISED_100baseT_Half	(1 << 2)
689 #define ADVERTISED_100baseT_Full	(1 << 3)
690 #define ADVERTISED_1000baseT_Half	(1 << 4)
691 #define ADVERTISED_1000baseT_Full	(1 << 5)
692 #define ADVERTISED_Autoneg		(1 << 6)
693 #define ADVERTISED_TP			(1 << 7)
694 #define ADVERTISED_AUI			(1 << 8)
695 #define ADVERTISED_MII			(1 << 9)
696 #define ADVERTISED_FIBRE		(1 << 10)
697 #define ADVERTISED_BNC			(1 << 11)
698 #define ADVERTISED_10000baseT_Full	(1 << 12)
699 #define ADVERTISED_Pause		(1 << 13)
700 #define ADVERTISED_Asym_Pause		(1 << 14)
701 #define ADVERTISED_2500baseX_Full	(1 << 15)
702 #define ADVERTISED_Backplane		(1 << 16)
703 #define ADVERTISED_1000baseKX_Full	(1 << 17)
704 #define ADVERTISED_10000baseKX4_Full	(1 << 18)
705 #define ADVERTISED_10000baseKR_Full	(1 << 19)
706 #define ADVERTISED_10000baseR_FEC	(1 << 20)
707 
708 /* The following are all involved in forcing a particular link
709  * mode for the device for setting things.  When getting the
710  * devices settings, these indicate the current mode and whether
711  * it was foced up into this mode or autonegotiated.
712  */
713 
714 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
715 #define SPEED_10		10
716 #define SPEED_100		100
717 #define SPEED_1000		1000
718 #define SPEED_2500		2500
719 #define SPEED_10000		10000
720 
721 /* Duplex, half or full. */
722 #define DUPLEX_HALF		0x00
723 #define DUPLEX_FULL		0x01
724 
725 /* Which connector port. */
726 #define PORT_TP			0x00
727 #define PORT_AUI		0x01
728 #define PORT_MII		0x02
729 #define PORT_FIBRE		0x03
730 #define PORT_BNC		0x04
731 #define PORT_DA			0x05
732 #define PORT_NONE		0xef
733 #define PORT_OTHER		0xff
734 
735 /* Which transceiver to use. */
736 #define XCVR_INTERNAL		0x00
737 #define XCVR_EXTERNAL		0x01
738 #define XCVR_DUMMY1		0x02
739 #define XCVR_DUMMY2		0x03
740 #define XCVR_DUMMY3		0x04
741 
742 /* Enable or disable autonegotiation.  If this is set to enable,
743  * the forced link modes above are completely ignored.
744  */
745 #define AUTONEG_DISABLE		0x00
746 #define AUTONEG_ENABLE		0x01
747 
748 /* Mode MDI or MDI-X */
749 #define ETH_TP_MDI_INVALID	0x00
750 #define ETH_TP_MDI		0x01
751 #define ETH_TP_MDI_X		0x02
752 
753 /* Wake-On-Lan options. */
754 #define WAKE_PHY		(1 << 0)
755 #define WAKE_UCAST		(1 << 1)
756 #define WAKE_MCAST		(1 << 2)
757 #define WAKE_BCAST		(1 << 3)
758 #define WAKE_ARP		(1 << 4)
759 #define WAKE_MAGIC		(1 << 5)
760 #define WAKE_MAGICSECURE	(1 << 6) /* only meaningful if WAKE_MAGIC */
761 
762 /* L3-L4 network traffic flow types */
763 #define	TCP_V4_FLOW	0x01
764 #define	UDP_V4_FLOW	0x02
765 #define	SCTP_V4_FLOW	0x03
766 #define	AH_ESP_V4_FLOW	0x04
767 #define	TCP_V6_FLOW	0x05
768 #define	UDP_V6_FLOW	0x06
769 #define	SCTP_V6_FLOW	0x07
770 #define	AH_ESP_V6_FLOW	0x08
771 #define	AH_V4_FLOW	0x09
772 #define	ESP_V4_FLOW	0x0a
773 #define	AH_V6_FLOW	0x0b
774 #define	ESP_V6_FLOW	0x0c
775 #define	IP_USER_FLOW	0x0d
776 #define	IPV4_FLOW	0x10
777 #define	IPV6_FLOW	0x11
778 
779 /* L3-L4 network traffic flow hash options */
780 #define	RXH_L2DA	(1 << 1)
781 #define	RXH_VLAN	(1 << 2)
782 #define	RXH_L3_PROTO	(1 << 3)
783 #define	RXH_IP_SRC	(1 << 4)
784 #define	RXH_IP_DST	(1 << 5)
785 #define	RXH_L4_B_0_1	(1 << 6) /* src port in case of TCP/UDP/SCTP */
786 #define	RXH_L4_B_2_3	(1 << 7) /* dst port in case of TCP/UDP/SCTP */
787 #define	RXH_DISCARD	(1 << 31)
788 
789 #define	RX_CLS_FLOW_DISC	0xffffffffffffffffULL
790 
791 /* Reset flags */
792 /* The reset() operation must clear the flags for the components which
793  * were actually reset.  On successful return, the flags indicate the
794  * components which were not reset, either because they do not exist
795  * in the hardware or because they cannot be reset independently.  The
796  * driver must never reset any components that were not requested.
797  */
798 enum ethtool_reset_flags {
799 	/* These flags represent components dedicated to the interface
800 	 * the command is addressed to.  Shift any flag left by
801 	 * ETH_RESET_SHARED_SHIFT to reset a shared component of the
802 	 * same type.
803 	 */
804 	ETH_RESET_MGMT		= 1 << 0,	/* Management processor */
805 	ETH_RESET_IRQ		= 1 << 1,	/* Interrupt requester */
806 	ETH_RESET_DMA		= 1 << 2,	/* DMA engine */
807 	ETH_RESET_FILTER	= 1 << 3,	/* Filtering/flow direction */
808 	ETH_RESET_OFFLOAD	= 1 << 4,	/* Protocol offload */
809 	ETH_RESET_MAC		= 1 << 5,	/* Media access controller */
810 	ETH_RESET_PHY		= 1 << 6,	/* Transceiver/PHY */
811 	ETH_RESET_RAM		= 1 << 7,	/* RAM shared between
812 						 * multiple components */
813 
814 	ETH_RESET_DEDICATED	= 0x0000ffff,	/* All components dedicated to
815 						 * this interface */
816 	ETH_RESET_ALL		= 0xffffffff,	/* All components used by this
817 						 * interface, even if shared */
818 };
819 #define ETH_RESET_SHARED_SHIFT	16
820 
821 #endif /* _LINUX_ETHTOOL_H */
822