[dpdk-dev] [PATCH v2] doc: refer to the supported Field IDs for modify field API
Alexander Kozyrev
akozyrev at nvidia.com
Thu Apr 8 14:32:58 CEST 2021
Fix the documentation about the MODIFY_FIELD RTE Flow action.
1. Include the rte_flow_field_id enumeration reference to point
to the full list of all supported Field IDs available.
2. Correct the formatting of the MODIFY_FIELD action and the
destination/source field definition tables.
Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action")
Cc: stable at dpdk.org
Signed-off-by: Alexander Kozyrev <akozyrev at nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo at nvidia.com>
---
v2: added commit message about the tables formatting
doc/guides/prog_guide/rte_flow.rst | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index aec2ba1ec0..e1b93ecedf 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -2779,6 +2779,7 @@ can be used as both source and destination fields as set by ``field``.
The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it
``RTE_FLOW_FIELD_POINTER``) is allowed as a source only.
``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet.
+See ``enum rte_flow_field_id`` for the list of supported fields.
``op`` selects the operation to perform on a destination field.
- ``set`` copies the data from ``src`` field to ``dst`` field.
@@ -2812,12 +2813,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively.
.. table:: MODIFY_FIELD
- +-----------------------------------------+
+ +---------------+-------------------------+
| Field | Value |
+===============+=========================+
| ``op`` | operation to perform |
+ +---------------+-------------------------+
| ``dst`` | destination field |
+ +---------------+-------------------------+
| ``src`` | source field |
+ +---------------+-------------------------+
| ``width`` | number of bits to use |
+---------------+-------------------------+
@@ -2825,12 +2829,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively.
.. table:: destination/source field definition
- +--------------------------------------------------------------------------+
+ +---------------+----------------------------------------------------------+
| Field | Value |
+===============+==========================================================+
| ``field`` | ID: packet field, mark, meta, tag, immediate, pointer |
+ +---------------+----------------------------------------------------------+
| ``level`` | encapsulation level of a packet field or tag array index |
+ +---------------+----------------------------------------------------------+
| ``offset`` | number of bits to skip at the beginning |
+ +---------------+----------------------------------------------------------+
| ``value`` | immediate value or a pointer to this value |
+---------------+----------------------------------------------------------+
--
2.24.1
More information about the dev
mailing list