doc: update build guide for armv8 crypto PMD
Checks
Commit Message
Removed references to Makefile and 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>
---
doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
Comments
<snip>
>
> Removed references to Makefile and 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>
> ---
> doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
> 1 file changed, 11 insertions(+), 9 deletions(-)
>
> diff --git a/doc/guides/cryptodevs/armv8.rst
> b/doc/guides/cryptodevs/armv8.rst index fee85354b..d11efe08d 100644
> --- a/doc/guides/cryptodevs/armv8.rst
> +++ b/doc/guides/cryptodevs/armv8.rst
> @@ -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
How is the flag set for Meson? Does it need to be documented here?
> - 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.
> --
> 2.17.1
> -----Original Message-----
> From: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>
> Sent: Wednesday, October 14, 2020 10:10 PM
> To: Ruifeng Wang <Ruifeng.Wang@arm.com>; Ruifeng Wang
> <Ruifeng.Wang@arm.com>
> Cc: dev@dpdk.org; Akhil.goyal@nxp.com; nd <nd@arm.com>; Honnappa
> Nagarahalli <Honnappa.Nagarahalli@arm.com>; nd <nd@arm.com>
> Subject: RE: [PATCH] doc: update build guide for armv8 crypto PMD
>
> <snip>
>
> >
> > Removed references to Makefile and 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>
> > ---
> > doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
> > 1 file changed, 11 insertions(+), 9 deletions(-)
> >
> > diff --git a/doc/guides/cryptodevs/armv8.rst
> > b/doc/guides/cryptodevs/armv8.rst index fee85354b..d11efe08d 100644
> > --- a/doc/guides/cryptodevs/armv8.rst
> > +++ b/doc/guides/cryptodevs/armv8.rst
> > @@ -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
> 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.
>
> > - 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.
> > --
> > 2.17.1
<snip>
> >
> > >
> > > Removed references to Makefile and 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>
> > > ---
> > > doc/guides/cryptodevs/armv8.rst | 20 +++++++++++---------
> > > 1 file changed, 11 insertions(+), 9 deletions(-)
> > >
> > > diff --git a/doc/guides/cryptodevs/armv8.rst
> > > b/doc/guides/cryptodevs/armv8.rst index fee85354b..d11efe08d 100644
> > > --- a/doc/guides/cryptodevs/armv8.rst
> > > +++ b/doc/guides/cryptodevs/armv8.rst
> > > @@ -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
> > 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.
>
> >
> > > - 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.
> > > --
> > > 2.17.1
14/10/2020 11:24, Ruifeng Wang:
> Removed references to Makefile and 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>
Applied, thanks
14/10/2020 11:24, Ruifeng Wang:
> +* 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
+ Dharmik
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Thursday, October 22, 2020 4:18 PM
> To: Ruifeng Wang <Ruifeng.Wang@arm.com>
> Cc: dev@dpdk.org; Akhil.goyal@nxp.com; Honnappa Nagarahalli
> <Honnappa.Nagarahalli@arm.com>; nd <nd@arm.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: update build guide for armv8 crypto
> PMD
>
> 14/10/2020 11:24, Ruifeng Wang:
> > +* 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.
If I remember correct, Dharmik had a patch for this.
>
> Thanks
>
> On Oct 22, 2020, at 4:25 PM, Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com> wrote:
>
> + Dharmik
>
>> -----Original Message-----
>> From: Thomas Monjalon <thomas@monjalon.net>
>> Sent: Thursday, October 22, 2020 4:18 PM
>> To: Ruifeng Wang <Ruifeng.Wang@arm.com>
>> Cc: dev@dpdk.org; Akhil.goyal@nxp.com; Honnappa Nagarahalli
>> <Honnappa.Nagarahalli@arm.com>; nd <nd@arm.com>
>> Subject: Re: [dpdk-dev] [PATCH] doc: update build guide for armv8 crypto
>> PMD
>>
>> 14/10/2020 11:24, Ruifeng Wang:
>>> +* 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.
> 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.
>
>>
>> Thanks
>>
>
27/10/2020 05:18, Dharmik Thakkar:
>
> > On Oct 22, 2020, at 4:25 PM, Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com> wrote:
> >
> > + Dharmik
> >
> > From: Thomas Monjalon <thomas@monjalon.net>
> >> 14/10/2020 11:24, Ruifeng Wang:
> >>> +* 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.
> > 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
@@ -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.