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/netlink.h> 19#include <uapi/linux/ethtool.h> 20 21struct compat_ethtool_rx_flow_spec { 22 u32 flow_type; 23 union ethtool_flow_union h_u; 24 struct ethtool_flow_ext h_ext; 25 union ethtool_flow_union m_u; 26 struct ethtool_flow_ext m_ext; 27 compat_u64 ring_cookie; 28 u32 location; 29}; 30 31struct compat_ethtool_rxnfc { 32 u32 cmd; 33 u32 flow_type; 34 compat_u64 data; 35 struct compat_ethtool_rx_flow_spec fs; 36 u32 rule_cnt; 37 u32 rule_locs[]; 38}; 39 40#include <linux/rculist.h> 41 42/** 43 * enum ethtool_phys_id_state - indicator state for physical identification 44 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated 45 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated 46 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE 47 * is not supported) 48 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE 49 * is not supported) 50 */ 51enum ethtool_phys_id_state { 52 ETHTOOL_ID_INACTIVE, 53 ETHTOOL_ID_ACTIVE, 54 ETHTOOL_ID_ON, 55 ETHTOOL_ID_OFF 56}; 57 58enum { 59 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */ 60 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */ 61 ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */ 62 63 /* 64 * Add your fresh new hash function bits above and remember to update 65 * rss_hash_func_strings[] in ethtool.c 66 */ 67 ETH_RSS_HASH_FUNCS_COUNT 68}; 69 70#define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit)) 71#define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT) 72 73#define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP) 74#define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR) 75#define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32) 76 77#define ETH_RSS_HASH_UNKNOWN 0 78#define ETH_RSS_HASH_NO_CHANGE 0 79 80struct net_device; 81struct netlink_ext_ack; 82 83/* Some generic methods drivers may use in their ethtool_ops */ 84u32 ethtool_op_get_link(struct net_device *dev); 85int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti); 86 87 88/* Link extended state and substate. */ 89struct ethtool_link_ext_state_info { 90 enum ethtool_link_ext_state link_ext_state; 91 union { 92 enum ethtool_link_ext_substate_autoneg autoneg; 93 enum ethtool_link_ext_substate_link_training link_training; 94 enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch; 95 enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity; 96 enum ethtool_link_ext_substate_cable_issue cable_issue; 97 u8 __link_ext_substate; 98 }; 99}; 100 101/** 102 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection 103 * @index: Index in RX flow hash indirection table 104 * @n_rx_rings: Number of RX rings to use 105 * 106 * This function provides the default policy for RX flow hash indirection. 107 */ 108static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings) 109{ 110 return index % n_rx_rings; 111} 112 113/* declare a link mode bitmap */ 114#define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \ 115 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS) 116 117/* drivers must ignore base.cmd and base.link_mode_masks_nwords 118 * fields, but they are allowed to overwrite them (will be ignored). 119 */ 120struct ethtool_link_ksettings { 121 struct ethtool_link_settings base; 122 struct { 123 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 124 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 125 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 126 } link_modes; 127 u32 lanes; 128}; 129 130/** 131 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask 132 * @ptr : pointer to struct ethtool_link_ksettings 133 * @name : one of supported/advertising/lp_advertising 134 */ 135#define ethtool_link_ksettings_zero_link_mode(ptr, name) \ 136 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS) 137 138/** 139 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings 140 * link mode mask 141 * @ptr : pointer to struct ethtool_link_ksettings 142 * @name : one of supported/advertising/lp_advertising 143 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 144 * (not atomic, no bound checking) 145 */ 146#define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \ 147 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 148 149/** 150 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings 151 * link mode mask 152 * @ptr : pointer to struct ethtool_link_ksettings 153 * @name : one of supported/advertising/lp_advertising 154 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 155 * (not atomic, no bound checking) 156 */ 157#define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \ 158 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 159 160/** 161 * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask 162 * @ptr : pointer to struct ethtool_link_ksettings 163 * @name : one of supported/advertising/lp_advertising 164 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 165 * (not atomic, no bound checking) 166 * 167 * Returns true/false. 168 */ 169#define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \ 170 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 171 172extern int 173__ethtool_get_link_ksettings(struct net_device *dev, 174 struct ethtool_link_ksettings *link_ksettings); 175 176struct kernel_ethtool_coalesce { 177 u8 use_cqe_mode_tx; 178 u8 use_cqe_mode_rx; 179}; 180 181/** 182 * ethtool_intersect_link_masks - Given two link masks, AND them together 183 * @dst: first mask and where result is stored 184 * @src: second mask to intersect with 185 * 186 * Given two link mode masks, AND them together and save the result in dst. 187 */ 188void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst, 189 struct ethtool_link_ksettings *src); 190 191void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst, 192 u32 legacy_u32); 193 194/* return false if src had higher bits set. lower bits always updated. */ 195bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32, 196 const unsigned long *src); 197 198#define ETHTOOL_COALESCE_RX_USECS BIT(0) 199#define ETHTOOL_COALESCE_RX_MAX_FRAMES BIT(1) 200#define ETHTOOL_COALESCE_RX_USECS_IRQ BIT(2) 201#define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ BIT(3) 202#define ETHTOOL_COALESCE_TX_USECS BIT(4) 203#define ETHTOOL_COALESCE_TX_MAX_FRAMES BIT(5) 204#define ETHTOOL_COALESCE_TX_USECS_IRQ BIT(6) 205#define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ BIT(7) 206#define ETHTOOL_COALESCE_STATS_BLOCK_USECS BIT(8) 207#define ETHTOOL_COALESCE_USE_ADAPTIVE_RX BIT(9) 208#define ETHTOOL_COALESCE_USE_ADAPTIVE_TX BIT(10) 209#define ETHTOOL_COALESCE_PKT_RATE_LOW BIT(11) 210#define ETHTOOL_COALESCE_RX_USECS_LOW BIT(12) 211#define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW BIT(13) 212#define ETHTOOL_COALESCE_TX_USECS_LOW BIT(14) 213#define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW BIT(15) 214#define ETHTOOL_COALESCE_PKT_RATE_HIGH BIT(16) 215#define ETHTOOL_COALESCE_RX_USECS_HIGH BIT(17) 216#define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH BIT(18) 217#define ETHTOOL_COALESCE_TX_USECS_HIGH BIT(19) 218#define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH BIT(20) 219#define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL BIT(21) 220#define ETHTOOL_COALESCE_USE_CQE_RX BIT(22) 221#define ETHTOOL_COALESCE_USE_CQE_TX BIT(23) 222#define ETHTOOL_COALESCE_ALL_PARAMS GENMASK(23, 0) 223 224#define ETHTOOL_COALESCE_USECS \ 225 (ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS) 226#define ETHTOOL_COALESCE_MAX_FRAMES \ 227 (ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES) 228#define ETHTOOL_COALESCE_USECS_IRQ \ 229 (ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ) 230#define ETHTOOL_COALESCE_MAX_FRAMES_IRQ \ 231 (ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ | \ 232 ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ) 233#define ETHTOOL_COALESCE_USE_ADAPTIVE \ 234 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX) 235#define ETHTOOL_COALESCE_USECS_LOW_HIGH \ 236 (ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \ 237 ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH) 238#define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH \ 239 (ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW | \ 240 ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW | \ 241 ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH | \ 242 ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH) 243#define ETHTOOL_COALESCE_PKT_RATE_RX_USECS \ 244 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | \ 245 ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \ 246 ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \ 247 ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL) 248#define ETHTOOL_COALESCE_USE_CQE \ 249 (ETHTOOL_COALESCE_USE_CQE_RX | ETHTOOL_COALESCE_USE_CQE_TX) 250 251#define ETHTOOL_STAT_NOT_SET (~0ULL) 252 253static inline void ethtool_stats_init(u64 *stats, unsigned int n) 254{ 255 while (n--) 256 stats[n] = ETHTOOL_STAT_NOT_SET; 257} 258 259/* Basic IEEE 802.3 MAC statistics (30.3.1.1.*), not otherwise exposed 260 * via a more targeted API. 261 */ 262struct ethtool_eth_mac_stats { 263 u64 FramesTransmittedOK; 264 u64 SingleCollisionFrames; 265 u64 MultipleCollisionFrames; 266 u64 FramesReceivedOK; 267 u64 FrameCheckSequenceErrors; 268 u64 AlignmentErrors; 269 u64 OctetsTransmittedOK; 270 u64 FramesWithDeferredXmissions; 271 u64 LateCollisions; 272 u64 FramesAbortedDueToXSColls; 273 u64 FramesLostDueToIntMACXmitError; 274 u64 CarrierSenseErrors; 275 u64 OctetsReceivedOK; 276 u64 FramesLostDueToIntMACRcvError; 277 u64 MulticastFramesXmittedOK; 278 u64 BroadcastFramesXmittedOK; 279 u64 FramesWithExcessiveDeferral; 280 u64 MulticastFramesReceivedOK; 281 u64 BroadcastFramesReceivedOK; 282 u64 InRangeLengthErrors; 283 u64 OutOfRangeLengthField; 284 u64 FrameTooLongErrors; 285}; 286 287/* Basic IEEE 802.3 PHY statistics (30.3.2.1.*), not otherwise exposed 288 * via a more targeted API. 289 */ 290struct ethtool_eth_phy_stats { 291 u64 SymbolErrorDuringCarrier; 292}; 293 294/* Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*), not otherwise exposed 295 * via a more targeted API. 296 */ 297struct ethtool_eth_ctrl_stats { 298 u64 MACControlFramesTransmitted; 299 u64 MACControlFramesReceived; 300 u64 UnsupportedOpcodesReceived; 301}; 302 303/** 304 * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames 305 * @tx_pause_frames: transmitted pause frame count. Reported to user space 306 * as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES. 307 * 308 * Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted` 309 * from the standard. 310 * 311 * @rx_pause_frames: received pause frame count. Reported to user space 312 * as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to: 313 * 314 * Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived` 315 * from the standard. 316 */ 317struct ethtool_pause_stats { 318 u64 tx_pause_frames; 319 u64 rx_pause_frames; 320}; 321 322#define ETHTOOL_MAX_LANES 8 323 324/** 325 * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC 326 * @corrected_blocks: number of received blocks corrected by FEC 327 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORRECTED. 328 * 329 * Equivalent to `30.5.1.1.17 aFECCorrectedBlocks` from the standard. 330 * 331 * @uncorrectable_blocks: number of received blocks FEC was not able to correct 332 * Reported to user space as %ETHTOOL_A_FEC_STAT_UNCORR. 333 * 334 * Equivalent to `30.5.1.1.18 aFECUncorrectableBlocks` from the standard. 335 * 336 * @corrected_bits: number of bits corrected by FEC 337 * Similar to @corrected_blocks but counts individual bit changes, 338 * not entire FEC data blocks. This is a non-standard statistic. 339 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS. 340 * 341 * @lane: per-lane/PCS-instance counts as defined by the standard 342 * @total: error counts for the entire port, for drivers incapable of reporting 343 * per-lane stats 344 * 345 * Drivers should fill in either only total or per-lane statistics, core 346 * will take care of adding lane values up to produce the total. 347 */ 348struct ethtool_fec_stats { 349 struct ethtool_fec_stat { 350 u64 total; 351 u64 lanes[ETHTOOL_MAX_LANES]; 352 } corrected_blocks, uncorrectable_blocks, corrected_bits; 353}; 354 355/** 356 * struct ethtool_rmon_hist_range - byte range for histogram statistics 357 * @low: low bound of the bucket (inclusive) 358 * @high: high bound of the bucket (inclusive) 359 */ 360struct ethtool_rmon_hist_range { 361 u16 low; 362 u16 high; 363}; 364 365#define ETHTOOL_RMON_HIST_MAX 10 366 367/** 368 * struct ethtool_rmon_stats - selected RMON (RFC 2819) statistics 369 * @undersize_pkts: Equivalent to `etherStatsUndersizePkts` from the RFC. 370 * @oversize_pkts: Equivalent to `etherStatsOversizePkts` from the RFC. 371 * @fragments: Equivalent to `etherStatsFragments` from the RFC. 372 * @jabbers: Equivalent to `etherStatsJabbers` from the RFC. 373 * @hist: Packet counter for packet length buckets (e.g. 374 * `etherStatsPkts128to255Octets` from the RFC). 375 * @hist_tx: Tx counters in similar form to @hist, not defined in the RFC. 376 * 377 * Selection of RMON (RFC 2819) statistics which are not exposed via different 378 * APIs, primarily the packet-length-based counters. 379 * Unfortunately different designs choose different buckets beyond 380 * the 1024B mark (jumbo frame teritory), so the definition of the bucket 381 * ranges is left to the driver. 382 */ 383struct ethtool_rmon_stats { 384 u64 undersize_pkts; 385 u64 oversize_pkts; 386 u64 fragments; 387 u64 jabbers; 388 389 u64 hist[ETHTOOL_RMON_HIST_MAX]; 390 u64 hist_tx[ETHTOOL_RMON_HIST_MAX]; 391}; 392 393#define ETH_MODULE_EEPROM_PAGE_LEN 128 394#define ETH_MODULE_MAX_I2C_ADDRESS 0x7f 395 396/** 397 * struct ethtool_module_eeprom - EEPROM dump from specified page 398 * @offset: Offset within the specified EEPROM page to begin read, in bytes. 399 * @length: Number of bytes to read. 400 * @page: Page number to read from. 401 * @bank: Page bank number to read from, if applicable by EEPROM spec. 402 * @i2c_address: I2C address of a page. Value less than 0x7f expected. Most 403 * EEPROMs use 0x50 or 0x51. 404 * @data: Pointer to buffer with EEPROM data of @length size. 405 * 406 * This can be used to manage pages during EEPROM dump in ethtool and pass 407 * required information to the driver. 408 */ 409struct ethtool_module_eeprom { 410 u32 offset; 411 u32 length; 412 u8 page; 413 u8 bank; 414 u8 i2c_address; 415 u8 *data; 416}; 417 418/** 419 * struct ethtool_ops - optional netdev operations 420 * @cap_link_lanes_supported: indicates if the driver supports lanes 421 * parameter. 422 * @supported_coalesce_params: supported types of interrupt coalescing. 423 * @get_drvinfo: Report driver/device information. Should only set the 424 * @driver, @version, @fw_version and @bus_info fields. If not 425 * implemented, the @driver and @bus_info fields will be filled in 426 * according to the netdev's parent device. 427 * @get_regs_len: Get buffer length required for @get_regs 428 * @get_regs: Get device registers 429 * @get_wol: Report whether Wake-on-Lan is enabled 430 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code 431 * or zero. 432 * @get_msglevel: Report driver message level. This should be the value 433 * of the @msg_enable field used by netif logging functions. 434 * @set_msglevel: Set driver message level 435 * @nway_reset: Restart autonegotiation. Returns a negative error code 436 * or zero. 437 * @get_link: Report whether physical link is up. Will only be called if 438 * the netdev is up. Should usually be set to ethtool_op_get_link(), 439 * which uses netif_carrier_ok(). 440 * @get_link_ext_state: Report link extended state. Should set link_ext_state and 441 * link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown, 442 * do not attach ext_substate attribute to netlink message). If link_ext_state 443 * and link_ext_substate are unknown, return -ENODATA. If not implemented, 444 * link_ext_state and link_ext_substate will not be sent to userspace. 445 * @get_eeprom_len: Read range of EEPROM addresses for validation of 446 * @get_eeprom and @set_eeprom requests. 447 * Returns 0 if device does not support EEPROM access. 448 * @get_eeprom: Read data from the device EEPROM. 449 * Should fill in the magic field. Don't need to check len for zero 450 * or wraparound. Fill in the data argument with the eeprom values 451 * from offset to offset + len. Update len to the amount read. 452 * Returns an error or zero. 453 * @set_eeprom: Write data to the device EEPROM. 454 * Should validate the magic field. Don't need to check len for zero 455 * or wraparound. Update len to the amount written. Returns an error 456 * or zero. 457 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative 458 * error code or zero. 459 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing 460 * types should be set in @supported_coalesce_params. 461 * Returns a negative error code or zero. 462 * @get_ringparam: Report ring sizes 463 * @set_ringparam: Set ring sizes. Returns a negative error code or zero. 464 * @get_pause_stats: Report pause frame statistics. Drivers must not zero 465 * statistics which they don't report. The stats structure is initialized 466 * to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics. 467 * @get_pauseparam: Report pause parameters 468 * @set_pauseparam: Set pause parameters. Returns a negative error code 469 * or zero. 470 * @self_test: Run specified self-tests 471 * @get_strings: Return a set of strings that describe the requested objects 472 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED 473 * attached to it. The implementation may update the indicator 474 * asynchronously or synchronously, but in either case it must return 475 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, 476 * and must either activate asynchronous updates and return zero, return 477 * a negative error or return a positive frequency for synchronous 478 * indication (e.g. 1 for one on/off cycle per second). If it returns 479 * a frequency then it will be called again at intervals with the 480 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of 481 * the indicator accordingly. Finally, it is called with the argument 482 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a 483 * negative error code or zero. 484 * @get_ethtool_stats: Return extended statistics about the device. 485 * This is only useful if the device maintains statistics not 486 * included in &struct rtnl_link_stats64. 487 * @begin: Function to be called before any other operation. Returns a 488 * negative error code or zero. 489 * @complete: Function to be called after any other operation except 490 * @begin. Will be called even if the other operation failed. 491 * @get_priv_flags: Report driver-specific feature flags. 492 * @set_priv_flags: Set driver-specific feature flags. Returns a negative 493 * error code or zero. 494 * @get_sset_count: Get number of strings that @get_strings will write. 495 * @get_rxnfc: Get RX flow classification rules. Returns a negative 496 * error code or zero. 497 * @set_rxnfc: Set RX flow classification rules. Returns a negative 498 * error code or zero. 499 * @flash_device: Write a firmware image to device's flash memory. 500 * Returns a negative error code or zero. 501 * @reset: Reset (part of) the device, as specified by a bitmask of 502 * flags from &enum ethtool_reset_flags. Returns a negative 503 * error code or zero. 504 * @get_rxfh_key_size: Get the size of the RX flow hash key. 505 * Returns zero if not supported for this specific device. 506 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. 507 * Returns zero if not supported for this specific device. 508 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key 509 * and/or hash function. 510 * Returns a negative error code or zero. 511 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash 512 * key, and/or hash function. Arguments which are set to %NULL or zero 513 * will remain unchanged. 514 * Returns a negative error code or zero. An error code must be returned 515 * if at least one unsupported change was requested. 516 * @get_rxfh_context: Get the contents of the RX flow hash indirection table, 517 * hash key, and/or hash function assiciated to the given rss context. 518 * Returns a negative error code or zero. 519 * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting 520 * the contents of the RX flow hash indirection table, hash key, and/or 521 * hash function associated to the given context. Arguments which are set 522 * to %NULL or zero will remain unchanged. 523 * Returns a negative error code or zero. An error code must be returned 524 * if at least one unsupported change was requested. 525 * @get_channels: Get number of channels. 526 * @set_channels: Set number of channels. Returns a negative error code or 527 * zero. 528 * @get_dump_flag: Get dump flag indicating current dump length, version, 529 * and flag of the device. 530 * @get_dump_data: Get dump data. 531 * @set_dump: Set dump specific flags to the device. 532 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. 533 * Drivers supporting transmit time stamps in software should set this to 534 * ethtool_op_get_ts_info(). 535 * @get_module_info: Get the size and type of the eeprom contained within 536 * a plug-in module. 537 * @get_module_eeprom: Get the eeprom information from the plug-in module 538 * @get_eee: Get Energy-Efficient (EEE) supported and status. 539 * @set_eee: Set EEE status (enable/disable) as well as LPI timers. 540 * @get_tunable: Read the value of a driver / device tunable. 541 * @set_tunable: Set the value of a driver / device tunable. 542 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue. 543 * It must check that the given queue number is valid. If neither a RX nor 544 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 545 * queue has this number, set the inapplicable fields to ~0 and return 0. 546 * Returns a negative error code or zero. 547 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue. 548 * It must check that the given queue number is valid. If neither a RX nor 549 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 550 * queue has this number, ignore the inapplicable fields. Supported 551 * coalescing types should be set in @supported_coalesce_params. 552 * Returns a negative error code or zero. 553 * @get_link_ksettings: Get various device settings including Ethernet link 554 * settings. The %cmd and %link_mode_masks_nwords fields should be 555 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), 556 * any change to them will be overwritten by kernel. Returns a negative 557 * error code or zero. 558 * @set_link_ksettings: Set various device settings including Ethernet link 559 * settings. The %cmd and %link_mode_masks_nwords fields should be 560 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), 561 * any change to them will be overwritten by kernel. Returns a negative 562 * error code or zero. 563 * @get_fec_stats: Report FEC statistics. 564 * Core will sum up per-lane stats to get the total. 565 * Drivers must not zero statistics which they don't report. The stats 566 * structure is initialized to ETHTOOL_STAT_NOT_SET indicating driver does 567 * not report statistics. 568 * @get_fecparam: Get the network device Forward Error Correction parameters. 569 * @set_fecparam: Set the network device Forward Error Correction parameters. 570 * @get_ethtool_phy_stats: Return extended statistics about the PHY device. 571 * This is only useful if the device maintains PHY statistics and 572 * cannot use the standard PHY library helpers. 573 * @get_phy_tunable: Read the value of a PHY tunable. 574 * @set_phy_tunable: Set the value of a PHY tunable. 575 * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from 576 * specified page. Returns a negative error code or the amount of bytes 577 * read. 578 * @get_eth_phy_stats: Query some of the IEEE 802.3 PHY statistics. 579 * @get_eth_mac_stats: Query some of the IEEE 802.3 MAC statistics. 580 * @get_eth_ctrl_stats: Query some of the IEEE 802.3 MAC Ctrl statistics. 581 * @get_rmon_stats: Query some of the RMON (RFC 2819) statistics. 582 * Set %ranges to a pointer to zero-terminated array of byte ranges. 583 * 584 * All operations are optional (i.e. the function pointer may be set 585 * to %NULL) and callers must take this into account. Callers must 586 * hold the RTNL lock. 587 * 588 * See the structures used by these operations for further documentation. 589 * Note that for all operations using a structure ending with a zero- 590 * length array, the array is allocated separately in the kernel and 591 * is passed to the driver as an additional parameter. 592 * 593 * See &struct net_device and &struct net_device_ops for documentation 594 * of the generic netdev features interface. 595 */ 596struct ethtool_ops { 597 u32 cap_link_lanes_supported:1; 598 u32 supported_coalesce_params; 599 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 600 int (*get_regs_len)(struct net_device *); 601 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 602 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 603 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 604 u32 (*get_msglevel)(struct net_device *); 605 void (*set_msglevel)(struct net_device *, u32); 606 int (*nway_reset)(struct net_device *); 607 u32 (*get_link)(struct net_device *); 608 int (*get_link_ext_state)(struct net_device *, 609 struct ethtool_link_ext_state_info *); 610 int (*get_eeprom_len)(struct net_device *); 611 int (*get_eeprom)(struct net_device *, 612 struct ethtool_eeprom *, u8 *); 613 int (*set_eeprom)(struct net_device *, 614 struct ethtool_eeprom *, u8 *); 615 int (*get_coalesce)(struct net_device *, 616 struct ethtool_coalesce *, 617 struct kernel_ethtool_coalesce *, 618 struct netlink_ext_ack *); 619 int (*set_coalesce)(struct net_device *, 620 struct ethtool_coalesce *, 621 struct kernel_ethtool_coalesce *, 622 struct netlink_ext_ack *); 623 void (*get_ringparam)(struct net_device *, 624 struct ethtool_ringparam *); 625 int (*set_ringparam)(struct net_device *, 626 struct ethtool_ringparam *); 627 void (*get_pause_stats)(struct net_device *dev, 628 struct ethtool_pause_stats *pause_stats); 629 void (*get_pauseparam)(struct net_device *, 630 struct ethtool_pauseparam*); 631 int (*set_pauseparam)(struct net_device *, 632 struct ethtool_pauseparam*); 633 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 634 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 635 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); 636 void (*get_ethtool_stats)(struct net_device *, 637 struct ethtool_stats *, u64 *); 638 int (*begin)(struct net_device *); 639 void (*complete)(struct net_device *); 640 u32 (*get_priv_flags)(struct net_device *); 641 int (*set_priv_flags)(struct net_device *, u32); 642 int (*get_sset_count)(struct net_device *, int); 643 int (*get_rxnfc)(struct net_device *, 644 struct ethtool_rxnfc *, u32 *rule_locs); 645 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 646 int (*flash_device)(struct net_device *, struct ethtool_flash *); 647 int (*reset)(struct net_device *, u32 *); 648 u32 (*get_rxfh_key_size)(struct net_device *); 649 u32 (*get_rxfh_indir_size)(struct net_device *); 650 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key, 651 u8 *hfunc); 652 int (*set_rxfh)(struct net_device *, const u32 *indir, 653 const u8 *key, const u8 hfunc); 654 int (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key, 655 u8 *hfunc, u32 rss_context); 656 int (*set_rxfh_context)(struct net_device *, const u32 *indir, 657 const u8 *key, const u8 hfunc, 658 u32 *rss_context, bool delete); 659 void (*get_channels)(struct net_device *, struct ethtool_channels *); 660 int (*set_channels)(struct net_device *, struct ethtool_channels *); 661 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); 662 int (*get_dump_data)(struct net_device *, 663 struct ethtool_dump *, void *); 664 int (*set_dump)(struct net_device *, struct ethtool_dump *); 665 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); 666 int (*get_module_info)(struct net_device *, 667 struct ethtool_modinfo *); 668 int (*get_module_eeprom)(struct net_device *, 669 struct ethtool_eeprom *, u8 *); 670 int (*get_eee)(struct net_device *, struct ethtool_eee *); 671 int (*set_eee)(struct net_device *, struct ethtool_eee *); 672 int (*get_tunable)(struct net_device *, 673 const struct ethtool_tunable *, void *); 674 int (*set_tunable)(struct net_device *, 675 const struct ethtool_tunable *, const void *); 676 int (*get_per_queue_coalesce)(struct net_device *, u32, 677 struct ethtool_coalesce *); 678 int (*set_per_queue_coalesce)(struct net_device *, u32, 679 struct ethtool_coalesce *); 680 int (*get_link_ksettings)(struct net_device *, 681 struct ethtool_link_ksettings *); 682 int (*set_link_ksettings)(struct net_device *, 683 const struct ethtool_link_ksettings *); 684 void (*get_fec_stats)(struct net_device *dev, 685 struct ethtool_fec_stats *fec_stats); 686 int (*get_fecparam)(struct net_device *, 687 struct ethtool_fecparam *); 688 int (*set_fecparam)(struct net_device *, 689 struct ethtool_fecparam *); 690 void (*get_ethtool_phy_stats)(struct net_device *, 691 struct ethtool_stats *, u64 *); 692 int (*get_phy_tunable)(struct net_device *, 693 const struct ethtool_tunable *, void *); 694 int (*set_phy_tunable)(struct net_device *, 695 const struct ethtool_tunable *, const void *); 696 int (*get_module_eeprom_by_page)(struct net_device *dev, 697 const struct ethtool_module_eeprom *page, 698 struct netlink_ext_ack *extack); 699 void (*get_eth_phy_stats)(struct net_device *dev, 700 struct ethtool_eth_phy_stats *phy_stats); 701 void (*get_eth_mac_stats)(struct net_device *dev, 702 struct ethtool_eth_mac_stats *mac_stats); 703 void (*get_eth_ctrl_stats)(struct net_device *dev, 704 struct ethtool_eth_ctrl_stats *ctrl_stats); 705 void (*get_rmon_stats)(struct net_device *dev, 706 struct ethtool_rmon_stats *rmon_stats, 707 const struct ethtool_rmon_hist_range **ranges); 708}; 709 710int ethtool_check_ops(const struct ethtool_ops *ops); 711 712struct ethtool_rx_flow_rule { 713 struct flow_rule *rule; 714 unsigned long priv[]; 715}; 716 717struct ethtool_rx_flow_spec_input { 718 const struct ethtool_rx_flow_spec *fs; 719 u32 rss_ctx; 720}; 721 722struct ethtool_rx_flow_rule * 723ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input); 724void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule); 725 726bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd); 727int ethtool_virtdev_set_link_ksettings(struct net_device *dev, 728 const struct ethtool_link_ksettings *cmd, 729 u32 *dev_speed, u8 *dev_duplex); 730 731struct phy_device; 732struct phy_tdr_config; 733 734/** 735 * struct ethtool_phy_ops - Optional PHY device options 736 * @get_sset_count: Get number of strings that @get_strings will write. 737 * @get_strings: Return a set of strings that describe the requested objects 738 * @get_stats: Return extended statistics about the PHY device. 739 * @start_cable_test: Start a cable test 740 * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test 741 * 742 * All operations are optional (i.e. the function pointer may be set to %NULL) 743 * and callers must take this into account. Callers must hold the RTNL lock. 744 */ 745struct ethtool_phy_ops { 746 int (*get_sset_count)(struct phy_device *dev); 747 int (*get_strings)(struct phy_device *dev, u8 *data); 748 int (*get_stats)(struct phy_device *dev, 749 struct ethtool_stats *stats, u64 *data); 750 int (*start_cable_test)(struct phy_device *phydev, 751 struct netlink_ext_ack *extack); 752 int (*start_cable_test_tdr)(struct phy_device *phydev, 753 struct netlink_ext_ack *extack, 754 const struct phy_tdr_config *config); 755}; 756 757/** 758 * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton 759 * @ops: Ethtool PHY operations to set 760 */ 761void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops); 762 763/** 764 * ethtool_params_from_link_mode - Derive link parameters from a given link mode 765 * @link_ksettings: Link parameters to be derived from the link mode 766 * @link_mode: Link mode 767 */ 768void 769ethtool_params_from_link_mode(struct ethtool_link_ksettings *link_ksettings, 770 enum ethtool_link_mode_bit_indices link_mode); 771 772/** 773 * ethtool_get_phc_vclocks - Derive phc vclocks information, and caller 774 * is responsible to free memory of vclock_index 775 * @dev: pointer to net_device structure 776 * @vclock_index: pointer to pointer of vclock index 777 * 778 * Return number of phc vclocks 779 */ 780int ethtool_get_phc_vclocks(struct net_device *dev, int **vclock_index); 781 782/** 783 * ethtool_sprintf - Write formatted string to ethtool string data 784 * @data: Pointer to start of string to update 785 * @fmt: Format of string to write 786 * 787 * Write formatted string to data. Update data to point at start of 788 * next string. 789 */ 790extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...); 791#endif /* _LINUX_ETHTOOL_H */ 792