xref: /dpdk/doc/guides/cryptodevs/overview.rst (revision 807418f263a48855fcc64455afda1b7d4be03e47)
1..  BSD LICENSE
2    Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
3
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    * Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    * Redistributions in binary form must reproduce the above copyright
11    notice, this list of conditions and the following disclaimer in
12    the documentation and/or other materials provided with the
13    distribution.
14    * Neither the name of 6WIND S.A. nor the names of its
15    contributors may be used to endorse or promote products derived
16    from this software without specific prior written permission.
17
18    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30Crypto Device Supported Functionality Matrices
31==============================================
32
33Supported Feature Flags
34-----------------------
35
36.. _table_crypto_pmd_features:
37
38.. raw:: html
39
40   <style>
41      .wy-nav-content {
42         opacity: .99;
43      }
44      table#id1 {
45         cursor: default;
46         overflow: hidden;
47      }
48      table#id1 th, table#id1 td {
49         text-align: center;
50      }
51      table#id1 th {
52         font-size: 80%;
53         white-space: pre-wrap;
54         vertical-align: top;
55         padding: 2px;
56      }
57      table#id1 th:first-child {
58         vertical-align: bottom;
59      }
60      table#id1 td {
61         font-size: 70%;
62         padding: 1px;
63      }
64      table#id1 td:first-child {
65         padding-left: 1em;
66         text-align: left;
67      }
68      table#id1 tr:nth-child(2n-1) td {
69         background-color: rgba(210, 210, 210, 0.2);
70      }
71      table#id1 th:not(:first-child):hover,
72      table#id1 td:not(:first-child):hover {
73         position: relative;
74      }
75      table#id1 th:not(:first-child):hover::after,
76      table#id1 td:not(:first-child):hover::after {
77         content: '';
78         height: 6000px;
79         top: -3000px;
80         width: 100%;
81         left: 0;
82         position: absolute;
83         z-index: -1;
84         background-color: #ffb;
85      }
86      table#id1 tr:hover td {
87         background-color: #ffb;
88      }
89   </style>
90
91.. include:: overview_feature_table.txt
92
93Supported Cipher Algorithms
94---------------------------
95
96.. _table_crypto_pmd_cipher_algos:
97
98.. raw:: html
99
100   <style>
101      .wy-nav-content {
102         opacity: .99;
103      }
104      table#id2 {
105         cursor: default;
106         overflow: hidden;
107      }
108      table#id2 th, table#id2 td {
109         text-align: center;
110      }
111      table#id2 th {
112         font-size: 80%;
113         white-space: pre-wrap;
114         vertical-align: top;
115         padding: 2px;
116      }
117      table#id2 th:first-child {
118         vertical-align: bottom;
119      }
120      table#id2 td {
121         font-size: 70%;
122         padding: 1px;
123      }
124      table#id2 td:first-child {
125         padding-left: 1em;
126         text-align: left;
127      }
128      table#id2 tr:nth-child(2n-1) td {
129         background-color: rgba(210, 210, 210, 0.2);
130      }
131      table#id2 th:not(:first-child):hover,
132      table#id2 td:not(:first-child):hover {
133         position: relative;
134      }
135      table#id2 th:not(:first-child):hover::after,
136      table#id2 td:not(:first-child):hover::after {
137         content: '';
138         height: 6000px;
139         top: -3000px;
140         width: 100%;
141         left: 0;
142         position: absolute;
143         z-index: -1;
144         background-color: #ffb;
145      }
146      table#id2 tr:hover td {
147         background-color: #ffb;
148      }
149   </style>
150
151.. include:: overview_cipher_table.txt
152
153Supported Authentication Algorithms
154-----------------------------------
155
156.. _table_crypto_pmd_auth_algos:
157
158.. raw:: html
159
160   <style>
161      .wy-nav-content {
162         opacity: .99;
163      }
164      table#id3 {
165         cursor: default;
166         overflow: hidden;
167      }
168      table#id3 th, table#id3 td {
169         text-align: center;
170      }
171      table#id3 th {
172         font-size: 80%;
173         white-space: pre-wrap;
174         vertical-align: top;
175         padding: 2px;
176      }
177      table#id3 th:first-child {
178         vertical-align: bottom;
179      }
180      table#id3 td {
181         font-size: 70%;
182         padding: 1px;
183      }
184      table#id3 td:first-child {
185         padding-left: 1em;
186         text-align: left;
187      }
188      table#id3 tr:nth-child(2n-1) td {
189         background-color: rgba(210, 210, 210, 0.2);
190      }
191      table#id3 th:not(:first-child):hover,
192      table#id3 td:not(:first-child):hover {
193         position: relative;
194      }
195      table#id3 th:not(:first-child):hover::after,
196      table#id3 td:not(:first-child):hover::after {
197         content: '';
198         height: 6000px;
199         top: -3000px;
200         width: 100%;
201         left: 0;
202         position: absolute;
203         z-index: -1;
204         background-color: #ffb;
205      }
206      table#id3 tr:hover td {
207         background-color: #ffb;
208      }
209   </style>
210
211.. include:: overview_auth_table.txt
212
213Supported AEAD Algorithms
214-------------------------
215
216.. _table_crypto_pmd_aead_algos:
217
218.. raw:: html
219
220   <style>
221      .wy-nav-content {
222         opacity: .99;
223      }
224      table#id4 {
225         cursor: default;
226         overflow: hidden;
227      }
228      table#id4 th, table#id4 td {
229         text-align: center;
230      }
231      table#id4 th {
232         font-size: 80%;
233         white-space: pre-wrap;
234         vertical-align: top;
235         padding: 2px;
236      }
237      table#id4 th:first-child {
238         vertical-align: bottom;
239      }
240      table#id4 td {
241         font-size: 70%;
242         padding: 1px;
243      }
244      table#id4 td:first-child {
245         padding-left: 1em;
246         text-align: left;
247      }
248      table#id4 tr:nth-child(2n-1) td {
249         background-color: rgba(210, 210, 210, 0.2);
250      }
251      table#id4 th:not(:first-child):hover,
252      table#id4 td:not(:first-child):hover {
253         position: relative;
254      }
255      table#id4 th:not(:first-child):hover::after,
256      table#id4 td:not(:first-child):hover::after {
257         content: '';
258         height: 6000px;
259         top: -3000px;
260         width: 100%;
261         left: 0;
262         position: absolute;
263         z-index: -1;
264         background-color: #ffb;
265      }
266      table#id4 tr:hover td {
267         background-color: #ffb;
268      }
269   </style>
270
271.. include:: overview_aead_table.txt
272