[6/6] doc: add link status event pre-conditions
Checks
Commit Message
From: Chengwen Feng <fengchengwen@huawei.com>
This patch adds link status event pre-conditions.
Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
---
doc/guides/nics/hns3.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
Comments
On 5/7/2021 10:08 AM, Min Hu (Connor) wrote:
> From: Chengwen Feng <fengchengwen@huawei.com>
>
> This patch adds link status event pre-conditions.
>
> Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
> ---
> doc/guides/nics/hns3.rst | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
> index 4439df5..c3aded8 100644
> --- a/doc/guides/nics/hns3.rst
> +++ b/doc/guides/nics/hns3.rst
> @@ -115,6 +115,16 @@ 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.
> +
I am not sure about documenting a not released kernel patch for the support,
what about waiting kernel release for support?
cc'ed more people for comment.
在 2021/5/12 0:14, Ferruh Yigit 写道:
> On 5/7/2021 10:08 AM, Min Hu (Connor) wrote:
>> From: Chengwen Feng <fengchengwen@huawei.com>
>>
>> This patch adds link status event pre-conditions.
>>
>> Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
>> ---
>> doc/guides/nics/hns3.rst | 10 ++++++++++
>> 1 file changed, 10 insertions(+)
>>
>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>> index 4439df5..c3aded8 100644
>> --- a/doc/guides/nics/hns3.rst
>> +++ b/doc/guides/nics/hns3.rst
>> @@ -115,6 +115,16 @@ 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.
>> +
>
> I am not sure about documenting a not released kernel patch for the support,
> what about waiting kernel release for support?
>
OK, I will send v2 after 5.13 kernel released, thanks.
> cc'ed more people for comment.
> .
>
在 2021/5/12 9:05, Min Hu (Connor) 写道:
>
>
> 在 2021/5/12 0:14, Ferruh Yigit 写道:
>> On 5/7/2021 10:08 AM, Min Hu (Connor) wrote:
>>> From: Chengwen Feng <fengchengwen@huawei.com>
>>>
>>> This patch adds link status event pre-conditions.
>>>
>>> Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
>>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
>>> ---
>>> doc/guides/nics/hns3.rst | 10 ++++++++++
>>> 1 file changed, 10 insertions(+)
>>>
>>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>>> index 4439df5..c3aded8 100644
>>> --- a/doc/guides/nics/hns3.rst
>>> +++ b/doc/guides/nics/hns3.rst
>>> @@ -115,6 +115,16 @@ 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>`_.
>>>
the patch has been merged.
>>> +Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
>>> +
>>
>> I am not sure about documenting a not released kernel patch for the
>> support,
>> what about waiting kernel release for support?
>>
Hi, Ferruh, all,
5.13 kernel has released:
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e
> OK, I will send v2 after 5.13 kernel released, thanks.
SO, I have sent v2, please check it. thanks.
>> cc'ed more people for comment.
>> .
>>
> .
@@ -115,6 +115,16 @@ 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
------------------------------