doc: update virtio prog guide with new feature list

Message ID 20250304174236.280764-1-kshankar@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Maxime Coquelin
Headers
Series doc: update virtio prog guide with new feature list |

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 success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS

Commit Message

Kommula Shiva Shankar March 4, 2025, 5:42 p.m. UTC
This patch adds newly added virtio hash report feature
to prog guide.

Signed-off-by: Kommula Shiva Shankar <kshankar@marvell.com>
---
 doc/guides/nics/virtio.rst | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

Maxime Coquelin March 12, 2025, 1:51 p.m. UTC | #1
On 3/4/25 6:42 PM, Kommula Shiva Shankar wrote:
> This patch adds newly added virtio hash report feature
> to prog guide.
> 
> Signed-off-by: Kommula Shiva Shankar <kshankar@marvell.com>
> ---
>   doc/guides/nics/virtio.rst | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index c22ce56a02..0615abfaaf 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -56,6 +56,7 @@ In this release, the virtio PMD provides the basic functionality of packet recep
>       command line. Note that, mac/vlan filter is best effort: unwanted packets could still arrive.
>   
>   *   "RTE_PKTMBUF_HEADROOM" should be defined
> +    no less than "sizeof(struct virtio_net_hdr_hash_report)", which is 20 bytes when using hash report or
>       no less than "sizeof(struct virtio_net_hdr_mrg_rxbuf)", which is 12 bytes when mergeable or
>       "VIRTIO_F_VERSION_1" is set.
>       no less than "sizeof(struct virtio_net_hdr)", which is 10 bytes, when using non-mergeable.
> @@ -68,6 +69,8 @@ In this release, the virtio PMD provides the basic functionality of packet recep
>   
>   *   Virtio supports software vlan stripping and inserting.
>   
> +*   Virtio supports hash report feature in packed queue mode.
> +
>   *   Virtio supports using port IO to get PCI resource when UIO module is not available.
>   
>   *   Virtio supports RSS Rx mode with 40B configurable hash key length, 128

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
  
Maxime Coquelin March 12, 2025, 2:52 p.m. UTC | #2
On 3/4/25 6:42 PM, Kommula Shiva Shankar wrote:
> This patch adds newly added virtio hash report feature
> to prog guide.
> 
> Signed-off-by: Kommula Shiva Shankar <kshankar@marvell.com>
> ---
>   doc/guides/nics/virtio.rst | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index c22ce56a02..0615abfaaf 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -56,6 +56,7 @@ In this release, the virtio PMD provides the basic functionality of packet recep
>       command line. Note that, mac/vlan filter is best effort: unwanted packets could still arrive.
>   
>   *   "RTE_PKTMBUF_HEADROOM" should be defined
> +    no less than "sizeof(struct virtio_net_hdr_hash_report)", which is 20 bytes when using hash report or
>       no less than "sizeof(struct virtio_net_hdr_mrg_rxbuf)", which is 12 bytes when mergeable or
>       "VIRTIO_F_VERSION_1" is set.
>       no less than "sizeof(struct virtio_net_hdr)", which is 10 bytes, when using non-mergeable.
> @@ -68,6 +69,8 @@ In this release, the virtio PMD provides the basic functionality of packet recep
>   
>   *   Virtio supports software vlan stripping and inserting.
>   
> +*   Virtio supports hash report feature in packed queue mode.
> +
>   *   Virtio supports using port IO to get PCI resource when UIO module is not available.
>   
>   *   Virtio supports RSS Rx mode with 40B configurable hash key length, 128

Applied to next-virtio.

Thanks,
Maxime
  

Patch

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index c22ce56a02..0615abfaaf 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -56,6 +56,7 @@  In this release, the virtio PMD provides the basic functionality of packet recep
     command line. Note that, mac/vlan filter is best effort: unwanted packets could still arrive.
 
 *   "RTE_PKTMBUF_HEADROOM" should be defined
+    no less than "sizeof(struct virtio_net_hdr_hash_report)", which is 20 bytes when using hash report or
     no less than "sizeof(struct virtio_net_hdr_mrg_rxbuf)", which is 12 bytes when mergeable or
     "VIRTIO_F_VERSION_1" is set.
     no less than "sizeof(struct virtio_net_hdr)", which is 10 bytes, when using non-mergeable.
@@ -68,6 +69,8 @@  In this release, the virtio PMD provides the basic functionality of packet recep
 
 *   Virtio supports software vlan stripping and inserting.
 
+*   Virtio supports hash report feature in packed queue mode.
+
 *   Virtio supports using port IO to get PCI resource when UIO module is not available.
 
 *   Virtio supports RSS Rx mode with 40B configurable hash key length, 128