mbox

[RFC,v2,0/3] improve FEC API usage

Message ID 20230508114707.89629-1-denis.pryazhennikov@arknetworks.am (mailing list archive)
Headers

Message

Denis Pryazhennikov May 8, 2023, 11:47 a.m. UTC 
  The documentation for the FEC API is currently incomplete and contains
inaccuracies in its descriptions of function parameters. 
Specifically, the semantics of the fec_capa parameter in rte_eth_fec_set()
is not well-defined. It does not provide information on what should
be done if only AUTO bit is set or one of the specified FEC modes is 
not supported. Additionally, the fec_capa parameter in rte_eth_fec_get()
implies that more than one FEC mode can be obtained, but it is 
wrong. Furthermore, the behaviour is undefined in 
rte_eth_fec_set() when the fec_capa parameter is zero.

To address these issues, a patch series has been created that updates
the FEC API documentation, renames one of the parameters to improve 
its clarity and adds a check for zero fec_capability.

v2:
* Update documentation for rte_eth_fec_set() to fix review comments.
* Don't rename the fec_capa parameter of rte_eth_fec_get() but
  add a proper description instead.

Denis Pryazhennikov (3):
  ethdev: update documentation for API to set FEC
  ethdev: check that at least one FEC mode is specified
  ethdev: update documentation for API to get FEC

 lib/ethdev/rte_ethdev.c |  5 +++++
 lib/ethdev/rte_ethdev.h | 16 ++++++++--------
 2 files changed, 13 insertions(+), 8 deletions(-)