From: Chengwen Feng <fengchengwen@huawei.com>
Date: Wed, 30 Jun 2021 01:56:23 +0000 (+0800)
Subject: doc: add link status event requirements in hns3 guide
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=80006b5987302111d78d3cf5017b0ff72dd17f77;p=dpdk.git

doc: add link status event requirements in hns3 guide

Add link status event pre-conditions in the driver documentation.

Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
---

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index cf72810375..6fbeccddba 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -115,6 +115,18 @@ Runtime Config Options
   For example::
   -a 0000:7d:00.0,dev_caps_mask=0xF
 
+
+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
 ------------------------------