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