summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomasz Kulasek <tomaszx.kulasek@intel.com>2017-05-04 17:37:23 +0200
committerThomas Monjalon <thomas@monjalon.net>2017-05-11 02:49:51 +0200
commita1472bc8d984e50d1ec3ee5780bb1c9b85cd10e1 (patch)
tree03f3afaf704aa3b8e1c1381c50d4620882efa9c8
parent9aa261109cac8d7a3aea94cd61475b2c8217fa25 (diff)
downloaddpdk-a1472bc8d984e50d1ec3ee5780bb1c9b85cd10e1.zip
dpdk-a1472bc8d984e50d1ec3ee5780bb1c9b85cd10e1.tar.gz
dpdk-a1472bc8d984e50d1ec3ee5780bb1c9b85cd10e1.tar.xz
doc: announce API changes for crypto sessions
API changes are planned for 17.08 to made sessions agnostic to the underlaying devices, removing coupling with crypto PMDs, so a single session can be used on multiple devices. It requires to change "struct rte_cryptodev_sym_session" to store more than one private data for devices, as well as remove redundant dev_id and dev_type. Effected public functions: - rte_cryptodev_sym_session_pool_create - rte_cryptodev_sym_session_create - rte_cryptodev_sym_session_free While session will not be directly associated with device, followed API will be changed adding uint8_t dev_id to the argument list: - rte_cryptodev_queue_pair_attach_sym_session - rte_cryptodev_queue_pair_detach_sym_session Signed-off-by: Tomasz Kulasek <tomaszx.kulasek@intel.com> Acked-by: Declan Doherty <declan.doherty@intel.com> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
-rw-r--r--doc/guides/rel_notes/deprecation.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 978c950..2ad6f13 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -92,6 +92,27 @@ Deprecation Notices
- the function ``rte_cryptodev_count_devtype`` will be replaced by
``rte_cryptodev_device_count_by_driver``
+* cryptodev: API changes are planned for 17.08 for the sessions management
+ to make it agnostic to the underlying devices, removing coupling with
+ crypto PMDs, so a single session can be used on multiple devices.
+
+ - ``struct rte_cryptodev_sym_session``, dev_id, dev_type will be removed,
+ _private field changed to the indirect array of private data pointers of
+ all supported devices
+
+ An API of followed functions will be changed to allow operate on multiple
+ devices with one session:
+
+ - ``rte_cryptodev_sym_session_create``
+ - ``rte_cryptodev_sym_session_free``
+ - ``rte_cryptodev_sym_session_pool_create``
+
+ While dev_id will not be stored in the ``struct rte_cryptodev_sym_session``,
+ directly, the change of followed API is required:
+
+ - ``rte_cryptodev_queue_pair_attach_sym_session``
+ - ``rte_cryptodev_queue_pair_detach_sym_session``
+
* crypto/scheduler: the following two functions are deprecated starting
from 17.05 and will be removed in 17.08: