From 2bf5b0a8dfa64f336bd59aa807e5d576612627e6 Mon Sep 17 00:00:00 2001 From: Ferruh Yigit Date: Tue, 21 Mar 2023 23:59:09 +0000 Subject: doc: unify sections of networking drivers guide [ upstream commit b583b9a1bb49e86aa0937d55415713282000c536 ] - Move supported device to the top - Move supported features up - Move limitations down - Rename configuration sections - Fix section indentation - Remove empty sections - Remove contact info as this is duplication of maintainers file This patch just fix hns3 PMD because others PMDs are very conflicting. Signed-off-by: Ferruh Yigit Acked-by: Hyong Youb Kim Acked-by: Chengwen Feng Acked-by: Dongdong Liu Acked-by: Qi Zhang Acked-by: Simei Su Reviewed-by: Rosen Xu Acked-by: Cristian Dumitrescu Reviewed-by: Chenbo Xia Reviewed-by: Igor Russkikh Acked-by: Liron Himi Acked-by: Jerin Jacob Acked-by: Long Li Acked-by: Sachin Saxena --- 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 791c9cc2ed..5373ec5a8f 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 ` 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: +``_. +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: -``_. -Note: The patch has been uploaded to 5.13 of the Linux kernel mainline. - Driver compilation and testing ------------------------------ -- 2.23.0