xref: /dpdk/drivers/crypto/null/null_crypto_pmd_private.h (revision cdfb776ba266cb610add47a95580f81f5105b4ed)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2016 Intel Corporation. All rights reserved.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
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
15  *       distribution.
16  *     * Neither the name of Intel Corporation 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.
19  *
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.
31  */
32 
33 #ifndef _NULL_CRYPTO_PMD_PRIVATE_H_
34 #define _NULL_CRYPTO_PMD_PRIVATE_H_
35 
36 #include "rte_config.h"
37 
38 #define NULL_CRYPTO_LOG_ERR(fmt, args...) \
39 	RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
40 			RTE_STR(CRYPTODEV_NAME_NULL_PMD), \
41 			__func__, __LINE__, ## args)
42 
43 #ifdef RTE_LIBRTE_NULL_CRYPTO_DEBUG
44 #define NULL_CRYPTO_LOG_INFO(fmt, args...) \
45 	RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
46 			RTE_STR(CRYPTODEV_NAME_NULL_PMD), \
47 			__func__, __LINE__, ## args)
48 
49 #define NULL_CRYPTO_LOG_DBG(fmt, args...) \
50 	RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
51 			RTE_STR(CRYPTODEV_NAME_NULL_PMD), \
52 			__func__, __LINE__, ## args)
53 #else
54 #define NULL_CRYPTO_LOG_INFO(fmt, args...)
55 #define NULL_CRYPTO_LOG_DBG(fmt, args...)
56 #endif
57 
58 
59 /** private data structure for each NULL crypto device */
60 struct null_crypto_private {
61 	unsigned max_nb_qpairs;		/**< Max number of queue pairs */
62 	unsigned max_nb_sessions;	/**< Max number of sessions */
63 };
64 
65 /** NULL crypto queue pair */
66 struct null_crypto_qp {
67 	uint16_t id;
68 	/**< Queue Pair Identifier */
69 	char name[RTE_CRYPTODEV_NAME_LEN];
70 	/**< Unique Queue Pair Name */
71 	struct rte_ring *processed_pkts;
72 	/**< Ring for placing process packets */
73 	struct rte_mempool *sess_mp;
74 	/**< Session Mempool */
75 	struct rte_cryptodev_stats qp_stats;
76 	/**< Queue pair statistics */
77 } __rte_cache_aligned;
78 
79 
80 /** NULL crypto private session structure */
81 struct null_crypto_session {
82 	uint32_t reserved;
83 } __rte_cache_aligned;
84 
85 /** Set and validate NULL crypto session parameters */
86 extern int
87 null_crypto_set_session_parameters(struct null_crypto_session *sess,
88 		const struct rte_crypto_sym_xform *xform);
89 
90 /** device specific operations function pointer structure */
91 extern struct rte_cryptodev_ops *null_crypto_pmd_ops;
92 
93 #endif /* _NULL_CRYPTO_PMD_PRIVATE_H_ */
94