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