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_pmd_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 v0.53, which 39can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.53.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 49As a reference, the following table shows a mapping between the past DPDK versions 50and the external crypto libraries supported by them: 51 52.. _table_zuc_versions: 53 54.. table:: DPDK and external crypto library version compatibility 55 56 ============= ================================ 57 DPDK version Crypto library version 58 ============= ================================ 59 16.11 - 19.11 LibSSO ZUC 60 20.02+ Multi-buffer library 0.53 61 ============= ================================ 62 63 64Initialization 65-------------- 66 67In order to enable this virtual crypto PMD, user must: 68 69* Build the multi buffer library (explained in Installation section). 70 71* Build DPDK as follows: 72 73.. code-block:: console 74 75 make config T=x86_64-native-linux-gcc 76 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_ZUC\)=n,\1=y,' build/.config 77 make 78 79To use the PMD in an application, user must: 80 81* Call rte_vdev_init("crypto_zuc") within the application. 82 83* Use --vdev="crypto_zuc" in the EAL options, which will call rte_vdev_init() internally. 84 85The following parameters (all optional) can be provided in the previous two calls: 86 87* socket_id: Specify the socket where the memory for the device is going to be allocated 88 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 89 90* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 91 92* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 93 94Example: 95 96.. code-block:: console 97 98 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ 99 -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3" 100