1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Cavium, Inc
4 ARMv8 Crypto Poll Mode Driver
5 =============================
7 This code provides the initial implementation of the ARMv8 crypto PMD.
8 The driver uses ARMv8 cryptographic extensions to process chained crypto
9 operations in an optimized way. The core functionality is provided by
10 a low-level library, written in the assembly code.
15 ARMv8 Crypto PMD has support for the following algorithm pairs:
17 Supported cipher algorithms:
19 * ``RTE_CRYPTO_CIPHER_AES_CBC``
21 Supported authentication algorithms:
23 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
24 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
29 To build DPDK with this virtual crypto PMD, the user is required to:
31 * Download AArch64 crypto library source code from
32 `here <https://github.com/ARM-software/AArch64cryptolib>`_.
34 * Build the ``AArch64cryptolib`` library:
36 .. code-block:: console
40 * Build DPDK with meson option ``-Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:
42 .. code-block:: console
44 meson -Darmv8_crypto_dir=<path_to_AArch64cryptolib> build
47 The corresponding device can be created only if the following features
48 are supported by the CPU:
51 * ``RTE_CPUFLAG_SHA1``
52 * ``RTE_CPUFLAG_SHA2``
53 * ``RTE_CPUFLAG_NEON``
58 Use ``--vdev "crypto_armv8"`` in the EAL options to create virtual crypto device.
60 User can use app/test application to check how to use this PMD and to verify
63 Test name is cryptodev_sw_armv8_autotest.
68 * Maximum number of sessions is 2048.
69 * Only chained operations are supported.
70 * AES-128-CBC is the only supported cipher variant.
71 * Cipher input data has to be a multiple of 16 bytes.
72 * Digest input data has to be a multiple of 8 bytes.