[dpdk-dev] [PATCH] doc: update sample actions support in mlx5 guide

[dpdk-dev] [PATCH] doc: update sample actions support in mlx5 guide

[Jiawei Wang]

Updates the documentation for supported sample actions in the NIC Rx
and E-Switch steering flow.

Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7c50497..2aa7483 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -370,6 +370,8 @@ Limitations
   - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and E-Switch steering domain.
   - The E-Switch Sample flow must have the eswitch_manager VPORT destination (PF or ECPF) and no additional actions.
   - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as first action in the E-Switch egress flow if with header modify or encapsulation actions.
+  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for NIC Rx sampling/mirroring flow.
+  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch mirroring (sample ratio = 1) flow.
 
 - Modify Field flow:
 
-- 
1.8.3.1

Re: [dpdk-dev] [PATCH] doc: update sample actions support in mlx5 guide

[Thomas Monjalon]

09/03/2021 14:09, Jiawei Wang:
> +  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for NIC Rx sampling/mirroring flow.

"sample actions for NIC Rx sampling" is redundant.
I suggest "Supports [...] actions for NIC Rx flow sampling/mirroring."

> +  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch mirroring (sample ratio = 1) flow.

I suggest "Supports [...] actions for E-Switch flow mirroring."

If lines are long, do not hesitate to start a new line after a punctuation.

Re: [dpdk-dev] [PATCH] doc: update sample actions support in mlx5 guide

[Jiawei(Jonny) Wang]

Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, March 9, 2021 9:39 PM
> To: Jiawei(Jonny) Wang <jiaweiw@nvidia.com>
> Cc: Slava Ovsiienko <viacheslavo@nvidia.com>; Matan Azrad
> <matan@nvidia.com>; Ori Kam <orika@nvidia.com>; dev@dpdk.org; Raslan
> Darawsheh <rasland@nvidia.com>
> Subject: Re: [PATCH] doc: update sample actions support in mlx5 guide
> 
> 09/03/2021 14:09, Jiawei Wang:
> > +  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for
> NIC Rx sampling/mirroring flow.
> 
> "sample actions for NIC Rx sampling" is redundant.
> I suggest "Supports [...] actions for NIC Rx flow sampling/mirroring."
> 

These actions are support in the sample action list, user also can add modify, decap , encap in the NIC RX flow;
How about this:

"For NIC RX flow with sample action, Supports [...] actions in the sample action list" ? 

> > +  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch
> mirroring (sample ratio = 1) flow.
> 
> I suggest "Supports [...] actions for E-Switch flow mirroring."
> 
> If lines are long, do not hesitate to start a new line after a punctuation.
> 

Ok, I will split into two lines.

Thanks.

Re: [dpdk-dev] [PATCH] doc: update sample actions support in mlx5 guide

[Thomas Monjalon]

12/03/2021 10:44, Jiawei(Jonny) Wang:
> From: Thomas Monjalon <thomas@monjalon.net>
> > 09/03/2021 14:09, Jiawei Wang:
> > > +  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for
> > NIC Rx sampling/mirroring flow.
> > 
> > "sample actions for NIC Rx sampling" is redundant.
> > I suggest "Supports [...] actions for NIC Rx flow sampling/mirroring."
> > 
> 
> These actions are support in the sample action list, user also can add modify, decap , encap in the NIC RX flow;
> How about this:
> 
> "For NIC RX flow with sample action, Supports [...] actions in the sample action list" ?

Another suggestion:
For NIC Rx flow, supports [...] in the sampling actions list.


> > > +  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch
> > mirroring (sample ratio = 1) flow.
> > 
> > I suggest "Supports [...] actions for E-Switch flow mirroring."
> > 
> > If lines are long, do not hesitate to start a new line after a punctuation.
> > 
> 
> Ok, I will split into two lines.
> 
> Thanks.

[dpdk-dev] [PATCH v2] doc: update sample actions support in mlx5 guide

[Jiawei Wang]

Updates the documentation for supported sample actions in the NIC Rx
and E-Switch steering flow.

Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7c50497..96fce36 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -367,9 +367,17 @@ Limitations
 
 - Sample flow:
 
-  - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and E-Switch steering domain.
-  - The E-Switch Sample flow must have the eswitch_manager VPORT destination (PF or ECPF) and no additional actions.
-  - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as first action in the E-Switch egress flow if with header modify or encapsulation actions.
+  - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and
+    E-Switch steering domain.
+  - The E-Switch Sample flow must have the eswitch_manager VPORT destination
+    (PF or ECPF) and no additional actions.
+  - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as
+    first action in the E-Switch egress flow if with header modify or
+    encapsulation actions.
+  - For NIC Rx flow, supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` in the
+    sample actions list.
+  - For E-Switch mirroring flow, supports ``RAW ENCAP``, ``Port ID`` in the
+    sample actions list.
 
 - Modify Field flow:
 
-- 
1.8.3.1

[dpdk-dev] [PATCH v3] doc: update sample actions support in mlx5 guide

[Jiawei Wang]

Updates the documentation for supported sample actions in the NIC Rx
and E-Switch steering flow.

Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
v3:
* Update the description.

v2:
* Update the description.

---
 doc/guides/nics/mlx5.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7c50497..a2cfc51 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -367,9 +367,17 @@ Limitations
 
 - Sample flow:
 
-  - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and E-Switch steering domain.
-  - The E-Switch Sample flow must have the eswitch_manager VPORT destination (PF or ECPF) and no additional actions.
-  - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as first action in the E-Switch egress flow if with header modify or encapsulation actions.
+  - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and
+    E-Switch steering domain.
+  - For E-Switch Sampling flow with sample ratio > 1, additional actions are not
+    supported in the sample actions list.
+  - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as
+    first action in the E-Switch egress flow if with header modify or
+    encapsulation actions.
+  - For NIC Rx flow, supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` in the
+    sample actions list.
+  - For E-Switch mirroring flow, supports ``RAW ENCAP``, ``Port ID`` in the
+    sample actions list.
 
 - Modify Field flow:
 
-- 
1.8.3.1

Re: [dpdk-dev] [PATCH v3] doc: update sample actions support in mlx5 guide

[Raslan Darawsheh]

Hi,

> -----Original Message-----
> From: Jiawei Wang <jiaweiw@nvidia.com>
> Sent: Tuesday, March 16, 2021 5:18 PM
> To: Slava Ovsiienko <viacheslavo@nvidia.com>; Matan Azrad
> <matan@nvidia.com>; Ori Kam <orika@nvidia.com>; NBU-Contact-Thomas
> Monjalon <thomas@monjalon.net>
> Cc: dev@dpdk.org; Raslan Darawsheh <rasland@nvidia.com>
> Subject: [PATCH v3] doc: update sample actions support in mlx5 guide
> 
> Updates the documentation for supported sample actions in the NIC Rx
> and E-Switch steering flow.
> 
> Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
> Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> ---
> v3:
> * Update the description.
> 
> v2:
> * Update the description.
> 
> ---

Patch applied to next-net-mlx,

Kindest regards,
Raslan Darawsheh