From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wg0-f51.google.com (mail-wg0-f51.google.com [74.125.82.51]) by dpdk.org (Postfix) with ESMTP id 6C98F7F6D for ; Fri, 14 Nov 2014 17:53:48 +0100 (CET) Received: by mail-wg0-f51.google.com with SMTP id k14so633321wgh.24 for ; Fri, 14 Nov 2014 09:03:52 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=Cb3emR4KBzm3AcR9V0RHxoQrfar5a0h4Nl1F3MpQEV8=; b=Pveuar7P9AIIwN1XFYqMRROhOxyI1GAGIT9kaazg89awRdmkgcJ1A7zcx55lp4aUVG Wj2U/kyC7ac5SmkbuOroV7hJFZSG1rcvi+nRHt5U1bqkMmz0Q0KRRJOMFu9qxGAWXfVi ik46q3YFGNsBt1CxonXtH4645ZryOWM/X5zoF4B5mPJ2XCb367xbRgUo/8uYR02VfAQZ GZdGbe9kr5I0J485zU0ZOddgwO7PhZCPU1OzdKvK/BXWKqz5A28ixFhUgOz4QKCVHVas Lvpc7YX1qauo0qonxwO9vUNWY+mrvt3Bg8kT4u9ow0gdUfO7yVUoLN9wZpY1l+z2JKLO fg4w== X-Gm-Message-State: ALoCoQnhiARfDcJr2FGS6kWm9Hx+6MhTrTD3nzPOpgDKRwZgImafGmKwL13E1ZhBWL7dD5GMzF8k X-Received: by 10.180.14.226 with SMTP id s2mr9129562wic.61.1415984632351; Fri, 14 Nov 2014 09:03:52 -0800 (PST) Received: from glumotte.dev.6wind.com (guy78-3-82-239-227-177.fbx.proxad.net. [82.239.227.177]) by mx.google.com with ESMTPSA id cu9sm40352554wjb.0.2014.11.14.09.03.51 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 14 Nov 2014 09:03:51 -0800 (PST) From: Olivier Matz To: dev@dpdk.org Date: Fri, 14 Nov 2014 18:03:20 +0100 Message-Id: <1415984609-2484-5-git-send-email-olivier.matz@6wind.com> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1415984609-2484-1-git-send-email-olivier.matz@6wind.com> References: <1415635166-1364-1-git-send-email-olivier.matz@6wind.com> <1415984609-2484-1-git-send-email-olivier.matz@6wind.com> Cc: jigsaw@gmail.com Subject: [dpdk-dev] [PATCH v2 04/13] mbuf: add help about TX checksum flags X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 14 Nov 2014 16:53:48 -0000 Describe how to use hardware checksum API. Signed-off-by: Olivier Matz Acked-by: Bruce Richardson --- lib/librte_mbuf/rte_mbuf.h | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index 029c669..d7070e9 100644 --- a/lib/librte_mbuf/rte_mbuf.h +++ b/lib/librte_mbuf/rte_mbuf.h @@ -95,19 +95,28 @@ extern "C" { #define PKT_RX_TUNNEL_IPV6_HDR (1ULL << 12) /**< RX tunnel packet with IPv6 header. */ #define PKT_TX_VLAN_PKT (1ULL << 55) /**< TX packet is a 802.1q VLAN packet. */ -#define PKT_TX_IP_CKSUM (1ULL << 54) /**< IP cksum of TX pkt. computed by NIC. */ + +/** + * Enable hardware computation of IP cksum. To use it: + * - fill l2_len and l3_len in mbuf + * - set the flags PKT_TX_IP_CKSUM + * - set the ip checksum to 0 in IP header + */ +#define PKT_TX_IP_CKSUM (1ULL << 54) #define PKT_TX_IPV4_CSUM PKT_TX_IP_CKSUM /**< Alias of PKT_TX_IP_CKSUM. */ #define PKT_TX_IPV4 PKT_RX_IPV4_HDR /**< IPv4 with no IP checksum offload. */ #define PKT_TX_IPV6 PKT_RX_IPV6_HDR /**< IPv6 packet */ -/* - * Bits 52+53 used for L4 packet type with checksum enabled. - * 00: Reserved - * 01: TCP checksum - * 10: SCTP checksum - * 11: UDP checksum +/** + * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, + * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware + * L4 checksum offload, the user needs to: + * - fill l2_len and l3_len in mbuf + * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM + * - calculate the pseudo header checksum and set it in the L4 header (only + * for TCP or UDP). For SCTP, set the crc field to 0. */ -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ +#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /* Disable L4 cksum of TX pkt. */ #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */ #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */ #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */ -- 2.1.0