doc: add cryptodev xform deprecation notice

diff mbox series

This patch adds the deprecation notice of changing Cryptodev
symmetric xform structure for DPDK 19.05.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Hi Fan,

On 2/8/2019 4:47 PM, Fan Zhang wrote:
> This patch adds the deprecation notice of changing Cryptodev
> symmetric xform structure for DPDK 19.05.
It would be better if a need of this change is explained in the 
description of the patch and I believe the change will be accepted for 
19.08 release and not 19.05.
>
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 1b4fcb7e6..5166d6eb5 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -75,3 +75,9 @@ Deprecation Notices
>   
>   * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
>     changed from 0.49.0 to 0.52.0.
> +
> +* 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`` in
> +  19.05. The structure ``rte_table_action_sym_crypto_params`` in pipeline
> +  library will be updated accordingly.

Hi,

The reason of this change is for a more formal API for cryptodev. Since the
key is for creating session and not meant to be modified by the driver.

The patch is finished I am doing some last checks. Is there any reason to
delay the patch for 19.08?

Regards,
Fan

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal@nxp.com]
> Sent: Thursday, February 28, 2019 10:08 AM
> To: Zhang, Roy Fan <roy.fan.zhang@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: add cryptodev xform deprecation
> notice
> 
> Hi Fan,
> 
> On 2/8/2019 4:47 PM, Fan Zhang wrote:
> > This patch adds the deprecation notice of changing Cryptodev symmetric
> > xform structure for DPDK 19.05.
> It would be better if a need of this change is explained in the description of
> the patch and I believe the change will be accepted for
> 19.08 release and not 19.05.
> >
> > Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> > ---
> >   doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >   1 file changed, 6 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index 1b4fcb7e6..5166d6eb5 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -75,3 +75,9 @@ Deprecation Notices
> >
> >   * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version
> will be
> >     changed from 0.49.0 to 0.52.0.
> > +
> > +* 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`` in
> > +  19.05. The structure ``rte_table_action_sym_crypto_params`` in
> > +pipeline
> > +  library will be updated accordingly.