projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
docs: ethtool: document standard statistics
[linux-block.git] / include / linux / ethtool.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT		 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)
59089d8d 11 * Portions Copyright (C) Sun Microsystems 2008
1da177e4 12 */
1da177e4
LT		 13#ifndef _LINUX_ETHTOOL_H
14#define _LINUX_ETHTOOL_H
15
3f1ac7a7 16#include <linux/bitmap.h>
3a7da39d 17#include <linux/compat.h>
607ca46e 18#include <uapi/linux/ethtool.h>
3ae7c0b2 19
3a7da39d
BH		 20#ifdef CONFIG_COMPAT
21
22struct compat_ethtool_rx_flow_spec {
23 u32 flow_type;
127fe533
AD		 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;
3a7da39d
BH		 28 compat_u64 ring_cookie;
29 u32 location;
30};
31
32struct 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;
5299a11a 38 u32 rule_locs[];
3a7da39d
BH		 39};
40
41#endif /* CONFIG_COMPAT */
c3ce7e20 42
a1467085
DM		 43#include <linux/rculist.h>
44
68f512f2
BH		 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 */
54enum ethtool_phys_id_state {
55 ETHTOOL_ID_INACTIVE,
56 ETHTOOL_ID_ACTIVE,
57 ETHTOOL_ID_ON,
58 ETHTOOL_ID_OFF
59};
60
892311f6
EP		 61enum {
62 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
63 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
abb521e3 64 ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */
892311f6
EP		 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)
abb521e3 78#define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32)
892311f6
EP		 79
80#define ETH_RSS_HASH_UNKNOWN 0
81#define ETH_RSS_HASH_NO_CHANGE 0
82
1da177e4 83struct net_device;
c781ff12 84struct netlink_ext_ack;
1da177e4
LT		 85
86/* Some generic methods drivers may use in their ethtool_ops */
87u32 ethtool_op_get_link(struct net_device *dev);
02eacbd0 88int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
1da177e4 89
ecc31c60 90
f0ebc2b6 91/* Link extended state and substate. */
ecc31c60
AC		 92struct ethtool_link_ext_state_info {
93 enum ethtool_link_ext_state link_ext_state;
94 union {
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;
101 };
102};
103
278bc429
BH		 104/**
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
108 *
109 * This function provides the default policy for RX flow hash indirection.
110 */
111static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
112{
113 return index % n_rx_rings;
114}
115
3f1ac7a7
DD		 116/* declare a link mode bitmap */
117#define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \
118 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
119
120/* drivers must ignore base.cmd and base.link_mode_masks_nwords
121 * fields, but they are allowed to overwrite them (will be ignored).
122 */
123struct ethtool_link_ksettings {
124 struct ethtool_link_settings base;
125 struct {
126 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
127 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
128 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
129 } link_modes;
012ce4dd 130 u32 lanes;
3f1ac7a7
DD		 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
606c07f3
LT		 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
3f1ac7a7
DD		 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
175extern int
176__ethtool_get_link_ksettings(struct net_device *dev,
177 struct ethtool_link_ksettings *link_ksettings);
178
5a6cd6de
AB		 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 */
186void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
187 struct ethtool_link_ksettings *src);
188
6d62b4d5
PR		 189void 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. */
193bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
194 const unsigned long *src);
195
95cddcb5
JK		 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)
4ae21993 218#define ETHTOOL_COALESCE_ALL_PARAMS GENMASK(21, 0)
95cddcb5
JK		 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)
8213f6c9
JK		 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)
4f9546d2
JK		 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)
812df69b
JK		 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)
95cddcb5 244
9a27a330
JK		 245#define ETHTOOL_STAT_NOT_SET (~0ULL)
246
c5797f8a
JK		 247static inline void ethtool_stats_init(u64 *stats, unsigned int n)
248{
249 while (n--)
250 stats[n] = ETHTOOL_STAT_NOT_SET;
251}
252
9a27a330
JK		 253/**
254 * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
255 * @tx_pause_frames: transmitted pause frame count. Reported to user space
256 * as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES.
257 *
258 * Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted`
259 * from the standard.
260 *
261 * @rx_pause_frames: received pause frame count. Reported to user space
262 * as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to:
263 *
264 * Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived`
265 * from the standard.
266 */
267struct ethtool_pause_stats {
268 u64 tx_pause_frames;
269 u64 rx_pause_frames;
270};
271
be85dbfe
JK		 272#define ETHTOOL_MAX_LANES 8
273
274/**
275 * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC
276 * @corrected_blocks: number of received blocks corrected by FEC
277 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORRECTED.
278 *
279 * Equivalent to `30.5.1.1.17 aFECCorrectedBlocks` from the standard.
280 *
281 * @uncorrectable_blocks: number of received blocks FEC was not able to correct
282 * Reported to user space as %ETHTOOL_A_FEC_STAT_UNCORR.
283 *
284 * Equivalent to `30.5.1.1.18 aFECUncorrectableBlocks` from the standard.
285 *
286 * @corrected_bits: number of bits corrected by FEC
287 * Similar to @corrected_blocks but counts individual bit changes,
288 * not entire FEC data blocks. This is a non-standard statistic.
289 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS.
290 *
291 * @lane: per-lane/PCS-instance counts as defined by the standard
292 * @total: error counts for the entire port, for drivers incapable of reporting
293 * per-lane stats
294 *
295 * Drivers should fill in either only total or per-lane statistics, core
296 * will take care of adding lane values up to produce the total.
297 */
298struct ethtool_fec_stats {
299 struct ethtool_fec_stat {
300 u64 total;
301 u64 lanes[ETHTOOL_MAX_LANES];
302 } corrected_blocks, uncorrectable_blocks, corrected_bits;
303};
304
c781ff12
VT		 305#define ETH_MODULE_EEPROM_PAGE_LEN 128
306#define ETH_MODULE_MAX_I2C_ADDRESS 0x7f
307
308/**
309 * struct ethtool_module_eeprom - EEPROM dump from specified page
310 * @offset: Offset within the specified EEPROM page to begin read, in bytes.
311 * @length: Number of bytes to read.
312 * @page: Page number to read from.
313 * @bank: Page bank number to read from, if applicable by EEPROM spec.
314 * @i2c_address: I2C address of a page. Value less than 0x7f expected. Most
315 * EEPROMs use 0x50 or 0x51.
316 * @data: Pointer to buffer with EEPROM data of @length size.
317 *
318 * This can be used to manage pages during EEPROM dump in ethtool and pass
319 * required information to the driver.
320 */
321struct ethtool_module_eeprom {
322 __u32 offset;
323 __u32 length;
324 __u8 page;
325 __u8 bank;
326 __u8 i2c_address;
327 __u8 *data;
328};
329
1da177e4 330/**
8717d07b 331 * struct ethtool_ops - optional netdev operations
012ce4dd
DR		 332 * @cap_link_lanes_supported: indicates if the driver supports lanes
333 * parameter.
95cddcb5 334 * @supported_coalesce_params: supported types of interrupt coalescing.
8717d07b
BH		 335 * @get_drvinfo: Report driver/device information. Should only set the
336 * @driver, @version, @fw_version and @bus_info fields. If not
337 * implemented, the @driver and @bus_info fields will be filled in
338 * according to the netdev's parent device.
339 * @get_regs_len: Get buffer length required for @get_regs
e20b5b61
BH		 340 * @get_regs: Get device registers
341 * @get_wol: Report whether Wake-on-Lan is enabled
8717d07b
BH		 342 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
343 * or zero.
344 * @get_msglevel: Report driver message level. This should be the value
345 * of the @msg_enable field used by netif logging functions.
e20b5b61 346 * @set_msglevel: Set driver message level
8717d07b
BH		 347 * @nway_reset: Restart autonegotiation. Returns a negative error code
348 * or zero.
349 * @get_link: Report whether physical link is up. Will only be called if
350 * the netdev is up. Should usually be set to ethtool_op_get_link(),
351 * which uses netif_carrier_ok().
ecc31c60
AC		 352 * @get_link_ext_state: Report link extended state. Should set link_ext_state and
353 * link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown,
354 * do not attach ext_substate attribute to netlink message). If link_ext_state
355 * and link_ext_substate are unknown, return -ENODATA. If not implemented,
356 * link_ext_state and link_ext_substate will not be sent to userspace.
d9c65de0
JK		 357 * @get_eeprom_len: Read range of EEPROM addresses for validation of
358 * @get_eeprom and @set_eeprom requests.
359 * Returns 0 if device does not support EEPROM access.
e20b5b61 360 * @get_eeprom: Read data from the device EEPROM.
1da177e4
LT		 361 * Should fill in the magic field. Don't need to check len for zero
362 * or wraparound. Fill in the data argument with the eeprom values
363 * from offset to offset + len. Update len to the amount read.
364 * Returns an error or zero.
e20b5b61 365 * @set_eeprom: Write data to the device EEPROM.
1da177e4
LT		 366 * Should validate the magic field. Don't need to check len for zero
367 * or wraparound. Update len to the amount written. Returns an error
368 * or zero.
8717d07b
BH		 369 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
370 * error code or zero.
95cddcb5
JK		 371 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing
372 * types should be set in @supported_coalesce_params.
373 * Returns a negative error code or zero.
e20b5b61 374 * @get_ringparam: Report ring sizes
8717d07b 375 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
9a27a330
JK		 376 * @get_pause_stats: Report pause frame statistics. Drivers must not zero
377 * statistics which they don't report. The stats structure is initialized
378 * to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics.
e20b5b61 379 * @get_pauseparam: Report pause parameters
8717d07b
BH		 380 * @set_pauseparam: Set pause parameters. Returns a negative error code
381 * or zero.
e20b5b61
BH		 382 * @self_test: Run specified self-tests
383 * @get_strings: Return a set of strings that describe the requested objects
68f512f2
BH		 384 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
385 * attached to it. The implementation may update the indicator
386 * asynchronously or synchronously, but in either case it must return
387 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
fce55922
AB		 388 * and must either activate asynchronous updates and return zero, return
389 * a negative error or return a positive frequency for synchronous
390 * indication (e.g. 1 for one on/off cycle per second). If it returns
391 * a frequency then it will be called again at intervals with the
68f512f2
BH		 392 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
393 * the indicator accordingly. Finally, it is called with the argument
394 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
395 * negative error code or zero.
8717d07b
BH		 396 * @get_ethtool_stats: Return extended statistics about the device.
397 * This is only useful if the device maintains statistics not
398 * included in &struct rtnl_link_stats64.
399 * @begin: Function to be called before any other operation. Returns a
400 * negative error code or zero.
401 * @complete: Function to be called after any other operation except
402 * @begin. Will be called even if the other operation failed.
8717d07b
BH		 403 * @get_priv_flags: Report driver-specific feature flags.
404 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
405 * error code or zero.
406 * @get_sset_count: Get number of strings that @get_strings will write.
407 * @get_rxnfc: Get RX flow classification rules. Returns a negative
408 * error code or zero.
409 * @set_rxnfc: Set RX flow classification rules. Returns a negative
410 * error code or zero.
411 * @flash_device: Write a firmware image to device's flash memory.
412 * Returns a negative error code or zero.
413 * @reset: Reset (part of) the device, as specified by a bitmask of
414 * flags from &enum ethtool_reset_flags. Returns a negative
415 * error code or zero.
3de0b592
VD		 416 * @get_rxfh_key_size: Get the size of the RX flow hash key.
417 * Returns zero if not supported for this specific device.
7850f63f
BH		 418 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
419 * Returns zero if not supported for this specific device.
892311f6
EP		 420 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
421 * and/or hash function.
8717d07b 422 * Returns a negative error code or zero.
892311f6
EP		 423 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
424 * key, and/or hash function. Arguments which are set to %NULL or zero
425 * will remain unchanged.
426 * Returns a negative error code or zero. An error code must be returned
427 * if at least one unsupported change was requested.
f4bcf14e
MC		 428 * @get_rxfh_context: Get the contents of the RX flow hash indirection table,
429 * hash key, and/or hash function assiciated to the given rss context.
430 * Returns a negative error code or zero.
431 * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting
432 * the contents of the RX flow hash indirection table, hash key, and/or
433 * hash function associated to the given context. Arguments which are set
434 * to %NULL or zero will remain unchanged.
435 * Returns a negative error code or zero. An error code must be returned
436 * if at least one unsupported change was requested.
8b5933c3 437 * @get_channels: Get number of channels.
438 * @set_channels: Set number of channels. Returns a negative error code or
439 * zero.
29dd54b7
AC		 440 * @get_dump_flag: Get dump flag indicating current dump length, version,
441 * and flag of the device.
442 * @get_dump_data: Get dump data.
443 * @set_dump: Set dump specific flags to the device.
c8f3a8c3
RC		 444 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
445 * Drivers supporting transmit time stamps in software should set this to
446 * ethtool_op_get_ts_info().
41c3cb6d
SH		 447 * @get_module_info: Get the size and type of the eeprom contained within
448 * a plug-in module.
449 * @get_module_eeprom: Get the eeprom information from the plug-in module
80f12ecc
YM		 450 * @get_eee: Get Energy-Efficient (EEE) supported and status.
451 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
d9c65de0
JK		 452 * @get_tunable: Read the value of a driver / device tunable.
453 * @set_tunable: Set the value of a driver / device tunable.
421797b1
KL		 454 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
455 * It must check that the given queue number is valid. If neither a RX nor
456 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
457 * queue has this number, set the inapplicable fields to ~0 and return 0.
458 * Returns a negative error code or zero.
f38d138a
KL		 459 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
460 * It must check that the given queue number is valid. If neither a RX nor
461 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
95cddcb5
JK		 462 * queue has this number, ignore the inapplicable fields. Supported
463 * coalescing types should be set in @supported_coalesce_params.
f38d138a 464 * Returns a negative error code or zero.
9b300495
MK		 465 * @get_link_ksettings: Get various device settings including Ethernet link
466 * settings. The %cmd and %link_mode_masks_nwords fields should be
467 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
468 * any change to them will be overwritten by kernel. Returns a negative
469 * error code or zero.
470 * @set_link_ksettings: Set various device settings including Ethernet link
471 * settings. The %cmd and %link_mode_masks_nwords fields should be
472 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
473 * any change to them will be overwritten by kernel. Returns a negative
474 * error code or zero.
be85dbfe
JK		 475 * @get_fec_stats: Report FEC statistics.
476 * Core will sum up per-lane stats to get the total.
477 * Drivers must not zero statistics which they don't report. The stats
478 * structure is initialized to ETHTOOL_STAT_NOT_SET indicating driver does
479 * not report statistics.
d805c520
FF		 480 * @get_fecparam: Get the network device Forward Error Correction parameters.
481 * @set_fecparam: Set the network device Forward Error Correction parameters.
99943382
FF		 482 * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
483 * This is only useful if the device maintains PHY statistics and
484 * cannot use the standard PHY library helpers.
56f15e2c
JK		 485 * @get_phy_tunable: Read the value of a PHY tunable.
486 * @set_phy_tunable: Set the value of a PHY tunable.
c781ff12
VT		 487 * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from
488 * specified page. Returns a negative error code or the amount of bytes
489 * read.
8717d07b
BH		 490 *
491 * All operations are optional (i.e. the function pointer may be set
492 * to %NULL) and callers must take this into account. Callers must
b4f79e5c 493 * hold the RTNL lock.
8717d07b
BH		 494 *
495 * See the structures used by these operations for further documentation.
6e201c85
BH		 496 * Note that for all operations using a structure ending with a zero-
497 * length array, the array is allocated separately in the kernel and
498 * is passed to the driver as an additional parameter.
8717d07b
BH		 499 *
500 * See &struct net_device and &struct net_device_ops for documentation
501 * of the generic netdev features interface.
1da177e4
LT		 502 */
503struct ethtool_ops {
012ce4dd 504 u32 cap_link_lanes_supported:1;
95cddcb5 505 u32 supported_coalesce_params;
1da177e4
LT		 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 *);
ecc31c60
AC		 515 int (*get_link_ext_state)(struct net_device *,
516 struct ethtool_link_ext_state_info *);
1da177e4 517 int (*get_eeprom_len)(struct net_device *);
97f8aefb 518 int (*get_eeprom)(struct net_device *,
519 struct ethtool_eeprom *, u8 *);
520 int (*set_eeprom)(struct net_device *,
521 struct ethtool_eeprom *, u8 *);
1da177e4
LT		 522 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
523 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
97f8aefb 524 void (*get_ringparam)(struct net_device *,
525 struct ethtool_ringparam *);
526 int (*set_ringparam)(struct net_device *,
527 struct ethtool_ringparam *);
9a27a330
JK		 528 void (*get_pause_stats)(struct net_device *dev,
529 struct ethtool_pause_stats *pause_stats);
97f8aefb 530 void (*get_pauseparam)(struct net_device *,
531 struct ethtool_pauseparam*);
532 int (*set_pauseparam)(struct net_device *,
533 struct ethtool_pauseparam*);
1da177e4
LT		 534 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
535 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
68f512f2 536 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
97f8aefb 537 void (*get_ethtool_stats)(struct net_device *,
538 struct ethtool_stats *, u64 *);
1da177e4
LT		 539 int (*begin)(struct net_device *);
540 void (*complete)(struct net_device *);
97f8aefb 541 u32 (*get_priv_flags)(struct net_device *);
542 int (*set_priv_flags)(struct net_device *, u32);
ff03d49f 543 int (*get_sset_count)(struct net_device *, int);
97f8aefb 544 int (*get_rxnfc)(struct net_device *,
815c7db5 545 struct ethtool_rxnfc *, u32 *rule_locs);
59089d8d 546 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
97f8aefb 547 int (*flash_device)(struct net_device *, struct ethtool_flash *);
d73d3a8c 548 int (*reset)(struct net_device *, u32 *);
3de0b592 549 u32 (*get_rxfh_key_size)(struct net_device *);
7850f63f 550 u32 (*get_rxfh_indir_size)(struct net_device *);
892311f6
EP		 551 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
552 u8 *hfunc);
33cb0fa7 553 int (*set_rxfh)(struct net_device *, const u32 *indir,
892311f6 554 const u8 *key, const u8 hfunc);
84a1d9c4
EC		 555 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key,
556 u8 *hfunc, u32 rss_context);
557 int (*set_rxfh_context)(struct net_device *, const u32 *indir,
558 const u8 *key, const u8 hfunc,
559 u32 *rss_context, bool delete);
8b5933c3 560 void (*get_channels)(struct net_device *, struct ethtool_channels *);
561 int (*set_channels)(struct net_device *, struct ethtool_channels *);
29dd54b7
AC		 562 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
563 int (*get_dump_data)(struct net_device *,
564 struct ethtool_dump *, void *);
565 int (*set_dump)(struct net_device *, struct ethtool_dump *);
c8f3a8c3 566 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
41c3cb6d
SH		 567 int (*get_module_info)(struct net_device *,
568 struct ethtool_modinfo *);
569 int (*get_module_eeprom)(struct net_device *,
570 struct ethtool_eeprom *, u8 *);
80f12ecc
YM		 571 int (*get_eee)(struct net_device *, struct ethtool_eee *);
572 int (*set_eee)(struct net_device *, struct ethtool_eee *);
f0db9b07
GV		 573 int (*get_tunable)(struct net_device *,
574 const struct ethtool_tunable *, void *);
575 int (*set_tunable)(struct net_device *,
576 const struct ethtool_tunable *, const void *);
421797b1
KL		 577 int (*get_per_queue_coalesce)(struct net_device *, u32,
578 struct ethtool_coalesce *);
f38d138a
KL		 579 int (*set_per_queue_coalesce)(struct net_device *, u32,
580 struct ethtool_coalesce *);
3f1ac7a7
DD		 581 int (*get_link_ksettings)(struct net_device *,
582 struct ethtool_link_ksettings *);
583 int (*set_link_ksettings)(struct net_device *,
584 const struct ethtool_link_ksettings *);
be85dbfe
JK		 585 void (*get_fec_stats)(struct net_device *dev,
586 struct ethtool_fec_stats *fec_stats);
1a5f3da2
VSR		 587 int (*get_fecparam)(struct net_device *,
588 struct ethtool_fecparam *);
589 int (*set_fecparam)(struct net_device *,
590 struct ethtool_fecparam *);
99943382
FF		 591 void (*get_ethtool_phy_stats)(struct net_device *,
592 struct ethtool_stats *, u64 *);
c6db31ff
IR		 593 int (*get_phy_tunable)(struct net_device *,
594 const struct ethtool_tunable *, void *);
595 int (*set_phy_tunable)(struct net_device *,
596 const struct ethtool_tunable *, const void *);
c781ff12
VT		 597 int (*get_module_eeprom_by_page)(struct net_device *dev,
598 const struct ethtool_module_eeprom *page,
599 struct netlink_ext_ack *extack);
1da177e4 600};
eca4205f 601
9000edb7
JK		 602int ethtool_check_ops(const struct ethtool_ops *ops);
603
eca4205f
PNA		 604struct ethtool_rx_flow_rule {
605 struct flow_rule *rule;
5299a11a 606 unsigned long priv[];
eca4205f
PNA		 607};
608
609struct ethtool_rx_flow_spec_input {
610 const struct ethtool_rx_flow_spec *fs;
611 u32 rss_ctx;
612};
613
614struct ethtool_rx_flow_rule *
615ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
616void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
617
70ae1e12
CF		 618bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
619int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
620 const struct ethtool_link_ksettings *cmd,
621 u32 *dev_speed, u8 *dev_duplex);
622
4895d780
FF		 623struct phy_device;
624struct phy_tdr_config;
625
626/**
627 * struct ethtool_phy_ops - Optional PHY device options
bd36ed1c
FF		 628 * @get_sset_count: Get number of strings that @get_strings will write.
629 * @get_strings: Return a set of strings that describe the requested objects
630 * @get_stats: Return extended statistics about the PHY device.
d9c65de0
JK		 631 * @start_cable_test: Start a cable test
632 * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test
4895d780
FF		 633 *
634 * All operations are optional (i.e. the function pointer may be set to %NULL)
635 * and callers must take this into account. Callers must hold the RTNL lock.
636 */
637struct ethtool_phy_ops {
bd36ed1c
FF		 638 int (*get_sset_count)(struct phy_device *dev);
639 int (*get_strings)(struct phy_device *dev, u8 *data);
640 int (*get_stats)(struct phy_device *dev,
641 struct ethtool_stats *stats, u64 *data);
4895d780
FF		 642 int (*start_cable_test)(struct phy_device *phydev,
643 struct netlink_ext_ack *extack);
644 int (*start_cable_test_tdr)(struct phy_device *phydev,
645 struct netlink_ext_ack *extack,
646 const struct phy_tdr_config *config);
647};
648
649/**
650 * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
651 * @ops: Ethtool PHY operations to set
652 */
653void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops);
70ae1e12 654
8859a44e 655/**
a975d7d8
DR		 656 * ethtool_params_from_link_mode - Derive link parameters from a given link mode
657 * @link_ksettings: Link parameters to be derived from the link mode
658 * @link_mode: Link mode
659 */
660void
661ethtool_params_from_link_mode(struct ethtool_link_ksettings *link_ksettings,
662 enum ethtool_link_mode_bit_indices link_mode);
8859a44e 663
7888fe53
AD		 664/**
665 * ethtool_sprintf - Write formatted string to ethtool string data
666 * @data: Pointer to start of string to update
667 * @fmt: Format of string to write
668 *
669 * Write formatted string to data. Update data to point at start of
670 * next string.
671 */
672extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);
1da177e4 673#endif /* _LINUX_ETHTOOL_H */
Linux 6.x block layer and io_uring tree(s)