1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2016-2019 Intel Corporation.
4 SNOW 3G Crypto Poll Mode Driver
5 ===============================
7 The SNOW3G PMD (**librte_snow3g_zuc**) provides poll mode crypto driver support for
8 utilizing `Intel IPSec Multi-buffer library <https://github.com/01org/intel-ipsec-mb>`_
9 which implements F8 and F8 functions for SNOW 3G UEA2 cipher and UIA2 hash algorithms.
14 SNOW 3G PMD has support for:
18 * RTE_CRYPTO_CIPHER_SNOW3G_UEA2
20 Authentication algorithm:
22 * RTE_CRYPTO_AUTH_SNOW3G_UIA2
27 * Chained mbufs are not supported.
28 * SNOW 3G (UIA2) supported only if hash offset field is byte-aligned.
29 * In-place bit-level operations for SNOW 3G (UEA2) are not supported
30 (if length and/or offset of data to be ciphered is not byte-aligned).
35 To build DPDK with the SNOW3G_PMD the user is required to download the multi-buffer
36 library from `here <https://github.com/01org/intel-ipsec-mb>`_
37 and compile it on their user system before building DPDK.
38 The latest version of the library supported by this PMD is v0.53, which
39 can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.53.zip>`_.
41 After downloading the library, the user needs to unpack and compile it
42 on their system before building DPDK:
44 .. code-block:: console
49 As a reference, the following table shows a mapping between the past DPDK versions
50 and the external crypto libraries supported by them:
52 .. _table_snow3g_versions:
54 .. table:: DPDK and external crypto library version compatibility
56 ============= ================================
57 DPDK version Crypto library version
58 ============= ================================
59 16.04 - 19.11 LibSSO SNOW3G
60 20.02+ Multi-buffer library 0.53
61 ============= ================================
67 In order to enable this virtual crypto PMD, user must:
69 * Build the multi buffer library (explained in Installation section).
71 * Build DPDK as follows:
73 .. code-block:: console
75 make config T=x86_64-native-linux-gcc
76 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_SNOW3G\)=n,\1=y,' build/.config
79 To use the PMD in an application, user must:
81 * Call rte_vdev_init("crypto_snow3g") within the application.
83 * Use --vdev="crypto_snow3g" in the EAL options, which will call rte_vdev_init() internally.
85 The following parameters (all optional) can be provided in the previous two calls:
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).
90 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
92 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
96 .. code-block:: console
98 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
99 -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"