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