From 553a6b4c40f9cfd4e0b36cbce53cbd17079061f9 Mon Sep 17 00:00:00 2001 From: Huisong Li Date: Tue, 28 Nov 2023 13:59:25 +0800 Subject: [PATCH 408/410] doc: fix description of RSS features [ upstream commit 46aa6b3cfca8818b8641026274c0a778f2e38a70 ] This patch fixes the description of RSS feature. And the setting 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 Acked-by: Chengwen Feng Acked-by: Ferruh Yigit --- doc/guides/nics/features.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index dba985a105..9f2da6ac0c 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -276,10 +276,20 @@ 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**: ``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()``. + +Supports 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: @@ -287,7 +297,7 @@ Supports RSS hashing on RX. Inner RSS --------- -Supports RX RSS hashing on Inner headers. +Supports RSS hashing on inner headers with flow API. * **[uses] rte_flow_action_rss**: ``level``. * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:RTE_ETH_RX_OFFLOAD_RSS_HASH``. @@ -302,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()``. -- 2.33.0