1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2016-2019 Intel Corporation. 3 4SNOW 3G Crypto Poll Mode Driver 5=============================== 6 7The SNOW3G PMD (**librte_crypto_snow3g**) provides poll mode crypto driver support for 8utilizing `Intel IPSec Multi-buffer library <https://github.com/01org/intel-ipsec-mb>`_ 9which implements F8 and F8 functions for SNOW 3G UEA2 cipher and UIA2 hash algorithms. 10 11Features 12-------- 13 14SNOW 3G PMD has support for: 15 16Cipher algorithm: 17 18* RTE_CRYPTO_CIPHER_SNOW3G_UEA2 19 20Authentication algorithm: 21 22* RTE_CRYPTO_AUTH_SNOW3G_UIA2 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* SNOW 3G (UIA2) supported only if hash offset field is byte-aligned. 33* In-place bit-level operations for SNOW 3G (UEA2) are not supported 34 (if length and/or offset of data to be ciphered is not byte-aligned). 35 36SNOW3G PMD vs AESNI MB PMD 37-------------------------- 38 39AESNI MB PMD also supports SNOW3G cipher and authentication algorithms. 40It is recommended to use the AESNI MB PMD, 41which offers better performance on Intel processors. 42Take a look at the PMD documentation (:doc:`aesni_mb`) for more information. 43 44Installation 45------------ 46 47To build DPDK with the SNOW3G_PMD the user is required to download the multi-buffer 48library and compile it on their user system before building DPDK. 49 50For x86 system, the multi-buffer library is available 51`here <https://github.com/01org/intel-ipsec-mb>`_. 52The latest version of the library supported by this PMD is v1.5, which 53can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_. 54 55For Arm system, ARM64 port of the multi-buffer library can be downloaded from 56`<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The 57latest version of the library supported by this PMD is tagged as SECLIB-IPSEC-2024.07.08. 58 59After downloading the library, the user needs to unpack and compile it 60on their system before building DPDK: 61 62.. code-block:: console 63 64 make 65 make install 66 67The library requires NASM to be built on x86. Depending on the library version, 68it might require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). 69 70NASM is packaged for different OS. However, on some OS the version is too old, 71so a manual installation is required. In that case, NASM can be downloaded from 72`NASM website <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_. 73Once it is downloaded, extract it and follow these steps: 74 75.. code-block:: console 76 77 ./configure 78 make 79 make install 80 81As a reference, the following table shows a mapping between the past DPDK versions 82and the external crypto libraries supported by them: 83 84.. _table_snow3g_versions: 85 86.. table:: DPDK and external crypto library version compatibility 87 88 ============= ================================ 89 DPDK version Crypto library version 90 ============= ================================ 91 20.02 - 21.08 Multi-buffer library 0.53 - 1.3 92 21.11 - 24.07 Multi-buffer library 1.0 - 1.5 93 24.11+ Multi-buffer library 1.4 - 1.5 94 ============= ================================ 95 96Initialization 97-------------- 98 99In order to enable this virtual crypto PMD, user must: 100 101* Build the multi buffer library (explained in Installation section). 102 103To use the PMD in an application, user must: 104 105* Call rte_vdev_init("crypto_snow3g") within the application. 106 107* Use --vdev="crypto_snow3g" in the EAL options, which will call rte_vdev_init() internally. 108 109The following parameters (all optional) can be provided in the previous two calls: 110 111* socket_id: Specify the socket where the memory for the device is going to be allocated 112 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 113 114* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 115 116* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 117 118Example: 119 120.. code-block:: console 121 122 ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ 123 -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2" 124