[dpdk-dev] doc/crypto: add clarification about chained mbuf feature

Message ID 1525354356-31000-1-git-send-email-fiona.trahe@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Fiona Trahe May 3, 2018, 1:32 p.m. UTC
  Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/cryptodevs/overview.rst |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
  

Comments

Deepak Kumar JAIN May 10, 2018, 12:29 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Fiona Trahe
> Sent: Thursday, May 3, 2018 2:33 PM
> 
> diff --git a/doc/guides/cryptodevs/overview.rst
> b/doc/guides/cryptodevs/overview.rst
> index b3cb6ca..493cd5f 100644
> --- a/doc/guides/cryptodevs/overview.rst
> +++ b/doc/guides/cryptodevs/overview.rst
> @@ -11,6 +11,16 @@ Supported Feature Flags
> 
>  .. include:: overview_feature_table.txt
> 
> +Note, the mbuf scatter gather feature (aka chained mbufs,
> +scatter-gather-lists or SGLs) indicate all following combinations are
> +supported unless otherwise called out in the Limitations section of each
> PMD.
> +
> +* In place operation, input buffer as multiple segments, same buffer
> +used for output
> +* Out of place operation, input buffer as single segment and output as
> +multiple segments
> +* Out of place operation, input buffer as multiple segments and output
> +as single segment
> +* Out of place operation, input buffer as multiple segments and output
> +as multiple segments
> +
> +
>  Supported Cipher Algorithms
>  ---------------------------
> 
> --
> 1.7.0.7
Acked-By: Deepak Kumar Jain <Deepak.k.jain@intel.com>
  
De Lara Guarch, Pablo May 21, 2018, 9:59 p.m. UTC | #2
> -----Original Message-----
> From: Jain, Deepak K
> Sent: Thursday, May 10, 2018 1:29 PM
> To: Trahe, Fiona <fiona.trahe@intel.com>; dev@dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Trahe, Fiona
> <fiona.trahe@intel.com>; hemant.agrawal@nxp.com; shreyansh.jain@nxp.com
> Subject: RE: [dpdk-dev] [PATCH] doc/crypto: add clarification about chained
> mbuf feature
> 
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Fiona Trahe
> > Sent: Thursday, May 3, 2018 2:33 PM
> >
> > diff --git a/doc/guides/cryptodevs/overview.rst
> > b/doc/guides/cryptodevs/overview.rst
> > index b3cb6ca..493cd5f 100644
> > --- a/doc/guides/cryptodevs/overview.rst
> > +++ b/doc/guides/cryptodevs/overview.rst
> > @@ -11,6 +11,16 @@ Supported Feature Flags
> >
> >  .. include:: overview_feature_table.txt
> >
> > +Note, the mbuf scatter gather feature (aka chained mbufs,
> > +scatter-gather-lists or SGLs) indicate all following combinations are
> > +supported unless otherwise called out in the Limitations section of
> > +each
> > PMD.
> > +
> > +* In place operation, input buffer as multiple segments, same buffer
> > +used for output
> > +* Out of place operation, input buffer as single segment and output
> > +as multiple segments
> > +* Out of place operation, input buffer as multiple segments and
> > +output as single segment
> > +* Out of place operation, input buffer as multiple segments and
> > +output as multiple segments
> > +
> > +
> >  Supported Cipher Algorithms
> >  ---------------------------
> >
> > --
> > 1.7.0.7
> Acked-By: Deepak Kumar Jain <Deepak.k.jain@intel.com>

Hopefully, we can have better feature flags in the next release to be able to get
the information programmatically with no ambiguity.

Applied to dpdk-next-crypto.
Thanks,

Pablo
  

Patch

diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst
index b3cb6ca..493cd5f 100644
--- a/doc/guides/cryptodevs/overview.rst
+++ b/doc/guides/cryptodevs/overview.rst
@@ -11,6 +11,16 @@  Supported Feature Flags
 
 .. include:: overview_feature_table.txt
 
+Note, the mbuf scatter gather feature (aka chained mbufs, scatter-gather-lists
+or SGLs) indicate all following combinations are supported unless otherwise called
+out in the Limitations section of each PMD.
+
+* In place operation, input buffer as multiple segments, same buffer used for output
+* Out of place operation, input buffer as single segment and output as multiple segments
+* Out of place operation, input buffer as multiple segments and output as single segment
+* Out of place operation, input buffer as multiple segments and output as multiple segments
+
+
 Supported Cipher Algorithms
 ---------------------------