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 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
419 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
421 .algo = RTE_CRYPTO_AUTH_NULL,
441 { /* NULL (CIPHER) */
442 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
444 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
446 .algo = RTE_CRYPTO_CIPHER_NULL,
462 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
467 * Configure device (PMD ops callback).
469 * @param dev Pointer to the device structure.
470 * @param config Pointer to configuration structure.
471 * @returns 0. Always.
474 mrvl_crypto_pmd_config(__rte_unused struct rte_cryptodev *dev,
475 __rte_unused struct rte_cryptodev_config *config)
481 * Start device (PMD ops callback).
483 * @param dev Pointer to the device structure.
484 * @returns 0. Always.
487 mrvl_crypto_pmd_start(__rte_unused struct rte_cryptodev *dev)
493 * Stop device (PMD ops callback).
495 * @param dev Pointer to the device structure.
496 * @returns 0. Always.
499 mrvl_crypto_pmd_stop(__rte_unused struct rte_cryptodev *dev)
504 * Get device statistics (PMD ops callback).
506 * @param dev Pointer to the device structure.
507 * @param stats Pointer to statistics structure [out].
510 mrvl_crypto_pmd_stats_get(struct rte_cryptodev *dev,
511 struct rte_cryptodev_stats *stats)
515 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
516 struct mrvl_crypto_qp *qp = dev->data->queue_pairs[qp_id];
518 stats->enqueued_count += qp->stats.enqueued_count;
519 stats->dequeued_count += qp->stats.dequeued_count;
521 stats->enqueue_err_count += qp->stats.enqueue_err_count;
522 stats->dequeue_err_count += qp->stats.dequeue_err_count;
527 * Reset device statistics (PMD ops callback).
529 * @param dev Pointer to the device structure.
532 mrvl_crypto_pmd_stats_reset(struct rte_cryptodev *dev)
536 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
537 struct mrvl_crypto_qp *qp = dev->data->queue_pairs[qp_id];
539 memset(&qp->stats, 0, sizeof(qp->stats));
544 * Get device info (PMD ops callback).
546 * @param dev Pointer to the device structure.
547 * @param dev_info Pointer to the device info structure [out].
550 mrvl_crypto_pmd_info_get(struct rte_cryptodev *dev,
551 struct rte_cryptodev_info *dev_info)
553 struct mrvl_crypto_private *internals = dev->data->dev_private;
555 if (dev_info != NULL) {
556 dev_info->driver_id = dev->driver_id;
557 dev_info->feature_flags = dev->feature_flags;
558 dev_info->capabilities = mrvl_crypto_pmd_capabilities;
559 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
560 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
565 * Release queue pair (PMD ops callback).
567 * @param dev Pointer to the device structure.
568 * @param qp_id ID of Queue Pair to release.
569 * @returns 0. Always.
572 mrvl_crypto_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
574 struct mrvl_crypto_qp *qp =
575 (struct mrvl_crypto_qp *)dev->data->queue_pairs[qp_id];
577 if (dev->data->queue_pairs[qp_id] != NULL) {
578 sam_cio_flush(qp->cio);
579 sam_cio_deinit(qp->cio);
580 rte_free(dev->data->queue_pairs[qp_id]);
581 dev->data->queue_pairs[qp_id] = NULL;
588 * Close device (PMD ops callback).
590 * @param dev Pointer to the device structure.
591 * @returns 0. Always.
594 mrvl_crypto_pmd_close(struct rte_cryptodev *dev)
598 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++)
599 mrvl_crypto_pmd_qp_release(dev, qp_id);
605 * Setup a queue pair (PMD ops callback).
607 * @param dev Pointer to the device structure.
608 * @param qp_id ID of the Queue Pair.
609 * @param qp_conf Queue pair configuration (nb of descriptors).
610 * @param socket_id NUMA socket to allocate memory on.
611 * @returns 0 upon success, negative value otherwise.
614 mrvl_crypto_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
615 const struct rte_cryptodev_qp_conf *qp_conf,
616 int socket_id, struct rte_mempool *session_pool)
618 struct mrvl_crypto_qp *qp = NULL;
619 char match[RTE_CRYPTODEV_NAME_MAX_LEN];
622 /* Allocate the queue pair data structure. */
623 qp = rte_zmalloc_socket("MRVL Crypto PMD Queue Pair", sizeof(*qp),
624 RTE_CACHE_LINE_SIZE, socket_id);
628 /* Free old qp prior setup if needed. */
629 if (dev->data->queue_pairs[qp_id] != NULL)
630 mrvl_crypto_pmd_qp_release(dev, qp_id);
632 do { /* Error handling block */
635 * This extra check is necessary due to a bug in
638 int num = sam_get_num_inst();
640 MRVL_CRYPTO_LOG_ERR("No crypto engines detected.\n");
645 * In case two crypto engines are enabled qps will
646 * be evenly spread among them. Even and odd qps will
647 * be handled by cio-0 and cio-1 respectively. qp-cio mapping
648 * will look as follows:
651 * cio-x:y: cio-0:0, cio-1:0, cio-0:1, cio-1:1
654 * cio-x:y: cio-0:2, cio-1:2, cio-0:3, cio-1:3
656 * In case just one engine is enabled mapping will look as
659 * cio-x:y: cio-0:0, cio-0:1, cio-0:2, cio-0:3
661 n = snprintf(match, sizeof(match), "cio-%u:%u",
662 qp_id % num, qp_id / num);
664 if (n >= sizeof(match))
667 qp->cio_params.match = match;
668 qp->cio_params.size = qp_conf->nb_descriptors;
670 if (sam_cio_init(&qp->cio_params, &qp->cio) < 0)
673 qp->sess_mp = session_pool;
675 memset(&qp->stats, 0, sizeof(qp->stats));
676 dev->data->queue_pairs[qp_id] = qp;
684 /** Return the number of allocated queue pairs (PMD ops callback).
686 * @param dev Pointer to the device structure.
687 * @returns Number of allocated queue pairs.
690 mrvl_crypto_pmd_qp_count(struct rte_cryptodev *dev)
692 return dev->data->nb_queue_pairs;
695 /** Returns the size of the session structure (PMD ops callback).
697 * @param dev Pointer to the device structure [Unused].
698 * @returns Size of Marvell crypto session.
701 mrvl_crypto_pmd_sym_session_get_size(__rte_unused struct rte_cryptodev *dev)
703 return sizeof(struct mrvl_crypto_session);
706 /** Configure the session from a crypto xform chain (PMD ops callback).
708 * @param dev Pointer to the device structure.
709 * @param xform Pointer to the crytpo configuration structure.
710 * @param sess Pointer to the empty session structure.
711 * @returns 0 upon success, negative value otherwise.
714 mrvl_crypto_pmd_sym_session_configure(__rte_unused struct rte_cryptodev *dev,
715 struct rte_crypto_sym_xform *xform,
716 struct rte_cryptodev_sym_session *sess,
717 struct rte_mempool *mp)
719 struct mrvl_crypto_session *mrvl_sess;
720 void *sess_private_data;
724 MRVL_CRYPTO_LOG_ERR("Invalid session struct.");
728 if (rte_mempool_get(mp, &sess_private_data)) {
729 CDEV_LOG_ERR("Couldn't get object from session mempool.");
733 ret = mrvl_crypto_set_session_parameters(sess_private_data, xform);
735 MRVL_CRYPTO_LOG_ERR("Failed to configure session parameters.");
737 /* Return session to mempool */
738 rte_mempool_put(mp, sess_private_data);
742 set_sym_session_private_data(sess, dev->driver_id, sess_private_data);
744 mrvl_sess = (struct mrvl_crypto_session *)sess_private_data;
745 if (sam_session_create(&mrvl_sess->sam_sess_params,
746 &mrvl_sess->sam_sess) < 0) {
747 MRVL_CRYPTO_LOG_DBG("Failed to create session!");
755 * Clear the memory of session so it doesn't leave key material behind.
757 * @param dev Pointer to the device structure.
758 * @returns 0. Always.
761 mrvl_crypto_pmd_sym_session_clear(struct rte_cryptodev *dev,
762 struct rte_cryptodev_sym_session *sess)
765 uint8_t index = dev->driver_id;
766 void *sess_priv = get_sym_session_private_data(sess, index);
768 /* Zero out the whole structure */
770 struct mrvl_crypto_session *mrvl_sess =
771 (struct mrvl_crypto_session *)sess_priv;
773 if (mrvl_sess->sam_sess &&
774 sam_session_destroy(mrvl_sess->sam_sess) < 0) {
775 MRVL_CRYPTO_LOG_INFO("Error while destroying session!");
778 memset(sess, 0, sizeof(struct mrvl_crypto_session));
779 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
780 set_sym_session_private_data(sess, index, NULL);
781 rte_mempool_put(sess_mp, sess_priv);
786 * PMD handlers for crypto ops.
788 static struct rte_cryptodev_ops mrvl_crypto_pmd_ops = {
789 .dev_configure = mrvl_crypto_pmd_config,
790 .dev_start = mrvl_crypto_pmd_start,
791 .dev_stop = mrvl_crypto_pmd_stop,
792 .dev_close = mrvl_crypto_pmd_close,
794 .dev_infos_get = mrvl_crypto_pmd_info_get,
796 .stats_get = mrvl_crypto_pmd_stats_get,
797 .stats_reset = mrvl_crypto_pmd_stats_reset,
799 .queue_pair_setup = mrvl_crypto_pmd_qp_setup,
800 .queue_pair_release = mrvl_crypto_pmd_qp_release,
801 .queue_pair_count = mrvl_crypto_pmd_qp_count,
803 .sym_session_get_size = mrvl_crypto_pmd_sym_session_get_size,
804 .sym_session_configure = mrvl_crypto_pmd_sym_session_configure,
805 .sym_session_clear = mrvl_crypto_pmd_sym_session_clear
808 struct rte_cryptodev_ops *rte_mrvl_crypto_pmd_ops = &mrvl_crypto_pmd_ops;