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-gather 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    - "Digest encrypted" feature flag means PMD support hash-cipher cases,
  47      where generated digest is appended to and encrypted with the data.
  48
  49
  50 Supported Cipher Algorithms
  51 ---------------------------
  52
  53 .. _table_crypto_pmd_cipher_algos:
  54
  55 .. include:: overview_cipher_table.txt
  56
  57 Supported Authentication Algorithms
  58 -----------------------------------
  59
  60 .. _table_crypto_pmd_auth_algos:
  61
  62 .. include:: overview_auth_table.txt
  63
  64 Supported AEAD Algorithms
  65 -------------------------
  66
  67 .. _table_crypto_pmd_aead_algos:
  68
  69 .. include:: overview_aead_table.txt
  70
  71 Supported Asymmetric Algorithms
  72 -------------------------------
  73
  74 .. _table_crypto_pmd_asym_algos:
  75
  76 .. include:: overview_asym_table.txt