-.. BSD LICENSE
- Copyright (C) Cavium networks Ltd. 2017.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in
- the documentation and/or other materials provided with the
- distribution.
- * Neither the name of Cavium networks nor the names of its
- contributors may be used to endorse or promote products derived
- from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2017 Cavium, Inc
ARMv8 Crypto Poll Mode Driver
=============================
Installation
------------
-In order to enable this virtual crypto PMD, user must:
+To build DPDK with this virtual crypto PMD, the user is required to:
+
+* Download AArch64 crypto library source code from
+ `here <https://github.com/ARM-software/AArch64cryptolib>`_.
-* Download ARMv8 crypto library source code from
- `here <https://github.com/caviumnetworks/armv8_crypto>`_
+* Build the ``AArch64cryptolib`` library:
+
+.. code-block:: console
-* Export the environmental variable ARMV8_CRYPTO_LIB_PATH with
- the path where the ``armv8_crypto`` library was downloaded
- or cloned.
+ make
-* Build the library by invoking:
+* Add path to `libAArch64crypto.pc` in `PKG_CONFIG_PATH` environment variable:
.. code-block:: console
- make -C $ARMV8_CRYPTO_LIB_PATH/
+ export PKG_CONFIG_PATH=<path_to_AArch64cryptolib>/pkgconfig/:$PKG_CONFIG_PATH
-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in
- config/defconfig_arm64-armv8a-linuxapp-gcc
+* Build DPDK:
+
+.. code-block:: console
+
+ meson build
+ ninja -C build
The corresponding device can be created only if the following features
are supported by the CPU:
Initialization
--------------
+Use ``--vdev "crypto_armv8"`` in the EAL options to create virtual crypto device.
+
User can use app/test application to check how to use this PMD and to verify
crypto processing.
Test name is cryptodev_sw_armv8_autotest.
-For performance test cryptodev_sw_armv8_perftest can be used.
Limitations
-----------