doc: add FEC to NIC features
authorMin Hu (Connor) <humin29@huawei.com>
Fri, 29 Jan 2021 09:22:03 +0000 (17:22 +0800)
committerFerruh Yigit <ferruh.yigit@intel.com>
Wed, 3 Feb 2021 09:42:11 +0000 (10:42 +0100)
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>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
doc/guides/nics/features.rst
doc/guides/nics/features/cxgbe.ini
doc/guides/nics/features/default.ini
doc/guides/nics/features/hns3.ini

index 59beb47..e9bb553 100644 (file)
@@ -518,6 +518,21 @@ Supports QinQ (queue in queue) offload.
   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``.
 
 
+.. _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_l3_checksum_offload:
 
 L3 checksum offload
index f913215..276879e 100644 (file)
@@ -20,6 +20,7 @@ Flow control         = Y
 Flow API             = Y
 CRC offload          = Y
 VLAN offload         = Y
+FEC                  = Y
 L3 checksum offload  = Y
 L4 checksum offload  = Y
 Packet type parsing  = Y
index 8d89278..8046bd1 100644 (file)
@@ -46,6 +46,7 @@ Inline protocol      =
 CRC offload          =
 VLAN offload         =
 QinQ offload         =
+FEC                  =
 L3 checksum offload  =
 L4 checksum offload  =
 Timestamp offload    =
index a467396..ef432af 100644 (file)
@@ -28,6 +28,7 @@ Flow control         = Y
 Flow API             = Y
 CRC offload          = Y
 VLAN offload         = Y
+FEC                  = Y
 L3 checksum offload  = Y
 L4 checksum offload  = Y
 Inner L3 checksum    = Y