From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 3AB9FA00C2;
	Mon, 23 May 2022 16:26:07 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 2B4B54014F;
	Mon, 23 May 2022 16:26:07 +0200 (CEST)
Received: from mga03.intel.com (mga03.intel.com [134.134.136.65])
 by mails.dpdk.org (Postfix) with ESMTP id E700440141
 for <dev@dpdk.org>; Mon, 23 May 2022 16:26:04 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
 d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
 t=1653315965; x=1684851965;
 h=from:to:cc:subject:date:message-id;
 bh=Fi6zXEVjFe+YFEjt+KuNxOXV0VhofC5t/ugsZ4aHi2s=;
 b=jlMui4uM11aKc5PHgXOt5ucm+rMGHcQzAzhVJT+1kuD7EbWskLbOe6k3
 PUTRpYQWAuEySArwNrFBB1TDPy+HiqOmnaKqnWFLmJ9tyc3YuNBUThyBh
 QMg8hq9OBWSHsvZW8exiSftw8owKmaP5knh3JDBmFjQPdhX/ubWAqPEWK
 UEYzd0e/8DL3sCDQyLdgtxMhrDziNOqW5NvKB5JAOxtGz5jDDnh7kROC/
 EZFcxWcrRWHJMvKfV5lryavmePNbqtpGcEL+e7UKh1xix85kZRdeIYQ+8
 63WsDLFh18oFGKVG7ch4j+UQkYL858QD1jo3Mc4hCiDqX0EMvTkC1HVh5 w==;
X-IronPort-AV: E=McAfee;i="6400,9594,10356"; a="273229717"
X-IronPort-AV: E=Sophos;i="5.91,246,1647327600"; d="scan'208";a="273229717"
Received: from orsmga008.jf.intel.com ([10.7.209.65])
 by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 23 May 2022 07:26:03 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.91,246,1647327600"; d="scan'208";a="600676321"
Received: from npg-dpdk-xuan-cbdma.sh.intel.com ([10.67.110.228])
 by orsmga008.jf.intel.com with ESMTP; 23 May 2022 07:26:01 -0700
From: xuan.ding@intel.com
To: thomas@monjalon.net,
	andrew.rybchenko@oktetlabs.ru,
	mdr@ashroe.eu
Cc: stephen@networkplumber.org, mb@smartsharesystems.com, dev@dpdk.org,
 Xuan Ding <xuan.ding@intel.com>
Subject: [PATCH] doc: announce header split deprecation
Date: Mon, 23 May 2022 14:20:16 +0000
Message-Id: <20220523142016.44451-1-xuan.ding@intel.com>
X-Mailer: git-send-email 2.17.1
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

From: Xuan Ding <xuan.ding@intel.com>

RTE_ETH_RX_OFFLOAD_HEADER_SPLIT offload was introduced some time ago to
substitute bit-field header_split in struct rte_eth_rxmode. It allows
to enable header split offload with the header size controlled using
split_hdr_size in the same structure.

Right now, no single PMD actually supports RTE_ETH_RX_OFFLOAD_HEADER_SPLIT
with above definition. Many examples and test apps initialize the field
to 0 explicitly. The most of drivers simply ignore split_hdr_size since
the offload is not advertised, but some double-check that its value is 0.

So the RTE_ETH_RX_OFFLOAD_HEADER_SPLIT and split_header_size field
will be removed in DPDK 22.11.

Signed-off-by: Xuan Ding <xuan.ding@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..b8114f29ed 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -125,3 +125,7 @@ Deprecation Notices
   applications should be updated to use the ``dmadev`` library instead,
   with the underlying HW-functionality being provided by the ``ioat`` or
   ``idxd`` dma drivers
+
+* ethdev: After bit-field header split was removed, the ``RTE_ETH_RX_OFFLOAD_HEADER_SPLIT``
+offload and the ``split_hdr_size`` field in structure ``rte_eth_rxmode`` to enable header
+split offload are not supported in any PMDs. They will be removed in DPDK 22.11.
-- 
2.17.1