doc update for rte flow shared action
PATCH 2/2 doc: group mlx5 shared actions
In reply to Jack MinPut all supported shared actions in one new table
--- doc/guides/nics/mlx5.rst | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-)
doc/guides/nics/mlx5.rst +21 -9
@@ -1497,10 +1497,10 @@ Supported hardware offloads | | | | | rdma-core 23 | | | | | | ConnectX-4 | +-----------------------+-----------------+-----------------+ - | RSS shared action | | | | DPDK 20.11 | - | | | N/A | | OFED 5.2 | - | | | | | rdma-core 33 | - | | | | | ConnectX-5 | + | Shared action | | | | | + | | | :numref:`sact`| | :numref:`sact`| + | | | | | | + | | | | | | +-----------------------+-----------------+-----------------+ | | VLAN | | DPDK 19.11 | | DPDK 19.11 | | | (of_pop_vlan / | | OFED 4.7-1 | | OFED 4.7-1 |
@@ -1580,11 +1580,6 @@ Supported hardware offloads | | | rdma-core 32 | | N/A | | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ - | Age shared action | | DPDK 20.11 | | DPDK 20.11 | - | | | OFED 5.2 | | OFED 5.2 | - | | | rdma-core 32 | | rdma-core 32 | - | | | ConnectX-6 Dx| | ConnectX-6 Dx | - +-----------------------+-----------------+-----------------+ | Encapsulation | | DPDK 21.02 | | DPDK 21.02 | | GTP PSC | | OFED 5.2 | | OFED 5.2 | | | | rdma-core 35 | | rdma-core 35 |
@@ -1601,6 +1596,23 @@ Supported hardware offloads | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ +.. table:: Minimal SW/HW versions for shared action offload + :name: sact + + +-----------------------+-----------------+-----------------+ + | Shared Action | with E-Switch | with NIC | + +=======================+=================+=================+ + | RSS | | | | DPDK 20.11 | + | | | N/A | | OFED 5.2 | + | | | | | rdma-core 33 | + | | | | | ConnectX-5 | + +-----------------------+-----------------+-----------------+ + | Age | | DPDK 20.11 | | DPDK 20.11 | + | | | OFED 5.2 | | OFED 5.2 | + | | | rdma-core 32 | | rdma-core 32 | + | | | ConnectX-6 Dx| | ConnectX-6 Dx | + +-----------------------+-----------------+-----------------+ + Notes for metadata ------------------
Signature · 1 line
2.30.0
cover doc update for rte flow shared action
This series update documents as following:
1. Add more information about shared action in rte_flow.rst.
2. Group all supported shared actions in mlx5.rst
Xiaoyu Min (2):
doc: more info of rte flow shared action
doc: group mlx5 shared actions
doc/guides/nics/mlx5.rst | 30 +++++++++++++++++++++--------- doc/guides/prog_guide/rte_flow.rst | 7 +++++++ 2 files changed, 28 insertions(+), 9 deletions(-)
Signature · 1 line
2.30.0
PATCH 1/2 doc: more info of rte flow shared action
Added more information of shared action on
how to update, query, and the benefits.
--- doc/guides/prog_guide/rte_flow.rst | 7 +++++++ 1 file changed, 7 insertions(+)
doc/guides/prog_guide/rte_flow.rst +7 -0
@@ -2756,6 +2756,13 @@ Flow utilize shared action by handle as returned from The behaviour of the shared action defined by ``action`` argument of type ``struct rte_flow_action`` passed to ``rte_flow_shared_action_create()``. +Multiple flows can use the same shared action. +The shared action can be in-place updated by ``rte_flow_shared_action_update()`` +without destroying flow and creating flow again. + +The shared action specified data (e.g. counter) can be queried by +``rte_flow_shared_action_query()``. + .. _table_rte_flow_shared_action: .. table:: SHARED
Signature · 1 line
2.30.0
Re: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared action
Hi Jack,
Quoted 34 lines
-----Original Message-----
From: Jack Min <[email protected]>
Subject: [PATCH 1/2] doc: more info of rte flow shared actionAdded more information of shared action on
how to update, query, and the benefits.Signed-off-by Xiaoyu Min <[email protected]>--- doc/guides/prog_guide/rte_flow.rst | 7 +++++++ 1 file changed, 7 insertions(+)doc/guides/prog_guide/rte_flow.rst +0
-0@@ -2756,6 +2756,13 @@ Flow utilize shared action by handle as returnedfrom
The behaviour of the shared action defined by ``action`` argument of type ``struct rte_flow_action`` passed to ``rte_flow_shared_action_create()``.doc/guides/prog_guide/rte_flow.rst +2
-0+Multiple flows can use the same shared action. +The shared action can be in-place updated by``rte_flow_shared_action_update()``
doc/guides/prog_guide/rte_flow.rst +5
-1+without destroying flow and creating flow again. + +The shared action specified data (e.g. counter) can be queried by +``rte_flow_shared_action_query()``. + .. _table_rte_flow_shared_action: .. table:: SHARED --
Quoted 1 line
2.30.0
Best,
Ori
Asaf Penso
Reviewed-byRe: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared action
Hi Jack,
Quoted 41 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Ori Kam
Sent: Wednesday, February 3, 2021 9:51 AM
To: Jack Min <[email protected]>
Cc: [email protected]
Subject: Re: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared actionHi Jack,
Quoted 32 lines
-----Original Message-----
From: Jack Min <[email protected]>
Subject: [PATCH 1/2] doc: more info of rte flow shared actionAdded more information of shared action on how to update, query, and the benefits.
Signed-off-by Xiaoyu Min <[email protected]>--- doc/guides/prog_guide/rte_flow.rst | 7 +++++++ 1 file changed, 7 insertions(+)doc/guides/prog_guide/rte_flow.rst +0
-0@@ -2756,6 +2756,13 @@ Flow utilize shared action by handle asreturned from The behaviour of the shared action defined by ``action`` argument of type ``struct rte_flow_action`` passed to ``rte_flow_shared_action_create()``.
doc/guides/prog_guide/rte_flow.rst +2
-0+Multiple flows can use the same shared action. +The shared action can be in-place updated by``rte_flow_shared_action_update()``
doc/guides/prog_guide/rte_flow.rst +5
-0+without destroying flow and creating flow again. + +The shared action specified data (e.g. counter) can be queried by +``rte_flow_shared_action_query()``. + .. _table_rte_flow_shared_action:
Quoted 7 lines
Quoted 3 lines
.. table:: SHARED
--
2.30.0Acked-by Ori Kam <[email protected]>Best,
Ori
Re: [dpdk-dev] [PATCH 2/2] doc: group mlx5 shared actions
In reply to Jack MinHi Jack,
Regards,
Asaf Penso
Quoted 72 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Jack Min
Sent: Tuesday, February 2, 2021 2:24 PM
To: Matan Azrad <[email protected]>; Shahaf Shuler <[email protected]>; Slava Ovsiienko <[email protected]>
Cc: [email protected]
Subject: [dpdk-dev] [PATCH 2/2] doc: group mlx5 shared actionsPut all supported shared actions in one new table
Signed-off-by Xiaoyu Min <[email protected]>---
doc/guides/nics/mlx5.rst| 30 +++++++++++++++++++++---------1 file changed, 21 insertions(+), 9 deletions(-)doc/guides/nics/mlx5.rst index renamed from doc/guides/nics/mlx5.rst +0
-0
e99fea4342..dbd7ae1bb9100644doc/guides/nics/mlx5.rst +11
-9@@ -1497,10 +1497,10 @@ Supported hardware offloads | | | | | rdma-core 23 | | | | | | ConnectX-4 | +-----------------------+-----------------+-----------------+ - | RSS shared action | | | | DPDK 20.11 | - | | | N/A | | OFED 5.2 | - | | | | | rdma-core 33 | - | | | | | ConnectX-5 | + | Shared action | | | | | + | | | :numref:`sact`| | :numref:`sact`| + | | | | | | + | | | | | | +-----------------------+-----------------+-----------------+ | | VLAN | | DPDK 19.11 | | DPDK 19.11 | | | (of_pop_vlan / | | OFED 4.7-1 | | OFED 4.7-1 |@@ -1580,11 +1580,6 @@ Supported hardware offloads | | | rdma-core 32 | | N/A | | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ - | Age shared action | | DPDK 20.11 | | DPDK 20.11 | - | | | OFED 5.2 | | OFED 5.2 | - | | | rdma-core 32 | | rdma-core 32 | - | | | ConnectX-6 Dx| | ConnectX-6 Dx | - +-----------------------+-----------------+-----------------+ | Encapsulation | | DPDK 21.02 | | DPDK 21.02 | | GTP PSC | | OFED 5.2 | | OFED 5.2 | | | | rdma-core 35 | | rdma-core 35 |@@ -1601,6 +1596,23 @@ Supported hardware offloads | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ +.. table:: Minimal SW/HW versions for shared action offload + :name: sact + + +-----------------------+-----------------+-----------------+ + | Shared Action | with E-Switch | with NIC | + +=======================+=================+=================+
doc/guides/nics/mlx5.rst +11
-0+ | RSS | | | | DPDK 20.11 | + | | | N/A | | OFED 5.2 | + | | | | | rdma-core 33 | + | | | | | ConnectX-5 | + +-----------------------+-----------------+-----------------+ + | Age | | DPDK 20.11 | | DPDK 20.11 | + | | | OFED 5.2 | | OFED 5.2 | + | | | rdma-core 32 | | rdma-core 32 | + | | | ConnectX-6 Dx| | ConnectX-6 Dx | + +-----------------------+-----------------+-----------------+ +Notes for metadata
------------------
Quoted 2 lines
--
2.30.0
Ferruh Yigit
Reviewed-byRe: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared action
In reply to Asaf PensoQuoted 18 lines · Asaf Penso
Hi Jack,
Quoted 16 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Ori Kam
Sent: Wednesday, February 3, 2021 9:51 AM
To: Jack Min <[email protected]>
Cc: [email protected]
Subject: Re: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared actionHi Jack,
Quoted 7 lines
-----Original Message-----
From: Jack Min <[email protected]>
Subject: [PATCH 1/2] doc: more info of rte flow shared actionAdded more information of shared action on how to update, query, and the benefits.
Quoted 8 lines
Quoted 5 lines
Quoted 1 line
Signed-off-by Xiaoyu Min <[email protected]>Acked-by Ori Kam <[email protected]>Best,
OriReviewed-by Asaf Penso <[email protected]>
Quoted 9 lines · Jack Min
This series update documents as following:
1. Add more information about shared action in
rte_flow.rst.
2. Group all supported shared actions inmlx5.rstXiaoyu Min (2):
doc: more info of rte flow shared action
doc: group mlx5 shared actions
Series applied to dpdk-next-net/main, thanks.