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 <uapi/linux/ethtool.h> 19 20#ifdef CONFIG_COMPAT 21 22struct compat_ethtool_rx_flow_spec { 23 u32 flow_type; 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; 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; 38 u32 rule_locs[0]; 39}; 40 41#endif /* CONFIG_COMPAT */ 42 43#include <linux/rculist.h> 44 45/** 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 61enum { 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 */ 65 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) 78#define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32) 79 80#define ETH_RSS_HASH_UNKNOWN 0 81#define ETH_RSS_HASH_NO_CHANGE 0 82 83struct net_device; 84 85/* Some generic methods drivers may use in their ethtool_ops */ 86u32 ethtool_op_get_link(struct net_device *dev); 87int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti); 88 89/** 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 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 101/* 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/** 137 * 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/** 148 * 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 163/** 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 173void 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 180/** 181 * struct ethtool_ops - optional netdev operations 182 * @get_drvinfo: Report driver/device information. Should only set the 183 * @driver, @version, @fw_version and @bus_info fields. If not 184 * implemented, the @driver and @bus_info fields will be filled in 185 * according to the netdev's parent device. 186 * @get_regs_len: Get buffer length required for @get_regs 187 * @get_regs: Get device registers 188 * @get_wol: Report whether Wake-on-Lan is enabled 189 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code 190 * or zero. 191 * @get_msglevel: Report driver message level. This should be the value 192 * of the @msg_enable field used by netif logging functions. 193 * @set_msglevel: Set driver message level 194 * @nway_reset: Restart autonegotiation. Returns a negative error code 195 * or zero. 196 * @get_link: Report whether physical link is up. Will only be called if 197 * the netdev is up. Should usually be set to ethtool_op_get_link(), 198 * which uses netif_carrier_ok(). 199 * @get_eeprom: Read data from the device EEPROM. 200 * Should fill in the magic field. Don't need to check len for zero 201 * or wraparound. Fill in the data argument with the eeprom values 202 * from offset to offset + len. Update len to the amount read. 203 * Returns an error or zero. 204 * @set_eeprom: Write data to the device EEPROM. 205 * Should validate the magic field. Don't need to check len for zero 206 * or wraparound. Update len to the amount written. Returns an error 207 * or zero. 208 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative 209 * error code or zero. 210 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative 211 * error code or zero. 212 * @get_ringparam: Report ring sizes 213 * @set_ringparam: Set ring sizes. Returns a negative error code or zero. 214 * @get_pauseparam: Report pause parameters 215 * @set_pauseparam: Set pause parameters. Returns a negative error code 216 * or zero. 217 * @self_test: Run specified self-tests 218 * @get_strings: Return a set of strings that describe the requested objects 219 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED 220 * attached to it. The implementation may update the indicator 221 * asynchronously or synchronously, but in either case it must return 222 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, 223 * and must either activate asynchronous updates and return zero, return 224 * a negative error or return a positive frequency for synchronous 225 * indication (e.g. 1 for one on/off cycle per second). If it returns 226 * a frequency then it will be called again at intervals with the 227 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of 228 * the indicator accordingly. Finally, it is called with the argument 229 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a 230 * negative error code or zero. 231 * @get_ethtool_stats: Return extended statistics about the device. 232 * This is only useful if the device maintains statistics not 233 * included in &struct rtnl_link_stats64. 234 * @begin: Function to be called before any other operation. Returns a 235 * negative error code or zero. 236 * @complete: Function to be called after any other operation except 237 * @begin. Will be called even if the other operation failed. 238 * @get_priv_flags: Report driver-specific feature flags. 239 * @set_priv_flags: Set driver-specific feature flags. Returns a negative 240 * error code or zero. 241 * @get_sset_count: Get number of strings that @get_strings will write. 242 * @get_rxnfc: Get RX flow classification rules. Returns a negative 243 * error code or zero. 244 * @set_rxnfc: Set RX flow classification rules. Returns a negative 245 * error code or zero. 246 * @flash_device: Write a firmware image to device's flash memory. 247 * Returns a negative error code or zero. 248 * @reset: Reset (part of) the device, as specified by a bitmask of 249 * flags from &enum ethtool_reset_flags. Returns a negative 250 * error code or zero. 251 * @get_rxfh_key_size: Get the size of the RX flow hash key. 252 * Returns zero if not supported for this specific device. 253 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. 254 * Returns zero if not supported for this specific device. 255 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key 256 * and/or hash function. 257 * Returns a negative error code or zero. 258 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash 259 * key, and/or hash function. Arguments which are set to %NULL or zero 260 * will remain unchanged. 261 * Returns a negative error code or zero. An error code must be returned 262 * if at least one unsupported change was requested. 263 * @get_rxfh_context: Get the contents of the RX flow hash indirection table, 264 * hash key, and/or hash function assiciated to the given rss context. 265 * Returns a negative error code or zero. 266 * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting 267 * the contents of the RX flow hash indirection table, hash key, and/or 268 * hash function associated to the given context. Arguments which are set 269 * to %NULL or zero will remain unchanged. 270 * Returns a negative error code or zero. An error code must be returned 271 * if at least one unsupported change was requested. 272 * @get_channels: Get number of channels. 273 * @set_channels: Set number of channels. Returns a negative error code or 274 * zero. 275 * @get_dump_flag: Get dump flag indicating current dump length, version, 276 * and flag of the device. 277 * @get_dump_data: Get dump data. 278 * @set_dump: Set dump specific flags to the device. 279 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. 280 * Drivers supporting transmit time stamps in software should set this to 281 * ethtool_op_get_ts_info(). 282 * @get_module_info: Get the size and type of the eeprom contained within 283 * a plug-in module. 284 * @get_module_eeprom: Get the eeprom information from the plug-in module 285 * @get_eee: Get Energy-Efficient (EEE) supported and status. 286 * @set_eee: Set EEE status (enable/disable) as well as LPI timers. 287 * @get_per_queue_coalesce: Get 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, set the inapplicable fields to ~0 and return 0. 291 * Returns a negative error code or zero. 292 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue. 293 * It must check that the given queue number is valid. If neither a RX nor 294 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 295 * queue has this number, ignore the inapplicable fields. 296 * Returns a negative error code or zero. 297 * @get_link_ksettings: Get 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 * @set_link_ksettings: Set various device settings including Ethernet link 303 * settings. The %cmd and %link_mode_masks_nwords fields should be 304 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), 305 * any change to them will be overwritten by kernel. Returns a negative 306 * error code or zero. 307 * @get_fecparam: Get the network device Forward Error Correction parameters. 308 * @set_fecparam: Set the network device Forward Error Correction parameters. 309 * @get_ethtool_phy_stats: Return extended statistics about the PHY device. 310 * This is only useful if the device maintains PHY statistics and 311 * cannot use the standard PHY library helpers. 312 * 313 * All operations are optional (i.e. the function pointer may be set 314 * to %NULL) and callers must take this into account. Callers must 315 * hold the RTNL lock. 316 * 317 * See the structures used by these operations for further documentation. 318 * Note that for all operations using a structure ending with a zero- 319 * length array, the array is allocated separately in the kernel and 320 * is passed to the driver as an additional parameter. 321 * 322 * See &struct net_device and &struct net_device_ops for documentation 323 * of the generic netdev features interface. 324 */ 325struct ethtool_ops { 326 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 327 int (*get_regs_len)(struct net_device *); 328 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 329 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 330 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 331 u32 (*get_msglevel)(struct net_device *); 332 void (*set_msglevel)(struct net_device *, u32); 333 int (*nway_reset)(struct net_device *); 334 u32 (*get_link)(struct net_device *); 335 int (*get_eeprom_len)(struct net_device *); 336 int (*get_eeprom)(struct net_device *, 337 struct ethtool_eeprom *, u8 *); 338 int (*set_eeprom)(struct net_device *, 339 struct ethtool_eeprom *, u8 *); 340 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); 341 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); 342 void (*get_ringparam)(struct net_device *, 343 struct ethtool_ringparam *); 344 int (*set_ringparam)(struct net_device *, 345 struct ethtool_ringparam *); 346 void (*get_pauseparam)(struct net_device *, 347 struct ethtool_pauseparam*); 348 int (*set_pauseparam)(struct net_device *, 349 struct ethtool_pauseparam*); 350 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 351 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 352 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); 353 void (*get_ethtool_stats)(struct net_device *, 354 struct ethtool_stats *, u64 *); 355 int (*begin)(struct net_device *); 356 void (*complete)(struct net_device *); 357 u32 (*get_priv_flags)(struct net_device *); 358 int (*set_priv_flags)(struct net_device *, u32); 359 int (*get_sset_count)(struct net_device *, int); 360 int (*get_rxnfc)(struct net_device *, 361 struct ethtool_rxnfc *, u32 *rule_locs); 362 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 363 int (*flash_device)(struct net_device *, struct ethtool_flash *); 364 int (*reset)(struct net_device *, u32 *); 365 u32 (*get_rxfh_key_size)(struct net_device *); 366 u32 (*get_rxfh_indir_size)(struct net_device *); 367 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key, 368 u8 *hfunc); 369 int (*set_rxfh)(struct net_device *, const u32 *indir, 370 const u8 *key, const u8 hfunc); 371 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key, 372 u8 *hfunc, u32 rss_context); 373 int (*set_rxfh_context)(struct net_device *, const u32 *indir, 374 const u8 *key, const u8 hfunc, 375 u32 *rss_context, bool delete); 376 void (*get_channels)(struct net_device *, struct ethtool_channels *); 377 int (*set_channels)(struct net_device *, struct ethtool_channels *); 378 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); 379 int (*get_dump_data)(struct net_device *, 380 struct ethtool_dump *, void *); 381 int (*set_dump)(struct net_device *, struct ethtool_dump *); 382 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); 383 int (*get_module_info)(struct net_device *, 384 struct ethtool_modinfo *); 385 int (*get_module_eeprom)(struct net_device *, 386 struct ethtool_eeprom *, u8 *); 387 int (*get_eee)(struct net_device *, struct ethtool_eee *); 388 int (*set_eee)(struct net_device *, struct ethtool_eee *); 389 int (*get_tunable)(struct net_device *, 390 const struct ethtool_tunable *, void *); 391 int (*set_tunable)(struct net_device *, 392 const struct ethtool_tunable *, const void *); 393 int (*get_per_queue_coalesce)(struct net_device *, u32, 394 struct ethtool_coalesce *); 395 int (*set_per_queue_coalesce)(struct net_device *, u32, 396 struct ethtool_coalesce *); 397 int (*get_link_ksettings)(struct net_device *, 398 struct ethtool_link_ksettings *); 399 int (*set_link_ksettings)(struct net_device *, 400 const struct ethtool_link_ksettings *); 401 int (*get_fecparam)(struct net_device *, 402 struct ethtool_fecparam *); 403 int (*set_fecparam)(struct net_device *, 404 struct ethtool_fecparam *); 405 void (*get_ethtool_phy_stats)(struct net_device *, 406 struct ethtool_stats *, u64 *); 407}; 408 409struct ethtool_rx_flow_rule { 410 struct flow_rule *rule; 411 unsigned long priv[0]; 412}; 413 414struct ethtool_rx_flow_spec_input { 415 const struct ethtool_rx_flow_spec *fs; 416 u32 rss_ctx; 417}; 418 419struct ethtool_rx_flow_rule * 420ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input); 421void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule); 422 423#endif /* _LINUX_ETHTOOL_H */ 424