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 21EB8A0548; Wed, 19 May 2021 19:33:24 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9DBB640041; Wed, 19 May 2021 19:33:23 +0200 (CEST) Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by mails.dpdk.org (Postfix) with ESMTP id 995294003F for ; Wed, 19 May 2021 19:33:22 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 2335C5C019D; Wed, 19 May 2021 13:33:22 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Wed, 19 May 2021 13:33:22 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; s=fm1; bh=lWNsCINqoJj/g XBMYyDcgns6f8J11HbrnIR9mJzYE+I=; b=QB5qxMb4KP2PnN3QUx1U/HvIfHzWI 4sVbDxxTfp0s5JnvCsxKH/hAK6frfr6HoDVesEsgg1d+88pw5CVGgo4IvfCMkbBP 76970sntRqu6pqCeE8hTPUdnE/4nbREw/1Znu4xBFpF/sWAqog/ZkZiFCuYxk1Qu x687qJ3f3cwuZWKW/ZMVfKXWZrOg7MdmOPVHigpaL93SBPTeLdelfC//A5+8P9HN GM+cwfyserz9FmRRdmWlbef7rBeRBp764KK5QkVq3ulIhmO02yx94D0cLAc9CmMD Vj+1+T+qaDzvn7KqFIpl4yldWb9n3+GYuX5E+7Lg58yePtLb+7WR0AA3g== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :in-reply-to:message-id:mime-version:references:subject:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; bh=lWNsCINqoJj/gXBMYyDcgns6f8J11HbrnIR9mJzYE+I=; b=JeChrqZl gGeda2HB+LzPGHVIpBYFXwzQRPgelpB19eO6t2UXOXaZkHUN6ewR97x/wqp0WRGc b2Yu5GZfSu7YZzAS1JXs6PpZXeVmv8SwYhflhZ8wR7jXtxITqLH5UjFRlH05a0Xx L7mIoRh94pnVqvxIiZSJv8bEWAE0qw6AZOCAxDHLcKpMIPovZhJq7yFoNJtvUR85 Zt6U4JoDBJlR0x/BI7yfytYvBn3JPZCMkSmAanaVO2DzyadsRsrmRPTSljSaNPN9 pttAdDnYCTUs2bRF7JsmZYG+oCargJZynsiAefKJqqBbmS7xL4lIz8jgWHOQMhNm 8XrLYpElWpdw5g== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdeiledguddufecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpedvhefgiedvjeegtdevheefhfetleefgfeivefgffevfeejgedt gfeutdehtdegveenucfkphepjeejrddufeegrddvtdefrddukeegnecuvehluhhsthgvrh fuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgr lhhonhdrnhgvth X-ME-Proxy: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 19 May 2021 13:33:19 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: ferruh.yigit@intel.com, asafp@nvidia.com, Andrew Rybchenko , Ajit Khaparde , Ori Kam Date: Wed, 19 May 2021 19:33:16 +0200 Message-Id: <20210519173316.2364189-1-thomas@monjalon.net> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210519162725.2179226-1-thomas@monjalon.net> References: <20210519162725.2179226-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item 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" The Doxygen comments are placed before the related lines, but the markers were /**< instead of /** The struct rte_flow_item_integrity did not appear in Doxygen output because there was no general comment for the struct. Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules") Signed-off-by: Thomas Monjalon Acked-by: Andrew Rybchenko Acked-by: Ajit Khaparde --- v2: add general comment for the struct (thanks Ferruh for the catch) --- lib/ethdev/rte_flow.h | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h index 94c8c1ccc8..961a5884fe 100644 --- a/lib/ethdev/rte_flow.h +++ b/lib/ethdev/rte_flow.h @@ -1707,8 +1707,16 @@ rte_flow_item_geneve_opt_mask = { }; #endif +/** + * @warning + * @b EXPERIMENTAL: this structure may change without prior notice + * + * RTE_FLOW_ITEM_TYPE_INTEGRITY + * + * Match on packet integrity check result. + */ struct rte_flow_item_integrity { - /**< Tunnel encapsulation level the item should apply to. + /** Tunnel encapsulation level the item should apply to. * @see rte_flow_action_rss */ uint32_t level; @@ -1716,21 +1724,21 @@ struct rte_flow_item_integrity { union { __extension__ struct { - /**< The packet is valid after passing all HW checks. */ + /** The packet is valid after passing all HW checks. */ uint64_t packet_ok:1; - /**< L2 layer is valid after passing all HW checks. */ + /** L2 layer is valid after passing all HW checks. */ uint64_t l2_ok:1; - /**< L3 layer is valid after passing all HW checks. */ + /** L3 layer is valid after passing all HW checks. */ uint64_t l3_ok:1; - /**< L4 layer is valid after passing all HW checks. */ + /** L4 layer is valid after passing all HW checks. */ uint64_t l4_ok:1; - /**< L2 layer CRC is valid. */ + /** L2 layer CRC is valid. */ uint64_t l2_crc_ok:1; - /**< IPv4 layer checksum is valid. */ + /** IPv4 layer checksum is valid. */ uint64_t ipv4_csum_ok:1; - /**< L4 layer checksum is valid. */ + /** L4 layer checksum is valid. */ uint64_t l4_csum_ok:1; - /**< The l3 length is smaller than the frame length. */ + /** L3 length is smaller than frame length. */ uint64_t l3_len_ok:1; uint64_t reserved:56; }; -- 2.31.1