d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add fields enum for modify action in flow guide

Browse Source 
Fix the documentation about the MODIFY_FIELD 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: 73b68f4c54a0 ("ethdev: introduce generic modify flow action")
Cc: stable@dpdk.org

Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
This commit is contained in:
Alexander Kozyrev 2021-04-08 12:32:58 +00:00 committed by Ferruh Yigit
parent b797b049b5
commit d2cf28145f
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/guides/prog_guide/rte_flow.rst
View File

@ -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 |
+---------------+----------------------------------------------------------+