linux/include/linux/ethtool.h
<<
>>
Prefs
   1/*
   2 * ethtool.h: Defines for Linux ethtool.
   3 *
   4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
   5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
   6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
   7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
   8 *                                christopher.leech@intel.com,
   9 *                                scott.feldman@intel.com)
  10 * Portions Copyright (C) Sun Microsystems 2008
  11 */
  12#ifndef _LINUX_ETHTOOL_H
  13#define _LINUX_ETHTOOL_H
  14
  15#include <linux/compat.h>
  16#include <uapi/linux/ethtool.h>
  17
  18#ifdef CONFIG_COMPAT
  19
  20struct 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
  30struct 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[0];
  37};
  38
  39#endif /* CONFIG_COMPAT */
  40
  41#include <linux/rculist.h>
  42
  43extern int __ethtool_get_settings(struct net_device *dev,
  44                                  struct ethtool_cmd *cmd);
  45
  46/**
  47 * enum ethtool_phys_id_state - indicator state for physical identification
  48 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated
  49 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated
  50 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE
  51 *      is not supported)
  52 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE
  53 *      is not supported)
  54 */
  55enum ethtool_phys_id_state {
  56        ETHTOOL_ID_INACTIVE,
  57        ETHTOOL_ID_ACTIVE,
  58        ETHTOOL_ID_ON,
  59        ETHTOOL_ID_OFF
  60};
  61
  62struct net_device;
  63
  64/* Some generic methods drivers may use in their ethtool_ops */
  65u32 ethtool_op_get_link(struct net_device *dev);
  66int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
  67
  68/**
  69 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
  70 * @index: Index in RX flow hash indirection table
  71 * @n_rx_rings: Number of RX rings to use
  72 *
  73 * This function provides the default policy for RX flow hash indirection.
  74 */
  75static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
  76{
  77        return index % n_rx_rings;
  78}
  79
  80/**
  81 * struct ethtool_ops - optional netdev operations
  82 * @get_settings: Get various device settings including Ethernet link
  83 *      settings. The @cmd parameter is expected to have been cleared
  84 *      before get_settings is called. Returns a negative error code or
  85 *      zero.
  86 * @set_settings: Set various device settings including Ethernet link
  87 *      settings.  Returns a negative error code or zero.
  88 * @get_drvinfo: Report driver/device information.  Should only set the
  89 *      @driver, @version, @fw_version and @bus_info fields.  If not
  90 *      implemented, the @driver and @bus_info fields will be filled in
  91 *      according to the netdev's parent device.
  92 * @get_regs_len: Get buffer length required for @get_regs
  93 * @get_regs: Get device registers
  94 * @get_wol: Report whether Wake-on-Lan is enabled
  95 * @set_wol: Turn Wake-on-Lan on or off.  Returns a negative error code
  96 *      or zero.
  97 * @get_msglevel: Report driver message level.  This should be the value
  98 *      of the @msg_enable field used by netif logging functions.
  99 * @set_msglevel: Set driver message level
 100 * @nway_reset: Restart autonegotiation.  Returns a negative error code
 101 *      or zero.
 102 * @get_link: Report whether physical link is up.  Will only be called if
 103 *      the netdev is up.  Should usually be set to ethtool_op_get_link(),
 104 *      which uses netif_carrier_ok().
 105 * @get_eeprom: Read data from the device EEPROM.
 106 *      Should fill in the magic field.  Don't need to check len for zero
 107 *      or wraparound.  Fill in the data argument with the eeprom values
 108 *      from offset to offset + len.  Update len to the amount read.
 109 *      Returns an error or zero.
 110 * @set_eeprom: Write data to the device EEPROM.
 111 *      Should validate the magic field.  Don't need to check len for zero
 112 *      or wraparound.  Update len to the amount written.  Returns an error
 113 *      or zero.
 114 * @get_coalesce: Get interrupt coalescing parameters.  Returns a negative
 115 *      error code or zero.
 116 * @set_coalesce: Set interrupt coalescing parameters.  Returns a negative
 117 *      error code or zero.
 118 * @get_ringparam: Report ring sizes
 119 * @set_ringparam: Set ring sizes.  Returns a negative error code or zero.
 120 * @get_pauseparam: Report pause parameters
 121 * @set_pauseparam: Set pause parameters.  Returns a negative error code
 122 *      or zero.
 123 * @self_test: Run specified self-tests
 124 * @get_strings: Return a set of strings that describe the requested objects
 125 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
 126 *      attached to it.  The implementation may update the indicator
 127 *      asynchronously or synchronously, but in either case it must return
 128 *      quickly.  It is initially called with the argument %ETHTOOL_ID_ACTIVE,
 129 *      and must either activate asynchronous updates and return zero, return
 130 *      a negative error or return a positive frequency for synchronous
 131 *      indication (e.g. 1 for one on/off cycle per second).  If it returns
 132 *      a frequency then it will be called again at intervals with the
 133 *      argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
 134 *      the indicator accordingly.  Finally, it is called with the argument
 135 *      %ETHTOOL_ID_INACTIVE and must deactivate the indicator.  Returns a
 136 *      negative error code or zero.
 137 * @get_ethtool_stats: Return extended statistics about the device.
 138 *      This is only useful if the device maintains statistics not
 139 *      included in &struct rtnl_link_stats64.
 140 * @begin: Function to be called before any other operation.  Returns a
 141 *      negative error code or zero.
 142 * @complete: Function to be called after any other operation except
 143 *      @begin.  Will be called even if the other operation failed.
 144 * @get_priv_flags: Report driver-specific feature flags.
 145 * @set_priv_flags: Set driver-specific feature flags.  Returns a negative
 146 *      error code or zero.
 147 * @get_sset_count: Get number of strings that @get_strings will write.
 148 * @get_rxnfc: Get RX flow classification rules.  Returns a negative
 149 *      error code or zero.
 150 * @set_rxnfc: Set RX flow classification rules.  Returns a negative
 151 *      error code or zero.
 152 * @flash_device: Write a firmware image to device's flash memory.
 153 *      Returns a negative error code or zero.
 154 * @reset: Reset (part of) the device, as specified by a bitmask of
 155 *      flags from &enum ethtool_reset_flags.  Returns a negative
 156 *      error code or zero.
 157 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
 158 *      Returns zero if not supported for this specific device.
 159 * @get_rxfh_indir: Get the contents of the RX flow hash indirection table.
 160 *      Will not be called if @get_rxfh_indir_size returns zero.
 161 *      Returns a negative error code or zero.
 162 * @set_rxfh_indir: Set the contents of the RX flow hash indirection table.
 163 *      Will not be called if @get_rxfh_indir_size returns zero.
 164 *      Returns a negative error code or zero.
 165 * @get_channels: Get number of channels.
 166 * @set_channels: Set number of channels.  Returns a negative error code or
 167 *      zero.
 168 * @get_dump_flag: Get dump flag indicating current dump length, version,
 169 *                 and flag of the device.
 170 * @get_dump_data: Get dump data.
 171 * @set_dump: Set dump specific flags to the device.
 172 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
 173 *      Drivers supporting transmit time stamps in software should set this to
 174 *      ethtool_op_get_ts_info().
 175 * @get_module_info: Get the size and type of the eeprom contained within
 176 *      a plug-in module.
 177 * @get_module_eeprom: Get the eeprom information from the plug-in module
 178 * @get_eee: Get Energy-Efficient (EEE) supported and status.
 179 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
 180 *
 181 * All operations are optional (i.e. the function pointer may be set
 182 * to %NULL) and callers must take this into account.  Callers must
 183 * hold the RTNL lock.
 184 *
 185 * See the structures used by these operations for further documentation.
 186 *
 187 * See &struct net_device and &struct net_device_ops for documentation
 188 * of the generic netdev features interface.
 189 */
 190struct ethtool_ops {
 191        int     (*get_settings)(struct net_device *, struct ethtool_cmd *);
 192        int     (*set_settings)(struct net_device *, struct ethtool_cmd *);
 193        void    (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
 194        int     (*get_regs_len)(struct net_device *);
 195        void    (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
 196        void    (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
 197        int     (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
 198        u32     (*get_msglevel)(struct net_device *);
 199        void    (*set_msglevel)(struct net_device *, u32);
 200        int     (*nway_reset)(struct net_device *);
 201        u32     (*get_link)(struct net_device *);
 202        int     (*get_eeprom_len)(struct net_device *);
 203        int     (*get_eeprom)(struct net_device *,
 204                              struct ethtool_eeprom *, u8 *);
 205        int     (*set_eeprom)(struct net_device *,
 206                              struct ethtool_eeprom *, u8 *);
 207        int     (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
 208        int     (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
 209        void    (*get_ringparam)(struct net_device *,
 210                                 struct ethtool_ringparam *);
 211        int     (*set_ringparam)(struct net_device *,
 212                                 struct ethtool_ringparam *);
 213        void    (*get_pauseparam)(struct net_device *,
 214                                  struct ethtool_pauseparam*);
 215        int     (*set_pauseparam)(struct net_device *,
 216                                  struct ethtool_pauseparam*);
 217        void    (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
 218        void    (*get_strings)(struct net_device *, u32 stringset, u8 *);
 219        int     (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
 220        void    (*get_ethtool_stats)(struct net_device *,
 221                                     struct ethtool_stats *, u64 *);
 222        int     (*begin)(struct net_device *);
 223        void    (*complete)(struct net_device *);
 224        u32     (*get_priv_flags)(struct net_device *);
 225        int     (*set_priv_flags)(struct net_device *, u32);
 226        int     (*get_sset_count)(struct net_device *, int);
 227        int     (*get_rxnfc)(struct net_device *,
 228                             struct ethtool_rxnfc *, u32 *rule_locs);
 229        int     (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
 230        int     (*flash_device)(struct net_device *, struct ethtool_flash *);
 231        int     (*reset)(struct net_device *, u32 *);
 232        u32     (*get_rxfh_indir_size)(struct net_device *);
 233        int     (*get_rxfh_indir)(struct net_device *, u32 *);
 234        int     (*set_rxfh_indir)(struct net_device *, const u32 *);
 235        void    (*get_channels)(struct net_device *, struct ethtool_channels *);
 236        int     (*set_channels)(struct net_device *, struct ethtool_channels *);
 237        int     (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
 238        int     (*get_dump_data)(struct net_device *,
 239                                 struct ethtool_dump *, void *);
 240        int     (*set_dump)(struct net_device *, struct ethtool_dump *);
 241        int     (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
 242        int     (*get_module_info)(struct net_device *,
 243                                   struct ethtool_modinfo *);
 244        int     (*get_module_eeprom)(struct net_device *,
 245                                     struct ethtool_eeprom *, u8 *);
 246        int     (*get_eee)(struct net_device *, struct ethtool_eee *);
 247        int     (*set_eee)(struct net_device *, struct ethtool_eee *);
 248
 249
 250};
 251#endif /* _LINUX_ETHTOOL_H */
 252
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.