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