1 /* SPDX-License-Identifier: GPL-2.0 */
3 * ethtool.h: Defines for Linux ethtool.
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
13 #ifndef _LINUX_ETHTOOL_H
14 #define _LINUX_ETHTOOL_H
16 #include <linux/bitmap.h>
17 #include <linux/compat.h>
18 #include <uapi/linux/ethtool.h>
22 struct compat_ethtool_rx_flow_spec {
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;
32 struct compat_ethtool_rxnfc {
36 struct compat_ethtool_rx_flow_spec fs;
41 #endif /* CONFIG_COMPAT */
43 #include <linux/rculist.h>
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
51 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
54 enum ethtool_phys_id_state {
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 */
67 * Add your fresh new hash function bits above and remember to update
68 * rss_hash_func_strings[] in ethtool.c
70 ETH_RSS_HASH_FUNCS_COUNT
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)
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)
80 #define ETH_RSS_HASH_UNKNOWN 0
81 #define ETH_RSS_HASH_NO_CHANGE 0
84 struct netlink_ext_ack;
86 /* Some generic methods drivers may use in their ethtool_ops */
87 u32 ethtool_op_get_link(struct net_device *dev);
88 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
91 /* Link extended state and substate. */
92 struct ethtool_link_ext_state_info {
93 enum ethtool_link_ext_state link_ext_state;
95 enum ethtool_link_ext_substate_autoneg autoneg;
96 enum ethtool_link_ext_substate_link_training link_training;
97 enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch;
98 enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity;
99 enum ethtool_link_ext_substate_cable_issue cable_issue;
100 u8 __link_ext_substate;
105 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
106 * @index: Index in RX flow hash indirection table
107 * @n_rx_rings: Number of RX rings to use
109 * This function provides the default policy for RX flow hash indirection.
111 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
113 return index % n_rx_rings;
116 /* declare a link mode bitmap */
117 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \
118 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
120 /* drivers must ignore base.cmd and base.link_mode_masks_nwords
121 * fields, but they are allowed to overwrite them (will be ignored).
123 struct ethtool_link_ksettings {
124 struct ethtool_link_settings base;
126 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
127 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
128 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
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
138 #define ethtool_link_ksettings_zero_link_mode(ptr, name) \
139 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
142 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
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)
149 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \
150 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
153 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
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)
160 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \
161 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
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)
170 * Returns true/false.
172 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \
173 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
176 __ethtool_get_link_ksettings(struct net_device *dev,
177 struct ethtool_link_ksettings *link_ksettings);
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
184 * Given two link mode masks, AND them together and save the result in dst.
186 void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
187 struct ethtool_link_ksettings *src);
189 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst,
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);
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)
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)
245 #define ETHTOOL_STAT_NOT_SET (~0ULL)
247 static inline void ethtool_stats_init(u64 *stats, unsigned int n)
250 stats[n] = ETHTOOL_STAT_NOT_SET;
253 /* Basic IEEE 802.3 PHY statistics (30.3.2.1.*), not otherwise exposed
254 * via a more targeted API.
256 struct ethtool_eth_phy_stats {
257 u64 SymbolErrorDuringCarrier;
261 * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
262 * @tx_pause_frames: transmitted pause frame count. Reported to user space
263 * as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES.
265 * Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted`
268 * @rx_pause_frames: received pause frame count. Reported to user space
269 * as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to:
271 * Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived`
274 struct ethtool_pause_stats {
279 #define ETHTOOL_MAX_LANES 8
282 * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC
283 * @corrected_blocks: number of received blocks corrected by FEC
284 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORRECTED.
286 * Equivalent to `30.5.1.1.17 aFECCorrectedBlocks` from the standard.
288 * @uncorrectable_blocks: number of received blocks FEC was not able to correct
289 * Reported to user space as %ETHTOOL_A_FEC_STAT_UNCORR.
291 * Equivalent to `30.5.1.1.18 aFECUncorrectableBlocks` from the standard.
293 * @corrected_bits: number of bits corrected by FEC
294 * Similar to @corrected_blocks but counts individual bit changes,
295 * not entire FEC data blocks. This is a non-standard statistic.
296 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS.
298 * @lane: per-lane/PCS-instance counts as defined by the standard
299 * @total: error counts for the entire port, for drivers incapable of reporting
302 * Drivers should fill in either only total or per-lane statistics, core
303 * will take care of adding lane values up to produce the total.
305 struct ethtool_fec_stats {
306 struct ethtool_fec_stat {
308 u64 lanes[ETHTOOL_MAX_LANES];
309 } corrected_blocks, uncorrectable_blocks, corrected_bits;
312 #define ETH_MODULE_EEPROM_PAGE_LEN 128
313 #define ETH_MODULE_MAX_I2C_ADDRESS 0x7f
316 * struct ethtool_module_eeprom - EEPROM dump from specified page
317 * @offset: Offset within the specified EEPROM page to begin read, in bytes.
318 * @length: Number of bytes to read.
319 * @page: Page number to read from.
320 * @bank: Page bank number to read from, if applicable by EEPROM spec.
321 * @i2c_address: I2C address of a page. Value less than 0x7f expected. Most
322 * EEPROMs use 0x50 or 0x51.
323 * @data: Pointer to buffer with EEPROM data of @length size.
325 * This can be used to manage pages during EEPROM dump in ethtool and pass
326 * required information to the driver.
328 struct ethtool_module_eeprom {
338 * struct ethtool_ops - optional netdev operations
339 * @cap_link_lanes_supported: indicates if the driver supports lanes
341 * @supported_coalesce_params: supported types of interrupt coalescing.
342 * @get_drvinfo: Report driver/device information. Should only set the
343 * @driver, @version, @fw_version and @bus_info fields. If not
344 * implemented, the @driver and @bus_info fields will be filled in
345 * according to the netdev's parent device.
346 * @get_regs_len: Get buffer length required for @get_regs
347 * @get_regs: Get device registers
348 * @get_wol: Report whether Wake-on-Lan is enabled
349 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
351 * @get_msglevel: Report driver message level. This should be the value
352 * of the @msg_enable field used by netif logging functions.
353 * @set_msglevel: Set driver message level
354 * @nway_reset: Restart autonegotiation. Returns a negative error code
356 * @get_link: Report whether physical link is up. Will only be called if
357 * the netdev is up. Should usually be set to ethtool_op_get_link(),
358 * which uses netif_carrier_ok().
359 * @get_link_ext_state: Report link extended state. Should set link_ext_state and
360 * link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown,
361 * do not attach ext_substate attribute to netlink message). If link_ext_state
362 * and link_ext_substate are unknown, return -ENODATA. If not implemented,
363 * link_ext_state and link_ext_substate will not be sent to userspace.
364 * @get_eeprom_len: Read range of EEPROM addresses for validation of
365 * @get_eeprom and @set_eeprom requests.
366 * Returns 0 if device does not support EEPROM access.
367 * @get_eeprom: Read data from the device EEPROM.
368 * Should fill in the magic field. Don't need to check len for zero
369 * or wraparound. Fill in the data argument with the eeprom values
370 * from offset to offset + len. Update len to the amount read.
371 * Returns an error or zero.
372 * @set_eeprom: Write data to the device EEPROM.
373 * Should validate the magic field. Don't need to check len for zero
374 * or wraparound. Update len to the amount written. Returns an error
376 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
377 * error code or zero.
378 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing
379 * types should be set in @supported_coalesce_params.
380 * Returns a negative error code or zero.
381 * @get_ringparam: Report ring sizes
382 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
383 * @get_pause_stats: Report pause frame statistics. Drivers must not zero
384 * statistics which they don't report. The stats structure is initialized
385 * to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics.
386 * @get_pauseparam: Report pause parameters
387 * @set_pauseparam: Set pause parameters. Returns a negative error code
389 * @self_test: Run specified self-tests
390 * @get_strings: Return a set of strings that describe the requested objects
391 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
392 * attached to it. The implementation may update the indicator
393 * asynchronously or synchronously, but in either case it must return
394 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
395 * and must either activate asynchronous updates and return zero, return
396 * a negative error or return a positive frequency for synchronous
397 * indication (e.g. 1 for one on/off cycle per second). If it returns
398 * a frequency then it will be called again at intervals with the
399 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
400 * the indicator accordingly. Finally, it is called with the argument
401 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
402 * negative error code or zero.
403 * @get_ethtool_stats: Return extended statistics about the device.
404 * This is only useful if the device maintains statistics not
405 * included in &struct rtnl_link_stats64.
406 * @begin: Function to be called before any other operation. Returns a
407 * negative error code or zero.
408 * @complete: Function to be called after any other operation except
409 * @begin. Will be called even if the other operation failed.
410 * @get_priv_flags: Report driver-specific feature flags.
411 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
412 * error code or zero.
413 * @get_sset_count: Get number of strings that @get_strings will write.
414 * @get_rxnfc: Get RX flow classification rules. Returns a negative
415 * error code or zero.
416 * @set_rxnfc: Set RX flow classification rules. Returns a negative
417 * error code or zero.
418 * @flash_device: Write a firmware image to device's flash memory.
419 * Returns a negative error code or zero.
420 * @reset: Reset (part of) the device, as specified by a bitmask of
421 * flags from &enum ethtool_reset_flags. Returns a negative
422 * error code or zero.
423 * @get_rxfh_key_size: Get the size of the RX flow hash key.
424 * Returns zero if not supported for this specific device.
425 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
426 * Returns zero if not supported for this specific device.
427 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
428 * and/or hash function.
429 * Returns a negative error code or zero.
430 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
431 * key, and/or hash function. Arguments which are set to %NULL or zero
432 * will remain unchanged.
433 * Returns a negative error code or zero. An error code must be returned
434 * if at least one unsupported change was requested.
435 * @get_rxfh_context: Get the contents of the RX flow hash indirection table,
436 * hash key, and/or hash function assiciated to the given rss context.
437 * Returns a negative error code or zero.
438 * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting
439 * the contents of the RX flow hash indirection table, hash key, and/or
440 * hash function associated to the given context. Arguments which are set
441 * to %NULL or zero will remain unchanged.
442 * Returns a negative error code or zero. An error code must be returned
443 * if at least one unsupported change was requested.
444 * @get_channels: Get number of channels.
445 * @set_channels: Set number of channels. Returns a negative error code or
447 * @get_dump_flag: Get dump flag indicating current dump length, version,
448 * and flag of the device.
449 * @get_dump_data: Get dump data.
450 * @set_dump: Set dump specific flags to the device.
451 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
452 * Drivers supporting transmit time stamps in software should set this to
453 * ethtool_op_get_ts_info().
454 * @get_module_info: Get the size and type of the eeprom contained within
456 * @get_module_eeprom: Get the eeprom information from the plug-in module
457 * @get_eee: Get Energy-Efficient (EEE) supported and status.
458 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
459 * @get_tunable: Read the value of a driver / device tunable.
460 * @set_tunable: Set the value of a driver / device tunable.
461 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
462 * It must check that the given queue number is valid. If neither a RX nor
463 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
464 * queue has this number, set the inapplicable fields to ~0 and return 0.
465 * Returns a negative error code or zero.
466 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
467 * It must check that the given queue number is valid. If neither a RX nor
468 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
469 * queue has this number, ignore the inapplicable fields. Supported
470 * coalescing types should be set in @supported_coalesce_params.
471 * Returns a negative error code or zero.
472 * @get_link_ksettings: Get various device settings including Ethernet link
473 * settings. The %cmd and %link_mode_masks_nwords fields should be
474 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
475 * any change to them will be overwritten by kernel. Returns a negative
476 * error code or zero.
477 * @set_link_ksettings: Set various device settings including Ethernet link
478 * settings. The %cmd and %link_mode_masks_nwords fields should be
479 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
480 * any change to them will be overwritten by kernel. Returns a negative
481 * error code or zero.
482 * @get_fec_stats: Report FEC statistics.
483 * Core will sum up per-lane stats to get the total.
484 * Drivers must not zero statistics which they don't report. The stats
485 * structure is initialized to ETHTOOL_STAT_NOT_SET indicating driver does
486 * not report statistics.
487 * @get_fecparam: Get the network device Forward Error Correction parameters.
488 * @set_fecparam: Set the network device Forward Error Correction parameters.
489 * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
490 * This is only useful if the device maintains PHY statistics and
491 * cannot use the standard PHY library helpers.
492 * @get_phy_tunable: Read the value of a PHY tunable.
493 * @set_phy_tunable: Set the value of a PHY tunable.
494 * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from
495 * specified page. Returns a negative error code or the amount of bytes
497 * @get_eth_phy_stats: Query some of the IEEE 802.3 PHY statistics.
499 * All operations are optional (i.e. the function pointer may be set
500 * to %NULL) and callers must take this into account. Callers must
501 * hold the RTNL lock.
503 * See the structures used by these operations for further documentation.
504 * Note that for all operations using a structure ending with a zero-
505 * length array, the array is allocated separately in the kernel and
506 * is passed to the driver as an additional parameter.
508 * See &struct net_device and &struct net_device_ops for documentation
509 * of the generic netdev features interface.
512 u32 cap_link_lanes_supported:1;
513 u32 supported_coalesce_params;
514 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
515 int (*get_regs_len)(struct net_device *);
516 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
517 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
518 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
519 u32 (*get_msglevel)(struct net_device *);
520 void (*set_msglevel)(struct net_device *, u32);
521 int (*nway_reset)(struct net_device *);
522 u32 (*get_link)(struct net_device *);
523 int (*get_link_ext_state)(struct net_device *,
524 struct ethtool_link_ext_state_info *);
525 int (*get_eeprom_len)(struct net_device *);
526 int (*get_eeprom)(struct net_device *,
527 struct ethtool_eeprom *, u8 *);
528 int (*set_eeprom)(struct net_device *,
529 struct ethtool_eeprom *, u8 *);
530 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
531 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
532 void (*get_ringparam)(struct net_device *,
533 struct ethtool_ringparam *);
534 int (*set_ringparam)(struct net_device *,
535 struct ethtool_ringparam *);
536 void (*get_pause_stats)(struct net_device *dev,
537 struct ethtool_pause_stats *pause_stats);
538 void (*get_pauseparam)(struct net_device *,
539 struct ethtool_pauseparam*);
540 int (*set_pauseparam)(struct net_device *,
541 struct ethtool_pauseparam*);
542 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
543 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
544 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
545 void (*get_ethtool_stats)(struct net_device *,
546 struct ethtool_stats *, u64 *);
547 int (*begin)(struct net_device *);
548 void (*complete)(struct net_device *);
549 u32 (*get_priv_flags)(struct net_device *);
550 int (*set_priv_flags)(struct net_device *, u32);
551 int (*get_sset_count)(struct net_device *, int);
552 int (*get_rxnfc)(struct net_device *,
553 struct ethtool_rxnfc *, u32 *rule_locs);
554 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
555 int (*flash_device)(struct net_device *, struct ethtool_flash *);
556 int (*reset)(struct net_device *, u32 *);
557 u32 (*get_rxfh_key_size)(struct net_device *);
558 u32 (*get_rxfh_indir_size)(struct net_device *);
559 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
561 int (*set_rxfh)(struct net_device *, const u32 *indir,
562 const u8 *key, const u8 hfunc);
563 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key,
564 u8 *hfunc, u32 rss_context);
565 int (*set_rxfh_context)(struct net_device *, const u32 *indir,
566 const u8 *key, const u8 hfunc,
567 u32 *rss_context, bool delete);
568 void (*get_channels)(struct net_device *, struct ethtool_channels *);
569 int (*set_channels)(struct net_device *, struct ethtool_channels *);
570 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
571 int (*get_dump_data)(struct net_device *,
572 struct ethtool_dump *, void *);
573 int (*set_dump)(struct net_device *, struct ethtool_dump *);
574 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
575 int (*get_module_info)(struct net_device *,
576 struct ethtool_modinfo *);
577 int (*get_module_eeprom)(struct net_device *,
578 struct ethtool_eeprom *, u8 *);
579 int (*get_eee)(struct net_device *, struct ethtool_eee *);
580 int (*set_eee)(struct net_device *, struct ethtool_eee *);
581 int (*get_tunable)(struct net_device *,
582 const struct ethtool_tunable *, void *);
583 int (*set_tunable)(struct net_device *,
584 const struct ethtool_tunable *, const void *);
585 int (*get_per_queue_coalesce)(struct net_device *, u32,
586 struct ethtool_coalesce *);
587 int (*set_per_queue_coalesce)(struct net_device *, u32,
588 struct ethtool_coalesce *);
589 int (*get_link_ksettings)(struct net_device *,
590 struct ethtool_link_ksettings *);
591 int (*set_link_ksettings)(struct net_device *,
592 const struct ethtool_link_ksettings *);
593 void (*get_fec_stats)(struct net_device *dev,
594 struct ethtool_fec_stats *fec_stats);
595 int (*get_fecparam)(struct net_device *,
596 struct ethtool_fecparam *);
597 int (*set_fecparam)(struct net_device *,
598 struct ethtool_fecparam *);
599 void (*get_ethtool_phy_stats)(struct net_device *,
600 struct ethtool_stats *, u64 *);
601 int (*get_phy_tunable)(struct net_device *,
602 const struct ethtool_tunable *, void *);
603 int (*set_phy_tunable)(struct net_device *,
604 const struct ethtool_tunable *, const void *);
605 int (*get_module_eeprom_by_page)(struct net_device *dev,
606 const struct ethtool_module_eeprom *page,
607 struct netlink_ext_ack *extack);
608 void (*get_eth_phy_stats)(struct net_device *dev,
609 struct ethtool_eth_phy_stats *phy_stats);
612 int ethtool_check_ops(const struct ethtool_ops *ops);
614 struct ethtool_rx_flow_rule {
615 struct flow_rule *rule;
616 unsigned long priv[];
619 struct ethtool_rx_flow_spec_input {
620 const struct ethtool_rx_flow_spec *fs;
624 struct ethtool_rx_flow_rule *
625 ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
626 void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
628 bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
629 int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
630 const struct ethtool_link_ksettings *cmd,
631 u32 *dev_speed, u8 *dev_duplex);
634 struct phy_tdr_config;
637 * struct ethtool_phy_ops - Optional PHY device options
638 * @get_sset_count: Get number of strings that @get_strings will write.
639 * @get_strings: Return a set of strings that describe the requested objects
640 * @get_stats: Return extended statistics about the PHY device.
641 * @start_cable_test: Start a cable test
642 * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test
644 * All operations are optional (i.e. the function pointer may be set to %NULL)
645 * and callers must take this into account. Callers must hold the RTNL lock.
647 struct ethtool_phy_ops {
648 int (*get_sset_count)(struct phy_device *dev);
649 int (*get_strings)(struct phy_device *dev, u8 *data);
650 int (*get_stats)(struct phy_device *dev,
651 struct ethtool_stats *stats, u64 *data);
652 int (*start_cable_test)(struct phy_device *phydev,
653 struct netlink_ext_ack *extack);
654 int (*start_cable_test_tdr)(struct phy_device *phydev,
655 struct netlink_ext_ack *extack,
656 const struct phy_tdr_config *config);
660 * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
661 * @ops: Ethtool PHY operations to set
663 void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops);
666 * ethtool_params_from_link_mode - Derive link parameters from a given link mode
667 * @link_ksettings: Link parameters to be derived from the link mode
668 * @link_mode: Link mode
671 ethtool_params_from_link_mode(struct ethtool_link_ksettings *link_ksettings,
672 enum ethtool_link_mode_bit_indices link_mode);
675 * ethtool_sprintf - Write formatted string to ethtool string data
676 * @data: Pointer to start of string to update
677 * @fmt: Format of string to write
679 * Write formatted string to data. Update data to point at start of
682 extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);
683 #endif /* _LINUX_ETHTOOL_H */