1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2018 Intel Corporation
5 #include <rte_common.h>
7 #include <rte_malloc.h>
8 #include <rte_memzone.h>
10 #include <rte_bus_pci.h>
11 #include <rte_atomic.h>
12 #include <rte_prefetch.h>
15 #include "qat_device.h"
17 #include "adf_transport_access_macros.h"
20 #define ADF_MAX_DESC 4096
21 #define ADF_MIN_DESC 128
23 #define ADF_ARB_REG_SLOT 0x1000
24 #define ADF_ARB_RINGSRVARBEN_OFFSET 0x19C
26 #define WRITE_CSR_ARB_RINGSRVARBEN(csr_addr, index, value) \
27 ADF_CSR_WR(csr_addr, ADF_ARB_RINGSRVARBEN_OFFSET + \
28 (ADF_ARB_REG_SLOT * index), value)
31 const struct qat_qp_hw_data qat_gen1_qps[QAT_MAX_SERVICES]
32 [ADF_MAX_QPS_ON_ANY_SERVICE] = {
33 /* queue pairs which provide an asymmetric crypto service */
34 [QAT_SERVICE_ASYMMETRIC] = {
36 .service_type = QAT_SERVICE_ASYMMETRIC,
44 .service_type = QAT_SERVICE_ASYMMETRIC,
52 /* queue pairs which provide a symmetric crypto service */
53 [QAT_SERVICE_SYMMETRIC] = {
55 .service_type = QAT_SERVICE_SYMMETRIC,
63 .service_type = QAT_SERVICE_SYMMETRIC,
71 /* queue pairs which provide a compression service */
72 [QAT_SERVICE_COMPRESSION] = {
74 .service_type = QAT_SERVICE_COMPRESSION,
81 .service_type = QAT_SERVICE_COMPRESSION,
91 static int qat_qp_check_queue_alignment(uint64_t phys_addr,
92 uint32_t queue_size_bytes);
93 static void qat_queue_delete(struct qat_queue *queue);
94 static int qat_queue_create(struct qat_pci_device *qat_dev,
95 struct qat_queue *queue, struct qat_qp_config *, uint8_t dir);
96 static int adf_verify_queue_size(uint32_t msg_size, uint32_t msg_num,
97 uint32_t *queue_size_for_csr);
98 static void adf_configure_queues(struct qat_qp *queue);
99 static void adf_queue_arb_enable(struct qat_queue *txq, void *base_addr,
100 rte_spinlock_t *lock);
101 static void adf_queue_arb_disable(struct qat_queue *txq, void *base_addr,
102 rte_spinlock_t *lock);
105 int qat_qps_per_service(const struct qat_qp_hw_data *qp_hw_data,
106 enum qat_service_type service)
110 for (i = 0, count = 0; i < ADF_MAX_QPS_ON_ANY_SERVICE; i++)
111 if (qp_hw_data[i].service_type == service)
116 static const struct rte_memzone *
117 queue_dma_zone_reserve(const char *queue_name, uint32_t queue_size,
120 const struct rte_memzone *mz;
122 PMD_INIT_FUNC_TRACE();
123 mz = rte_memzone_lookup(queue_name);
125 if (((size_t)queue_size <= mz->len) &&
126 ((socket_id == SOCKET_ID_ANY) ||
127 (socket_id == mz->socket_id))) {
128 PMD_DRV_LOG(DEBUG, "re-use memzone already "
129 "allocated for %s", queue_name);
133 PMD_DRV_LOG(ERR, "Incompatible memzone already "
134 "allocated %s, size %u, socket %d. "
135 "Requested size %u, socket %u",
136 queue_name, (uint32_t)mz->len,
137 mz->socket_id, queue_size, socket_id);
141 PMD_DRV_LOG(DEBUG, "Allocate memzone for %s, size %u on socket %u",
142 queue_name, queue_size, socket_id);
143 return rte_memzone_reserve_aligned(queue_name, queue_size,
144 socket_id, RTE_MEMZONE_IOVA_CONTIG, queue_size);
147 int qat_qp_setup(struct qat_pci_device *qat_dev,
148 struct qat_qp **qp_addr,
149 uint16_t queue_pair_id,
150 struct qat_qp_config *qat_qp_conf)
154 struct rte_pci_device *pci_dev = qat_dev->pci_dev;
155 char op_cookie_pool_name[RTE_RING_NAMESIZE];
158 PMD_DRV_LOG(DEBUG, "Setup qp %u on qat pci device %d gen %d",
159 queue_pair_id, qat_dev->qat_dev_id, qat_dev->qat_dev_gen);
161 if ((qat_qp_conf->nb_descriptors > ADF_MAX_DESC) ||
162 (qat_qp_conf->nb_descriptors < ADF_MIN_DESC)) {
163 PMD_DRV_LOG(ERR, "Can't create qp for %u descriptors",
164 qat_qp_conf->nb_descriptors);
168 if (pci_dev->mem_resource[0].addr == NULL) {
169 PMD_DRV_LOG(ERR, "Could not find VF config space "
170 "(UIO driver attached?).");
174 /* Allocate the queue pair data structure. */
175 qp = rte_zmalloc("qat PMD qp metadata",
176 sizeof(*qp), RTE_CACHE_LINE_SIZE);
178 PMD_DRV_LOG(ERR, "Failed to alloc mem for qp struct");
181 qp->nb_descriptors = qat_qp_conf->nb_descriptors;
182 qp->op_cookies = rte_zmalloc("qat PMD op cookie pointer",
183 qat_qp_conf->nb_descriptors * sizeof(*qp->op_cookies),
184 RTE_CACHE_LINE_SIZE);
185 if (qp->op_cookies == NULL) {
186 PMD_DRV_LOG(ERR, "Failed to alloc mem for cookie");
191 qp->mmap_bar_addr = pci_dev->mem_resource[0].addr;
194 if (qat_queue_create(qat_dev, &(qp->tx_q), qat_qp_conf,
195 ADF_RING_DIR_TX) != 0) {
196 PMD_INIT_LOG(ERR, "Tx queue create failed "
197 "queue_pair_id=%u", queue_pair_id);
201 if (qat_queue_create(qat_dev, &(qp->rx_q), qat_qp_conf,
202 ADF_RING_DIR_RX) != 0) {
203 PMD_DRV_LOG(ERR, "Rx queue create failed "
204 "queue_pair_id=%hu", queue_pair_id);
205 qat_queue_delete(&(qp->tx_q));
209 adf_configure_queues(qp);
210 adf_queue_arb_enable(&qp->tx_q, qp->mmap_bar_addr,
211 &qat_dev->arb_csr_lock);
213 snprintf(op_cookie_pool_name, RTE_RING_NAMESIZE,
214 "%s%d_cookies_%s_qp%hu",
215 pci_dev->driver->driver.name, qat_dev->qat_dev_id,
216 qat_qp_conf->service_str, queue_pair_id);
218 PMD_DRV_LOG(DEBUG, "cookiepool: %s", op_cookie_pool_name);
219 qp->op_cookie_pool = rte_mempool_lookup(op_cookie_pool_name);
220 if (qp->op_cookie_pool == NULL)
221 qp->op_cookie_pool = rte_mempool_create(op_cookie_pool_name,
223 qat_qp_conf->cookie_size, 64, 0,
224 NULL, NULL, NULL, NULL, qat_qp_conf->socket_id,
226 if (!qp->op_cookie_pool) {
227 PMD_DRV_LOG(ERR, "QAT PMD Cannot create"
232 for (i = 0; i < qp->nb_descriptors; i++) {
233 if (rte_mempool_get(qp->op_cookie_pool, &qp->op_cookies[i])) {
234 PMD_DRV_LOG(ERR, "QAT PMD Cannot get op_cookie");
239 qp->qat_dev_gen = qat_dev->qat_dev_gen;
240 qp->build_request = qat_qp_conf->build_request;
241 qp->process_response = qat_qp_conf->process_response;
242 qp->qat_dev = qat_dev;
244 PMD_DRV_LOG(DEBUG, "QP setup complete: id: %d, cookiepool: %s",
245 queue_pair_id, op_cookie_pool_name);
251 if (qp->op_cookie_pool)
252 rte_mempool_free(qp->op_cookie_pool);
253 rte_free(qp->op_cookies);
258 int qat_qp_release(struct qat_qp **qp_addr)
260 struct qat_qp *qp = *qp_addr;
263 PMD_INIT_FUNC_TRACE();
265 PMD_DRV_LOG(DEBUG, "qp already freed");
269 PMD_DRV_LOG(DEBUG, "Free qp on qat_pci device %d",
270 qp->qat_dev->qat_dev_id);
272 /* Don't free memory if there are still responses to be processed */
273 if (qp->inflights16 == 0) {
274 qat_queue_delete(&(qp->tx_q));
275 qat_queue_delete(&(qp->rx_q));
280 adf_queue_arb_disable(&(qp->tx_q), qp->mmap_bar_addr,
281 &qp->qat_dev->arb_csr_lock);
283 for (i = 0; i < qp->nb_descriptors; i++)
284 rte_mempool_put(qp->op_cookie_pool, qp->op_cookies[i]);
286 if (qp->op_cookie_pool)
287 rte_mempool_free(qp->op_cookie_pool);
289 rte_free(qp->op_cookies);
296 static void qat_queue_delete(struct qat_queue *queue)
298 const struct rte_memzone *mz;
302 PMD_DRV_LOG(DEBUG, "Invalid queue");
305 PMD_DRV_LOG(DEBUG, "Free ring %d, memzone: %s",
306 queue->hw_queue_number, queue->memz_name);
308 mz = rte_memzone_lookup(queue->memz_name);
310 /* Write an unused pattern to the queue memory. */
311 memset(queue->base_addr, 0x7F, queue->queue_size);
312 status = rte_memzone_free(mz);
314 PMD_DRV_LOG(ERR, "Error %d on freeing queue %s",
315 status, queue->memz_name);
317 PMD_DRV_LOG(DEBUG, "queue %s doesn't exist",
323 qat_queue_create(struct qat_pci_device *qat_dev, struct qat_queue *queue,
324 struct qat_qp_config *qp_conf, uint8_t dir)
328 const struct rte_memzone *qp_mz;
329 struct rte_pci_device *pci_dev = qat_dev->pci_dev;
331 uint16_t desc_size = (dir == ADF_RING_DIR_TX ?
332 qp_conf->hw->tx_msg_size : qp_conf->hw->rx_msg_size);
333 uint32_t queue_size_bytes = (qp_conf->nb_descriptors)*(desc_size);
335 queue->hw_bundle_number = qp_conf->hw->hw_bundle_num;
336 queue->hw_queue_number = (dir == ADF_RING_DIR_TX ?
337 qp_conf->hw->tx_ring_num : qp_conf->hw->rx_ring_num);
339 if (desc_size > ADF_MSG_SIZE_TO_BYTES(ADF_MAX_MSG_SIZE)) {
340 PMD_DRV_LOG(ERR, "Invalid descriptor size %d", desc_size);
345 * Allocate a memzone for the queue - create a unique name.
347 snprintf(queue->memz_name, sizeof(queue->memz_name),
349 pci_dev->driver->driver.name, qat_dev->qat_dev_id,
350 qp_conf->service_str, "qp_mem",
351 queue->hw_bundle_number, queue->hw_queue_number);
352 qp_mz = queue_dma_zone_reserve(queue->memz_name, queue_size_bytes,
355 PMD_DRV_LOG(ERR, "Failed to allocate ring memzone");
359 queue->base_addr = (char *)qp_mz->addr;
360 queue->base_phys_addr = qp_mz->iova;
361 if (qat_qp_check_queue_alignment(queue->base_phys_addr,
363 PMD_DRV_LOG(ERR, "Invalid alignment on queue create "
365 queue->base_phys_addr);
367 goto queue_create_err;
370 if (adf_verify_queue_size(desc_size, qp_conf->nb_descriptors,
371 &(queue->queue_size)) != 0) {
372 PMD_DRV_LOG(ERR, "Invalid num inflights");
374 goto queue_create_err;
377 queue->max_inflights = ADF_MAX_INFLIGHTS(queue->queue_size,
378 ADF_BYTES_TO_MSG_SIZE(desc_size));
379 queue->modulo_mask = (1 << ADF_RING_SIZE_MODULO(queue->queue_size)) - 1;
381 if (queue->max_inflights < 2) {
382 PMD_DRV_LOG(ERR, "Invalid num inflights");
384 goto queue_create_err;
388 queue->msg_size = desc_size;
391 * Write an unused pattern to the queue memory.
393 memset(queue->base_addr, 0x7F, queue_size_bytes);
395 queue_base = BUILD_RING_BASE_ADDR(queue->base_phys_addr,
398 io_addr = pci_dev->mem_resource[0].addr;
400 WRITE_CSR_RING_BASE(io_addr, queue->hw_bundle_number,
401 queue->hw_queue_number, queue_base);
403 PMD_DRV_LOG(DEBUG, "RING: Name:%s, size in CSR: %u, in bytes %u,"
404 " nb msgs %u, msg_size %u, max_inflights %u modulo mask %u",
406 queue->queue_size, queue_size_bytes,
407 qp_conf->nb_descriptors, desc_size,
408 queue->max_inflights, queue->modulo_mask);
413 rte_memzone_free(qp_mz);
417 static int qat_qp_check_queue_alignment(uint64_t phys_addr,
418 uint32_t queue_size_bytes)
420 PMD_INIT_FUNC_TRACE();
421 if (((queue_size_bytes - 1) & phys_addr) != 0)
426 static int adf_verify_queue_size(uint32_t msg_size, uint32_t msg_num,
427 uint32_t *p_queue_size_for_csr)
429 uint8_t i = ADF_MIN_RING_SIZE;
431 PMD_INIT_FUNC_TRACE();
432 for (; i <= ADF_MAX_RING_SIZE; i++)
433 if ((msg_size * msg_num) ==
434 (uint32_t)ADF_SIZE_TO_RING_SIZE_IN_BYTES(i)) {
435 *p_queue_size_for_csr = i;
438 PMD_DRV_LOG(ERR, "Invalid ring size %d", msg_size * msg_num);
442 static void adf_queue_arb_enable(struct qat_queue *txq, void *base_addr,
443 rte_spinlock_t *lock)
445 uint32_t arb_csr_offset = ADF_ARB_RINGSRVARBEN_OFFSET +
447 txq->hw_bundle_number);
450 PMD_INIT_FUNC_TRACE();
452 rte_spinlock_lock(lock);
453 value = ADF_CSR_RD(base_addr, arb_csr_offset);
454 value |= (0x01 << txq->hw_queue_number);
455 ADF_CSR_WR(base_addr, arb_csr_offset, value);
456 rte_spinlock_unlock(lock);
459 static void adf_queue_arb_disable(struct qat_queue *txq, void *base_addr,
460 rte_spinlock_t *lock)
462 uint32_t arb_csr_offset = ADF_ARB_RINGSRVARBEN_OFFSET +
464 txq->hw_bundle_number);
467 PMD_INIT_FUNC_TRACE();
469 rte_spinlock_lock(lock);
470 value = ADF_CSR_RD(base_addr, arb_csr_offset);
471 value &= ~(0x01 << txq->hw_queue_number);
472 ADF_CSR_WR(base_addr, arb_csr_offset, value);
473 rte_spinlock_unlock(lock);
476 static void adf_configure_queues(struct qat_qp *qp)
478 uint32_t queue_config;
479 struct qat_queue *queue = &qp->tx_q;
481 PMD_INIT_FUNC_TRACE();
482 queue_config = BUILD_RING_CONFIG(queue->queue_size);
484 WRITE_CSR_RING_CONFIG(qp->mmap_bar_addr, queue->hw_bundle_number,
485 queue->hw_queue_number, queue_config);
489 BUILD_RESP_RING_CONFIG(queue->queue_size,
490 ADF_RING_NEAR_WATERMARK_512,
491 ADF_RING_NEAR_WATERMARK_0);
493 WRITE_CSR_RING_CONFIG(qp->mmap_bar_addr, queue->hw_bundle_number,
494 queue->hw_queue_number, queue_config);
497 static inline uint32_t adf_modulo(uint32_t data, uint32_t modulo_mask)
499 return data & modulo_mask;
503 txq_write_tail(struct qat_qp *qp, struct qat_queue *q) {
504 WRITE_CSR_RING_TAIL(qp->mmap_bar_addr, q->hw_bundle_number,
505 q->hw_queue_number, q->tail);
506 q->nb_pending_requests = 0;
507 q->csr_tail = q->tail;
511 void rxq_free_desc(struct qat_qp *qp, struct qat_queue *q)
513 uint32_t old_head, new_head;
516 old_head = q->csr_head;
518 max_head = qp->nb_descriptors * q->msg_size;
520 /* write out free descriptors */
521 void *cur_desc = (uint8_t *)q->base_addr + old_head;
523 if (new_head < old_head) {
524 memset(cur_desc, ADF_RING_EMPTY_SIG_BYTE, max_head - old_head);
525 memset(q->base_addr, ADF_RING_EMPTY_SIG_BYTE, new_head);
527 memset(cur_desc, ADF_RING_EMPTY_SIG_BYTE, new_head - old_head);
529 q->nb_processed_responses = 0;
530 q->csr_head = new_head;
532 /* write current head to CSR */
533 WRITE_CSR_RING_HEAD(qp->mmap_bar_addr, q->hw_bundle_number,
534 q->hw_queue_number, new_head);
538 qat_enqueue_op_burst(void *qp, void **ops, uint16_t nb_ops)
540 register struct qat_queue *queue;
541 struct qat_qp *tmp_qp = (struct qat_qp *)qp;
542 register uint32_t nb_ops_sent = 0;
544 uint16_t nb_ops_possible = nb_ops;
545 register uint8_t *base_addr;
546 register uint32_t tail;
549 if (unlikely(nb_ops == 0))
552 /* read params used a lot in main loop into registers */
553 queue = &(tmp_qp->tx_q);
554 base_addr = (uint8_t *)queue->base_addr;
557 /* Find how many can actually fit on the ring */
558 tmp_qp->inflights16 += nb_ops;
559 overflow = tmp_qp->inflights16 - queue->max_inflights;
561 tmp_qp->inflights16 -= overflow;
562 nb_ops_possible = nb_ops - overflow;
563 if (nb_ops_possible == 0)
567 while (nb_ops_sent != nb_ops_possible) {
568 ret = tmp_qp->build_request(*ops, base_addr + tail,
569 tmp_qp->op_cookies[tail / queue->msg_size],
570 tmp_qp->qat_dev_gen);
572 tmp_qp->stats.enqueue_err_count++;
574 * This message cannot be enqueued,
575 * decrease number of ops that wasn't sent
577 tmp_qp->inflights16 -= nb_ops_possible - nb_ops_sent;
578 if (nb_ops_sent == 0)
583 tail = adf_modulo(tail + queue->msg_size, queue->modulo_mask);
589 tmp_qp->stats.enqueued_count += nb_ops_sent;
590 queue->nb_pending_requests += nb_ops_sent;
591 if (tmp_qp->inflights16 < QAT_CSR_TAIL_FORCE_WRITE_THRESH ||
592 queue->nb_pending_requests > QAT_CSR_TAIL_WRITE_THRESH) {
593 txq_write_tail(tmp_qp, queue);
599 qat_dequeue_op_burst(void *qp, void **ops, uint16_t nb_ops)
601 struct qat_queue *rx_queue, *tx_queue;
602 struct qat_qp *tmp_qp = (struct qat_qp *)qp;
604 uint32_t resp_counter = 0;
607 rx_queue = &(tmp_qp->rx_q);
608 tx_queue = &(tmp_qp->tx_q);
609 head = rx_queue->head;
610 resp_msg = (uint8_t *)rx_queue->base_addr + rx_queue->head;
612 while (*(uint32_t *)resp_msg != ADF_RING_EMPTY_SIG &&
613 resp_counter != nb_ops) {
615 tmp_qp->process_response(ops, resp_msg);
617 head = adf_modulo(head + rx_queue->msg_size,
618 rx_queue->modulo_mask);
620 resp_msg = (uint8_t *)rx_queue->base_addr + head;
624 if (resp_counter > 0) {
625 rx_queue->head = head;
626 tmp_qp->stats.dequeued_count += resp_counter;
627 rx_queue->nb_processed_responses += resp_counter;
628 tmp_qp->inflights16 -= resp_counter;
630 if (rx_queue->nb_processed_responses >
631 QAT_CSR_HEAD_WRITE_THRESH)
632 rxq_free_desc(tmp_qp, rx_queue);
634 /* also check if tail needs to be advanced */
635 if (tmp_qp->inflights16 <= QAT_CSR_TAIL_FORCE_WRITE_THRESH &&
636 tx_queue->tail != tx_queue->csr_tail) {
637 txq_write_tail(tmp_qp, tx_queue);