From patchwork Wed Mar 3 22:19:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kozyrev X-Patchwork-Id: 88440 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 6498BA0567; Wed, 3 Mar 2021 23:19:11 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A334E40691; Wed, 3 Mar 2021 23:19:10 +0100 (CET) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id A6C0D40683 for ; Wed, 3 Mar 2021 23:19:08 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from akozyrev@nvidia.com) with SMTP; 4 Mar 2021 00:19:05 +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 123MJ5K7013821; Thu, 4 Mar 2021 00:19:05 +0200 From: Alexander Kozyrev To: dev@dpdk.org Cc: stable@dpdk.org, rasland@nvidia.com, viacheslavo@nvidia.com, matan@nvidia.com, orika@nvidia.com Date: Wed, 3 Mar 2021 22:19:04 +0000 Message-Id: <20210303221904.25841-1-akozyrev@nvidia.com> X-Mailer: git-send-email 2.24.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] ethdev: add Field ID doxygen description 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" Field IDs for the MODIFY_FIELD action lack doxygen comments and not visible in online DPDK documentation because of that. Provide a meaningful description for every Field ID for the rte_flow_field_id enumeration. Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action") Cc: stable@dpdk.org Signed-off-by: Alexander Kozyrev Reviewed-by: Ferruh Yigit --- lib/librte_ethdev/rte_flow.h | 58 ++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/lib/librte_ethdev/rte_flow.h b/lib/librte_ethdev/rte_flow.h index 68c68cdd6c..669e677e91 100644 --- a/lib/librte_ethdev/rte_flow.h +++ b/lib/librte_ethdev/rte_flow.h @@ -2832,35 +2832,35 @@ struct rte_flow_shared_action; * Field IDs for MODIFY_FIELD action. */ enum rte_flow_field_id { - RTE_FLOW_FIELD_START = 0, /**< Start of a packet. */ - RTE_FLOW_FIELD_MAC_DST, - RTE_FLOW_FIELD_MAC_SRC, - RTE_FLOW_FIELD_VLAN_TYPE, - RTE_FLOW_FIELD_VLAN_ID, - RTE_FLOW_FIELD_MAC_TYPE, - RTE_FLOW_FIELD_IPV4_DSCP, - RTE_FLOW_FIELD_IPV4_TTL, - RTE_FLOW_FIELD_IPV4_SRC, - RTE_FLOW_FIELD_IPV4_DST, - RTE_FLOW_FIELD_IPV6_DSCP, - RTE_FLOW_FIELD_IPV6_HOPLIMIT, - RTE_FLOW_FIELD_IPV6_SRC, - RTE_FLOW_FIELD_IPV6_DST, - RTE_FLOW_FIELD_TCP_PORT_SRC, - RTE_FLOW_FIELD_TCP_PORT_DST, - RTE_FLOW_FIELD_TCP_SEQ_NUM, - RTE_FLOW_FIELD_TCP_ACK_NUM, - RTE_FLOW_FIELD_TCP_FLAGS, - RTE_FLOW_FIELD_UDP_PORT_SRC, - RTE_FLOW_FIELD_UDP_PORT_DST, - RTE_FLOW_FIELD_VXLAN_VNI, - RTE_FLOW_FIELD_GENEVE_VNI, - RTE_FLOW_FIELD_GTP_TEID, - RTE_FLOW_FIELD_TAG, - RTE_FLOW_FIELD_MARK, - RTE_FLOW_FIELD_META, - RTE_FLOW_FIELD_POINTER, /**< Memory pointer. */ - RTE_FLOW_FIELD_VALUE, /**< Immediate value. */ + 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. */ }; /**