1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2018 Intel Corporation
5 #include <rte_common.h>
6 #include <rte_hexdump.h>
7 #include <rte_cryptodev.h>
8 #include <rte_cryptodev_pmd.h>
9 #include <rte_bus_vdev.h>
10 #include <rte_malloc.h>
11 #include <rte_cpuflags.h>
13 #include "rte_kasumi_pmd_private.h"
15 #define KASUMI_KEY_LENGTH 16
16 #define KASUMI_IV_LENGTH 8
17 #define KASUMI_MAX_BURST 4
20 static uint8_t cryptodev_driver_id;
22 /** Get xform chain order. */
23 static enum kasumi_operation
24 kasumi_get_mode(const struct rte_crypto_sym_xform *xform)
27 return KASUMI_OP_NOT_SUPPORTED;
30 if (xform->next->next != NULL)
31 return KASUMI_OP_NOT_SUPPORTED;
33 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
34 if (xform->next == NULL)
35 return KASUMI_OP_ONLY_AUTH;
36 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
37 return KASUMI_OP_AUTH_CIPHER;
39 return KASUMI_OP_NOT_SUPPORTED;
42 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
43 if (xform->next == NULL)
44 return KASUMI_OP_ONLY_CIPHER;
45 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
46 return KASUMI_OP_CIPHER_AUTH;
48 return KASUMI_OP_NOT_SUPPORTED;
51 return KASUMI_OP_NOT_SUPPORTED;
55 /** Parse crypto xform chain and set private session parameters. */
57 kasumi_set_session_parameters(struct kasumi_session *sess,
58 const struct rte_crypto_sym_xform *xform)
60 const struct rte_crypto_sym_xform *auth_xform = NULL;
61 const struct rte_crypto_sym_xform *cipher_xform = NULL;
62 enum kasumi_operation mode;
64 /* Select Crypto operation - hash then cipher / cipher then hash */
65 mode = kasumi_get_mode(xform);
68 case KASUMI_OP_CIPHER_AUTH:
69 auth_xform = xform->next;
71 case KASUMI_OP_ONLY_CIPHER:
74 case KASUMI_OP_AUTH_CIPHER:
75 cipher_xform = xform->next;
77 case KASUMI_OP_ONLY_AUTH:
80 case KASUMI_OP_NOT_SUPPORTED:
82 KASUMI_LOG(ERR, "Unsupported operation chain order parameter");
87 /* Only KASUMI F8 supported */
88 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_KASUMI_F8) {
89 KASUMI_LOG(ERR, "Unsupported cipher algorithm ");
93 sess->cipher_iv_offset = cipher_xform->cipher.iv.offset;
94 if (cipher_xform->cipher.iv.length != KASUMI_IV_LENGTH) {
95 KASUMI_LOG(ERR, "Wrong IV length");
100 sso_kasumi_init_f8_key_sched(cipher_xform->cipher.key.data,
101 &sess->pKeySched_cipher);
105 /* Only KASUMI F9 supported */
106 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_KASUMI_F9) {
107 KASUMI_LOG(ERR, "Unsupported authentication");
111 if (auth_xform->auth.digest_length != KASUMI_DIGEST_LENGTH) {
112 KASUMI_LOG(ERR, "Wrong digest length");
116 sess->auth_op = auth_xform->auth.op;
119 sso_kasumi_init_f9_key_sched(auth_xform->auth.key.data,
120 &sess->pKeySched_hash);
129 /** Get KASUMI session. */
130 static struct kasumi_session *
131 kasumi_get_session(struct kasumi_qp *qp, struct rte_crypto_op *op)
133 struct kasumi_session *sess = NULL;
135 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
136 if (likely(op->sym->session != NULL))
137 sess = (struct kasumi_session *)
138 get_sym_session_private_data(
140 cryptodev_driver_id);
143 void *_sess_private_data = NULL;
145 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
148 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
151 sess = (struct kasumi_session *)_sess_private_data;
153 if (unlikely(kasumi_set_session_parameters(sess,
154 op->sym->xform) != 0)) {
155 rte_mempool_put(qp->sess_mp, _sess);
156 rte_mempool_put(qp->sess_mp, _sess_private_data);
159 op->sym->session = (struct rte_cryptodev_sym_session *)_sess;
160 set_sym_session_private_data(op->sym->session,
161 cryptodev_driver_id, _sess_private_data);
164 if (unlikely(sess == NULL))
165 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
170 /** Encrypt/decrypt mbufs with same cipher key. */
172 process_kasumi_cipher_op(struct rte_crypto_op **ops,
173 struct kasumi_session *session,
177 uint8_t processed_ops = 0;
178 uint8_t *src[num_ops], *dst[num_ops];
180 uint64_t iv[num_ops];
181 uint32_t num_bytes[num_ops];
183 for (i = 0; i < num_ops; i++) {
184 src[i] = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
185 (ops[i]->sym->cipher.data.offset >> 3);
186 dst[i] = ops[i]->sym->m_dst ?
187 rte_pktmbuf_mtod(ops[i]->sym->m_dst, uint8_t *) +
188 (ops[i]->sym->cipher.data.offset >> 3) :
189 rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
190 (ops[i]->sym->cipher.data.offset >> 3);
191 iv_ptr = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
192 session->cipher_iv_offset);
193 iv[i] = *((uint64_t *)(iv_ptr));
194 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
199 if (processed_ops != 0)
200 sso_kasumi_f8_n_buffer(&session->pKeySched_cipher, iv,
201 src, dst, num_bytes, processed_ops);
203 return processed_ops;
206 /** Encrypt/decrypt mbuf (bit level function). */
208 process_kasumi_cipher_op_bit(struct rte_crypto_op *op,
209 struct kasumi_session *session)
214 uint32_t length_in_bits, offset_in_bits;
216 offset_in_bits = op->sym->cipher.data.offset;
217 src = rte_pktmbuf_mtod(op->sym->m_src, uint8_t *);
218 if (op->sym->m_dst == NULL) {
219 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
220 KASUMI_LOG(ERR, "bit-level in-place not supported");
223 dst = rte_pktmbuf_mtod(op->sym->m_dst, uint8_t *);
224 iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
225 session->cipher_iv_offset);
226 iv = *((uint64_t *)(iv_ptr));
227 length_in_bits = op->sym->cipher.data.length;
229 sso_kasumi_f8_1_buffer_bit(&session->pKeySched_cipher, iv,
230 src, dst, length_in_bits, offset_in_bits);
235 /** Generate/verify hash from mbufs with same hash key. */
237 process_kasumi_hash_op(struct kasumi_qp *qp, struct rte_crypto_op **ops,
238 struct kasumi_session *session,
242 uint8_t processed_ops = 0;
244 uint32_t length_in_bits;
247 for (i = 0; i < num_ops; i++) {
248 /* Data must be byte aligned */
249 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
250 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
251 KASUMI_LOG(ERR, "Invalid Offset");
255 length_in_bits = ops[i]->sym->auth.data.length;
257 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
258 (ops[i]->sym->auth.data.offset >> 3);
259 /* Direction from next bit after end of message */
260 num_bytes = length_in_bits >> 3;
262 if (session->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
263 dst = qp->temp_digest;
264 sso_kasumi_f9_1_buffer(&session->pKeySched_hash, src,
268 if (memcmp(dst, ops[i]->sym->auth.digest.data,
269 KASUMI_DIGEST_LENGTH) != 0)
270 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
272 dst = ops[i]->sym->auth.digest.data;
274 sso_kasumi_f9_1_buffer(&session->pKeySched_hash, src,
280 return processed_ops;
283 /** Process a batch of crypto ops which shares the same session. */
285 process_ops(struct rte_crypto_op **ops, struct kasumi_session *session,
286 struct kasumi_qp *qp, uint8_t num_ops,
287 uint16_t *accumulated_enqueued_ops)
290 unsigned enqueued_ops, processed_ops;
292 switch (session->op) {
293 case KASUMI_OP_ONLY_CIPHER:
294 processed_ops = process_kasumi_cipher_op(ops,
297 case KASUMI_OP_ONLY_AUTH:
298 processed_ops = process_kasumi_hash_op(qp, ops, session,
301 case KASUMI_OP_CIPHER_AUTH:
302 processed_ops = process_kasumi_cipher_op(ops, session,
304 process_kasumi_hash_op(qp, ops, session, processed_ops);
306 case KASUMI_OP_AUTH_CIPHER:
307 processed_ops = process_kasumi_hash_op(qp, ops, session,
309 process_kasumi_cipher_op(ops, session, processed_ops);
312 /* Operation not supported. */
316 for (i = 0; i < num_ops; i++) {
318 * If there was no error/authentication failure,
319 * change status to successful.
321 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
322 ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
323 /* Free session if a session-less crypto op. */
324 if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
325 memset(session, 0, sizeof(struct kasumi_session));
326 memset(ops[i]->sym->session, 0,
327 rte_cryptodev_sym_get_header_session_size());
328 rte_mempool_put(qp->sess_mp, session);
329 rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
330 ops[i]->sym->session = NULL;
334 enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
335 (void **)ops, processed_ops, NULL);
336 qp->qp_stats.enqueued_count += enqueued_ops;
337 *accumulated_enqueued_ops += enqueued_ops;
342 /** Process a crypto op with length/offset in bits. */
344 process_op_bit(struct rte_crypto_op *op, struct kasumi_session *session,
345 struct kasumi_qp *qp, uint16_t *accumulated_enqueued_ops)
347 unsigned enqueued_op, processed_op;
349 switch (session->op) {
350 case KASUMI_OP_ONLY_CIPHER:
351 processed_op = process_kasumi_cipher_op_bit(op,
354 case KASUMI_OP_ONLY_AUTH:
355 processed_op = process_kasumi_hash_op(qp, &op, session, 1);
357 case KASUMI_OP_CIPHER_AUTH:
358 processed_op = process_kasumi_cipher_op_bit(op, session);
359 if (processed_op == 1)
360 process_kasumi_hash_op(qp, &op, session, 1);
362 case KASUMI_OP_AUTH_CIPHER:
363 processed_op = process_kasumi_hash_op(qp, &op, session, 1);
364 if (processed_op == 1)
365 process_kasumi_cipher_op_bit(op, session);
368 /* Operation not supported. */
373 * If there was no error/authentication failure,
374 * change status to successful.
376 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
377 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
379 /* Free session if a session-less crypto op. */
380 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
381 memset(op->sym->session, 0, sizeof(struct kasumi_session));
382 rte_cryptodev_sym_session_free(op->sym->session);
383 op->sym->session = NULL;
386 enqueued_op = rte_ring_enqueue_burst(qp->processed_ops, (void **)&op,
388 qp->qp_stats.enqueued_count += enqueued_op;
389 *accumulated_enqueued_ops += enqueued_op;
395 kasumi_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
398 struct rte_crypto_op *c_ops[nb_ops];
399 struct rte_crypto_op *curr_c_op;
401 struct kasumi_session *prev_sess = NULL, *curr_sess = NULL;
402 struct kasumi_qp *qp = queue_pair;
404 uint8_t burst_size = 0;
405 uint16_t enqueued_ops = 0;
406 uint8_t processed_ops;
408 for (i = 0; i < nb_ops; i++) {
411 #ifdef RTE_LIBRTE_PMD_KASUMI_DEBUG
412 if (!rte_pktmbuf_is_contiguous(curr_c_op->sym->m_src) ||
413 (curr_c_op->sym->m_dst != NULL &&
414 !rte_pktmbuf_is_contiguous(
415 curr_c_op->sym->m_dst))) {
416 KASUMI_LOG(ERR, "PMD supports only contiguous mbufs, "
417 "op (%p) provides noncontiguous mbuf as "
418 "source/destination buffer.", curr_c_op);
419 curr_c_op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
424 /* Set status as enqueued (not processed yet) by default. */
425 curr_c_op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
427 curr_sess = kasumi_get_session(qp, curr_c_op);
428 if (unlikely(curr_sess == NULL ||
429 curr_sess->op == KASUMI_OP_NOT_SUPPORTED)) {
431 RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
435 /* If length/offset is at bit-level, process this buffer alone. */
436 if (((curr_c_op->sym->cipher.data.length % BYTE_LEN) != 0)
437 || ((ops[i]->sym->cipher.data.offset
439 /* Process the ops of the previous session. */
440 if (prev_sess != NULL) {
441 processed_ops = process_ops(c_ops, prev_sess,
442 qp, burst_size, &enqueued_ops);
443 if (processed_ops < burst_size) {
452 processed_ops = process_op_bit(curr_c_op, curr_sess,
454 if (processed_ops != 1)
460 /* Batch ops that share the same session. */
461 if (prev_sess == NULL) {
462 prev_sess = curr_sess;
463 c_ops[burst_size++] = curr_c_op;
464 } else if (curr_sess == prev_sess) {
465 c_ops[burst_size++] = curr_c_op;
467 * When there are enough ops to process in a batch,
468 * process them, and start a new batch.
470 if (burst_size == KASUMI_MAX_BURST) {
471 processed_ops = process_ops(c_ops, prev_sess,
472 qp, burst_size, &enqueued_ops);
473 if (processed_ops < burst_size) {
483 * Different session, process the ops
484 * of the previous session.
486 processed_ops = process_ops(c_ops, prev_sess,
487 qp, burst_size, &enqueued_ops);
488 if (processed_ops < burst_size) {
494 prev_sess = curr_sess;
496 c_ops[burst_size++] = curr_c_op;
500 if (burst_size != 0) {
501 /* Process the crypto ops of the last session. */
502 processed_ops = process_ops(c_ops, prev_sess,
503 qp, burst_size, &enqueued_ops);
506 qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
511 kasumi_pmd_dequeue_burst(void *queue_pair,
512 struct rte_crypto_op **c_ops, uint16_t nb_ops)
514 struct kasumi_qp *qp = queue_pair;
516 unsigned nb_dequeued;
518 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
519 (void **)c_ops, nb_ops, NULL);
520 qp->qp_stats.dequeued_count += nb_dequeued;
525 static int cryptodev_kasumi_remove(struct rte_vdev_device *vdev);
528 cryptodev_kasumi_create(const char *name,
529 struct rte_vdev_device *vdev,
530 struct rte_cryptodev_pmd_init_params *init_params)
532 struct rte_cryptodev *dev;
533 struct kasumi_private *internals;
534 uint64_t cpu_flags = 0;
536 dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
538 KASUMI_LOG(ERR, "failed to create cryptodev vdev");
542 /* Check CPU for supported vector instruction set */
543 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
544 cpu_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
546 cpu_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
548 dev->driver_id = cryptodev_driver_id;
549 dev->dev_ops = rte_kasumi_pmd_ops;
551 /* Register RX/TX burst functions for data path. */
552 dev->dequeue_burst = kasumi_pmd_dequeue_burst;
553 dev->enqueue_burst = kasumi_pmd_enqueue_burst;
555 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
556 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
559 internals = dev->data->dev_private;
561 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
565 KASUMI_LOG(ERR, "driver %s: failed",
568 cryptodev_kasumi_remove(vdev);
573 cryptodev_kasumi_probe(struct rte_vdev_device *vdev)
575 struct rte_cryptodev_pmd_init_params init_params = {
577 sizeof(struct kasumi_private),
579 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
582 const char *input_args;
584 name = rte_vdev_device_name(vdev);
587 input_args = rte_vdev_device_args(vdev);
589 rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
591 return cryptodev_kasumi_create(name, vdev, &init_params);
595 cryptodev_kasumi_remove(struct rte_vdev_device *vdev)
597 struct rte_cryptodev *cryptodev;
600 name = rte_vdev_device_name(vdev);
604 cryptodev = rte_cryptodev_pmd_get_named_dev(name);
605 if (cryptodev == NULL)
608 return rte_cryptodev_pmd_destroy(cryptodev);
611 static struct rte_vdev_driver cryptodev_kasumi_pmd_drv = {
612 .probe = cryptodev_kasumi_probe,
613 .remove = cryptodev_kasumi_remove
616 static struct cryptodev_driver kasumi_crypto_drv;
618 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_KASUMI_PMD, cryptodev_kasumi_pmd_drv);
619 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_KASUMI_PMD, cryptodev_kasumi_pmd);
620 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_KASUMI_PMD,
621 "max_nb_queue_pairs=<int> "
623 RTE_PMD_REGISTER_CRYPTO_DRIVER(kasumi_crypto_drv,
624 cryptodev_kasumi_pmd_drv.driver, cryptodev_driver_id);
626 RTE_INIT(kasumi_init_log)
628 kasumi_logtype_driver = rte_log_register("pmd.crypto.kasumi");