From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E2C53A0C43 for ; Thu, 16 Sep 2021 18:10:52 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D200241121; Thu, 16 Sep 2021 18:10:52 +0200 (CEST) Received: from mail-pj1-f50.google.com (mail-pj1-f50.google.com [209.85.216.50]) by mails.dpdk.org (Postfix) with ESMTP id 2BAD04069E for ; Thu, 16 Sep 2021 18:10:51 +0200 (CEST) Received: by mail-pj1-f50.google.com with SMTP id mv7-20020a17090b198700b0019c843e7233so1385356pjb.4 for ; Thu, 16 Sep 2021 09:10:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; h=from:to:cc:subject:date:message-id:mime-version; bh=eJ8u+j3WFboL1iic/g3cn7volMsuKP/A9gntkwTEHgg=; b=FoxwTo6IErzax5sVzip+3c0ZfdtDZIpe4rTQNPnUTyf4OB5DSLYEnwGS8dm2fSRKu4 9FUKTX1DHX0AEzyFv4OdkiASsYEL/6x0YGl9mf3aZ9qxQe77Urbxmkl4xEpmbU58kgSu +VHmiAFM/ye8vrGlwtYUqMqjcPL7q0RkUQApM= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version; bh=eJ8u+j3WFboL1iic/g3cn7volMsuKP/A9gntkwTEHgg=; b=YeaS5XcMkmORcPphow9kNUX4ZhiQNNHobEHAd3rGJPuP0WMsMdWWRXadajD1Q+OdKn F5oNcpYd8jVrJC2J3HwUOmXvW4EfoV2FnbYLM+U24izZ40MbaAc89gT7ApEh6M3XhgAw AqJ/eprxoZELe7geQWWwJ1mQz8EkyYT6NpuFULYS5Dj4L4pWZrzTlzGcUg9CTt0mpKA2 UTPlgAJv4yT0PLSMx0IAimuB9GWF8ThnfQiD4+b7mG8aXeKBL5lT6Qd+36LIRIlYbCZl gIxDXkdCBF3Dc5MVT92ASIodT+6xurG+ycxKk/0qzA641zPXr4nbtdoNc1SsS9NwQ3Kq 4GvQ== X-Gm-Message-State: AOAM530M5soAUfwWqbblMpVxeVneynfxkUaGtXX0JY0Ugjdu0yLyukcj Ygqx9gsEXyL1zXwDbhR1iT/Yjw== X-Google-Smtp-Source: ABdhPJz66UHnvTODVSXwiK9Tcu4c0FG4s92EWUnzvA2InSdvyAfFC89EFQMdjIunaYv3mS0MRYEEBA== X-Received: by 2002:a17:90b:38cc:: with SMTP id nn12mr12055364pjb.81.1631808650188; Thu, 16 Sep 2021 09:10:50 -0700 (PDT) Received: from localhost.localdomain ([192.19.11.250]) by smtp.gmail.com with ESMTPSA id mi18sm3433033pjb.15.2021.09.16.09.10.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 16 Sep 2021 09:10:49 -0700 (PDT) From: Lance Richardson To: Olivier Matz , Konstantin Ananyev , =?UTF-8?q?Morten=20Br=C3=B8rup?= , Andrew Rybchenko Cc: dev@dpdk.org, stable@dpdk.org Date: Thu, 16 Sep 2021 12:10:40 -0400 Message-Id: <20210916161040.346703-1-lance.richardson@broadcom.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Type: multipart/signed; protocol="application/pkcs7-signature"; micalg=sha-256; boundary="000000000000f4d46105cc1f0edf" X-Content-Filtered-By: Mailman/MimeDel 2.1.29 Subject: [dpdk-stable] [PATCH] net: fix checksum API documentation X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" --000000000000f4d46105cc1f0edf Content-Transfer-Encoding: 8bit Minor corrections and improvements to documentation for checksum APIs. Fixes: 6006818cfb26 ("net: new checksum functions") Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums") Cc: stable@dpdk.org Signed-off-by: Lance Richardson --- lib/net/rte_ip.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h index 05948b69b7..fd08ea31b2 100644 --- a/lib/net/rte_ip.h +++ b/lib/net/rte_ip.h @@ -488,7 +488,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags) } /** - * @internal Calculate the non-complemented IPv4 L4 checksum + * @internal Calculate the non-complemented IPv6 L4 checksum */ static inline uint16_t __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr) @@ -509,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr) /** * Process the IPv6 UDP or TCP checksum. * - * The IPv4 header should not contains options. The layer 4 checksum - * must be set to 0 in the packet by the caller. + * The IPv6 header must not be followed by extension headers. The layer 4 + * checksum must be set to 0 in the L4 header by the caller. * * @param ipv6_hdr * The pointer to the contiguous IPv6 header. * @param l4_hdr * The pointer to the beginning of the L4 header. * @return - * The complemented checksum to set in the IP packet. + * The complemented checksum to set in the L4 header. */ static inline uint16_t rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr) -- 2.25.1 --000000000000f4d46105cc1f0edf--