doc: announce change in crypto raw data vector

Message ID 20210805080538.12063-1-hemant.agrawal@nxp.com (mailing list archive)
State Superseded, archived
Headers
Series doc: announce change in crypto raw data vector |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-spell-check-testing warning Testing issues
ci/github-robot success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing fail Testing issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing fail Testing issues

Commit Message

Hemant Agrawal Aug. 5, 2021, 8:05 a.m. UTC
  The current crypto raw data vectors need to be extended to support
out of place processing. It is proposed to add additional desl_sgl
to provide details for destination sgl.
The same is also extended to support rte_security usecases, where
we need total data length to know how much additional memory space
is available in buffer other than data length so that driver/HW
can write expanded size data after encryption.

Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
  

Comments

Fan Zhang Aug. 5, 2021, 1:49 p.m. UTC | #1
Hi Hemant,

> -----Original Message-----
> From: Hemant Agrawal <hemant.agrawal@nxp.com>
> Sent: Thursday, August 5, 2021 9:06 AM
> To: dev@dpdk.org; gakhil@marvell.com
> Cc: anoobj@marvell.com; Nicolau, Radu <radu.nicolau@intel.com>; Doherty,
> Declan <declan.doherty@intel.com>; matan@nvidia.com; Ananyev,
> Konstantin <konstantin.ananyev@intel.com>; thomas@monjalon.net; Zhang,
> Roy Fan <roy.fan.zhang@intel.com>; asomalap@amd.com;
> ruifeng.wang@arm.com; ajit.khaparde@broadcom.com; De Lara Guarch,
> Pablo <pablo.de.lara.guarch@intel.com>; Trahe, Fiona
> <fiona.trahe@intel.com>; adwivedi@marvell.com;
> jianjay.zhou@huawei.com; Gagandeep Singh <G.Singh@nxp.com>
> Subject: [PATCH] doc: announce change in crypto raw data vector
> 
> The current crypto raw data vectors need to be extended to support
> out of place processing. It is proposed to add additional desl_sgl
> to provide details for destination sgl.
> The same is also extended to support rte_security usecases, where
> we need total data length to know how much additional memory space
> is available in buffer other than data length so that driver/HW
> can write expanded size data after encryption.
> 
> Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index f4a4d00db2..c19a306c93 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -193,3 +193,15 @@ Deprecation Notices
>    reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
>    information from the crypto/security operation. This field will be used to
>    communicate events such as soft expiry with IPsec in lookaside mode.
> +
> +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to
> add
> +  ``dest_sgl`` to support out of place processing. This field will be null for
> +  inplace processing. This change is targeted for DPDK 21.11
> +
> +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> +  ``tot_len`` to support total buffer length. This is required for security
> +  cases like IPsec and PDCP encryption offload to know how much additional
> +  memory space is available in buffer other than data length so that
> driver/HW
> +  can write expanded size data after encryption. This change is targeted for
> +  DPDK 21.11
> +
> --
> 2.17.1

To add ``dest_sgl`` to ``rte_crypto_sym_vec`` I suppose it is better to rename ``sgl`` to ``src_sgl`` in this deprecating notice too?

Regards,
Fan
  
Hemant Agrawal Aug. 5, 2021, 1:52 p.m. UTC | #2
> > -----Original Message-----
> > From: Hemant Agrawal <hemant.agrawal@nxp.com>
> > Sent: Thursday, August 5, 2021 9:06 AM
> > To: dev@dpdk.org; gakhil@marvell.com
> > Cc: anoobj@marvell.com; Nicolau, Radu <radu.nicolau@intel.com>;
> > Doherty, Declan <declan.doherty@intel.com>; matan@nvidia.com;
> Ananyev,
> > Konstantin <konstantin.ananyev@intel.com>; thomas@monjalon.net;
> Zhang,
> > Roy Fan <roy.fan.zhang@intel.com>; asomalap@amd.com;
> > ruifeng.wang@arm.com; ajit.khaparde@broadcom.com; De Lara Guarch,
> > Pablo <pablo.de.lara.guarch@intel.com>; Trahe, Fiona
> > <fiona.trahe@intel.com>; adwivedi@marvell.com;
> > jianjay.zhou@huawei.com; Gagandeep Singh <G.Singh@nxp.com>
> > Subject: [PATCH] doc: announce change in crypto raw data vector
> >
> > The current crypto raw data vectors need to be extended to support out
> > of place processing. It is proposed to add additional desl_sgl to
> > provide details for destination sgl.
> > The same is also extended to support rte_security usecases, where we
> > need total data length to know how much additional memory space is
> > available in buffer other than data length so that driver/HW can write
> > expanded size data after encryption.
> >
> > Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
> >  1 file changed, 12 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index f4a4d00db2..c19a306c93 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -193,3 +193,15 @@ Deprecation Notices
> >    reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and
> other
> >    information from the crypto/security operation. This field will be used to
> >    communicate events such as soft expiry with IPsec in lookaside mode.
> > +
> > +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to
> > add
> > +  ``dest_sgl`` to support out of place processing. This field will be
> > + null for  inplace processing. This change is targeted for DPDK 21.11
> > +
> > +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> > +  ``tot_len`` to support total buffer length. This is required for
> > +security
> > +  cases like IPsec and PDCP encryption offload to know how much
> > +additional
> > +  memory space is available in buffer other than data length so that
> > driver/HW
> > +  can write expanded size data after encryption. This change is
> > + targeted for  DPDK 21.11
> > +
> > --
> > 2.17.1
> 
> To add ``dest_sgl`` to ``rte_crypto_sym_vec`` I suppose it is better to rename
> ``sgl`` to ``src_sgl`` in this deprecating notice too?
[Hemant] I was just trying to minimize the changes. But it can be done. 

> 
> Regards,
> Fan
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index f4a4d00db2..c19a306c93 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -193,3 +193,15 @@  Deprecation Notices
   reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
   information from the crypto/security operation. This field will be used to
   communicate events such as soft expiry with IPsec in lookaside mode.
+
+* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
+  ``dest_sgl`` to support out of place processing. This field will be null for
+  inplace processing. This change is targeted for DPDK 21.11
+
+* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
+  ``tot_len`` to support total buffer length. This is required for security
+  cases like IPsec and PDCP encryption offload to know how much additional
+  memory space is available in buffer other than data length so that driver/HW
+  can write expanded size data after encryption. This change is targeted for
+  DPDK 21.11
+