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 24.. note:: 25 26 The latest v1.3 add ARM64 port of ipsec-mb library support ARM platform. 27 28Limitations 29----------- 30 31* Chained mbufs are not supported. 32* ZUC (EIA3) supported only if hash offset field is byte-aligned. 33* ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned. 34 35ZUC PMD vs AESNI MB PMD 36----------------------- 37 38AESNI MB PMD also supports ZUC cipher and authentication algorithms. 39It is recommended to use the AESNI MB PMD, 40which offers better performance on Intel processors. 41Take a look at the PMD documentation (:doc:`aesni_mb`) for more information. 42 43Installation 44------------ 45 46To build DPDK with the ZUC_PMD the user is required to download the multi-buffer 47library and compile it on their user system before building DPDK. 48 49For x86 system, the multi-buffer library is available 50`here <https://github.com/01org/intel-ipsec-mb>`_. 51The latest version of the library supported by this PMD is v1.3, which 52can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_. 53 54For Arm system, ARM64 port of the multi-buffer library can be downloaded from 55`<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The 56latest version of the library supported by this PMD is tagged as SECLIB-IPSEC-2022.05.25. 57 58After downloading the library, the user needs to unpack and compile it 59on their system before building DPDK: 60 61.. code-block:: console 62 63 make 64 make install 65 66The library requires NASM to be built on x86. Depending on the library version, 67it might require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). 68 69NASM is packaged for different OS. However, on some OS the version is too old, 70so a manual installation is required. In that case, NASM can be downloaded from 71`NASM website <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_. 72Once it is downloaded, extract it and follow these steps: 73 74.. code-block:: console 75 76 ./configure 77 make 78 make install 79 80.. note:: 81 82 Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53. 83 If a lower GCC version than 5.0, the workaround proposed by the following link 84 should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_. 85 86As a reference, the following table shows a mapping between the past DPDK versions 87and the external crypto libraries supported by them: 88 89.. _table_zuc_versions: 90 91.. table:: DPDK and external crypto library version compatibility 92 93 ============= ================================ 94 DPDK version Crypto library version 95 ============= ================================ 96 16.11 - 19.11 LibSSO ZUC 97 20.02 - 21.08 Multi-buffer library 0.53 - 1.3* 98 21.11+ Multi-buffer library 1.0 - 1.3* 99 ============= ================================ 100 101\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. 102 103Initialization 104-------------- 105 106In order to enable this virtual crypto PMD, user must: 107 108* Build the multi buffer library (explained in Installation section). 109 110To use the PMD in an application, user must: 111 112* Call rte_vdev_init("crypto_zuc") within the application. 113 114* Use --vdev="crypto_zuc" in the EAL options, which will call rte_vdev_init() internally. 115 116The following parameters (all optional) can be provided in the previous two calls: 117 118* socket_id: Specify the socket where the memory for the device is going to be allocated 119 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 120 121* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 122 123* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 124 125Example: 126 127.. code-block:: console 128 129 ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ 130 -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3" 131