doc: announce crypto device type enumeration removal
authorSlawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
Fri, 5 May 2017 11:24:19 +0000 (13:24 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Thu, 11 May 2017 00:46:10 +0000 (02:46 +0200)
Refer to RFC patch - cryptodev: remove crypto device type enumeration

It is planned to remove device type enumeration rte_cryptodev_type from
library to remove the coupling between crypto PMD and the librte_cryptodev.

In this case following stuctures will be changed: rte_cryptodev_session,
rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.

It is planned to change the function rte_cryptodev_count_devtype().
The function prototype doesn’t clearly show the operation.
>From next release 17.08 the dev_type will be changed to driver_id.
So the function name will change to rte_cryptodev_device_count_by_driver().

Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Declan Doherty <declan.doherty@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
doc/guides/rel_notes/deprecation.rst

index ce4e0bb..978c950 100644 (file)
@@ -84,6 +84,14 @@ Deprecation Notices
 * cryptodev: All PMD names definitions will be moved to the individual PMDs
   in 17.08.
 
+* cryptodev: The following changes will be done in in 17.08:
+
+  - the device type enumeration ``rte_cryptodev_type`` will be removed
+  - the following structures will be changed: ``rte_cryptodev_session``,
+    ``rte_cryptodev_sym_session``, ``rte_cryptodev_info``, ``rte_cryptodev``
+  - the function ``rte_cryptodev_count_devtype`` will be replaced by
+    ``rte_cryptodev_device_count_by_driver``
+
 * crypto/scheduler: the following two functions are deprecated starting
   from 17.05 and will be removed in 17.08: