forge/linux-pinenote
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ethtool: Convert struct ethtool_ops comment to kernel-doc format

Browse source 
Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
This commit is contained in:
Ben Hutchings 2011-04-01 22:52:34 +01:00
commit e20b5b61a3
1 changed files with 35 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

80
include/linux/ethtool.h
View file

@ -683,63 +683,53 @@ void ethtool_ntuple_flush(struct net_device *dev);
bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported); bool ethtool_invalid_flags(struct net_device *dev, u32 data, u32 supported);
/** /**
* &ethtool_ops - Alter and report network device settings * struct ethtool_ops - Alter and report network device settings
* get_settings: Get device-specific settings * @get_settings: Get device-specific settings.
* set_settings: Set device-specific settings
* get_drvinfo: Report driver information
* get_regs: Get device registers
* get_wol: Report whether Wake-on-Lan is enabled
* set_wol: Turn Wake-on-Lan on or off
* get_msglevel: Report driver message level
* set_msglevel: Set driver message level
* nway_reset: Restart autonegotiation
* get_link: Get link status
* get_eeprom: Read data from the device EEPROM
* set_eeprom: Write data to the device EEPROM
* get_coalesce: Get interrupt coalescing parameters
* set_coalesce: Set interrupt coalescing parameters
* get_ringparam: Report ring sizes
* set_ringparam: Set ring sizes
* get_pauseparam: Report pause parameters
* set_pauseparam: Set pause parameters
* get_rx_csum: Report whether receive checksums are turned on or off
* set_rx_csum: Turn receive checksum on or off
* get_tx_csum: Report whether transmit checksums are turned on or off
* set_tx_csum: Turn transmit checksums on or off
* get_sg: Report whether scatter-gather is enabled
* set_sg: Turn scatter-gather on or off
* get_tso: Report whether TCP segmentation offload is enabled
* set_tso: Turn TCP segmentation offload on or off
* get_ufo: Report whether UDP fragmentation offload is enabled
* set_ufo: Turn UDP fragmentation offload on or off
* self_test: Run specified self-tests
* get_strings: Return a set of strings that describe the requested objects
* phys_id: Identify the device
* get_stats: Return statistics about the device
* get_flags: get 32-bit flags bitmap
* set_flags: set 32-bit flags bitmap
*
* Description:
*
* get_settings:
* @get_settings is passed an &ethtool_cmd to fill in. It returns * @get_settings is passed an &ethtool_cmd to fill in. It returns
* an negative errno or zero. * an negative errno or zero.
* * @set_settings: Set device-specific settings.
* set_settings:
* @set_settings is passed an &ethtool_cmd and should attempt to set * @set_settings is passed an &ethtool_cmd and should attempt to set
* all the settings this device supports. It may return an error value * all the settings this device supports. It may return an error value
* if something goes wrong (otherwise 0). * if something goes wrong (otherwise 0).
* * @get_drvinfo: Report driver information
* get_eeprom: * @get_regs: Get device registers
* @get_wol: Report whether Wake-on-Lan is enabled
* @set_wol: Turn Wake-on-Lan on or off
* @get_msglevel: Report driver message level
* @set_msglevel: Set driver message level
* @nway_reset: Restart autonegotiation
* @get_link: Get link status
* @get_eeprom: Read data from the device EEPROM.
* Should fill in the magic field. Don't need to check len for zero * Should fill in the magic field. Don't need to check len for zero
* or wraparound. Fill in the data argument with the eeprom values * or wraparound. Fill in the data argument with the eeprom values
* from offset to offset + len. Update len to the amount read. * from offset to offset + len. Update len to the amount read.
* Returns an error or zero. * Returns an error or zero.
* * @set_eeprom: Write data to the device EEPROM.
* set_eeprom:
* Should validate the magic field. Don't need to check len for zero * Should validate the magic field. Don't need to check len for zero
* or wraparound. Update len to the amount written. Returns an error * or wraparound. Update len to the amount written. Returns an error
* or zero. * or zero.
* @get_coalesce: Get interrupt coalescing parameters
* @set_coalesce: Set interrupt coalescing parameters
* @get_ringparam: Report ring sizes
* @set_ringparam: Set ring sizes
* @get_pauseparam: Report pause parameters
* @set_pauseparam: Set pause parameters
* @get_rx_csum: Report whether receive checksums are turned on or off
* @set_rx_csum: Turn receive checksum on or off
* @get_tx_csum: Report whether transmit checksums are turned on or off
* @set_tx_csum: Turn transmit checksums on or off
* @get_sg: Report whether scatter-gather is enabled
* @set_sg: Turn scatter-gather on or off
* @get_tso: Report whether TCP segmentation offload is enabled
* @set_tso: Turn TCP segmentation offload on or off
* @get_ufo: Report whether UDP fragmentation offload is enabled
* @set_ufo: Turn UDP fragmentation offload on or off
* @self_test: Run specified self-tests
* @get_strings: Return a set of strings that describe the requested objects
* @phys_id: Identify the device
* @get_stats: Return statistics about the device
* @get_flags: get 32-bit flags bitmap
* @set_flags: set 32-bit flags bitmap
*/ */
struct ethtool_ops { struct ethtool_ops {
int (*get_settings)(struct net_device *, struct ethtool_cmd *); int (*get_settings)(struct net_device *, struct ethtool_cmd *);