SNOW 3G Crypto Poll Mode Driver
===============================
-The SNOW3G PMD (**librte_snow3g_zuc**) provides poll mode crypto driver support for
+The SNOW3G PMD (**librte_crypto_snow3g**) provides poll mode crypto driver support for
utilizing `Intel IPSec Multi-buffer library <https://github.com/01org/intel-ipsec-mb>`_
which implements F8 and F8 functions for SNOW 3G UEA2 cipher and UIA2 hash algorithms.
To build DPDK with the SNOW3G_PMD the user is required to download the multi-buffer
library from `here <https://github.com/01org/intel-ipsec-mb>`_
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 `<https://github.com/01org/intel-ipsec-mb/archive/v0.53.zip>`_.
+The latest version of the library supported by this PMD is v1.0, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.0.zip>`_.
After downloading the library, the user needs to unpack and compile it
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 <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
+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.
DPDK version Crypto library version
============= ================================
16.04 - 19.11 LibSSO SNOW3G
- 20.02+ Multi-buffer library 0.53
+ 20.02+ Multi-buffer library 0.53 - 1.0
============= ================================
* 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_SNOW3G\)=n,\1=y,' build/.config
- make
-
To use the PMD in an application, user must:
* Call rte_vdev_init("crypto_snow3g") within the application.
.. code-block:: console
- ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
+ ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
-- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"