doc: add cryptodev sample code
[dpdk.git] / doc / guides / cryptodevs / null.rst
1 ..  BSD LICENSE
2     Copyright(c) 2016 Intel Corporation. All rights reserved.
3
4     Redistribution and use in source and binary forms, with or without
5     modification, are permitted provided that the following conditions
6     are met:
7
8     * Redistributions of source code must retain the above copyright
9     notice, this list of conditions and the following disclaimer.
10     * Redistributions in binary form must reproduce the above copyright
11     notice, this list of conditions and the following disclaimer in
12     the documentation and/or other materials provided with the
13     distribution.
14     * Neither the name of Intel Corporation nor the names of its
15     contributors may be used to endorse or promote products derived
16     from this software without specific prior written permission.
17
18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 Null Crypto Poll Mode Driver
31 ============================
32
33 The Null Crypto PMD (**librte_pmd_null_crypto**) provides a crypto poll mode
34 driver which provides a minimal implementation for a software crypto device. As
35 a null device it does not modify the data in the mbuf on which the crypto
36 operation is to operate and it only has support for a single cipher and
37 authentication algorithm.
38
39 When a burst of mbufs is submitted to a Null Crypto PMD for processing then
40 each mbuf in the burst will be enqueued in an internal buffer for collection on
41 a dequeue call as long as the mbuf has a valid rte_mbuf_offload operation with
42 a valid rte_cryptodev_session or rte_crypto_xform chain of operations.
43
44 Features
45 --------
46
47 Modes:
48
49 * RTE_CRYPTO_XFORM_CIPHER ONLY
50 * RTE_CRYPTO_XFORM_AUTH ONLY
51 * RTE_CRYPTO_XFORM_CIPHER THEN RTE_CRYPTO_XFORM_AUTH
52 * RTE_CRYPTO_XFORM_AUTH THEN RTE_CRYPTO_XFORM_CIPHER
53
54 Cipher algorithms:
55
56 * RTE_CRYPTO_CIPHER_NULL
57
58 Authentication algorithms:
59
60 * RTE_CRYPTO_AUTH_NULL
61
62 Limitations
63 -----------
64
65 * Only in-place is currently supported (destination address is the same as
66   source address).
67
68 Installation
69 ------------
70
71 The Null Crypto PMD is enabled and built by default in both the Linux and
72 FreeBSD builds.
73
74 Initialization
75 --------------
76
77 To use the PMD in an application, user must:
78
79 * Call rte_vdev_init("crypto_null") within the application.
80
81 * Use --vdev="crypto_null" in the EAL options, which will call rte_vdev_init() internally.
82
83 The following parameters (all optional) can be provided in the previous two calls:
84
85 * socket_id: Specify the socket where the memory for the device is going to be allocated
86   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
87
88 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
89
90 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
91
92 Example:
93
94 .. code-block:: console
95
96     ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
97     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"