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

ethtool: document the enum values not defines

kdoc does not have good support for documenting defines,
and we can't abuse the enum documentation because it
generates warnings.
Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent cf2cc0bf
...@@ -1414,16 +1414,16 @@ struct ethtool_fecparam { ...@@ -1414,16 +1414,16 @@ struct ethtool_fecparam {
/** /**
* enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
* @ETHTOOL_FEC_NONE: FEC mode configuration is not supported. Should not * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not
* be used together with other bits. GET only. * be used together with other bits. GET only.
* @ETHTOOL_FEC_AUTO: Select default/best FEC mode automatically, usually based * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually
* link mode and SFP parameters read from module's EEPROM. * based link mode and SFP parameters read from module's
* This bit does _not_ mean autonegotiation. * EEPROM. This bit does _not_ mean autonegotiation.
* @ETHTOOL_FEC_OFF: No FEC Mode * @ETHTOOL_FEC_OFF_BIT: No FEC Mode
* @ETHTOOL_FEC_RS: Reed-Solomon FEC Mode * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode
* @ETHTOOL_FEC_BASER: Base-R/Reed-Solomon FEC Mode * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode
* @ETHTOOL_FEC_LLRS: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet
* Consortium) * Consortium)
*/ */
enum ethtool_fec_config_bits { enum ethtool_fec_config_bits {
ETHTOOL_FEC_NONE_BIT, ETHTOOL_FEC_NONE_BIT,
......
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