4 * Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _QAT_CRYPTO_H_
35 #define _QAT_CRYPTO_H_
37 #include <rte_cryptodev_pmd.h>
38 #include <rte_memzone.h>
40 #include "qat_crypto_capabilities.h"
42 #define CRYPTODEV_NAME_QAT_SYM_PMD crypto_qat
43 /**< Intel QAT Symmetric Crypto PMD device name */
46 * This macro rounds up a number to a be a multiple of
47 * the alignment when the alignment is a power of 2
49 #define ALIGN_POW2_ROUNDUP(num, align) \
50 (((num) + (align) - 1) & ~((align) - 1))
51 #define QAT_64_BTYE_ALIGN_MASK (~0x3f)
54 * Structure associated with each queue.
57 char memz_name[RTE_MEMZONE_NAMESIZE];
58 void *base_addr; /* Base address */
59 phys_addr_t base_phys_addr; /* Queue physical address */
60 uint32_t head; /* Shadow copy of the head */
61 uint32_t tail; /* Shadow copy of the tail */
64 uint16_t max_inflights;
66 uint8_t hw_bundle_number;
67 uint8_t hw_queue_number;
68 /* HW queue aka ring offset on bundle */
73 rte_atomic16_t inflights16;
74 struct qat_queue tx_q;
75 struct qat_queue rx_q;
76 struct rte_cryptodev_stats stats;
77 struct rte_mempool *op_cookie_pool;
79 uint32_t nb_descriptors;
80 } __rte_cache_aligned;
82 /** private data structure for each QAT device */
83 struct qat_pmd_private {
84 unsigned max_nb_queue_pairs;
85 /**< Max number of queue pairs supported by device */
86 unsigned max_nb_sessions;
87 /**< Max number of sessions supported by device */
88 const struct rte_cryptodev_capabilities *qat_dev_capabilities;
91 extern uint8_t cryptodev_qat_driver_id;
93 int qat_dev_config(struct rte_cryptodev *dev,
94 struct rte_cryptodev_config *config);
95 int qat_dev_start(struct rte_cryptodev *dev);
96 void qat_dev_stop(struct rte_cryptodev *dev);
97 int qat_dev_close(struct rte_cryptodev *dev);
98 void qat_dev_info_get(struct rte_cryptodev *dev,
99 struct rte_cryptodev_info *info);
101 void qat_crypto_sym_stats_get(struct rte_cryptodev *dev,
102 struct rte_cryptodev_stats *stats);
103 void qat_crypto_sym_stats_reset(struct rte_cryptodev *dev);
105 int qat_crypto_sym_qp_setup(struct rte_cryptodev *dev, uint16_t queue_pair_id,
106 const struct rte_cryptodev_qp_conf *rx_conf, int socket_id);
107 int qat_crypto_sym_qp_release(struct rte_cryptodev *dev,
108 uint16_t queue_pair_id);
111 qat_pmd_session_mempool_create(struct rte_cryptodev *dev,
112 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
115 qat_crypto_sym_get_session_private_size(struct rte_cryptodev *dev);
118 qat_crypto_sym_session_init(struct rte_mempool *mempool, void *priv_sess);
121 qat_crypto_sym_configure_session(struct rte_cryptodev *dev,
122 struct rte_crypto_sym_xform *xform, void *session_private);
125 qat_crypto_sym_configure_session_aead(struct rte_crypto_sym_xform *xform,
126 struct qat_session *session_private);
129 qat_crypto_sym_configure_session_auth(struct rte_cryptodev *dev,
130 struct rte_crypto_sym_xform *xform,
131 struct qat_session *session_private);
134 qat_crypto_sym_configure_session_cipher(struct rte_cryptodev *dev,
135 struct rte_crypto_sym_xform *xform, void *session_private);
139 qat_crypto_sym_clear_session(struct rte_cryptodev *dev, void *session);
143 qat_pmd_enqueue_op_burst(void *qp, struct rte_crypto_op **ops,
147 qat_pmd_dequeue_op_burst(void *qp, struct rte_crypto_op **ops,
150 #endif /* _QAT_CRYPTO_H_ */