12f342b0f2cbe3901d0f78d1c089e096d75d959e
[dpdk.git] / doc / guides / cryptodevs / overview.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2016-2017 Intel Corporation.
3
4 Crypto Device Supported Functionality Matrices
5 ==============================================
6
7 Supported Feature Flags
8 -----------------------
9
10 .. _table_crypto_pmd_features:
11
12 .. include:: overview_feature_table.txt
13
14 .. Note::
15
16    - "In Place SGL" feature flag stands for "In place Scatter-gather list",
17      which means that an input buffer can consist of multiple segments,
18      being the operation in-place (input address = output address).
19
20    - "OOP SGL In SGL Out" feature flag stands for
21      "Out-of-place Scatter-gather list Input, Scatter-gater list Output",
22      which means pmd supports different scatter-gather styled input and output buffers
23      (i.e. both can consists of multiple segments).
24
25    - "OOP SGL In LB Out" feature flag stands for
26      "Out-of-place Scatter-gather list Input, Linear Buffers Output",
27      which means PMD supports input from scatter-gathered styled buffers,
28      outputting linear buffers (i.e. single segment).
29
30    - "OOP LB In SGL Out" feature flag stands for
31      "Out-of-place Linear Buffers Input, Scatter-gather list Output",
32      which means PMD supports input from linear buffer, outputting
33      scatter-gathered styled buffers.
34
35    - "OOP LB In LB Out" feature flag stands for
36      "Out-of-place Linear Buffers Input, Linear Buffers Output",
37      which means that Out-of-place operation is supported,
38      with linear input and output buffers.
39
40    - "RSA PRIV OP KEY EXP" feature flag means PMD support RSA private key
41      operation (Sign and Decrypt) using exponent key type only.
42
43    - "RSA PRIV OP KEY QT" feature flag means PMD support RSA private key
44      operation (Sign and Decrypt) using quintuple (crt) type key only.
45
46
47 Supported Cipher Algorithms
48 ---------------------------
49
50 .. _table_crypto_pmd_cipher_algos:
51
52 .. include:: overview_cipher_table.txt
53
54 Supported Authentication Algorithms
55 -----------------------------------
56
57 .. _table_crypto_pmd_auth_algos:
58
59 .. include:: overview_auth_table.txt
60
61 Supported AEAD Algorithms
62 -------------------------
63
64 .. _table_crypto_pmd_aead_algos:
65
66 .. include:: overview_aead_table.txt
67
68 Supported Asymmetric Algorithms
69 -------------------------------
70
71 .. _table_crypto_pmd_asym_algos:
72
73 .. include:: overview_asym_table.txt