xref: /dpdk/drivers/crypto/null/null_crypto_pmd.c (revision 2a440d6ab362de705d99c6740b27a3e0755a87f4)
15566a3e3SBruce Richardson /* SPDX-License-Identifier: BSD-3-Clause
25566a3e3SBruce Richardson  * Copyright(c) 2016-2017 Intel Corporation
394b0ad8eSDeclan Doherty  */
494b0ad8eSDeclan Doherty 
594b0ad8eSDeclan Doherty #include <rte_common.h>
6af668035SAkhil Goyal #include <cryptodev_pmd.h>
74851ef2bSDavid Marchand #include <bus_vdev_driver.h>
894b0ad8eSDeclan Doherty #include <rte_malloc.h>
994b0ad8eSDeclan Doherty 
1094b0ad8eSDeclan Doherty #include "null_crypto_pmd_private.h"
1194b0ad8eSDeclan Doherty 
127a364faeSSlawomir Mrozowicz static uint8_t cryptodev_driver_id;
137a364faeSSlawomir Mrozowicz 
1494b0ad8eSDeclan Doherty /** verify and set session parameters */
1594b0ad8eSDeclan Doherty int
null_crypto_set_session_parameters(struct null_crypto_session * sess __rte_unused,const struct rte_crypto_sym_xform * xform)1694b0ad8eSDeclan Doherty null_crypto_set_session_parameters(
1794b0ad8eSDeclan Doherty 		struct null_crypto_session *sess __rte_unused,
1894b0ad8eSDeclan Doherty 		const struct rte_crypto_sym_xform *xform)
1994b0ad8eSDeclan Doherty {
2094b0ad8eSDeclan Doherty 	if (xform == NULL) {
2127391b53SPablo de Lara 		return -EINVAL;
2294b0ad8eSDeclan Doherty 	} else if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
2394b0ad8eSDeclan Doherty 			xform->next == NULL) {
2494b0ad8eSDeclan Doherty 		/* Authentication Only */
2594b0ad8eSDeclan Doherty 		if (xform->auth.algo == RTE_CRYPTO_AUTH_NULL)
2694b0ad8eSDeclan Doherty 			return 0;
2794b0ad8eSDeclan Doherty 	} else if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
2894b0ad8eSDeclan Doherty 			xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
2994b0ad8eSDeclan Doherty 		/* Authentication then Cipher */
3094b0ad8eSDeclan Doherty 		if (xform->auth.algo == RTE_CRYPTO_AUTH_NULL &&
3194b0ad8eSDeclan Doherty 			xform->next->cipher.algo == RTE_CRYPTO_CIPHER_NULL)
3294b0ad8eSDeclan Doherty 			return 0;
3394b0ad8eSDeclan Doherty 	} else if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
3494b0ad8eSDeclan Doherty 			xform->next == NULL) {
3594b0ad8eSDeclan Doherty 		/* Cipher Only */
3694b0ad8eSDeclan Doherty 		if (xform->cipher.algo == RTE_CRYPTO_CIPHER_NULL)
3794b0ad8eSDeclan Doherty 			return 0;
3894b0ad8eSDeclan Doherty 	} else if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
3994b0ad8eSDeclan Doherty 			xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
4094b0ad8eSDeclan Doherty 		/* Cipher then Authentication */
4194b0ad8eSDeclan Doherty 		if (xform->cipher.algo == RTE_CRYPTO_CIPHER_NULL &&
4294b0ad8eSDeclan Doherty 			xform->next->auth.algo == RTE_CRYPTO_AUTH_NULL)
4394b0ad8eSDeclan Doherty 			return 0;
4494b0ad8eSDeclan Doherty 	}
4594b0ad8eSDeclan Doherty 
4627391b53SPablo de Lara 	return -ENOTSUP;
4794b0ad8eSDeclan Doherty }
4894b0ad8eSDeclan Doherty 
4994b0ad8eSDeclan Doherty /** Process crypto operation for mbuf */
5094b0ad8eSDeclan Doherty static int
process_op(const struct null_crypto_qp * qp,struct rte_crypto_op * op,struct null_crypto_session * sess __rte_unused)5194b0ad8eSDeclan Doherty process_op(const struct null_crypto_qp *qp, struct rte_crypto_op *op,
5294b0ad8eSDeclan Doherty 		struct null_crypto_session *sess __rte_unused)
5394b0ad8eSDeclan Doherty {
5494b0ad8eSDeclan Doherty 	/* set status as successful by default */
5594b0ad8eSDeclan Doherty 	op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
5694b0ad8eSDeclan Doherty 
57b3bbd9e5SSlawomir Mrozowicz 	/* Free session if a session-less crypto op. */
58b3bbd9e5SSlawomir Mrozowicz 	if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
59b3bbd9e5SSlawomir Mrozowicz 		memset(op->sym->session, 0,
60b3bbd9e5SSlawomir Mrozowicz 				sizeof(struct null_crypto_session));
61bdce2564SAkhil Goyal 		rte_mempool_put(qp->sess_mp, (void *)op->sym->session);
62b3bbd9e5SSlawomir Mrozowicz 		op->sym->session = NULL;
63b3bbd9e5SSlawomir Mrozowicz 	}
64b3bbd9e5SSlawomir Mrozowicz 
6594b0ad8eSDeclan Doherty 	/*
6694b0ad8eSDeclan Doherty 	 * if crypto session and operation are valid just enqueue the packet
6794b0ad8eSDeclan Doherty 	 * in the processed ring
6894b0ad8eSDeclan Doherty 	 */
6994b0ad8eSDeclan Doherty 	return rte_ring_enqueue(qp->processed_pkts, (void *)op);
7094b0ad8eSDeclan Doherty }
7194b0ad8eSDeclan Doherty 
7294b0ad8eSDeclan Doherty static struct null_crypto_session *
get_session(struct null_crypto_qp * qp,struct rte_crypto_op * op)735209df0dSPablo de Lara get_session(struct null_crypto_qp *qp, struct rte_crypto_op *op)
7494b0ad8eSDeclan Doherty {
75b3bbd9e5SSlawomir Mrozowicz 	struct null_crypto_session *sess = NULL;
765209df0dSPablo de Lara 	struct rte_crypto_sym_op *sym_op = op->sym;
7794b0ad8eSDeclan Doherty 
785209df0dSPablo de Lara 	if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
79b3bbd9e5SSlawomir Mrozowicz 		if (likely(sym_op->session != NULL))
80*2a440d6aSAkhil Goyal 			sess = CRYPTODEV_GET_SYM_SESS_PRIV(sym_op->session);
8194b0ad8eSDeclan Doherty 	} else {
82bdce2564SAkhil Goyal 		struct rte_cryptodev_sym_session *_sess = NULL;
8394b0ad8eSDeclan Doherty 
84b3bbd9e5SSlawomir Mrozowicz 		if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
8594b0ad8eSDeclan Doherty 			return NULL;
8694b0ad8eSDeclan Doherty 
87bdce2564SAkhil Goyal 		sess = (struct null_crypto_session *)_sess->driver_priv_data;
88b3bbd9e5SSlawomir Mrozowicz 
89b3bbd9e5SSlawomir Mrozowicz 		if (unlikely(null_crypto_set_session_parameters(sess,
90b3bbd9e5SSlawomir Mrozowicz 				sym_op->xform) != 0)) {
91b3bbd9e5SSlawomir Mrozowicz 			rte_mempool_put(qp->sess_mp, _sess);
92b3bbd9e5SSlawomir Mrozowicz 			sess = NULL;
93b3bbd9e5SSlawomir Mrozowicz 		}
94bdce2564SAkhil Goyal 		sym_op->session = _sess;
9594b0ad8eSDeclan Doherty 	}
9694b0ad8eSDeclan Doherty 
9794b0ad8eSDeclan Doherty 	return sess;
9894b0ad8eSDeclan Doherty }
9994b0ad8eSDeclan Doherty 
10094b0ad8eSDeclan Doherty /** Enqueue burst */
10194b0ad8eSDeclan Doherty static uint16_t
null_crypto_pmd_enqueue_burst(void * queue_pair,struct rte_crypto_op ** ops,uint16_t nb_ops)10294b0ad8eSDeclan Doherty null_crypto_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
10394b0ad8eSDeclan Doherty 		uint16_t nb_ops)
10494b0ad8eSDeclan Doherty {
10594b0ad8eSDeclan Doherty 	struct null_crypto_session *sess;
10694b0ad8eSDeclan Doherty 	struct null_crypto_qp *qp = queue_pair;
10794b0ad8eSDeclan Doherty 
10894b0ad8eSDeclan Doherty 	int i, retval;
10994b0ad8eSDeclan Doherty 
11094b0ad8eSDeclan Doherty 	for (i = 0; i < nb_ops; i++) {
1115209df0dSPablo de Lara 		sess = get_session(qp, ops[i]);
11294b0ad8eSDeclan Doherty 		if (unlikely(sess == NULL))
11394b0ad8eSDeclan Doherty 			goto enqueue_err;
11494b0ad8eSDeclan Doherty 
11594b0ad8eSDeclan Doherty 		retval = process_op(qp, ops[i], sess);
11694b0ad8eSDeclan Doherty 		if (unlikely(retval < 0))
11794b0ad8eSDeclan Doherty 			goto enqueue_err;
11894b0ad8eSDeclan Doherty 	}
11994b0ad8eSDeclan Doherty 
12094b0ad8eSDeclan Doherty 	qp->qp_stats.enqueued_count += i;
12194b0ad8eSDeclan Doherty 	return i;
12294b0ad8eSDeclan Doherty 
12394b0ad8eSDeclan Doherty enqueue_err:
12494b0ad8eSDeclan Doherty 	if (ops[i])
12594b0ad8eSDeclan Doherty 		ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
12694b0ad8eSDeclan Doherty 
12794b0ad8eSDeclan Doherty 	qp->qp_stats.enqueue_err_count++;
12894b0ad8eSDeclan Doherty 	return i;
12994b0ad8eSDeclan Doherty }
13094b0ad8eSDeclan Doherty 
13194b0ad8eSDeclan Doherty /** Dequeue burst */
13294b0ad8eSDeclan Doherty static uint16_t
null_crypto_pmd_dequeue_burst(void * queue_pair,struct rte_crypto_op ** ops,uint16_t nb_ops)13394b0ad8eSDeclan Doherty null_crypto_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
13494b0ad8eSDeclan Doherty 		uint16_t nb_ops)
13594b0ad8eSDeclan Doherty {
13694b0ad8eSDeclan Doherty 	struct null_crypto_qp *qp = queue_pair;
13794b0ad8eSDeclan Doherty 
13894b0ad8eSDeclan Doherty 	unsigned nb_dequeued;
13994b0ad8eSDeclan Doherty 
14094b0ad8eSDeclan Doherty 	nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
141ecaed092SBruce Richardson 			(void **)ops, nb_ops, NULL);
14294b0ad8eSDeclan Doherty 	qp->qp_stats.dequeued_count += nb_dequeued;
14394b0ad8eSDeclan Doherty 
14494b0ad8eSDeclan Doherty 	return nb_dequeued;
14594b0ad8eSDeclan Doherty }
14694b0ad8eSDeclan Doherty 
14794b0ad8eSDeclan Doherty /** Create crypto device */
14894b0ad8eSDeclan Doherty static int
cryptodev_null_create(const char * name,struct rte_vdev_device * vdev,struct rte_cryptodev_pmd_init_params * init_params)149168b9e76SPablo de Lara cryptodev_null_create(const char *name,
150917ac9c4SPablo de Lara 		struct rte_vdev_device *vdev,
151f2f020d2SDeclan Doherty 		struct rte_cryptodev_pmd_init_params *init_params)
15294b0ad8eSDeclan Doherty {
15394b0ad8eSDeclan Doherty 	struct rte_cryptodev *dev;
15494b0ad8eSDeclan Doherty 	struct null_crypto_private *internals;
155f2f020d2SDeclan Doherty 	dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
15694b0ad8eSDeclan Doherty 	if (dev == NULL) {
157735b783dSPallantla Poornima 		NULL_LOG(ERR, "failed to create cryptodev vdev");
158f2f020d2SDeclan Doherty 		return -EFAULT;
15994b0ad8eSDeclan Doherty 	}
16094b0ad8eSDeclan Doherty 
1617a364faeSSlawomir Mrozowicz 	dev->driver_id = cryptodev_driver_id;
16294b0ad8eSDeclan Doherty 	dev->dev_ops = null_crypto_pmd_ops;
16394b0ad8eSDeclan Doherty 
16494b0ad8eSDeclan Doherty 	/* register rx/tx burst functions for data path */
16594b0ad8eSDeclan Doherty 	dev->dequeue_burst = null_crypto_pmd_dequeue_burst;
16694b0ad8eSDeclan Doherty 	dev->enqueue_burst = null_crypto_pmd_enqueue_burst;
16794b0ad8eSDeclan Doherty 
16826c2e4adSDeclan Doherty 	dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
1692d03ec6aSTomasz Kulasek 			RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
170b3aaf24dSPablo de Lara 			RTE_CRYPTODEV_FF_IN_PLACE_SGL |
171b3aaf24dSPablo de Lara 			RTE_CRYPTODEV_FF_SYM_SESSIONLESS;
17226c2e4adSDeclan Doherty 
17394b0ad8eSDeclan Doherty 	internals = dev->data->dev_private;
17494b0ad8eSDeclan Doherty 
17594b0ad8eSDeclan Doherty 	internals->max_nb_qpairs = init_params->max_nb_queue_pairs;
17694b0ad8eSDeclan Doherty 
177d54c72ecSAkhil Goyal 	rte_cryptodev_pmd_probing_finish(dev);
178d54c72ecSAkhil Goyal 
17994b0ad8eSDeclan Doherty 	return 0;
18094b0ad8eSDeclan Doherty }
18194b0ad8eSDeclan Doherty 
18294b0ad8eSDeclan Doherty /** Initialise null crypto device */
18394b0ad8eSDeclan Doherty static int
cryptodev_null_probe(struct rte_vdev_device * dev)1845d2aa461SJan Blunck cryptodev_null_probe(struct rte_vdev_device *dev)
18594b0ad8eSDeclan Doherty {
186f2f020d2SDeclan Doherty 	struct rte_cryptodev_pmd_init_params init_params = {
187f2f020d2SDeclan Doherty 		"",
188f2f020d2SDeclan Doherty 		sizeof(struct null_crypto_private),
189d803b443SFan Zhang 		rte_socket_id(),
190e1fc5b76SPablo de Lara 		RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
19194b0ad8eSDeclan Doherty 	};
192f2f020d2SDeclan Doherty 	const char *name, *args;
193f2f020d2SDeclan Doherty 	int retval;
19494b0ad8eSDeclan Doherty 
1957e214771SPablo de Lara 	name = rte_vdev_device_name(dev);
1967e214771SPablo de Lara 	if (name == NULL)
1977e214771SPablo de Lara 		return -EINVAL;
19894b0ad8eSDeclan Doherty 
199f2f020d2SDeclan Doherty 	args = rte_vdev_device_args(dev);
200f2f020d2SDeclan Doherty 
201f2f020d2SDeclan Doherty 	retval = rte_cryptodev_pmd_parse_input_args(&init_params, args);
202f2f020d2SDeclan Doherty 	if (retval) {
203735b783dSPallantla Poornima 		NULL_LOG(ERR,
204735b783dSPallantla Poornima 				"Failed to parse initialisation arguments[%s]",
205735b783dSPallantla Poornima 				args);
206f2f020d2SDeclan Doherty 		return -EINVAL;
207f2f020d2SDeclan Doherty 	}
20894b0ad8eSDeclan Doherty 
209917ac9c4SPablo de Lara 	return cryptodev_null_create(name, dev, &init_params);
21094b0ad8eSDeclan Doherty }
21194b0ad8eSDeclan Doherty 
21294b0ad8eSDeclan Doherty static int
cryptodev_null_remove_dev(struct rte_vdev_device * vdev)213f2f020d2SDeclan Doherty cryptodev_null_remove_dev(struct rte_vdev_device *vdev)
21494b0ad8eSDeclan Doherty {
215f2f020d2SDeclan Doherty 	struct rte_cryptodev *cryptodev;
216f2f020d2SDeclan Doherty 	const char *name;
217f2f020d2SDeclan Doherty 
218f2f020d2SDeclan Doherty 	name = rte_vdev_device_name(vdev);
21994b0ad8eSDeclan Doherty 	if (name == NULL)
22094b0ad8eSDeclan Doherty 		return -EINVAL;
22194b0ad8eSDeclan Doherty 
222f2f020d2SDeclan Doherty 	cryptodev = rte_cryptodev_pmd_get_named_dev(name);
223f2f020d2SDeclan Doherty 	if (cryptodev == NULL)
224f2f020d2SDeclan Doherty 		return -ENODEV;
22594b0ad8eSDeclan Doherty 
226f2f020d2SDeclan Doherty 	return rte_cryptodev_pmd_destroy(cryptodev);
2275d2aa461SJan Blunck }
2285d2aa461SJan Blunck 
229fe363dd4SJan Viktorin static struct rte_vdev_driver cryptodev_null_pmd_drv = {
23050a3345fSShreyansh Jain 	.probe = cryptodev_null_probe,
2315d2aa461SJan Blunck 	.remove = cryptodev_null_remove_dev,
23294b0ad8eSDeclan Doherty };
23394b0ad8eSDeclan Doherty 
234effd3b9fSPablo de Lara static struct cryptodev_driver null_crypto_drv;
235effd3b9fSPablo de Lara 
23601f19227SShreyansh Jain RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_NULL_PMD, cryptodev_null_pmd_drv);
237479c4af3SJan Blunck RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_NULL_PMD, cryptodev_null_pmd);
23801f19227SShreyansh Jain RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_NULL_PMD,
23965eca099SPablo de Lara 	"max_nb_queue_pairs=<int> "
24065eca099SPablo de Lara 	"socket_id=<int>");
241f737f5ceSFiona Trahe RTE_PMD_REGISTER_CRYPTO_DRIVER(null_crypto_drv, cryptodev_null_pmd_drv.driver,
242effd3b9fSPablo de Lara 		cryptodev_driver_id);
243eeded204SDavid Marchand RTE_LOG_REGISTER_DEFAULT(null_logtype_driver, INFO);
244