1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2018 Intel Corporation
5 #include <rte_bus_pci.h>
6 #include <rte_common.h>
8 #include <rte_malloc.h>
10 #include <rte_cryptodev_pmd.h>
14 #include "qat_sym_session.h"
15 #include "qat_sym_pmd.h"
17 #define MIXED_CRYPTO_MIN_FW_VER 0x04090000
19 uint8_t cryptodev_qat_driver_id;
21 static const struct rte_cryptodev_capabilities qat_gen1_sym_capabilities[] = {
22 QAT_BASE_GEN1_SYM_CAPABILITIES,
23 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
26 static const struct rte_cryptodev_capabilities qat_gen2_sym_capabilities[] = {
27 QAT_BASE_GEN1_SYM_CAPABILITIES,
28 QAT_EXTRA_GEN2_SYM_CAPABILITIES,
29 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
32 static int qat_sym_qp_release(struct rte_cryptodev *dev,
33 uint16_t queue_pair_id);
35 static int qat_sym_dev_config(__rte_unused struct rte_cryptodev *dev,
36 __rte_unused struct rte_cryptodev_config *config)
41 static int qat_sym_dev_start(__rte_unused struct rte_cryptodev *dev)
46 static void qat_sym_dev_stop(__rte_unused struct rte_cryptodev *dev)
51 static int qat_sym_dev_close(struct rte_cryptodev *dev)
55 for (i = 0; i < dev->data->nb_queue_pairs; i++) {
56 ret = qat_sym_qp_release(dev, i);
64 static void qat_sym_dev_info_get(struct rte_cryptodev *dev,
65 struct rte_cryptodev_info *info)
67 struct qat_sym_dev_private *internals = dev->data->dev_private;
68 const struct qat_qp_hw_data *sym_hw_qps =
69 qat_gen_config[internals->qat_dev->qat_dev_gen]
70 .qp_hw_data[QAT_SERVICE_SYMMETRIC];
73 info->max_nb_queue_pairs =
74 qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC);
75 info->feature_flags = dev->feature_flags;
76 info->capabilities = internals->qat_dev_capabilities;
77 info->driver_id = cryptodev_qat_driver_id;
78 /* No limit of number of sessions */
79 info->sym.max_nb_sessions = 0;
83 static void qat_sym_stats_get(struct rte_cryptodev *dev,
84 struct rte_cryptodev_stats *stats)
86 struct qat_common_stats qat_stats = {0};
87 struct qat_sym_dev_private *qat_priv;
89 if (stats == NULL || dev == NULL) {
90 QAT_LOG(ERR, "invalid ptr: stats %p, dev %p", stats, dev);
93 qat_priv = dev->data->dev_private;
95 qat_stats_get(qat_priv->qat_dev, &qat_stats, QAT_SERVICE_SYMMETRIC);
96 stats->enqueued_count = qat_stats.enqueued_count;
97 stats->dequeued_count = qat_stats.dequeued_count;
98 stats->enqueue_err_count = qat_stats.enqueue_err_count;
99 stats->dequeue_err_count = qat_stats.dequeue_err_count;
102 static void qat_sym_stats_reset(struct rte_cryptodev *dev)
104 struct qat_sym_dev_private *qat_priv;
107 QAT_LOG(ERR, "invalid cryptodev ptr %p", dev);
110 qat_priv = dev->data->dev_private;
112 qat_stats_reset(qat_priv->qat_dev, QAT_SERVICE_SYMMETRIC);
116 static int qat_sym_qp_release(struct rte_cryptodev *dev, uint16_t queue_pair_id)
118 struct qat_sym_dev_private *qat_private = dev->data->dev_private;
120 QAT_LOG(DEBUG, "Release sym qp %u on device %d",
121 queue_pair_id, dev->data->dev_id);
123 qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][queue_pair_id]
126 return qat_qp_release((struct qat_qp **)
127 &(dev->data->queue_pairs[queue_pair_id]));
130 static int qat_sym_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
131 const struct rte_cryptodev_qp_conf *qp_conf,
137 struct qat_qp_config qat_qp_conf;
139 struct qat_qp **qp_addr =
140 (struct qat_qp **)&(dev->data->queue_pairs[qp_id]);
141 struct qat_sym_dev_private *qat_private = dev->data->dev_private;
142 const struct qat_qp_hw_data *sym_hw_qps =
143 qat_gen_config[qat_private->qat_dev->qat_dev_gen]
144 .qp_hw_data[QAT_SERVICE_SYMMETRIC];
145 const struct qat_qp_hw_data *qp_hw_data = sym_hw_qps + qp_id;
147 /* If qp is already in use free ring memory and qp metadata. */
148 if (*qp_addr != NULL) {
149 ret = qat_sym_qp_release(dev, qp_id);
153 if (qp_id >= qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC)) {
154 QAT_LOG(ERR, "qp_id %u invalid for this device", qp_id);
158 qat_qp_conf.hw = qp_hw_data;
159 qat_qp_conf.build_request = qat_sym_build_request;
160 qat_qp_conf.cookie_size = sizeof(struct qat_sym_op_cookie);
161 qat_qp_conf.nb_descriptors = qp_conf->nb_descriptors;
162 qat_qp_conf.socket_id = socket_id;
163 qat_qp_conf.service_str = "sym";
165 ret = qat_qp_setup(qat_private->qat_dev, qp_addr, qp_id, &qat_qp_conf);
169 /* store a link to the qp in the qat_pci_device */
170 qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][qp_id]
173 qp = (struct qat_qp *)*qp_addr;
174 qp->min_enq_burst_threshold = qat_private->min_enq_burst_threshold;
176 for (i = 0; i < qp->nb_descriptors; i++) {
178 struct qat_sym_op_cookie *cookie =
181 cookie->qat_sgl_src_phys_addr =
182 rte_mempool_virt2iova(cookie) +
183 offsetof(struct qat_sym_op_cookie,
186 cookie->qat_sgl_dst_phys_addr =
187 rte_mempool_virt2iova(cookie) +
188 offsetof(struct qat_sym_op_cookie,
192 /* Get fw version from QAT (GEN2), skip if we've got it already */
193 if (qp->qat_dev_gen == QAT_GEN2 && !(qat_private->internal_capabilities
194 & QAT_SYM_CAP_VALID)) {
195 ret = qat_cq_get_fw_version(qp);
198 qat_sym_qp_release(dev, qp_id);
203 QAT_LOG(DEBUG, "QAT firmware version: %d.%d.%d",
208 QAT_LOG(DEBUG, "unknown QAT firmware version");
210 /* set capabilities based on the fw version */
211 qat_private->internal_capabilities = QAT_SYM_CAP_VALID |
212 ((ret >= MIXED_CRYPTO_MIN_FW_VER) ?
213 QAT_SYM_CAP_MIXED_CRYPTO : 0);
220 static struct rte_cryptodev_ops crypto_qat_ops = {
222 /* Device related operations */
223 .dev_configure = qat_sym_dev_config,
224 .dev_start = qat_sym_dev_start,
225 .dev_stop = qat_sym_dev_stop,
226 .dev_close = qat_sym_dev_close,
227 .dev_infos_get = qat_sym_dev_info_get,
229 .stats_get = qat_sym_stats_get,
230 .stats_reset = qat_sym_stats_reset,
231 .queue_pair_setup = qat_sym_qp_setup,
232 .queue_pair_release = qat_sym_qp_release,
234 /* Crypto related operations */
235 .sym_session_get_size = qat_sym_session_get_private_size,
236 .sym_session_configure = qat_sym_session_configure,
237 .sym_session_clear = qat_sym_session_clear
241 qat_sym_pmd_enqueue_op_burst(void *qp, struct rte_crypto_op **ops,
244 return qat_enqueue_op_burst(qp, (void **)ops, nb_ops);
248 qat_sym_pmd_dequeue_op_burst(void *qp, struct rte_crypto_op **ops,
251 return qat_dequeue_op_burst(qp, (void **)ops, nb_ops);
254 /* An rte_driver is needed in the registration of both the device and the driver
256 * The actual qat pci's rte_driver can't be used as its name represents
257 * the whole pci device with all services. Think of this as a holder for a name
258 * for the crypto part of the pci device.
260 static const char qat_sym_drv_name[] = RTE_STR(CRYPTODEV_NAME_QAT_SYM_PMD);
261 static const struct rte_driver cryptodev_qat_sym_driver = {
262 .name = qat_sym_drv_name,
263 .alias = qat_sym_drv_name
267 qat_sym_dev_create(struct qat_pci_device *qat_pci_dev,
268 struct qat_dev_cmd_param *qat_dev_cmd_param __rte_unused)
271 struct rte_cryptodev_pmd_init_params init_params = {
273 .socket_id = qat_pci_dev->pci_dev->device.numa_node,
274 .private_data_size = sizeof(struct qat_sym_dev_private)
276 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
277 struct rte_cryptodev *cryptodev;
278 struct qat_sym_dev_private *internals;
280 snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN, "%s_%s",
281 qat_pci_dev->name, "sym");
282 QAT_LOG(DEBUG, "Creating QAT SYM device %s", name);
284 /* Populate subset device to use in cryptodev device creation */
285 qat_pci_dev->sym_rte_dev.driver = &cryptodev_qat_sym_driver;
286 qat_pci_dev->sym_rte_dev.numa_node =
287 qat_pci_dev->pci_dev->device.numa_node;
288 qat_pci_dev->sym_rte_dev.devargs = NULL;
290 cryptodev = rte_cryptodev_pmd_create(name,
291 &(qat_pci_dev->sym_rte_dev), &init_params);
293 if (cryptodev == NULL)
296 qat_pci_dev->sym_rte_dev.name = cryptodev->data->name;
297 cryptodev->driver_id = cryptodev_qat_driver_id;
298 cryptodev->dev_ops = &crypto_qat_ops;
300 cryptodev->enqueue_burst = qat_sym_pmd_enqueue_op_burst;
301 cryptodev->dequeue_burst = qat_sym_pmd_dequeue_op_burst;
303 cryptodev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
304 RTE_CRYPTODEV_FF_HW_ACCELERATED |
305 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
306 RTE_CRYPTODEV_FF_IN_PLACE_SGL |
307 RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT |
308 RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
309 RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT |
310 RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT |
311 RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED;
313 internals = cryptodev->data->dev_private;
314 internals->qat_dev = qat_pci_dev;
315 qat_pci_dev->sym_dev = internals;
317 internals->sym_dev_id = cryptodev->data->dev_id;
318 switch (qat_pci_dev->qat_dev_gen) {
320 internals->qat_dev_capabilities = qat_gen1_sym_capabilities;
324 internals->qat_dev_capabilities = qat_gen2_sym_capabilities;
327 internals->qat_dev_capabilities = qat_gen2_sym_capabilities;
329 "QAT gen %d capabilities unknown, default to GEN2",
330 qat_pci_dev->qat_dev_gen);
335 if (qat_dev_cmd_param[i].name == NULL)
337 if (!strcmp(qat_dev_cmd_param[i].name, SYM_ENQ_THRESHOLD_NAME))
338 internals->min_enq_burst_threshold =
339 qat_dev_cmd_param[i].val;
343 QAT_LOG(DEBUG, "Created QAT SYM device %s as cryptodev instance %d",
344 cryptodev->data->name, internals->sym_dev_id);
349 qat_sym_dev_destroy(struct qat_pci_device *qat_pci_dev)
351 struct rte_cryptodev *cryptodev;
353 if (qat_pci_dev == NULL)
355 if (qat_pci_dev->sym_dev == NULL)
358 /* free crypto device */
359 cryptodev = rte_cryptodev_pmd_get_dev(qat_pci_dev->sym_dev->sym_dev_id);
360 rte_cryptodev_pmd_destroy(cryptodev);
361 qat_pci_dev->sym_rte_dev.name = NULL;
362 qat_pci_dev->sym_dev = NULL;
367 static struct cryptodev_driver qat_crypto_drv;
368 RTE_PMD_REGISTER_CRYPTO_DRIVER(qat_crypto_drv,
369 cryptodev_qat_sym_driver,
370 cryptodev_qat_driver_id);