1 /* 2 * ethtool.h: Defines for Linux ethtool. 3 * 4 * Copyright (C) 1998 David S. Miller ([email protected]) 5 * Copyright 2001 Jeff Garzik <[email protected]> 6 * Portions Copyright 2001 Sun Microsystems ([email protected]) 7 * Portions Copyright 2002 Intel ([email protected], 8 * [email protected], 9 * [email protected]) 10 * Portions Copyright (C) Sun Microsystems 2008 11 */ 12 #ifndef _LINUX_ETHTOOL_H 13 #define _LINUX_ETHTOOL_H 14 15 #include <linux/bitmap.h> 16 #include <linux/compat.h> 17 #include <uapi/linux/ethtool.h> 18 19 #ifdef CONFIG_COMPAT 20 21 struct compat_ethtool_rx_flow_spec { 22 u32 flow_type; 23 union ethtool_flow_union h_u; 24 struct ethtool_flow_ext h_ext; 25 union ethtool_flow_union m_u; 26 struct ethtool_flow_ext m_ext; 27 compat_u64 ring_cookie; 28 u32 location; 29 }; 30 31 struct compat_ethtool_rxnfc { 32 u32 cmd; 33 u32 flow_type; 34 compat_u64 data; 35 struct compat_ethtool_rx_flow_spec fs; 36 u32 rule_cnt; 37 u32 rule_locs[0]; 38 }; 39 40 #endif /* CONFIG_COMPAT */ 41 42 #include <linux/rculist.h> 43 44 /** 45 * enum ethtool_phys_id_state - indicator state for physical identification 46 * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated 47 * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated 48 * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE 49 * is not supported) 50 * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE 51 * is not supported) 52 */ 53 enum ethtool_phys_id_state { 54 ETHTOOL_ID_INACTIVE, 55 ETHTOOL_ID_ACTIVE, 56 ETHTOOL_ID_ON, 57 ETHTOOL_ID_OFF 58 }; 59 60 enum { 61 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */ 62 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */ 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 #define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit)) 72 #define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT) 73 74 #define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP) 75 #define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR) 76 77 #define ETH_RSS_HASH_UNKNOWN 0 78 #define ETH_RSS_HASH_NO_CHANGE 0 79 80 struct net_device; 81 82 /* Some generic methods drivers may use in their ethtool_ops */ 83 u32 ethtool_op_get_link(struct net_device *dev); 84 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti); 85 86 /** 87 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection 88 * @index: Index in RX flow hash indirection table 89 * @n_rx_rings: Number of RX rings to use 90 * 91 * This function provides the default policy for RX flow hash indirection. 92 */ 93 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings) 94 { 95 return index % n_rx_rings; 96 } 97 98 /* number of link mode bits/ulongs handled internally by kernel */ 99 #define __ETHTOOL_LINK_MODE_MASK_NBITS \ 100 (__ETHTOOL_LINK_MODE_LAST + 1) 101 102 /* declare a link mode bitmap */ 103 #define __ETHTOOL_DECLARE_LINK_MODE_MASK(name) \ 104 DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS) 105 106 /* drivers must ignore base.cmd and base.link_mode_masks_nwords 107 * fields, but they are allowed to overwrite them (will be ignored). 108 */ 109 struct ethtool_link_ksettings { 110 struct ethtool_link_settings base; 111 struct { 112 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 113 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 114 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 115 } link_modes; 116 }; 117 118 /** 119 * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask 120 * @ptr : pointer to struct ethtool_link_ksettings 121 * @name : one of supported/advertising/lp_advertising 122 */ 123 #define ethtool_link_ksettings_zero_link_mode(ptr, name) \ 124 bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS) 125 126 /** 127 * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings 128 * link mode mask 129 * @ptr : pointer to struct ethtool_link_ksettings 130 * @name : one of supported/advertising/lp_advertising 131 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 132 * (not atomic, no bound checking) 133 */ 134 #define ethtool_link_ksettings_add_link_mode(ptr, name, mode) \ 135 __set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 136 137 /** 138 * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask 139 * @ptr : pointer to struct ethtool_link_ksettings 140 * @name : one of supported/advertising/lp_advertising 141 * @mode : one of the ETHTOOL_LINK_MODE_*_BIT 142 * (not atomic, no bound checking) 143 * 144 * Returns true/false. 145 */ 146 #define ethtool_link_ksettings_test_link_mode(ptr, name, mode) \ 147 test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name) 148 149 extern int 150 __ethtool_get_link_ksettings(struct net_device *dev, 151 struct ethtool_link_ksettings *link_ksettings); 152 153 /** 154 * struct ethtool_ops - optional netdev operations 155 * @get_settings: DEPRECATED, use %get_link_ksettings/%set_link_ksettings 156 * API. Get various device settings including Ethernet link 157 * settings. The @cmd parameter is expected to have been cleared 158 * before get_settings is called. Returns a negative error code 159 * or zero. 160 * @set_settings: DEPRECATED, use %get_link_ksettings/%set_link_ksettings 161 * API. Set various device settings including Ethernet link 162 * settings. Returns a negative error code or zero. 163 * @get_drvinfo: Report driver/device information. Should only set the 164 * @driver, @version, @fw_version and @bus_info fields. If not 165 * implemented, the @driver and @bus_info fields will be filled in 166 * according to the netdev's parent device. 167 * @get_regs_len: Get buffer length required for @get_regs 168 * @get_regs: Get device registers 169 * @get_wol: Report whether Wake-on-Lan is enabled 170 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code 171 * or zero. 172 * @get_msglevel: Report driver message level. This should be the value 173 * of the @msg_enable field used by netif logging functions. 174 * @set_msglevel: Set driver message level 175 * @nway_reset: Restart autonegotiation. Returns a negative error code 176 * or zero. 177 * @get_link: Report whether physical link is up. Will only be called if 178 * the netdev is up. Should usually be set to ethtool_op_get_link(), 179 * which uses netif_carrier_ok(). 180 * @get_eeprom: Read data from the device EEPROM. 181 * Should fill in the magic field. Don't need to check len for zero 182 * or wraparound. Fill in the data argument with the eeprom values 183 * from offset to offset + len. Update len to the amount read. 184 * Returns an error or zero. 185 * @set_eeprom: Write data to the device EEPROM. 186 * Should validate the magic field. Don't need to check len for zero 187 * or wraparound. Update len to the amount written. Returns an error 188 * or zero. 189 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative 190 * error code or zero. 191 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative 192 * error code or zero. 193 * @get_ringparam: Report ring sizes 194 * @set_ringparam: Set ring sizes. Returns a negative error code or zero. 195 * @get_pauseparam: Report pause parameters 196 * @set_pauseparam: Set pause parameters. Returns a negative error code 197 * or zero. 198 * @self_test: Run specified self-tests 199 * @get_strings: Return a set of strings that describe the requested objects 200 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED 201 * attached to it. The implementation may update the indicator 202 * asynchronously or synchronously, but in either case it must return 203 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, 204 * and must either activate asynchronous updates and return zero, return 205 * a negative error or return a positive frequency for synchronous 206 * indication (e.g. 1 for one on/off cycle per second). If it returns 207 * a frequency then it will be called again at intervals with the 208 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of 209 * the indicator accordingly. Finally, it is called with the argument 210 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a 211 * negative error code or zero. 212 * @get_ethtool_stats: Return extended statistics about the device. 213 * This is only useful if the device maintains statistics not 214 * included in &struct rtnl_link_stats64. 215 * @begin: Function to be called before any other operation. Returns a 216 * negative error code or zero. 217 * @complete: Function to be called after any other operation except 218 * @begin. Will be called even if the other operation failed. 219 * @get_priv_flags: Report driver-specific feature flags. 220 * @set_priv_flags: Set driver-specific feature flags. Returns a negative 221 * error code or zero. 222 * @get_sset_count: Get number of strings that @get_strings will write. 223 * @get_rxnfc: Get RX flow classification rules. Returns a negative 224 * error code or zero. 225 * @set_rxnfc: Set RX flow classification rules. Returns a negative 226 * error code or zero. 227 * @flash_device: Write a firmware image to device's flash memory. 228 * Returns a negative error code or zero. 229 * @reset: Reset (part of) the device, as specified by a bitmask of 230 * flags from &enum ethtool_reset_flags. Returns a negative 231 * error code or zero. 232 * @get_rxfh_key_size: Get the size of the RX flow hash key. 233 * Returns zero if not supported for this specific device. 234 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. 235 * Returns zero if not supported for this specific device. 236 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key 237 * and/or hash function. 238 * Returns a negative error code or zero. 239 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash 240 * key, and/or hash function. Arguments which are set to %NULL or zero 241 * will remain unchanged. 242 * Returns a negative error code or zero. An error code must be returned 243 * if at least one unsupported change was requested. 244 * @get_channels: Get number of channels. 245 * @set_channels: Set number of channels. Returns a negative error code or 246 * zero. 247 * @get_dump_flag: Get dump flag indicating current dump length, version, 248 * and flag of the device. 249 * @get_dump_data: Get dump data. 250 * @set_dump: Set dump specific flags to the device. 251 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. 252 * Drivers supporting transmit time stamps in software should set this to 253 * ethtool_op_get_ts_info(). 254 * @get_module_info: Get the size and type of the eeprom contained within 255 * a plug-in module. 256 * @get_module_eeprom: Get the eeprom information from the plug-in module 257 * @get_eee: Get Energy-Efficient (EEE) supported and status. 258 * @set_eee: Set EEE status (enable/disable) as well as LPI timers. 259 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue. 260 * It must check that the given queue number is valid. If neither a RX nor 261 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 262 * queue has this number, set the inapplicable fields to ~0 and return 0. 263 * Returns a negative error code or zero. 264 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue. 265 * It must check that the given queue number is valid. If neither a RX nor 266 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 267 * queue has this number, ignore the inapplicable fields. 268 * Returns a negative error code or zero. 269 * @get_link_ksettings: When defined, takes precedence over the 270 * %get_settings method. Get various device settings 271 * including Ethernet link settings. The %cmd and 272 * %link_mode_masks_nwords fields should be ignored (use 273 * %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), any 274 * change to them will be overwritten by kernel. Returns a 275 * negative error code or zero. 276 * @set_link_ksettings: When defined, takes precedence over the 277 * %set_settings method. Set various device settings including 278 * Ethernet link settings. The %cmd and %link_mode_masks_nwords 279 * fields should be ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS 280 * instead of the latter), any change to them will be overwritten 281 * by kernel. Returns a negative error code or zero. 282 * 283 * All operations are optional (i.e. the function pointer may be set 284 * to %NULL) and callers must take this into account. Callers must 285 * hold the RTNL lock. 286 * 287 * See the structures used by these operations for further documentation. 288 * Note that for all operations using a structure ending with a zero- 289 * length array, the array is allocated separately in the kernel and 290 * is passed to the driver as an additional parameter. 291 * 292 * See &struct net_device and &struct net_device_ops for documentation 293 * of the generic netdev features interface. 294 */ 295 struct ethtool_ops { 296 int (*get_settings)(struct net_device *, struct ethtool_cmd *); 297 int (*set_settings)(struct net_device *, struct ethtool_cmd *); 298 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 299 int (*get_regs_len)(struct net_device *); 300 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 301 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 302 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 303 u32 (*get_msglevel)(struct net_device *); 304 void (*set_msglevel)(struct net_device *, u32); 305 int (*nway_reset)(struct net_device *); 306 u32 (*get_link)(struct net_device *); 307 int (*get_eeprom_len)(struct net_device *); 308 int (*get_eeprom)(struct net_device *, 309 struct ethtool_eeprom *, u8 *); 310 int (*set_eeprom)(struct net_device *, 311 struct ethtool_eeprom *, u8 *); 312 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); 313 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); 314 void (*get_ringparam)(struct net_device *, 315 struct ethtool_ringparam *); 316 int (*set_ringparam)(struct net_device *, 317 struct ethtool_ringparam *); 318 void (*get_pauseparam)(struct net_device *, 319 struct ethtool_pauseparam*); 320 int (*set_pauseparam)(struct net_device *, 321 struct ethtool_pauseparam*); 322 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 323 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 324 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); 325 void (*get_ethtool_stats)(struct net_device *, 326 struct ethtool_stats *, u64 *); 327 int (*begin)(struct net_device *); 328 void (*complete)(struct net_device *); 329 u32 (*get_priv_flags)(struct net_device *); 330 int (*set_priv_flags)(struct net_device *, u32); 331 int (*get_sset_count)(struct net_device *, int); 332 int (*get_rxnfc)(struct net_device *, 333 struct ethtool_rxnfc *, u32 *rule_locs); 334 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 335 int (*flash_device)(struct net_device *, struct ethtool_flash *); 336 int (*reset)(struct net_device *, u32 *); 337 u32 (*get_rxfh_key_size)(struct net_device *); 338 u32 (*get_rxfh_indir_size)(struct net_device *); 339 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key, 340 u8 *hfunc); 341 int (*set_rxfh)(struct net_device *, const u32 *indir, 342 const u8 *key, const u8 hfunc); 343 void (*get_channels)(struct net_device *, struct ethtool_channels *); 344 int (*set_channels)(struct net_device *, struct ethtool_channels *); 345 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); 346 int (*get_dump_data)(struct net_device *, 347 struct ethtool_dump *, void *); 348 int (*set_dump)(struct net_device *, struct ethtool_dump *); 349 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); 350 int (*get_module_info)(struct net_device *, 351 struct ethtool_modinfo *); 352 int (*get_module_eeprom)(struct net_device *, 353 struct ethtool_eeprom *, u8 *); 354 int (*get_eee)(struct net_device *, struct ethtool_eee *); 355 int (*set_eee)(struct net_device *, struct ethtool_eee *); 356 int (*get_tunable)(struct net_device *, 357 const struct ethtool_tunable *, void *); 358 int (*set_tunable)(struct net_device *, 359 const struct ethtool_tunable *, const void *); 360 int (*get_per_queue_coalesce)(struct net_device *, u32, 361 struct ethtool_coalesce *); 362 int (*set_per_queue_coalesce)(struct net_device *, u32, 363 struct ethtool_coalesce *); 364 int (*get_link_ksettings)(struct net_device *, 365 struct ethtool_link_ksettings *); 366 int (*set_link_ksettings)(struct net_device *, 367 const struct ethtool_link_ksettings *); 368 }; 369 #endif /* _LINUX_ETHTOOL_H */ 370