[1/3] doc: add FEC in NIC features
Checks
Commit Message
From: "Min Hu (Connor)" <humin29@huawei.com>
Document FEC in NIC features, add information about FEC and add
implementation related support.
Cc: stable@dpdk.org
Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
Signed-off-by: Lijun Ou <oulijun@huawei.com>
---
doc/guides/nics/features.rst | 14 ++++++++++++++
doc/guides/nics/features/default.ini | 1 +
2 files changed, 15 insertions(+)
Comments
On 1/20/2021 1:43 PM, Lijun Ou wrote:
> From: "Min Hu (Connor)" <humin29@huawei.com>
>
> Document FEC in NIC features, add information about FEC and add
> implementation related support.
>
> Cc: stable@dpdk.org
>
> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
> Signed-off-by: Lijun Ou <oulijun@huawei.com>
> ---
> 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 cf82e9d..ded5c16 100644
> --- a/doc/guides/nics/features.rst
> +++ b/doc/guides/nics/features.rst
> @@ -926,6 +926,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()``.
> +
Feature doc looks good, thanks for adding this.
Can you add another patch in this series to update .ini files for hns3 & cxgbe
to advertise FEC feature?
> .. _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 ee786d3..562a681 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 =
> BSD nic_uio =
> Linux UIO =
> Linux VFIO =
>
"Linux UIO" etc renamed in this release, can you rebase on top of latest repo
please?
On 1/28/2021 12:20 AM, Ferruh Yigit wrote:
> On 1/20/2021 1:43 PM, Lijun Ou wrote:
>> From: "Min Hu (Connor)" <humin29@huawei.com>
>>
>> Document FEC in NIC features, add information about FEC and add
>> implementation related support.
>>
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
>> Signed-off-by: Lijun Ou <oulijun@huawei.com>
>> ---
>> 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 cf82e9d..ded5c16 100644
>> --- a/doc/guides/nics/features.rst
>> +++ b/doc/guides/nics/features.rst
>> @@ -926,6 +926,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()``.
>> +
>
> Feature doc looks good, thanks for adding this.
>
cc'ed Andrew too for comment.
> Can you add another patch in this series to update .ini files for hns3 & cxgbe
> to advertise FEC feature?
>
>> .. _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 ee786d3..562a681 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 =
>> BSD nic_uio =
>> Linux UIO =
>> Linux VFIO =
>>
>
> "Linux UIO" etc renamed in this release, can you rebase on top of latest repo
> please?
在 2021/1/28 8:20, Ferruh Yigit 写道:
> On 1/20/2021 1:43 PM, Lijun Ou wrote:
>> From: "Min Hu (Connor)" <humin29@huawei.com>
>>
>> Document FEC in NIC features, add information about FEC and add
>> implementation related support.
>>
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
>> Signed-off-by: Lijun Ou <oulijun@huawei.com>
>> ---
>> 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 cf82e9d..ded5c16 100644
>> --- a/doc/guides/nics/features.rst
>> +++ b/doc/guides/nics/features.rst
>> @@ -926,6 +926,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()``.
>> +
>
> Feature doc looks good, thanks for adding this.
>
> Can you add another patch in this series to update .ini files for hns3 &
> cxgbe to advertise FEC feature?
>
ok. I will do it in next version.
>> .. _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 ee786d3..562a681 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 =
>> BSD nic_uio =
>> Linux UIO =
>> Linux VFIO =
>>
>
> "Linux UIO" etc renamed in this release, can you rebase on top of latest
> repo please?
> .
>
28/01/2021 02:55, oulijun:
> >> +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()``.
> >> +
> >
> > Feature doc looks good, thanks for adding this.
> >
> > Can you add another patch in this series to update .ini files for hns3 &
> > cxgbe to advertise FEC feature?
> >
> ok. I will do it in next version.
I suppose updating drivers can be done in the same patch.
@@ -926,6 +926,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
@@ -65,6 +65,7 @@ Module EEPROM dump =
Registers dump =
LED =
Multiprocess aware =
+FEC =
BSD nic_uio =
Linux UIO =
Linux VFIO =