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