From: Min Hu (Connor) Date: Fri, 29 Jan 2021 09:22:03 +0000 (+0800) Subject: doc: add FEC to NIC features X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=fa5dbd825af232e99e82a6de8ea55540c8a07191;p=dpdk.git doc: add FEC to NIC features 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) Signed-off-by: Lijun Ou Reviewed-by: Ferruh Yigit --- diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 59beb47316..e9bb55376e 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -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 diff --git a/doc/guides/nics/features/cxgbe.ini b/doc/guides/nics/features/cxgbe.ini index f91321504f..276879ec1a 100644 --- a/doc/guides/nics/features/cxgbe.ini +++ b/doc/guides/nics/features/cxgbe.ini @@ -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 diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini index 8d89278479..8046bd121e 100644 --- a/doc/guides/nics/features/default.ini +++ b/doc/guides/nics/features/default.ini @@ -46,6 +46,7 @@ Inline protocol = CRC offload = VLAN offload = QinQ offload = +FEC = L3 checksum offload = L4 checksum offload = Timestamp offload = diff --git a/doc/guides/nics/features/hns3.ini b/doc/guides/nics/features/hns3.ini index a46739678f..ef432aff2a 100644 --- a/doc/guides/nics/features/hns3.ini +++ b/doc/guides/nics/features/hns3.ini @@ -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