doc: clarify chained mbuf feature in crypto guide
authorFiona Trahe <fiona.trahe@intel.com>
Thu, 3 May 2018 13:32:36 +0000 (14:32 +0100)
committerPablo de Lara <pablo.de.lara.guarch@intel.com>
Tue, 22 May 2018 14:36:11 +0000 (16:36 +0200)
Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Deepak Kumar Jain <deepak.k.jain@intel.com>
doc/guides/cryptodevs/overview.rst

index b3cb6ca..493cd5f 100644 (file)
@@ -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
 ---------------------------