include/linux/ethtool.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * ethtool.h: Defines for Linux ethtool.
   4  *
   5  * Copyright (C) 1998 David S. Miller (davem@redhat.com)
   6  * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
   7  * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
   8  * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
   9  *                                christopher.leech@intel.com,
  10  *                                scott.feldman@intel.com)
  11  * Portions Copyright (C) Sun Microsystems 2008
  12  */
  13 #ifndef _LINUX_ETHTOOL_H
  14 #define _LINUX_ETHTOOL_H
  15
  16 #include <linux/bitmap.h>
  17 #include <linux/compat.h>
  18 #include <uapi/linux/ethtool.h>
  19
  20 struct compat_ethtool_rx_flow_spec {
  21         u32             flow_type;
  22         union ethtool_flow_union h_u;
  23         struct ethtool_flow_ext h_ext;
  24         union ethtool_flow_union m_u;
  25         struct ethtool_flow_ext m_ext;
  26         compat_u64      ring_cookie;
  27         u32             location;
  28 };
  29
  30 struct compat_ethtool_rxnfc {
  31         u32                             cmd;
  32         u32                             flow_type;
  33         compat_u64                      data;
  34         struct compat_ethtool_rx_flow_spec fs;
  35         u32                             rule_cnt;
  36         u32                             rule_locs[];
  37 };
  38
  39 #include <linux/rculist.h>
  40
  41 /**
  42  * enum ethtool_phys_id_state - indicator state for physical identification
  43  * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
  44  * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
  45  * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
  46  *      is not supported)
  47  * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
  48  *      is not supported)
  49  */
  50 enum ethtool_phys_id_state {
  51         ETHTOOL_ID_INACTIVE,
  52         ETHTOOL_ID_ACTIVE,
  53         ETHTOOL_ID_ON,
  54         ETHTOOL_ID_OFF
  55 };
  56
  57 enum {
  58         ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
  59         ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
  60         ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */
  61
  62         /*
  63          * Add your fresh new hash function bits above and remember to update
  64          * rss_hash_func_strings[] in ethtool.c
  65          */
  66         ETH_RSS_HASH_FUNCS_COUNT
  67 };
  68
  69 #define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit))
  70 #define __ETH_RSS_HASH(name)    __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
  71
  72 #define ETH_RSS_HASH_TOP        __ETH_RSS_HASH(TOP)
  73 #define ETH_RSS_HASH_XOR        __ETH_RSS_HASH(XOR)
  74 #define ETH_RSS_HASH_CRC32      __ETH_RSS_HASH(CRC32)
  75
  76 #define ETH_RSS_HASH_UNKNOWN    0
  77 #define ETH_RSS_HASH_NO_CHANGE  0
  78
  79 struct net_device;
  80
  81 /* Some generic methods drivers may use in their ethtool_ops */
  82 u32 ethtool_op_get_link(struct net_device *dev);
  83 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
  84
  85
  86 /**
  87  * struct ethtool_link_ext_state_info - link extended state and substate.
  88  */
  89 struct ethtool_link_ext_state_info {
  90         enum ethtool_link_ext_state link_ext_state;
  91         union {
  92                 enum ethtool_link_ext_substate_autoneg autoneg;
  93                 enum ethtool_link_ext_substate_link_training link_training;
  94                 enum ethtool_link_ext_substate_link_logical_mismatch link_logical_mismatch;
  95                 enum ethtool_link_ext_substate_bad_signal_integrity bad_signal_integrity;
  96                 enum ethtool_link_ext_substate_cable_issue cable_issue;
  97                 u8 __link_ext_substate;
  98         };
  99 };
 100
 101 /**
 102  * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
 103  * @index: Index in RX flow hash indirection table
 104  * @n_rx_rings: Number of RX rings to use
 105  *
 106  * This function provides the default policy for RX flow hash indirection.
 107  */
 108 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
 109 {
 110         return index % n_rx_rings;
 111 }
 112
 113 /* declare a link mode bitmap */
 114 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name)          \
 115         DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS)
 116
 117 /* drivers must ignore base.cmd and base.link_mode_masks_nwords
 118  * fields, but they are allowed to overwrite them (will be ignored).
 119  */
 120 struct ethtool_link_ksettings {
 121         struct ethtool_link_settings base;
 122         struct {
 123                 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 124                 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 125                 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
 126         } link_modes;
 127 };
 128
 129 /**
 130  * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
 131  *   @ptr : pointer to struct ethtool_link_ksettings
 132  *   @name : one of supported/advertising/lp_advertising
 133  */
 134 #define ethtool_link_ksettings_zero_link_mode(ptr, name)                \
 135         bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
 136
 137 /**
 138  * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
 139  * link mode mask
 140  *   @ptr : pointer to struct ethtool_link_ksettings
 141  *   @name : one of supported/advertising/lp_advertising
 142  *   @mode : one of the ETHTOOL_LINK_MODE_*_BIT
 143  * (not atomic, no bound checking)
 144  */
 145 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode)           \
 146         __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
 147
 148 /**
 149  * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
 150  * link mode mask
 151  *   @ptr : pointer to struct ethtool_link_ksettings
 152  *   @name : one of supported/advertising/lp_advertising
 153  *   @mode : one of the ETHTOOL_LINK_MODE_*_BIT
 154  * (not atomic, no bound checking)
 155  */
 156 #define ethtool_link_ksettings_del_link_mode(ptr, name, mode)           \
 157         __clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
 158
 159 /**
 160  * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask
 161  *   @ptr : pointer to struct ethtool_link_ksettings
 162  *   @name : one of supported/advertising/lp_advertising
 163  *   @mode : one of the ETHTOOL_LINK_MODE_*_BIT
 164  * (not atomic, no bound checking)
 165  *
 166  * Returns true/false.
 167  */
 168 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode)          \
 169         test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
 170
 171 extern int
 172 __ethtool_get_link_ksettings(struct net_device *dev,
 173                              struct ethtool_link_ksettings *link_ksettings);
 174
 175 /**
 176  * ethtool_intersect_link_masks - Given two link masks, AND them together
 177  * @dst: first mask and where result is stored
 178  * @src: second mask to intersect with
 179  *
 180  * Given two link mode masks, AND them together and save the result in dst.
 181  */
 182 void ethtool_intersect_link_masks(struct ethtool_link_ksettings *dst,
 183                                   struct ethtool_link_ksettings *src);
 184
 185 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst,
 186                                              u32 legacy_u32);
 187
 188 /* return false if src had higher bits set. lower bits always updated. */
 189 bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
 190                                      const unsigned long *src);
 191
 192 #define ETHTOOL_COALESCE_RX_USECS               BIT(0)
 193 #define ETHTOOL_COALESCE_RX_MAX_FRAMES          BIT(1)
 194 #define ETHTOOL_COALESCE_RX_USECS_IRQ           BIT(2)
 195 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ      BIT(3)
 196 #define ETHTOOL_COALESCE_TX_USECS               BIT(4)
 197 #define ETHTOOL_COALESCE_TX_MAX_FRAMES          BIT(5)
 198 #define ETHTOOL_COALESCE_TX_USECS_IRQ           BIT(6)
 199 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ      BIT(7)
 200 #define ETHTOOL_COALESCE_STATS_BLOCK_USECS      BIT(8)
 201 #define ETHTOOL_COALESCE_USE_ADAPTIVE_RX        BIT(9)
 202 #define ETHTOOL_COALESCE_USE_ADAPTIVE_TX        BIT(10)
 203 #define ETHTOOL_COALESCE_PKT_RATE_LOW           BIT(11)
 204 #define ETHTOOL_COALESCE_RX_USECS_LOW           BIT(12)
 205 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW      BIT(13)
 206 #define ETHTOOL_COALESCE_TX_USECS_LOW           BIT(14)
 207 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW      BIT(15)
 208 #define ETHTOOL_COALESCE_PKT_RATE_HIGH          BIT(16)
 209 #define ETHTOOL_COALESCE_RX_USECS_HIGH          BIT(17)
 210 #define ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH     BIT(18)
 211 #define ETHTOOL_COALESCE_TX_USECS_HIGH          BIT(19)
 212 #define ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH     BIT(20)
 213 #define ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL   BIT(21)
 214
 215 #define ETHTOOL_COALESCE_USECS                                          \
 216         (ETHTOOL_COALESCE_RX_USECS | ETHTOOL_COALESCE_TX_USECS)
 217 #define ETHTOOL_COALESCE_MAX_FRAMES                                     \
 218         (ETHTOOL_COALESCE_RX_MAX_FRAMES | ETHTOOL_COALESCE_TX_MAX_FRAMES)
 219 #define ETHTOOL_COALESCE_USECS_IRQ                                      \
 220         (ETHTOOL_COALESCE_RX_USECS_IRQ | ETHTOOL_COALESCE_TX_USECS_IRQ)
 221 #define ETHTOOL_COALESCE_MAX_FRAMES_IRQ         \
 222         (ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ |   \
 223          ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ)
 224 #define ETHTOOL_COALESCE_USE_ADAPTIVE                                   \
 225         (ETHTOOL_COALESCE_USE_ADAPTIVE_RX | ETHTOOL_COALESCE_USE_ADAPTIVE_TX)
 226 #define ETHTOOL_COALESCE_USECS_LOW_HIGH                                 \
 227         (ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_TX_USECS_LOW | \
 228          ETHTOOL_COALESCE_RX_USECS_HIGH | ETHTOOL_COALESCE_TX_USECS_HIGH)
 229 #define ETHTOOL_COALESCE_MAX_FRAMES_LOW_HIGH    \
 230         (ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW |   \
 231          ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW |   \
 232          ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH |  \
 233          ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH)
 234 #define ETHTOOL_COALESCE_PKT_RATE_RX_USECS                              \
 235         (ETHTOOL_COALESCE_USE_ADAPTIVE_RX |                             \
 236          ETHTOOL_COALESCE_RX_USECS_LOW | ETHTOOL_COALESCE_RX_USECS_HIGH | \
 237          ETHTOOL_COALESCE_PKT_RATE_LOW | ETHTOOL_COALESCE_PKT_RATE_HIGH | \
 238          ETHTOOL_COALESCE_RATE_SAMPLE_INTERVAL)
 239
 240 #define ETHTOOL_STAT_NOT_SET    (~0ULL)
 241
 242 /**
 243  * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
 244  * @tx_pause_frames: transmitted pause frame count. Reported to user space
 245  *      as %ETHTOOL_A_PAUSE_STAT_TX_FRAMES.
 246  *
 247  *      Equivalent to `30.3.4.2 aPAUSEMACCtrlFramesTransmitted`
 248  *      from the standard.
 249  *
 250  * @rx_pause_frames: received pause frame count. Reported to user space
 251  *      as %ETHTOOL_A_PAUSE_STAT_RX_FRAMES. Equivalent to:
 252  *
 253  *      Equivalent to `30.3.4.3 aPAUSEMACCtrlFramesReceived`
 254  *      from the standard.
 255  */
 256 struct ethtool_pause_stats {
 257         u64 tx_pause_frames;
 258         u64 rx_pause_frames;
 259 };
 260
 261 /**
 262  * struct ethtool_ops - optional netdev operations
 263  * @supported_coalesce_params: supported types of interrupt coalescing.
 264  * @get_drvinfo: Report driver/device information.  Should only set the
 265  *      @driver, @version, @fw_version and @bus_info fields.  If not
 266  *      implemented, the @driver and @bus_info fields will be filled in
 267  *      according to the netdev's parent device.
 268  * @get_regs_len: Get buffer length required for @get_regs
 269  * @get_regs: Get device registers
 270  * @get_wol: Report whether Wake-on-Lan is enabled
 271  * @set_wol: Turn Wake-on-Lan on or off.  Returns a negative error code
 272  *      or zero.
 273  * @get_msglevel: Report driver message level.  This should be the value
 274  *      of the @msg_enable field used by netif logging functions.
 275  * @set_msglevel: Set driver message level
 276  * @nway_reset: Restart autonegotiation.  Returns a negative error code
 277  *      or zero.
 278  * @get_link: Report whether physical link is up.  Will only be called if
 279  *      the netdev is up.  Should usually be set to ethtool_op_get_link(),
 280  *      which uses netif_carrier_ok().
 281  * @get_link_ext_state: Report link extended state. Should set link_ext_state and
 282  *      link_ext_substate (link_ext_substate of 0 means link_ext_substate is unknown,
 283  *      do not attach ext_substate attribute to netlink message). If link_ext_state
 284  *      and link_ext_substate are unknown, return -ENODATA. If not implemented,
 285  *      link_ext_state and link_ext_substate will not be sent to userspace.
 286  * @get_eeprom: Read data from the device EEPROM.
 287  *      Should fill in the magic field.  Don't need to check len for zero
 288  *      or wraparound.  Fill in the data argument with the eeprom values
 289  *      from offset to offset + len.  Update len to the amount read.
 290  *      Returns an error or zero.
 291  * @set_eeprom: Write data to the device EEPROM.
 292  *      Should validate the magic field.  Don't need to check len for zero
 293  *      or wraparound.  Update len to the amount written.  Returns an error
 294  *      or zero.
 295  * @get_coalesce: Get interrupt coalescing parameters.  Returns a negative
 296  *      error code or zero.
 297  * @set_coalesce: Set interrupt coalescing parameters.  Supported coalescing
 298  *      types should be set in @supported_coalesce_params.
 299  *      Returns a negative error code or zero.
 300  * @get_ringparam: Report ring sizes
 301  * @set_ringparam: Set ring sizes.  Returns a negative error code or zero.
 302  * @get_pause_stats: Report pause frame statistics. Drivers must not zero
 303  *      statistics which they don't report. The stats structure is initialized
 304  *      to ETHTOOL_STAT_NOT_SET indicating driver does not report statistics.
 305  * @get_pauseparam: Report pause parameters
 306  * @set_pauseparam: Set pause parameters.  Returns a negative error code
 307  *      or zero.
 308  * @self_test: Run specified self-tests
 309  * @get_strings: Return a set of strings that describe the requested objects
 310  * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
 311  *      attached to it.  The implementation may update the indicator
 312  *      asynchronously or synchronously, but in either case it must return
 313  *      quickly.  It is initially called with the argument %ETHTOOL_ID_ACTIVE,
 314  *      and must either activate asynchronous updates and return zero, return
 315  *      a negative error or return a positive frequency for synchronous
 316  *      indication (e.g. 1 for one on/off cycle per second).  If it returns
 317  *      a frequency then it will be called again at intervals with the
 318  *      argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
 319  *      the indicator accordingly.  Finally, it is called with the argument
 320  *      %ETHTOOL_ID_INACTIVE and must deactivate the indicator.  Returns a
 321  *      negative error code or zero.
 322  * @get_ethtool_stats: Return extended statistics about the device.
 323  *      This is only useful if the device maintains statistics not
 324  *      included in &struct rtnl_link_stats64.
 325  * @begin: Function to be called before any other operation.  Returns a
 326  *      negative error code or zero.
 327  * @complete: Function to be called after any other operation except
 328  *      @begin.  Will be called even if the other operation failed.
 329  * @get_priv_flags: Report driver-specific feature flags.
 330  * @set_priv_flags: Set driver-specific feature flags.  Returns a negative
 331  *      error code or zero.
 332  * @get_sset_count: Get number of strings that @get_strings will write.
 333  * @get_rxnfc: Get RX flow classification rules.  Returns a negative
 334  *      error code or zero.
 335  * @set_rxnfc: Set RX flow classification rules.  Returns a negative
 336  *      error code or zero.
 337  * @flash_device: Write a firmware image to device's flash memory.
 338  *      Returns a negative error code or zero.
 339  * @reset: Reset (part of) the device, as specified by a bitmask of
 340  *      flags from &enum ethtool_reset_flags.  Returns a negative
 341  *      error code or zero.
 342  * @get_rxfh_key_size: Get the size of the RX flow hash key.
 343  *      Returns zero if not supported for this specific device.
 344  * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
 345  *      Returns zero if not supported for this specific device.
 346  * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
 347  *      and/or hash function.
 348  *      Returns a negative error code or zero.
 349  * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
 350  *      key, and/or hash function.  Arguments which are set to %NULL or zero
 351  *      will remain unchanged.
 352  *      Returns a negative error code or zero. An error code must be returned
 353  *      if at least one unsupported change was requested.
 354  * @get_rxfh_context: Get the contents of the RX flow hash indirection table,
 355  *      hash key, and/or hash function assiciated to the given rss context.
 356  *      Returns a negative error code or zero.
 357  * @set_rxfh_context: Create, remove and configure RSS contexts. Allows setting
 358  *      the contents of the RX flow hash indirection table, hash key, and/or
 359  *      hash function associated to the given context. Arguments which are set
 360  *      to %NULL or zero will remain unchanged.
 361  *      Returns a negative error code or zero. An error code must be returned
 362  *      if at least one unsupported change was requested.
 363  * @get_channels: Get number of channels.
 364  * @set_channels: Set number of channels.  Returns a negative error code or
 365  *      zero.
 366  * @get_dump_flag: Get dump flag indicating current dump length, version,
 367  *                 and flag of the device.
 368  * @get_dump_data: Get dump data.
 369  * @set_dump: Set dump specific flags to the device.
 370  * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
 371  *      Drivers supporting transmit time stamps in software should set this to
 372  *      ethtool_op_get_ts_info().
 373  * @get_module_info: Get the size and type of the eeprom contained within
 374  *      a plug-in module.
 375  * @get_module_eeprom: Get the eeprom information from the plug-in module
 376  * @get_eee: Get Energy-Efficient (EEE) supported and status.
 377  * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
 378  * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
 379  *      It must check that the given queue number is valid. If neither a RX nor
 380  *      a TX queue has this number, return -EINVAL. If only a RX queue or a TX
 381  *      queue has this number, set the inapplicable fields to ~0 and return 0.
 382  *      Returns a negative error code or zero.
 383  * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue.
 384  *      It must check that the given queue number is valid. If neither a RX nor
 385  *      a TX queue has this number, return -EINVAL. If only a RX queue or a TX
 386  *      queue has this number, ignore the inapplicable fields. Supported
 387  *      coalescing types should be set in @supported_coalesce_params.
 388  *      Returns a negative error code or zero.
 389  * @get_link_ksettings: Get various device settings including Ethernet link
 390  *      settings. The %cmd and %link_mode_masks_nwords fields should be
 391  *      ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
 392  *      any change to them will be overwritten by kernel. Returns a negative
 393  *      error code or zero.
 394  * @set_link_ksettings: Set various device settings including Ethernet link
 395  *      settings. The %cmd and %link_mode_masks_nwords fields should be
 396  *      ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter),
 397  *      any change to them will be overwritten by kernel. Returns a negative
 398  *      error code or zero.
 399  * @get_fecparam: Get the network device Forward Error Correction parameters.
 400  * @set_fecparam: Set the network device Forward Error Correction parameters.
 401  * @get_ethtool_phy_stats: Return extended statistics about the PHY device.
 402  *      This is only useful if the device maintains PHY statistics and
 403  *      cannot use the standard PHY library helpers.
 404  *
 405  * All operations are optional (i.e. the function pointer may be set
 406  * to %NULL) and callers must take this into account.  Callers must
 407  * hold the RTNL lock.
 408  *
 409  * See the structures used by these operations for further documentation.
 410  * Note that for all operations using a structure ending with a zero-
 411  * length array, the array is allocated separately in the kernel and
 412  * is passed to the driver as an additional parameter.
 413  *
 414  * See &struct net_device and &struct net_device_ops for documentation
 415  * of the generic netdev features interface.
 416  */
 417 struct ethtool_ops {
 418         u32     supported_coalesce_params;
 419         void    (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
 420         int     (*get_regs_len)(struct net_device *);
 421         void    (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
 422         void    (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
 423         int     (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
 424         u32     (*get_msglevel)(struct net_device *);
 425         void    (*set_msglevel)(struct net_device *, u32);
 426         int     (*nway_reset)(struct net_device *);
 427         u32     (*get_link)(struct net_device *);
 428         int     (*get_link_ext_state)(struct net_device *,
 429                                       struct ethtool_link_ext_state_info *);
 430         int     (*get_eeprom_len)(struct net_device *);
 431         int     (*get_eeprom)(struct net_device *,
 432                               struct ethtool_eeprom *, u8 *);
 433         int     (*set_eeprom)(struct net_device *,
 434                               struct ethtool_eeprom *, u8 *);
 435         int     (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
 436         int     (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
 437         void    (*get_ringparam)(struct net_device *,
 438                                  struct ethtool_ringparam *);
 439         int     (*set_ringparam)(struct net_device *,
 440                                  struct ethtool_ringparam *);
 441         void    (*get_pause_stats)(struct net_device *dev,
 442                                    struct ethtool_pause_stats *pause_stats);
 443         void    (*get_pauseparam)(struct net_device *,
 444                                   struct ethtool_pauseparam*);
 445         int     (*set_pauseparam)(struct net_device *,
 446                                   struct ethtool_pauseparam*);
 447         void    (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
 448         void    (*get_strings)(struct net_device *, u32 stringset, u8 *);
 449         int     (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
 450         void    (*get_ethtool_stats)(struct net_device *,
 451                                      struct ethtool_stats *, u64 *);
 452         int     (*begin)(struct net_device *);
 453         void    (*complete)(struct net_device *);
 454         u32     (*get_priv_flags)(struct net_device *);
 455         int     (*set_priv_flags)(struct net_device *, u32);
 456         int     (*get_sset_count)(struct net_device *, int);
 457         int     (*get_rxnfc)(struct net_device *,
 458                              struct ethtool_rxnfc *, u32 *rule_locs);
 459         int     (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
 460         int     (*flash_device)(struct net_device *, struct ethtool_flash *);
 461         int     (*reset)(struct net_device *, u32 *);
 462         u32     (*get_rxfh_key_size)(struct net_device *);
 463         u32     (*get_rxfh_indir_size)(struct net_device *);
 464         int     (*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
 465                             u8 *hfunc);
 466         int     (*set_rxfh)(struct net_device *, const u32 *indir,
 467                             const u8 *key, const u8 hfunc);
 468         int     (*get_rxfh_context)(struct net_device *, u32 *indir, u8 *key,
 469                                     u8 *hfunc, u32 rss_context);
 470         int     (*set_rxfh_context)(struct net_device *, const u32 *indir,
 471                                     const u8 *key, const u8 hfunc,
 472                                     u32 *rss_context, bool delete);
 473         void    (*get_channels)(struct net_device *, struct ethtool_channels *);
 474         int     (*set_channels)(struct net_device *, struct ethtool_channels *);
 475         int     (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
 476         int     (*get_dump_data)(struct net_device *,
 477                                  struct ethtool_dump *, void *);
 478         int     (*set_dump)(struct net_device *, struct ethtool_dump *);
 479         int     (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
 480         int     (*get_module_info)(struct net_device *,
 481                                    struct ethtool_modinfo *);
 482         int     (*get_module_eeprom)(struct net_device *,
 483                                      struct ethtool_eeprom *, u8 *);
 484         int     (*get_eee)(struct net_device *, struct ethtool_eee *);
 485         int     (*set_eee)(struct net_device *, struct ethtool_eee *);
 486         int     (*get_tunable)(struct net_device *,
 487                                const struct ethtool_tunable *, void *);
 488         int     (*set_tunable)(struct net_device *,
 489                                const struct ethtool_tunable *, const void *);
 490         int     (*get_per_queue_coalesce)(struct net_device *, u32,
 491                                           struct ethtool_coalesce *);
 492         int     (*set_per_queue_coalesce)(struct net_device *, u32,
 493                                           struct ethtool_coalesce *);
 494         int     (*get_link_ksettings)(struct net_device *,
 495                                       struct ethtool_link_ksettings *);
 496         int     (*set_link_ksettings)(struct net_device *,
 497                                       const struct ethtool_link_ksettings *);
 498         int     (*get_fecparam)(struct net_device *,
 499                                       struct ethtool_fecparam *);
 500         int     (*set_fecparam)(struct net_device *,
 501                                       struct ethtool_fecparam *);
 502         void    (*get_ethtool_phy_stats)(struct net_device *,
 503                                          struct ethtool_stats *, u64 *);
 504         int     (*get_phy_tunable)(struct net_device *,
 505                                    const struct ethtool_tunable *, void *);
 506         int     (*set_phy_tunable)(struct net_device *,
 507                                    const struct ethtool_tunable *, const void *);
 508 };
 509
 510 int ethtool_check_ops(const struct ethtool_ops *ops);
 511
 512 struct ethtool_rx_flow_rule {
 513         struct flow_rule        *rule;
 514         unsigned long           priv[];
 515 };
 516
 517 struct ethtool_rx_flow_spec_input {
 518         const struct ethtool_rx_flow_spec       *fs;
 519         u32                                     rss_ctx;
 520 };
 521
 522 struct ethtool_rx_flow_rule *
 523 ethtool_rx_flow_rule_create(const struct ethtool_rx_flow_spec_input *input);
 524 void ethtool_rx_flow_rule_destroy(struct ethtool_rx_flow_rule *rule);
 525
 526 bool ethtool_virtdev_validate_cmd(const struct ethtool_link_ksettings *cmd);
 527 int ethtool_virtdev_set_link_ksettings(struct net_device *dev,
 528                                        const struct ethtool_link_ksettings *cmd,
 529                                        u32 *dev_speed, u8 *dev_duplex);
 530
 531 struct netlink_ext_ack;
 532 struct phy_device;
 533 struct phy_tdr_config;
 534
 535 /**
 536  * struct ethtool_phy_ops - Optional PHY device options
 537  * @get_sset_count: Get number of strings that @get_strings will write.
 538  * @get_strings: Return a set of strings that describe the requested objects
 539  * @get_stats: Return extended statistics about the PHY device.
 540  * @start_cable_test - Start a cable test
 541  * @start_cable_test_tdr - Start a Time Domain Reflectometry cable test
 542  *
 543  * All operations are optional (i.e. the function pointer may be set to %NULL)
 544  * and callers must take this into account. Callers must hold the RTNL lock.
 545  */
 546 struct ethtool_phy_ops {
 547         int (*get_sset_count)(struct phy_device *dev);
 548         int (*get_strings)(struct phy_device *dev, u8 *data);
 549         int (*get_stats)(struct phy_device *dev,
 550                          struct ethtool_stats *stats, u64 *data);
 551         int (*start_cable_test)(struct phy_device *phydev,
 552                                 struct netlink_ext_ack *extack);
 553         int (*start_cable_test_tdr)(struct phy_device *phydev,
 554                                     struct netlink_ext_ack *extack,
 555                                     const struct phy_tdr_config *config);
 556 };
 557
 558 /**
 559  * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
 560  * @ops: Ethtool PHY operations to set
 561  */
 562 void ethtool_set_ethtool_phy_ops(const struct ethtool_phy_ops *ops);
 563
 564 #endif /* _LINUX_ETHTOOL_H */