[v4,1/5] doc: fix the description of RSS related feature
Checks
Commit Message
This patch fixes the description of RSS feature.
And the settinf ot hash algorithm is introduced by 23.11, so add it.
Fixes: 34ff088cc241 ("ethdev: set and query RSS hash algorithm")
Signed-off-by: Huisong Li <lihuisong@huawei.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
---
doc/guides/nics/features.rst | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
Comments
On 11/27/2023 2:16 PM, Huisong Li wrote:
> This patch fixes the description of RSS feature.
> And the settinf ot hash algorithm is introduced by 23.11, so add it.
>
> Fixes: 34ff088cc241 ("ethdev: set and query RSS hash algorithm")
>
> Signed-off-by: Huisong Li <lihuisong@huawei.com>
> Acked-by: Chengwen Feng <fengchengwen@huawei.com>
>
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
@@ -277,10 +277,19 @@ RSS hash
Supports RSS hashing on RX.
* **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``RTE_ETH_MQ_RX_RSS_FLAG``.
-* **[uses] user config**: ``dev_conf.rx_adv_conf.rss_conf``.
+* **[uses] user config**: ``dev_conf.rx_adv_conf.rss_conf.rss_hf``. ``rss_conf.rss_hf``
* **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:RTE_ETH_RX_OFFLOAD_RSS_HASH``.
* **[provides] rte_eth_dev_info**: ``flow_type_rss_offloads``.
* **[provides] mbuf**: ``mbuf.ol_flags:RTE_MBUF_F_RX_RSS_HASH``, ``mbuf.rss``.
+* **[related] API**: ``rte_eth_dev_configure()``, ``rte_eth_dev_rss_hash_update``
+ ``rte_eth_dev_rss_hash_conf_get()``.
+
+Support RSS hash algorithm on Rx.
+* **[implements] eth_dev_ops**: ``dev_configure``, ``rss_hash_update``, ``rss_hash_conf_get``.
+* **[uses] user config**: ``rss_conf.algorithm``
+* **[provides] rte_eth_dev_info**: ``rss_algo_capa``.
+* **[related] API**: ``rte_eth_dev_configure()``, ``rte_eth_dev_rss_hash_update()``,
+ ``rte_eth_dev_rss_hash_conf_get()``.
.. _nic_features_inner_rss:
@@ -288,7 +297,7 @@ Supports RSS hashing on RX.
Inner RSS
---------
-Supports RX RSS hashing on Inner headers.
+Supports RX RSS hashing on Inner headers by rte_flow API.
* **[uses] rte_flow_action_rss**: ``level``.
* **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:RTE_ETH_RX_OFFLOAD_RSS_HASH``.
@@ -303,9 +312,10 @@ RSS key update
Supports configuration of Receive Side Scaling (RSS) hash computation. Updating
Receive Side Scaling (RSS) hash key.
-* **[implements] eth_dev_ops**: ``rss_hash_update``, ``rss_hash_conf_get``.
+* **[implements] eth_dev_ops**: ``dev_configure``, ``rss_hash_update``, ``rss_hash_conf_get``.
+* **[uses] user config**: ``rss_conf.rss_key``, ``rss_conf.rss_key_len``
* **[provides] rte_eth_dev_info**: ``hash_key_size``.
-* **[related] API**: ``rte_eth_dev_rss_hash_update()``,
+* **[related] API**: ``rte_eth_dev_configure()``, ``rte_eth_dev_rss_hash_update()``,
``rte_eth_dev_rss_hash_conf_get()``.