The documentation for the rte_eth_fec_set() is updated to provide more detailed information about how FEC modes are handled. It also includes a description of the case when only the AUTO bit is set.
Signed-off-by: Denis Pryazhennikov <denis.pryazhenni...@arknetworks.am> Acked-by: Ivan Malov <ivan.ma...@arknetworks.am> Acked-by: Viacheslav Galaktionov <viacheslav.galaktio...@arknetworks.am> --- lib/ethdev/rte_ethdev.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index 99fe9e238b20..0f10ac944061 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -4227,13 +4227,19 @@ int rte_eth_fec_get(uint16_t port_id, uint32_t *fec_capa); * @param port_id * The port identifier of the Ethernet device. * @param fec_capa - * A bitmask of allowed FEC modes. If AUTO bit is set, other - * bits specify FEC modes which may be negotiated. If AUTO - * bit is clear, specify FEC modes to be used (only one valid - * mode per speed may be set). + * A bitmask of allowed FEC modes. + * If only the AUTO bit is set, the decision on which FEC + * mode to use will be made by HW/FW or driver. + * If the AUTO bit is set, other bits specify FEC modes + * which may be negotiated. It means that only specified + * FEC modes can be set. + * If AUTO bit is clear, specify FEC mode to be used + * (only one valid mode per speed may be set). + * NOFEC will be used if specified FEC modes are not + * supported. * @return * - (0) if successful. - * - (-EINVAL) if the FEC mode is not valid. + * - (-EINVAL) if *fec_capa* is not valid. * - (-ENOTSUP) if underlying hardware OR driver doesn't support. * - (-EIO) if device is removed. * - (-ENODEV) if *port_id* invalid. -- 2.37.0 (Apple Git-136)
