diff mbox series

[v3,1/3] doc: add FEC in NIC features

Message ID 1611912125-18216-2-git-send-email-oulijun@huawei.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series update doc for hns3 |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Lijun Ou Jan. 29, 2021, 9:22 a.m. UTC 
  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")
Fixes: 9bf2ea8dbc65 ("net/hns3: support FEC")
Fixes: 62aafe035896 ("net/cxgbe: support configuring link FEC")
Cc: stable@dpdk.org

Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
Signed-off-by: Lijun Ou <oulijun@huawei.com>
---
V2->V3:
- merge patch 2 and patch 3 into patch 1 according to Thomas Monjalon's
  advice.
- fix format errors in hns3.ini and cxgbe.ini

V1->V2:
- add Fixes for indicating that the driver is updated synchronously.
---
 doc/guides/nics/features.rst         | 14 ++++++++++++++
 doc/guides/nics/features/cxgbe.ini   |  1 +
 doc/guides/nics/features/default.ini |  1 +
 doc/guides/nics/features/hns3.ini    |  1 +
 4 files changed, 17 insertions(+)
diff mbox series

Patch

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/cxgbe.ini b/doc/guides/nics/features/cxgbe.ini
index f913215..fea7d4d 100644
--- a/doc/guides/nics/features/cxgbe.ini
+++ b/doc/guides/nics/features/cxgbe.ini
@@ -28,6 +28,7 @@  Stats per queue      = Y
 EEPROM dump          = Y
 Registers dump       = Y
 Multiprocess aware   = Y
+FEC                  = Y
 FreeBSD              = Y
 Linux                = Y
 x86-32               = Y
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              =
diff --git a/doc/guides/nics/features/hns3.ini b/doc/guides/nics/features/hns3.ini
index a467396..452a7b5 100644
--- a/doc/guides/nics/features/hns3.ini
+++ b/doc/guides/nics/features/hns3.ini
@@ -39,5 +39,6 @@  Stats per queue      = Y
 FW version           = Y
 Registers dump       = Y
 Multiprocess aware   = Y
+FEC                  = Y
 Linux                = Y
 ARMv8                = Y