X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Fsnow3g.rst;h=13341c39c4d4dc070d408eea96d3d9f78172c2bb;hb=fd5f9fb95ff5fb2543ad1cd8b4206f531d443347;hp=8fb06f4d6ce840bc3275f23e19efbace2f2e30ee;hpb=7c87e2d7b3597bc9fdb9a5f462f9bdfe24edcf3d;p=dpdk.git diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst index 8fb06f4d6c..13341c39c4 100644 --- a/doc/guides/cryptodevs/snow3g.rst +++ b/doc/guides/cryptodevs/snow3g.rst @@ -35,8 +35,8 @@ Installation To build DPDK with the SNOW3G_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 v0.54, which +can be downloaded from ``_. After downloading the library, the user needs to unpack and compile it on their system before building DPDK: @@ -46,6 +46,26 @@ 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. + If a lower GCC version than 5.0, the workaround proposed by the following link + should be used: ``_. + As a reference, the following table shows a mapping between the past DPDK versions and the external crypto libraries supported by them: @@ -57,7 +77,7 @@ and the external crypto libraries supported by them: 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 - 0.54 ============= ================================ @@ -68,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_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. @@ -95,5 +107,5 @@ Example: .. 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"