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