From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 9C05AA052A;
	Wed, 27 Jan 2021 23:46:27 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 884D414106F;
	Wed, 27 Jan 2021 23:46:27 +0100 (CET)
Received: from wout3-smtp.messagingengine.com (wout3-smtp.messagingengine.com
 [64.147.123.19])
 by mails.dpdk.org (Postfix) with ESMTP id C9615141056
 for <dev@dpdk.org>; Wed, 27 Jan 2021 23:46:25 +0100 (CET)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.42])
 by mailout.west.internal (Postfix) with ESMTP id 46058510;
 Wed, 27 Jan 2021 17:46:24 -0500 (EST)
Received: from mailfrontend2 ([10.202.2.163])
 by compute2.internal (MEProxy); Wed, 27 Jan 2021 17:46:24 -0500
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:content-type; s=fm3; bh=
 wUiXre+T0qrS/LgKkSZCXoHZX12e3F6VakjtBG2iVXU=; b=iVw0T1BCc5Dk1SAk
 4lmxTRObF/sSY1UmBhaUHhVpAtyy2xbOu+QvdpfHEmE+5nxqflx61uaL3H8MmRwX
 NbWRcWoBQup0B1TixzFLEtYbjIvo4ljON+f83lD+IW4qVQFMnd6qCC5st6BF5CO3
 TP+C4dqnlY5U+Njgu4m2/HQBnNnc5heKCI9Af/v9XU4jID3wQ2Ousr9iFDyLoS8Z
 M1u0yGsUDS/RqP1xy1bYag1MdZU1Fjb1Roe74c+hN84P04cH6tvkMnOFO68yq+a9
 Bb2e4sC2x89MhoLJ4eN6fbspbG3jFl/4ynH35GnxjpsyG55UNXZTZ74co3YZ5sIN
 Bvz3LQ==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
 messagingengine.com; h=cc:content-transfer-encoding:content-type
 :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=fm1; bh=wUiXre+T0qrS/LgKkSZCXoHZX12e3F6VakjtBG2iV
 XU=; b=i3/dN3tlOmElPCXKPAhk1Pff5EyqPOcWWeTZEEb/BpgSHYUdZw44QJ3lA
 K531fO/RiRmvger3Pf9fWuWhjlXsakmVzao5uzaYMTSBlevOEVYB0DpQlR78yQuv
 pvQPzJpMKVyOcMEx7Kfx0CExblUGDGzhBiPj54k9pLvZZ7mOSS5E4ebjAzF113Ry
 KyxZQm1NxJOhk0cQFTxQ4Z1I238Nuial2iofZotw5UURMa5+hULHzN9jxdKJ50AY
 SoiGWuOThusdVc5USg2wP1Q6yaPoIFjFzncNOoXNxQ74kVhc3ayHcxZU7P3ajcWX
 O/LHA8QqO9T1Mov5kvlmO1sVbkKOg==
X-ME-Sender: <xms:P-0RYKzqH7nMIjYJtnawOezJ-FtNYYn-XOdSSbUdw9BfXHOLHoMpOg>
 <xme:P-0RYGSP80UWmEv423BW6ehL0ThBE2PcZmGxUvkz05dRZImv_SSrQgHKpUdqP2Nok
 OBhKyFO3-CIRS30og>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdelgddtudcutefuodetggdotefrodftvf
 curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu
 uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc
 fjughrpefhvffufffkjghfggfgtgesthfuredttddtvdenucfhrhhomhepvfhhohhmrghs
 ucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtf
 frrghtthgvrhhnpedugefgvdefudfftdefgeelgffhueekgfffhfeujedtteeutdejueei
 iedvffegheenucfkphepjeejrddufeegrddvtdefrddukeegnecuvehluhhsthgvrhfuih
 iivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhho
 nhdrnhgvth
X-ME-Proxy: <xmx:P-0RYMU9GHuaa_pq_boxp-XECm2LQaUPkTfDI5cpxO4uO7bBU_dXvQ>
 <xmx:P-0RYAi3UD3iJklXx79J4nXTs7AaaEySrMaCfOdapCgLHwmtV7iXWw>
 <xmx:P-0RYMDicofN3pfpm_WQpveUbwh1N2zL7sbzHr_UrlVKtpNMxdv21g>
 <xmx:P-0RYPM9ZHwmjrzSk39cjIhOFsyt9ER9JWu122arlj77A959-BLFCA>
Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184])
 by mail.messagingengine.com (Postfix) with ESMTPA id 75E431080063;
 Wed, 27 Jan 2021 17:46:22 -0500 (EST)
From: Thomas Monjalon <thomas@monjalon.net>
To: Qi Zhang <qi.z.zhang@intel.com>
Cc: dev@dpdk.org, Ferruh Yigit <ferruh.yigit@intel.com>,
 andrew.rybchenko@oktetlabs.ru, ajit.khaparde@broadcom.com, jerinj@marvell.com
Date: Wed, 27 Jan 2021 23:46:20 +0100
Message-ID: <2127515.4xTPBHG8O9@thomas>
In-Reply-To: <de4bdfa5-0575-71e9-2932-39f2c52074da@intel.com>
References: <20210112114703.350878-1-qi.z.zhang@intel.com>
 <20210119031905.518082-1-qi.z.zhang@intel.com>
 <de4bdfa5-0575-71e9-2932-39f2c52074da@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
Subject: Re: [dpdk-dev] [PATCH v2] ethdev: refine doxygen for add UDP tunnel
 port API
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

27/01/2021 12:34, Ferruh Yigit:
> On 1/19/2021 3:19 AM, Qi Zhang wrote:
> > Refine the doxygen for rte_eth_dev_udp_tunnel_port_add.
> > Add more detail description of the impacted offload functions.
> > 
> > Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
> > ---
> > 
> > v2:
> > - reword doxygen that focus on API impact base on previous discussion.
> > 
> >   lib/librte_ethdev/rte_ethdev.h | 11 +++++++++++
> >   1 file changed, 11 insertions(+)
> > 
> > diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> > index f758ec837..ab50a7039 100644
> > --- a/lib/librte_ethdev/rte_ethdev.h
> > +++ b/lib/librte_ethdev/rte_ethdev.h
> > @@ -4031,6 +4031,17 @@ rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
> >    * to change or add more UDP port for the tunnel. So the offloading function
> >    * can take effect on the packets with the specific UDP port.
> >    *
> > + * The impacted offloading functions include:
> > + *
> > + * - A specific tunnel type in mbuf->packet_type
> > + *
> > + * - A rte_flow rule that matches on specific tunnel header
> > + *
> > + * NOTE: If a packet only has a matched UDP port but don't have a legal tunnel
> > + *       header, the packet may still not be recognized as a tunnel packet by
> > + *       the device parser, then the related offloading function will not take
> > + *       effect.
> > + *
> >    * @param port_id
> >    *   The port identifier of the Ethernet device.
> >    * @param tunnel_udp
> > 
> 
> Hi Thomas, is the v2 good to go?

Sorry I didn't take time to work on the wording.
I think we can make the explanation a bit more precise
with few more updates in the existing lines for this function and
for struct rte_eth_udp_tunnel and enum rte_eth_tunnel_type.
I agree with the idea and would like to propose a v3 for -rc3 integration
if possible.

The ethdev API documentation is not an easy task.
As we are improving it, let's not miss some corners.