[dpdk-dev] [PATCH 1/2] mbuf: fix Tx checksum offload API doc

[Olivier Matz]

On Fri, Apr 20, 2018 at 02:13:23AM +0200, Thomas Monjalon wrote:
> When introducing rte_eth_tx_prepare(), the constraints on checksum
> pre-filling for Tx offloads were relaxed because implemented in
> the PMDs with rte_net_intel_cksum_flags_prepare() helper.
> As a consequence, these old requirements are removed for:
> 	- PKT_TX_OUTER_IP_CKSUM
> 	- PKT_TX_IP_CKSUM
> 	- PKT_TX_[L4]_CKSUM
> 	- PKT_TX_TCP_SEG
> 
> Not sure SCTP offload is properly implemented though.
> 
> A reference to rte_eth_tx_prepare() is added in rte_eth_tx_burst() doc.
> 
> Fixes: 4fb7e803eb1a ("ethdev: add Tx preparation")
> Cc: tomaszx.kulasek at intel.com
> 
> Signed-off-by: Thomas Monjalon <thomas at monjalon.net>

Acked-by: Olivier Matz <olivier.matz at 6wind.com>


> @@ -288,10 +280,8 @@ extern "C" {
>  
>  /**
>   * Offload the IP checksum of an external header in the hardware. The
> - * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh
> - * a PMD will only check PKT_TX_IP_CKSUM.  The IP checksum field in the
> - * packet must be set to 0.
> - *  - set the outer IP checksum field in the packet to 0
> + * flag PKT_TX_OUTER_IPV4 should also be set by the application, altough
> + * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
>   *  - fill the mbuf offload information: outer_l2_len, outer_l3_len
>   */
>  #define PKT_TX_OUTER_IP_CKSUM   (1ULL << 58)

Nice catch (PKT_TX_IP_CKSUM -> PKT_TX_OUTER_IP_CKSUM).

It could eventually deserve also a:
Fixes: 609dd68ef14f ("mbuf: enhance the API documentation of offload flags")


Thanks
Olivier