2 Copyright(c) 2017 Marvell International Ltd.
3 Copyright(c) 2017 Semihalf.
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions
10 * Redistributions of source code must retain the above copyright
11 notice, this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in
14 the documentation and/or other materials provided with the
16 * Neither the name of the copyright holder nor the names of its
17 contributors may be used to endorse or promote products derived
18 from this software without specific prior written permission.
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 MVSAM Crypto Poll Mode Driver
33 =============================
35 The MVSAM CRYPTO PMD (**librte_crypto_mvsam_pmd**) provides poll mode crypto driver
36 support by utilizing MUSDK library, which provides cryptographic operations
37 acceleration by using Security Acceleration Engine (EIP197) directly from
38 user-space with minimum overhead and high performance.
40 Detailed information about SoCs that use MVSAM crypto driver can be obtained here:
42 * https://www.marvell.com/embedded-processors/armada-70xx/
43 * https://www.marvell.com/embedded-processors/armada-80xx/
44 * https://www.marvell.com/embedded-processors/armada-3700/
50 MVSAM CRYPTO PMD has support for:
54 * ``RTE_CRYPTO_CIPHER_NULL``
55 * ``RTE_CRYPTO_CIPHER_AES_CBC``
56 * ``RTE_CRYPTO_CIPHER_AES_CTR``
57 * ``RTE_CRYPTO_CIPHER_AES_ECB``
58 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
59 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
60 * ``RTE_CRYPTO_CIPHER_3DES_ECB``
64 * ``RTE_CRYPTO_AUTH_NULL``
65 * ``RTE_CRYPTO_AUTH_MD5``
66 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
67 * ``RTE_CRYPTO_AUTH_SHA1``
68 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
69 * ``RTE_CRYPTO_AUTH_SHA224``
70 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
71 * ``RTE_CRYPTO_AUTH_SHA256``
72 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
73 * ``RTE_CRYPTO_AUTH_SHA384``
74 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
75 * ``RTE_CRYPTO_AUTH_SHA512``
76 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
77 * ``RTE_CRYPTO_AUTH_AES_GMAC``
81 * ``RTE_CRYPTO_AEAD_AES_GCM``
83 For supported feature flags please consult :doc:`overview`.
88 * Hardware only supports scenarios where ICV (digest buffer) is placed just
89 after the authenticated data. Other placement will result in error.
94 MVSAM CRYPTO PMD driver compilation is disabled by default due to external dependencies.
95 Currently there are two driver specific compilation options in
96 ``config/common_base`` available:
98 - ``CONFIG_RTE_LIBRTE_PMD_MVSAM_CRYPTO`` (default: ``n``)
100 Toggle compilation of the librte_pmd_mvsam driver.
102 MVSAM CRYPTO PMD requires MUSDK built with EIP197 support thus following
103 extra option must be passed to the library configuration script:
105 .. code-block:: console
107 --enable-sam [--enable-sam-statistics] [--enable-sam-debug]
109 For instructions how to build required kernel modules please refer
110 to `doc/musdk_get_started.txt`.
115 After successfully building MVSAM CRYPTO PMD, the following modules need to be
118 .. code-block:: console
121 insmod crypto_safexcel.ko rings=0,0
124 The following parameters (all optional) are exported by the driver:
126 - ``max_nb_queue_pairs``: maximum number of queue pairs in the device (default: 8 - A8K, 4 - A7K/A3K).
127 - ``max_nb_sessions``: maximum number of sessions that can be created (default: 2048).
128 - ``socket_id``: socket on which to allocate the device resources on.
130 l2fwd-crypto example application can be used to verify MVSAM CRYPTO PMD
133 .. code-block:: console
135 ./l2fwd-crypto --vdev=eth_mvpp2,iface=eth0 --vdev=crypto_mvsam -- \
136 --cipher_op ENCRYPT --cipher_algo aes-cbc \
137 --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f \
138 --auth_op GENERATE --auth_algo sha1-hmac \
139 --auth_key 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f