[v4,7/7] net/gve: update GVE documentation with RSS support

Message ID 20240126173317.2779230-8-joshwash@google.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series [v4,1/7] net/gve: fully expose RSS offload support in dev_info |

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/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-compile-amd64-testing fail Testing issues
ci/iol-sample-apps-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Joshua Washington Jan. 26, 2024, 5:33 p.m. UTC
  This patch updates the GVE doc page to communicate that GVE now supports
RSS configuration and explains the limitations.

Signed-off-by: Joshua Washington <joshwash@google.com>
---
 doc/guides/nics/gve.rst | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)
  

Comments

Ferruh Yigit Jan. 31, 2024, 2:50 p.m. UTC | #1
On 1/26/2024 5:33 PM, Joshua Washington wrote:
> This patch updates the GVE doc page to communicate that GVE now supports
> RSS configuration and explains the limitations.
> 
> Signed-off-by: Joshua Washington <joshwash@google.com>
> ---
>  doc/guides/nics/gve.rst | 16 ++++++++++------
>  1 file changed, 10 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/nics/gve.rst b/doc/guides/nics/gve.rst
> index 1c3eaf03ef..80991e70cf 100644
> --- a/doc/guides/nics/gve.rst
> +++ b/doc/guides/nics/gve.rst
> @@ -70,6 +70,8 @@ Supported features of the GVE PMD are:
>  - Link state information
>  - Tx multi-segments (Scatter Tx)
>  - Tx UDP/TCP/SCTP Checksum
> +- RSS hash configuration
> +- RSS redirection table update and query
>  
>  Currently, only GQI_QPL and GQI_RDA queue format are supported in PMD.
>  Jumbo Frame is not supported in PMD for now.
> @@ -77,10 +79,12 @@ It'll be added in a future DPDK release.
>  Also, only GQI_QPL queue format is in use on GCP
>  since GQI_RDA hasn't been released in production.
>  
> -Currently, setting MTU with value larger than 1460 is not supported.
> +RSS
> +^^^
>  
> -Currently, only "RSS hash" is force enabled
> -so that the backend hardware device calculated hash values
> -could be shared with applications.
> -But for RSS, there is no such API to config RSS hash function or RETA table.
> -So, limited RSS is supported only with default config/setting.
> +GVE RSS can be enabled and configured using the standard interfaces. The driver
> +does not support querying the initial RSS configuration.
> +
> +The RSS hash key must be exactly 40 bytes, and the redirection table must have
> +128 entries. The RSS hash key must be configured before the redirection table
> +can be set up.
>

Similarly can you please update documentation on each relevant patch,
instead of having a separate documentation patch.
  

Patch

diff --git a/doc/guides/nics/gve.rst b/doc/guides/nics/gve.rst
index 1c3eaf03ef..80991e70cf 100644
--- a/doc/guides/nics/gve.rst
+++ b/doc/guides/nics/gve.rst
@@ -70,6 +70,8 @@  Supported features of the GVE PMD are:
 - Link state information
 - Tx multi-segments (Scatter Tx)
 - Tx UDP/TCP/SCTP Checksum
+- RSS hash configuration
+- RSS redirection table update and query
 
 Currently, only GQI_QPL and GQI_RDA queue format are supported in PMD.
 Jumbo Frame is not supported in PMD for now.
@@ -77,10 +79,12 @@  It'll be added in a future DPDK release.
 Also, only GQI_QPL queue format is in use on GCP
 since GQI_RDA hasn't been released in production.
 
-Currently, setting MTU with value larger than 1460 is not supported.
+RSS
+^^^
 
-Currently, only "RSS hash" is force enabled
-so that the backend hardware device calculated hash values
-could be shared with applications.
-But for RSS, there is no such API to config RSS hash function or RETA table.
-So, limited RSS is supported only with default config/setting.
+GVE RSS can be enabled and configured using the standard interfaces. The driver
+does not support querying the initial RSS configuration.
+
+The RSS hash key must be exactly 40 bytes, and the redirection table must have
+128 entries. The RSS hash key must be configured before the redirection table
+can be set up.