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/* number of link mode bits/ulongs handled internally by kernel */ 102#define __ETHTOOL_LINK_MODE_MASK_NBITS \ 103 (__ETHTOOL_LINK_MODE_LAST + 1) 104 105/* declare a link mode bitmap */ 106#define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \ 107 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS) 108 109/* drivers must ignore base.cmd and base.link_mode_masks_nwords 110 * fields, but they are allowed to overwrite them (will be ignored). 111 */ 112struct ethtool_link_ksettings { 113 struct ethtool_link_settings base; 114 struct { 115 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 116 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 117 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 118 } link_modes; 119}; 120 121/** 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 125 */ 126#define ethtool_link_ksettings_zero_link_mode(ptr, name) \ 127 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS) 128 129/** 130 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings 131 * link mode mask 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) 136 */ 137#define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \ 138 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 139 140/** 141 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings 142 * link mode mask 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) 147 */ 148#define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \ 149 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 150 151/** 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) 157 * 158 * Returns true/false. 159 */ 160#define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \ 161 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 162 163extern int 164__ethtool_get_link_ksettings(struct net_device *dev, 165 struct ethtool_link_ksettings *link_ksettings); 166 167/** 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 171 * 172 * Given two link mode masks, AND them together and save the result in dst. 173 */ 174void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst, 175 struct ethtool_link_ksettings *src); 176 177void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst, 178 u32 legacy_u32); 179 180/* return false if src had higher bits set. lower bits always updated. */ 181bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32, 182 const unsigned long *src); 183 184/** 185 * struct ethtool_ops - optional netdev operations 186 * @get_settings: DEPRECATED, use %get_link_ksettings/%set_link_ksettings 187 * API. Get various device settings including Ethernet link 188 * settings. The @cmd parameter is expected to have been cleared 189 * before get_settings is called. Returns a negative error code 190 * or zero. 191 * @set_settings: DEPRECATED, use %get_link_ksettings/%set_link_ksettings 192 * API. Set various device settings including Ethernet link 193 * settings. Returns a negative error code or zero. 194 * @get_drvinfo: Report driver/device information. Should only set the 195 * @driver, @version, @fw_version and @bus_info fields. If not 196 * implemented, the @driver and @bus_info fields will be filled in 197 * according to the netdev's parent device. 198 * @get_regs_len: Get buffer length required for @get_regs 199 * @get_regs: Get device registers 200 * @get_wol: Report whether Wake-on-Lan is enabled 201 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code 202 * or zero. 203 * @get_msglevel: Report driver message level. This should be the value 204 * of the @msg_enable field used by netif logging functions. 205 * @set_msglevel: Set driver message level 206 * @nway_reset: Restart autonegotiation. Returns a negative error code 207 * or zero. 208 * @get_link: Report whether physical link is up. Will only be called if 209 * the netdev is up. Should usually be set to ethtool_op_get_link(), 210 * which uses netif_carrier_ok(). 211 * @get_eeprom: Read data from the device EEPROM. 212 * Should fill in the magic field. Don't need to check len for zero 213 * or wraparound. Fill in the data argument with the eeprom values 214 * from offset to offset + len. Update len to the amount read. 215 * Returns an error or zero. 216 * @set_eeprom: Write data to the device EEPROM. 217 * Should validate the magic field. Don't need to check len for zero 218 * or wraparound. Update len to the amount written. Returns an error 219 * or zero. 220 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative 221 * error code or zero. 222 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative 223 * error code or zero. 224 * @get_ringparam: Report ring sizes 225 * @set_ringparam: Set ring sizes. Returns a negative error code or zero. 226 * @get_pauseparam: Report pause parameters 227 * @set_pauseparam: Set pause parameters. Returns a negative error code 228 * or zero. 229 * @self_test: Run specified self-tests 230 * @get_strings: Return a set of strings that describe the requested objects 231 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED 232 * attached to it. The implementation may update the indicator 233 * asynchronously or synchronously, but in either case it must return 234 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, 235 * and must either activate asynchronous updates and return zero, return 236 * a negative error or return a positive frequency for synchronous 237 * indication (e.g. 1 for one on/off cycle per second). If it returns 238 * a frequency then it will be called again at intervals with the 239 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of 240 * the indicator accordingly. Finally, it is called with the argument 241 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a 242 * negative error code or zero. 243 * @get_ethtool_stats: Return extended statistics about the device. 244 * This is only useful if the device maintains statistics not 245 * included in &struct rtnl_link_stats64. 246 * @begin: Function to be called before any other operation. Returns a 247 * negative error code or zero. 248 * @complete: Function to be called after any other operation except 249 * @begin. Will be called even if the other operation failed. 250 * @get_priv_flags: Report driver-specific feature flags. 251 * @set_priv_flags: Set driver-specific feature flags. Returns a negative 252 * error code or zero. 253 * @get_sset_count: Get number of strings that @get_strings will write. 254 * @get_rxnfc: Get RX flow classification rules. Returns a negative 255 * error code or zero. 256 * @set_rxnfc: Set RX flow classification rules. Returns a negative 257 * error code or zero. 258 * @flash_device: Write a firmware image to device's flash memory. 259 * Returns a negative error code or zero. 260 * @reset: Reset (part of) the device, as specified by a bitmask of 261 * flags from &enum ethtool_reset_flags. Returns a negative 262 * error code or zero. 263 * @get_rxfh_key_size: Get the size of the RX flow hash key. 264 * Returns zero if not supported for this specific device. 265 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. 266 * Returns zero if not supported for this specific device. 267 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key 268 * and/or hash function. 269 * Returns a negative error code or zero. 270 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash 271 * key, and/or hash function. Arguments which are set to %NULL or zero 272 * will remain unchanged. 273 * Returns a negative error code or zero. An error code must be returned 274 * if at least one unsupported change was requested. 275 * @get_channels: Get number of channels. 276 * @set_channels: Set number of channels. Returns a negative error code or 277 * zero. 278 * @get_dump_flag: Get dump flag indicating current dump length, version, 279 * and flag of the device. 280 * @get_dump_data: Get dump data. 281 * @set_dump: Set dump specific flags to the device. 282 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. 283 * Drivers supporting transmit time stamps in software should set this to 284 * ethtool_op_get_ts_info(). 285 * @get_module_info: Get the size and type of the eeprom contained within 286 * a plug-in module. 287 * @get_module_eeprom: Get the eeprom information from the plug-in module 288 * @get_eee: Get Energy-Efficient (EEE) supported and status. 289 * @set_eee: Set EEE status (enable/disable) as well as LPI timers. 290 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue. 291 * It must check that the given queue number is valid. If neither a RX nor 292 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 293 * queue has this number, set the inapplicable fields to ~0 and return 0. 294 * Returns a negative error code or zero. 295 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue. 296 * It must check that the given queue number is valid. If neither a RX nor 297 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 298 * queue has this number, ignore the inapplicable fields. 299 * Returns a negative error code or zero. 300 * @get_link_ksettings: When defined, takes precedence over the 301 * %get_settings method. Get various device settings 302 * including Ethernet link settings. The %cmd and 303 * %link_mode_masks_nwords fields should be ignored (use 304 * %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), any 305 * change to them will be overwritten by kernel. Returns a 306 * negative error code or zero. 307 * @set_link_ksettings: When defined, takes precedence over the 308 * %set_settings method. Set various device settings including 309 * Ethernet link settings. The %cmd and %link_mode_masks_nwords 310 * fields should be ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS 311 * instead of the latter), any change to them will be overwritten 312 * by kernel. Returns a negative error code or zero. 313 * @get_fecparam: Get the network device Forward Error Correction parameters. 314 * @set_fecparam: Set the network device Forward Error Correction parameters. 315 * @get_ethtool_phy_stats: Return extended statistics about the PHY device. 316 * This is only useful if the device maintains PHY statistics and 317 * cannot use the standard PHY library helpers. 318 * 319 * All operations are optional (i.e. the function pointer may be set 320 * to %NULL) and callers must take this into account. Callers must 321 * hold the RTNL lock. 322 * 323 * See the structures used by these operations for further documentation. 324 * Note that for all operations using a structure ending with a zero- 325 * length array, the array is allocated separately in the kernel and 326 * is passed to the driver as an additional parameter. 327 * 328 * See &struct net_device and &struct net_device_ops for documentation 329 * of the generic netdev features interface. 330 */ 331struct ethtool_ops { 332 int (*get_settings)(struct net_device *, struct ethtool_cmd *); 333 int (*set_settings)(struct net_device *, struct ethtool_cmd *); 334 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 335 int (*get_regs_len)(struct net_device *); 336 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 337 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 338 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 339 u32 (*get_msglevel)(struct net_device *); 340 void (*set_msglevel)(struct net_device *, u32); 341 int (*nway_reset)(struct net_device *); 342 u32 (*get_link)(struct net_device *); 343 int (*get_eeprom_len)(struct net_device *); 344 int (*get_eeprom)(struct net_device *, 345 struct ethtool_eeprom *, u8 *); 346 int (*set_eeprom)(struct net_device *, 347 struct ethtool_eeprom *, u8 *); 348 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); 349 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); 350 void (*get_ringparam)(struct net_device *, 351 struct ethtool_ringparam *); 352 int (*set_ringparam)(struct net_device *, 353 struct ethtool_ringparam *); 354 void (*get_pauseparam)(struct net_device *, 355 struct ethtool_pauseparam*); 356 int (*set_pauseparam)(struct net_device *, 357 struct ethtool_pauseparam*); 358 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 359 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 360 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); 361 void (*get_ethtool_stats)(struct net_device *, 362 struct ethtool_stats *, u64 *); 363 int (*begin)(struct net_device *); 364 void (*complete)(struct net_device *); 365 u32 (*get_priv_flags)(struct net_device *); 366 int (*set_priv_flags)(struct net_device *, u32); 367 int (*get_sset_count)(struct net_device *, int); 368 int (*get_rxnfc)(struct net_device *, 369 struct ethtool_rxnfc *, u32 *rule_locs); 370 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 371 int (*flash_device)(struct net_device *, struct ethtool_flash *); 372 int (*reset)(struct net_device *, u32 *); 373 u32 (*get_rxfh_key_size)(struct net_device *); 374 u32 (*get_rxfh_indir_size)(struct net_device *); 375 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key, 376 u8 *hfunc); 377 int (*set_rxfh)(struct net_device *, const u32 *indir, 378 const u8 *key, const u8 hfunc); 379 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key, 380 u8 *hfunc, u32 rss_context); 381 int (*set_rxfh_context)(struct net_device *, const u32 *indir, 382 const u8 *key, const u8 hfunc, 383 u32 *rss_context, bool delete); 384 void (*get_channels)(struct net_device *, struct ethtool_channels *); 385 int (*set_channels)(struct net_device *, struct ethtool_channels *); 386 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); 387 int (*get_dump_data)(struct net_device *, 388 struct ethtool_dump *, void *); 389 int (*set_dump)(struct net_device *, struct ethtool_dump *); 390 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); 391 int (*get_module_info)(struct net_device *, 392 struct ethtool_modinfo *); 393 int (*get_module_eeprom)(struct net_device *, 394 struct ethtool_eeprom *, u8 *); 395 int (*get_eee)(struct net_device *, struct ethtool_eee *); 396 int (*set_eee)(struct net_device *, struct ethtool_eee *); 397 int (*get_tunable)(struct net_device *, 398 const struct ethtool_tunable *, void *); 399 int (*set_tunable)(struct net_device *, 400 const struct ethtool_tunable *, const void *); 401 int (*get_per_queue_coalesce)(struct net_device *, u32, 402 struct ethtool_coalesce *); 403 int (*set_per_queue_coalesce)(struct net_device *, u32, 404 struct ethtool_coalesce *); 405 int (*get_link_ksettings)(struct net_device *, 406 struct ethtool_link_ksettings *); 407 int (*set_link_ksettings)(struct net_device *, 408 const struct ethtool_link_ksettings *); 409 int (*get_fecparam)(struct net_device *, 410 struct ethtool_fecparam *); 411 int (*set_fecparam)(struct net_device *, 412 struct ethtool_fecparam *); 413 void (*get_ethtool_phy_stats)(struct net_device *, 414 struct ethtool_stats *, u64 *); 415}; 416#endif /* _LINUX_ETHTOOL_H */ 417