From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by dpdk.org (Postfix) with ESMTP id 884AF1DBA; Mon, 23 Apr 2018 12:48:43 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id B9BA6215FC; Mon, 23 Apr 2018 06:48:42 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Mon, 23 Apr 2018 06:48:42 -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=5Ax7TykibS+++v Ilq8PW9Es1P30QoLWWlTWVKyuVYv0=; b=FiTG/bE4TNOSGaIgneUa/5rphl3A3c J3F/Onlqny2785QTQjm/ejmVvofUt+ff9WNAfoJHaod51JHedKsxT7FwIn5bblPa qvRnDnIrAgkZaCOQB3PVr+Q5q/suBQZDWyKmIzqkb7SffrlVJ9qI8sF6cx9VMLbb UsLQ18YpGzaHU= 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=5Ax7TykibS+++vIlq8PW9Es1P30QoLWWlTWVKyuVYv0=; b=S3Sw1qXB HzZd23Xmwg5/fnOlPHol3kJ52N5omdGep+2jO/K+mibKZBhe1AHDJdqIx5Iza9KT G04MFRnqtQf9vIy9nnGNrv/Sr1+38Cy0gw3e1EDMJdu8RyJnIArCJsxG/4xFurnD 7E5aYeZYmMYRQDOFJEWosWdRN5sKRgjMCF+mU/BAf+1rq+ktg+0OLKLXjQw5bN4s jnejNF5GwsXIvS2PUngrMgvtIuCUtjIhrjXKL2lOwjoRoAQgi0wmQGvUZuhVoDeO ULzIbv3XPI6/knuZu8TwjXFla4PW9isfCdcbTssrid11GoifW+HpLG8/YVFpgcDm gyvVEVzstEpLgw== X-ME-Sender: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id EC2DDE4120; Mon, 23 Apr 2018 06:48:41 -0400 (EDT) From: Thomas Monjalon To: olivier.matz@6wind.com Cc: dev@dpdk.org, xuemingl@mellanox.com, stable@dpdk.org Date: Mon, 23 Apr 2018 12:48:36 +0200 Message-Id: <20180423104836.24299-3-thomas@monjalon.net> X-Mailer: git-send-email 2.16.2 In-Reply-To: <20180423104836.24299-1-thomas@monjalon.net> References: <20180420001324.11813-1-thomas@monjalon.net> <20180423104836.24299-1-thomas@monjalon.net> Subject: [dpdk-stable] [PATCH v2 2/2] mbuf: improve API doc for tunnel Tx offloads X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 23 Apr 2018 10:48:44 -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: stable@dpdk.org Signed-off-by: Thomas Monjalon --- lib/librte_mbuf/rte_mbuf.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index 029822226..63a03c2f7 100644 --- a/lib/librte_mbuf/rte_mbuf.h +++ b/lib/librte_mbuf/rte_mbuf.h @@ -201,14 +201,17 @@ 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 the inner part + * of 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 are required: + * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. */ #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