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