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