1 /* SPDX-License-Identifier: GPL-2.0 */
3 * ethtool.h: Defines for Linux ethtool.
5 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
6 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
7 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
8 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
9 * christopher.leech@intel.com,
10 * scott.feldman@intel.com)
11 * Portions Copyright (C) Sun Microsystems 2008
13 #ifndef _LINUX_ETHTOOL_H
14 #define _LINUX_ETHTOOL_H
16 #include <linux/bitmap.h>
17 #include <linux/compat.h>
18 #include <uapi/linux/ethtool.h>
22 struct compat_ethtool_rx_flow_spec
{
24 union ethtool_flow_union h_u
;
25 struct ethtool_flow_ext h_ext
;
26 union ethtool_flow_union m_u
;
27 struct ethtool_flow_ext m_ext
;
28 compat_u64 ring_cookie
;
32 struct compat_ethtool_rxnfc
{
36 struct compat_ethtool_rx_flow_spec fs
;
41 #endif /* CONFIG_COMPAT */
43 #include <linux/rculist.h>
46 * enum ethtool_phys_id_state - indicator state for physical identification
47 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
48 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
49 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
51 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
54 enum ethtool_phys_id_state
{
62 ETH_RSS_HASH_TOP_BIT
, /* Configurable RSS hash function - Toeplitz */
63 ETH_RSS_HASH_XOR_BIT
, /* Configurable RSS hash function - Xor */
64 ETH_RSS_HASH_CRC32_BIT
, /* Configurable RSS hash function - Crc32 */
67 * Add your fresh new hash function bits above and remember to update
68 * rss_hash_func_strings[] in ethtool.c
70 ETH_RSS_HASH_FUNCS_COUNT
73 #define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit))
74 #define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
76 #define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP)
77 #define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR)
78 #define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32)
80 #define ETH_RSS_HASH_UNKNOWN 0
81 #define ETH_RSS_HASH_NO_CHANGE 0
85 /* Some generic methods drivers may use in their ethtool_ops */
86 u32
ethtool_op_get_link(struct net_device
*dev
);
87 int ethtool_op_get_ts_info(struct net_device
*dev
, struct ethtool_ts_info
*eti
);
90 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
91 * @index: Index in RX flow hash indirection table
92 * @n_rx_rings: Number of RX rings to use
94 * This function provides the default policy for RX flow hash indirection.
96 static inline u32
ethtool_rxfh_indir_default(u32 index
, u32 n_rx_rings
)
98 return index
% n_rx_rings
;
101 /* number of link mode bits/ulongs handled internally by kernel */
102 #define __ETHTOOL_LINK_MODE_MASK_NBITS \
103 (__ETHTOOL_LINK_MODE_LAST + 1)
105 /* declare a link mode bitmap */
106 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \
107 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
109 /* drivers must ignore base.cmd and base.link_mode_masks_nwords
110 * fields, but they are allowed to overwrite them (will be ignored).
112 struct ethtool_link_ksettings
{
113 struct ethtool_link_settings base
;
115 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported
);
116 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising
);
117 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising
);
122 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
123 * @ptr : pointer to struct ethtool_link_ksettings
124 * @name : one of supported/advertising/lp_advertising
126 #define ethtool_link_ksettings_zero_link_mode(ptr, name) \
127 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
130 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
132 * @ptr : pointer to struct ethtool_link_ksettings
133 * @name : one of supported/advertising/lp_advertising
134 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
135 * (not atomic, no bound checking)
137 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \
138 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
141 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
143 * @ptr : pointer to struct ethtool_link_ksettings
144 * @name : one of supported/advertising/lp_advertising
145 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
146 * (not atomic, no bound checking)
148 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \
149 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
152 * ethtool_link_ksettings_test_link_mode - test bit in ksettings 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)
158 * Returns true/false.
160 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \
161 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
164 __ethtool_get_link_ksettings(struct net_device
*dev
,
165 struct ethtool_link_ksettings
*link_ksettings
);
168 * ethtool_intersect_link_masks - Given two link masks, AND them together
169 * @dst: first mask and where result is stored
170 * @src: second mask to intersect with
172 * Given two link mode masks, AND them together and save the result in dst.
174 void ethtool_intersect_link_masks(struct ethtool_link_ksettings
*dst
,
175 struct ethtool_link_ksettings
*src
);
177 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst
,
180 /* return false if src had higher bits set. lower bits always updated. */
181 bool ethtool_convert_link_mode_to_legacy_u32(u32
*legacy_u32
,
182 const unsigned long *src
);
185 * struct ethtool_ops - optional netdev operations
186 * @get_drvinfo: Report driver/device information. Should only set the
187 * @driver, @version, @fw_version and @bus_info fields. If not
188 * implemented, the @driver and @bus_info fields will be filled in
189 * according to the netdev's parent device.
190 * @get_regs_len: Get buffer length required for @get_regs
191 * @get_regs: Get device registers
192 * @get_wol: Report whether Wake-on-Lan is enabled
193 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
195 * @get_msglevel: Report driver message level. This should be the value
196 * of the @msg_enable field used by netif logging functions.
197 * @set_msglevel: Set driver message level
198 * @nway_reset: Restart autonegotiation. Returns a negative error code
200 * @get_link: Report whether physical link is up. Will only be called if
201 * the netdev is up. Should usually be set to ethtool_op_get_link(),
202 * which uses netif_carrier_ok().
203 * @get_eeprom: Read data from the device EEPROM.
204 * Should fill in the magic field. Don't need to check len for zero
205 * or wraparound. Fill in the data argument with the eeprom values
206 * from offset to offset + len. Update len to the amount read.
207 * Returns an error or zero.
208 * @set_eeprom: Write data to the device EEPROM.
209 * Should validate the magic field. Don't need to check len for zero
210 * or wraparound. Update len to the amount written. Returns an error
212 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
213 * error code or zero.
214 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
215 * error code or zero.
216 * @get_ringparam: Report ring sizes
217 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
218 * @get_pauseparam: Report pause parameters
219 * @set_pauseparam: Set pause parameters. Returns a negative error code
221 * @self_test: Run specified self-tests
222 * @get_strings: Return a set of strings that describe the requested objects
223 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
224 * attached to it. The implementation may update the indicator
225 * asynchronously or synchronously, but in either case it must return
226 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
227 * and must either activate asynchronous updates and return zero, return
228 * a negative error or return a positive frequency for synchronous
229 * indication (e.g. 1 for one on/off cycle per second). If it returns
230 * a frequency then it will be called again at intervals with the
231 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
232 * the indicator accordingly. Finally, it is called with the argument
233 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
234 * negative error code or zero.
235 * @get_ethtool_stats: Return extended statistics about the device.
236 * This is only useful if the device maintains statistics not
237 * included in &struct rtnl_link_stats64.
238 * @begin: Function to be called before any other operation. Returns a
239 * negative error code or zero.
240 * @complete: Function to be called after any other operation except
241 * @begin. Will be called even if the other operation failed.
242 * @get_priv_flags: Report driver-specific feature flags.
243 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
244 * error code or zero.
245 * @get_sset_count: Get number of strings that @get_strings will write.
246 * @get_rxnfc: Get RX flow classification rules. Returns a negative
247 * error code or zero.
248 * @set_rxnfc: Set RX flow classification rules. Returns a negative
249 * error code or zero.
250 * @flash_device: Write a firmware image to device's flash memory.
251 * Returns a negative error code or zero.
252 * @reset: Reset (part of) the device, as specified by a bitmask of
253 * flags from &enum ethtool_reset_flags. Returns a negative
254 * error code or zero.
255 * @get_rxfh_key_size: Get the size of the RX flow hash key.
256 * Returns zero if not supported for this specific device.
257 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
258 * Returns zero if not supported for this specific device.
259 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
260 * and/or hash function.
261 * Returns a negative error code or zero.
262 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
263 * key, and/or hash function. Arguments which are set to %NULL or zero
264 * will remain unchanged.
265 * Returns a negative error code or zero. An error code must be returned
266 * if at least one unsupported change was requested.
267 * @get_channels: Get number of channels.
268 * @set_channels: Set number of channels. Returns a negative error code or
270 * @get_dump_flag: Get dump flag indicating current dump length, version,
271 * and flag of the device.
272 * @get_dump_data: Get dump data.
273 * @set_dump: Set dump specific flags to the device.
274 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
275 * Drivers supporting transmit time stamps in software should set this to
276 * ethtool_op_get_ts_info().
277 * @get_module_info: Get the size and type of the eeprom contained within
279 * @get_module_eeprom: Get the eeprom information from the plug-in module
280 * @get_eee: Get Energy-Efficient (EEE) supported and status.
281 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
282 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
283 * It must check that the given queue number is valid. If neither a RX nor
284 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
285 * queue has this number, set the inapplicable fields to ~0 and return 0.
286 * Returns a negative error code or zero.
287 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
288 * It must check that the given queue number is valid. If neither a RX nor
289 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
290 * queue has this number, ignore the inapplicable fields.
291 * Returns a negative error code or zero.
292 * @get_link_ksettings: Get various device settings including Ethernet link
293 * settings. The %cmd and %link_mode_masks_nwords fields should be
294 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
295 * any change to them will be overwritten by kernel. Returns a negative
296 * error code or zero.
297 * @set_link_ksettings: Set various device settings including Ethernet link
298 * settings. The %cmd and %link_mode_masks_nwords fields should be
299 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
300 * any change to them will be overwritten by kernel. Returns a negative
301 * error code or zero.
302 * @get_fecparam: Get the network device Forward Error Correction parameters.
303 * @set_fecparam: Set the network device Forward Error Correction parameters.
304 * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
305 * This is only useful if the device maintains PHY statistics and
306 * cannot use the standard PHY library helpers.
308 * All operations are optional (i.e. the function pointer may be set
309 * to %NULL) and callers must take this into account. Callers must
310 * hold the RTNL lock.
312 * See the structures used by these operations for further documentation.
313 * Note that for all operations using a structure ending with a zero-
314 * length array, the array is allocated separately in the kernel and
315 * is passed to the driver as an additional parameter.
317 * See &struct net_device and &struct net_device_ops for documentation
318 * of the generic netdev features interface.
321 void (*get_drvinfo
)(struct net_device
*, struct ethtool_drvinfo
*);
322 int (*get_regs_len
)(struct net_device
*);
323 void (*get_regs
)(struct net_device
*, struct ethtool_regs
*, void *);
324 void (*get_wol
)(struct net_device
*, struct ethtool_wolinfo
*);
325 int (*set_wol
)(struct net_device
*, struct ethtool_wolinfo
*);
326 u32 (*get_msglevel
)(struct net_device
*);
327 void (*set_msglevel
)(struct net_device
*, u32
);
328 int (*nway_reset
)(struct net_device
*);
329 u32 (*get_link
)(struct net_device
*);
330 int (*get_eeprom_len
)(struct net_device
*);
331 int (*get_eeprom
)(struct net_device
*,
332 struct ethtool_eeprom
*, u8
*);
333 int (*set_eeprom
)(struct net_device
*,
334 struct ethtool_eeprom
*, u8
*);
335 int (*get_coalesce
)(struct net_device
*, struct ethtool_coalesce
*);
336 int (*set_coalesce
)(struct net_device
*, struct ethtool_coalesce
*);
337 void (*get_ringparam
)(struct net_device
*,
338 struct ethtool_ringparam
*);
339 int (*set_ringparam
)(struct net_device
*,
340 struct ethtool_ringparam
*);
341 void (*get_pauseparam
)(struct net_device
*,
342 struct ethtool_pauseparam
*);
343 int (*set_pauseparam
)(struct net_device
*,
344 struct ethtool_pauseparam
*);
345 void (*self_test
)(struct net_device
*, struct ethtool_test
*, u64
*);
346 void (*get_strings
)(struct net_device
*, u32 stringset
, u8
*);
347 int (*set_phys_id
)(struct net_device
*, enum ethtool_phys_id_state
);
348 void (*get_ethtool_stats
)(struct net_device
*,
349 struct ethtool_stats
*, u64
*);
350 int (*begin
)(struct net_device
*);
351 void (*complete
)(struct net_device
*);
352 u32 (*get_priv_flags
)(struct net_device
*);
353 int (*set_priv_flags
)(struct net_device
*, u32
);
354 int (*get_sset_count
)(struct net_device
*, int);
355 int (*get_rxnfc
)(struct net_device
*,
356 struct ethtool_rxnfc
*, u32
*rule_locs
);
357 int (*set_rxnfc
)(struct net_device
*, struct ethtool_rxnfc
*);
358 int (*flash_device
)(struct net_device
*, struct ethtool_flash
*);
359 int (*reset
)(struct net_device
*, u32
*);
360 u32 (*get_rxfh_key_size
)(struct net_device
*);
361 u32 (*get_rxfh_indir_size
)(struct net_device
*);
362 int (*get_rxfh
)(struct net_device
*, u32
*indir
, u8
*key
,
364 int (*set_rxfh
)(struct net_device
*, const u32
*indir
,
365 const u8
*key
, const u8 hfunc
);
366 int (*get_rxfh_context
)(struct net_device
*, u32
*indir
, u8
*key
,
367 u8
*hfunc
, u32 rss_context
);
368 int (*set_rxfh_context
)(struct net_device
*, const u32
*indir
,
369 const u8
*key
, const u8 hfunc
,
370 u32
*rss_context
, bool delete);
371 void (*get_channels
)(struct net_device
*, struct ethtool_channels
*);
372 int (*set_channels
)(struct net_device
*, struct ethtool_channels
*);
373 int (*get_dump_flag
)(struct net_device
*, struct ethtool_dump
*);
374 int (*get_dump_data
)(struct net_device
*,
375 struct ethtool_dump
*, void *);
376 int (*set_dump
)(struct net_device
*, struct ethtool_dump
*);
377 int (*get_ts_info
)(struct net_device
*, struct ethtool_ts_info
*);
378 int (*get_module_info
)(struct net_device
*,
379 struct ethtool_modinfo
*);
380 int (*get_module_eeprom
)(struct net_device
*,
381 struct ethtool_eeprom
*, u8
*);
382 int (*get_eee
)(struct net_device
*, struct ethtool_eee
*);
383 int (*set_eee
)(struct net_device
*, struct ethtool_eee
*);
384 int (*get_tunable
)(struct net_device
*,
385 const struct ethtool_tunable
*, void *);
386 int (*set_tunable
)(struct net_device
*,
387 const struct ethtool_tunable
*, const void *);
388 int (*get_per_queue_coalesce
)(struct net_device
*, u32
,
389 struct ethtool_coalesce
*);
390 int (*set_per_queue_coalesce
)(struct net_device
*, u32
,
391 struct ethtool_coalesce
*);
392 int (*get_link_ksettings
)(struct net_device
*,
393 struct ethtool_link_ksettings
*);
394 int (*set_link_ksettings
)(struct net_device
*,
395 const struct ethtool_link_ksettings
*);
396 int (*get_fecparam
)(struct net_device
*,
397 struct ethtool_fecparam
*);
398 int (*set_fecparam
)(struct net_device
*,
399 struct ethtool_fecparam
*);
400 void (*get_ethtool_phy_stats
)(struct net_device
*,
401 struct ethtool_stats
*, u64
*);
403 #endif /* _LINUX_ETHTOOL_H */