From: Thomas Monjalon <thomas@monjalon.net>
To: olivier.matz@6wind.com
Cc: dev@dpdk.org, xuemingl@mellanox.com, stable@dpdk.org
Subject: [dpdk-dev] [PATCH v2 2/2] mbuf: improve API doc for tunnel Tx offloads
Date: Mon, 23 Apr 2018 12:48:36 +0200 [thread overview]
Message-ID: <20180423104836.24299-3-thomas@monjalon.net> (raw)
In-Reply-To: <20180423104836.24299-1-thomas@monjalon.net>
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 <thomas@monjalon.net>
---
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
next prev parent reply other threads:[~2018-04-23 10:48 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-20 0:13 [dpdk-dev] [PATCH 0/2] mbuf: improve Tx offload API doc Thomas Monjalon
2018-04-20 0:13 ` [dpdk-dev] [PATCH 1/2] mbuf: fix Tx checksum " Thomas Monjalon
2018-04-23 8:14 ` Olivier Matz
2018-04-20 0:13 ` [dpdk-dev] [PATCH 2/2] mbuf: improve API doc for tunnel Tx offloads Thomas Monjalon
2018-04-23 8:14 ` Olivier Matz
2018-04-23 8:53 ` Thomas Monjalon
2018-04-23 9:03 ` Olivier Matz
2018-04-23 10:48 ` [dpdk-dev] [PATCH v2 0/2] mbuf: improve Tx offload API doc Thomas Monjalon
2018-04-23 10:48 ` [dpdk-dev] [PATCH v2 1/2] mbuf: fix Tx checksum " Thomas Monjalon
2018-04-23 10:48 ` Thomas Monjalon [this message]
2018-04-23 11:06 ` [dpdk-dev] [PATCH v2 2/2] mbuf: improve API doc for tunnel Tx offloads Olivier Matz
2018-04-23 14:10 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180423104836.24299-3-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=dev@dpdk.org \
--cc=olivier.matz@6wind.com \
--cc=stable@dpdk.org \
--cc=xuemingl@mellanox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).