doc: clarify TSO Tx offload prerequisite

Message ID 20181101084546.4393-1-jerin.jacob@caviumnetworks.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series doc: clarify TSO Tx offload prerequisite |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK

Commit Message

Jerin Jacob Nov. 1, 2018, 8:46 a.m. UTC
  Based on the PKT_TX_TCP_SEG definition,
the application needs to update PKT_TX_IPV4 or PKT_TX_IPV6
based on IPV4 or IPV6 packet and PKT_TX_IP_CKSUM ol_flags
to enable Tx TSO offload.

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

Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---
Definition of PKT_TX_TCP_SEG
https://git.dpdk.org/dpdk/tree/lib/librte_mbuf/rte_mbuf.h#n289
---
 doc/guides/nics/features.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Ferruh Yigit Nov. 1, 2018, 1:33 p.m. UTC | #1
On 11/1/2018 8:46 AM, Jerin Jacob wrote:
> Based on the PKT_TX_TCP_SEG definition,
> the application needs to update PKT_TX_IPV4 or PKT_TX_IPV6
> based on IPV4 or IPV6 packet and PKT_TX_IP_CKSUM ol_flags
> to enable Tx TSO offload.
> 
> Fixes: dad1ec72a377 ("doc: document NIC features")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> ---
> Definition of PKT_TX_TCP_SEG
> https://git.dpdk.org/dpdk/tree/lib/librte_mbuf/rte_mbuf.h#n289

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Ferruh Yigit Nov. 2, 2018, 8:37 p.m. UTC | #2
On 11/1/2018 1:33 PM, Ferruh Yigit wrote:
> On 11/1/2018 8:46 AM, Jerin Jacob wrote:
>> Based on the PKT_TX_TCP_SEG definition,
>> the application needs to update PKT_TX_IPV4 or PKT_TX_IPV6
>> based on IPV4 or IPV6 packet and PKT_TX_IP_CKSUM ol_flags
>> to enable Tx TSO offload.
>>
>> Fixes: dad1ec72a377 ("doc: document NIC features")
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
>> ---
>> Definition of PKT_TX_TCP_SEG
>> https://git.dpdk.org/dpdk/tree/lib/librte_mbuf/rte_mbuf.h#n289
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.
  

Patch

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index 3fa5cb745..d3f904839 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -208,7 +208,7 @@  Supports TCP Segmentation Offloading.
 
 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_TCP_TSO``.
 * **[uses]       rte_eth_desc_lim**: ``nb_seg_max``, ``nb_mtu_seg_max``.
-* **[uses]       mbuf**: ``mbuf.ol_flags:PKT_TX_TCP_SEG``.
+* **[uses]       mbuf**: ``mbuf.ol_flags:`` ``PKT_TX_TCP_SEG``, ``PKT_TX_IPV4``, ``PKT_TX_IPV6``, ``PKT_TX_IP_CKSUM``.
 * **[uses]       mbuf**: ``mbuf.tso_segsz``, ``mbuf.l2_len``, ``mbuf.l3_len``, ``mbuf.l4_len``.
 * **[implements] datapath**: ``TSO functionality``.
 * **[provides]   rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_TCP_TSO,DEV_TX_OFFLOAD_UDP_TSO``.