eal: rename IPC request as synchronous one
[dpdk.git] / doc / guides / cryptodevs / dpaa2_sec.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright 2016 NXP
3
4
5
6 NXP DPAA2 CAAM (DPAA2_SEC)
7 ==========================
8
9 The DPAA2_SEC PMD provides poll mode crypto driver support for NXP DPAA2 CAAM
10 hardware accelerator.
11
12 Architecture
13 ------------
14
15 SEC is the SOC's security engine, which serves as NXP's latest cryptographic
16 acceleration and offloading hardware. It combines functions previously
17 implemented in separate modules to create a modular and scalable acceleration
18 and assurance engine. It also implements block encryption algorithms, stream
19 cipher algorithms, hashing algorithms, public key algorithms, run-time
20 integrity checking, and a hardware random number generator. SEC performs
21 higher-level cryptographic operations than previous NXP cryptographic
22 accelerators. This provides significant improvement to system level performance.
23
24 DPAA2_SEC is one of the hardware resource in DPAA2 Architecture. More information
25 on DPAA2 Architecture is described in :ref:`dpaa2_overview`.
26
27 DPAA2_SEC PMD is one of DPAA2 drivers which interacts with Management Complex (MC)
28 portal to access the hardware object - DPSECI. The MC provides access to create,
29 discover, connect, configure and destroy dpseci objects in DPAA2_SEC PMD.
30
31 DPAA2_SEC PMD also uses some of the other hardware resources like buffer pools,
32 queues, queue portals to store and to enqueue/dequeue data to the hardware SEC.
33
34 DPSECI objects are detected by PMD using a resource container called DPRC (like
35 in :ref:`dpaa2_overview`).
36
37 For example:
38
39 .. code-block:: console
40
41     DPRC.1 (bus)
42       |
43       +--+--------+-------+-------+-------+---------+
44          |        |       |       |       |         |
45        DPMCP.1  DPIO.1  DPBP.1  DPNI.1  DPMAC.1  DPSECI.1
46        DPMCP.2  DPIO.2          DPNI.2  DPMAC.2  DPSECI.2
47        DPMCP.3
48
49 Implementation
50 --------------
51
52 SEC provides platform assurance by working with SecMon, which is a companion
53 logic block that tracks the security state of the SOC. SEC is programmed by
54 means of descriptors (not to be confused with frame descriptors (FDs)) that
55 indicate the operations to be performed and link to the message and
56 associated data. SEC incorporates two DMA engines to fetch the descriptors,
57 read the message data, and write the results of the operations. The DMA
58 engine provides a scatter/gather capability so that SEC can read and write
59 data scattered in memory. SEC may be configured by means of software for
60 dynamic changes in byte ordering. The default configuration for this version
61 of SEC is little-endian mode.
62
63 A block diagram similar to dpaa2 NIC is shown below to show where DPAA2_SEC
64 fits in the DPAA2 Bus model
65
66 .. code-block:: console
67
68
69                                        +----------------+
70                                        | DPDK DPAA2_SEC |
71                                        |     PMD        |
72                                        +----------------+       +------------+
73                                        |  MC SEC object |.......|  Mempool   |
74                     . . . . . . . . .  |   (DPSECI)     |       |  (DPBP)    |
75                    .                   +---+---+--------+       +-----+------+
76                   .                        ^   |                      .
77                  .                         |   |<enqueue,             .
78                 .                          |   | dequeue>             .
79                .                           |   |                      .
80               .                        +---+---V----+                 .
81              .      . . . . . . . . . .| DPIO driver|                 .
82             .      .                   |  (DPIO)    |                 .
83            .      .                    +-----+------+                 .
84           .      .                     |  QBMAN     |                 .
85          .      .                      |  Driver    |                 .
86     +----+------+-------+              +-----+----- |                 .
87     |   dpaa2 bus       |                    |                        .
88     |   VFIO fslmc-bus  |....................|.........................
89     |                   |                    |
90     |     /bus/fslmc    |                    |
91     +-------------------+                    |
92                                              |
93     ========================== HARDWARE =====|=======================
94                                            DPIO
95                                              |
96                                            DPSECI---DPBP
97     =========================================|========================
98
99
100
101 Features
102 --------
103
104 The DPAA2_SEC PMD has support for:
105
106 Cipher algorithms:
107
108 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
109 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
110 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
111 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
112 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
113 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
114 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
115
116 Hash algorithms:
117
118 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
119 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
120 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
121 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
122 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
123 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
124
125 AEAD algorithms:
126
127 * ``RTE_CRYPTO_AEAD_AES_GCM``
128
129 Supported DPAA2 SoCs
130 --------------------
131
132 * LS2080A/LS2040A
133 * LS2084A/LS2044A
134 * LS2088A/LS2048A
135 * LS1088A/LS1048A
136
137 Limitations
138 -----------
139
140 * Chained mbufs are not supported.
141 * Hash followed by Cipher mode is not supported
142 * Only supports the session-oriented API implementation (session-less APIs are not supported).
143
144 Prerequisites
145 -------------
146
147 DPAA2_SEC driver has similar pre-requisites as described in :ref:`dpaa2_overview`.
148 The following dependencies are not part of DPDK and must be installed separately:
149
150 * **NXP Linux SDK**
151
152   NXP Linux software development kit (SDK) includes support for the family
153   of QorIQ® ARM-Architecture-based system on chip (SoC) processors
154   and corresponding boards.
155
156   It includes the Linux board support packages (BSPs) for NXP SoCs,
157   a fully operational tool chain, kernel and board specific modules.
158
159   SDK and related information can be obtained from:  `NXP QorIQ SDK  <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
160
161 * **DPDK Extra Scripts**
162
163   DPAA2 based resources can be configured easily with the help of ready scripts
164   as provided in the DPDK helper repository.
165
166   `DPDK Extra Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
167
168 Currently supported by DPDK:
169
170 * NXP SDK **17.08+**.
171 * MC Firmware version **10.3.1** and higher.
172 * Supported architectures:  **arm64 LE**.
173
174 * Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
175
176 Pre-Installation Configuration
177 ------------------------------
178
179 Config File Options
180 ~~~~~~~~~~~~~~~~~~~
181
182 Basic DPAA2 config file options are described in :ref:`dpaa2_overview`.
183 In addition to those, the following options can be modified in the ``config`` file
184 to enable DPAA2_SEC PMD.
185
186 Please note that enabling debugging options may affect system performance.
187
188 * ``CONFIG_RTE_LIBRTE_PMD_DPAA2_SEC`` (default ``n``)
189   By default it is only enabled in defconfig_arm64-dpaa2-* config.
190   Toggle compilation of the ``librte_pmd_dpaa2_sec`` driver.
191
192 * ``CONFIG_RTE_DPAA2_SEC_PMD_MAX_NB_SESSIONS``
193   By default it is set as 2048 in defconfig_arm64-dpaa2-* config.
194   It indicates Number of sessions to create in the session memory pool
195   on a single DPAA2 SEC device.
196
197 Installations
198 -------------
199 To compile the DPAA2_SEC PMD for Linux arm64 gcc target, run the
200 following ``make`` command:
201
202 .. code-block:: console
203
204    cd <DPDK-source-directory>
205    make config T=arm64-dpaa2-linuxapp-gcc install
206
207 Enabling logs
208 -------------
209
210 For enabling logs, use the following EAL parameter:
211
212 .. code-block:: console
213
214    ./your_crypto_application <EAL args> --log-level=pmd.crypto.dpaa2,<level>
215
216 Using ``crypto.dpaa2`` as log matching criteria, all Crypto PMD logs can be
217 enabled which are lower than logging ``level``.