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