From: Ruifeng Wang <ruifeng.wang@arm.com>
Date: Wed, 14 Oct 2020 09:24:14 +0000 (+0800)
Subject: doc: update guide for armv8 crypto
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=50ee0c2d0a8b1ad889de589228be9c2c7a056a76;p=dpdk.git

doc: update guide for armv8 crypto

Added guide about building by using meson.

Also added the command to create virtual device.

Suggested-by: Akhil Goyal <akhil.goyal@nxp.com>
Signed-off-by: Ruifeng Wang <ruifeng.wang@arm.com>
---

diff --git a/doc/guides/cryptodevs/armv8.rst b/doc/guides/cryptodevs/armv8.rst
index d30ef6168e..f0f30fe000 100644
--- a/doc/guides/cryptodevs/armv8.rst
+++ b/doc/guides/cryptodevs/armv8.rst
@@ -26,19 +26,23 @@ Supported authentication algorithms:
 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>`_
+  `here <https://github.com/ARM-software/AArch64cryptolib>`_.
 
-* Export the environmental variable ARMV8_CRYPTO_LIB_PATH with
-  the path to ``AArch64cryptolib`` library.
+* Build the ``AArch64cryptolib`` library:
 
-* Build the library by invoking:
+.. code-block:: console
+
+   make
+
+* Build DPDK with meson option ``-Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:
 
 .. code-block:: console
 
-	make -C $ARMV8_CRYPTO_LIB_PATH/
+   meson -Darmv8_crypto_dir=<path_to_AArch64cryptolib> build
+   ninja -C build
 
 The corresponding device can be created only if the following features
 are supported by the CPU:
@@ -51,6 +55,8 @@ 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.