Commit d9c65de0 authored by Jakub Kicinski's avatar Jakub Kicinski Committed by David S. Miller

ethtool: fix kdoc in headers

Fix remaining issues with kdoc in the ethtool headers.
Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 83e5feeb
...@@ -290,6 +290,9 @@ struct ethtool_pause_stats { ...@@ -290,6 +290,9 @@ struct ethtool_pause_stats {
* do not attach ext_substate attribute to netlink message). If link_ext_state * do not attach ext_substate attribute to netlink message). If link_ext_state
* and link_ext_substate are unknown, return -ENODATA. If not implemented, * and link_ext_substate are unknown, return -ENODATA. If not implemented,
* link_ext_state and link_ext_substate will not be sent to userspace. * link_ext_state and link_ext_substate will not be sent to userspace.
* @get_eeprom_len: Read range of EEPROM addresses for validation of
* @get_eeprom and @set_eeprom requests.
* Returns 0 if device does not support EEPROM access.
* @get_eeprom: Read data from the device EEPROM. * @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
...@@ -382,6 +385,8 @@ struct ethtool_pause_stats { ...@@ -382,6 +385,8 @@ struct ethtool_pause_stats {
* @get_module_eeprom: Get the eeprom information from the plug-in module * @get_module_eeprom: Get the eeprom information from the plug-in module
* @get_eee: Get Energy-Efficient (EEE) supported and status. * @get_eee: Get Energy-Efficient (EEE) supported and status.
* @set_eee: Set EEE status (enable/disable) as well as LPI timers. * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
* @get_tunable: Read the value of a driver / device tunable.
* @set_tunable: Set the value of a driver / device tunable.
* @get_per_queue_coalesce: Get interrupt coalescing parameters per queue. * @get_per_queue_coalesce: Get interrupt coalescing parameters per queue.
* It must check that the given queue number is valid. If neither a RX nor * It must check that the given queue number is valid. If neither a RX nor
* a TX queue has this number, return -EINVAL. If only a RX queue or a TX * a TX queue has this number, return -EINVAL. If only a RX queue or a TX
...@@ -545,8 +550,8 @@ struct phy_tdr_config; ...@@ -545,8 +550,8 @@ struct phy_tdr_config;
* @get_sset_count: Get number of strings that @get_strings will write. * @get_sset_count: Get number of strings that @get_strings will write.
* @get_strings: Return a set of strings that describe the requested objects * @get_strings: Return a set of strings that describe the requested objects
* @get_stats: Return extended statistics about the PHY device. * @get_stats: Return extended statistics about the PHY device.
* @start_cable_test - Start a cable test * @start_cable_test: Start a cable test
* @start_cable_test_tdr - Start a Time Domain Reflectometry cable test * @start_cable_test_tdr: Start a Time Domain Reflectometry cable test
* *
* All operations are optional (i.e. the function pointer may be set to %NULL) * All operations are optional (i.e. the function pointer may be set to %NULL)
* and callers must take this into account. Callers must hold the RTNL lock. * and callers must take this into account. Callers must hold the RTNL lock.
......
...@@ -659,6 +659,7 @@ enum ethtool_link_ext_substate_cable_issue { ...@@ -659,6 +659,7 @@ enum ethtool_link_ext_substate_cable_issue {
* now deprecated * now deprecated
* @ETH_SS_FEATURES: Device feature names * @ETH_SS_FEATURES: Device feature names
* @ETH_SS_RSS_HASH_FUNCS: RSS hush function names * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names
* @ETH_SS_TUNABLES: tunable names
* @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS
* @ETH_SS_PHY_TUNABLES: PHY tunable names * @ETH_SS_PHY_TUNABLES: PHY tunable names
* @ETH_SS_LINK_MODES: link mode names * @ETH_SS_LINK_MODES: link mode names
...@@ -668,6 +669,8 @@ enum ethtool_link_ext_substate_cable_issue { ...@@ -668,6 +669,8 @@ enum ethtool_link_ext_substate_cable_issue {
* @ETH_SS_TS_TX_TYPES: timestamping Tx types * @ETH_SS_TS_TX_TYPES: timestamping Tx types
* @ETH_SS_TS_RX_FILTERS: timestamping Rx filters * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters
* @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types * @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types
*
* @ETH_SS_COUNT: number of defined string sets
*/ */
enum ethtool_stringset { enum ethtool_stringset {
ETH_SS_TEST = 0, ETH_SS_TEST = 0,
...@@ -1962,8 +1965,11 @@ enum ethtool_reset_flags { ...@@ -1962,8 +1965,11 @@ enum ethtool_reset_flags {
* autonegotiation; 0 if unknown or not applicable. Read-only. * autonegotiation; 0 if unknown or not applicable. Read-only.
* @transceiver: Used to distinguish different possible PHY types, * @transceiver: Used to distinguish different possible PHY types,
* reported consistently by PHYLIB. Read-only. * reported consistently by PHYLIB. Read-only.
* @master_slave_cfg: Master/slave port mode.
* @master_slave_state: Master/slave port state.
* @reserved: Reserved for future use; see the note on reserved space. * @reserved: Reserved for future use; see the note on reserved space.
* @reserved1: Reserved for future use; see the note on reserved space. * @reserved1: Reserved for future use; see the note on reserved space.
* @link_mode_masks: Variable length bitmaps.
* *
* If autonegotiation is disabled, the speed and @duplex represent the * If autonegotiation is disabled, the speed and @duplex represent the
* fixed link mode and are writable if the driver supports multiple * fixed link mode and are writable if the driver supports multiple
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment