From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 6A1441B1BC for ; Fri, 26 Jan 2018 12:27:44 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Jan 2018 03:27:43 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,416,1511856000"; d="scan'208";a="198994320" Received: from silpixa00399464.ir.intel.com (HELO silpixa00399464.ger.corp.intel.com) ([10.237.222.157]) by fmsmga006.fm.intel.com with ESMTP; 26 Jan 2018 03:27:39 -0800 From: Pablo de Lara 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 Date: Fri, 26 Jan 2018 11:27:32 +0000 Message-Id: <20180126112732.28967-1-pablo.de.lara.guarch@intel.com> X-Mailer: git-send-email 2.14.3 Subject: [dpdk-dev] [PATCH] doc: announce API deprecation in cryptodev X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 26 Jan 2018 11:27:44 -0000 Functions rte_cryptodev_queue_pair_start/stop are not really used in any of the crypto drivers (they all just return 0 or -ENOTSUP). Therefore, this API can be deprecated from 18.02 and removed in 18.05. Signed-off-by: Pablo de Lara --- 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 d59ad5988..c5846d849 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -59,3 +59,8 @@ Deprecation Notices be added between the producer and consumer structures. The size of the structure and the offset of the fields will remain the same on platforms with 64B cache line, but will change on other platforms. + +* cryptodev: Functions ``rte_cryptodev_queue_pair_start()`` and + ``rte_cryptodev_queue_pair_stop()`` 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..a2863b206 100644 --- a/lib/librte_cryptodev/rte_cryptodev.h +++ b/lib/librte_cryptodev/rte_cryptodev.h @@ -602,6 +602,7 @@ rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id, struct rte_mempool *session_pool); /** + * @deprecated * Start a specified queue pair of a device. It is used * when deferred_start flag of the specified queue is true. * @@ -619,6 +620,7 @@ extern int rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id); /** + * @deprecated * Stop specified queue pair of a device * * @param dev_id The identifier of the device -- 2.14.3