include/linux/ethtool.h

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