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