From: "Min Hu (Connor)" humin29@huawei.com
Document FEC in NIC features, add information about FEC and add implementation related support.
Fixes: b7ccfb09da95 ("ethdev: introduce FEC API") Cc: stable@dpdk.org
Signed-off-by: Min Hu (Connor) humin29@huawei.com Signed-off-by: Lijun Ou oulijun@huawei.com --- V1->V2: - Add Fixes for indicating that the driver is updated synchronously. --- doc/guides/nics/features.rst | 14 ++++++++++++++ doc/guides/nics/features/default.ini | 1 + 2 files changed, 15 insertions(+)
diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 59beb47..fed98bf 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -908,6 +908,20 @@ Supports to get Rx/Tx packet burst mode information. * **[implements] eth_dev_ops**: ``rx_burst_mode_get``, ``tx_burst_mode_get``. * **[related] API**: ``rte_eth_rx_burst_mode_get()``, ``rte_eth_tx_burst_mode_get()``.
+.. _nic_features_fec: + +FEC +--- + +Supports Forward error correction. Forward error correction (FEC) is a bit error correction mode. +It adds error correction information to data packets at the transmit end, and uses the error correction +information to correct the bit errors generated during data packet transmission at the receive end. This +improves signal quality but also brings a delay to signals. This function can be enabled or disabled as required. + +* **[implements] eth_dev_ops**: ``fec_get_capability``, ``fec_get``, ``fec_set``. +* **[provides] rte_eth_fec_capa**: ``speed:ETH_SPEED_NUM_*``, ``capa:RTE_ETH_FEC_MODE_TO_CAPA()``. +* **[related] API**: ``rte_eth_fec_get_capability()``, ``rte_eth_fec_get()``, ``rte_eth_fec_set()``. + .. _nic_features_other:
Other dev ops not represented by a Feature diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini index 8d89278..f0d89da 100644 --- a/doc/guides/nics/features/default.ini +++ b/doc/guides/nics/features/default.ini @@ -65,6 +65,7 @@ Module EEPROM dump = Registers dump = LED = Multiprocess aware = +FEC = FreeBSD = Linux = Windows =