From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <thomas@monjalon.net>
Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com
[66.111.4.27]) by dpdk.org (Postfix) with ESMTP id 6D18DAADA
for <dev@dpdk.org>; Fri, 20 Apr 2018 02:13:36 +0200 (CEST)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41])
by mailout.nyi.internal (Postfix) with ESMTP id 1F1A8218FD;
Thu, 19 Apr 2018 20:13:35 -0400 (EDT)
Received: from mailfrontend1 ([10.202.2.162])
by compute1.internal (MEProxy); Thu, 19 Apr 2018 20:13:35 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=
cc:date:from:in-reply-to:message-id:references:subject:to
:x-me-sender:x-me-sender:x-sasl-enc; s=mesmtp; bh=0UJHoEYOiVwoN2
Ge/+bBcwzqKYw6muIGWjCTUoIbSaQ=; b=R4DcwcQXhhCtSemne+/EQHv6s/e0sv
XOKrDhIG4gugMdtN12i4LwlFp2xpHTmQAG3ifZIwHHWqabj1WE8aAb34ZWnFiqXh
0erersziOKlEJyjc00p6Jhjc+Q3ENdEvRYchm+CFf3T4kAMwhHbBpexMWehPFQuC
eaArNeSSXyiis=
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
messagingengine.com; h=cc:date:from:in-reply-to:message-id
:references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s=
fm2; bh=0UJHoEYOiVwoN2Ge/+bBcwzqKYw6muIGWjCTUoIbSaQ=; b=JEh1IcTe
cWyHpKP+UhYym4p6W7uS5TcwMghG6dxKISp1eAF6azr5ERQaQAWyNT8bQnHdS67e
pBorVaXhQHoTboGK37c/q4XUQSDKAk8um0/1Zg7zSAmX67BAIxdLs+DVa/PNC7xM
g1AKD1iTD5uLtBi93EfZEIvPHPaLoDUeniatTi1BdGs/6uDBXPwtDans1Yue2z44
g20Twg8pmGpXexuh88VBR/zJ4y5aoTMVx9zWfpIAfXpvbMFKmVirE13enkdkQ+34
YUsPPQOwLMSmMs9RH6pjhKjSS4g1zEjajKOYjSgI9V+tjJ0iKGZZWHl+u7WxRu64
UG3InL+fLHgt/Q==
X-ME-Sender: <xms:rzDZWnwm7aXyhxoqCZ_wd0j_umQSUYfONmuXvhrQuYKwig5ojDu2nQ>
Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184])
by mail.messagingengine.com (Postfix) with ESMTPA id 54B45E4921;
Thu, 19 Apr 2018 20:13:34 -0400 (EDT)
From: Thomas Monjalon <thomas@monjalon.net>
To: olivier.matz@6wind.com
Cc: dev@dpdk.org,
xuemingl@mellanox.com,
harish.patil@cavium.com
Date: Fri, 20 Apr 2018 02:13:24 +0200
Message-Id: <20180420001324.11813-3-thomas@monjalon.net>
X-Mailer: git-send-email 2.16.2
In-Reply-To: <20180420001324.11813-1-thomas@monjalon.net>
References: <20180420001324.11813-1-thomas@monjalon.net>
Subject: [dpdk-dev] [PATCH 2/2] mbuf: improve API doc for tunnel Tx offloads
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 20 Apr 2018 00:13:36 -0000
Add few details to remind TSO flag, checksum flags and header lengths.
The doxygen syntax for MPLS-in-UDP is fixed.
Fixes: d95188551fa1 ("mbuf: introduce new Tx offload flag for MPLS-in-UDP")
Cc: harish.patil@cavium.com
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
lib/librte_mbuf/rte_mbuf.h | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index 7ae3bab14..adf95e3cd 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -201,14 +201,16 @@ extern "C" {
/**
* Bits 45:48 used for the tunnel type.
- * When doing Tx offload like TSO or checksum, the HW needs to configure the
- * tunnel type into the HW descriptors.
+ * The tunnel type must be specified for TSO or checksum on tunnel packets.
+ * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
+ * The mbuf fields for inner and outer header lengths may be required:
+ * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len.
*/
#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
#define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
-/**< TX packet with MPLS-in-UDP RFC 7510 header. */
+/** TX packet with MPLS-in-UDP RFC 7510 header. */
#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
/* add new TX TUNNEL type here */
#define PKT_TX_TUNNEL_MASK (0xFULL << 45)
--
2.16.2