X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Fkasumi.rst;h=bc82744fcc3c4620cceb986d93b62e49d3b20f0e;hb=fd390896f4a3dd27ebdf551673960bece8aff966;hp=0d48d10f1364476a63a42ab3f1fca7946726b438;hpb=f69ed1044230c218c9afd8f1b47b6fe6aa1eeec5;p=dpdk.git diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst index 0d48d10f13..bc82744fcc 100644 --- a/doc/guides/cryptodevs/kasumi.rst +++ b/doc/guides/cryptodevs/kasumi.rst @@ -4,7 +4,7 @@ KASUMI Crypto Poll Mode Driver =============================== -The KASUMI PMD (**librte_pmd_kasumi**) provides poll mode crypto driver support for +The KASUMI PMD (**librte_crypto_kasumi**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms. @@ -36,8 +36,8 @@ Installation To build DPDK with the KASUMI_PMD the user is required to download the multi-buffer library from `here `_ and compile it on their user system before building DPDK. -The latest version of the library supported by this PMD is v0.53, which -can be downloaded from ``_. +The latest version of the library supported by this PMD is v1.0, which +can be downloaded from ``_. After downloading the library, the user needs to unpack and compile it on their system before building DPDK: @@ -47,6 +47,20 @@ on their system before building DPDK: make make install +The library requires NASM to be built. Depending on the library version, it might +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). + +NASM is packaged for different OS. However, on some OS the version is too old, +so a manual installation is required. In that case, NASM can be downloaded from +`NASM website `_. +Once it is downloaded, extract it and follow these steps: + +.. code-block:: console + + ./configure + make + make install + .. note:: Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53. @@ -64,9 +78,11 @@ and the external crypto libraries supported by them: DPDK version Crypto library version ============= ================================ 16.11 - 19.11 LibSSO KASUMI - 20.02+ Multi-buffer library 0.53 + 20.02 - 21.08 Multi-buffer library 0.53 - 1.0* + 21.11+ Multi-buffer library 1.0* ============= ================================ +\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. Initialization -------------- @@ -75,15 +91,6 @@ In order to enable this virtual crypto PMD, user must: * Build the multi buffer library (explained in Installation section). -* Build DPDK as follows: - -.. code-block:: console - - make config T=x86_64-native-linux-gcc - sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_KASUMI\)=n,\1=y,' build/.config - make - - To use the PMD in an application, user must: * Call rte_vdev_init("crypto_kasumi") within the application. @@ -103,7 +110,7 @@ Example: .. code-block:: console - ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8" Extra notes on KASUMI F9