summaryrefslogtreecommitdiff
path: root/lib/librte_mbuf
diff options
context:
space:
mode:
authorThomas Monjalon <thomas@monjalon.net>2018-04-20 01:53:10 +0200
committerThomas Monjalon <thomas@monjalon.net>2018-04-23 16:09:23 +0200
commitab66fe0e4a1ca058c4e23efd475e48788c0977e7 (patch)
treeefc4f56ae8bf0cd6cabf888922dd82dbcdb6a76b /lib/librte_mbuf
parentf00dcb7b0a74928b8b846f73b37386d7b1bb4869 (diff)
downloaddpdk-ab66fe0e4a1ca058c4e23efd475e48788c0977e7.zip
dpdk-ab66fe0e4a1ca058c4e23efd475e48788c0977e7.tar.gz
dpdk-ab66fe0e4a1ca058c4e23efd475e48788c0977e7.tar.xz
mbuf: improve tunnel Tx offloads API doc
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> Acked-by: Olivier Matz <olivier.matz@6wind.com>
Diffstat (limited to 'lib/librte_mbuf')
-rw-r--r--lib/librte_mbuf/rte_mbuf.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index 0298222..63a03c2 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)