Skip to contentSkip to conversation

doc: update build guide for armv8 crypto PMD

PATCH Applied Ruifeng Wang 4 participants 9 messages Oct 14, 2020 – Oct 27, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: update build guide for armv8 crypto PMD

Removed references to Makefile and added guide about building by using meson.

Also added the command to create virtual device.

---
 doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)
doc/guides/cryptodevs/armv8.rst +11 -9
index fee85354b..d11efe08d 100644
@@ -26,22 +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 library by invoking:
+* Build the ``AArch64cryptolib`` library:
 
 .. code-block:: console
 
-	make -C $ARMV8_CRYPTO_LIB_PATH/
+	make
+
+* Build DPDK with meson option ``-Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:
+
+.. code-block:: console
 
-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in
-  config/defconfig_arm64-armv8a-linux-gcc
+	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:
@@ -53,6 +54,7 @@ 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.
Signature · 1 line
2.17.1
#1 lore raw

<snip>

Quoted 40 lines

Removed references to Makefile and added guide about building by using meson.

Also added the command to create virtual device.

---
 doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)
(quoted diff) +0 -0

b/doc/guides/cryptodevs/armv8.rst index fee85354b..d11efe08d 100644

doc/guides/cryptodevs/armv8.rst +6 -7
@@ -26,22 +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 library by invoking:
+* Build the ``AArch64cryptolib`` library:
 
 .. code-block:: console
 
-	make -C $ARMV8_CRYPTO_LIB_PATH/
+	make
+
+* Build DPDK with meson option ``-

Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:

doc/guides/cryptodevs/armv8.rst Supported authentication algorithms: · line 43

Quoted 4 lines
doc/guides/cryptodevs/armv8.rst +2 -1
+
+.. code-block:: console
 
-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in

How is the flag set for Meson? Does it need to be documented here?

Quoted 17 lines
doc/guides/cryptodevs/armv8.rst +2 -1
-  config/defconfig_arm64-armv8a-linux-gcc
+	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:

doc/guides/cryptodevs/armv8.rst +1 -0
@@ -53,6 +54,7 @@ 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.
--
2.17.1

#2 lore raw
Quoted 55 lines

-----Original Message-----
From: Honnappa Nagarahalli <[email protected]>
Sent: Wednesday, October 14, 2020 10:10 PM
To: Ruifeng Wang <[email protected]>; Ruifeng Wang <[email protected]>
Cc: [email protected]; [email protected]; nd <[email protected]>; Honnappa Nagarahalli <[email protected]>; nd <[email protected]>
Subject: RE: [PATCH] doc: update build guide for armv8 crypto PMD

<snip>

Quoted 43 lines

Removed references to Makefile and added guide about building by using meson.

Also added the command to create virtual device.

---
 doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)
(quoted diff) +0 -0

b/doc/guides/cryptodevs/armv8.rst index fee85354b..d11efe08d 100644

doc/guides/cryptodevs/armv8.rst +6 -7
@@ -26,22 +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 library by invoking:
+* Build the ``AArch64cryptolib`` library:
 
 .. code-block:: console
 
-	make -C $ARMV8_CRYPTO_LIB_PATH/
+	make
+
+* Build DPDK with meson option ``-

Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:
+
+.. code-block:: console

Quoted 2 lines
Quoted 1 line

-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in

How is the flag set for Meson? Does it need to be documented here?

Meson don't use this flag.
It will build a PMD when dependency is met. And armv8 crypto PMD depends on armv8_crypto_dir which points to AArch64cryptolib.

Quoted 19 lines
Quoted 19 lines
doc/guides/cryptodevs/armv8.rst +2 -1
-  config/defconfig_arm64-armv8a-linux-gcc
+	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:

doc/guides/cryptodevs/armv8.rst +2 -0
@@ -53,6 +54,7 @@ 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.
--
2.17.1

#3 lore raw

<snip>

Quoted 44 lines
Quoted 44 lines
Quoted 44 lines

Removed references to Makefile and added guide about building by using meson.

Also added the command to create virtual device.

---
 doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)
(quoted diff) +0 -0

b/doc/guides/cryptodevs/armv8.rst index fee85354b..d11efe08d 100644

doc/guides/cryptodevs/armv8.rst +6 -7
@@ -26,22 +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 library by invoking:
+* Build the ``AArch64cryptolib`` library:
 
 .. code-block:: console
 
-	make -C $ARMV8_CRYPTO_LIB_PATH/
+	make
+
+* Build DPDK with meson option ``-

Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:
+
+.. code-block:: console

Quoted 5 lines
Quoted 2 lines
Quoted 1 line

-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in

How is the flag set for Meson? Does it need to be documented here?

Meson don't use this flag.
It will build a PMD when dependency is met. And armv8 crypto PMD depends on armv8_crypto_dir which points to AArch64cryptolib.

Ok, got it. I do not see any code using this flag as well.

Quoted 20 lines
Quoted 20 lines
Quoted 20 lines
doc/guides/cryptodevs/armv8.rst +2 -1
-  config/defconfig_arm64-armv8a-linux-gcc
+	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:

doc/guides/cryptodevs/armv8.rst +2 -0
@@ -53,6 +54,7 @@ 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.
--
2.17.1

#5 lore raw
In reply to Ruifeng Wang

14/10/2020 11:24, Ruifeng Wang:

doc/guides/cryptodevs/armv8.rst Supported authentication algorithms: · line 44

Quoted 3 lines
doc/guides/cryptodevs/armv8.rst +3 -0
+* Build DPDK with meson option ``-Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:
+
+	meson -Darmv8_crypto_dir=<path_to_AArch64cryptolib> build

Please, could you add pkg-config support to this lib? I would like to remove with option from DPDK, and use the standard variable PKG_CONFIG_PATH instead.

Thanks

#6 lore raw

+ Dharmik

Quoted 10 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Thursday, October 22, 2020 4:18 PM
To: Ruifeng Wang <[email protected]>
Cc: [email protected]; [email protected]; Honnappa Nagarahalli <[email protected]>; nd <[email protected]>
Subject: Re: [dpdk-dev] [PATCH] doc: update build guide for armv8 crypto PMD

14/10/2020 11:24, Ruifeng Wang:

Quoted 8 lines
Quoted 1 line

+* Build DPDK with meson option ``-

Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+	meson -Darmv8_crypto_dir=<path_to_AArch64cryptolib> build

Please, could you add pkg-config support to this lib?
I would like to remove with option from DPDK, and use the standard variable PKG_CONFIG_PATH instead.

If I remember correct, Dharmik had a patch for this.

Quoted 3 lines

Thanks

#7 lore raw
Quoted 17 lines · Honnappa Nagarahalli

+ Dharmik

Quoted 11 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Thursday, October 22, 2020 4:18 PM
To: Ruifeng Wang <[email protected]>
Cc: [email protected]; [email protected]; Honnappa Nagarahalli <[email protected]>; nd <[email protected]>
Subject: Re: [dpdk-dev] [PATCH] doc: update build guide for armv8 crypto PMD

14/10/2020 11:24, Ruifeng Wang:

Quoted 1 line

+* Build DPDK with meson option ``-

Quoted 8 lines
Quoted 7 lines

Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+meson -Darmv8_crypto_dir=<path_to_AArch64cryptolib> build

Please, could you add pkg-config support to this lib?
I would like to remove with option from DPDK, and use the standard variable PKG_CONFIG_PATH instead.

If I remember correct, Dharmik had a patch for this.

I have created a pull request to add pkg-config support to the AArch64crypto library. Once it is merged, I will submit a patch to remove the meson option.

Quoted 5 lines
Quoted 4 lines

Thanks

#8 lore raw

27/10/2020 05:18, Dharmik Thakkar:

Quoted 15 lines
Quoted 15 lines · Honnappa Nagarahalli

+ Dharmik

From: Thomas Monjalon <[email protected]>

Quoted 9 lines

14/10/2020 11:24, Ruifeng Wang:

Quoted 1 line

+* Build DPDK with meson option ``-

Darmv8_crypto_dir=<path_to_AArch64cryptolib>``:

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+meson -Darmv8_crypto_dir=<path_to_AArch64cryptolib> build

Please, could you add pkg-config support to this lib?
I would like to remove with option from DPDK, and use the standard variable PKG_CONFIG_PATH instead.

Quoted 4 lines
Quoted 1 line

If I remember correct, Dharmik had a patch for this.

I have created a pull request to add pkg-config support to the AArch64crypto library. Once it is merged, I will submit a patch to remove the meson option.

Wonderful, thank you