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/netlink.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 struct netlink_ext_ack;
82
83 /* Some generic methods drivers may use in their ethtool_ops */
84 u32 ethtool_op_get_link(struct net_device *dev);
85 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
86
87
88 /* Link extended state and substate. */
89 struct ethtool_link_ext_state_info {
90 enum ethtool_link_ext_state link_ext_state;
91 union {
92 enum ethtool_link_ext_substate_autoneg autoneg;
93 enum ethtool_link_ext_substate_link_training link_training;
94 enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch;
95 enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity;
96 enum ethtool_link_ext_substate_cable_issue cable_issue;
97 enum ethtool_link_ext_substate_module module;
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 u32 lanes;
129 };
130
131 /**
132 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
133 * @ptr : pointer to struct ethtool_link_ksettings
134 * @name : one of supported/advertising/lp_advertising
135 */
136 #define ethtool_link_ksettings_zero_link_mode(ptr, name) \
137 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
138
139 /**
140 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
141 * link mode mask
142 * @ptr : pointer to struct ethtool_link_ksettings
143 * @name : one of supported/advertising/lp_advertising
144 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
145 * (not atomic, no bound checking)
146 */
147 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \
148 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
149
150 /**
151 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
152 * link mode mask
153 * @ptr : pointer to struct ethtool_link_ksettings
154 * @name : one of supported/advertising/lp_advertising
155 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
156 * (not atomic, no bound checking)
157 */
158 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \
159 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
160
161 /**
162 * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask
163 * @ptr : pointer to struct ethtool_link_ksettings
164 * @name : one of supported/advertising/lp_advertising
165 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
166 * (not atomic, no bound checking)
167 *
168 * Returns true/false.
169 */
170 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \
171 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
172
173 extern int
174 __ethtool_get_link_ksettings(struct net_device *dev,
175 struct ethtool_link_ksettings *link_ksettings);
176
177 struct kernel_ethtool_coalesce {
178 u8 use_cqe_mode_tx;
179 u8 use_cqe_mode_rx;
180 };
181
182 /**
183 * ethtool_intersect_link_masks - Given two link masks, AND them together
184 * @dst: first mask and where result is stored
185 * @src: second mask to intersect with
186 *
187 * Given two link mode masks, AND them together and save the result in dst.
188 */
189 void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
190 struct ethtool_link_ksettings *src);
191
192 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst,
193 u32 legacy_u32);
194
195 /* return false if src had higher bits set. lower bits always updated. */
196 bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
197 const unsigned long *src);
198
199 #define ETHTOOL_COALESCE_RX_USECS BIT(0)
200 #define ETHTOOL_COALESCE_RX_MAX_FRAMES BIT(1)
201 #define ETHTOOL_COALESCE_RX_USECS_IRQ BIT(2)
202 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ BIT(3)
203 #define ETHTOOL_COALESCE_TX_USECS BIT(4)
204 #define ETHTOOL_COALESCE_TX_MAX_FRAMES BIT(5)
205 #define ETHTOOL_COALESCE_TX_USECS_IRQ BIT(6)
206 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ BIT(7)
207 #define ETHTOOL_COALESCE_STATS_BLOCK_USECS BIT(8)
208 #define ETHTOOL_COALESCE_USE_ADAPTIVE_RX BIT(9)
209 #define ETHTOOL_COALESCE_USE_ADAPTIVE_TX BIT(10)
210 #define ETHTOOL_COALESCE_PKT_RATE_LOW BIT(11)
211 #define ETHTOOL_COALESCE_RX_USECS_LOW BIT(12)
212 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW BIT(13)
213 #define ETHTOOL_COALESCE_TX_USECS_LOW BIT(14)
214 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW BIT(15)
215 #define ETHTOOL_COALESCE_PKT_RATE_HIGH BIT(16)
216 #define ETHTOOL_COALESCE_RX_USECS_HIGH BIT(17)
217 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH BIT(18)
218 #define ETHTOOL_COALESCE_TX_USECS_HIGH BIT(19)
219 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH BIT(20)
220 #define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL BIT(21)
221 #define ETHTOOL_COALESCE_USE_CQE_RX BIT(22)
222 #define ETHTOOL_COALESCE_USE_CQE_TX BIT(23)
223 #define ETHTOOL_COALESCE_ALL_PARAMS GENMASK(23, 0)
224
225 #define ETHTOOL_COALESCE_USECS \
226 (ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS)
227 #define ETHTOOL_COALESCE_MAX_FRAMES \
228 (ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES)
229 #define ETHTOOL_COALESCE_USECS_IRQ \
230 (ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ)
231 #define ETHTOOL_COALESCE_MAX_FRAMES_IRQ \
232 (ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ | \
233 ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ)
234 #define ETHTOOL_COALESCE_USE_ADAPTIVE \
235 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX)
236 #define ETHTOOL_COALESCE_USECS_LOW_HIGH \
237 (ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \
238 ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH)
239 #define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH \
240 (ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW | \
241 ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW | \
242 ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH | \
243 ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH)
244 #define ETHTOOL_COALESCE_PKT_RATE_RX_USECS \
245 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | \
246 ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \
247 ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \
248 ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL)
249 #define ETHTOOL_COALESCE_USE_CQE \
250 (ETHTOOL_COALESCE_USE_CQE_RX | ETHTOOL_COALESCE_USE_CQE_TX)
251
252 #define ETHTOOL_STAT_NOT_SET (~0ULL)
253
ethtool_stats_init(u64 * stats,unsigned int n)254 static inline void ethtool_stats_init(u64 *stats, unsigned int n)
255 {
256 while (n--)
257 stats[n] = ETHTOOL_STAT_NOT_SET;
258 }
259
260 /* Basic IEEE 802.3 MAC statistics (30.3.1.1.*), not otherwise exposed
261 * via a more targeted API.
262 */
263 struct ethtool_eth_mac_stats {
264 u64 FramesTransmittedOK;
265 u64 SingleCollisionFrames;
266 u64 MultipleCollisionFrames;
267 u64 FramesReceivedOK;
268 u64 FrameCheckSequenceErrors;
269 u64 AlignmentErrors;
270 u64 OctetsTransmittedOK;
271 u64 FramesWithDeferredXmissions;
272 u64 LateCollisions;
273 u64 FramesAbortedDueToXSColls;
274 u64 FramesLostDueToIntMACXmitError;
275 u64 CarrierSenseErrors;
276 u64 OctetsReceivedOK;
277 u64 FramesLostDueToIntMACRcvError;
278 u64 MulticastFramesXmittedOK;
279 u64 BroadcastFramesXmittedOK;
280 u64 FramesWithExcessiveDeferral;
281 u64 MulticastFramesReceivedOK;
282 u64 BroadcastFramesReceivedOK;
283 u64 InRangeLengthErrors;
284 u64 OutOfRangeLengthField;
285 u64 FrameTooLongErrors;
286 };
287
288 /* Basic IEEE 802.3 PHY statistics (30.3.2.1.*), not otherwise exposed
289 * via a more targeted API.
290 */
291 struct ethtool_eth_phy_stats {
292 u64 SymbolErrorDuringCarrier;
293 };
294
295 /* Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*), not otherwise exposed
296 * via a more targeted API.
297 */
298 struct ethtool_eth_ctrl_stats {
299 u64 MACControlFramesTransmitted;
300 u64 MACControlFramesReceived;
301 u64 UnsupportedOpcodesReceived;
302 };
303
304 /**
305 * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
306 * @tx_pause_frames: transmitted pause frame count. Reported to user space
307 * as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES.
308 *
309 * Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted`
310 * from the standard.
311 *
312 * @rx_pause_frames: received pause frame count. Reported to user space
313 * as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to:
314 *
315 * Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived`
316 * from the standard.
317 */
318 struct ethtool_pause_stats {
319 u64 tx_pause_frames;
320 u64 rx_pause_frames;
321 };
322
323 #define ETHTOOL_MAX_LANES 8
324
325 /**
326 * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC
327 * @corrected_blocks: number of received blocks corrected by FEC
328 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORRECTED.
329 *
330 * Equivalent to `30.5.1.1.17 aFECCorrectedBlocks` from the standard.
331 *
332 * @uncorrectable_blocks: number of received blocks FEC was not able to correct
333 * Reported to user space as %ETHTOOL_A_FEC_STAT_UNCORR.
334 *
335 * Equivalent to `30.5.1.1.18 aFECUncorrectableBlocks` from the standard.
336 *
337 * @corrected_bits: number of bits corrected by FEC
338 * Similar to @corrected_blocks but counts individual bit changes,
339 * not entire FEC data blocks. This is a non-standard statistic.
340 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS.
341 *
342 * @lane: per-lane/PCS-instance counts as defined by the standard
343 * @total: error counts for the entire port, for drivers incapable of reporting
344 * per-lane stats
345 *
346 * Drivers should fill in either only total or per-lane statistics, core
347 * will take care of adding lane values up to produce the total.
348 */
349 struct ethtool_fec_stats {
350 struct ethtool_fec_stat {
351 u64 total;
352 u64 lanes[ETHTOOL_MAX_LANES];
353 } corrected_blocks, uncorrectable_blocks, corrected_bits;
354 };
355
356 /**
357 * struct ethtool_rmon_hist_range - byte range for histogram statistics
358 * @low: low bound of the bucket (inclusive)
359 * @high: high bound of the bucket (inclusive)
360 */
361 struct ethtool_rmon_hist_range {
362 u16 low;
363 u16 high;
364 };
365
366 #define ETHTOOL_RMON_HIST_MAX 10
367
368 /**
369 * struct ethtool_rmon_stats - selected RMON (RFC 2819) statistics
370 * @undersize_pkts: Equivalent to `etherStatsUndersizePkts` from the RFC.
371 * @oversize_pkts: Equivalent to `etherStatsOversizePkts` from the RFC.
372 * @fragments: Equivalent to `etherStatsFragments` from the RFC.
373 * @jabbers: Equivalent to `etherStatsJabbers` from the RFC.
374 * @hist: Packet counter for packet length buckets (e.g.
375 * `etherStatsPkts128to255Octets` from the RFC).
376 * @hist_tx: Tx counters in similar form to @hist, not defined in the RFC.
377 *
378 * Selection of RMON (RFC 2819) statistics which are not exposed via different
379 * APIs, primarily the packet-length-based counters.
380 * Unfortunately different designs choose different buckets beyond
381 * the 1024B mark (jumbo frame teritory), so the definition of the bucket
382 * ranges is left to the driver.
383 */
384 struct ethtool_rmon_stats {
385 u64 undersize_pkts;
386 u64 oversize_pkts;
387 u64 fragments;
388 u64 jabbers;
389
390 u64 hist[ETHTOOL_RMON_HIST_MAX];
391 u64 hist_tx[ETHTOOL_RMON_HIST_MAX];
392 };
393
394 #define ETH_MODULE_EEPROM_PAGE_LEN 128
395 #define ETH_MODULE_MAX_I2C_ADDRESS 0x7f
396
397 /**
398 * struct ethtool_module_eeprom - EEPROM dump from specified page
399 * @offset: Offset within the specified EEPROM page to begin read, in bytes.
400 * @length: Number of bytes to read.
401 * @page: Page number to read from.
402 * @bank: Page bank number to read from, if applicable by EEPROM spec.
403 * @i2c_address: I2C address of a page. Value less than 0x7f expected. Most
404 * EEPROMs use 0x50 or 0x51.
405 * @data: Pointer to buffer with EEPROM data of @length size.
406 *
407 * This can be used to manage pages during EEPROM dump in ethtool and pass
408 * required information to the driver.
409 */
410 struct ethtool_module_eeprom {
411 u32 offset;
412 u32 length;
413 u8 page;
414 u8 bank;
415 u8 i2c_address;
416 u8 *data;
417 };
418
419 /**
420 * struct ethtool_module_power_mode_params - module power mode parameters
421 * @policy: The power mode policy enforced by the host for the plug-in module.
422 * @mode: The operational power mode of the plug-in module. Should be filled by
423 * device drivers on get operations.
424 */
425 struct ethtool_module_power_mode_params {
426 enum ethtool_module_power_mode_policy policy;
427 enum ethtool_module_power_mode mode;
428 };
429
430 /**
431 * struct ethtool_ops - optional netdev operations
432 * @cap_link_lanes_supported: indicates if the driver supports lanes
433 * parameter.
434 * @supported_coalesce_params: supported types of interrupt coalescing.
435 * @get_drvinfo: Report driver/device information. Should only set the
436 * @driver, @version, @fw_version and @bus_info fields. If not
437 * implemented, the @driver and @bus_info fields will be filled in
438 * according to the netdev's parent device.
439 * @get_regs_len: Get buffer length required for @get_regs
440 * @get_regs: Get device registers
441 * @get_wol: Report whether Wake-on-Lan is enabled
442 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
443 * or zero.
444 * @get_msglevel: Report driver message level. This should be the value
445 * of the @msg_enable field used by netif logging functions.
446 * @set_msglevel: Set driver message level
447 * @nway_reset: Restart autonegotiation. Returns a negative error code
448 * or zero.
449 * @get_link: Report whether physical link is up. Will only be called if
450 * the netdev is up. Should usually be set to ethtool_op_get_link(),
451 * which uses netif_carrier_ok().
452 * @get_link_ext_state: Report link extended state. Should set link_ext_state and
453 * link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown,
454 * do not attach ext_substate attribute to netlink message). If link_ext_state
455 * and link_ext_substate are unknown, return -ENODATA. If not implemented,
456 * link_ext_state and link_ext_substate will not be sent to userspace.
457 * @get_eeprom_len: Read range of EEPROM addresses for validation of
458 * @get_eeprom and @set_eeprom requests.
459 * Returns 0 if device does not support EEPROM access.
460 * @get_eeprom: Read data from the device EEPROM.
461 * Should fill in the magic field. Don't need to check len for zero
462 * or wraparound. Fill in the data argument with the eeprom values
463 * from offset to offset + len. Update len to the amount read.
464 * Returns an error or zero.
465 * @set_eeprom: Write data to the device EEPROM.
466 * Should validate the magic field. Don't need to check len for zero
467 * or wraparound. Update len to the amount written. Returns an error
468 * or zero.
469 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
470 * error code or zero.
471 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing
472 * types should be set in @supported_coalesce_params.
473 * Returns a negative error code or zero.
474 * @get_ringparam: Report ring sizes
475 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
476 * @get_pause_stats: Report pause frame statistics. Drivers must not zero
477 * statistics which they don't report. The stats structure is initialized
478 * to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics.
479 * @get_pauseparam: Report pause parameters
480 * @set_pauseparam: Set pause parameters. Returns a negative error code
481 * or zero.
482 * @self_test: Run specified self-tests
483 * @get_strings: Return a set of strings that describe the requested objects
484 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
485 * attached to it. The implementation may update the indicator
486 * asynchronously or synchronously, but in either case it must return
487 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
488 * and must either activate asynchronous updates and return zero, return
489 * a negative error or return a positive frequency for synchronous
490 * indication (e.g. 1 for one on/off cycle per second). If it returns
491 * a frequency then it will be called again at intervals with the
492 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
493 * the indicator accordingly. Finally, it is called with the argument
494 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
495 * negative error code or zero.
496 * @get_ethtool_stats: Return extended statistics about the device.
497 * This is only useful if the device maintains statistics not
498 * included in &struct rtnl_link_stats64.
499 * @begin: Function to be called before any other operation. Returns a
500 * negative error code or zero.
501 * @complete: Function to be called after any other operation except
502 * @begin. Will be called even if the other operation failed.
503 * @get_priv_flags: Report driver-specific feature flags.
504 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
505 * error code or zero.
506 * @get_sset_count: Get number of strings that @get_strings will write.
507 * @get_rxnfc: Get RX flow classification rules. Returns a negative
508 * error code or zero.
509 * @set_rxnfc: Set RX flow classification rules. Returns a negative
510 * error code or zero.
511 * @flash_device: Write a firmware image to device's flash memory.
512 * Returns a negative error code or zero.
513 * @reset: Reset (part of) the device, as specified by a bitmask of
514 * flags from &enum ethtool_reset_flags. Returns a negative
515 * error code or zero.
516 * @get_rxfh_key_size: Get the size of the RX flow hash key.
517 * Returns zero if not supported for this specific device.
518 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
519 * Returns zero if not supported for this specific device.
520 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
521 * and/or hash function.
522 * Returns a negative error code or zero.
523 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
524 * key, and/or hash function. Arguments which are set to %NULL or zero
525 * will remain unchanged.
526 * Returns a negative error code or zero. An error code must be returned
527 * if at least one unsupported change was requested.
528 * @get_rxfh_context: Get the contents of the RX flow hash indirection table,
529 * hash key, and/or hash function assiciated to the given rss context.
530 * Returns a negative error code or zero.
531 * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting
532 * the contents of the RX flow hash indirection table, hash key, and/or
533 * hash function associated to the given context. Arguments which are set
534 * to %NULL or zero will remain unchanged.
535 * Returns a negative error code or zero. An error code must be returned
536 * if at least one unsupported change was requested.
537 * @get_channels: Get number of channels.
538 * @set_channels: Set number of channels. Returns a negative error code or
539 * zero.
540 * @get_dump_flag: Get dump flag indicating current dump length, version,
541 * and flag of the device.
542 * @get_dump_data: Get dump data.
543 * @set_dump: Set dump specific flags to the device.
544 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
545 * Drivers supporting transmit time stamps in software should set this to
546 * ethtool_op_get_ts_info().
547 * @get_module_info: Get the size and type of the eeprom contained within
548 * a plug-in module.
549 * @get_module_eeprom: Get the eeprom information from the plug-in module
550 * @get_eee: Get Energy-Efficient (EEE) supported and status.
551 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
552 * @get_tunable: Read the value of a driver / device tunable.
553 * @set_tunable: Set the value of a driver / device tunable.
554 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
555 * It must check that the given queue number is valid. If neither a RX nor
556 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
557 * queue has this number, set the inapplicable fields to ~0 and return 0.
558 * Returns a negative error code or zero.
559 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
560 * It must check that the given queue number is valid. If neither a RX nor
561 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
562 * queue has this number, ignore the inapplicable fields. Supported
563 * coalescing types should be set in @supported_coalesce_params.
564 * Returns a negative error code or zero.
565 * @get_link_ksettings: Get various device settings including Ethernet link
566 * settings. The %cmd and %link_mode_masks_nwords fields should be
567 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
568 * any change to them will be overwritten by kernel. Returns a negative
569 * error code or zero.
570 * @set_link_ksettings: Set various device settings including Ethernet link
571 * settings. The %cmd and %link_mode_masks_nwords fields should be
572 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
573 * any change to them will be overwritten by kernel. Returns a negative
574 * error code or zero.
575 * @get_fec_stats: Report FEC statistics.
576 * Core will sum up per-lane stats to get the total.
577 * Drivers must not zero statistics which they don't report. The stats
578 * structure is initialized to ETHTOOL_STAT_NOT_SET indicating driver does
579 * not report statistics.
580 * @get_fecparam: Get the network device Forward Error Correction parameters.
581 * @set_fecparam: Set the network device Forward Error Correction parameters.
582 * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
583 * This is only useful if the device maintains PHY statistics and
584 * cannot use the standard PHY library helpers.
585 * @get_phy_tunable: Read the value of a PHY tunable.
586 * @set_phy_tunable: Set the value of a PHY tunable.
587 * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from
588 * specified page. Returns a negative error code or the amount of bytes
589 * read.
590 * @get_eth_phy_stats: Query some of the IEEE 802.3 PHY statistics.
591 * @get_eth_mac_stats: Query some of the IEEE 802.3 MAC statistics.
592 * @get_eth_ctrl_stats: Query some of the IEEE 802.3 MAC Ctrl statistics.
593 * @get_rmon_stats: Query some of the RMON (RFC 2819) statistics.
594 * Set %ranges to a pointer to zero-terminated array of byte ranges.
595 * @get_module_power_mode: Get the power mode policy for the plug-in module
596 * used by the network device and its operational power mode, if
597 * plugged-in.
598 * @set_module_power_mode: Set the power mode policy for the plug-in module
599 * used by the network device.
600 *
601 * All operations are optional (i.e. the function pointer may be set
602 * to %NULL) and callers must take this into account. Callers must
603 * hold the RTNL lock.
604 *
605 * See the structures used by these operations for further documentation.
606 * Note that for all operations using a structure ending with a zero-
607 * length array, the array is allocated separately in the kernel and
608 * is passed to the driver as an additional parameter.
609 *
610 * See &struct net_device and &struct net_device_ops for documentation
611 * of the generic netdev features interface.
612 */
613 struct ethtool_ops {
614 u32 cap_link_lanes_supported:1;
615 u32 supported_coalesce_params;
616 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
617 int (*get_regs_len)(struct net_device *);
618 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
619 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
620 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
621 u32 (*get_msglevel)(struct net_device *);
622 void (*set_msglevel)(struct net_device *, u32);
623 int (*nway_reset)(struct net_device *);
624 u32 (*get_link)(struct net_device *);
625 int (*get_link_ext_state)(struct net_device *,
626 struct ethtool_link_ext_state_info *);
627 int (*get_eeprom_len)(struct net_device *);
628 int (*get_eeprom)(struct net_device *,
629 struct ethtool_eeprom *, u8 *);
630 int (*set_eeprom)(struct net_device *,
631 struct ethtool_eeprom *, u8 *);
632 int (*get_coalesce)(struct net_device *,
633 struct ethtool_coalesce *,
634 struct kernel_ethtool_coalesce *,
635 struct netlink_ext_ack *);
636 int (*set_coalesce)(struct net_device *,
637 struct ethtool_coalesce *,
638 struct kernel_ethtool_coalesce *,
639 struct netlink_ext_ack *);
640 void (*get_ringparam)(struct net_device *,
641 struct ethtool_ringparam *);
642 int (*set_ringparam)(struct net_device *,
643 struct ethtool_ringparam *);
644 void (*get_pause_stats)(struct net_device *dev,
645 struct ethtool_pause_stats *pause_stats);
646 void (*get_pauseparam)(struct net_device *,
647 struct ethtool_pauseparam*);
648 int (*set_pauseparam)(struct net_device *,
649 struct ethtool_pauseparam*);
650 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
651 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
652 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
653 void (*get_ethtool_stats)(struct net_device *,
654 struct ethtool_stats *, u64 *);
655 int (*begin)(struct net_device *);
656 void (*complete)(struct net_device *);
657 u32 (*get_priv_flags)(struct net_device *);
658 int (*set_priv_flags)(struct net_device *, u32);
659 int (*get_sset_count)(struct net_device *, int);
660 int (*get_rxnfc)(struct net_device *,
661 struct ethtool_rxnfc *, u32 *rule_locs);
662 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
663 int (*flash_device)(struct net_device *, struct ethtool_flash *);
664 int (*reset)(struct net_device *, u32 *);
665 u32 (*get_rxfh_key_size)(struct net_device *);
666 u32 (*get_rxfh_indir_size)(struct net_device *);
667 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
668 u8 *hfunc);
669 int (*set_rxfh)(struct net_device *, const u32 *indir,
670 const u8 *key, const u8 hfunc);
671 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key,
672 u8 *hfunc, u32 rss_context);
673 int (*set_rxfh_context)(struct net_device *, const u32 *indir,
674 const u8 *key, const u8 hfunc,
675 u32 *rss_context, bool delete);
676 void (*get_channels)(struct net_device *, struct ethtool_channels *);
677 int (*set_channels)(struct net_device *, struct ethtool_channels *);
678 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
679 int (*get_dump_data)(struct net_device *,
680 struct ethtool_dump *, void *);
681 int (*set_dump)(struct net_device *, struct ethtool_dump *);
682 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
683 int (*get_module_info)(struct net_device *,
684 struct ethtool_modinfo *);
685 int (*get_module_eeprom)(struct net_device *,
686 struct ethtool_eeprom *, u8 *);
687 int (*get_eee)(struct net_device *, struct ethtool_eee *);
688 int (*set_eee)(struct net_device *, struct ethtool_eee *);
689 int (*get_tunable)(struct net_device *,
690 const struct ethtool_tunable *, void *);
691 int (*set_tunable)(struct net_device *,
692 const struct ethtool_tunable *, const void *);
693 int (*get_per_queue_coalesce)(struct net_device *, u32,
694 struct ethtool_coalesce *);
695 int (*set_per_queue_coalesce)(struct net_device *, u32,
696 struct ethtool_coalesce *);
697 int (*get_link_ksettings)(struct net_device *,
698 struct ethtool_link_ksettings *);
699 int (*set_link_ksettings)(struct net_device *,
700 const struct ethtool_link_ksettings *);
701 void (*get_fec_stats)(struct net_device *dev,
702 struct ethtool_fec_stats *fec_stats);
703 int (*get_fecparam)(struct net_device *,
704 struct ethtool_fecparam *);
705 int (*set_fecparam)(struct net_device *,
706 struct ethtool_fecparam *);
707 void (*get_ethtool_phy_stats)(struct net_device *,
708 struct ethtool_stats *, u64 *);
709 int (*get_phy_tunable)(struct net_device *,
710 const struct ethtool_tunable *, void *);
711 int (*set_phy_tunable)(struct net_device *,
712 const struct ethtool_tunable *, const void *);
713 int (*get_module_eeprom_by_page)(struct net_device *dev,
714 const struct ethtool_module_eeprom *page,
715 struct netlink_ext_ack *extack);
716 void (*get_eth_phy_stats)(struct net_device *dev,
717 struct ethtool_eth_phy_stats *phy_stats);
718 void (*get_eth_mac_stats)(struct net_device *dev,
719 struct ethtool_eth_mac_stats *mac_stats);
720 void (*get_eth_ctrl_stats)(struct net_device *dev,
721 struct ethtool_eth_ctrl_stats *ctrl_stats);
722 void (*get_rmon_stats)(struct net_device *dev,
723 struct ethtool_rmon_stats *rmon_stats,
724 const struct ethtool_rmon_hist_range **ranges);
725 int (*get_module_power_mode)(struct net_device *dev,
726 struct ethtool_module_power_mode_params *params,
727 struct netlink_ext_ack *extack);
728 int (*set_module_power_mode)(struct net_device *dev,
729 const struct ethtool_module_power_mode_params *params,
730 struct netlink_ext_ack *extack);
731 };
732
733 int ethtool_check_ops(const struct ethtool_ops *ops);
734
735 struct ethtool_rx_flow_rule {
736 struct flow_rule *rule;
737 unsigned long priv[];
738 };
739
740 struct ethtool_rx_flow_spec_input {
741 const struct ethtool_rx_flow_spec *fs;
742 u32 rss_ctx;
743 };
744
745 struct ethtool_rx_flow_rule *
746 ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
747 void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
748
749 bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
750 int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
751 const struct ethtool_link_ksettings *cmd,
752 u32 *dev_speed, u8 *dev_duplex);
753
754 struct phy_device;
755 struct phy_tdr_config;
756
757 /**
758 * struct ethtool_phy_ops - Optional PHY device options
759 * @get_sset_count: Get number of strings that @get_strings will write.
760 * @get_strings: Return a set of strings that describe the requested objects
761 * @get_stats: Return extended statistics about the PHY device.
762 * @start_cable_test: Start a cable test
763 * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test
764 *
765 * All operations are optional (i.e. the function pointer may be set to %NULL)
766 * and callers must take this into account. Callers must hold the RTNL lock.
767 */
768 struct ethtool_phy_ops {
769 int (*get_sset_count)(struct phy_device *dev);
770 int (*get_strings)(struct phy_device *dev, u8 *data);
771 int (*get_stats)(struct phy_device *dev,
772 struct ethtool_stats *stats, u64 *data);
773 int (*start_cable_test)(struct phy_device *phydev,
774 struct netlink_ext_ack *extack);
775 int (*start_cable_test_tdr)(struct phy_device *phydev,
776 struct netlink_ext_ack *extack,
777 const struct phy_tdr_config *config);
778 };
779
780 /**
781 * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
782 * @ops: Ethtool PHY operations to set
783 */
784 void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops);
785
786 /**
787 * ethtool_params_from_link_mode - Derive link parameters from a given link mode
788 * @link_ksettings: Link parameters to be derived from the link mode
789 * @link_mode: Link mode
790 */
791 void
792 ethtool_params_from_link_mode(struct ethtool_link_ksettings *link_ksettings,
793 enum ethtool_link_mode_bit_indices link_mode);
794
795 /**
796 * ethtool_get_phc_vclocks - Derive phc vclocks information, and caller
797 * is responsible to free memory of vclock_index
798 * @dev: pointer to net_device structure
799 * @vclock_index: pointer to pointer of vclock index
800 *
801 * Return number of phc vclocks
802 */
803 int ethtool_get_phc_vclocks(struct net_device *dev, int **vclock_index);
804
805 /**
806 * ethtool_sprintf - Write formatted string to ethtool string data
807 * @data: Pointer to start of string to update
808 * @fmt: Format of string to write
809 *
810 * Write formatted string to data. Update data to point at start of
811 * next string.
812 */
813 extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);
814 #endif /* _LINUX_ETHTOOL_H */
815