xref: /openbmc/linux/include/linux/ethtool.h (revision 84b102f5)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * ethtool.h: Defines for Linux ethtool.
4  *
5  * Copyright (C) 1998 David S. Miller (davem@redhat.com)
6  * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
7  * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
8  * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
9  *                                christopher.leech@intel.com,
10  *                                scott.feldman@intel.com)
11  * Portions Copyright (C) Sun Microsystems 2008
12  */
13 #ifndef _LINUX_ETHTOOL_H
14 #define _LINUX_ETHTOOL_H
15 
16 #include <linux/bitmap.h>
17 #include <linux/compat.h>
18 #include <uapi/linux/ethtool.h>
19 
20 #ifdef CONFIG_COMPAT
21 
22 struct compat_ethtool_rx_flow_spec {
23 	u32		flow_type;
24 	union ethtool_flow_union h_u;
25 	struct ethtool_flow_ext h_ext;
26 	union ethtool_flow_union m_u;
27 	struct ethtool_flow_ext m_ext;
28 	compat_u64	ring_cookie;
29 	u32		location;
30 };
31 
32 struct compat_ethtool_rxnfc {
33 	u32				cmd;
34 	u32				flow_type;
35 	compat_u64			data;
36 	struct compat_ethtool_rx_flow_spec fs;
37 	u32				rule_cnt;
38 	u32				rule_locs[];
39 };
40 
41 #endif /* CONFIG_COMPAT */
42 
43 #include <linux/rculist.h>
44 
45 /**
46  * enum ethtool_phys_id_state - indicator state for physical identification
47  * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
48  * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
49  * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
50  *	is not supported)
51  * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
52  *	is not supported)
53  */
54 enum ethtool_phys_id_state {
55 	ETHTOOL_ID_INACTIVE,
56 	ETHTOOL_ID_ACTIVE,
57 	ETHTOOL_ID_ON,
58 	ETHTOOL_ID_OFF
59 };
60 
61 enum {
62 	ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
63 	ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
64 	ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */
65 
66 	/*
67 	 * Add your fresh new hash function bits above and remember to update
68 	 * rss_hash_func_strings[] in ethtool.c
69 	 */
70 	ETH_RSS_HASH_FUNCS_COUNT
71 };
72 
73 #define __ETH_RSS_HASH_BIT(bit)	((u32)1 << (bit))
74 #define __ETH_RSS_HASH(name)	__ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
75 
76 #define ETH_RSS_HASH_TOP	__ETH_RSS_HASH(TOP)
77 #define ETH_RSS_HASH_XOR	__ETH_RSS_HASH(XOR)
78 #define ETH_RSS_HASH_CRC32	__ETH_RSS_HASH(CRC32)
79 
80 #define ETH_RSS_HASH_UNKNOWN	0
81 #define ETH_RSS_HASH_NO_CHANGE	0
82 
83 struct net_device;
84 
85 /* Some generic methods drivers may use in their ethtool_ops */
86 u32 ethtool_op_get_link(struct net_device *dev);
87 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
88 
89 
90 /**
91  * struct ethtool_link_ext_state_info - link extended state and substate.
92  */
93 struct ethtool_link_ext_state_info {
94 	enum ethtool_link_ext_state link_ext_state;
95 	union {
96 		enum ethtool_link_ext_substate_autoneg autoneg;
97 		enum ethtool_link_ext_substate_link_training link_training;
98 		enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch;
99 		enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity;
100 		enum ethtool_link_ext_substate_cable_issue cable_issue;
101 		u8 __link_ext_substate;
102 	};
103 };
104 
105 /**
106  * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
107  * @index: Index in RX flow hash indirection table
108  * @n_rx_rings: Number of RX rings to use
109  *
110  * This function provides the default policy for RX flow hash indirection.
111  */
112 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
113 {
114 	return index % n_rx_rings;
115 }
116 
117 /* declare a link mode bitmap */
118 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name)		\
119 	DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
120 
121 /* drivers must ignore base.cmd and base.link_mode_masks_nwords
122  * fields, but they are allowed to overwrite them (will be ignored).
123  */
124 struct ethtool_link_ksettings {
125 	struct ethtool_link_settings base;
126 	struct {
127 		__ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
128 		__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
129 		__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
130 	} link_modes;
131 };
132 
133 /**
134  * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
135  *   @ptr : pointer to struct ethtool_link_ksettings
136  *   @name : one of supported/advertising/lp_advertising
137  */
138 #define ethtool_link_ksettings_zero_link_mode(ptr, name)		\
139 	bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
140 
141 /**
142  * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
143  * link mode mask
144  *   @ptr : pointer to struct ethtool_link_ksettings
145  *   @name : one of supported/advertising/lp_advertising
146  *   @mode : one of the ETHTOOL_LINK_MODE_*_BIT
147  * (not atomic, no bound checking)
148  */
149 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode)		\
150 	__set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
151 
152 /**
153  * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
154  * link mode mask
155  *   @ptr : pointer to struct ethtool_link_ksettings
156  *   @name : one of supported/advertising/lp_advertising
157  *   @mode : one of the ETHTOOL_LINK_MODE_*_BIT
158  * (not atomic, no bound checking)
159  */
160 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode)		\
161 	__clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
162 
163 /**
164  * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask
165  *   @ptr : pointer to struct ethtool_link_ksettings
166  *   @name : one of supported/advertising/lp_advertising
167  *   @mode : one of the ETHTOOL_LINK_MODE_*_BIT
168  * (not atomic, no bound checking)
169  *
170  * Returns true/false.
171  */
172 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode)		\
173 	test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
174 
175 extern int
176 __ethtool_get_link_ksettings(struct net_device *dev,
177 			     struct ethtool_link_ksettings *link_ksettings);
178 
179 /**
180  * ethtool_intersect_link_masks - Given two link masks, AND them together
181  * @dst: first mask and where result is stored
182  * @src: second mask to intersect with
183  *
184  * Given two link mode masks, AND them together and save the result in dst.
185  */
186 void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
187 				  struct ethtool_link_ksettings *src);
188 
189 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst,
190 					     u32 legacy_u32);
191 
192 /* return false if src had higher bits set. lower bits always updated. */
193 bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
194 				     const unsigned long *src);
195 
196 #define ETHTOOL_COALESCE_RX_USECS		BIT(0)
197 #define ETHTOOL_COALESCE_RX_MAX_FRAMES		BIT(1)
198 #define ETHTOOL_COALESCE_RX_USECS_IRQ		BIT(2)
199 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ	BIT(3)
200 #define ETHTOOL_COALESCE_TX_USECS		BIT(4)
201 #define ETHTOOL_COALESCE_TX_MAX_FRAMES		BIT(5)
202 #define ETHTOOL_COALESCE_TX_USECS_IRQ		BIT(6)
203 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ	BIT(7)
204 #define ETHTOOL_COALESCE_STATS_BLOCK_USECS	BIT(8)
205 #define ETHTOOL_COALESCE_USE_ADAPTIVE_RX	BIT(9)
206 #define ETHTOOL_COALESCE_USE_ADAPTIVE_TX	BIT(10)
207 #define ETHTOOL_COALESCE_PKT_RATE_LOW		BIT(11)
208 #define ETHTOOL_COALESCE_RX_USECS_LOW		BIT(12)
209 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW	BIT(13)
210 #define ETHTOOL_COALESCE_TX_USECS_LOW		BIT(14)
211 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW	BIT(15)
212 #define ETHTOOL_COALESCE_PKT_RATE_HIGH		BIT(16)
213 #define ETHTOOL_COALESCE_RX_USECS_HIGH		BIT(17)
214 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH	BIT(18)
215 #define ETHTOOL_COALESCE_TX_USECS_HIGH		BIT(19)
216 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH	BIT(20)
217 #define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL	BIT(21)
218 #define ETHTOOL_COALESCE_ALL_PARAMS		GENMASK(21, 0)
219 
220 #define ETHTOOL_COALESCE_USECS						\
221 	(ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS)
222 #define ETHTOOL_COALESCE_MAX_FRAMES					\
223 	(ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES)
224 #define ETHTOOL_COALESCE_USECS_IRQ					\
225 	(ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ)
226 #define ETHTOOL_COALESCE_MAX_FRAMES_IRQ		\
227 	(ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ |	\
228 	 ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ)
229 #define ETHTOOL_COALESCE_USE_ADAPTIVE					\
230 	(ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX)
231 #define ETHTOOL_COALESCE_USECS_LOW_HIGH					\
232 	(ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \
233 	 ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH)
234 #define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH	\
235 	(ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW |	\
236 	 ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW |	\
237 	 ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH |	\
238 	 ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH)
239 #define ETHTOOL_COALESCE_PKT_RATE_RX_USECS				\
240 	(ETHTOOL_COALESCE_USE_ADAPTIVE_RX |				\
241 	 ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \
242 	 ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \
243 	 ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL)
244 
245 #define ETHTOOL_STAT_NOT_SET	(~0ULL)
246 
247 /**
248  * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
249  * @tx_pause_frames: transmitted pause frame count. Reported to user space
250  *	as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES.
251  *
252  *	Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted`
253  *	from the standard.
254  *
255  * @rx_pause_frames: received pause frame count. Reported to user space
256  *	as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to:
257  *
258  *	Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived`
259  *	from the standard.
260  */
261 struct ethtool_pause_stats {
262 	u64 tx_pause_frames;
263 	u64 rx_pause_frames;
264 };
265 
266 /**
267  * struct ethtool_ops - optional netdev operations
268  * @supported_coalesce_params: supported types of interrupt coalescing.
269  * @get_drvinfo: Report driver/device information.  Should only set the
270  *	@driver, @version, @fw_version and @bus_info fields.  If not
271  *	implemented, the @driver and @bus_info fields will be filled in
272  *	according to the netdev's parent device.
273  * @get_regs_len: Get buffer length required for @get_regs
274  * @get_regs: Get device registers
275  * @get_wol: Report whether Wake-on-Lan is enabled
276  * @set_wol: Turn Wake-on-Lan on or off.  Returns a negative error code
277  *	or zero.
278  * @get_msglevel: Report driver message level.  This should be the value
279  *	of the @msg_enable field used by netif logging functions.
280  * @set_msglevel: Set driver message level
281  * @nway_reset: Restart autonegotiation.  Returns a negative error code
282  *	or zero.
283  * @get_link: Report whether physical link is up.  Will only be called if
284  *	the netdev is up.  Should usually be set to ethtool_op_get_link(),
285  *	which uses netif_carrier_ok().
286  * @get_link_ext_state: Report link extended state. Should set link_ext_state and
287  *	link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown,
288  *	do not attach ext_substate attribute to netlink message). If link_ext_state
289  *	and link_ext_substate are unknown, return -ENODATA. If not implemented,
290  *	link_ext_state and link_ext_substate will not be sent to userspace.
291  * @get_eeprom: Read data from the device EEPROM.
292  *	Should fill in the magic field.  Don't need to check len for zero
293  *	or wraparound.  Fill in the data argument with the eeprom values
294  *	from offset to offset + len.  Update len to the amount read.
295  *	Returns an error or zero.
296  * @set_eeprom: Write data to the device EEPROM.
297  *	Should validate the magic field.  Don't need to check len for zero
298  *	or wraparound.  Update len to the amount written.  Returns an error
299  *	or zero.
300  * @get_coalesce: Get interrupt coalescing parameters.  Returns a negative
301  *	error code or zero.
302  * @set_coalesce: Set interrupt coalescing parameters.  Supported coalescing
303  *	types should be set in @supported_coalesce_params.
304  *	Returns a negative error code or zero.
305  * @get_ringparam: Report ring sizes
306  * @set_ringparam: Set ring sizes.  Returns a negative error code or zero.
307  * @get_pause_stats: Report pause frame statistics. Drivers must not zero
308  *	statistics which they don't report. The stats structure is initialized
309  *	to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics.
310  * @get_pauseparam: Report pause parameters
311  * @set_pauseparam: Set pause parameters.  Returns a negative error code
312  *	or zero.
313  * @self_test: Run specified self-tests
314  * @get_strings: Return a set of strings that describe the requested objects
315  * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
316  *	attached to it.  The implementation may update the indicator
317  *	asynchronously or synchronously, but in either case it must return
318  *	quickly.  It is initially called with the argument %ETHTOOL_ID_ACTIVE,
319  *	and must either activate asynchronous updates and return zero, return
320  *	a negative error or return a positive frequency for synchronous
321  *	indication (e.g. 1 for one on/off cycle per second).  If it returns
322  *	a frequency then it will be called again at intervals with the
323  *	argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
324  *	the indicator accordingly.  Finally, it is called with the argument
325  *	%ETHTOOL_ID_INACTIVE and must deactivate the indicator.  Returns a
326  *	negative error code or zero.
327  * @get_ethtool_stats: Return extended statistics about the device.
328  *	This is only useful if the device maintains statistics not
329  *	included in &struct rtnl_link_stats64.
330  * @begin: Function to be called before any other operation.  Returns a
331  *	negative error code or zero.
332  * @complete: Function to be called after any other operation except
333  *	@begin.  Will be called even if the other operation failed.
334  * @get_priv_flags: Report driver-specific feature flags.
335  * @set_priv_flags: Set driver-specific feature flags.  Returns a negative
336  *	error code or zero.
337  * @get_sset_count: Get number of strings that @get_strings will write.
338  * @get_rxnfc: Get RX flow classification rules.  Returns a negative
339  *	error code or zero.
340  * @set_rxnfc: Set RX flow classification rules.  Returns a negative
341  *	error code or zero.
342  * @flash_device: Write a firmware image to device's flash memory.
343  *	Returns a negative error code or zero.
344  * @reset: Reset (part of) the device, as specified by a bitmask of
345  *	flags from &enum ethtool_reset_flags.  Returns a negative
346  *	error code or zero.
347  * @get_rxfh_key_size: Get the size of the RX flow hash key.
348  *	Returns zero if not supported for this specific device.
349  * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
350  *	Returns zero if not supported for this specific device.
351  * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
352  *	and/or hash function.
353  *	Returns a negative error code or zero.
354  * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
355  *	key, and/or hash function.  Arguments which are set to %NULL or zero
356  *	will remain unchanged.
357  *	Returns a negative error code or zero. An error code must be returned
358  *	if at least one unsupported change was requested.
359  * @get_rxfh_context: Get the contents of the RX flow hash indirection table,
360  *	hash key, and/or hash function assiciated to the given rss context.
361  *	Returns a negative error code or zero.
362  * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting
363  *	the contents of the RX flow hash indirection table, hash key, and/or
364  *	hash function associated to the given context. Arguments which are set
365  *	to %NULL or zero will remain unchanged.
366  *	Returns a negative error code or zero. An error code must be returned
367  *	if at least one unsupported change was requested.
368  * @get_channels: Get number of channels.
369  * @set_channels: Set number of channels.  Returns a negative error code or
370  *	zero.
371  * @get_dump_flag: Get dump flag indicating current dump length, version,
372  * 		   and flag of the device.
373  * @get_dump_data: Get dump data.
374  * @set_dump: Set dump specific flags to the device.
375  * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
376  *	Drivers supporting transmit time stamps in software should set this to
377  *	ethtool_op_get_ts_info().
378  * @get_module_info: Get the size and type of the eeprom contained within
379  *	a plug-in module.
380  * @get_module_eeprom: Get the eeprom information from the plug-in module
381  * @get_eee: Get Energy-Efficient (EEE) supported and status.
382  * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
383  * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
384  *	It must check that the given queue number is valid. If neither a RX nor
385  *	a TX queue has this number, return -EINVAL. If only a RX queue or a TX
386  *	queue has this number, set the inapplicable fields to ~0 and return 0.
387  *	Returns a negative error code or zero.
388  * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
389  *	It must check that the given queue number is valid. If neither a RX nor
390  *	a TX queue has this number, return -EINVAL. If only a RX queue or a TX
391  *	queue has this number, ignore the inapplicable fields. Supported
392  *	coalescing types should be set in @supported_coalesce_params.
393  *	Returns a negative error code or zero.
394  * @get_link_ksettings: Get various device settings including Ethernet link
395  *	settings. The %cmd and %link_mode_masks_nwords fields should be
396  *	ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
397  *	any change to them will be overwritten by kernel. Returns a negative
398  *	error code or zero.
399  * @set_link_ksettings: Set various device settings including Ethernet link
400  *	settings. The %cmd and %link_mode_masks_nwords fields should be
401  *	ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
402  *	any change to them will be overwritten by kernel. Returns a negative
403  *	error code or zero.
404  * @get_fecparam: Get the network device Forward Error Correction parameters.
405  * @set_fecparam: Set the network device Forward Error Correction parameters.
406  * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
407  *	This is only useful if the device maintains PHY statistics and
408  *	cannot use the standard PHY library helpers.
409  *
410  * All operations are optional (i.e. the function pointer may be set
411  * to %NULL) and callers must take this into account.  Callers must
412  * hold the RTNL lock.
413  *
414  * See the structures used by these operations for further documentation.
415  * Note that for all operations using a structure ending with a zero-
416  * length array, the array is allocated separately in the kernel and
417  * is passed to the driver as an additional parameter.
418  *
419  * See &struct net_device and &struct net_device_ops for documentation
420  * of the generic netdev features interface.
421  */
422 struct ethtool_ops {
423 	u32	supported_coalesce_params;
424 	void	(*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
425 	int	(*get_regs_len)(struct net_device *);
426 	void	(*get_regs)(struct net_device *, struct ethtool_regs *, void *);
427 	void	(*get_wol)(struct net_device *, struct ethtool_wolinfo *);
428 	int	(*set_wol)(struct net_device *, struct ethtool_wolinfo *);
429 	u32	(*get_msglevel)(struct net_device *);
430 	void	(*set_msglevel)(struct net_device *, u32);
431 	int	(*nway_reset)(struct net_device *);
432 	u32	(*get_link)(struct net_device *);
433 	int	(*get_link_ext_state)(struct net_device *,
434 				      struct ethtool_link_ext_state_info *);
435 	int	(*get_eeprom_len)(struct net_device *);
436 	int	(*get_eeprom)(struct net_device *,
437 			      struct ethtool_eeprom *, u8 *);
438 	int	(*set_eeprom)(struct net_device *,
439 			      struct ethtool_eeprom *, u8 *);
440 	int	(*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
441 	int	(*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
442 	void	(*get_ringparam)(struct net_device *,
443 				 struct ethtool_ringparam *);
444 	int	(*set_ringparam)(struct net_device *,
445 				 struct ethtool_ringparam *);
446 	void	(*get_pause_stats)(struct net_device *dev,
447 				   struct ethtool_pause_stats *pause_stats);
448 	void	(*get_pauseparam)(struct net_device *,
449 				  struct ethtool_pauseparam*);
450 	int	(*set_pauseparam)(struct net_device *,
451 				  struct ethtool_pauseparam*);
452 	void	(*self_test)(struct net_device *, struct ethtool_test *, u64 *);
453 	void	(*get_strings)(struct net_device *, u32 stringset, u8 *);
454 	int	(*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
455 	void	(*get_ethtool_stats)(struct net_device *,
456 				     struct ethtool_stats *, u64 *);
457 	int	(*begin)(struct net_device *);
458 	void	(*complete)(struct net_device *);
459 	u32	(*get_priv_flags)(struct net_device *);
460 	int	(*set_priv_flags)(struct net_device *, u32);
461 	int	(*get_sset_count)(struct net_device *, int);
462 	int	(*get_rxnfc)(struct net_device *,
463 			     struct ethtool_rxnfc *, u32 *rule_locs);
464 	int	(*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
465 	int	(*flash_device)(struct net_device *, struct ethtool_flash *);
466 	int	(*reset)(struct net_device *, u32 *);
467 	u32	(*get_rxfh_key_size)(struct net_device *);
468 	u32	(*get_rxfh_indir_size)(struct net_device *);
469 	int	(*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
470 			    u8 *hfunc);
471 	int	(*set_rxfh)(struct net_device *, const u32 *indir,
472 			    const u8 *key, const u8 hfunc);
473 	int	(*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key,
474 				    u8 *hfunc, u32 rss_context);
475 	int	(*set_rxfh_context)(struct net_device *, const u32 *indir,
476 				    const u8 *key, const u8 hfunc,
477 				    u32 *rss_context, bool delete);
478 	void	(*get_channels)(struct net_device *, struct ethtool_channels *);
479 	int	(*set_channels)(struct net_device *, struct ethtool_channels *);
480 	int	(*get_dump_flag)(struct net_device *, struct ethtool_dump *);
481 	int	(*get_dump_data)(struct net_device *,
482 				 struct ethtool_dump *, void *);
483 	int	(*set_dump)(struct net_device *, struct ethtool_dump *);
484 	int	(*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
485 	int     (*get_module_info)(struct net_device *,
486 				   struct ethtool_modinfo *);
487 	int     (*get_module_eeprom)(struct net_device *,
488 				     struct ethtool_eeprom *, u8 *);
489 	int	(*get_eee)(struct net_device *, struct ethtool_eee *);
490 	int	(*set_eee)(struct net_device *, struct ethtool_eee *);
491 	int	(*get_tunable)(struct net_device *,
492 			       const struct ethtool_tunable *, void *);
493 	int	(*set_tunable)(struct net_device *,
494 			       const struct ethtool_tunable *, const void *);
495 	int	(*get_per_queue_coalesce)(struct net_device *, u32,
496 					  struct ethtool_coalesce *);
497 	int	(*set_per_queue_coalesce)(struct net_device *, u32,
498 					  struct ethtool_coalesce *);
499 	int	(*get_link_ksettings)(struct net_device *,
500 				      struct ethtool_link_ksettings *);
501 	int	(*set_link_ksettings)(struct net_device *,
502 				      const struct ethtool_link_ksettings *);
503 	int	(*get_fecparam)(struct net_device *,
504 				      struct ethtool_fecparam *);
505 	int	(*set_fecparam)(struct net_device *,
506 				      struct ethtool_fecparam *);
507 	void	(*get_ethtool_phy_stats)(struct net_device *,
508 					 struct ethtool_stats *, u64 *);
509 	int	(*get_phy_tunable)(struct net_device *,
510 				   const struct ethtool_tunable *, void *);
511 	int	(*set_phy_tunable)(struct net_device *,
512 				   const struct ethtool_tunable *, const void *);
513 };
514 
515 int ethtool_check_ops(const struct ethtool_ops *ops);
516 
517 struct ethtool_rx_flow_rule {
518 	struct flow_rule	*rule;
519 	unsigned long		priv[];
520 };
521 
522 struct ethtool_rx_flow_spec_input {
523 	const struct ethtool_rx_flow_spec	*fs;
524 	u32					rss_ctx;
525 };
526 
527 struct ethtool_rx_flow_rule *
528 ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
529 void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
530 
531 bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
532 int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
533 				       const struct ethtool_link_ksettings *cmd,
534 				       u32 *dev_speed, u8 *dev_duplex);
535 
536 struct netlink_ext_ack;
537 struct phy_device;
538 struct phy_tdr_config;
539 
540 /**
541  * struct ethtool_phy_ops - Optional PHY device options
542  * @get_sset_count: Get number of strings that @get_strings will write.
543  * @get_strings: Return a set of strings that describe the requested objects
544  * @get_stats: Return extended statistics about the PHY device.
545  * @start_cable_test - Start a cable test
546  * @start_cable_test_tdr - Start a Time Domain Reflectometry cable test
547  *
548  * All operations are optional (i.e. the function pointer may be set to %NULL)
549  * and callers must take this into account. Callers must hold the RTNL lock.
550  */
551 struct ethtool_phy_ops {
552 	int (*get_sset_count)(struct phy_device *dev);
553 	int (*get_strings)(struct phy_device *dev, u8 *data);
554 	int (*get_stats)(struct phy_device *dev,
555 			 struct ethtool_stats *stats, u64 *data);
556 	int (*start_cable_test)(struct phy_device *phydev,
557 				struct netlink_ext_ack *extack);
558 	int (*start_cable_test_tdr)(struct phy_device *phydev,
559 				    struct netlink_ext_ack *extack,
560 				    const struct phy_tdr_config *config);
561 };
562 
563 /**
564  * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
565  * @ops: Ethtool PHY operations to set
566  */
567 void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops);
568 
569 #endif /* _LINUX_ETHTOOL_H */
570