[2/2] doc: clarify L4 Tx checksum prerequisite
diff mbox series

Message ID 20181005044606.27026-2-jerin.jacob@caviumnetworks.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • [1/2] doc: clarify L3 Tx checksum prerequisite
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Jerin Jacob Oct. 5, 2018, 4:46 a.m. UTC
Based on PKT_TX_[TCP|UDP|SCTP]_CKSUM definition the user needs
to fill l2_len and l3_len mbuf fields before issuing HW Tx
checksum request.

Fixes: dad1ec72a377 ("doc: document NIC features")
Cc: stable@dpdk.org

Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---

See PKT_TX_TCP_CKSUM defintion at
https://git.dpdk.org/dpdk/tree/lib/librte_mbuf/rte_mbuf.h#n269

---
 doc/guides/nics/features.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Andrew Rybchenko Oct. 5, 2018, 6:45 a.m. UTC | #1
On 10/5/18 7:46 AM, Jerin Jacob wrote:
> Based on PKT_TX_[TCP|UDP|SCTP]_CKSUM definition the user needs
> to fill l2_len and l3_len mbuf fields before issuing HW Tx
> checksum request.
>
> Fixes: dad1ec72a377 ("doc: document NIC features")
> Cc: stable@dpdk.org
>
> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>

Patch
diff mbox series

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index e726a6bb8..c39fb0074 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -582,6 +582,7 @@  Supports L4 checksum offload.
 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
   ``mbuf.ol_flags:PKT_TX_L4_NO_CKSUM`` | ``PKT_TX_TCP_CKSUM`` |
   ``PKT_TX_SCTP_CKSUM`` | ``PKT_TX_UDP_CKSUM``.
+* **[uses]     mbuf**: ``mbuf.l2_len``, ``mbuf.l3_len``.
 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_L4_CKSUM_UNKNOWN`` |
   ``PKT_RX_L4_CKSUM_BAD`` | ``PKT_RX_L4_CKSUM_GOOD`` |
   ``PKT_RX_L4_CKSUM_NONE``.