4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
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.
33 #ifndef _RTE_CRYPTODEV_VDEV_H_
34 #define _RTE_CRYPTODEV_VDEV_H_
39 #include "rte_cryptodev.h"
41 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS 8
42 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS 2048
44 #define RTE_CRYPTODEV_VDEV_NAME ("name")
45 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs")
46 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions")
47 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id")
49 static const char * const cryptodev_vdev_valid_params[] = {
50 RTE_CRYPTODEV_VDEV_NAME,
51 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
52 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
53 RTE_CRYPTODEV_VDEV_SOCKET_ID
58 * Initialisation parameters for virtual crypto devices
60 struct rte_crypto_vdev_init_params {
61 unsigned int max_nb_queue_pairs;
62 unsigned int max_nb_sessions;
64 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
69 * Creates a new virtual crypto device and returns the pointer
72 * @param name PMD type name
73 * @param dev_private_size Size of crypto PMDs private data
74 * @param socket_id Socket to allocate resources on.
75 * @param vdev Pointer to virtual device structure.
78 * - Cryptodev pointer if device is successfully created.
79 * - NULL if device cannot be created.
81 struct rte_cryptodev *
82 rte_cryptodev_vdev_pmd_init(const char *name, size_t dev_private_size,
83 int socket_id, struct rte_vdev_device *vdev);
87 * Parse virtual device initialisation parameters input arguments
89 * @params params Initialisation parameters with defaults set.
90 * @params input_args Command line arguments
93 * 0 on successful parse
94 * <0 on failure to parse
97 rte_cryptodev_vdev_parse_init_params(struct rte_crypto_vdev_init_params *params,
98 const char *input_args);
100 #endif /* _RTE_CRYPTODEV_VDEV_H_ */