From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1A401433E5; Mon, 27 Nov 2023 15:17:21 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AA42E40A80; Mon, 27 Nov 2023 15:17:04 +0100 (CET) Received: from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187]) by mails.dpdk.org (Postfix) with ESMTP id 0C2F540273 for ; Mon, 27 Nov 2023 15:17:00 +0100 (CET) Received: from kwepemm000004.china.huawei.com (unknown [172.30.72.54]) by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4Sf6xs6lSxzsRZc; Mon, 27 Nov 2023 22:13:21 +0800 (CST) Received: from localhost.localdomain (10.69.192.56) by kwepemm000004.china.huawei.com (7.193.23.18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Mon, 27 Nov 2023 22:16:57 +0800 From: Huisong Li To: , , , Dongdong Liu , Jie Hai , Chengwen Feng CC: , Subject: [PATCH v4 1/5] doc: fix the description of RSS related feature Date: Mon, 27 Nov 2023 22:16:55 +0800 Message-ID: <20231127141659.46600-2-lihuisong@huawei.com> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20231127141659.46600-1-lihuisong@huawei.com> References: <20231123135916.33315-1-lihuisong@huawei.com> <20231127141659.46600-1-lihuisong@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.69.192.56] X-ClientProxiedBy: dggems702-chm.china.huawei.com (10.3.19.179) To kwepemm000004.china.huawei.com (7.193.23.18) X-CFilter-Loop: Reflected X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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 Acked-by: Chengwen Feng --- doc/guides/nics/features.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 1a1dc16c1e..307dfc162e 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -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()``. -- 2.33.0