1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2016-2019 Intel Corporation. 3 4ZUC Crypto Poll Mode Driver 5=========================== 6 7The ZUC PMD (**librte_crypto_zuc**) provides poll mode crypto driver support for 8utilizing `Intel IPSec Multi-buffer library <https://github.com/01org/intel-ipsec-mb>`_ 9which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms. 10 11Features 12-------- 13 14ZUC PMD has support for: 15 16Cipher algorithm: 17 18* RTE_CRYPTO_CIPHER_ZUC_EEA3 19 20Authentication algorithm: 21 22* RTE_CRYPTO_AUTH_ZUC_EIA3 23 24Limitations 25----------- 26 27* Chained mbufs are not supported. 28* ZUC (EIA3) supported only if hash offset field is byte-aligned. 29* ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned. 30 31 32Installation 33------------ 34 35To build DPDK with the ZUC_PMD the user is required to download the multi-buffer 36library from `here <https://github.com/01org/intel-ipsec-mb>`_ 37and compile it on their user system before building DPDK. 38The latest version of the library supported by this PMD is v1.2, which 39can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.2.zip>`_. 40 41After downloading the library, the user needs to unpack and compile it 42on their system before building DPDK: 43 44.. code-block:: console 45 46 make 47 make install 48 49The library requires NASM to be built. Depending on the library version, it might 50require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). 51 52NASM is packaged for different OS. However, on some OS the version is too old, 53so a manual installation is required. In that case, NASM can be downloaded from 54`NASM website <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_. 55Once it is downloaded, extract it and follow these steps: 56 57.. code-block:: console 58 59 ./configure 60 make 61 make install 62 63.. note:: 64 65 Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53. 66 If a lower GCC version than 5.0, the workaround proposed by the following link 67 should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_. 68 69As a reference, the following table shows a mapping between the past DPDK versions 70and the external crypto libraries supported by them: 71 72.. _table_zuc_versions: 73 74.. table:: DPDK and external crypto library version compatibility 75 76 ============= ================================ 77 DPDK version Crypto library version 78 ============= ================================ 79 16.11 - 19.11 LibSSO ZUC 80 20.02 - 21.08 Multi-buffer library 0.53 - 1.2* 81 21.11+ Multi-buffer library 1.0 - 1.2* 82 ============= ================================ 83 84\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. 85 86Initialization 87-------------- 88 89In order to enable this virtual crypto PMD, user must: 90 91* Build the multi buffer library (explained in Installation section). 92 93To use the PMD in an application, user must: 94 95* Call rte_vdev_init("crypto_zuc") within the application. 96 97* Use --vdev="crypto_zuc" in the EAL options, which will call rte_vdev_init() internally. 98 99The following parameters (all optional) can be provided in the previous two calls: 100 101* socket_id: Specify the socket where the memory for the device is going to be allocated 102 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 103 104* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 105 106* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 107 108Example: 109 110.. code-block:: console 111 112 ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ 113 -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3" 114