From: Tomasz Kulasek Date: Thu, 4 May 2017 15:37:23 +0000 (+0200) Subject: doc: announce API changes for crypto sessions X-Git-Tag: spdx-start~3209 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=a1472bc8d984e50d1ec3ee5780bb1c9b85cd10e1;p=dpdk.git 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 Acked-by: Declan Doherty Acked-by: Pablo de Lara Acked-by: Fiona Trahe Acked-by: Akhil Goyal --- diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 978c950879..2ad6f13829 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: