[PATCH 0/3] doc/hns3: fix hns3 doc

[PATCH 0/3] doc/hns3: fix hns3 doc

[Huisong Li]

This series fix some feature description and update features for hns3.

Hope this series merge into 23.11.

Huisong Li (3):
  doc/hns3: fix compilation option about max queue number
  doc/hns3: update the features for hns3
  doc/hns3: fix the usage description for RSS flow

 doc/guides/nics/hns3.rst | 55 ++++++++++++++++++++++++++++------------
 1 file changed, 39 insertions(+), 16 deletions(-)

-- 
2.33.0

[PATCH 1/3] doc/hns3: fix compilation option about max queue number

[Huisong Li]

This patch fixes the description of compilation option about setting max
queue number. The maximum queue number of HIP09 and HIP10 is determined by
the RTE_LIBRTE_HNS3_MAX_TQP_NUM_PER_PF and the value the firmware report.

Fixes: 21938cf4e43e ("doc: add build config option in hns3 guide")
Cc: stable@dpdk.org

Signed-off-by: Huisong Li <lihuisong@huawei.com>
---
 doc/guides/nics/hns3.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index ee774639d3..7eac1b3c92 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -69,7 +69,8 @@ The following options can be modified in the ``config/rte_config.h`` file.
 
 - ``RTE_LIBRTE_HNS3_MAX_TQP_NUM_PER_PF`` (default ``256``)
 
-  Number of MAX queues reserved for PF.
+  Number of MAX queues reserved for PF on HIP09 and HIP10. The MAX queue
+  number is also determined by the value the firmware report.
 
 Runtime Configuration
 ~~~~~~~~~~~~~~~~~~~~~
-- 
2.33.0

[PATCH 2/3] doc/hns3: update the features for hns3

[Huisong Li]

Update the features for hns3.

Signed-off-by: Huisong Li <lihuisong@huawei.com>
---
 doc/guides/nics/hns3.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 7eac1b3c92..11d0c04884 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
 - DCB
 - Scattered and gather for TX and RX
 - Vector Poll mode driver
-- Dump register
 - SR-IOV VF
 - Multi-process
 - MAC/VLAN filter
@@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
 - NUMA support
 - Generic flow API
 - IEEE1588/802.1AS timestamping
+- Basic stats
+- Extended stats
+- Traffic Management API
+- Speed capabilities
+- Link Auto-negotiation
+- Link flow control
+- Dump register
+- Dump private info from device
+- FW version
 
 Prerequisites
 -------------
-- 
2.33.0

Re: [PATCH 2/3] doc/hns3: update the features for hns3

[Ferruh Yigit]

On 11/20/2023 7:55 AM, Huisong Li wrote:
> Update the features for hns3.
> 
> Signed-off-by: Huisong Li <lihuisong@huawei.com>
> ---
>  doc/guides/nics/hns3.rst | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
> index 7eac1b3c92..11d0c04884 100644
> --- a/doc/guides/nics/hns3.rst
> +++ b/doc/guides/nics/hns3.rst
> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>  - DCB
>  - Scattered and gather for TX and RX
>  - Vector Poll mode driver
> -- Dump register
>  - SR-IOV VF
>  - Multi-process
>  - MAC/VLAN filter
> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>  - NUMA support
>  - Generic flow API
>  - IEEE1588/802.1AS timestamping
> +- Basic stats
> +- Extended stats
> +- Traffic Management API
> +- Speed capabilities
> +- Link Auto-negotiation
> +- Link flow control
> +- Dump register
> +- Dump private info from device
> +- FW version
>  

Hi Huisong,

Can you please add fixes tag for each feature, to let track the relevant
code commit with claimed feature support?

Re: [PATCH 2/3] doc/hns3: update the features for hns3

[lihuisong (C)]

在 2023/11/20 17:56, Ferruh Yigit 写道:
> On 11/20/2023 7:55 AM, Huisong Li wrote:
>> Update the features for hns3.
>>
>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>> ---
>>   doc/guides/nics/hns3.rst | 10 +++++++++-
>>   1 file changed, 9 insertions(+), 1 deletion(-)
>>
>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>> index 7eac1b3c92..11d0c04884 100644
>> --- a/doc/guides/nics/hns3.rst
>> +++ b/doc/guides/nics/hns3.rst
>> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>>   - DCB
>>   - Scattered and gather for TX and RX
>>   - Vector Poll mode driver
>> -- Dump register
>>   - SR-IOV VF
>>   - Multi-process
>>   - MAC/VLAN filter
>> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>>   - NUMA support
>>   - Generic flow API
>>   - IEEE1588/802.1AS timestamping
>> +- Basic stats
>> +- Extended stats
>> +- Traffic Management API
>> +- Speed capabilities
>> +- Link Auto-negotiation
>> +- Link flow control
>> +- Dump register
>> +- Dump private info from device
>> +- FW version
>>   
> Hi Huisong,
>
> Can you please add fixes tag for each feature, to let track the relevant
> code commit with claimed feature support?
Thanks for your advice.
Put fixes tag of each feature commit in the commit log of this patch, right?
Do we need to Cc stable?
>
>
> .

Re: [PATCH 2/3] doc/hns3: update the features for hns3

[Ferruh Yigit]

On 11/20/2023 10:48 AM, lihuisong (C) wrote:
> 
> 在 2023/11/20 17:56, Ferruh Yigit 写道:
>> On 11/20/2023 7:55 AM, Huisong Li wrote:
>>> Update the features for hns3.
>>>
>>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>>> ---
>>>   doc/guides/nics/hns3.rst | 10 +++++++++-
>>>   1 file changed, 9 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>>> index 7eac1b3c92..11d0c04884 100644
>>> --- a/doc/guides/nics/hns3.rst
>>> +++ b/doc/guides/nics/hns3.rst
>>> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>>>   - DCB
>>>   - Scattered and gather for TX and RX
>>>   - Vector Poll mode driver
>>> -- Dump register
>>>   - SR-IOV VF
>>>   - Multi-process
>>>   - MAC/VLAN filter
>>> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>>>   - NUMA support
>>>   - Generic flow API
>>>   - IEEE1588/802.1AS timestamping
>>> +- Basic stats
>>> +- Extended stats
>>> +- Traffic Management API
>>> +- Speed capabilities
>>> +- Link Auto-negotiation
>>> +- Link flow control
>>> +- Dump register
>>> +- Dump private info from device
>>> +- FW version
>>>   
>> Hi Huisong,
>>
>> Can you please add fixes tag for each feature, to let track the relevant
>> code commit with claimed feature support?
> Thanks for your advice.
> Put fixes tag of each feature commit in the commit log of this patch,
> right?
>

Like for "Basic stats", add commit that introduces basic stats as fixes
line, same for each feature added above.


> Do we need to Cc stable?
>

For this case, main purpose for above fixes tags is to provide back
trace from document to the code,
but adding 'stable' tag enables backporting this document patch to LTS
release, which doesn't hurt, so please add stable tag too.

Re: [PATCH 2/3] doc/hns3: update the features for hns3

[lihuisong (C)]

在 2023/11/20 18:53, Ferruh Yigit 写道:
> On 11/20/2023 10:48 AM, lihuisong (C) wrote:
>> 在 2023/11/20 17:56, Ferruh Yigit 写道:
>>> On 11/20/2023 7:55 AM, Huisong Li wrote:
>>>> Update the features for hns3.
>>>>
>>>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>>>> ---
>>>>    doc/guides/nics/hns3.rst | 10 +++++++++-
>>>>    1 file changed, 9 insertions(+), 1 deletion(-)
>>>>
>>>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>>>> index 7eac1b3c92..11d0c04884 100644
>>>> --- a/doc/guides/nics/hns3.rst
>>>> +++ b/doc/guides/nics/hns3.rst
>>>> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>>>>    - DCB
>>>>    - Scattered and gather for TX and RX
>>>>    - Vector Poll mode driver
>>>> -- Dump register
>>>>    - SR-IOV VF
>>>>    - Multi-process
>>>>    - MAC/VLAN filter
>>>> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>>>>    - NUMA support
>>>>    - Generic flow API
>>>>    - IEEE1588/802.1AS timestamping
>>>> +- Basic stats
>>>> +- Extended stats
>>>> +- Traffic Management API
>>>> +- Speed capabilities
>>>> +- Link Auto-negotiation
>>>> +- Link flow control
>>>> +- Dump register
>>>> +- Dump private info from device
>>>> +- FW version
>>>>    
>>> Hi Huisong,
>>>
>>> Can you please add fixes tag for each feature, to let track the relevant
>>> code commit with claimed feature support?
>> Thanks for your advice.
>> Put fixes tag of each feature commit in the commit log of this patch,
>> right?
>>
> Like for "Basic stats", add commit that introduces basic stats as fixes
> line, same for each feature added above.
ok
>
>
>> Do we need to Cc stable?
>>
> For this case, main purpose for above fixes tags is to provide back
> trace from document to the code,
> but adding 'stable' tag enables backporting this document patch to LTS
> release, which doesn't hurt, so please add stable tag too.
all right, many thanks for you.
> .

[PATCH 3/3] doc/hns3: fix the usage description for RSS flow

[Huisong Li]

The hns3 driver supports for creating rule base on input tuple, hash key,
queues and hash algorithm. But hash key, queues and hash algorithm are the
global configuration for hardware which will affect other rules. The rule
just setting input tuple is completely independent.

Fixes: 63a0f65c9572 ("doc: add more description in hns3 guide")
Cc: stable@dpdk.org

Signed-off-by: Huisong Li <lihuisong@huawei.com>
---
 doc/guides/nics/hns3.rst | 42 ++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 11d0c04884..e260b301a8 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -239,36 +239,50 @@ Generic flow API
 
 - ``RSS Flow``
 
-  RSS Flow supports to set hash input set, hash function, enable hash
-  and configure queues.
-  For example:
-  Configure queues as queue 0, 1, 2, 3.
+  RSS Flow supports for creating rule base on input tuple, hash key, queues
+  and hash algorithm. But hash key, queues and hash algorithm are the global
+  configuration for hardware which will affect other rules. The rule just
+  setting input tuple is completely independent.
+
+  Run ``testpmd``:
 
   .. code-block:: console
 
-    testpmd> flow create 0 ingress pattern end actions rss types end \
-      queues 0 1 2 3 end / end
+    dpdk-testpmd -a 0000:7d:00.0 -l 10-18 -- -i --rxq=8 --txq=8
+
+  All IP packets can be distributed to 8 queues.
 
-  Enable hash and set input set for IPv4-TCP.
+  Set ipv4-tcp packet is distributed to 8 queues based on L3/L4 SRC only.
 
   .. code-block:: console
 
-    testpmd> flow create 0 ingress pattern eth / ipv4 / tcp / end \
-      actions rss types ipv4-tcp l3-src-only end queues end / end
+    testpmd> flow create 0 ingress pattern eth / ipv4 / tcp / end actions \
+             rss types ipv4-tcp l4-src-only l3-src-only end queues end / end
 
-  Set symmetric hash enable for flow type IPv4-TCP.
+  Disable ipv4 packet RSS hash.
 
   .. code-block:: console
 
-    testpmd> flow create 0 ingress pattern eth / ipv4 / tcp / end \
-      actions rss types ipv4-tcp end queues end func symmetric_toeplitz / end
+    testpmd> flow create 0 ingress pattern eth / ipv4 / end actions rss \
+             types none end queues end / end
 
-  Set hash function as simple xor.
+  Set hash function as symmetric toeplitz.
 
   .. code-block:: console
 
     testpmd> flow create 0 ingress pattern end actions rss types end \
-      queues end func simple_xor / end
+             queues end func symmetric_toeplitz / end
+
+  In this case, all packets that enabled RSS are hashed using symmetric
+  toeplitz algorithm.
+
+  Flush all RSS rules
+
+  .. code-block:: console
+
+    testpmd> flow flush 0
+
+  The RSS configurations of hardwre is back to the one ethdev ops set.
 
 Statistics
 ----------
-- 
2.33.0

Re: [PATCH 0/3] doc/hns3: fix hns3 doc

[Ferruh Yigit]

On 11/20/2023 7:54 AM, Huisong Li wrote:
> This series fix some feature description and update features for hns3.
> 
> Hope this series merge into 23.11.
> 
> Huisong Li (3):
>   doc/hns3: fix compilation option about max queue number
>   doc/hns3: update the features for hns3
>   doc/hns3: fix the usage description for RSS flow
> 

Except 2/3, rest looks good to me, I will wait maintainers ack to proceed.