xref: /dpdk/lib/cryptodev/rte_cryptodev_core.h (revision e4f0e2158b8e210065e91f45fd83aee118cbbd96)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2021 Marvell.
3  */
4 
5 #ifndef _RTE_CRYPTODEV_CORE_H_
6 #define _RTE_CRYPTODEV_CORE_H_
7 
8 /**
9  * @file
10  *
11  * RTE Crypto Device internal header.
12  *
13  * This header contains internal data types. But they are still part of the
14  * public API because they are used by inline functions in the published API.
15  *
16  * Applications should not use these directly.
17  */
18 
19 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
20 		struct rte_crypto_op **ops,	uint16_t nb_ops);
21 /**< Dequeue processed packets from queue pair of a device. */
22 
23 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
24 		struct rte_crypto_op **ops,	uint16_t nb_ops);
25 /**< Enqueue packets for processing on queue pair of a device. */
26 
27 /**
28  * @internal
29  * Structure used to hold opaque pointers to internal ethdev Rx/Tx
30  * queues data.
31  * The main purpose to expose these pointers at all - allow compiler
32  * to fetch this data for fast-path cryptodev inline functions in advance.
33  */
34 struct rte_cryptodev_qpdata {
35 	/** points to array of internal queue pair data pointers. */
36 	void **data;
37 	/** points to array of enqueue callback data pointers */
38 	struct rte_cryptodev_cb_rcu *enq_cb;
39 	/** points to array of dequeue callback data pointers */
40 	struct rte_cryptodev_cb_rcu *deq_cb;
41 };
42 
43 struct rte_crypto_fp_ops {
44 	/** PMD enqueue burst function. */
45 	enqueue_pkt_burst_t enqueue_burst;
46 	/** PMD dequeue burst function. */
47 	dequeue_pkt_burst_t dequeue_burst;
48 	/** Internal queue pair data pointers. */
49 	struct rte_cryptodev_qpdata qp;
50 	/** Reserved for future ops. */
51 	uintptr_t reserved[3];
52 } __rte_cache_aligned;
53 
54 extern struct rte_crypto_fp_ops rte_crypto_fp_ops[RTE_CRYPTO_MAX_DEVS];
55 
56 /**
57  * The pool of rte_cryptodev structures.
58  */
59 extern struct rte_cryptodev *rte_cryptodevs;
60 
61 #endif /* _RTE_CRYPTODEV_CORE_H_ */
62