Skip to content

Commit

Permalink
ethdev: update documentation for API to set FEC
Browse files Browse the repository at this point in the history
[ upstream commit 6af24dc3794059373c2131ae776d55ac78724ffa ]

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.

Fixes: b7ccfb0 ("ethdev: introduce FEC API")

Signed-off-by: Denis Pryazhennikov <denis.pryazhennikov@arknetworks.am>
Acked-by: Ivan Malov <ivan.malov@arknetworks.am>
Acked-by: Viacheslav Galaktionov <viacheslav.galaktionov@arknetworks.am>
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
  • Loading branch information
okt-denispr authored and kevintraynor committed Jul 12, 2023
1 parent 1cf0bf4 commit d53afe6
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions lib/ethdev/rte_ethdev.h
Original file line number Diff line number Diff line change
Expand Up @@ -4057,10 +4057,13 @@ 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 with some FEC modes, 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).
* @return
* - (0) if successful.
* - (-EINVAL) if the FEC mode is not valid.
Expand Down

0 comments on commit d53afe6

Please sign in to comment.