xref: /dpdk/doc/guides/cryptodevs/overview.rst (revision 85256fea3859b57451657919486e4559b0f2677c)
15630257fSFerruh Yigit..  SPDX-License-Identifier: BSD-3-Clause
25630257fSFerruh Yigit    Copyright(c) 2016-2017 Intel Corporation.
32373c066SDeclan Doherty
42373c066SDeclan DohertyCrypto Device Supported Functionality Matrices
5807418f2SPablo de Lara==============================================
62373c066SDeclan Doherty
72373c066SDeclan DohertySupported Feature Flags
8807418f2SPablo de Lara-----------------------
92373c066SDeclan Doherty
10807418f2SPablo de Lara.. _table_crypto_pmd_features:
112373c066SDeclan Doherty
12807418f2SPablo de Lara.. include:: overview_feature_table.txt
132373c066SDeclan Doherty
142717246eSPablo de Lara.. Note::
1508aa6271SFiona Trahe
162717246eSPablo de Lara   - "In Place SGL" feature flag stands for "In place Scatter-gather list",
172717246eSPablo de Lara     which means that an input buffer can consist of multiple segments,
182717246eSPablo de Lara     being the operation in-place (input address = output address).
192717246eSPablo de Lara
202717246eSPablo de Lara   - "OOP SGL In SGL Out" feature flag stands for
21d629b7b5SJohn McNamara     "Out-of-place Scatter-gather list Input, Scatter-gather list Output",
2235bd0a5cSSean Morrissey     which means PMD supports different scatter-gather styled input and output buffers
23*85256feaSAndrew Boyer     (i.e. both can consist of multiple segments).
242717246eSPablo de Lara
252717246eSPablo de Lara   - "OOP SGL In LB Out" feature flag stands for
262717246eSPablo de Lara     "Out-of-place Scatter-gather list Input, Linear Buffers Output",
27*85256feaSAndrew Boyer     which means PMD supports input from scatter-gather styled buffers,
282717246eSPablo de Lara     outputting linear buffers (i.e. single segment).
292717246eSPablo de Lara
302717246eSPablo de Lara   - "OOP LB In SGL Out" feature flag stands for
312717246eSPablo de Lara     "Out-of-place Linear Buffers Input, Scatter-gather list Output",
322717246eSPablo de Lara     which means PMD supports input from linear buffer, outputting
33*85256feaSAndrew Boyer     scatter-gather styled buffers.
342717246eSPablo de Lara
352717246eSPablo de Lara   - "OOP LB In LB Out" feature flag stands for
36026bde3bSTomasz Duszynski     "Out-of-place Linear Buffers Input, Linear Buffers Output",
372717246eSPablo de Lara     which means that Out-of-place operation is supported,
382717246eSPablo de Lara     with linear input and output buffers.
3908aa6271SFiona Trahe
40398ba4c1SAyuj Verma   - "RSA PRIV OP KEY EXP" feature flag means PMD support RSA private key
41398ba4c1SAyuj Verma     operation (Sign and Decrypt) using exponent key type only.
42398ba4c1SAyuj Verma
43398ba4c1SAyuj Verma   - "RSA PRIV OP KEY QT" feature flag means PMD support RSA private key
44398ba4c1SAyuj Verma     operation (Sign and Decrypt) using quintuple (crt) type key only.
45398ba4c1SAyuj Verma
4690197eb0SDamian Nowak   - "Digest encrypted" feature flag means PMD support hash-cipher cases,
4790197eb0SDamian Nowak     where generated digest is appended to and encrypted with the data.
4890197eb0SDamian Nowak
49d014dddbSMatan Azrad   - "CIPHER_MULTIPLE_DATA_UNITS" feature flag means PMD support operations
50d014dddbSMatan Azrad      on multiple data-units message.
51d014dddbSMatan Azrad
5207b0b753SMatan Azrad   - "CIPHER_WRAPPED_KEY" feature flag means PMD support wrapped key in cipher
5307b0b753SMatan Azrad      xform.
5407b0b753SMatan Azrad
5508aa6271SFiona Trahe
562373c066SDeclan DohertySupported Cipher Algorithms
57807418f2SPablo de Lara---------------------------
582373c066SDeclan Doherty
59807418f2SPablo de Lara.. _table_crypto_pmd_cipher_algos:
602373c066SDeclan Doherty
61807418f2SPablo de Lara.. include:: overview_cipher_table.txt
622373c066SDeclan Doherty
632373c066SDeclan DohertySupported Authentication Algorithms
64807418f2SPablo de Lara-----------------------------------
652373c066SDeclan Doherty
66807418f2SPablo de Lara.. _table_crypto_pmd_auth_algos:
672373c066SDeclan Doherty
68807418f2SPablo de Lara.. include:: overview_auth_table.txt
692373c066SDeclan Doherty
702373c066SDeclan DohertySupported AEAD Algorithms
71807418f2SPablo de Lara-------------------------
722373c066SDeclan Doherty
73807418f2SPablo de Lara.. _table_crypto_pmd_aead_algos:
742373c066SDeclan Doherty
75807418f2SPablo de Lara.. include:: overview_aead_table.txt
767df9d02eSFiona Trahe
777df9d02eSFiona TraheSupported Asymmetric Algorithms
787df9d02eSFiona Trahe-------------------------------
797df9d02eSFiona Trahe
807df9d02eSFiona Trahe.. _table_crypto_pmd_asym_algos:
817df9d02eSFiona Trahe
827df9d02eSFiona Trahe.. include:: overview_asym_table.txt
8359e380f1STal Shnaiderman
8459e380f1STal ShnaidermanSupported Operating Systems
8559e380f1STal Shnaiderman-------------------------------
8659e380f1STal Shnaiderman
8759e380f1STal Shnaiderman.. _table_crypto_pmd_os:
8859e380f1STal Shnaiderman
8959e380f1STal Shnaiderman.. include:: overview_os_table.txt
90