1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Marvell International Ltd.
3 * Copyright(c) 2017 Semihalf.
9 #include <rte_common.h>
10 #include <rte_malloc.h>
11 #include <rte_cryptodev_pmd.h>
13 #include "rte_mrvl_pmd_private.h"
16 * Capabilities list to be used in reporting to DPDK.
18 static const struct rte_cryptodev_capabilities
19 mrvl_crypto_pmd_capabilities[] = {
21 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
23 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
25 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
41 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
43 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
45 .algo = RTE_CRYPTO_AUTH_MD5,
61 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
63 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
65 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
81 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
83 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
85 .algo = RTE_CRYPTO_AUTH_SHA1,
102 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
104 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
106 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
122 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
124 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
126 .algo = RTE_CRYPTO_AUTH_SHA224,
142 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
144 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
146 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
162 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
164 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
166 .algo = RTE_CRYPTO_AUTH_SHA256,
182 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
184 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
186 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
202 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
204 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
206 .algo = RTE_CRYPTO_AUTH_SHA384,
222 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
224 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
226 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
242 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
244 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
246 .algo = RTE_CRYPTO_AUTH_SHA512,
262 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
264 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
266 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
282 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
284 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
286 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
302 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
304 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
306 .algo = RTE_CRYPTO_CIPHER_AES_ECB,
322 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
324 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
326 .algo = RTE_CRYPTO_AEAD_AES_GCM,
351 { /* AES GMAC (AUTH) */
352 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
354 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
356 .algo = RTE_CRYPTO_AUTH_AES_GMAC,
377 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
379 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
381 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
397 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
399 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
401 .algo = RTE_CRYPTO_CIPHER_3DES_CTR,
417 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
422 * Configure device (PMD ops callback).
424 * @param dev Pointer to the device structure.
425 * @param config Pointer to configuration structure.
426 * @returns 0. Always.
429 mrvl_crypto_pmd_config(__rte_unused struct rte_cryptodev *dev,
430 __rte_unused struct rte_cryptodev_config *config)
436 * Start device (PMD ops callback).
438 * @param dev Pointer to the device structure.
439 * @returns 0. Always.
442 mrvl_crypto_pmd_start(__rte_unused struct rte_cryptodev *dev)
448 * Stop device (PMD ops callback).
450 * @param dev Pointer to the device structure.
451 * @returns 0. Always.
454 mrvl_crypto_pmd_stop(__rte_unused struct rte_cryptodev *dev)
459 * Get device statistics (PMD ops callback).
461 * @param dev Pointer to the device structure.
462 * @param stats Pointer to statistics structure [out].
465 mrvl_crypto_pmd_stats_get(struct rte_cryptodev *dev,
466 struct rte_cryptodev_stats *stats)
470 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
471 struct mrvl_crypto_qp *qp = dev->data->queue_pairs[qp_id];
473 stats->enqueued_count += qp->stats.enqueued_count;
474 stats->dequeued_count += qp->stats.dequeued_count;
476 stats->enqueue_err_count += qp->stats.enqueue_err_count;
477 stats->dequeue_err_count += qp->stats.dequeue_err_count;
482 * Reset device statistics (PMD ops callback).
484 * @param dev Pointer to the device structure.
487 mrvl_crypto_pmd_stats_reset(struct rte_cryptodev *dev)
491 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
492 struct mrvl_crypto_qp *qp = dev->data->queue_pairs[qp_id];
494 memset(&qp->stats, 0, sizeof(qp->stats));
499 * Get device info (PMD ops callback).
501 * @param dev Pointer to the device structure.
502 * @param dev_info Pointer to the device info structure [out].
505 mrvl_crypto_pmd_info_get(struct rte_cryptodev *dev,
506 struct rte_cryptodev_info *dev_info)
508 struct mrvl_crypto_private *internals = dev->data->dev_private;
510 if (dev_info != NULL) {
511 dev_info->driver_id = dev->driver_id;
512 dev_info->feature_flags = dev->feature_flags;
513 dev_info->capabilities = mrvl_crypto_pmd_capabilities;
514 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
515 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
520 * Release queue pair (PMD ops callback).
522 * @param dev Pointer to the device structure.
523 * @param qp_id ID of Queue Pair to release.
524 * @returns 0. Always.
527 mrvl_crypto_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
529 struct mrvl_crypto_qp *qp =
530 (struct mrvl_crypto_qp *)dev->data->queue_pairs[qp_id];
532 if (dev->data->queue_pairs[qp_id] != NULL) {
533 sam_cio_flush(qp->cio);
534 sam_cio_deinit(qp->cio);
535 rte_free(dev->data->queue_pairs[qp_id]);
536 dev->data->queue_pairs[qp_id] = NULL;
543 * Close device (PMD ops callback).
545 * @param dev Pointer to the device structure.
546 * @returns 0. Always.
549 mrvl_crypto_pmd_close(struct rte_cryptodev *dev)
553 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++)
554 mrvl_crypto_pmd_qp_release(dev, qp_id);
560 * Setup a queue pair (PMD ops callback).
562 * @param dev Pointer to the device structure.
563 * @param qp_id ID of the Queue Pair.
564 * @param qp_conf Queue pair configuration (nb of descriptors).
565 * @param socket_id NUMA socket to allocate memory on.
566 * @returns 0 upon success, negative value otherwise.
569 mrvl_crypto_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
570 const struct rte_cryptodev_qp_conf *qp_conf,
571 int socket_id, struct rte_mempool *session_pool)
573 struct mrvl_crypto_qp *qp = NULL;
574 char match[RTE_CRYPTODEV_NAME_MAX_LEN];
577 /* Allocate the queue pair data structure. */
578 qp = rte_zmalloc_socket("MRVL Crypto PMD Queue Pair", sizeof(*qp),
579 RTE_CACHE_LINE_SIZE, socket_id);
583 /* Free old qp prior setup if needed. */
584 if (dev->data->queue_pairs[qp_id] != NULL)
585 mrvl_crypto_pmd_qp_release(dev, qp_id);
587 do { /* Error handling block */
590 * This extra check is necessary due to a bug in
593 int num = sam_get_num_inst();
595 MRVL_CRYPTO_LOG_ERR("No crypto engines detected.\n");
600 * In case two crypto engines are enabled qps will
601 * be evenly spread among them. Even and odd qps will
602 * be handled by cio-0 and cio-1 respectively. qp-cio mapping
603 * will look as follows:
606 * cio-x:y: cio-0:0, cio-1:0, cio-0:1, cio-1:1
609 * cio-x:y: cio-0:2, cio-1:2, cio-0:3, cio-1:3
611 * In case just one engine is enabled mapping will look as
614 * cio-x:y: cio-0:0, cio-0:1, cio-0:2, cio-0:3
616 n = snprintf(match, sizeof(match), "cio-%u:%u",
617 qp_id % num, qp_id / num);
619 if (n >= sizeof(match))
622 qp->cio_params.match = match;
623 qp->cio_params.size = qp_conf->nb_descriptors;
625 if (sam_cio_init(&qp->cio_params, &qp->cio) < 0)
628 qp->sess_mp = session_pool;
630 memset(&qp->stats, 0, sizeof(qp->stats));
631 dev->data->queue_pairs[qp_id] = qp;
639 /** Return the number of allocated queue pairs (PMD ops callback).
641 * @param dev Pointer to the device structure.
642 * @returns Number of allocated queue pairs.
645 mrvl_crypto_pmd_qp_count(struct rte_cryptodev *dev)
647 return dev->data->nb_queue_pairs;
650 /** Returns the size of the session structure (PMD ops callback).
652 * @param dev Pointer to the device structure [Unused].
653 * @returns Size of Marvell crypto session.
656 mrvl_crypto_pmd_sym_session_get_size(__rte_unused struct rte_cryptodev *dev)
658 return sizeof(struct mrvl_crypto_session);
661 /** Configure the session from a crypto xform chain (PMD ops callback).
663 * @param dev Pointer to the device structure.
664 * @param xform Pointer to the crytpo configuration structure.
665 * @param sess Pointer to the empty session structure.
666 * @returns 0 upon success, negative value otherwise.
669 mrvl_crypto_pmd_sym_session_configure(__rte_unused struct rte_cryptodev *dev,
670 struct rte_crypto_sym_xform *xform,
671 struct rte_cryptodev_sym_session *sess,
672 struct rte_mempool *mp)
674 struct mrvl_crypto_session *mrvl_sess;
675 void *sess_private_data;
679 MRVL_CRYPTO_LOG_ERR("Invalid session struct.");
683 if (rte_mempool_get(mp, &sess_private_data)) {
684 CDEV_LOG_ERR("Couldn't get object from session mempool.");
688 ret = mrvl_crypto_set_session_parameters(sess_private_data, xform);
690 MRVL_CRYPTO_LOG_ERR("Failed to configure session parameters.");
692 /* Return session to mempool */
693 rte_mempool_put(mp, sess_private_data);
697 set_sym_session_private_data(sess, dev->driver_id, sess_private_data);
699 mrvl_sess = (struct mrvl_crypto_session *)sess_private_data;
700 if (sam_session_create(&mrvl_sess->sam_sess_params,
701 &mrvl_sess->sam_sess) < 0) {
702 MRVL_CRYPTO_LOG_DBG("Failed to create session!");
710 * Clear the memory of session so it doesn't leave key material behind.
712 * @param dev Pointer to the device structure.
713 * @returns 0. Always.
716 mrvl_crypto_pmd_sym_session_clear(struct rte_cryptodev *dev,
717 struct rte_cryptodev_sym_session *sess)
720 uint8_t index = dev->driver_id;
721 void *sess_priv = get_sym_session_private_data(sess, index);
723 /* Zero out the whole structure */
725 struct mrvl_crypto_session *mrvl_sess =
726 (struct mrvl_crypto_session *)sess_priv;
728 if (mrvl_sess->sam_sess &&
729 sam_session_destroy(mrvl_sess->sam_sess) < 0) {
730 MRVL_CRYPTO_LOG_INFO("Error while destroying session!");
733 memset(sess, 0, sizeof(struct mrvl_crypto_session));
734 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
735 set_sym_session_private_data(sess, index, NULL);
736 rte_mempool_put(sess_mp, sess_priv);
741 * PMD handlers for crypto ops.
743 static struct rte_cryptodev_ops mrvl_crypto_pmd_ops = {
744 .dev_configure = mrvl_crypto_pmd_config,
745 .dev_start = mrvl_crypto_pmd_start,
746 .dev_stop = mrvl_crypto_pmd_stop,
747 .dev_close = mrvl_crypto_pmd_close,
749 .dev_infos_get = mrvl_crypto_pmd_info_get,
751 .stats_get = mrvl_crypto_pmd_stats_get,
752 .stats_reset = mrvl_crypto_pmd_stats_reset,
754 .queue_pair_setup = mrvl_crypto_pmd_qp_setup,
755 .queue_pair_release = mrvl_crypto_pmd_qp_release,
756 .queue_pair_count = mrvl_crypto_pmd_qp_count,
758 .sym_session_get_size = mrvl_crypto_pmd_sym_session_get_size,
759 .sym_session_configure = mrvl_crypto_pmd_sym_session_configure,
760 .sym_session_clear = mrvl_crypto_pmd_sym_session_clear
763 struct rte_cryptodev_ops *rte_mrvl_crypto_pmd_ops = &mrvl_crypto_pmd_ops;