doc: announce cryptodev xform API change
authorFan Zhang <roy.fan.zhang@intel.com>
Fri, 22 Mar 2019 16:34:31 +0000 (16:34 +0000)
committerAkhil Goyal <akhil.goyal@nxp.com>
Wed, 3 Apr 2019 09:33:16 +0000 (11:33 +0200)
This patch adds the deprecation notice of changing Cryptodev
symmetric xform structure. The proposed change is to making
key pointers in the crypto xforms (cipher, auth, aead) to
indicate neither the library or the drivers will not change
the content of the key buffer.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Anoob Joseph <anoobj@marvell.com>
doc/guides/rel_notes/deprecation.rst

index d5a79a3..ba39c2d 100644 (file)
@@ -83,3 +83,7 @@ Deprecation Notices
   - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config``
 
   The field would be added in v19.08.
+
+* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
+  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
+  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.