From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2FF78A09E4; Fri, 29 Jan 2021 10:22:56 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C5D62240149; Fri, 29 Jan 2021 10:22:38 +0100 (CET) Received: from szxga04-in.huawei.com (szxga04-in.huawei.com [45.249.212.190]) by mails.dpdk.org (Postfix) with ESMTP id 0F5C0240137 for ; Fri, 29 Jan 2021 10:22:34 +0100 (CET) Received: from DGGEMS407-HUB.china.huawei.com (unknown [172.30.72.58]) by szxga04-in.huawei.com (SkyGuard) with ESMTP id 4DRsJp5sGnzl9kh; Fri, 29 Jan 2021 17:20:58 +0800 (CST) Received: from localhost.localdomain (10.69.192.56) by DGGEMS407-HUB.china.huawei.com (10.3.19.207) with Microsoft SMTP Server id 14.3.498.0; Fri, 29 Jan 2021 17:22:27 +0800 From: Lijun Ou To: , , CC: , Date: Fri, 29 Jan 2021 17:22:03 +0800 Message-ID: <1611912125-18216-2-git-send-email-oulijun@huawei.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1611912125-18216-1-git-send-email-oulijun@huawei.com> References: <1611837805-42429-1-git-send-email-oulijun@huawei.com> <1611912125-18216-1-git-send-email-oulijun@huawei.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [10.69.192.56] X-CFilter-Loop: Reflected Subject: [dpdk-dev] [PATCH v3 1/3] doc: add FEC in NIC features X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: "Min Hu (Connor)" 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 --- 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 --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 -- 2.7.4