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 void ethtool_convert_legacy_u32_to_link_mode(unsigned long *dst, 154 u32 legacy_u32); 155 156 /* return false if src had higher bits set. lower bits always updated. */ 157 bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32, 158 const unsigned long *src); 159 160 /** 161 * struct ethtool_ops - optional netdev operations 162 * @get_settings: DEPRECATED, use %get_link_ksettings/%set_link_ksettings 163 * API. Get various device settings including Ethernet link 164 * settings. The @cmd parameter is expected to have been cleared 165 * before get_settings is called. Returns a negative error code 166 * or zero. 167 * @set_settings: DEPRECATED, use %get_link_ksettings/%set_link_ksettings 168 * API. Set various device settings including Ethernet link 169 * settings. Returns a negative error code or zero. 170 * @get_drvinfo: Report driver/device information. Should only set the 171 * @driver, @version, @fw_version and @bus_info fields. If not 172 * implemented, the @driver and @bus_info fields will be filled in 173 * according to the netdev's parent device. 174 * @get_regs_len: Get buffer length required for @get_regs 175 * @get_regs: Get device registers 176 * @get_wol: Report whether Wake-on-Lan is enabled 177 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code 178 * or zero. 179 * @get_msglevel: Report driver message level. This should be the value 180 * of the @msg_enable field used by netif logging functions. 181 * @set_msglevel: Set driver message level 182 * @nway_reset: Restart autonegotiation. Returns a negative error code 183 * or zero. 184 * @get_link: Report whether physical link is up. Will only be called if 185 * the netdev is up. Should usually be set to ethtool_op_get_link(), 186 * which uses netif_carrier_ok(). 187 * @get_eeprom: Read data from the device EEPROM. 188 * Should fill in the magic field. Don't need to check len for zero 189 * or wraparound. Fill in the data argument with the eeprom values 190 * from offset to offset + len. Update len to the amount read. 191 * Returns an error or zero. 192 * @set_eeprom: Write data to the device EEPROM. 193 * Should validate the magic field. Don't need to check len for zero 194 * or wraparound. Update len to the amount written. Returns an error 195 * or zero. 196 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative 197 * error code or zero. 198 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative 199 * error code or zero. 200 * @get_ringparam: Report ring sizes 201 * @set_ringparam: Set ring sizes. Returns a negative error code or zero. 202 * @get_pauseparam: Report pause parameters 203 * @set_pauseparam: Set pause parameters. Returns a negative error code 204 * or zero. 205 * @self_test: Run specified self-tests 206 * @get_strings: Return a set of strings that describe the requested objects 207 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED 208 * attached to it. The implementation may update the indicator 209 * asynchronously or synchronously, but in either case it must return 210 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, 211 * and must either activate asynchronous updates and return zero, return 212 * a negative error or return a positive frequency for synchronous 213 * indication (e.g. 1 for one on/off cycle per second). If it returns 214 * a frequency then it will be called again at intervals with the 215 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of 216 * the indicator accordingly. Finally, it is called with the argument 217 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a 218 * negative error code or zero. 219 * @get_ethtool_stats: Return extended statistics about the device. 220 * This is only useful if the device maintains statistics not 221 * included in &struct rtnl_link_stats64. 222 * @begin: Function to be called before any other operation. Returns a 223 * negative error code or zero. 224 * @complete: Function to be called after any other operation except 225 * @begin. Will be called even if the other operation failed. 226 * @get_priv_flags: Report driver-specific feature flags. 227 * @set_priv_flags: Set driver-specific feature flags. Returns a negative 228 * error code or zero. 229 * @get_sset_count: Get number of strings that @get_strings will write. 230 * @get_rxnfc: Get RX flow classification rules. Returns a negative 231 * error code or zero. 232 * @set_rxnfc: Set RX flow classification rules. Returns a negative 233 * error code or zero. 234 * @flash_device: Write a firmware image to device's flash memory. 235 * Returns a negative error code or zero. 236 * @reset: Reset (part of) the device, as specified by a bitmask of 237 * flags from &enum ethtool_reset_flags. Returns a negative 238 * error code or zero. 239 * @get_rxfh_key_size: Get the size of the RX flow hash key. 240 * Returns zero if not supported for this specific device. 241 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. 242 * Returns zero if not supported for this specific device. 243 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key 244 * and/or hash function. 245 * Returns a negative error code or zero. 246 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash 247 * key, and/or hash function. Arguments which are set to %NULL or zero 248 * will remain unchanged. 249 * Returns a negative error code or zero. An error code must be returned 250 * if at least one unsupported change was requested. 251 * @get_channels: Get number of channels. 252 * @set_channels: Set number of channels. Returns a negative error code or 253 * zero. 254 * @get_dump_flag: Get dump flag indicating current dump length, version, 255 * and flag of the device. 256 * @get_dump_data: Get dump data. 257 * @set_dump: Set dump specific flags to the device. 258 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. 259 * Drivers supporting transmit time stamps in software should set this to 260 * ethtool_op_get_ts_info(). 261 * @get_module_info: Get the size and type of the eeprom contained within 262 * a plug-in module. 263 * @get_module_eeprom: Get the eeprom information from the plug-in module 264 * @get_eee: Get Energy-Efficient (EEE) supported and status. 265 * @set_eee: Set EEE status (enable/disable) as well as LPI timers. 266 * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue. 267 * It must check that the given queue number is valid. If neither a RX nor 268 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 269 * queue has this number, set the inapplicable fields to ~0 and return 0. 270 * Returns a negative error code or zero. 271 * @set_per_queue_coalesce: Set interrupt coalescing parameters per queue. 272 * It must check that the given queue number is valid. If neither a RX nor 273 * a TX queue has this number, return -EINVAL. If only a RX queue or a TX 274 * queue has this number, ignore the inapplicable fields. 275 * Returns a negative error code or zero. 276 * @get_link_ksettings: When defined, takes precedence over the 277 * %get_settings method. Get various device settings 278 * including Ethernet link settings. The %cmd and 279 * %link_mode_masks_nwords fields should be ignored (use 280 * %__ETHTOOL_LINK_MODE_MASK_NBITS instead of the latter), any 281 * change to them will be overwritten by kernel. Returns a 282 * negative error code or zero. 283 * @set_link_ksettings: When defined, takes precedence over the 284 * %set_settings method. Set various device settings including 285 * Ethernet link settings. The %cmd and %link_mode_masks_nwords 286 * fields should be ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS 287 * instead of the latter), any change to them will be overwritten 288 * by kernel. Returns a negative error code or zero. 289 * 290 * All operations are optional (i.e. the function pointer may be set 291 * to %NULL) and callers must take this into account. Callers must 292 * hold the RTNL lock. 293 * 294 * See the structures used by these operations for further documentation. 295 * Note that for all operations using a structure ending with a zero- 296 * length array, the array is allocated separately in the kernel and 297 * is passed to the driver as an additional parameter. 298 * 299 * See &struct net_device and &struct net_device_ops for documentation 300 * of the generic netdev features interface. 301 */ 302 struct ethtool_ops { 303 int (*get_settings)(struct net_device *, struct ethtool_cmd *); 304 int (*set_settings)(struct net_device *, struct ethtool_cmd *); 305 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 306 int (*get_regs_len)(struct net_device *); 307 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 308 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 309 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 310 u32 (*get_msglevel)(struct net_device *); 311 void (*set_msglevel)(struct net_device *, u32); 312 int (*nway_reset)(struct net_device *); 313 u32 (*get_link)(struct net_device *); 314 int (*get_eeprom_len)(struct net_device *); 315 int (*get_eeprom)(struct net_device *, 316 struct ethtool_eeprom *, u8 *); 317 int (*set_eeprom)(struct net_device *, 318 struct ethtool_eeprom *, u8 *); 319 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); 320 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); 321 void (*get_ringparam)(struct net_device *, 322 struct ethtool_ringparam *); 323 int (*set_ringparam)(struct net_device *, 324 struct ethtool_ringparam *); 325 void (*get_pauseparam)(struct net_device *, 326 struct ethtool_pauseparam*); 327 int (*set_pauseparam)(struct net_device *, 328 struct ethtool_pauseparam*); 329 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 330 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 331 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); 332 void (*get_ethtool_stats)(struct net_device *, 333 struct ethtool_stats *, u64 *); 334 int (*begin)(struct net_device *); 335 void (*complete)(struct net_device *); 336 u32 (*get_priv_flags)(struct net_device *); 337 int (*set_priv_flags)(struct net_device *, u32); 338 int (*get_sset_count)(struct net_device *, int); 339 int (*get_rxnfc)(struct net_device *, 340 struct ethtool_rxnfc *, u32 *rule_locs); 341 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 342 int (*flash_device)(struct net_device *, struct ethtool_flash *); 343 int (*reset)(struct net_device *, u32 *); 344 u32 (*get_rxfh_key_size)(struct net_device *); 345 u32 (*get_rxfh_indir_size)(struct net_device *); 346 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key, 347 u8 *hfunc); 348 int (*set_rxfh)(struct net_device *, const u32 *indir, 349 const u8 *key, const u8 hfunc); 350 void (*get_channels)(struct net_device *, struct ethtool_channels *); 351 int (*set_channels)(struct net_device *, struct ethtool_channels *); 352 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); 353 int (*get_dump_data)(struct net_device *, 354 struct ethtool_dump *, void *); 355 int (*set_dump)(struct net_device *, struct ethtool_dump *); 356 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); 357 int (*get_module_info)(struct net_device *, 358 struct ethtool_modinfo *); 359 int (*get_module_eeprom)(struct net_device *, 360 struct ethtool_eeprom *, u8 *); 361 int (*get_eee)(struct net_device *, struct ethtool_eee *); 362 int (*set_eee)(struct net_device *, struct ethtool_eee *); 363 int (*get_tunable)(struct net_device *, 364 const struct ethtool_tunable *, void *); 365 int (*set_tunable)(struct net_device *, 366 const struct ethtool_tunable *, const void *); 367 int (*get_per_queue_coalesce)(struct net_device *, u32, 368 struct ethtool_coalesce *); 369 int (*set_per_queue_coalesce)(struct net_device *, u32, 370 struct ethtool_coalesce *); 371 int (*get_link_ksettings)(struct net_device *, 372 struct ethtool_link_ksettings *); 373 int (*set_link_ksettings)(struct net_device *, 374 const struct ethtool_link_ksettings *); 375 }; 376 #endif /* _LINUX_ETHTOOL_H */ 377