diff mbox series

[v2,1/3] ethdev: add description for KEEP CRC offload

Message ID 20240718114806.577298-2-haijie1@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series bugfix about KEEP CRC offload |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Jie Hai July 18, 2024, 11:48 a.m. UTC 
From: Dengdui Huang <huangdengdui@huawei.com>

The data execeed the pkt_len in mbuf is inavailable for user.
When KEEP CRC offload is enabled, CRC field length should be
included pkt_len in mbuf. However, almost of drivers supported
KEEP CRC feature didn't add the CRC data length to pkt_len.
So it is very necessary to add a coments for this.

Fixes: 70815c9ecadd ("ethdev: add new offload flag to keep CRC")
Cc: stable@dpdk.org

Signed-off-by: Dengdui Huang <huangdengdui@huawei.com>
---
 lib/ethdev/rte_ethdev.h | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Morten Brørup July 18, 2024, 11:57 a.m. UTC | #1 
> From: Jie Hai [mailto:haijie1@huawei.com]
> Sent: Thursday, 18 July 2024 13.48
> 
> From: Dengdui Huang <huangdengdui@huawei.com>
> 
> The data execeed the pkt_len in mbuf is inavailable for user.
> When KEEP CRC offload is enabled, CRC field length should be
> included pkt_len in mbuf. However, almost of drivers supported
> KEEP CRC feature didn't add the CRC data length to pkt_len.
> So it is very necessary to add a coments for this.
> 
> Fixes: 70815c9ecadd ("ethdev: add new offload flag to keep CRC")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Dengdui Huang <huangdengdui@huawei.com>
> ---
>  lib/ethdev/rte_ethdev.h | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
> index 548fada1c7..3d44673161 100644
> --- a/lib/ethdev/rte_ethdev.h
> +++ b/lib/ethdev/rte_ethdev.h
> @@ -1550,6 +1550,12 @@ struct rte_eth_conf {
>   */
>  #define RTE_ETH_RX_OFFLOAD_TIMESTAMP        RTE_BIT64(14)
>  #define RTE_ETH_RX_OFFLOAD_SECURITY         RTE_BIT64(15)
> +/*

Suggest making this a Doxygen comment: /**

> + * Keep CRC data in packet.
> + *
> + * Note: If this offload is enabled, the pkt_len in mbuf should contain

"should contain" -> "must include"

> + * the CRC data length.
> + */
>  #define RTE_ETH_RX_OFFLOAD_KEEP_CRC         RTE_BIT64(16)
>  #define RTE_ETH_RX_OFFLOAD_SCTP_CKSUM       RTE_BIT64(17)
>  #define RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM  RTE_BIT64(18)
> --
> 2.33.0

With above modifications,
Acked-by: Morten Brørup <mb@smartsharesystems.com>
diff mbox series

Patch

diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 548fada1c7..3d44673161 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -1550,6 +1550,12 @@  struct rte_eth_conf {
  */
 #define RTE_ETH_RX_OFFLOAD_TIMESTAMP        RTE_BIT64(14)
 #define RTE_ETH_RX_OFFLOAD_SECURITY         RTE_BIT64(15)
+/*
+ * Keep CRC data in packet.
+ *
+ * Note: If this offload is enabled, the pkt_len in mbuf should contain
+ * the CRC data length.
+ */
 #define RTE_ETH_RX_OFFLOAD_KEEP_CRC         RTE_BIT64(16)
 #define RTE_ETH_RX_OFFLOAD_SCTP_CKSUM       RTE_BIT64(17)
 #define RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM  RTE_BIT64(18)