[09/33] doc: update hns3 guide
Checks
Commit Message
- Move "Link status event Pre-conditions" subsection under
"Prerequisites" section
- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Config File Options" section to "Compilation Options"
- Rename "Runtime Config Options" section to "Runtime Configuration"
Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
doc/guides/nics/hns3.rst | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
Comments
On 2023/3/22 7:59, Ferruh Yigit wrote:
> - Move "Link status event Pre-conditions" subsection under
> "Prerequisites" section
> - Rename "Pre-Installation Configuration" section to "Configuration"
> - Rename "Config File Options" section to "Compilation Options"
> - Rename "Runtime Config Options" section to "Runtime Configuration"
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
...
Hi Ferruh
Many thanks for your work.
On 2023/3/22 7:59, Ferruh Yigit wrote:
> - Move "Link status event Pre-conditions" subsection under
> "Prerequisites" section
> - Rename "Pre-Installation Configuration" section to "Configuration"
> - Rename "Config File Options" section to "Compilation Options"
> - Rename "Runtime Config Options" section to "Runtime Configuration"
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
Acked-by: Dongdong Liu <liudongdong3@huawei.com>
Thanks,
Dongdong
> ---
> doc/guides/nics/hns3.rst | 30 +++++++++++++++---------------
> 1 file changed, 15 insertions(+), 15 deletions(-)
>
> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
> index 791c9cc2ed49..5373ec5a8faf 100644
> --- a/doc/guides/nics/hns3.rst
> +++ b/doc/guides/nics/hns3.rst
> @@ -47,11 +47,21 @@ Prerequisites
> - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to
> setup the basic DPDK environment.
>
> +Link status event Pre-conditions
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> -Pre-Installation Configuration
> -------------------------------
> +Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
> +Therefore, to use the LSC for the PF driver, ensure that the firmware version
> +also supports reporting link changes.
> +If the VF driver needs to support LSC, special patch must be added:
> +`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
> +Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
> +
> +
> +Configuration
> +-------------
>
> -Config File Options
> +Compilation Options
> ~~~~~~~~~~~~~~~~~~~
>
> The following options can be modified in the ``config/rte_config.h`` file.
> @@ -60,8 +70,8 @@ The following options can be modified in the ``config/rte_config.h`` file.
>
> Number of MAX queues reserved for PF.
>
> -Runtime Config Options
> -~~~~~~~~~~~~~~~~~~~~~~
> +Runtime Configuration
> +~~~~~~~~~~~~~~~~~~~~~
>
> - ``rx_func_hint`` (default ``none``)
>
> @@ -130,16 +140,6 @@ Runtime Config Options
> For example::
> -a 0000:7d:00.0,mbx_time_limit_ms=600
>
> -Link status event Pre-conditions
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> -
> -Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
> -Therefore, to use the LSC for the PF driver, ensure that the firmware version
> -also supports reporting link changes.
> -If the VF driver needs to support LSC, special patch must be added:
> -`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
> -Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
> -
>
> Driver compilation and testing
> ------------------------------
>
@@ -47,11 +47,21 @@ Prerequisites
- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to
setup the basic DPDK environment.
+Link status event Pre-conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Pre-Installation Configuration
-------------------------------
+Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
+Therefore, to use the LSC for the PF driver, ensure that the firmware version
+also supports reporting link changes.
+If the VF driver needs to support LSC, special patch must be added:
+`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
+Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
+
+
+Configuration
+-------------
-Config File Options
+Compilation Options
~~~~~~~~~~~~~~~~~~~
The following options can be modified in the ``config/rte_config.h`` file.
@@ -60,8 +70,8 @@ The following options can be modified in the ``config/rte_config.h`` file.
Number of MAX queues reserved for PF.
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
- ``rx_func_hint`` (default ``none``)
@@ -130,16 +140,6 @@ Runtime Config Options
For example::
-a 0000:7d:00.0,mbx_time_limit_ms=600
-Link status event Pre-conditions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
-Therefore, to use the LSC for the PF driver, ensure that the firmware version
-also supports reporting link changes.
-If the VF driver needs to support LSC, special patch must be added:
-`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
-Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
-
Driver compilation and testing
------------------------------