From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 79C56A0A02; Wed, 24 Mar 2021 16:05:19 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 83FF4140F03; Wed, 24 Mar 2021 16:04:54 +0100 (CET) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id 81F60140ED1 for ; Wed, 24 Mar 2021 16:04:47 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from akozyrev@nvidia.com) with SMTP; 24 Mar 2021 17:04:42 +0200 Received: from nvidia.com (pegasus02.mtr.labs.mlnx [10.210.16.122]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 12OF4fhL002053; Wed, 24 Mar 2021 17:04:41 +0200 From: Alexander Kozyrev To: dev@dpdk.org Cc: rasland@nvidia.com, viacheslavo@nvidia.com, matan@nvidia.com, orika@nvidia.com Date: Wed, 24 Mar 2021 15:04:38 +0000 Message-Id: <20210324150439.9247-6-akozyrev@nvidia.com> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20210324150439.9247-1-akozyrev@nvidia.com> References: <20210324150439.9247-1-akozyrev@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 5/6] doc: add list of supported Field IDs to modify 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 into the documentation to provide the full list of all supported Field IDs available for the MODIFY_FIELD RTE action. Signed-off-by: Alexander Kozyrev --- doc/guides/prog_guide/rte_flow.rst | 45 ++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 62a57919eb..4265b7bfb8 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2784,6 +2784,41 @@ 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: + +.. code-block:: c + + enum rte_flow_field_id { + RTE_FLOW_FIELD_START = 0, /**< Start of a packet. */ + RTE_FLOW_FIELD_MAC_DST, /**< Destination MAC Address. */ + RTE_FLOW_FIELD_MAC_SRC, /**< Source MAC Address. */ + RTE_FLOW_FIELD_VLAN_TYPE, /**< 802.1Q Tag Identifier. */ + RTE_FLOW_FIELD_VLAN_ID, /**< 802.1Q VLAN Identifier. */ + RTE_FLOW_FIELD_MAC_TYPE, /**< EtherType. */ + RTE_FLOW_FIELD_IPV4_DSCP, /**< IPv4 DSCP. */ + RTE_FLOW_FIELD_IPV4_TTL, /**< IPv4 Time To Live. */ + RTE_FLOW_FIELD_IPV4_SRC, /**< IPv4 Source Address. */ + RTE_FLOW_FIELD_IPV4_DST, /**< IPv4 Destination Address. */ + RTE_FLOW_FIELD_IPV6_DSCP, /**< IPv6 DSCP. */ + RTE_FLOW_FIELD_IPV6_HOPLIMIT, /**< IPv6 Hop Limit. */ + RTE_FLOW_FIELD_IPV6_SRC, /**< IPv6 Source Address. */ + RTE_FLOW_FIELD_IPV6_DST, /**< IPv6 Destination Address. */ + RTE_FLOW_FIELD_TCP_PORT_SRC, /**< TCP Source Port Number. */ + RTE_FLOW_FIELD_TCP_PORT_DST, /**< TCP Destination Port Number. */ + RTE_FLOW_FIELD_TCP_SEQ_NUM, /**< TCP Sequence Number. */ + RTE_FLOW_FIELD_TCP_ACK_NUM, /**< TCP Acknowledgment Number. */ + RTE_FLOW_FIELD_TCP_FLAGS, /**< TCP Flags. */ + RTE_FLOW_FIELD_UDP_PORT_SRC, /**< UDP Source Port Number. */ + RTE_FLOW_FIELD_UDP_PORT_DST, /**< UDP Destination Port Number. */ + RTE_FLOW_FIELD_VXLAN_VNI, /**< VXLAN Network Identifier. */ + RTE_FLOW_FIELD_GENEVE_VNI, /**< GENEVE Network Identifier. */ + RTE_FLOW_FIELD_GTP_TEID, /**< GTP Tunnel Endpoint Identifier. */ + RTE_FLOW_FIELD_TAG, /**< Tag value. */ + RTE_FLOW_FIELD_MARK, /**< Mark value. */ + RTE_FLOW_FIELD_META, /**< Metadata value. */ + RTE_FLOW_FIELD_POINTER, /**< Memory pointer. */ + RTE_FLOW_FIELD_VALUE, /**< Immediate value. */ + }; ``op`` selects the operation to perform on a destination field. - ``set`` copies the data from ``src`` field to ``dst`` field. @@ -2817,12 +2852,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 | +---------------+-------------------------+ @@ -2830,12 +2868,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