blob: a23b26eab479007408a90a2ebe4dfd823d8078a2 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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)
Santwona Behera59089d82009-02-20 00:58:13 -080011 * Portions Copyright (C) Sun Microsystems 2008
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#ifndef _LINUX_ETHTOOL_H
14#define _LINUX_ETHTOOL_H
15
David Decotigny3f1ac7a2016-02-24 10:57:59 -080016#include <linux/bitmap.h>
Ben Hutchings3a7da392011-03-17 07:34:32 +000017#include <linux/compat.h>
David Howells607ca462012-10-13 10:46:48 +010018#include <uapi/linux/ethtool.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Ben Hutchings3a7da392011-03-17 07:34:32 +000020#ifdef CONFIG_COMPAT
21
22struct compat_ethtool_rx_flow_spec {
23 u32 flow_type;
Alexander Duyck127fe532011-04-08 18:01:59 +000024 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;
Ben Hutchings3a7da392011-03-17 07:34:32 +000028 compat_u64 ring_cookie;
29 u32 location;
30};
31
32struct compat_ethtool_rxnfc {
33 u32 cmd;
34 u32 flow_type;
35 compat_u64 data;
36 struct compat_ethtool_rx_flow_spec fs;
37 u32 rule_cnt;
Gustavo A. R. Silva5299a112020-03-23 17:24:53 -050038 u32 rule_locs[];
Ben Hutchings3a7da392011-03-17 07:34:32 +000039};
40
41#endif /* CONFIG_COMPAT */
David Woodhousec3ce7e22006-04-29 01:53:47 +010042
David S. Millera1467082010-02-14 22:38:54 -080043#include <linux/rculist.h>
44
Ben Hutchings68f512f2011-04-02 00:35:15 +010045/**
46 * enum ethtool_phys_id_state - indicator state for physical identification
47 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
48 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
49 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
50 * is not supported)
51 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
52 * is not supported)
53 */
54enum ethtool_phys_id_state {
55 ETHTOOL_ID_INACTIVE,
56 ETHTOOL_ID_ACTIVE,
57 ETHTOOL_ID_ON,
58 ETHTOOL_ID_OFF
59};
60
Eyal Perry892311f2014-12-02 18:12:10 +020061enum {
62 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
63 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
Jakub Kicinskiabb521e2017-03-08 08:57:00 -080064 ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */
Eyal Perry892311f2014-12-02 18:12:10 +020065
66 /*
67 * Add your fresh new hash function bits above and remember to update
68 * rss_hash_func_strings[] in ethtool.c
69 */
70 ETH_RSS_HASH_FUNCS_COUNT
71};
72
73#define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit))
74#define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
75
76#define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP)
77#define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR)
Jakub Kicinskiabb521e2017-03-08 08:57:00 -080078#define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32)
Eyal Perry892311f2014-12-02 18:12:10 +020079
80#define ETH_RSS_HASH_UNKNOWN 0
81#define ETH_RSS_HASH_NO_CHANGE 0
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083struct net_device;
84
85/* Some generic methods drivers may use in their ethtool_ops */
86u32 ethtool_op_get_link(struct net_device *dev);
Richard Cochran02eacbd2012-04-03 22:59:22 +000087int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89/**
Ben Hutchings278bc422011-12-15 13:56:49 +000090 * 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
93 *
94 * This function provides the default policy for RX flow hash indirection.
95 */
96static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
97{
98 return index % n_rx_rings;
99}
100
David Decotigny3f1ac7a2016-02-24 10:57:59 -0800101/* declare a link mode bitmap */
102#define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \
103 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
104
105/* drivers must ignore base.cmd and base.link_mode_masks_nwords
106 * fields, but they are allowed to overwrite them (will be ignored).
107 */
108struct ethtool_link_ksettings {
109 struct ethtool_link_settings base;
110 struct {
111 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
112 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
113 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
114 } link_modes;
115};
116
117/**
118 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
119 * @ptr : pointer to struct ethtool_link_ksettings
120 * @name : one of supported/advertising/lp_advertising
121 */
122#define ethtool_link_ksettings_zero_link_mode(ptr, name) \
123 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
124
125/**
126 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
127 * link mode mask
128 * @ptr : pointer to struct ethtool_link_ksettings
129 * @name : one of supported/advertising/lp_advertising
130 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
131 * (not atomic, no bound checking)
132 */
133#define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \
134 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
135
136/**
Lendacky, Thomas606c07f2017-08-18 09:03:44 -0500137 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
138 * link mode mask
139 * @ptr : pointer to struct ethtool_link_ksettings
140 * @name : one of supported/advertising/lp_advertising
141 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
142 * (not atomic, no bound checking)
143 */
144#define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \
145 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
146
147/**
David Decotigny3f1ac7a2016-02-24 10:57:59 -0800148 * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask
149 * @ptr : pointer to struct ethtool_link_ksettings
150 * @name : one of supported/advertising/lp_advertising
151 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT
152 * (not atomic, no bound checking)
153 *
154 * Returns true/false.
155 */
156#define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \
157 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
158
159extern int
160__ethtool_get_link_ksettings(struct net_device *dev,
161 struct ethtool_link_ksettings *link_ksettings);
162
Alan Brady5a6cd6d2017-10-05 14:53:40 -0700163/**
164 * ethtool_intersect_link_masks - Given two link masks, AND them together
165 * @dst: first mask and where result is stored
166 * @src: second mask to intersect with
167 *
168 * Given two link mode masks, AND them together and save the result in dst.
169 */
170void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
171 struct ethtool_link_ksettings *src);
172
Philippe Reynes6d62b4d2016-04-15 00:34:59 +0200173void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst,
174 u32 legacy_u32);
175
176/* return false if src had higher bits set. lower bits always updated. */
177bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
178 const unsigned long *src);
179
Jakub Kicinski95cddcb2020-03-04 21:15:31 -0800180#define ETHTOOL_COALESCE_RX_USECS BIT(0)
181#define ETHTOOL_COALESCE_RX_MAX_FRAMES BIT(1)
182#define ETHTOOL_COALESCE_RX_USECS_IRQ BIT(2)
183#define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ BIT(3)
184#define ETHTOOL_COALESCE_TX_USECS BIT(4)
185#define ETHTOOL_COALESCE_TX_MAX_FRAMES BIT(5)
186#define ETHTOOL_COALESCE_TX_USECS_IRQ BIT(6)
187#define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ BIT(7)
188#define ETHTOOL_COALESCE_STATS_BLOCK_USECS BIT(8)
189#define ETHTOOL_COALESCE_USE_ADAPTIVE_RX BIT(9)
190#define ETHTOOL_COALESCE_USE_ADAPTIVE_TX BIT(10)
191#define ETHTOOL_COALESCE_PKT_RATE_LOW BIT(11)
192#define ETHTOOL_COALESCE_RX_USECS_LOW BIT(12)
193#define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW BIT(13)
194#define ETHTOOL_COALESCE_TX_USECS_LOW BIT(14)
195#define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW BIT(15)
196#define ETHTOOL_COALESCE_PKT_RATE_HIGH BIT(16)
197#define ETHTOOL_COALESCE_RX_USECS_HIGH BIT(17)
198#define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH BIT(18)
199#define ETHTOOL_COALESCE_TX_USECS_HIGH BIT(19)
200#define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH BIT(20)
201#define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL BIT(21)
202
203#define ETHTOOL_COALESCE_USECS \
204 (ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS)
205#define ETHTOOL_COALESCE_MAX_FRAMES \
206 (ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES)
207#define ETHTOOL_COALESCE_USECS_IRQ \
208 (ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ)
209#define ETHTOOL_COALESCE_MAX_FRAMES_IRQ \
210 (ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ | \
211 ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ)
212#define ETHTOOL_COALESCE_USE_ADAPTIVE \
213 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX)
Jakub Kicinski8213f6c2020-03-11 15:32:48 -0700214#define ETHTOOL_COALESCE_USECS_LOW_HIGH \
215 (ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \
216 ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH)
Jakub Kicinski4f9546d2020-03-11 15:32:52 -0700217#define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH \
218 (ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW | \
219 ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW | \
220 ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH | \
221 ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH)
Jakub Kicinski812df69b2020-03-09 19:15:06 -0700222#define ETHTOOL_COALESCE_PKT_RATE_RX_USECS \
223 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | \
224 ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \
225 ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \
226 ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL)
Jakub Kicinski95cddcb2020-03-04 21:15:31 -0800227
Ben Hutchings278bc422011-12-15 13:56:49 +0000228/**
Ben Hutchings8717d072011-04-01 23:57:41 +0100229 * struct ethtool_ops - optional netdev operations
Jakub Kicinski95cddcb2020-03-04 21:15:31 -0800230 * @supported_coalesce_params: supported types of interrupt coalescing.
Ben Hutchings8717d072011-04-01 23:57:41 +0100231 * @get_drvinfo: Report driver/device information. Should only set the
232 * @driver, @version, @fw_version and @bus_info fields. If not
233 * implemented, the @driver and @bus_info fields will be filled in
234 * according to the netdev's parent device.
235 * @get_regs_len: Get buffer length required for @get_regs
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100236 * @get_regs: Get device registers
237 * @get_wol: Report whether Wake-on-Lan is enabled
Ben Hutchings8717d072011-04-01 23:57:41 +0100238 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
239 * or zero.
240 * @get_msglevel: Report driver message level. This should be the value
241 * of the @msg_enable field used by netif logging functions.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100242 * @set_msglevel: Set driver message level
Ben Hutchings8717d072011-04-01 23:57:41 +0100243 * @nway_reset: Restart autonegotiation. Returns a negative error code
244 * or zero.
245 * @get_link: Report whether physical link is up. Will only be called if
246 * the netdev is up. Should usually be set to ethtool_op_get_link(),
247 * which uses netif_carrier_ok().
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100248 * @get_eeprom: Read data from the device EEPROM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 * Should fill in the magic field. Don't need to check len for zero
250 * or wraparound. Fill in the data argument with the eeprom values
251 * from offset to offset + len. Update len to the amount read.
252 * Returns an error or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100253 * @set_eeprom: Write data to the device EEPROM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 * Should validate the magic field. Don't need to check len for zero
255 * or wraparound. Update len to the amount written. Returns an error
256 * or zero.
Ben Hutchings8717d072011-04-01 23:57:41 +0100257 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
258 * error code or zero.
Jakub Kicinski95cddcb2020-03-04 21:15:31 -0800259 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing
260 * types should be set in @supported_coalesce_params.
261 * Returns a negative error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100262 * @get_ringparam: Report ring sizes
Ben Hutchings8717d072011-04-01 23:57:41 +0100263 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100264 * @get_pauseparam: Report pause parameters
Ben Hutchings8717d072011-04-01 23:57:41 +0100265 * @set_pauseparam: Set pause parameters. Returns a negative error code
266 * or zero.
Ben Hutchingse20b5b62011-04-01 22:52:34 +0100267 * @self_test: Run specified self-tests
268 * @get_strings: Return a set of strings that describe the requested objects
Ben Hutchings68f512f2011-04-02 00:35:15 +0100269 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
270 * attached to it. The implementation may update the indicator
271 * asynchronously or synchronously, but in either case it must return
272 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
Allan, Bruce Wfce55922011-04-13 13:09:10 +0000273 * and must either activate asynchronous updates and return zero, return
274 * a negative error or return a positive frequency for synchronous
275 * indication (e.g. 1 for one on/off cycle per second). If it returns
276 * a frequency then it will be called again at intervals with the
Ben Hutchings68f512f2011-04-02 00:35:15 +0100277 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
278 * the indicator accordingly. Finally, it is called with the argument
279 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
280 * negative error code or zero.
Ben Hutchings8717d072011-04-01 23:57:41 +0100281 * @get_ethtool_stats: Return extended statistics about the device.
282 * This is only useful if the device maintains statistics not
283 * included in &struct rtnl_link_stats64.
284 * @begin: Function to be called before any other operation. Returns a
285 * negative error code or zero.
286 * @complete: Function to be called after any other operation except
287 * @begin. Will be called even if the other operation failed.
Ben Hutchings8717d072011-04-01 23:57:41 +0100288 * @get_priv_flags: Report driver-specific feature flags.
289 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
290 * error code or zero.
291 * @get_sset_count: Get number of strings that @get_strings will write.
292 * @get_rxnfc: Get RX flow classification rules. Returns a negative
293 * error code or zero.
294 * @set_rxnfc: Set RX flow classification rules. Returns a negative
295 * error code or zero.
296 * @flash_device: Write a firmware image to device's flash memory.
297 * Returns a negative error code or zero.
298 * @reset: Reset (part of) the device, as specified by a bitmask of
299 * flags from &enum ethtool_reset_flags. Returns a negative
300 * error code or zero.
Venkata Duvvuru3de0b592014-04-21 15:37:59 +0530301 * @get_rxfh_key_size: Get the size of the RX flow hash key.
302 * Returns zero if not supported for this specific device.
Ben Hutchings7850f632011-12-15 13:55:01 +0000303 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
304 * Returns zero if not supported for this specific device.
Eyal Perry892311f2014-12-02 18:12:10 +0200305 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
306 * and/or hash function.
Ben Hutchings8717d072011-04-01 23:57:41 +0100307 * Returns a negative error code or zero.
Eyal Perry892311f2014-12-02 18:12:10 +0200308 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
309 * key, and/or hash function. Arguments which are set to %NULL or zero
310 * will remain unchanged.
311 * Returns a negative error code or zero. An error code must be returned
312 * if at least one unsupported change was requested.
Maxime Chevallierf4bcf142019-05-24 12:05:30 +0200313 * @get_rxfh_context: Get the contents of the RX flow hash indirection table,
314 * hash key, and/or hash function assiciated to the given rss context.
315 * Returns a negative error code or zero.
316 * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting
317 * the contents of the RX flow hash indirection table, hash key, and/or
318 * hash function associated to the given context. Arguments which are set
319 * to %NULL or zero will remain unchanged.
320 * Returns a negative error code or zero. An error code must be returned
321 * if at least one unsupported change was requested.
amit salecha8b5933c2011-04-07 01:58:42 +0000322 * @get_channels: Get number of channels.
323 * @set_channels: Set number of channels. Returns a negative error code or
324 * zero.
Anirban Chakraborty29dd54b2011-05-12 12:48:32 +0000325 * @get_dump_flag: Get dump flag indicating current dump length, version,
326 * and flag of the device.
327 * @get_dump_data: Get dump data.
328 * @set_dump: Set dump specific flags to the device.
Richard Cochranc8f3a8c2012-04-03 22:59:17 +0000329 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
330 * Drivers supporting transmit time stamps in software should set this to
331 * ethtool_op_get_ts_info().
Stuart Hodgson41c3cb62012-04-19 09:44:42 +0100332 * @get_module_info: Get the size and type of the eeprom contained within
333 * a plug-in module.
334 * @get_module_eeprom: Get the eeprom information from the plug-in module
Yuval Mintz80f12ec2012-06-06 17:13:06 +0000335 * @get_eee: Get Energy-Efficient (EEE) supported and status.
336 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
Kan Liang421797b2016-02-19 09:24:02 -0500337 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
338 * It must check that the given queue number is valid. If neither a RX nor
339 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
340 * queue has this number, set the inapplicable fields to ~0 and return 0.
341 * Returns a negative error code or zero.
Kan Liangf38d1382016-02-19 09:24:03 -0500342 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
343 * It must check that the given queue number is valid. If neither a RX nor
344 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
Jakub Kicinski95cddcb2020-03-04 21:15:31 -0800345 * queue has this number, ignore the inapplicable fields. Supported
346 * coalescing types should be set in @supported_coalesce_params.
Kan Liangf38d1382016-02-19 09:24:03 -0500347 * Returns a negative error code or zero.
Michal Kubecek9b300492018-08-28 19:56:58 +0200348 * @get_link_ksettings: Get various device settings including Ethernet link
349 * settings. The %cmd and %link_mode_masks_nwords fields should be
350 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
351 * any change to them will be overwritten by kernel. Returns a negative
352 * error code or zero.
353 * @set_link_ksettings: Set various device settings including Ethernet link
354 * settings. The %cmd and %link_mode_masks_nwords fields should be
355 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
356 * any change to them will be overwritten by kernel. Returns a negative
357 * error code or zero.
Florian Fainellid805c522018-04-23 15:51:38 -0700358 * @get_fecparam: Get the network device Forward Error Correction parameters.
359 * @set_fecparam: Set the network device Forward Error Correction parameters.
Florian Fainelli99943382018-04-25 12:12:48 -0700360 * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
361 * This is only useful if the device maintains PHY statistics and
362 * cannot use the standard PHY library helpers.
Ben Hutchings8717d072011-04-01 23:57:41 +0100363 *
364 * All operations are optional (i.e. the function pointer may be set
365 * to %NULL) and callers must take this into account. Callers must
Ben Hutchingsb4f79e52012-04-05 14:38:49 +0000366 * hold the RTNL lock.
Ben Hutchings8717d072011-04-01 23:57:41 +0100367 *
368 * See the structures used by these operations for further documentation.
Ben Hutchings6e201c82014-02-12 22:14:53 +0000369 * Note that for all operations using a structure ending with a zero-
370 * length array, the array is allocated separately in the kernel and
371 * is passed to the driver as an additional parameter.
Ben Hutchings8717d072011-04-01 23:57:41 +0100372 *
373 * See &struct net_device and &struct net_device_ops for documentation
374 * of the generic netdev features interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 */
376struct ethtool_ops {
Jakub Kicinski95cddcb2020-03-04 21:15:31 -0800377 u32 supported_coalesce_params;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
379 int (*get_regs_len)(struct net_device *);
380 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
381 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
382 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
383 u32 (*get_msglevel)(struct net_device *);
384 void (*set_msglevel)(struct net_device *, u32);
385 int (*nway_reset)(struct net_device *);
386 u32 (*get_link)(struct net_device *);
387 int (*get_eeprom_len)(struct net_device *);
chavey97f8aef2010-04-07 21:54:42 -0700388 int (*get_eeprom)(struct net_device *,
389 struct ethtool_eeprom *, u8 *);
390 int (*set_eeprom)(struct net_device *,
391 struct ethtool_eeprom *, u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
393 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
chavey97f8aef2010-04-07 21:54:42 -0700394 void (*get_ringparam)(struct net_device *,
395 struct ethtool_ringparam *);
396 int (*set_ringparam)(struct net_device *,
397 struct ethtool_ringparam *);
398 void (*get_pauseparam)(struct net_device *,
399 struct ethtool_pauseparam*);
400 int (*set_pauseparam)(struct net_device *,
401 struct ethtool_pauseparam*);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
403 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
Ben Hutchings68f512f2011-04-02 00:35:15 +0100404 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
chavey97f8aef2010-04-07 21:54:42 -0700405 void (*get_ethtool_stats)(struct net_device *,
406 struct ethtool_stats *, u64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 int (*begin)(struct net_device *);
408 void (*complete)(struct net_device *);
chavey97f8aef2010-04-07 21:54:42 -0700409 u32 (*get_priv_flags)(struct net_device *);
410 int (*set_priv_flags)(struct net_device *, u32);
Jeff Garzikff03d492007-08-15 16:01:08 -0700411 int (*get_sset_count)(struct net_device *, int);
chavey97f8aef2010-04-07 21:54:42 -0700412 int (*get_rxnfc)(struct net_device *,
Ben Hutchings815c7db2011-09-06 13:49:12 +0000413 struct ethtool_rxnfc *, u32 *rule_locs);
Santwona Behera59089d82009-02-20 00:58:13 -0800414 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
chavey97f8aef2010-04-07 21:54:42 -0700415 int (*flash_device)(struct net_device *, struct ethtool_flash *);
Ben Hutchingsd73d3a82009-10-05 10:59:58 +0000416 int (*reset)(struct net_device *, u32 *);
Venkata Duvvuru3de0b592014-04-21 15:37:59 +0530417 u32 (*get_rxfh_key_size)(struct net_device *);
Ben Hutchings7850f632011-12-15 13:55:01 +0000418 u32 (*get_rxfh_indir_size)(struct net_device *);
Eyal Perry892311f2014-12-02 18:12:10 +0200419 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
420 u8 *hfunc);
Ben Hutchings33cb0fa2014-05-15 02:01:23 +0100421 int (*set_rxfh)(struct net_device *, const u32 *indir,
Eyal Perry892311f2014-12-02 18:12:10 +0200422 const u8 *key, const u8 hfunc);
Edward Cree84a1d9c42018-03-08 15:45:03 +0000423 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key,
424 u8 *hfunc, u32 rss_context);
425 int (*set_rxfh_context)(struct net_device *, const u32 *indir,
426 const u8 *key, const u8 hfunc,
427 u32 *rss_context, bool delete);
amit salecha8b5933c2011-04-07 01:58:42 +0000428 void (*get_channels)(struct net_device *, struct ethtool_channels *);
429 int (*set_channels)(struct net_device *, struct ethtool_channels *);
Anirban Chakraborty29dd54b2011-05-12 12:48:32 +0000430 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
431 int (*get_dump_data)(struct net_device *,
432 struct ethtool_dump *, void *);
433 int (*set_dump)(struct net_device *, struct ethtool_dump *);
Richard Cochranc8f3a8c2012-04-03 22:59:17 +0000434 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
Stuart Hodgson41c3cb62012-04-19 09:44:42 +0100435 int (*get_module_info)(struct net_device *,
436 struct ethtool_modinfo *);
437 int (*get_module_eeprom)(struct net_device *,
438 struct ethtool_eeprom *, u8 *);
Yuval Mintz80f12ec2012-06-06 17:13:06 +0000439 int (*get_eee)(struct net_device *, struct ethtool_eee *);
440 int (*set_eee)(struct net_device *, struct ethtool_eee *);
Govindarajulu Varadarajanf0db9b02014-09-03 03:17:20 +0530441 int (*get_tunable)(struct net_device *,
442 const struct ethtool_tunable *, void *);
443 int (*set_tunable)(struct net_device *,
444 const struct ethtool_tunable *, const void *);
Kan Liang421797b2016-02-19 09:24:02 -0500445 int (*get_per_queue_coalesce)(struct net_device *, u32,
446 struct ethtool_coalesce *);
Kan Liangf38d1382016-02-19 09:24:03 -0500447 int (*set_per_queue_coalesce)(struct net_device *, u32,
448 struct ethtool_coalesce *);
David Decotigny3f1ac7a2016-02-24 10:57:59 -0800449 int (*get_link_ksettings)(struct net_device *,
450 struct ethtool_link_ksettings *);
451 int (*set_link_ksettings)(struct net_device *,
452 const struct ethtool_link_ksettings *);
Vidya Sagar Ravipati1a5f3da2017-07-27 16:47:26 -0700453 int (*get_fecparam)(struct net_device *,
454 struct ethtool_fecparam *);
455 int (*set_fecparam)(struct net_device *,
456 struct ethtool_fecparam *);
Florian Fainelli99943382018-04-25 12:12:48 -0700457 void (*get_ethtool_phy_stats)(struct net_device *,
458 struct ethtool_stats *, u64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459};
Pablo Neira Ayusoeca42052019-02-02 12:50:51 +0100460
Jakub Kicinski9000edb2020-03-16 13:47:12 -0700461int ethtool_check_ops(const struct ethtool_ops *ops);
462
Pablo Neira Ayusoeca42052019-02-02 12:50:51 +0100463struct ethtool_rx_flow_rule {
464 struct flow_rule *rule;
Gustavo A. R. Silva5299a112020-03-23 17:24:53 -0500465 unsigned long priv[];
Pablo Neira Ayusoeca42052019-02-02 12:50:51 +0100466};
467
468struct ethtool_rx_flow_spec_input {
469 const struct ethtool_rx_flow_spec *fs;
470 u32 rss_ctx;
471};
472
473struct ethtool_rx_flow_rule *
474ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
475void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
476
Cris Forno70ae1e12020-02-28 14:12:04 -0600477bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
478int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
479 const struct ethtool_link_ksettings *cmd,
480 u32 *dev_speed, u8 *dev_duplex);
481
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483#endif /* _LINUX_ETHTOOL_H */