doc: update CNXK event device guide

Message ID 20230301112918.1057-1-pbhagavatula@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series doc: update CNXK event device guide |

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/intel-Functional success Functional PASS
ci/iol-testing warning apply patch failure

Commit Message

Pavan Nikhilesh Bhagavatula March 1, 2023, 11:29 a.m. UTC
  From: Pavan Nikhilesh <pbhagavatula@marvell.com>

Update CNXK event device guide to include WQE stashing parameters
that are enabled by default.

Fixes: ca88db3ae76d ("event/cnxk: support WQE stashing ")

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
 Please squash

 doc/guides/eventdevs/cnxk.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--
2.25.1
  

Comments

Jerin Jacob March 3, 2023, 2:54 p.m. UTC | #1
On Wed, Mar 1, 2023 at 5:05 PM <pbhagavatula@marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
>
> Update CNXK event device guide to include WQE stashing parameters
> that are enabled by default.
>
> Fixes: ca88db3ae76d ("event/cnxk: support WQE stashing ")

Squashed with above patch and merged to next-eventdev

>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> ---
>  Please squash
>
>  doc/guides/eventdevs/cnxk.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/eventdevs/cnxk.rst b/doc/guides/eventdevs/cnxk.rst
> index c3c0bfd7b5..1a59233282 100644
> --- a/doc/guides/eventdevs/cnxk.rst
> +++ b/doc/guides/eventdevs/cnxk.rst
> @@ -109,7 +109,8 @@ Runtime Config Options
>    is configurable per HWGRP i.e. event queue. The dictionary format is as
>    follows `[Qx|stash_offset|stash_length]` here the stash offset can be
>    a negative integer.
> -  By default stashing is not enabled.
> +  By default, stashing is enabled on queues which have been connected to
> +  Rx adapter. Both MBUF and NIX_RX_WQE_HDR + NIX_RX_PARSE_S are stashed.
>
>    For example::
>
> --
> 2.25.1
>
  

Patch

diff --git a/doc/guides/eventdevs/cnxk.rst b/doc/guides/eventdevs/cnxk.rst
index c3c0bfd7b5..1a59233282 100644
--- a/doc/guides/eventdevs/cnxk.rst
+++ b/doc/guides/eventdevs/cnxk.rst
@@ -109,7 +109,8 @@  Runtime Config Options
   is configurable per HWGRP i.e. event queue. The dictionary format is as
   follows `[Qx|stash_offset|stash_length]` here the stash offset can be
   a negative integer.
-  By default stashing is not enabled.
+  By default, stashing is enabled on queues which have been connected to
+  Rx adapter. Both MBUF and NIX_RX_WQE_HDR + NIX_RX_PARSE_S are stashed.

   For example::