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/if_ether.h>
19 #include <linux/netlink.h>
20 #include <uapi/linux/ethtool.h>
21 #include <uapi/linux/net_tstamp.h>
22
23 struct compat_ethtool_rx_flow_spec {
24 u32 flow_type;
25 union ethtool_flow_union h_u;
26 struct ethtool_flow_ext h_ext;
27 union ethtool_flow_union m_u;
28 struct ethtool_flow_ext m_ext;
29 compat_u64 ring_cookie;
30 u32 location;
31 };
32
33 struct compat_ethtool_rxnfc {
34 u32 cmd;
35 u32 flow_type;
36 compat_u64 data;
37 struct compat_ethtool_rx_flow_spec fs;
38 u32 rule_cnt;
39 u32 rule_locs[];
40 };
41
42 #include <linux/rculist.h>
43
44 /**
45 * enum ethtool_phys_id_state - indicator state for physical identification
46 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
47 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
48 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
49 * is not supported)
50 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
51 * is not supported)
52 */
53 enum ethtool_phys_id_state {
54 ETHTOOL_ID_INACTIVE,
55 ETHTOOL_ID_ACTIVE,
56 ETHTOOL_ID_ON,
57 ETHTOOL_ID_OFF
58 };
59
60 enum {
61 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
62 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
63 ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */
64
65 /*
66 * Add your fresh new hash function bits above and remember to update
67 * rss_hash_func_strings[] in ethtool.c
68 */
69 ETH_RSS_HASH_FUNCS_COUNT
70 };
71
72 /**
73 * struct kernel_ethtool_ringparam - RX/TX ring configuration
74 * @rx_buf_len: Current length of buffers on the rx ring.
75 * @tcp_data_split: Scatter packet headers and data to separate buffers
76 * @tx_push: The flag of tx push mode
77 * @rx_push: The flag of rx push mode
78 * @cqe_size: Size of TX/RX completion queue event
79 * @tx_push_buf_len: Size of TX push buffer
80 * @tx_push_buf_max_len: Maximum allowed size of TX push buffer
81 * @hds_thresh: Packet size threshold for header data split (HDS)
82 * @hds_thresh_max: Maximum supported setting for @hds_threshold
83 *
84 */
85 struct kernel_ethtool_ringparam {
86 u32 rx_buf_len;
87 u8 tcp_data_split;
88 u8 tx_push;
89 u8 rx_push;
90 u32 cqe_size;
91 u32 tx_push_buf_len;
92 u32 tx_push_buf_max_len;
93 u32 hds_thresh;
94 u32 hds_thresh_max;
95 };
96
97 /**
98 * enum ethtool_supported_ring_param - indicator caps for setting ring params
99 * @ETHTOOL_RING_USE_RX_BUF_LEN: capture for setting rx_buf_len
100 * @ETHTOOL_RING_USE_CQE_SIZE: capture for setting cqe_size
101 * @ETHTOOL_RING_USE_TX_PUSH: capture for setting tx_push
102 * @ETHTOOL_RING_USE_RX_PUSH: capture for setting rx_push
103 * @ETHTOOL_RING_USE_TX_PUSH_BUF_LEN: capture for setting tx_push_buf_len
104 * @ETHTOOL_RING_USE_TCP_DATA_SPLIT: capture for setting tcp_data_split
105 * @ETHTOOL_RING_USE_HDS_THRS: capture for setting header-data-split-thresh
106 */
107 enum ethtool_supported_ring_param {
108 ETHTOOL_RING_USE_RX_BUF_LEN = BIT(0),
109 ETHTOOL_RING_USE_CQE_SIZE = BIT(1),
110 ETHTOOL_RING_USE_TX_PUSH = BIT(2),
111 ETHTOOL_RING_USE_RX_PUSH = BIT(3),
112 ETHTOOL_RING_USE_TX_PUSH_BUF_LEN = BIT(4),
113 ETHTOOL_RING_USE_TCP_DATA_SPLIT = BIT(5),
114 ETHTOOL_RING_USE_HDS_THRS = BIT(6),
115 };
116
117 #define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit))
118 #define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
119
120 #define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP)
121 #define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR)
122 #define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32)
123
124 #define ETH_RSS_HASH_UNKNOWN 0
125 #define ETH_RSS_HASH_NO_CHANGE 0
126
127 struct net_device;
128 struct netlink_ext_ack;
129
130 /* Link extended state and substate. */
131 struct ethtool_link_ext_state_info {
132 enum ethtool_link_ext_state link_ext_state;
133 union {
134 enum ethtool_link_ext_substate_autoneg autoneg;
135 enum ethtool_link_ext_substate_link_training link_training;
136 enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch;
137 enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity;
138 enum ethtool_link_ext_substate_cable_issue cable_issue;
139 enum ethtool_link_ext_substate_module module;
140 u32 __link_ext_substate;
141 };
142 };
143
144 struct ethtool_link_ext_stats {
145 /* Custom Linux statistic for PHY level link down events.
146 * In a simpler world it should be equal to netdev->carrier_down_count
147 * unfortunately netdev also counts local reconfigurations which don't
148 * actually take the physical link down, not to mention NC-SI which,
149 * if present, keeps the link up regardless of host state.
150 * This statistic counts when PHY _actually_ went down, or lost link.
151 *
152 * Note that we need u64 for ethtool_stats_init() and comparisons
153 * to ETHTOOL_STAT_NOT_SET, but only u32 is exposed to the user.
154 */
155 u64 link_down_events;
156 };
157
158 /**
159 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
160 * @index: Index in RX flow hash indirection table
161 * @n_rx_rings: Number of RX rings to use
162 *
163 * This function provides the default policy for RX flow hash indirection.
164 */
ethtool_rxfh_indir_default(u32 index,u32 n_rx_rings)165 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
166 {
167 return index % n_rx_rings;
168 }
169
170 /**
171 * struct ethtool_rxfh_context - a custom RSS context configuration
172 * @indir_size: Number of u32 entries in indirection table
173 * @key_size: Size of hash key, in bytes
174 * @priv_size: Size of driver private data, in bytes
175 * @hfunc: RSS hash function identifier. One of the %ETH_RSS_HASH_*
176 * @input_xfrm: Defines how the input data is transformed. Valid values are one
177 * of %RXH_XFRM_*.
178 * @indir_configured: indir has been specified (at create time or subsequently)
179 * @key_configured: hkey has been specified (at create time or subsequently)
180 */
181 struct ethtool_rxfh_context {
182 u32 indir_size;
183 u32 key_size;
184 u16 priv_size;
185 u8 hfunc;
186 u8 input_xfrm;
187 u8 indir_configured:1;
188 u8 key_configured:1;
189 /* private: driver private data, indirection table, and hash key are
190 * stored sequentially in @data area. Use below helpers to access.
191 */
192 u32 key_off;
193 u8 data[] __aligned(sizeof(void *));
194 };
195
ethtool_rxfh_context_priv(struct ethtool_rxfh_context * ctx)196 static inline void *ethtool_rxfh_context_priv(struct ethtool_rxfh_context *ctx)
197 {
198 return ctx->data;
199 }
200
ethtool_rxfh_context_indir(struct ethtool_rxfh_context * ctx)201 static inline u32 *ethtool_rxfh_context_indir(struct ethtool_rxfh_context *ctx)
202 {
203 return (u32 *)(ctx->data + ALIGN(ctx->priv_size, sizeof(u32)));
204 }
205
ethtool_rxfh_context_key(struct ethtool_rxfh_context * ctx)206 static inline u8 *ethtool_rxfh_context_key(struct ethtool_rxfh_context *ctx)
207 {
208 return &ctx->data[ctx->key_off];
209 }
210
211 void ethtool_rxfh_context_lost(struct net_device *dev, u32 context_id);
212
213 struct link_mode_info {
214 int speed;
215 u8 lanes;
216 u8 duplex;
217 };
218
219 extern const struct link_mode_info link_mode_params[];
220
221 /* declare a link mode bitmap */
222 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \
223 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
224
225 /* drivers must ignore base.cmd and base.link_mode_masks_nwords
226 * fields, but they are allowed to overwrite them (will be ignored).
227 */
228 struct ethtool_link_ksettings {
229 struct ethtool_link_settings base;
230 struct {
231 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
232 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
233 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
234 } link_modes;
235 u32 lanes;
236 };
237
238 /**
239 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
240 * @ptr : pointer to struct ethtool_link_ksettings
241 * @name : one of supported/advertising/lp_advertising
242 */
243 #define ethtool_link_ksettings_zero_link_mode(ptr, name) \
244 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
245
246 /**
247 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
248 * link mode mask
249 * @ptr : pointer to struct ethtool_link_ksettings
250 * @name : one of supported/advertising/lp_advertising
251 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
252 * (not atomic, no bound checking)
253 */
254 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \
255 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
256
257 /**
258 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
259 * link mode mask
260 * @ptr : pointer to struct ethtool_link_ksettings
261 * @name : one of supported/advertising/lp_advertising
262 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
263 * (not atomic, no bound checking)
264 */
265 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \
266 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
267
268 /**
269 * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask
270 * @ptr : pointer to struct ethtool_link_ksettings
271 * @name : one of supported/advertising/lp_advertising
272 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
273 * (not atomic, no bound checking)
274 *
275 * Returns: true/false.
276 */
277 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \
278 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
279
280 extern int
281 __ethtool_get_link_ksettings(struct net_device *dev,
282 struct ethtool_link_ksettings *link_ksettings);
283
284 struct ethtool_keee {
285 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
286 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertised);
287 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertised);
288 u32 tx_lpi_timer;
289 bool tx_lpi_enabled;
290 bool eee_active;
291 bool eee_enabled;
292 };
293
294 struct kernel_ethtool_coalesce {
295 u8 use_cqe_mode_tx;
296 u8 use_cqe_mode_rx;
297 u32 tx_aggr_max_bytes;
298 u32 tx_aggr_max_frames;
299 u32 tx_aggr_time_usecs;
300 };
301
302 /**
303 * ethtool_intersect_link_masks - Given two link masks, AND them together
304 * @dst: first mask and where result is stored
305 * @src: second mask to intersect with
306 *
307 * Given two link mode masks, AND them together and save the result in dst.
308 */
309 void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
310 struct ethtool_link_ksettings *src);
311
312 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst,
313 u32 legacy_u32);
314
315 /* return false if src had higher bits set. lower bits always updated. */
316 bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
317 const unsigned long *src);
318
319 #define ETHTOOL_COALESCE_RX_USECS BIT(0)
320 #define ETHTOOL_COALESCE_RX_MAX_FRAMES BIT(1)
321 #define ETHTOOL_COALESCE_RX_USECS_IRQ BIT(2)
322 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ BIT(3)
323 #define ETHTOOL_COALESCE_TX_USECS BIT(4)
324 #define ETHTOOL_COALESCE_TX_MAX_FRAMES BIT(5)
325 #define ETHTOOL_COALESCE_TX_USECS_IRQ BIT(6)
326 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ BIT(7)
327 #define ETHTOOL_COALESCE_STATS_BLOCK_USECS BIT(8)
328 #define ETHTOOL_COALESCE_USE_ADAPTIVE_RX BIT(9)
329 #define ETHTOOL_COALESCE_USE_ADAPTIVE_TX BIT(10)
330 #define ETHTOOL_COALESCE_PKT_RATE_LOW BIT(11)
331 #define ETHTOOL_COALESCE_RX_USECS_LOW BIT(12)
332 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW BIT(13)
333 #define ETHTOOL_COALESCE_TX_USECS_LOW BIT(14)
334 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW BIT(15)
335 #define ETHTOOL_COALESCE_PKT_RATE_HIGH BIT(16)
336 #define ETHTOOL_COALESCE_RX_USECS_HIGH BIT(17)
337 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH BIT(18)
338 #define ETHTOOL_COALESCE_TX_USECS_HIGH BIT(19)
339 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH BIT(20)
340 #define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL BIT(21)
341 #define ETHTOOL_COALESCE_USE_CQE_RX BIT(22)
342 #define ETHTOOL_COALESCE_USE_CQE_TX BIT(23)
343 #define ETHTOOL_COALESCE_TX_AGGR_MAX_BYTES BIT(24)
344 #define ETHTOOL_COALESCE_TX_AGGR_MAX_FRAMES BIT(25)
345 #define ETHTOOL_COALESCE_TX_AGGR_TIME_USECS BIT(26)
346 #define ETHTOOL_COALESCE_RX_PROFILE BIT(27)
347 #define ETHTOOL_COALESCE_TX_PROFILE BIT(28)
348 #define ETHTOOL_COALESCE_ALL_PARAMS GENMASK(28, 0)
349
350 #define ETHTOOL_COALESCE_USECS \
351 (ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS)
352 #define ETHTOOL_COALESCE_MAX_FRAMES \
353 (ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES)
354 #define ETHTOOL_COALESCE_USECS_IRQ \
355 (ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ)
356 #define ETHTOOL_COALESCE_MAX_FRAMES_IRQ \
357 (ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ | \
358 ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ)
359 #define ETHTOOL_COALESCE_USE_ADAPTIVE \
360 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX)
361 #define ETHTOOL_COALESCE_USECS_LOW_HIGH \
362 (ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \
363 ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH)
364 #define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH \
365 (ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW | \
366 ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW | \
367 ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH | \
368 ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH)
369 #define ETHTOOL_COALESCE_PKT_RATE_RX_USECS \
370 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | \
371 ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \
372 ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \
373 ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL)
374 #define ETHTOOL_COALESCE_USE_CQE \
375 (ETHTOOL_COALESCE_USE_CQE_RX | ETHTOOL_COALESCE_USE_CQE_TX)
376 #define ETHTOOL_COALESCE_TX_AGGR \
377 (ETHTOOL_COALESCE_TX_AGGR_MAX_BYTES | \
378 ETHTOOL_COALESCE_TX_AGGR_MAX_FRAMES | \
379 ETHTOOL_COALESCE_TX_AGGR_TIME_USECS)
380
381 #define ETHTOOL_STAT_NOT_SET (~0ULL)
382
ethtool_stats_init(u64 * stats,unsigned int n)383 static inline void ethtool_stats_init(u64 *stats, unsigned int n)
384 {
385 while (n--)
386 stats[n] = ETHTOOL_STAT_NOT_SET;
387 }
388
389 /* Basic IEEE 802.3 MAC statistics (30.3.1.1.*), not otherwise exposed
390 * via a more targeted API.
391 */
392 struct ethtool_eth_mac_stats {
393 enum ethtool_mac_stats_src src;
394 struct_group(stats,
395 u64 FramesTransmittedOK;
396 u64 SingleCollisionFrames;
397 u64 MultipleCollisionFrames;
398 u64 FramesReceivedOK;
399 u64 FrameCheckSequenceErrors;
400 u64 AlignmentErrors;
401 u64 OctetsTransmittedOK;
402 u64 FramesWithDeferredXmissions;
403 u64 LateCollisions;
404 u64 FramesAbortedDueToXSColls;
405 u64 FramesLostDueToIntMACXmitError;
406 u64 CarrierSenseErrors;
407 u64 OctetsReceivedOK;
408 u64 FramesLostDueToIntMACRcvError;
409 u64 MulticastFramesXmittedOK;
410 u64 BroadcastFramesXmittedOK;
411 u64 FramesWithExcessiveDeferral;
412 u64 MulticastFramesReceivedOK;
413 u64 BroadcastFramesReceivedOK;
414 u64 InRangeLengthErrors;
415 u64 OutOfRangeLengthField;
416 u64 FrameTooLongErrors;
417 );
418 };
419
420 /* Basic IEEE 802.3 PHY statistics (30.3.2.1.*), not otherwise exposed
421 * via a more targeted API.
422 */
423 struct ethtool_eth_phy_stats {
424 enum ethtool_mac_stats_src src;
425 struct_group(stats,
426 u64 SymbolErrorDuringCarrier;
427 );
428 };
429
430 /**
431 * struct ethtool_phy_stats - PHY-level statistics counters
432 * @rx_packets: Total successfully received frames
433 * @rx_bytes: Total successfully received bytes
434 * @rx_errors: Total received frames with errors (e.g., CRC errors)
435 * @tx_packets: Total successfully transmitted frames
436 * @tx_bytes: Total successfully transmitted bytes
437 * @tx_errors: Total transmitted frames with errors
438 *
439 * This structure provides a standardized interface for reporting
440 * PHY-level statistics counters. It is designed to expose statistics
441 * commonly provided by PHYs but not explicitly defined in the IEEE
442 * 802.3 standard.
443 */
444 struct ethtool_phy_stats {
445 u64 rx_packets;
446 u64 rx_bytes;
447 u64 rx_errors;
448 u64 tx_packets;
449 u64 tx_bytes;
450 u64 tx_errors;
451 };
452
453 /* Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*), not otherwise exposed
454 * via a more targeted API.
455 */
456 struct ethtool_eth_ctrl_stats {
457 enum ethtool_mac_stats_src src;
458 struct_group(stats,
459 u64 MACControlFramesTransmitted;
460 u64 MACControlFramesReceived;
461 u64 UnsupportedOpcodesReceived;
462 );
463 };
464
465 /**
466 * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
467 * @src: input field denoting whether stats should be queried from the eMAC or
468 * pMAC (if the MM layer is supported). To be ignored otherwise.
469 * @tx_pause_frames: transmitted pause frame count. Reported to user space
470 * as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES.
471 *
472 * Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted`
473 * from the standard.
474 *
475 * @rx_pause_frames: received pause frame count. Reported to user space
476 * as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to:
477 *
478 * Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived`
479 * from the standard.
480 */
481 struct ethtool_pause_stats {
482 enum ethtool_mac_stats_src src;
483 struct_group(stats,
484 u64 tx_pause_frames;
485 u64 rx_pause_frames;
486 );
487 };
488
489 #define ETHTOOL_MAX_LANES 8
490
491 /**
492 * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC
493 * @corrected_blocks: number of received blocks corrected by FEC
494 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORRECTED.
495 *
496 * Equivalent to `30.5.1.1.17 aFECCorrectedBlocks` from the standard.
497 *
498 * @uncorrectable_blocks: number of received blocks FEC was not able to correct
499 * Reported to user space as %ETHTOOL_A_FEC_STAT_UNCORR.
500 *
501 * Equivalent to `30.5.1.1.18 aFECUncorrectableBlocks` from the standard.
502 *
503 * @corrected_bits: number of bits corrected by FEC
504 * Similar to @corrected_blocks but counts individual bit changes,
505 * not entire FEC data blocks. This is a non-standard statistic.
506 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS.
507 *
508 * For each of the above fields, the two substructure members are:
509 *
510 * - @lanes: per-lane/PCS-instance counts as defined by the standard
511 * - @total: error counts for the entire port, for drivers incapable of reporting
512 * per-lane stats
513 *
514 * Drivers should fill in either only total or per-lane statistics, core
515 * will take care of adding lane values up to produce the total.
516 */
517 struct ethtool_fec_stats {
518 struct ethtool_fec_stat {
519 u64 total;
520 u64 lanes[ETHTOOL_MAX_LANES];
521 } corrected_blocks, uncorrectable_blocks, corrected_bits;
522 };
523
524 /**
525 * struct ethtool_rmon_hist_range - byte range for histogram statistics
526 * @low: low bound of the bucket (inclusive)
527 * @high: high bound of the bucket (inclusive)
528 */
529 struct ethtool_rmon_hist_range {
530 u16 low;
531 u16 high;
532 };
533
534 #define ETHTOOL_RMON_HIST_MAX 10
535
536 /**
537 * struct ethtool_rmon_stats - selected RMON (RFC 2819) statistics
538 * @src: input field denoting whether stats should be queried from the eMAC or
539 * pMAC (if the MM layer is supported). To be ignored otherwise.
540 * @undersize_pkts: Equivalent to `etherStatsUndersizePkts` from the RFC.
541 * @oversize_pkts: Equivalent to `etherStatsOversizePkts` from the RFC.
542 * @fragments: Equivalent to `etherStatsFragments` from the RFC.
543 * @jabbers: Equivalent to `etherStatsJabbers` from the RFC.
544 * @hist: Packet counter for packet length buckets (e.g.
545 * `etherStatsPkts128to255Octets` from the RFC).
546 * @hist_tx: Tx counters in similar form to @hist, not defined in the RFC.
547 *
548 * Selection of RMON (RFC 2819) statistics which are not exposed via different
549 * APIs, primarily the packet-length-based counters.
550 * Unfortunately different designs choose different buckets beyond
551 * the 1024B mark (jumbo frame teritory), so the definition of the bucket
552 * ranges is left to the driver.
553 */
554 struct ethtool_rmon_stats {
555 enum ethtool_mac_stats_src src;
556 struct_group(stats,
557 u64 undersize_pkts;
558 u64 oversize_pkts;
559 u64 fragments;
560 u64 jabbers;
561
562 u64 hist[ETHTOOL_RMON_HIST_MAX];
563 u64 hist_tx[ETHTOOL_RMON_HIST_MAX];
564 );
565 };
566
567 /**
568 * struct ethtool_ts_stats - HW timestamping statistics
569 * @pkts: Number of packets successfully timestamped by the hardware.
570 * @onestep_pkts_unconfirmed: Number of PTP packets with one-step TX
571 * timestamping that were sent, but for which the
572 * device offers no confirmation whether they made
573 * it onto the wire and the timestamp was inserted
574 * in the originTimestamp or correctionField, or
575 * not.
576 * @lost: Number of hardware timestamping requests where the timestamping
577 * information from the hardware never arrived for submission with
578 * the skb.
579 * @err: Number of arbitrary timestamp generation error events that the
580 * hardware encountered, exclusive of @lost statistics. Cases such
581 * as resource exhaustion, unavailability, firmware errors, and
582 * detected illogical timestamp values not submitted with the skb
583 * are inclusive to this counter.
584 */
585 struct ethtool_ts_stats {
586 struct_group(tx_stats,
587 u64 pkts;
588 u64 onestep_pkts_unconfirmed;
589 u64 lost;
590 u64 err;
591 );
592 };
593
594 #define ETH_MODULE_EEPROM_PAGE_LEN 128
595 #define ETH_MODULE_MAX_I2C_ADDRESS 0x7f
596
597 /**
598 * struct ethtool_module_eeprom - plug-in module EEPROM read / write parameters
599 * @offset: When @offset is 0-127, it is used as an address to the Lower Memory
600 * (@page must be 0). Otherwise, it is used as an address to the
601 * Upper Memory.
602 * @length: Number of bytes to read / write.
603 * @page: Page number.
604 * @bank: Bank number, if supported by EEPROM spec.
605 * @i2c_address: I2C address of a page. Value less than 0x7f expected. Most
606 * EEPROMs use 0x50 or 0x51.
607 * @data: Pointer to buffer with EEPROM data of @length size.
608 */
609 struct ethtool_module_eeprom {
610 u32 offset;
611 u32 length;
612 u8 page;
613 u8 bank;
614 u8 i2c_address;
615 u8 *data;
616 };
617
618 /**
619 * struct ethtool_module_power_mode_params - module power mode parameters
620 * @policy: The power mode policy enforced by the host for the plug-in module.
621 * @mode: The operational power mode of the plug-in module. Should be filled by
622 * device drivers on get operations.
623 */
624 struct ethtool_module_power_mode_params {
625 enum ethtool_module_power_mode_policy policy;
626 enum ethtool_module_power_mode mode;
627 };
628
629 /**
630 * struct ethtool_mm_state - 802.3 MAC merge layer state
631 * @verify_time:
632 * wait time between verification attempts in ms (according to clause
633 * 30.14.1.6 aMACMergeVerifyTime)
634 * @max_verify_time:
635 * maximum accepted value for the @verify_time variable in set requests
636 * @verify_status:
637 * state of the verification state machine of the MM layer (according to
638 * clause 30.14.1.2 aMACMergeStatusVerify)
639 * @tx_enabled:
640 * set if the MM layer is administratively enabled in the TX direction
641 * (according to clause 30.14.1.3 aMACMergeEnableTx)
642 * @tx_active:
643 * set if the MM layer is enabled in the TX direction, which makes FP
644 * possible (according to 30.14.1.5 aMACMergeStatusTx). This should be
645 * true if MM is enabled, and the verification status is either verified,
646 * or disabled.
647 * @pmac_enabled:
648 * set if the preemptible MAC is powered on and is able to receive
649 * preemptible packets and respond to verification frames.
650 * @verify_enabled:
651 * set if the Verify function of the MM layer (which sends SMD-V
652 * verification requests) is administratively enabled (regardless of
653 * whether it is currently in the ETHTOOL_MM_VERIFY_STATUS_DISABLED state
654 * or not), according to clause 30.14.1.4 aMACMergeVerifyDisableTx (but
655 * using positive rather than negative logic). The device should always
656 * respond to received SMD-V requests as long as @pmac_enabled is set.
657 * @tx_min_frag_size:
658 * the minimum size of non-final mPacket fragments that the link partner
659 * supports receiving, expressed in octets. Compared to the definition
660 * from clause 30.14.1.7 aMACMergeAddFragSize which is expressed in the
661 * range 0 to 3 (requiring a translation to the size in octets according
662 * to the formula 64 * (1 + addFragSize) - 4), a value in a continuous and
663 * unbounded range can be specified here.
664 * @rx_min_frag_size:
665 * the minimum size of non-final mPacket fragments that this device
666 * supports receiving, expressed in octets.
667 */
668 struct ethtool_mm_state {
669 u32 verify_time;
670 u32 max_verify_time;
671 enum ethtool_mm_verify_status verify_status;
672 bool tx_enabled;
673 bool tx_active;
674 bool pmac_enabled;
675 bool verify_enabled;
676 u32 tx_min_frag_size;
677 u32 rx_min_frag_size;
678 };
679
680 /**
681 * struct ethtool_mm_cfg - 802.3 MAC merge layer configuration
682 * @verify_time: see struct ethtool_mm_state
683 * @verify_enabled: see struct ethtool_mm_state
684 * @tx_enabled: see struct ethtool_mm_state
685 * @pmac_enabled: see struct ethtool_mm_state
686 * @tx_min_frag_size: see struct ethtool_mm_state
687 */
688 struct ethtool_mm_cfg {
689 u32 verify_time;
690 bool verify_enabled;
691 bool tx_enabled;
692 bool pmac_enabled;
693 u32 tx_min_frag_size;
694 };
695
696 /**
697 * struct ethtool_mm_stats - 802.3 MAC merge layer statistics
698 * @MACMergeFrameAssErrorCount:
699 * received MAC frames with reassembly errors
700 * @MACMergeFrameSmdErrorCount:
701 * received MAC frames/fragments rejected due to unknown or incorrect SMD
702 * @MACMergeFrameAssOkCount:
703 * received MAC frames that were successfully reassembled and passed up
704 * @MACMergeFragCountRx:
705 * number of additional correct SMD-C mPackets received due to preemption
706 * @MACMergeFragCountTx:
707 * number of additional mPackets sent due to preemption
708 * @MACMergeHoldCount:
709 * number of times the MM layer entered the HOLD state, which blocks
710 * transmission of preemptible traffic
711 */
712 struct ethtool_mm_stats {
713 u64 MACMergeFrameAssErrorCount;
714 u64 MACMergeFrameSmdErrorCount;
715 u64 MACMergeFrameAssOkCount;
716 u64 MACMergeFragCountRx;
717 u64 MACMergeFragCountTx;
718 u64 MACMergeHoldCount;
719 };
720
721 /**
722 * struct ethtool_rxfh_param - RXFH (RSS) parameters
723 * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
724 * Valid values are one of the %ETH_RSS_HASH_*.
725 * @indir_size: On SET, the array size of the user buffer for the
726 * indirection table, which may be zero, or
727 * %ETH_RXFH_INDIR_NO_CHANGE. On GET (read from the driver),
728 * the array size of the hardware indirection table.
729 * @indir: The indirection table of size @indir_size entries.
730 * @key_size: On SET, the array size of the user buffer for the hash key,
731 * which may be zero. On GET (read from the driver), the size of the
732 * hardware hash key.
733 * @key: The hash key of size @key_size bytes.
734 * @rss_context: RSS context identifier. Context 0 is the default for normal
735 * traffic; other contexts can be referenced as the destination for RX flow
736 * classification rules. On SET, %ETH_RXFH_CONTEXT_ALLOC is used
737 * to allocate a new RSS context; on return this field will
738 * contain the ID of the newly allocated context.
739 * @rss_delete: Set to non-ZERO to remove the @rss_context context.
740 * @input_xfrm: Defines how the input data is transformed. Valid values are one
741 * of %RXH_XFRM_*.
742 */
743 struct ethtool_rxfh_param {
744 u8 hfunc;
745 u32 indir_size;
746 u32 *indir;
747 u32 key_size;
748 u8 *key;
749 u32 rss_context;
750 u8 rss_delete;
751 u8 input_xfrm;
752 };
753
754 /**
755 * struct kernel_ethtool_ts_info - kernel copy of struct ethtool_ts_info
756 * @cmd: command number = %ETHTOOL_GET_TS_INFO
757 * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
758 * @phc_index: device index of the associated PHC, or -1 if there is none
759 * @phc_qualifier: qualifier of the associated PHC
760 * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
761 * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
762 */
763 struct kernel_ethtool_ts_info {
764 u32 cmd;
765 u32 so_timestamping;
766 int phc_index;
767 enum hwtstamp_provider_qualifier phc_qualifier;
768 enum hwtstamp_tx_types tx_types;
769 enum hwtstamp_rx_filters rx_filters;
770 };
771
772 /**
773 * struct ethtool_ops - optional netdev operations
774 * @supported_input_xfrm: supported types of input xfrm from %RXH_XFRM_*.
775 * @cap_link_lanes_supported: indicates if the driver supports lanes
776 * parameter.
777 * @cap_rss_ctx_supported: indicates if the driver supports RSS
778 * contexts via legacy API, drivers implementing @create_rxfh_context
779 * do not have to set this bit.
780 * @rxfh_per_ctx_key: device supports setting different RSS key for each
781 * additional context. Netlink API should report hfunc, key, and input_xfrm
782 * for every context, not just context 0.
783 * @cap_rss_rxnfc_adds: device supports nonzero ring_cookie in filters with
784 * %FLOW_RSS flag; the queue ID from the filter is added to the value from
785 * the indirection table to determine the delivery queue.
786 * @rxfh_indir_space: max size of RSS indirection tables, if indirection table
787 * size as returned by @get_rxfh_indir_size may change during lifetime
788 * of the device. Leave as 0 if the table size is constant.
789 * @rxfh_key_space: same as @rxfh_indir_space, but for the key.
790 * @rxfh_priv_size: size of the driver private data area the core should
791 * allocate for an RSS context (in &struct ethtool_rxfh_context).
792 * @rxfh_max_num_contexts: maximum (exclusive) supported RSS context ID.
793 * If this is zero then the core may choose any (nonzero) ID, otherwise
794 * the core will only use IDs strictly less than this value, as the
795 * @rss_context argument to @create_rxfh_context and friends.
796 * @supported_coalesce_params: supported types of interrupt coalescing.
797 * @supported_ring_params: supported ring params.
798 * @supported_hwtstamp_qualifiers: bitfield of supported hwtstamp qualifier.
799 * @get_drvinfo: Report driver/device information. Modern drivers no
800 * longer have to implement this callback. Most fields are
801 * correctly filled in by the core using system information, or
802 * populated using other driver operations.
803 * @get_regs_len: Get buffer length required for @get_regs
804 * @get_regs: Get device registers
805 * @get_wol: Report whether Wake-on-Lan is enabled
806 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
807 * or zero.
808 * @get_msglevel: Report driver message level. This should be the value
809 * of the @msg_enable field used by netif logging functions.
810 * @set_msglevel: Set driver message level
811 * @nway_reset: Restart autonegotiation. Returns a negative error code
812 * or zero.
813 * @get_link: Report whether physical link is up. Will only be called if
814 * the netdev is up. Should usually be set to ethtool_op_get_link(),
815 * which uses netif_carrier_ok().
816 * @get_link_ext_state: Report link extended state. Should set link_ext_state and
817 * link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown,
818 * do not attach ext_substate attribute to netlink message). If link_ext_state
819 * and link_ext_substate are unknown, return -ENODATA. If not implemented,
820 * link_ext_state and link_ext_substate will not be sent to userspace.
821 * @get_link_ext_stats: Read extra link-related counters.
822 * @get_eeprom_len: Read range of EEPROM addresses for validation of
823 * @get_eeprom and @set_eeprom requests.
824 * Returns 0 if device does not support EEPROM access.
825 * @get_eeprom: Read data from the device EEPROM.
826 * Should fill in the magic field. Don't need to check len for zero
827 * or wraparound. Fill in the data argument with the eeprom values
828 * from offset to offset + len. Update len to the amount read.
829 * Returns an error or zero.
830 * @set_eeprom: Write data to the device EEPROM.
831 * Should validate the magic field. Don't need to check len for zero
832 * or wraparound. Update len to the amount written. Returns an error
833 * or zero.
834 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
835 * error code or zero.
836 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing
837 * types should be set in @supported_coalesce_params.
838 * Returns a negative error code or zero.
839 * @get_ringparam: Report ring sizes
840 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
841 * @get_pause_stats: Report pause frame statistics. Drivers must not zero
842 * statistics which they don't report. The stats structure is initialized
843 * to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics.
844 * @get_pauseparam: Report pause parameters
845 * @set_pauseparam: Set pause parameters. Returns a negative error code
846 * or zero.
847 * @self_test: Run specified self-tests
848 * @get_strings: Return a set of strings that describe the requested objects
849 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
850 * attached to it. The implementation may update the indicator
851 * asynchronously or synchronously, but in either case it must return
852 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
853 * and must either activate asynchronous updates and return zero, return
854 * a negative error or return a positive frequency for synchronous
855 * indication (e.g. 1 for one on/off cycle per second). If it returns
856 * a frequency then it will be called again at intervals with the
857 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
858 * the indicator accordingly. Finally, it is called with the argument
859 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
860 * negative error code or zero.
861 * @get_ethtool_stats: Return extended statistics about the device.
862 * This is only useful if the device maintains statistics not
863 * included in &struct rtnl_link_stats64.
864 * @begin: Function to be called before any other operation. Returns a
865 * negative error code or zero.
866 * @complete: Function to be called after any other operation except
867 * @begin. Will be called even if the other operation failed.
868 * @get_priv_flags: Report driver-specific feature flags.
869 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
870 * error code or zero.
871 * @get_sset_count: Get number of strings that @get_strings will write.
872 * @get_rxnfc: Get RX flow classification rules. Returns a negative
873 * error code or zero.
874 * @set_rxnfc: Set RX flow classification rules. Returns a negative
875 * error code or zero.
876 * @flash_device: Write a firmware image to device's flash memory.
877 * Returns a negative error code or zero.
878 * @reset: Reset (part of) the device, as specified by a bitmask of
879 * flags from &enum ethtool_reset_flags. Returns a negative
880 * error code or zero.
881 * @get_rxfh_key_size: Get the size of the RX flow hash key.
882 * Returns zero if not supported for this specific device.
883 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
884 * Returns zero if not supported for this specific device.
885 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
886 * and/or hash function.
887 * Returns a negative error code or zero.
888 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
889 * key, and/or hash function. Arguments which are set to %NULL or zero
890 * will remain unchanged.
891 * Returns a negative error code or zero. An error code must be returned
892 * if at least one unsupported change was requested.
893 * @create_rxfh_context: Create a new RSS context with the specified RX flow
894 * hash indirection table, hash key, and hash function.
895 * The &struct ethtool_rxfh_context for this context is passed in @ctx;
896 * note that the indir table, hkey and hfunc are not yet populated as
897 * of this call. The driver does not need to update these; the core
898 * will do so if this op succeeds.
899 * However, if @rxfh.indir is set to %NULL, the driver must update the
900 * indir table in @ctx with the (default or inherited) table actually in
901 * use; similarly, if @rxfh.key is %NULL, @rxfh.hfunc is
902 * %ETH_RSS_HASH_NO_CHANGE, or @rxfh.input_xfrm is %RXH_XFRM_NO_CHANGE,
903 * the driver should update the corresponding information in @ctx.
904 * If the driver provides this method, it must also provide
905 * @modify_rxfh_context and @remove_rxfh_context.
906 * Returns a negative error code or zero.
907 * @modify_rxfh_context: Reconfigure the specified RSS context. Allows setting
908 * the contents of the RX flow hash indirection table, hash key, and/or
909 * hash function associated with the given context.
910 * Parameters which are set to %NULL or zero will remain unchanged.
911 * The &struct ethtool_rxfh_context for this context is passed in @ctx;
912 * note that it will still contain the *old* settings. The driver does
913 * not need to update these; the core will do so if this op succeeds.
914 * Returns a negative error code or zero. An error code must be returned
915 * if at least one unsupported change was requested.
916 * @remove_rxfh_context: Remove the specified RSS context.
917 * The &struct ethtool_rxfh_context for this context is passed in @ctx.
918 * Returns a negative error code or zero.
919 * @get_channels: Get number of channels.
920 * @set_channels: Set number of channels. Returns a negative error code or
921 * zero.
922 * @get_dump_flag: Get dump flag indicating current dump length, version,
923 * and flag of the device.
924 * @get_dump_data: Get dump data.
925 * @set_dump: Set dump specific flags to the device.
926 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
927 * It may be called with RCU, or rtnl or reference on the device.
928 * Drivers supporting transmit time stamps in software should set this to
929 * ethtool_op_get_ts_info(). Drivers must not zero statistics which they
930 * don't report. The stats structure is initialized to ETHTOOL_STAT_NOT_SET
931 * indicating driver does not report statistics.
932 * @get_ts_stats: Query the device hardware timestamping statistics.
933 * @get_module_info: Get the size and type of the eeprom contained within
934 * a plug-in module.
935 * @get_module_eeprom: Get the eeprom information from the plug-in module
936 * @get_eee: Get Energy-Efficient (EEE) supported and status.
937 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
938 * @get_tunable: Read the value of a driver / device tunable.
939 * @set_tunable: Set the value of a driver / device tunable.
940 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
941 * It must check that the given queue number is valid. If neither a RX nor
942 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
943 * queue has this number, set the inapplicable fields to ~0 and return 0.
944 * Returns a negative error code or zero.
945 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
946 * It must check that the given queue number is valid. If neither a RX nor
947 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
948 * queue has this number, ignore the inapplicable fields. Supported
949 * coalescing types should be set in @supported_coalesce_params.
950 * Returns a negative error code or zero.
951 * @get_link_ksettings: Get various device settings including Ethernet link
952 * settings. The %cmd and %link_mode_masks_nwords fields should be
953 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
954 * any change to them will be overwritten by kernel. Returns a negative
955 * error code or zero.
956 * @set_link_ksettings: Set various device settings including Ethernet link
957 * settings. The %cmd and %link_mode_masks_nwords fields should be
958 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
959 * any change to them will be overwritten by kernel. Returns a negative
960 * error code or zero.
961 * @get_fec_stats: Report FEC statistics.
962 * Core will sum up per-lane stats to get the total.
963 * Drivers must not zero statistics which they don't report. The stats
964 * structure is initialized to ETHTOOL_STAT_NOT_SET indicating driver does
965 * not report statistics.
966 * @get_fecparam: Get the network device Forward Error Correction parameters.
967 * @set_fecparam: Set the network device Forward Error Correction parameters.
968 * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
969 * This is only useful if the device maintains PHY statistics and
970 * cannot use the standard PHY library helpers.
971 * @get_phy_tunable: Read the value of a PHY tunable.
972 * @set_phy_tunable: Set the value of a PHY tunable.
973 * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from
974 * specified page. Returns a negative error code or the amount of bytes
975 * read.
976 * @set_module_eeprom_by_page: Write to a region of plug-in module EEPROM,
977 * from kernel space only. Returns a negative error code or zero.
978 * @get_eth_phy_stats: Query some of the IEEE 802.3 PHY statistics.
979 * @get_eth_mac_stats: Query some of the IEEE 802.3 MAC statistics.
980 * @get_eth_ctrl_stats: Query some of the IEEE 802.3 MAC Ctrl statistics.
981 * @get_rmon_stats: Query some of the RMON (RFC 2819) statistics.
982 * Set %ranges to a pointer to zero-terminated array of byte ranges.
983 * @get_module_power_mode: Get the power mode policy for the plug-in module
984 * used by the network device and its operational power mode, if
985 * plugged-in.
986 * @set_module_power_mode: Set the power mode policy for the plug-in module
987 * used by the network device.
988 * @get_mm: Query the 802.3 MAC Merge layer state.
989 * @set_mm: Set the 802.3 MAC Merge layer parameters.
990 * @get_mm_stats: Query the 802.3 MAC Merge layer statistics.
991 *
992 * All operations are optional (i.e. the function pointer may be set
993 * to %NULL) and callers must take this into account. Callers must
994 * hold the RTNL lock.
995 *
996 * See the structures used by these operations for further documentation.
997 * Note that for all operations using a structure ending with a zero-
998 * length array, the array is allocated separately in the kernel and
999 * is passed to the driver as an additional parameter.
1000 *
1001 * See &struct net_device and &struct net_device_ops for documentation
1002 * of the generic netdev features interface.
1003 */
1004 struct ethtool_ops {
1005 u32 supported_input_xfrm:8;
1006 u32 cap_link_lanes_supported:1;
1007 u32 cap_rss_ctx_supported:1;
1008 u32 rxfh_per_ctx_key:1;
1009 u32 cap_rss_rxnfc_adds:1;
1010 u32 rxfh_indir_space;
1011 u16 rxfh_key_space;
1012 u16 rxfh_priv_size;
1013 u32 rxfh_max_num_contexts;
1014 u32 supported_coalesce_params;
1015 u32 supported_ring_params;
1016 u32 supported_hwtstamp_qualifiers;
1017 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
1018 int (*get_regs_len)(struct net_device *);
1019 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
1020 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
1021 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
1022 u32 (*get_msglevel)(struct net_device *);
1023 void (*set_msglevel)(struct net_device *, u32);
1024 int (*nway_reset)(struct net_device *);
1025 u32 (*get_link)(struct net_device *);
1026 int (*get_link_ext_state)(struct net_device *,
1027 struct ethtool_link_ext_state_info *);
1028 void (*get_link_ext_stats)(struct net_device *dev,
1029 struct ethtool_link_ext_stats *stats);
1030 int (*get_eeprom_len)(struct net_device *);
1031 int (*get_eeprom)(struct net_device *,
1032 struct ethtool_eeprom *, u8 *);
1033 int (*set_eeprom)(struct net_device *,
1034 struct ethtool_eeprom *, u8 *);
1035 int (*get_coalesce)(struct net_device *,
1036 struct ethtool_coalesce *,
1037 struct kernel_ethtool_coalesce *,
1038 struct netlink_ext_ack *);
1039 int (*set_coalesce)(struct net_device *,
1040 struct ethtool_coalesce *,
1041 struct kernel_ethtool_coalesce *,
1042 struct netlink_ext_ack *);
1043 void (*get_ringparam)(struct net_device *,
1044 struct ethtool_ringparam *,
1045 struct kernel_ethtool_ringparam *,
1046 struct netlink_ext_ack *);
1047 int (*set_ringparam)(struct net_device *,
1048 struct ethtool_ringparam *,
1049 struct kernel_ethtool_ringparam *,
1050 struct netlink_ext_ack *);
1051 void (*get_pause_stats)(struct net_device *dev,
1052 struct ethtool_pause_stats *pause_stats);
1053 void (*get_pauseparam)(struct net_device *,
1054 struct ethtool_pauseparam*);
1055 int (*set_pauseparam)(struct net_device *,
1056 struct ethtool_pauseparam*);
1057 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
1058 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
1059 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
1060 void (*get_ethtool_stats)(struct net_device *,
1061 struct ethtool_stats *, u64 *);
1062 int (*begin)(struct net_device *);
1063 void (*complete)(struct net_device *);
1064 u32 (*get_priv_flags)(struct net_device *);
1065 int (*set_priv_flags)(struct net_device *, u32);
1066 int (*get_sset_count)(struct net_device *, int);
1067 int (*get_rxnfc)(struct net_device *,
1068 struct ethtool_rxnfc *, u32 *rule_locs);
1069 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
1070 int (*flash_device)(struct net_device *, struct ethtool_flash *);
1071 int (*reset)(struct net_device *, u32 *);
1072 u32 (*get_rxfh_key_size)(struct net_device *);
1073 u32 (*get_rxfh_indir_size)(struct net_device *);
1074 int (*get_rxfh)(struct net_device *, struct ethtool_rxfh_param *);
1075 int (*set_rxfh)(struct net_device *, struct ethtool_rxfh_param *,
1076 struct netlink_ext_ack *extack);
1077 int (*create_rxfh_context)(struct net_device *,
1078 struct ethtool_rxfh_context *ctx,
1079 const struct ethtool_rxfh_param *rxfh,
1080 struct netlink_ext_ack *extack);
1081 int (*modify_rxfh_context)(struct net_device *,
1082 struct ethtool_rxfh_context *ctx,
1083 const struct ethtool_rxfh_param *rxfh,
1084 struct netlink_ext_ack *extack);
1085 int (*remove_rxfh_context)(struct net_device *,
1086 struct ethtool_rxfh_context *ctx,
1087 u32 rss_context,
1088 struct netlink_ext_ack *extack);
1089 void (*get_channels)(struct net_device *, struct ethtool_channels *);
1090 int (*set_channels)(struct net_device *, struct ethtool_channels *);
1091 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
1092 int (*get_dump_data)(struct net_device *,
1093 struct ethtool_dump *, void *);
1094 int (*set_dump)(struct net_device *, struct ethtool_dump *);
1095 int (*get_ts_info)(struct net_device *, struct kernel_ethtool_ts_info *);
1096 void (*get_ts_stats)(struct net_device *dev,
1097 struct ethtool_ts_stats *ts_stats);
1098 int (*get_module_info)(struct net_device *,
1099 struct ethtool_modinfo *);
1100 int (*get_module_eeprom)(struct net_device *,
1101 struct ethtool_eeprom *, u8 *);
1102 int (*get_eee)(struct net_device *dev, struct ethtool_keee *eee);
1103 int (*set_eee)(struct net_device *dev, struct ethtool_keee *eee);
1104 int (*get_tunable)(struct net_device *,
1105 const struct ethtool_tunable *, void *);
1106 int (*set_tunable)(struct net_device *,
1107 const struct ethtool_tunable *, const void *);
1108 int (*get_per_queue_coalesce)(struct net_device *, u32,
1109 struct ethtool_coalesce *);
1110 int (*set_per_queue_coalesce)(struct net_device *, u32,
1111 struct ethtool_coalesce *);
1112 int (*get_link_ksettings)(struct net_device *,
1113 struct ethtool_link_ksettings *);
1114 int (*set_link_ksettings)(struct net_device *,
1115 const struct ethtool_link_ksettings *);
1116 void (*get_fec_stats)(struct net_device *dev,
1117 struct ethtool_fec_stats *fec_stats);
1118 int (*get_fecparam)(struct net_device *,
1119 struct ethtool_fecparam *);
1120 int (*set_fecparam)(struct net_device *,
1121 struct ethtool_fecparam *);
1122 void (*get_ethtool_phy_stats)(struct net_device *,
1123 struct ethtool_stats *, u64 *);
1124 int (*get_phy_tunable)(struct net_device *,
1125 const struct ethtool_tunable *, void *);
1126 int (*set_phy_tunable)(struct net_device *,
1127 const struct ethtool_tunable *, const void *);
1128 int (*get_module_eeprom_by_page)(struct net_device *dev,
1129 const struct ethtool_module_eeprom *page,
1130 struct netlink_ext_ack *extack);
1131 int (*set_module_eeprom_by_page)(struct net_device *dev,
1132 const struct ethtool_module_eeprom *page,
1133 struct netlink_ext_ack *extack);
1134 void (*get_eth_phy_stats)(struct net_device *dev,
1135 struct ethtool_eth_phy_stats *phy_stats);
1136 void (*get_eth_mac_stats)(struct net_device *dev,
1137 struct ethtool_eth_mac_stats *mac_stats);
1138 void (*get_eth_ctrl_stats)(struct net_device *dev,
1139 struct ethtool_eth_ctrl_stats *ctrl_stats);
1140 void (*get_rmon_stats)(struct net_device *dev,
1141 struct ethtool_rmon_stats *rmon_stats,
1142 const struct ethtool_rmon_hist_range **ranges);
1143 int (*get_module_power_mode)(struct net_device *dev,
1144 struct ethtool_module_power_mode_params *params,
1145 struct netlink_ext_ack *extack);
1146 int (*set_module_power_mode)(struct net_device *dev,
1147 const struct ethtool_module_power_mode_params *params,
1148 struct netlink_ext_ack *extack);
1149 int (*get_mm)(struct net_device *dev, struct ethtool_mm_state *state);
1150 int (*set_mm)(struct net_device *dev, struct ethtool_mm_cfg *cfg,
1151 struct netlink_ext_ack *extack);
1152 void (*get_mm_stats)(struct net_device *dev, struct ethtool_mm_stats *stats);
1153 };
1154
1155 int ethtool_check_ops(const struct ethtool_ops *ops);
1156
1157 struct ethtool_rx_flow_rule {
1158 struct flow_rule *rule;
1159 unsigned long priv[];
1160 };
1161
1162 struct ethtool_rx_flow_spec_input {
1163 const struct ethtool_rx_flow_spec *fs;
1164 u32 rss_ctx;
1165 };
1166
1167 struct ethtool_rx_flow_rule *
1168 ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
1169 void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
1170
1171 bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
1172 int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
1173 const struct ethtool_link_ksettings *cmd,
1174 u32 *dev_speed, u8 *dev_duplex);
1175
1176 /**
1177 * struct ethtool_netdev_state - per-netdevice state for ethtool features
1178 * @rss_ctx: XArray of custom RSS contexts
1179 * @rss_lock: Protects entries in @rss_ctx. May be taken from
1180 * within RTNL.
1181 * @wol_enabled: Wake-on-LAN is enabled
1182 * @module_fw_flash_in_progress: Module firmware flashing is in progress.
1183 */
1184 struct ethtool_netdev_state {
1185 struct xarray rss_ctx;
1186 struct mutex rss_lock;
1187 unsigned wol_enabled:1;
1188 unsigned module_fw_flash_in_progress:1;
1189 };
1190
1191 struct phy_device;
1192 struct phy_tdr_config;
1193 struct phy_plca_cfg;
1194 struct phy_plca_status;
1195
1196 /**
1197 * struct ethtool_phy_ops - Optional PHY device options
1198 * @get_sset_count: Get number of strings that @get_strings will write.
1199 * @get_strings: Return a set of strings that describe the requested objects
1200 * @get_stats: Return extended statistics about the PHY device.
1201 * @get_plca_cfg: Return PLCA configuration.
1202 * @set_plca_cfg: Set PLCA configuration.
1203 * @get_plca_status: Get PLCA configuration.
1204 * @start_cable_test: Start a cable test
1205 * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test
1206 *
1207 * All operations are optional (i.e. the function pointer may be set to %NULL)
1208 * and callers must take this into account. Callers must hold the RTNL lock.
1209 */
1210 struct ethtool_phy_ops {
1211 int (*get_sset_count)(struct phy_device *dev);
1212 int (*get_strings)(struct phy_device *dev, u8 *data);
1213 int (*get_stats)(struct phy_device *dev,
1214 struct ethtool_stats *stats, u64 *data);
1215 int (*get_plca_cfg)(struct phy_device *dev,
1216 struct phy_plca_cfg *plca_cfg);
1217 int (*set_plca_cfg)(struct phy_device *dev,
1218 const struct phy_plca_cfg *plca_cfg,
1219 struct netlink_ext_ack *extack);
1220 int (*get_plca_status)(struct phy_device *dev,
1221 struct phy_plca_status *plca_st);
1222 int (*start_cable_test)(struct phy_device *phydev,
1223 struct netlink_ext_ack *extack);
1224 int (*start_cable_test_tdr)(struct phy_device *phydev,
1225 struct netlink_ext_ack *extack,
1226 const struct phy_tdr_config *config);
1227 };
1228
1229 /**
1230 * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
1231 * @ops: Ethtool PHY operations to set
1232 */
1233 void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops);
1234
1235 /**
1236 * ethtool_params_from_link_mode - Derive link parameters from a given link mode
1237 * @link_ksettings: Link parameters to be derived from the link mode
1238 * @link_mode: Link mode
1239 */
1240 void
1241 ethtool_params_from_link_mode(struct ethtool_link_ksettings *link_ksettings,
1242 enum ethtool_link_mode_bit_indices link_mode);
1243
1244 /**
1245 * ethtool_get_phc_vclocks - Derive phc vclocks information, and caller
1246 * is responsible to free memory of vclock_index
1247 * @dev: pointer to net_device structure
1248 * @vclock_index: pointer to pointer of vclock index
1249 *
1250 * Return: number of phc vclocks
1251 */
1252 int ethtool_get_phc_vclocks(struct net_device *dev, int **vclock_index);
1253
1254 /* Some generic methods drivers may use in their ethtool_ops */
1255 u32 ethtool_op_get_link(struct net_device *dev);
1256 int ethtool_op_get_ts_info(struct net_device *dev,
1257 struct kernel_ethtool_ts_info *eti);
1258
1259 /**
1260 * ethtool_mm_frag_size_add_to_min - Translate (standard) additional fragment
1261 * size expressed as multiplier into (absolute) minimum fragment size
1262 * value expressed in octets
1263 * @val_add: Value of addFragSize multiplier
1264 */
ethtool_mm_frag_size_add_to_min(u32 val_add)1265 static inline u32 ethtool_mm_frag_size_add_to_min(u32 val_add)
1266 {
1267 return (ETH_ZLEN + ETH_FCS_LEN) * (1 + val_add) - ETH_FCS_LEN;
1268 }
1269
1270 /**
1271 * ethtool_mm_frag_size_min_to_add - Translate (absolute) minimum fragment size
1272 * expressed in octets into (standard) additional fragment size expressed
1273 * as multiplier
1274 * @val_min: Value of addFragSize variable in octets
1275 * @val_add: Pointer where the standard addFragSize value is to be returned
1276 * @extack: Netlink extended ack
1277 *
1278 * Translate a value in octets to one of 0, 1, 2, 3 according to the reverse
1279 * application of the 802.3 formula 64 * (1 + addFragSize) - 4. To be called
1280 * by drivers which do not support programming the minimum fragment size to a
1281 * continuous range. Returns error on other fragment length values.
1282 */
ethtool_mm_frag_size_min_to_add(u32 val_min,u32 * val_add,struct netlink_ext_ack * extack)1283 static inline int ethtool_mm_frag_size_min_to_add(u32 val_min, u32 *val_add,
1284 struct netlink_ext_ack *extack)
1285 {
1286 u32 add_frag_size;
1287
1288 for (add_frag_size = 0; add_frag_size < 4; add_frag_size++) {
1289 if (ethtool_mm_frag_size_add_to_min(add_frag_size) == val_min) {
1290 *val_add = add_frag_size;
1291 return 0;
1292 }
1293 }
1294
1295 NL_SET_ERR_MSG_MOD(extack,
1296 "minFragSize required to be one of 60, 124, 188 or 252");
1297 return -EINVAL;
1298 }
1299
1300 /**
1301 * ethtool_get_ts_info_by_layer - Obtains time stamping capabilities from the MAC or PHY layer.
1302 * @dev: pointer to net_device structure
1303 * @info: buffer to hold the result
1304 * Returns: zero on success, non-zero otherwise.
1305 */
1306 int ethtool_get_ts_info_by_layer(struct net_device *dev,
1307 struct kernel_ethtool_ts_info *info);
1308
1309 /**
1310 * ethtool_sprintf - Write formatted string to ethtool string data
1311 * @data: Pointer to a pointer to the start of string to update
1312 * @fmt: Format of string to write
1313 *
1314 * Write formatted string to *data. Update *data to point at start of
1315 * next string.
1316 */
1317 extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);
1318
1319 /**
1320 * ethtool_puts - Write string to ethtool string data
1321 * @data: Pointer to a pointer to the start of string to update
1322 * @str: String to write
1323 *
1324 * Write string to *data without a trailing newline. Update *data
1325 * to point at start of next string.
1326 *
1327 * Prefer this function to ethtool_sprintf() when given only
1328 * two arguments or if @fmt is just "%s".
1329 */
1330 extern void ethtool_puts(u8 **data, const char *str);
1331
1332 /* Link mode to forced speed capabilities maps */
1333 struct ethtool_forced_speed_map {
1334 u32 speed;
1335 __ETHTOOL_DECLARE_LINK_MODE_MASK(caps);
1336
1337 const u32 *cap_arr;
1338 u32 arr_size;
1339 };
1340
1341 #define ETHTOOL_FORCED_SPEED_MAP(prefix, value) \
1342 { \
1343 .speed = SPEED_##value, \
1344 .cap_arr = prefix##_##value, \
1345 .arr_size = ARRAY_SIZE(prefix##_##value), \
1346 }
1347
1348 void
1349 ethtool_forced_speed_maps_init(struct ethtool_forced_speed_map *maps, u32 size);
1350 #endif /* _LINUX_ETHTOOL_H */
1351