From patchwork Wed Mar 31 16:00:28 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kozyrev X-Patchwork-Id: 90240 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id BA849A034F; Wed, 31 Mar 2021 18:00:42 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 58BA4140EB2; Wed, 31 Mar 2021 18:00:42 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id 72C9F140EB0 for ; Wed, 31 Mar 2021 18:00:41 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from akozyrev@nvidia.com) with SMTP; 31 Mar 2021 19:00:35 +0300 Received: from nvidia.com (pegasus02.mtr.labs.mlnx [10.210.16.122]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 12VG0TX4031833; Wed, 31 Mar 2021 19:00:29 +0300 From: Alexander Kozyrev To: dev@dpdk.org Cc: rasland@nvidia.com, viacheslavo@nvidia.com, ferruh.yigit@intel.com Date: Wed, 31 Mar 2021 16:00:28 +0000 Message-Id: <20210331160028.21811-1-akozyrev@nvidia.com> X-Mailer: git-send-email 2.24.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc: refer to the supported Field IDs for modify field API X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Include the rte_flow_field_id enumeration reference into the documentation to point to the full list of all supported Field IDs available for the MODIFY_FIELD RTE action. Signed-off-by: Alexander Kozyrev Acked-by: Viacheslav Ovsiienko --- 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 a1fdcd7c07..9fce58ea5e 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2777,6 +2777,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. @@ -2810,12 +2811,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 | +---------------+-------------------------+ @@ -2823,12 +2827,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 | +---------------+----------------------------------------------------------+