From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pablo.de.lara.guarch@intel.com>
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
 by dpdk.org (Postfix) with ESMTP id DF4E91B40F
 for <dev@dpdk.org>; Tue, 30 Jan 2018 13:14:33 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga007.fm.intel.com ([10.253.24.52])
 by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 30 Jan 2018 04:14:32 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.46,434,1511856000"; d="scan'208";a="14030106"
Received: from silpixa00399464.ir.intel.com (HELO
 silpixa00399464.ger.corp.intel.com) ([10.237.222.157])
 by fmsmga007.fm.intel.com with ESMTP; 30 Jan 2018 04:14:29 -0800
From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
To: akhil.goyal@nxp.com, hemant.agrawal@nxp.com, declan.doherty@intel.com,
 jerin.jacob@caviumnetworks.com, fiona.trahe@intel.com,
 john.griffin@intel.com, deepak.k.jain@intel.com, jck@semihalf.com,
 tdu@semihalf.com, dima@marvell.com, nsamsono@marvell.com,
 jianbo.liu@arm.com
Cc: dev@dpdk.org,
	Pablo de Lara <pablo.de.lara.guarch@intel.com>
Date: Tue, 30 Jan 2018 12:14:14 +0000
Message-Id: <20180130121415.16623-3-pablo.de.lara.guarch@intel.com>
X-Mailer: git-send-email 2.14.3
In-Reply-To: <20180130121415.16623-1-pablo.de.lara.guarch@intel.com>
References: <20180126090355.25903-1-pablo.de.lara.guarch@intel.com>
 <20180130121415.16623-1-pablo.de.lara.guarch@intel.com>
Subject: [dpdk-dev] [PATCH v2 2/3] doc: announce deprecation for
	attach/detach crypto session
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 30 Jan 2018 12:14:34 -0000

Functions rte_cryptodev_queue_pair_attach_sym_session
and rte_cryptodev_queue_pair_detach_sym_sessions
are not really used in any of the crypto drivers
(only one driver implements it and it just return 0).
Therefore, this API can be deprecated from 18.02
and removed in 18.05.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 lib/librte_cryptodev/rte_cryptodev.h | 2 ++
 2 files changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 5588ba7c1..bd4200bba 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -64,3 +64,8 @@ Deprecation Notices
   and ``max_nb_sessions_per_qp``, in structure ``rte_cryptodev_info``,
   will be removed in 18.05, as these fields are not relevant anymore
   since the session mempool is not internal in the crypto device anymore.
+
+* cryptodev: Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
+  ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
+  18.02 and removed in 18.05, as there are no drivers doing anything useful
+  with them.
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index c8fa68935..4597f864d 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -986,6 +986,7 @@ unsigned int
 rte_cryptodev_get_private_session_size(uint8_t dev_id);
 
 /**
+ * @deprecated
  * Attach queue pair with sym session.
  *
  * @param	dev_id		Device to which the session will be attached.
@@ -1002,6 +1003,7 @@ rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
 		struct rte_cryptodev_sym_session *session);
 
 /**
+ * @deprecated
  * Detach queue pair with sym session.
  *
  * @param	dev_id		Device to which the session is attached.
-- 
2.14.3