doc/mlx4: set limitation for RSS

Message ID 20231119132430.3666-1-rasland@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Raslan Darawsheh
Headers
Series doc/mlx4: set limitation for RSS |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/github-robot: build fail github build: failed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Raslan Darawsheh Nov. 19, 2023, 1:24 p.m. UTC
  This adds a limitation explanation on RSS queue usage
for MLX4 pmd.

MLX4 pmd requires a power of two queues to do RSS
but, the user can still open more queues which can be utilized
through flow API.

Signed-off-by: Raslan Darawsheh <rasland@nvidia.com>
---
 doc/guides/nics/mlx4.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
  

Comments

Thomas Monjalon Nov. 27, 2023, 11:27 a.m. UTC | #1
19/11/2023 14:24, Raslan Darawsheh:
> This adds a limitation explanation on RSS queue usage
> for MLX4 pmd.
> 
> MLX4 pmd requires a power of two queues to do RSS
> but, the user can still open more queues which can be utilized
> through flow API.
> 
> Signed-off-by: Raslan Darawsheh <rasland@nvidia.com>

Applied with few indent fixes, thanks.
  

Patch

diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index c6279f51d0..f59e52a671 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -145,6 +145,18 @@  Limitations
 - TSO (Transmit Segmentation Offload) is supported in OFED version
   4.4 and above.
 
+- RSS only works on power of two number of queues.
+- The user can open none power of two queues,  but the PMD will round down
+  to the highest power of two queues by default for RSS.
+  Other queues can be utilized through flow API.
+  example::
+      ./dpdk-testpmd -a 08:00.0 -- -i --rxq 12 --txq 12 --rss-ip
+
+  The first 8 queues will be used by default for RSS over IP.
+  The rest of the queues can be utilized through rte flow like the following::
+  flow create 0 ingress pattern eth / ipv4 / tcp / end actions rss queues 8 9 10 11 end / end
+
+
 Prerequisites
 -------------