Hi Akhil, > -----Original Message----- > From: Akhil Goyal [mailto:akhil.go...@nxp.com] > Sent: Tuesday, August 8, 2017 8:10 AM > To: dev@dpdk.org; Doherty, Declan <declan.dohe...@intel.com>; > tho...@monjalon.net; Nicolau, Radu <radu.nico...@intel.com>; > avia...@mellanox.com; bor...@mellanox.com; > hemant.agra...@nxp.com; De Lara Guarch, Pablo > <pablo.de.lara.gua...@intel.com> > Cc: shah...@mellanox.com; Akhil Goyal <akhil.go...@nxp.com> > Subject: [PATCH v2] doc: announce ABI change for cryptodev and ethdev > > Support for security operations is planned to be added in ethdev and > cryptodev for the 17.11 release. > > For this following changes are required. > - rte_cryptodev and rte_eth_dev structures need to be added new > parameter rte_security_ops which extend support for security ops to the > corresponding driver. > - rte_cryptodev_info and rte_eth_dev_info need to be added with > rte_security_capabilities to identify the capabilities of the corresponding > driver. > - rte_security_session needs to be added in the union inside structure > rte_crypto_sym_op to decide between various types of sessions > > Signed-off-by: Akhil Goyal <akhil.go...@nxp.com> > Acked-by: Hemant Agrawal <hemant.agra...@nxp.com> > Acked-by: Boris Pismenny <bor...@mellanox.com> > Acked-by: Shahaf Shuler <shah...@mellanox.com> > Acked-by: Pablo de Lara <pablo.de.lara.gua...@intel.com> > --- > changes in v2: > Added one more ABI change wrt to security session, This patch is not split > into 3 patches as these all will be implemented simultaneously with > rte_security support. > > doc/guides/rel_notes/deprecation.rst | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) > > diff --git a/doc/guides/rel_notes/deprecation.rst > b/doc/guides/rel_notes/deprecation.rst > index 72d1f35..e34a809 100644 > --- a/doc/guides/rel_notes/deprecation.rst > +++ b/doc/guides/rel_notes/deprecation.rst > @@ -78,3 +78,18 @@ Deprecation Notices > be removed in 17.11: > > - ``rte_cryptodev_create_vdev`` > + > +* cryptodev: new parameters - ``rte_security_capabilities`` and > + ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and > + ``rte_cryptodev`` respectively to support security protocol offloaded > + operations. > + > +* cryptodev: new parameter ``rte_security_session`` will be added in > +the union > + of the structure ``rte_crypto_sym_op``, so that the user can choose > +either to > + use ``rte_cryptodev_sym_session`` or ``rte_crypto_sym_xform`` or > + ``rte_security_session``.
I don't think it is required to have a deprecation notice for this, as it is adding another element in a union, and it is not changing its size. However, this would require an addition in rte_crypto_op_sess_type, which, as long as it is added at the end, should not require a deprecation notice. About splitting this into two patches, I would do it, as I believe deprecation notices should target a specific library.
