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