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/if_ether.h> 19 #include <linux/netlink.h> 20 #include <uapi/linux/ethtool.h> 21 22 struct compat_ethtool_rx_flow_spec { 23 u32 flow_type; 24 union ethtool_flow_union h_u; 25 struct ethtool_flow_ext h_ext; 26 union ethtool_flow_union m_u; 27 struct ethtool_flow_ext m_ext; 28 compat_u64 ring_cookie; 29 u32 location; 30 }; 31 32 struct compat_ethtool_rxnfc { 33 u32 cmd; 34 u32 flow_type; 35 compat_u64 data; 36 struct compat_ethtool_rx_flow_spec fs; 37 u32 rule_cnt; 38 u32 rule_locs[]; 39 }; 40 41 #include <linux/rculist.h> 42 43 /** 44 * enum ethtool_phys_id_state - indicator state for physical identification 45 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated 46 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated 47 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE 48 * is not supported) 49 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE 50 * is not supported) 51 */ 52 enum ethtool_phys_id_state { 53 ETHTOOL_ID_INACTIVE, 54 ETHTOOL_ID_ACTIVE, 55 ETHTOOL_ID_ON, 56 ETHTOOL_ID_OFF 57 }; 58 59 enum { 60 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */ 61 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */ 62 ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */ 63 64 /* 65 * Add your fresh new hash function bits above and remember to update 66 * rss_hash_func_strings[] in ethtool.c 67 */ 68 ETH_RSS_HASH_FUNCS_COUNT 69 }; 70 71 /** 72 * struct kernel_ethtool_ringparam - RX/TX ring configuration 73 * @rx_buf_len: Current length of buffers on the rx ring. 74 * @tcp_data_split: Scatter packet headers and data to separate buffers 75 * @tx_push: The flag of tx push mode 76 * @rx_push: The flag of rx push mode 77 * @cqe_size: Size of TX/RX completion queue event 78 * @tx_push_buf_len: Size of TX push buffer 79 * @tx_push_buf_max_len: Maximum allowed size of TX push buffer 80 */ 81 struct kernel_ethtool_ringparam { 82 u32 rx_buf_len; 83 u8 tcp_data_split; 84 u8 tx_push; 85 u8 rx_push; 86 u32 cqe_size; 87 u32 tx_push_buf_len; 88 u32 tx_push_buf_max_len; 89 }; 90 91 /** 92 * enum ethtool_supported_ring_param - indicator caps for setting ring params 93 * @ETHTOOL_RING_USE_RX_BUF_LEN: capture for setting rx_buf_len 94 * @ETHTOOL_RING_USE_CQE_SIZE: capture for setting cqe_size 95 * @ETHTOOL_RING_USE_TX_PUSH: capture for setting tx_push 96 * @ETHTOOL_RING_USE_RX_PUSH: capture for setting rx_push 97 * @ETHTOOL_RING_USE_TX_PUSH_BUF_LEN: capture for setting tx_push_buf_len 98 * @ETHTOOL_RING_USE_TCP_DATA_SPLIT: capture for setting tcp_data_split 99 */ 100 enum ethtool_supported_ring_param { 101 ETHTOOL_RING_USE_RX_BUF_LEN = BIT(0), 102 ETHTOOL_RING_USE_CQE_SIZE = BIT(1), 103 ETHTOOL_RING_USE_TX_PUSH = BIT(2), 104 ETHTOOL_RING_USE_RX_PUSH = BIT(3), 105 ETHTOOL_RING_USE_TX_PUSH_BUF_LEN = BIT(4), 106 ETHTOOL_RING_USE_TCP_DATA_SPLIT = BIT(5), 107 }; 108 109 #define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit)) 110 #define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT) 111 112 #define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP) 113 #define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR) 114 #define ETH_RSS_HASH_CRC32 __ETH_RSS_HASH(CRC32) 115 116 #define ETH_RSS_HASH_UNKNOWN 0 117 #define ETH_RSS_HASH_NO_CHANGE 0 118 119 struct net_device; 120 struct netlink_ext_ack; 121 122 /* Link extended state and substate. */ 123 struct ethtool_link_ext_state_info { 124 enum ethtool_link_ext_state link_ext_state; 125 union { 126 enum ethtool_link_ext_substate_autoneg autoneg; 127 enum ethtool_link_ext_substate_link_training link_training; 128 enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch; 129 enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity; 130 enum ethtool_link_ext_substate_cable_issue cable_issue; 131 enum ethtool_link_ext_substate_module module; 132 u32 __link_ext_substate; 133 }; 134 }; 135 136 struct ethtool_link_ext_stats { 137 /* Custom Linux statistic for PHY level link down events. 138 * In a simpler world it should be equal to netdev->carrier_down_count 139 * unfortunately netdev also counts local reconfigurations which don't 140 * actually take the physical link down, not to mention NC-SI which, 141 * if present, keeps the link up regardless of host state. 142 * This statistic counts when PHY _actually_ went down, or lost link. 143 * 144 * Note that we need u64 for ethtool_stats_init() and comparisons 145 * to ETHTOOL_STAT_NOT_SET, but only u32 is exposed to the user. 146 */ 147 u64 link_down_events; 148 }; 149 150 /** 151 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection 152 * @index: Index in RX flow hash indirection table 153 * @n_rx_rings: Number of RX rings to use 154 * 155 * This function provides the default policy for RX flow hash indirection. 156 */ 157 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings) 158 { 159 return index % n_rx_rings; 160 } 161 162 /* declare a link mode bitmap */ 163 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \ 164 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS) 165 166 /* drivers must ignore base.cmd and base.link_mode_masks_nwords 167 * fields, but they are allowed to overwrite them (will be ignored). 168 */ 169 struct ethtool_link_ksettings { 170 struct ethtool_link_settings base; 171 struct { 172 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 173 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 174 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 175 } link_modes; 176 u32 lanes; 177 }; 178 179 /** 180 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask 181 * @ptr : pointer to struct ethtool_link_ksettings 182 * @name : one of supported/advertising/lp_advertising 183 */ 184 #define ethtool_link_ksettings_zero_link_mode(ptr, name) \ 185 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS) 186 187 /** 188 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings 189 * link mode mask 190 * @ptr : pointer to struct ethtool_link_ksettings 191 * @name : one of supported/advertising/lp_advertising 192 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 193 * (not atomic, no bound checking) 194 */ 195 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \ 196 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 197 198 /** 199 * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings 200 * link mode mask 201 * @ptr : pointer to struct ethtool_link_ksettings 202 * @name : one of supported/advertising/lp_advertising 203 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 204 * (not atomic, no bound checking) 205 */ 206 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode) \ 207 __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 208 209 /** 210 * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask 211 * @ptr : pointer to struct ethtool_link_ksettings 212 * @name : one of supported/advertising/lp_advertising 213 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 214 * (not atomic, no bound checking) 215 * 216 * Returns true/false. 217 */ 218 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \ 219 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 220 221 extern int 222 __ethtool_get_link_ksettings(struct net_device *dev, 223 struct ethtool_link_ksettings *link_ksettings); 224 225 struct ethtool_keee { 226 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 227 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertised); 228 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertised); 229 u32 supported_u32; 230 u32 advertised_u32; 231 u32 lp_advertised_u32; 232 u32 tx_lpi_timer; 233 bool tx_lpi_enabled; 234 bool eee_active; 235 bool eee_enabled; 236 }; 237 238 struct kernel_ethtool_coalesce { 239 u8 use_cqe_mode_tx; 240 u8 use_cqe_mode_rx; 241 u32 tx_aggr_max_bytes; 242 u32 tx_aggr_max_frames; 243 u32 tx_aggr_time_usecs; 244 }; 245 246 /** 247 * ethtool_intersect_link_masks - Given two link masks, AND them together 248 * @dst: first mask and where result is stored 249 * @src: second mask to intersect with 250 * 251 * Given two link mode masks, AND them together and save the result in dst. 252 */ 253 void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst, 254 struct ethtool_link_ksettings *src); 255 256 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst, 257 u32 legacy_u32); 258 259 /* return false if src had higher bits set. lower bits always updated. */ 260 bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32, 261 const unsigned long *src); 262 263 #define ETHTOOL_COALESCE_RX_USECS BIT(0) 264 #define ETHTOOL_COALESCE_RX_MAX_FRAMES BIT(1) 265 #define ETHTOOL_COALESCE_RX_USECS_IRQ BIT(2) 266 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ BIT(3) 267 #define ETHTOOL_COALESCE_TX_USECS BIT(4) 268 #define ETHTOOL_COALESCE_TX_MAX_FRAMES BIT(5) 269 #define ETHTOOL_COALESCE_TX_USECS_IRQ BIT(6) 270 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ BIT(7) 271 #define ETHTOOL_COALESCE_STATS_BLOCK_USECS BIT(8) 272 #define ETHTOOL_COALESCE_USE_ADAPTIVE_RX BIT(9) 273 #define ETHTOOL_COALESCE_USE_ADAPTIVE_TX BIT(10) 274 #define ETHTOOL_COALESCE_PKT_RATE_LOW BIT(11) 275 #define ETHTOOL_COALESCE_RX_USECS_LOW BIT(12) 276 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW BIT(13) 277 #define ETHTOOL_COALESCE_TX_USECS_LOW BIT(14) 278 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW BIT(15) 279 #define ETHTOOL_COALESCE_PKT_RATE_HIGH BIT(16) 280 #define ETHTOOL_COALESCE_RX_USECS_HIGH BIT(17) 281 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH BIT(18) 282 #define ETHTOOL_COALESCE_TX_USECS_HIGH BIT(19) 283 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH BIT(20) 284 #define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL BIT(21) 285 #define ETHTOOL_COALESCE_USE_CQE_RX BIT(22) 286 #define ETHTOOL_COALESCE_USE_CQE_TX BIT(23) 287 #define ETHTOOL_COALESCE_TX_AGGR_MAX_BYTES BIT(24) 288 #define ETHTOOL_COALESCE_TX_AGGR_MAX_FRAMES BIT(25) 289 #define ETHTOOL_COALESCE_TX_AGGR_TIME_USECS BIT(26) 290 #define ETHTOOL_COALESCE_ALL_PARAMS GENMASK(26, 0) 291 292 #define ETHTOOL_COALESCE_USECS \ 293 (ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS) 294 #define ETHTOOL_COALESCE_MAX_FRAMES \ 295 (ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES) 296 #define ETHTOOL_COALESCE_USECS_IRQ \ 297 (ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ) 298 #define ETHTOOL_COALESCE_MAX_FRAMES_IRQ \ 299 (ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ | \ 300 ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ) 301 #define ETHTOOL_COALESCE_USE_ADAPTIVE \ 302 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX) 303 #define ETHTOOL_COALESCE_USECS_LOW_HIGH \ 304 (ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \ 305 ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH) 306 #define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH \ 307 (ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW | \ 308 ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW | \ 309 ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH | \ 310 ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH) 311 #define ETHTOOL_COALESCE_PKT_RATE_RX_USECS \ 312 (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | \ 313 ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \ 314 ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \ 315 ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL) 316 #define ETHTOOL_COALESCE_USE_CQE \ 317 (ETHTOOL_COALESCE_USE_CQE_RX | ETHTOOL_COALESCE_USE_CQE_TX) 318 #define ETHTOOL_COALESCE_TX_AGGR \ 319 (ETHTOOL_COALESCE_TX_AGGR_MAX_BYTES | \ 320 ETHTOOL_COALESCE_TX_AGGR_MAX_FRAMES | \ 321 ETHTOOL_COALESCE_TX_AGGR_TIME_USECS) 322 323 #define ETHTOOL_STAT_NOT_SET (~0ULL) 324 325 static inline void ethtool_stats_init(u64 *stats, unsigned int n) 326 { 327 while (n--) 328 stats[n] = ETHTOOL_STAT_NOT_SET; 329 } 330 331 /* Basic IEEE 802.3 MAC statistics (30.3.1.1.*), not otherwise exposed 332 * via a more targeted API. 333 */ 334 struct ethtool_eth_mac_stats { 335 enum ethtool_mac_stats_src src; 336 struct_group(stats, 337 u64 FramesTransmittedOK; 338 u64 SingleCollisionFrames; 339 u64 MultipleCollisionFrames; 340 u64 FramesReceivedOK; 341 u64 FrameCheckSequenceErrors; 342 u64 AlignmentErrors; 343 u64 OctetsTransmittedOK; 344 u64 FramesWithDeferredXmissions; 345 u64 LateCollisions; 346 u64 FramesAbortedDueToXSColls; 347 u64 FramesLostDueToIntMACXmitError; 348 u64 CarrierSenseErrors; 349 u64 OctetsReceivedOK; 350 u64 FramesLostDueToIntMACRcvError; 351 u64 MulticastFramesXmittedOK; 352 u64 BroadcastFramesXmittedOK; 353 u64 FramesWithExcessiveDeferral; 354 u64 MulticastFramesReceivedOK; 355 u64 BroadcastFramesReceivedOK; 356 u64 InRangeLengthErrors; 357 u64 OutOfRangeLengthField; 358 u64 FrameTooLongErrors; 359 ); 360 }; 361 362 /* Basic IEEE 802.3 PHY statistics (30.3.2.1.*), not otherwise exposed 363 * via a more targeted API. 364 */ 365 struct ethtool_eth_phy_stats { 366 enum ethtool_mac_stats_src src; 367 struct_group(stats, 368 u64 SymbolErrorDuringCarrier; 369 ); 370 }; 371 372 /* Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*), not otherwise exposed 373 * via a more targeted API. 374 */ 375 struct ethtool_eth_ctrl_stats { 376 enum ethtool_mac_stats_src src; 377 struct_group(stats, 378 u64 MACControlFramesTransmitted; 379 u64 MACControlFramesReceived; 380 u64 UnsupportedOpcodesReceived; 381 ); 382 }; 383 384 /** 385 * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames 386 * @src: input field denoting whether stats should be queried from the eMAC or 387 * pMAC (if the MM layer is supported). To be ignored otherwise. 388 * @tx_pause_frames: transmitted pause frame count. Reported to user space 389 * as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES. 390 * 391 * Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted` 392 * from the standard. 393 * 394 * @rx_pause_frames: received pause frame count. Reported to user space 395 * as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to: 396 * 397 * Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived` 398 * from the standard. 399 */ 400 struct ethtool_pause_stats { 401 enum ethtool_mac_stats_src src; 402 struct_group(stats, 403 u64 tx_pause_frames; 404 u64 rx_pause_frames; 405 ); 406 }; 407 408 #define ETHTOOL_MAX_LANES 8 409 410 /** 411 * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC 412 * @corrected_blocks: number of received blocks corrected by FEC 413 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORRECTED. 414 * 415 * Equivalent to `30.5.1.1.17 aFECCorrectedBlocks` from the standard. 416 * 417 * @uncorrectable_blocks: number of received blocks FEC was not able to correct 418 * Reported to user space as %ETHTOOL_A_FEC_STAT_UNCORR. 419 * 420 * Equivalent to `30.5.1.1.18 aFECUncorrectableBlocks` from the standard. 421 * 422 * @corrected_bits: number of bits corrected by FEC 423 * Similar to @corrected_blocks but counts individual bit changes, 424 * not entire FEC data blocks. This is a non-standard statistic. 425 * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS. 426 * 427 * For each of the above fields, the two substructure members are: 428 * 429 * - @lanes: per-lane/PCS-instance counts as defined by the standard 430 * - @total: error counts for the entire port, for drivers incapable of reporting 431 * per-lane stats 432 * 433 * Drivers should fill in either only total or per-lane statistics, core 434 * will take care of adding lane values up to produce the total. 435 */ 436 struct ethtool_fec_stats { 437 struct ethtool_fec_stat { 438 u64 total; 439 u64 lanes[ETHTOOL_MAX_LANES]; 440 } corrected_blocks, uncorrectable_blocks, corrected_bits; 441 }; 442 443 /** 444 * struct ethtool_rmon_hist_range - byte range for histogram statistics 445 * @low: low bound of the bucket (inclusive) 446 * @high: high bound of the bucket (inclusive) 447 */ 448 struct ethtool_rmon_hist_range { 449 u16 low; 450 u16 high; 451 }; 452 453 #define ETHTOOL_RMON_HIST_MAX 10 454 455 /** 456 * struct ethtool_rmon_stats - selected RMON (RFC 2819) statistics 457 * @src: input field denoting whether stats should be queried from the eMAC or 458 * pMAC (if the MM layer is supported). To be ignored otherwise. 459 * @undersize_pkts: Equivalent to `etherStatsUndersizePkts` from the RFC. 460 * @oversize_pkts: Equivalent to `etherStatsOversizePkts` from the RFC. 461 * @fragments: Equivalent to `etherStatsFragments` from the RFC. 462 * @jabbers: Equivalent to `etherStatsJabbers` from the RFC. 463 * @hist: Packet counter for packet length buckets (e.g. 464 * `etherStatsPkts128to255Octets` from the RFC). 465 * @hist_tx: Tx counters in similar form to @hist, not defined in the RFC. 466 * 467 * Selection of RMON (RFC 2819) statistics which are not exposed via different 468 * APIs, primarily the packet-length-based counters. 469 * Unfortunately different designs choose different buckets beyond 470 * the 1024B mark (jumbo frame teritory), so the definition of the bucket 471 * ranges is left to the driver. 472 */ 473 struct ethtool_rmon_stats { 474 enum ethtool_mac_stats_src src; 475 struct_group(stats, 476 u64 undersize_pkts; 477 u64 oversize_pkts; 478 u64 fragments; 479 u64 jabbers; 480 481 u64 hist[ETHTOOL_RMON_HIST_MAX]; 482 u64 hist_tx[ETHTOOL_RMON_HIST_MAX]; 483 ); 484 }; 485 486 #define ETH_MODULE_EEPROM_PAGE_LEN 128 487 #define ETH_MODULE_MAX_I2C_ADDRESS 0x7f 488 489 /** 490 * struct ethtool_module_eeprom - EEPROM dump from specified page 491 * @offset: Offset within the specified EEPROM page to begin read, in bytes. 492 * @length: Number of bytes to read. 493 * @page: Page number to read from. 494 * @bank: Page bank number to read from, if applicable by EEPROM spec. 495 * @i2c_address: I2C address of a page. Value less than 0x7f expected. Most 496 * EEPROMs use 0x50 or 0x51. 497 * @data: Pointer to buffer with EEPROM data of @length size. 498 * 499 * This can be used to manage pages during EEPROM dump in ethtool and pass 500 * required information to the driver. 501 */ 502 struct ethtool_module_eeprom { 503 u32 offset; 504 u32 length; 505 u8 page; 506 u8 bank; 507 u8 i2c_address; 508 u8 *data; 509 }; 510 511 /** 512 * struct ethtool_module_power_mode_params - module power mode parameters 513 * @policy: The power mode policy enforced by the host for the plug-in module. 514 * @mode: The operational power mode of the plug-in module. Should be filled by 515 * device drivers on get operations. 516 */ 517 struct ethtool_module_power_mode_params { 518 enum ethtool_module_power_mode_policy policy; 519 enum ethtool_module_power_mode mode; 520 }; 521 522 /** 523 * struct ethtool_mm_state - 802.3 MAC merge layer state 524 * @verify_time: 525 * wait time between verification attempts in ms (according to clause 526 * 30.14.1.6 aMACMergeVerifyTime) 527 * @max_verify_time: 528 * maximum accepted value for the @verify_time variable in set requests 529 * @verify_status: 530 * state of the verification state machine of the MM layer (according to 531 * clause 30.14.1.2 aMACMergeStatusVerify) 532 * @tx_enabled: 533 * set if the MM layer is administratively enabled in the TX direction 534 * (according to clause 30.14.1.3 aMACMergeEnableTx) 535 * @tx_active: 536 * set if the MM layer is enabled in the TX direction, which makes FP 537 * possible (according to 30.14.1.5 aMACMergeStatusTx). This should be 538 * true if MM is enabled, and the verification status is either verified, 539 * or disabled. 540 * @pmac_enabled: 541 * set if the preemptible MAC is powered on and is able to receive 542 * preemptible packets and respond to verification frames. 543 * @verify_enabled: 544 * set if the Verify function of the MM layer (which sends SMD-V 545 * verification requests) is administratively enabled (regardless of 546 * whether it is currently in the ETHTOOL_MM_VERIFY_STATUS_DISABLED state 547 * or not), according to clause 30.14.1.4 aMACMergeVerifyDisableTx (but 548 * using positive rather than negative logic). The device should always 549 * respond to received SMD-V requests as long as @pmac_enabled is set. 550 * @tx_min_frag_size: 551 * the minimum size of non-final mPacket fragments that the link partner 552 * supports receiving, expressed in octets. Compared to the definition 553 * from clause 30.14.1.7 aMACMergeAddFragSize which is expressed in the 554 * range 0 to 3 (requiring a translation to the size in octets according 555 * to the formula 64 * (1 + addFragSize) - 4), a value in a continuous and 556 * unbounded range can be specified here. 557 * @rx_min_frag_size: 558 * the minimum size of non-final mPacket fragments that this device 559 * supports receiving, expressed in octets. 560 */ 561 struct ethtool_mm_state { 562 u32 verify_time; 563 u32 max_verify_time; 564 enum ethtool_mm_verify_status verify_status; 565 bool tx_enabled; 566 bool tx_active; 567 bool pmac_enabled; 568 bool verify_enabled; 569 u32 tx_min_frag_size; 570 u32 rx_min_frag_size; 571 }; 572 573 /** 574 * struct ethtool_mm_cfg - 802.3 MAC merge layer configuration 575 * @verify_time: see struct ethtool_mm_state 576 * @verify_enabled: see struct ethtool_mm_state 577 * @tx_enabled: see struct ethtool_mm_state 578 * @pmac_enabled: see struct ethtool_mm_state 579 * @tx_min_frag_size: see struct ethtool_mm_state 580 */ 581 struct ethtool_mm_cfg { 582 u32 verify_time; 583 bool verify_enabled; 584 bool tx_enabled; 585 bool pmac_enabled; 586 u32 tx_min_frag_size; 587 }; 588 589 /** 590 * struct ethtool_mm_stats - 802.3 MAC merge layer statistics 591 * @MACMergeFrameAssErrorCount: 592 * received MAC frames with reassembly errors 593 * @MACMergeFrameSmdErrorCount: 594 * received MAC frames/fragments rejected due to unknown or incorrect SMD 595 * @MACMergeFrameAssOkCount: 596 * received MAC frames that were successfully reassembled and passed up 597 * @MACMergeFragCountRx: 598 * number of additional correct SMD-C mPackets received due to preemption 599 * @MACMergeFragCountTx: 600 * number of additional mPackets sent due to preemption 601 * @MACMergeHoldCount: 602 * number of times the MM layer entered the HOLD state, which blocks 603 * transmission of preemptible traffic 604 */ 605 struct ethtool_mm_stats { 606 u64 MACMergeFrameAssErrorCount; 607 u64 MACMergeFrameSmdErrorCount; 608 u64 MACMergeFrameAssOkCount; 609 u64 MACMergeFragCountRx; 610 u64 MACMergeFragCountTx; 611 u64 MACMergeHoldCount; 612 }; 613 614 /** 615 * struct ethtool_rxfh_param - RXFH (RSS) parameters 616 * @hfunc: Defines the current RSS hash function used by HW (or to be set to). 617 * Valid values are one of the %ETH_RSS_HASH_*. 618 * @indir_size: On SET, the array size of the user buffer for the 619 * indirection table, which may be zero, or 620 * %ETH_RXFH_INDIR_NO_CHANGE. On GET (read from the driver), 621 * the array size of the hardware indirection table. 622 * @indir: The indirection table of size @indir_size entries. 623 * @key_size: On SET, the array size of the user buffer for the hash key, 624 * which may be zero. On GET (read from the driver), the size of the 625 * hardware hash key. 626 * @key: The hash key of size @key_size bytes. 627 * @rss_context: RSS context identifier. Context 0 is the default for normal 628 * traffic; other contexts can be referenced as the destination for RX flow 629 * classification rules. On SET, %ETH_RXFH_CONTEXT_ALLOC is used 630 * to allocate a new RSS context; on return this field will 631 * contain the ID of the newly allocated context. 632 * @rss_delete: Set to non-ZERO to remove the @rss_context context. 633 * @input_xfrm: Defines how the input data is transformed. Valid values are one 634 * of %RXH_XFRM_*. 635 */ 636 struct ethtool_rxfh_param { 637 u8 hfunc; 638 u32 indir_size; 639 u32 *indir; 640 u32 key_size; 641 u8 *key; 642 u32 rss_context; 643 u8 rss_delete; 644 u8 input_xfrm; 645 }; 646 647 /** 648 * struct ethtool_ops - optional netdev operations 649 * @cap_link_lanes_supported: indicates if the driver supports lanes 650 * parameter. 651 * @cap_rss_ctx_supported: indicates if the driver supports RSS 652 * contexts. 653 * @cap_rss_sym_xor_supported: indicates if the driver supports symmetric-xor 654 * RSS. 655 * @supported_coalesce_params: supported types of interrupt coalescing. 656 * @supported_ring_params: supported ring params. 657 * @get_drvinfo: Report driver/device information. Modern drivers no 658 * longer have to implement this callback. Most fields are 659 * correctly filled in by the core using system information, or 660 * populated using other driver operations. 661 * @get_regs_len: Get buffer length required for @get_regs 662 * @get_regs: Get device registers 663 * @get_wol: Report whether Wake-on-Lan is enabled 664 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code 665 * or zero. 666 * @get_msglevel: Report driver message level. This should be the value 667 * of the @msg_enable field used by netif logging functions. 668 * @set_msglevel: Set driver message level 669 * @nway_reset: Restart autonegotiation. Returns a negative error code 670 * or zero. 671 * @get_link: Report whether physical link is up. Will only be called if 672 * the netdev is up. Should usually be set to ethtool_op_get_link(), 673 * which uses netif_carrier_ok(). 674 * @get_link_ext_state: Report link extended state. Should set link_ext_state and 675 * link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown, 676 * do not attach ext_substate attribute to netlink message). If link_ext_state 677 * and link_ext_substate are unknown, return -ENODATA. If not implemented, 678 * link_ext_state and link_ext_substate will not be sent to userspace. 679 * @get_link_ext_stats: Read extra link-related counters. 680 * @get_eeprom_len: Read range of EEPROM addresses for validation of 681 * @get_eeprom and @set_eeprom requests. 682 * Returns 0 if device does not support EEPROM access. 683 * @get_eeprom: Read data from the device EEPROM. 684 * Should fill in the magic field. Don't need to check len for zero 685 * or wraparound. Fill in the data argument with the eeprom values 686 * from offset to offset + len. Update len to the amount read. 687 * Returns an error or zero. 688 * @set_eeprom: Write data to the device EEPROM. 689 * Should validate the magic field. Don't need to check len for zero 690 * or wraparound. Update len to the amount written. Returns an error 691 * or zero. 692 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative 693 * error code or zero. 694 * @set_coalesce: Set interrupt coalescing parameters. Supported coalescing 695 * types should be set in @supported_coalesce_params. 696 * Returns a negative error code or zero. 697 * @get_ringparam: Report ring sizes 698 * @set_ringparam: Set ring sizes. Returns a negative error code or zero. 699 * @get_pause_stats: Report pause frame statistics. Drivers must not zero 700 * statistics which they don't report. The stats structure is initialized 701 * to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics. 702 * @get_pauseparam: Report pause parameters 703 * @set_pauseparam: Set pause parameters. Returns a negative error code 704 * or zero. 705 * @self_test: Run specified self-tests 706 * @get_strings: Return a set of strings that describe the requested objects 707 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED 708 * attached to it. The implementation may update the indicator 709 * asynchronously or synchronously, but in either case it must return 710 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, 711 * and must either activate asynchronous updates and return zero, return 712 * a negative error or return a positive frequency for synchronous 713 * indication (e.g. 1 for one on/off cycle per second). If it returns 714 * a frequency then it will be called again at intervals with the 715 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of 716 * the indicator accordingly. Finally, it is called with the argument 717 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a 718 * negative error code or zero. 719 * @get_ethtool_stats: Return extended statistics about the device. 720 * This is only useful if the device maintains statistics not 721 * included in &struct rtnl_link_stats64. 722 * @begin: Function to be called before any other operation. Returns a 723 * negative error code or zero. 724 * @complete: Function to be called after any other operation except 725 * @begin. Will be called even if the other operation failed. 726 * @get_priv_flags: Report driver-specific feature flags. 727 * @set_priv_flags: Set driver-specific feature flags. Returns a negative 728 * error code or zero. 729 * @get_sset_count: Get number of strings that @get_strings will write. 730 * @get_rxnfc: Get RX flow classification rules. Returns a negative 731 * error code or zero. 732 * @set_rxnfc: Set RX flow classification rules. Returns a negative 733 * error code or zero. 734 * @flash_device: Write a firmware image to device's flash memory. 735 * Returns a negative error code or zero. 736 * @reset: Reset (part of) the device, as specified by a bitmask of 737 * flags from &enum ethtool_reset_flags. Returns a negative 738 * error code or zero. 739 * @get_rxfh_key_size: Get the size of the RX flow hash key. 740 * Returns zero if not supported for this specific device. 741 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. 742 * Returns zero if not supported for this specific device. 743 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key 744 * and/or hash function. 745 * Returns a negative error code or zero. 746 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash 747 * key, and/or hash function. Arguments which are set to %NULL or zero 748 * will remain unchanged. 749 * Returns a negative error code or zero. An error code must be returned 750 * if at least one unsupported change was requested. 751 * @get_channels: Get number of channels. 752 * @set_channels: Set number of channels. Returns a negative error code or 753 * zero. 754 * @get_dump_flag: Get dump flag indicating current dump length, version, 755 * and flag of the device. 756 * @get_dump_data: Get dump data. 757 * @set_dump: Set dump specific flags to the device. 758 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. 759 * It may be called with RCU, or rtnl or reference on the device. 760 * Drivers supporting transmit time stamps in software should set this to 761 * ethtool_op_get_ts_info(). 762 * @get_module_info: Get the size and type of the eeprom contained within 763 * a plug-in module. 764 * @get_module_eeprom: Get the eeprom information from the plug-in module 765 * @get_eee: Get Energy-Efficient (EEE) supported and status. 766 * @set_eee: Set EEE status (enable/disable) as well as LPI timers. 767 * @get_tunable: Read the value of a driver / device tunable. 768 * @set_tunable: Set the value of a driver / device tunable. 769 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue. 770 * It must check that the given queue number is valid. If neither a RX nor 771 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 772 * queue has this number, set the inapplicable fields to ~0 and return 0. 773 * Returns a negative error code or zero. 774 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue. 775 * It must check that the given queue number is valid. If neither a RX nor 776 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 777 * queue has this number, ignore the inapplicable fields. Supported 778 * coalescing types should be set in @supported_coalesce_params. 779 * Returns a negative error code or zero. 780 * @get_link_ksettings: Get various device settings including Ethernet link 781 * settings. The %cmd and %link_mode_masks_nwords fields should be 782 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), 783 * any change to them will be overwritten by kernel. Returns a negative 784 * error code or zero. 785 * @set_link_ksettings: Set various device settings including Ethernet link 786 * settings. The %cmd and %link_mode_masks_nwords fields should be 787 * ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), 788 * any change to them will be overwritten by kernel. Returns a negative 789 * error code or zero. 790 * @get_fec_stats: Report FEC statistics. 791 * Core will sum up per-lane stats to get the total. 792 * Drivers must not zero statistics which they don't report. The stats 793 * structure is initialized to ETHTOOL_STAT_NOT_SET indicating driver does 794 * not report statistics. 795 * @get_fecparam: Get the network device Forward Error Correction parameters. 796 * @set_fecparam: Set the network device Forward Error Correction parameters. 797 * @get_ethtool_phy_stats: Return extended statistics about the PHY device. 798 * This is only useful if the device maintains PHY statistics and 799 * cannot use the standard PHY library helpers. 800 * @get_phy_tunable: Read the value of a PHY tunable. 801 * @set_phy_tunable: Set the value of a PHY tunable. 802 * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from 803 * specified page. Returns a negative error code or the amount of bytes 804 * read. 805 * @get_eth_phy_stats: Query some of the IEEE 802.3 PHY statistics. 806 * @get_eth_mac_stats: Query some of the IEEE 802.3 MAC statistics. 807 * @get_eth_ctrl_stats: Query some of the IEEE 802.3 MAC Ctrl statistics. 808 * @get_rmon_stats: Query some of the RMON (RFC 2819) statistics. 809 * Set %ranges to a pointer to zero-terminated array of byte ranges. 810 * @get_module_power_mode: Get the power mode policy for the plug-in module 811 * used by the network device and its operational power mode, if 812 * plugged-in. 813 * @set_module_power_mode: Set the power mode policy for the plug-in module 814 * used by the network device. 815 * @get_mm: Query the 802.3 MAC Merge layer state. 816 * @set_mm: Set the 802.3 MAC Merge layer parameters. 817 * @get_mm_stats: Query the 802.3 MAC Merge layer statistics. 818 * 819 * All operations are optional (i.e. the function pointer may be set 820 * to %NULL) and callers must take this into account. Callers must 821 * hold the RTNL lock. 822 * 823 * See the structures used by these operations for further documentation. 824 * Note that for all operations using a structure ending with a zero- 825 * length array, the array is allocated separately in the kernel and 826 * is passed to the driver as an additional parameter. 827 * 828 * See &struct net_device and &struct net_device_ops for documentation 829 * of the generic netdev features interface. 830 */ 831 struct ethtool_ops { 832 u32 cap_link_lanes_supported:1; 833 u32 cap_rss_ctx_supported:1; 834 u32 cap_rss_sym_xor_supported:1; 835 u32 supported_coalesce_params; 836 u32 supported_ring_params; 837 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 838 int (*get_regs_len)(struct net_device *); 839 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 840 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 841 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 842 u32 (*get_msglevel)(struct net_device *); 843 void (*set_msglevel)(struct net_device *, u32); 844 int (*nway_reset)(struct net_device *); 845 u32 (*get_link)(struct net_device *); 846 int (*get_link_ext_state)(struct net_device *, 847 struct ethtool_link_ext_state_info *); 848 void (*get_link_ext_stats)(struct net_device *dev, 849 struct ethtool_link_ext_stats *stats); 850 int (*get_eeprom_len)(struct net_device *); 851 int (*get_eeprom)(struct net_device *, 852 struct ethtool_eeprom *, u8 *); 853 int (*set_eeprom)(struct net_device *, 854 struct ethtool_eeprom *, u8 *); 855 int (*get_coalesce)(struct net_device *, 856 struct ethtool_coalesce *, 857 struct kernel_ethtool_coalesce *, 858 struct netlink_ext_ack *); 859 int (*set_coalesce)(struct net_device *, 860 struct ethtool_coalesce *, 861 struct kernel_ethtool_coalesce *, 862 struct netlink_ext_ack *); 863 void (*get_ringparam)(struct net_device *, 864 struct ethtool_ringparam *, 865 struct kernel_ethtool_ringparam *, 866 struct netlink_ext_ack *); 867 int (*set_ringparam)(struct net_device *, 868 struct ethtool_ringparam *, 869 struct kernel_ethtool_ringparam *, 870 struct netlink_ext_ack *); 871 void (*get_pause_stats)(struct net_device *dev, 872 struct ethtool_pause_stats *pause_stats); 873 void (*get_pauseparam)(struct net_device *, 874 struct ethtool_pauseparam*); 875 int (*set_pauseparam)(struct net_device *, 876 struct ethtool_pauseparam*); 877 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 878 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 879 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); 880 void (*get_ethtool_stats)(struct net_device *, 881 struct ethtool_stats *, u64 *); 882 int (*begin)(struct net_device *); 883 void (*complete)(struct net_device *); 884 u32 (*get_priv_flags)(struct net_device *); 885 int (*set_priv_flags)(struct net_device *, u32); 886 int (*get_sset_count)(struct net_device *, int); 887 int (*get_rxnfc)(struct net_device *, 888 struct ethtool_rxnfc *, u32 *rule_locs); 889 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 890 int (*flash_device)(struct net_device *, struct ethtool_flash *); 891 int (*reset)(struct net_device *, u32 *); 892 u32 (*get_rxfh_key_size)(struct net_device *); 893 u32 (*get_rxfh_indir_size)(struct net_device *); 894 int (*get_rxfh)(struct net_device *, struct ethtool_rxfh_param *); 895 int (*set_rxfh)(struct net_device *, struct ethtool_rxfh_param *, 896 struct netlink_ext_ack *extack); 897 void (*get_channels)(struct net_device *, struct ethtool_channels *); 898 int (*set_channels)(struct net_device *, struct ethtool_channels *); 899 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); 900 int (*get_dump_data)(struct net_device *, 901 struct ethtool_dump *, void *); 902 int (*set_dump)(struct net_device *, struct ethtool_dump *); 903 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); 904 int (*get_module_info)(struct net_device *, 905 struct ethtool_modinfo *); 906 int (*get_module_eeprom)(struct net_device *, 907 struct ethtool_eeprom *, u8 *); 908 int (*get_eee)(struct net_device *dev, struct ethtool_keee *eee); 909 int (*set_eee)(struct net_device *dev, struct ethtool_keee *eee); 910 int (*get_tunable)(struct net_device *, 911 const struct ethtool_tunable *, void *); 912 int (*set_tunable)(struct net_device *, 913 const struct ethtool_tunable *, const void *); 914 int (*get_per_queue_coalesce)(struct net_device *, u32, 915 struct ethtool_coalesce *); 916 int (*set_per_queue_coalesce)(struct net_device *, u32, 917 struct ethtool_coalesce *); 918 int (*get_link_ksettings)(struct net_device *, 919 struct ethtool_link_ksettings *); 920 int (*set_link_ksettings)(struct net_device *, 921 const struct ethtool_link_ksettings *); 922 void (*get_fec_stats)(struct net_device *dev, 923 struct ethtool_fec_stats *fec_stats); 924 int (*get_fecparam)(struct net_device *, 925 struct ethtool_fecparam *); 926 int (*set_fecparam)(struct net_device *, 927 struct ethtool_fecparam *); 928 void (*get_ethtool_phy_stats)(struct net_device *, 929 struct ethtool_stats *, u64 *); 930 int (*get_phy_tunable)(struct net_device *, 931 const struct ethtool_tunable *, void *); 932 int (*set_phy_tunable)(struct net_device *, 933 const struct ethtool_tunable *, const void *); 934 int (*get_module_eeprom_by_page)(struct net_device *dev, 935 const struct ethtool_module_eeprom *page, 936 struct netlink_ext_ack *extack); 937 void (*get_eth_phy_stats)(struct net_device *dev, 938 struct ethtool_eth_phy_stats *phy_stats); 939 void (*get_eth_mac_stats)(struct net_device *dev, 940 struct ethtool_eth_mac_stats *mac_stats); 941 void (*get_eth_ctrl_stats)(struct net_device *dev, 942 struct ethtool_eth_ctrl_stats *ctrl_stats); 943 void (*get_rmon_stats)(struct net_device *dev, 944 struct ethtool_rmon_stats *rmon_stats, 945 const struct ethtool_rmon_hist_range **ranges); 946 int (*get_module_power_mode)(struct net_device *dev, 947 struct ethtool_module_power_mode_params *params, 948 struct netlink_ext_ack *extack); 949 int (*set_module_power_mode)(struct net_device *dev, 950 const struct ethtool_module_power_mode_params *params, 951 struct netlink_ext_ack *extack); 952 int (*get_mm)(struct net_device *dev, struct ethtool_mm_state *state); 953 int (*set_mm)(struct net_device *dev, struct ethtool_mm_cfg *cfg, 954 struct netlink_ext_ack *extack); 955 void (*get_mm_stats)(struct net_device *dev, struct ethtool_mm_stats *stats); 956 }; 957 958 int ethtool_check_ops(const struct ethtool_ops *ops); 959 960 struct ethtool_rx_flow_rule { 961 struct flow_rule *rule; 962 unsigned long priv[]; 963 }; 964 965 struct ethtool_rx_flow_spec_input { 966 const struct ethtool_rx_flow_spec *fs; 967 u32 rss_ctx; 968 }; 969 970 struct ethtool_rx_flow_rule * 971 ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input); 972 void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule); 973 974 bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd); 975 int ethtool_virtdev_set_link_ksettings(struct net_device *dev, 976 const struct ethtool_link_ksettings *cmd, 977 u32 *dev_speed, u8 *dev_duplex); 978 979 struct phy_device; 980 struct phy_tdr_config; 981 struct phy_plca_cfg; 982 struct phy_plca_status; 983 984 /** 985 * struct ethtool_phy_ops - Optional PHY device options 986 * @get_sset_count: Get number of strings that @get_strings will write. 987 * @get_strings: Return a set of strings that describe the requested objects 988 * @get_stats: Return extended statistics about the PHY device. 989 * @get_plca_cfg: Return PLCA configuration. 990 * @set_plca_cfg: Set PLCA configuration. 991 * @get_plca_status: Get PLCA configuration. 992 * @start_cable_test: Start a cable test 993 * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test 994 * 995 * All operations are optional (i.e. the function pointer may be set to %NULL) 996 * and callers must take this into account. Callers must hold the RTNL lock. 997 */ 998 struct ethtool_phy_ops { 999 int (*get_sset_count)(struct phy_device *dev); 1000 int (*get_strings)(struct phy_device *dev, u8 *data); 1001 int (*get_stats)(struct phy_device *dev, 1002 struct ethtool_stats *stats, u64 *data); 1003 int (*get_plca_cfg)(struct phy_device *dev, 1004 struct phy_plca_cfg *plca_cfg); 1005 int (*set_plca_cfg)(struct phy_device *dev, 1006 const struct phy_plca_cfg *plca_cfg, 1007 struct netlink_ext_ack *extack); 1008 int (*get_plca_status)(struct phy_device *dev, 1009 struct phy_plca_status *plca_st); 1010 int (*start_cable_test)(struct phy_device *phydev, 1011 struct netlink_ext_ack *extack); 1012 int (*start_cable_test_tdr)(struct phy_device *phydev, 1013 struct netlink_ext_ack *extack, 1014 const struct phy_tdr_config *config); 1015 }; 1016 1017 /** 1018 * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton 1019 * @ops: Ethtool PHY operations to set 1020 */ 1021 void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops); 1022 1023 /** 1024 * ethtool_params_from_link_mode - Derive link parameters from a given link mode 1025 * @link_ksettings: Link parameters to be derived from the link mode 1026 * @link_mode: Link mode 1027 */ 1028 void 1029 ethtool_params_from_link_mode(struct ethtool_link_ksettings *link_ksettings, 1030 enum ethtool_link_mode_bit_indices link_mode); 1031 1032 /** 1033 * ethtool_get_phc_vclocks - Derive phc vclocks information, and caller 1034 * is responsible to free memory of vclock_index 1035 * @dev: pointer to net_device structure 1036 * @vclock_index: pointer to pointer of vclock index 1037 * 1038 * Return number of phc vclocks 1039 */ 1040 int ethtool_get_phc_vclocks(struct net_device *dev, int **vclock_index); 1041 1042 /* Some generic methods drivers may use in their ethtool_ops */ 1043 u32 ethtool_op_get_link(struct net_device *dev); 1044 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti); 1045 1046 /** 1047 * ethtool_mm_frag_size_add_to_min - Translate (standard) additional fragment 1048 * size expressed as multiplier into (absolute) minimum fragment size 1049 * value expressed in octets 1050 * @val_add: Value of addFragSize multiplier 1051 */ 1052 static inline u32 ethtool_mm_frag_size_add_to_min(u32 val_add) 1053 { 1054 return (ETH_ZLEN + ETH_FCS_LEN) * (1 + val_add) - ETH_FCS_LEN; 1055 } 1056 1057 /** 1058 * ethtool_mm_frag_size_min_to_add - Translate (absolute) minimum fragment size 1059 * expressed in octets into (standard) additional fragment size expressed 1060 * as multiplier 1061 * @val_min: Value of addFragSize variable in octets 1062 * @val_add: Pointer where the standard addFragSize value is to be returned 1063 * @extack: Netlink extended ack 1064 * 1065 * Translate a value in octets to one of 0, 1, 2, 3 according to the reverse 1066 * application of the 802.3 formula 64 * (1 + addFragSize) - 4. To be called 1067 * by drivers which do not support programming the minimum fragment size to a 1068 * continuous range. Returns error on other fragment length values. 1069 */ 1070 static inline int ethtool_mm_frag_size_min_to_add(u32 val_min, u32 *val_add, 1071 struct netlink_ext_ack *extack) 1072 { 1073 u32 add_frag_size; 1074 1075 for (add_frag_size = 0; add_frag_size < 4; add_frag_size++) { 1076 if (ethtool_mm_frag_size_add_to_min(add_frag_size) == val_min) { 1077 *val_add = add_frag_size; 1078 return 0; 1079 } 1080 } 1081 1082 NL_SET_ERR_MSG_MOD(extack, 1083 "minFragSize required to be one of 60, 124, 188 or 252"); 1084 return -EINVAL; 1085 } 1086 1087 /** 1088 * ethtool_get_ts_info_by_layer - Obtains time stamping capabilities from the MAC or PHY layer. 1089 * @dev: pointer to net_device structure 1090 * @info: buffer to hold the result 1091 * Returns zero on success, non-zero otherwise. 1092 */ 1093 int ethtool_get_ts_info_by_layer(struct net_device *dev, struct ethtool_ts_info *info); 1094 1095 /** 1096 * ethtool_sprintf - Write formatted string to ethtool string data 1097 * @data: Pointer to a pointer to the start of string to update 1098 * @fmt: Format of string to write 1099 * 1100 * Write formatted string to *data. Update *data to point at start of 1101 * next string. 1102 */ 1103 extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...); 1104 1105 /** 1106 * ethtool_puts - Write string to ethtool string data 1107 * @data: Pointer to a pointer to the start of string to update 1108 * @str: String to write 1109 * 1110 * Write string to *data without a trailing newline. Update *data 1111 * to point at start of next string. 1112 * 1113 * Prefer this function to ethtool_sprintf() when given only 1114 * two arguments or if @fmt is just "%s". 1115 */ 1116 extern void ethtool_puts(u8 **data, const char *str); 1117 1118 /* Link mode to forced speed capabilities maps */ 1119 struct ethtool_forced_speed_map { 1120 u32 speed; 1121 __ETHTOOL_DECLARE_LINK_MODE_MASK(caps); 1122 1123 const u32 *cap_arr; 1124 u32 arr_size; 1125 }; 1126 1127 #define ETHTOOL_FORCED_SPEED_MAP(prefix, value) \ 1128 { \ 1129 .speed = SPEED_##value, \ 1130 .cap_arr = prefix##_##value, \ 1131 .arr_size = ARRAY_SIZE(prefix##_##value), \ 1132 } 1133 1134 void 1135 ethtool_forced_speed_maps_init(struct ethtool_forced_speed_map *maps, u32 size); 1136 #endif /* _LINUX_ETHTOOL_H */ 1137