X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Foverview.rst;h=e2a1e08ec1bb4479aaf2a6fb27a7aa548e6b2a17;hb=2097255731d5d3724063e9acf18b23bcbe4b7bac;hp=493cd5f55ca7506e6de4bd97104e60787a1ec6e0;hpb=08aa6271c86a561b66c6dd91f9a54fa2f12bc859;p=dpdk.git diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst index 493cd5f55c..e2a1e08ec1 100644 --- a/doc/guides/cryptodevs/overview.rst +++ b/doc/guides/cryptodevs/overview.rst @@ -11,14 +11,40 @@ 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. +.. Note:: -* 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 + - "In Place SGL" feature flag stands for "In place Scatter-gather list", + which means that an input buffer can consist of multiple segments, + being the operation in-place (input address = output address). + + - "OOP SGL In SGL Out" feature flag stands for + "Out-of-place Scatter-gather list Input, Scatter-gather list Output", + which means pmd supports different scatter-gather styled input and output buffers + (i.e. both can consists of multiple segments). + + - "OOP SGL In LB Out" feature flag stands for + "Out-of-place Scatter-gather list Input, Linear Buffers Output", + which means PMD supports input from scatter-gathered styled buffers, + outputting linear buffers (i.e. single segment). + + - "OOP LB In SGL Out" feature flag stands for + "Out-of-place Linear Buffers Input, Scatter-gather list Output", + which means PMD supports input from linear buffer, outputting + scatter-gathered styled buffers. + + - "OOP LB In LB Out" feature flag stands for + "Out-of-place Linear Buffers Input, Linear Buffers Output", + which means that Out-of-place operation is supported, + with linear input and output buffers. + + - "RSA PRIV OP KEY EXP" feature flag means PMD support RSA private key + operation (Sign and Decrypt) using exponent key type only. + + - "RSA PRIV OP KEY QT" feature flag means PMD support RSA private key + operation (Sign and Decrypt) using quintuple (crt) type key only. + + - "Digest encrypted" feature flag means PMD support hash-cipher cases, + where generated digest is appended to and encrypted with the data. Supported Cipher Algorithms @@ -41,3 +67,10 @@ Supported AEAD Algorithms .. _table_crypto_pmd_aead_algos: .. include:: overview_aead_table.txt + +Supported Asymmetric Algorithms +------------------------------- + +.. _table_crypto_pmd_asym_algos: + +.. include:: overview_asym_table.txt