X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Fzuc.rst;h=800d371f4b7620b5ed65c288e7f33768f4261d0e;hb=cdf6a5fbc540cdaac576a2be6c8dac25ce173c65;hp=c384f3d9e99dd9599e84796f03a067f516fa9d97;hpb=0b133c36ad7d5fdce852b060d69019d69d48a7cb;p=dpdk.git diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst index c384f3d9e9..800d371f4b 100644 --- a/doc/guides/cryptodevs/zuc.rst +++ b/doc/guides/cryptodevs/zuc.rst @@ -4,7 +4,7 @@ ZUC Crypto Poll Mode Driver =========================== -The ZUC PMD (**librte_pmd_zuc**) provides poll mode crypto driver support for +The ZUC PMD (**librte_crypto_zuc**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms. @@ -46,6 +46,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. @@ -74,14 +88,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_ZUC\)=n,\1=y,' build/.config - make - To use the PMD in an application, user must: * Call rte_vdev_init("crypto_zuc") within the application. @@ -101,5 +107,5 @@ Example: .. code-block:: console - ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"