mbox series

[resend,v5,0/6] crypto/uadk: introduce uadk crypto driver

Message ID 20221024134409.1896776-1-zhangfei.gao@linaro.org
Headers show
Series crypto/uadk: introduce uadk crypto driver | expand

Message

Zhangfei Gao Oct. 24, 2022, 1:44 p.m. UTC 
Introduce a new crypto PMD for hardware accelerators based on UADK [1].

UADK is a framework for user applications to access hardware accelerators.
UADK relies on IOMMU SVA (Shared Virtual Address) feature, which share
the same page table between IOMMU and MMU.
Thereby user application can directly use virtual address for device dma,
which enhances the performance as well as easy usability.

[1] https://github.com/Linaro/uadk

Test:
sudo dpdk-test --vdev=crypto_uadk (--log-level=6)
RTE>>cryptodev_uadk_autotest
RTE>>quit

resend:
fix uadk lib, still use <uadk/wd_cipher.h>

Update in v5
Patch 1 fix the build issue when uadk is installed to specific folder
And update doc accordingly

Update in v4:
Akril suggest dpdk use pkg-config, So
Enable uadk support x86 local build, and support pkg-config.
Use pkg-config feature for the uadk crypto pmd.
Add build uadk library steps in doc
Test on both x86 and arm.
x86 can build and install, but can not test since no device.

Resend v3:
Rebase on next/for-main, which just merged the series
"cryptodev: rework session framework".

Update in v3:
Split patches according to Akhil's suggestions
Please split the patches as below.
1. introduce driver - create files with meson.build and with probe/remove
   and device ops defined but not implemented.
   You do not need to write empty functions.
   Add basic documentation also which defines what the driver is.
   You can explain the build dependency here.
2. define queue structs and setup/remove APIs
3. Add data path
4. implement cipher op. Add capabilities and documentation of what is
   supported in each of the patches. Add feature flags etc.
5. implement auth,  add capabilities and documentation
6. test app changes.

Update in v2:
Change uadk_supported_platform to uadk_crypto_version, which matches better
than platform.
enum uadk_crypto_version {
	UADK_CRYPTO_V2,
	UADK_CRYPTO_V3,
};

Update in v1, compared with rfc

Suggested from Akhil Goyal <gakhil@marvell.com>
Only consider crypto PMD first
Split patch into small (individually compiled) patches.
Update MAINTAINERS and doc/guides/cryptodevs/features/uadk.ini

Zhangfei Gao (6):
  crypto/uadk: introduce uadk crypto driver
  crypto/uadk: support basic operations
  crypto/uadk: support enqueue/dequeue operations
  crypto/uadk: support cipher algorithms
  crypto/uadk: support auth algorithms
  test/crypto: add cryptodev_uadk_autotest

 MAINTAINERS                             |    6 +
 app/test/test_cryptodev.c               |    7 +
 app/test/test_cryptodev.h               |    1 +
 doc/guides/cryptodevs/features/uadk.ini |   55 ++
 doc/guides/cryptodevs/index.rst         |    1 +
 doc/guides/cryptodevs/uadk.rst          |   94 ++
 drivers/crypto/meson.build              |    1 +
 drivers/crypto/uadk/meson.build         |   30 +
 drivers/crypto/uadk/uadk_crypto_pmd.c   | 1141 +++++++++++++++++++++++
 drivers/crypto/uadk/version.map         |    3 +
 10 files changed, 1339 insertions(+)
 create mode 100644 doc/guides/cryptodevs/features/uadk.ini
 create mode 100644 doc/guides/cryptodevs/uadk.rst
 create mode 100644 drivers/crypto/uadk/meson.build
 create mode 100644 drivers/crypto/uadk/uadk_crypto_pmd.c
 create mode 100644 drivers/crypto/uadk/version.map

Comments

Akhil Goyal Oct. 25, 2022, 2:59 p.m. UTC | #1 
> Introduce a new crypto PMD for hardware accelerators based on UADK [1].
> 
> UADK is a framework for user applications to access hardware accelerators.
> UADK relies on IOMMU SVA (Shared Virtual Address) feature, which share
> the same page table between IOMMU and MMU.
> Thereby user application can directly use virtual address for device dma,
> which enhances the performance as well as easy usability.
> 
> [1]  https://github.com/Linaro/uadk 
> 
> Test:
> sudo dpdk-test --vdev=crypto_uadk (--log-level=6)
> RTE>>cryptodev_uadk_autotest
> RTE>>quit
> 
> resend:
> fix uadk lib, still use <uadk/wd_cipher.h>

There is nothing called as resend in DPDK ML.
Please simply increment version number each time you send the set.


Also add release notes update in the patch
where the driver implementation is complete.

Compilation issues are all done now.
Have sent some other comments on the patches. Please send the v6 ASAP.
We need to close RC2 in a couple of days.

> 
> Update in v5
> Patch 1 fix the build issue when uadk is installed to specific folder
> And update doc accordingly
> 
> Update in v4:
> Akril suggest dpdk use pkg-config, So
> Enable uadk support x86 local build, and support pkg-config.
> Use pkg-config feature for the uadk crypto pmd.
> Add build uadk library steps in doc
> Test on both x86 and arm.
> x86 can build and install, but can not test since no device.
> 
> Resend v3:
> Rebase on next/for-main, which just merged the series
> "cryptodev: rework session framework".
> 
> Update in v3:
> Split patches according to Akhil's suggestions
> Please split the patches as below.
> 1. introduce driver - create files with meson.build and with probe/remove
>    and device ops defined but not implemented.
>    You do not need to write empty functions.
>    Add basic documentation also which defines what the driver is.
>    You can explain the build dependency here.
> 2. define queue structs and setup/remove APIs
> 3. Add data path
> 4. implement cipher op. Add capabilities and documentation of what is
>    supported in each of the patches. Add feature flags etc.
> 5. implement auth,  add capabilities and documentation
> 6. test app changes.
> 
> Update in v2:
> Change uadk_supported_platform to uadk_crypto_version, which matches
> better
> than platform.
> enum uadk_crypto_version {
> 	UADK_CRYPTO_V2,
> 	UADK_CRYPTO_V3,
> };
> 
> Update in v1, compared with rfc
> 
> Suggested from Akhil Goyal <gakhil@marvell.com>
> Only consider crypto PMD first
> Split patch into small (individually compiled) patches.
> Update MAINTAINERS and doc/guides/cryptodevs/features/uadk.ini
> 
> Zhangfei Gao (6):
>   crypto/uadk: introduce uadk crypto driver
>   crypto/uadk: support basic operations
>   crypto/uadk: support enqueue/dequeue operations
>   crypto/uadk: support cipher algorithms
>   crypto/uadk: support auth algorithms
>   test/crypto: add cryptodev_uadk_autotest
> 
>  MAINTAINERS                             |    6 +
>  app/test/test_cryptodev.c               |    7 +
>  app/test/test_cryptodev.h               |    1 +
>  doc/guides/cryptodevs/features/uadk.ini |   55 ++
>  doc/guides/cryptodevs/index.rst         |    1 +
>  doc/guides/cryptodevs/uadk.rst          |   94 ++
>  drivers/crypto/meson.build              |    1 +
>  drivers/crypto/uadk/meson.build         |   30 +
>  drivers/crypto/uadk/uadk_crypto_pmd.c   | 1141 +++++++++++++++++++++++
>  drivers/crypto/uadk/version.map         |    3 +
>  10 files changed, 1339 insertions(+)
>  create mode 100644 doc/guides/cryptodevs/features/uadk.ini
>  create mode 100644 doc/guides/cryptodevs/uadk.rst
>  create mode 100644 drivers/crypto/uadk/meson.build
>  create mode 100644 drivers/crypto/uadk/uadk_crypto_pmd.c
>  create mode 100644 drivers/crypto/uadk/version.map
> 
> --
> 2.38.1
Zhangfei Gao Oct. 26, 2022, 9:53 a.m. UTC | #2 
Hi, Akhil

Thanks for your guidance.

On Tue, 25 Oct 2022 at 23:02, Akhil Goyal <gakhil@marvell.com> wrote:
>
>
> > Introduce a new crypto PMD for hardware accelerators based on UADK [1].
> >
> > UADK is a framework for user applications to access hardware accelerators.
> > UADK relies on IOMMU SVA (Shared Virtual Address) feature, which share
> > the same page table between IOMMU and MMU.
> > Thereby user application can directly use virtual address for device dma,
> > which enhances the performance as well as easy usability.
> >
> > [1]  https://github.com/Linaro/uadk
> >
> > Test:
> > sudo dpdk-test --vdev=crypto_uadk (--log-level=6)
> > RTE>>cryptodev_uadk_autotest
> > RTE>>quit
> >
> > resend:
> > fix uadk lib, still use <uadk/wd_cipher.h>
>
> There is nothing called as resend in DPDK ML.
> Please simply increment version number each time you send the set.
>
>
> Also add release notes update in the patch
> where the driver implementation is complete.
>
> Compilation issues are all done now.
> Have sent some other comments on the patches. Please send the v6 ASAP.
> We need to close RC2 in a couple of days.
>

Got it, have addressed the comments and updated to v6
https://github.com/Linaro/dpdk/commits/next-9.11-v6
Will send tonight.

Some uncertainty
1. The updated uadk.rst
https://github.com/Linaro/dpdk/blob/next-9.11-v6/doc/guides/cryptodevs/uadk.rst

2. About the release notes change,
Do I add a new patch in the last: 07
https://github.com/Linaro/dpdk/commit/f2294300662def012e00d5a3c5466bbf8436904b

Or merge it to the first patch 01.

3. I update uadk.rst and test in the same patch, is that OK.
https://github.com/Linaro/dpdk/commit/4be993e9995def1061dcfdd7863a7f2ba6d5da6c

Thanks
Akhil Goyal Oct. 26, 2022, 10:16 a.m. UTC | #3 
> 
> Hi, Akhil
> 
> Thanks for your guidance.
> 
> On Tue, 25 Oct 2022 at 23:02, Akhil Goyal <gakhil@marvell.com> wrote:
> >
> >
> > > Introduce a new crypto PMD for hardware accelerators based on UADK [1].
> > >
> > > UADK is a framework for user applications to access hardware accelerators.
> > > UADK relies on IOMMU SVA (Shared Virtual Address) feature, which share
> > > the same page table between IOMMU and MMU.
> > > Thereby user application can directly use virtual address for device dma,
> > > which enhances the performance as well as easy usability.
> > >
> > > [1]  https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__github.com_Linaro_uadk&d=DwIBaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=Dn
> L7Si2wl_PRwpZ9TWey3eu68gBzn7DkPwuqhd6WNyo&m=tyhRlU0KYYHgoC9wyL
> _TYFJMfkt98378qTt70kHNizUdEEmLt_dSBdzMJS4IOREt&s=ZdQO3qCVbcJePPFh
> OGL2IsFh0AoEdndgscdqMT_QzhY&e=
> > >
> > > Test:
> > > sudo dpdk-test --vdev=crypto_uadk (--log-level=6)
> > > RTE>>cryptodev_uadk_autotest
> > > RTE>>quit
> > >
> > > resend:
> > > fix uadk lib, still use <uadk/wd_cipher.h>
> >
> > There is nothing called as resend in DPDK ML.
> > Please simply increment version number each time you send the set.
> >
> >
> > Also add release notes update in the patch
> > where the driver implementation is complete.
> >
> > Compilation issues are all done now.
> > Have sent some other comments on the patches. Please send the v6 ASAP.
> > We need to close RC2 in a couple of days.
> >
> 
> Got it, have addressed the comments and updated to v6
> https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__github.com_Linaro_dpdk_commits_next-2D9.11-
> 2Dv6&d=DwIBaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=DnL7Si2wl_PRwpZ9TWey3e
> u68gBzn7DkPwuqhd6WNyo&m=tyhRlU0KYYHgoC9wyL_TYFJMfkt98378qTt70kH
> NizUdEEmLt_dSBdzMJS4IOREt&s=8D-
> LSc3u5Dbhbp5kiEynMpS46QYwVLM0AuwAMY5HdYU&e=
> Will send tonight.
> 
> Some uncertainty
> 1. The updated uadk.rst
>  https://github.com/Linaro/dpdk/blob/next-9.11-v6/doc/guides/cryptodevs/uadk.rst 
This seems fine.

> 
> 2. About the release notes change,
> Do I add a new patch in the last: 07
>  https://github.com/Linaro/dpdk/commit/f2294300662def012e00d5a3c5466bbf8436904b#diff-b994e803545bf8101a466b464d2171d96f01226aee3401862f0c0a3c1897ffb5R199 

No need for a separate release notes patch
You can squash it in your last patch.

> 
> Or merge it to the first patch 01.
> 
> 3. I update uadk.rst and test in the same patch, is that OK.

Yes

> 
> Thanks