From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: [PATCH 2/2] mbuf: improve API doc for tunnel Tx offloads Date: Fri, 20 Apr 2018 02:13:24 +0200 Message-ID: <20180420001324.11813-3-thomas@monjalon.net> References: <20180420001324.11813-1-thomas@monjalon.net> Cc: dev@dpdk.org, xuemingl@mellanox.com, harish.patil@cavium.com To: olivier.matz@6wind.com Return-path: Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by dpdk.org (Postfix) with ESMTP id 6D18DAADA for ; Fri, 20 Apr 2018 02:13:36 +0200 (CEST) In-Reply-To: <20180420001324.11813-1-thomas@monjalon.net> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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