4 * Copyright (C) Cavium networks Ltd. 2017.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Cavium networks nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <rte_common.h>
36 #include <rte_hexdump.h>
37 #include <rte_cryptodev.h>
38 #include <rte_cryptodev_pmd.h>
39 #include <rte_cryptodev_vdev.h>
41 #include <rte_malloc.h>
42 #include <rte_cpuflags.h>
44 #include "armv8_crypto_defs.h"
46 #include "rte_armv8_pmd_private.h"
48 static uint8_t cryptodev_driver_id;
50 static int cryptodev_armv8_crypto_uninit(struct rte_vdev_device *vdev);
53 * Pointers to the supported combined mode crypto functions are stored
54 * in the static tables. Each combined (chained) cryptographic operation
55 * can be described by a set of numbers:
56 * - order: order of operations (cipher, auth) or (auth, cipher)
57 * - direction: encryption or decryption
58 * - calg: cipher algorithm such as AES_CBC, AES_CTR, etc.
59 * - aalg: authentication algorithm such as SHA1, SHA256, etc.
60 * - keyl: cipher key length, for example 128, 192, 256 bits
62 * In order to quickly acquire each function pointer based on those numbers,
63 * a hierarchy of arrays is maintained. The final level, 3D array is indexed
64 * by the combined mode function parameters only (cipher algorithm,
65 * authentication algorithm and key length).
67 * This gives 3 memory accesses to obtain a function pointer instead of
68 * traversing the array manually and comparing function parameters on each loop.
82 * 3D array type for ARM Combined Mode crypto functions pointers.
83 * CRYPTO_CIPHER_MAX: max cipher ID number
84 * CRYPTO_AUTH_MAX: max auth ID number
85 * CRYPTO_CIPHER_KEYLEN_MAX: max key length ID number
87 typedef const crypto_func_t
88 crypto_func_tbl_t[CRYPTO_CIPHER_MAX][CRYPTO_AUTH_MAX][CRYPTO_CIPHER_KEYLEN_MAX];
90 /* Evaluate to key length definition */
91 #define KEYL(keyl) (ARMV8_CRYPTO_CIPHER_KEYLEN_ ## keyl)
93 /* Local aliases for supported ciphers */
94 #define CIPH_AES_CBC RTE_CRYPTO_CIPHER_AES_CBC
95 /* Local aliases for supported hashes */
96 #define AUTH_SHA1_HMAC RTE_CRYPTO_AUTH_SHA1_HMAC
97 #define AUTH_SHA256_HMAC RTE_CRYPTO_AUTH_SHA256_HMAC
100 * Arrays containing pointers to particular cryptographic,
101 * combined mode functions.
102 * crypto_op_ca_encrypt: cipher (encrypt), authenticate
103 * crypto_op_ca_decrypt: cipher (decrypt), authenticate
104 * crypto_op_ac_encrypt: authenticate, cipher (encrypt)
105 * crypto_op_ac_decrypt: authenticate, cipher (decrypt)
107 static const crypto_func_tbl_t
108 crypto_op_ca_encrypt = {
109 /* [cipher alg][auth alg][key length] = crypto_function, */
110 [CIPH_AES_CBC][AUTH_SHA1_HMAC][KEYL(128)] = aes128cbc_sha1_hmac,
111 [CIPH_AES_CBC][AUTH_SHA256_HMAC][KEYL(128)] = aes128cbc_sha256_hmac,
114 static const crypto_func_tbl_t
115 crypto_op_ca_decrypt = {
119 static const crypto_func_tbl_t
120 crypto_op_ac_encrypt = {
124 static const crypto_func_tbl_t
125 crypto_op_ac_decrypt = {
126 /* [cipher alg][auth alg][key length] = crypto_function, */
127 [CIPH_AES_CBC][AUTH_SHA1_HMAC][KEYL(128)] = sha1_hmac_aes128cbc_dec,
128 [CIPH_AES_CBC][AUTH_SHA256_HMAC][KEYL(128)] = sha256_hmac_aes128cbc_dec,
132 * Arrays containing pointers to particular cryptographic function sets,
133 * covering given cipher operation directions (encrypt, decrypt)
134 * for each order of cipher and authentication pairs.
136 static const crypto_func_tbl_t *
137 crypto_cipher_auth[] = {
138 &crypto_op_ca_encrypt,
139 &crypto_op_ca_decrypt,
143 static const crypto_func_tbl_t *
144 crypto_auth_cipher[] = {
145 &crypto_op_ac_encrypt,
146 &crypto_op_ac_decrypt,
151 * Top level array containing pointers to particular cryptographic
152 * function sets, covering given order of chained operations.
153 * crypto_cipher_auth: cipher first, authenticate after
154 * crypto_auth_cipher: authenticate first, cipher after
156 static const crypto_func_tbl_t **
157 crypto_chain_order[] = {
164 * Extract particular combined mode crypto function from the 3D array.
166 #define CRYPTO_GET_ALGO(order, cop, calg, aalg, keyl) \
168 crypto_func_tbl_t *func_tbl = \
169 (crypto_chain_order[(order)])[(cop)]; \
171 ((*func_tbl)[(calg)][(aalg)][KEYL(keyl)]); \
174 /*----------------------------------------------------------------------------*/
177 * 2D array type for ARM key schedule functions pointers.
178 * CRYPTO_CIPHER_MAX: max cipher ID number
179 * CRYPTO_CIPHER_KEYLEN_MAX: max key length ID number
181 typedef const crypto_key_sched_t
182 crypto_key_sched_tbl_t[CRYPTO_CIPHER_MAX][CRYPTO_CIPHER_KEYLEN_MAX];
184 static const crypto_key_sched_tbl_t
185 crypto_key_sched_encrypt = {
186 /* [cipher alg][key length] = key_expand_func, */
187 [CIPH_AES_CBC][KEYL(128)] = aes128_key_sched_enc,
190 static const crypto_key_sched_tbl_t
191 crypto_key_sched_decrypt = {
192 /* [cipher alg][key length] = key_expand_func, */
193 [CIPH_AES_CBC][KEYL(128)] = aes128_key_sched_dec,
197 * Top level array containing pointers to particular key generation
198 * function sets, covering given operation direction.
199 * crypto_key_sched_encrypt: keys for encryption
200 * crypto_key_sched_decrypt: keys for decryption
202 static const crypto_key_sched_tbl_t *
203 crypto_key_sched_dir[] = {
204 &crypto_key_sched_encrypt,
205 &crypto_key_sched_decrypt,
210 * Extract particular combined mode crypto function from the 3D array.
212 #define CRYPTO_GET_KEY_SCHED(cop, calg, keyl) \
214 crypto_key_sched_tbl_t *ks_tbl = crypto_key_sched_dir[(cop)]; \
216 ((*ks_tbl)[(calg)][KEYL(keyl)]); \
219 /*----------------------------------------------------------------------------*/
222 *------------------------------------------------------------------------------
224 *------------------------------------------------------------------------------
227 /** Get xform chain order */
228 static enum armv8_crypto_chain_order
229 armv8_crypto_get_chain_order(const struct rte_crypto_sym_xform *xform)
233 * This driver currently covers only chained operations.
234 * Ignore only cipher or only authentication operations
235 * or chains longer than 2 xform structures.
237 if (xform->next == NULL || xform->next->next != NULL)
238 return ARMV8_CRYPTO_CHAIN_NOT_SUPPORTED;
240 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
241 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
242 return ARMV8_CRYPTO_CHAIN_AUTH_CIPHER;
245 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
246 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
247 return ARMV8_CRYPTO_CHAIN_CIPHER_AUTH;
250 return ARMV8_CRYPTO_CHAIN_NOT_SUPPORTED;
254 auth_hmac_pad_prepare(struct armv8_crypto_session *sess,
255 const struct rte_crypto_sym_xform *xform)
259 /* Generate i_key_pad and o_key_pad */
260 memset(sess->auth.hmac.i_key_pad, 0, sizeof(sess->auth.hmac.i_key_pad));
261 rte_memcpy(sess->auth.hmac.i_key_pad, sess->auth.hmac.key,
262 xform->auth.key.length);
263 memset(sess->auth.hmac.o_key_pad, 0, sizeof(sess->auth.hmac.o_key_pad));
264 rte_memcpy(sess->auth.hmac.o_key_pad, sess->auth.hmac.key,
265 xform->auth.key.length);
267 * XOR key with IPAD/OPAD values to obtain i_key_pad
269 * Byte-by-byte operation may seem to be the less efficient
270 * here but in fact it's the opposite.
271 * The result ASM code is likely operate on NEON registers
272 * (load auth key to Qx, load IPAD/OPAD to multiple
273 * elements of Qy, eor 128 bits at once).
275 for (i = 0; i < SHA_BLOCK_MAX; i++) {
276 sess->auth.hmac.i_key_pad[i] ^= HMAC_IPAD_VALUE;
277 sess->auth.hmac.o_key_pad[i] ^= HMAC_OPAD_VALUE;
282 auth_set_prerequisites(struct armv8_crypto_session *sess,
283 const struct rte_crypto_sym_xform *xform)
285 uint8_t partial[64] = { 0 };
288 switch (xform->auth.algo) {
289 case RTE_CRYPTO_AUTH_SHA1_HMAC:
291 * Generate authentication key, i_key_pad and o_key_pad.
293 /* Zero memory under key */
294 memset(sess->auth.hmac.key, 0, SHA1_AUTH_KEY_LENGTH);
296 if (xform->auth.key.length > SHA1_AUTH_KEY_LENGTH) {
298 * In case the key is longer than 160 bits
299 * the algorithm will use SHA1(key) instead.
301 error = sha1_block(NULL, xform->auth.key.data,
302 sess->auth.hmac.key, xform->auth.key.length);
307 * Now copy the given authentication key to the session
308 * key assuming that the session key is zeroed there is
309 * no need for additional zero padding if the key is
310 * shorter than SHA1_AUTH_KEY_LENGTH.
312 rte_memcpy(sess->auth.hmac.key, xform->auth.key.data,
313 xform->auth.key.length);
316 /* Prepare HMAC padding: key|pattern */
317 auth_hmac_pad_prepare(sess, xform);
319 * Calculate partial hash values for i_key_pad and o_key_pad.
320 * Will be used as initialization state for final HMAC.
322 error = sha1_block_partial(NULL, sess->auth.hmac.i_key_pad,
323 partial, SHA1_BLOCK_SIZE);
326 memcpy(sess->auth.hmac.i_key_pad, partial, SHA1_BLOCK_SIZE);
328 error = sha1_block_partial(NULL, sess->auth.hmac.o_key_pad,
329 partial, SHA1_BLOCK_SIZE);
332 memcpy(sess->auth.hmac.o_key_pad, partial, SHA1_BLOCK_SIZE);
335 case RTE_CRYPTO_AUTH_SHA256_HMAC:
337 * Generate authentication key, i_key_pad and o_key_pad.
339 /* Zero memory under key */
340 memset(sess->auth.hmac.key, 0, SHA256_AUTH_KEY_LENGTH);
342 if (xform->auth.key.length > SHA256_AUTH_KEY_LENGTH) {
344 * In case the key is longer than 256 bits
345 * the algorithm will use SHA256(key) instead.
347 error = sha256_block(NULL, xform->auth.key.data,
348 sess->auth.hmac.key, xform->auth.key.length);
353 * Now copy the given authentication key to the session
354 * key assuming that the session key is zeroed there is
355 * no need for additional zero padding if the key is
356 * shorter than SHA256_AUTH_KEY_LENGTH.
358 rte_memcpy(sess->auth.hmac.key, xform->auth.key.data,
359 xform->auth.key.length);
362 /* Prepare HMAC padding: key|pattern */
363 auth_hmac_pad_prepare(sess, xform);
365 * Calculate partial hash values for i_key_pad and o_key_pad.
366 * Will be used as initialization state for final HMAC.
368 error = sha256_block_partial(NULL, sess->auth.hmac.i_key_pad,
369 partial, SHA256_BLOCK_SIZE);
372 memcpy(sess->auth.hmac.i_key_pad, partial, SHA256_BLOCK_SIZE);
374 error = sha256_block_partial(NULL, sess->auth.hmac.o_key_pad,
375 partial, SHA256_BLOCK_SIZE);
378 memcpy(sess->auth.hmac.o_key_pad, partial, SHA256_BLOCK_SIZE);
389 cipher_set_prerequisites(struct armv8_crypto_session *sess,
390 const struct rte_crypto_sym_xform *xform)
392 crypto_key_sched_t cipher_key_sched;
394 cipher_key_sched = sess->cipher.key_sched;
395 if (likely(cipher_key_sched != NULL)) {
396 /* Set up cipher session key */
397 cipher_key_sched(sess->cipher.key.data, xform->cipher.key.data);
404 armv8_crypto_set_session_chained_parameters(struct armv8_crypto_session *sess,
405 const struct rte_crypto_sym_xform *cipher_xform,
406 const struct rte_crypto_sym_xform *auth_xform)
408 enum armv8_crypto_chain_order order;
409 enum armv8_crypto_cipher_operation cop;
410 enum rte_crypto_cipher_algorithm calg;
411 enum rte_crypto_auth_algorithm aalg;
413 /* Validate and prepare scratch order of combined operations */
414 switch (sess->chain_order) {
415 case ARMV8_CRYPTO_CHAIN_CIPHER_AUTH:
416 case ARMV8_CRYPTO_CHAIN_AUTH_CIPHER:
417 order = sess->chain_order;
422 /* Select cipher direction */
423 sess->cipher.direction = cipher_xform->cipher.op;
424 /* Select cipher key */
425 sess->cipher.key.length = cipher_xform->cipher.key.length;
426 /* Set cipher direction */
427 cop = sess->cipher.direction;
428 /* Set cipher algorithm */
429 calg = cipher_xform->cipher.algo;
431 /* Select cipher algo */
433 /* Cover supported cipher algorithms */
434 case RTE_CRYPTO_CIPHER_AES_CBC:
435 sess->cipher.algo = calg;
436 /* IV len is always 16 bytes (block size) for AES CBC */
437 sess->cipher.iv.length = 16;
442 /* Select auth generate/verify */
443 sess->auth.operation = auth_xform->auth.op;
445 /* Select auth algo */
446 switch (auth_xform->auth.algo) {
447 /* Cover supported hash algorithms */
448 case RTE_CRYPTO_AUTH_SHA1_HMAC:
449 case RTE_CRYPTO_AUTH_SHA256_HMAC: /* Fall through */
450 aalg = auth_xform->auth.algo;
451 sess->auth.mode = ARMV8_CRYPTO_AUTH_AS_HMAC;
457 /* Set the digest length */
458 sess->auth.digest_length = auth_xform->auth.digest_length;
460 /* Verify supported key lengths and extract proper algorithm */
461 switch (cipher_xform->cipher.key.length << 3) {
464 CRYPTO_GET_ALGO(order, cop, calg, aalg, 128);
465 sess->cipher.key_sched =
466 CRYPTO_GET_KEY_SCHED(cop, calg, 128);
470 /* These key lengths are not supported yet */
471 default: /* Fall through */
472 sess->crypto_func = NULL;
473 sess->cipher.key_sched = NULL;
477 if (unlikely(sess->crypto_func == NULL)) {
479 * If we got here that means that there must be a bug
480 * in the algorithms selection above. Nevertheless keep
481 * it here to catch bug immediately and avoid NULL pointer
482 * dereference in OPs processing.
484 ARMV8_CRYPTO_LOG_ERR(
485 "No appropriate crypto function for given parameters");
489 /* Set up cipher session prerequisites */
490 if (cipher_set_prerequisites(sess, cipher_xform) != 0)
493 /* Set up authentication session prerequisites */
494 if (auth_set_prerequisites(sess, auth_xform) != 0)
500 /** Parse crypto xform chain and set private session parameters */
502 armv8_crypto_set_session_parameters(struct armv8_crypto_session *sess,
503 const struct rte_crypto_sym_xform *xform)
505 const struct rte_crypto_sym_xform *cipher_xform = NULL;
506 const struct rte_crypto_sym_xform *auth_xform = NULL;
510 /* Filter out spurious/broken requests */
514 sess->chain_order = armv8_crypto_get_chain_order(xform);
515 switch (sess->chain_order) {
516 case ARMV8_CRYPTO_CHAIN_CIPHER_AUTH:
517 cipher_xform = xform;
518 auth_xform = xform->next;
519 is_chained_op = true;
521 case ARMV8_CRYPTO_CHAIN_AUTH_CIPHER:
523 cipher_xform = xform->next;
524 is_chained_op = true;
527 is_chained_op = false;
532 sess->cipher.iv.offset = cipher_xform->cipher.iv.offset;
535 ret = armv8_crypto_set_session_chained_parameters(sess,
536 cipher_xform, auth_xform);
537 if (unlikely(ret != 0)) {
538 ARMV8_CRYPTO_LOG_ERR(
539 "Invalid/unsupported chained (cipher/auth) parameters");
543 ARMV8_CRYPTO_LOG_ERR("Invalid/unsupported operation");
550 /** Provide session for operation */
551 static inline struct armv8_crypto_session *
552 get_session(struct armv8_crypto_qp *qp, struct rte_crypto_op *op)
554 struct armv8_crypto_session *sess = NULL;
556 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
557 /* get existing session */
558 if (likely(op->sym->session != NULL &&
559 op->sym->session->driver_id ==
560 cryptodev_driver_id)) {
561 sess = (struct armv8_crypto_session *)
562 op->sym->session->_private;
565 /* provide internal session */
568 if (!rte_mempool_get(qp->sess_mp, (void **)&_sess)) {
569 sess = (struct armv8_crypto_session *)
570 ((struct rte_cryptodev_sym_session *)_sess)
573 if (unlikely(armv8_crypto_set_session_parameters(
574 sess, op->sym->xform) != 0)) {
575 rte_mempool_put(qp->sess_mp, _sess);
578 op->sym->session = _sess;
582 if (unlikely(sess == NULL))
583 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
589 *------------------------------------------------------------------------------
591 *------------------------------------------------------------------------------
594 /*----------------------------------------------------------------------------*/
596 /** Process cipher operation */
598 process_armv8_chained_op
599 (struct rte_crypto_op *op, struct armv8_crypto_session *sess,
600 struct rte_mbuf *mbuf_src, struct rte_mbuf *mbuf_dst)
602 crypto_func_t crypto_func;
604 struct rte_mbuf *m_asrc, *m_adst;
605 uint8_t *csrc, *cdst;
606 uint8_t *adst, *asrc;
610 clen = op->sym->cipher.data.length;
611 alen = op->sym->auth.data.length;
613 csrc = rte_pktmbuf_mtod_offset(mbuf_src, uint8_t *,
614 op->sym->cipher.data.offset);
615 cdst = rte_pktmbuf_mtod_offset(mbuf_dst, uint8_t *,
616 op->sym->cipher.data.offset);
618 switch (sess->chain_order) {
619 case ARMV8_CRYPTO_CHAIN_CIPHER_AUTH:
620 m_asrc = m_adst = mbuf_dst;
622 case ARMV8_CRYPTO_CHAIN_AUTH_CIPHER:
627 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
630 asrc = rte_pktmbuf_mtod_offset(m_asrc, uint8_t *,
631 op->sym->auth.data.offset);
633 switch (sess->auth.mode) {
634 case ARMV8_CRYPTO_AUTH_AS_AUTH:
635 /* Nothing to do here, just verify correct option */
637 case ARMV8_CRYPTO_AUTH_AS_HMAC:
638 arg.digest.hmac.key = sess->auth.hmac.key;
639 arg.digest.hmac.i_key_pad = sess->auth.hmac.i_key_pad;
640 arg.digest.hmac.o_key_pad = sess->auth.hmac.o_key_pad;
643 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
647 if (sess->auth.operation == RTE_CRYPTO_AUTH_OP_GENERATE) {
648 adst = op->sym->auth.digest.data;
650 adst = rte_pktmbuf_mtod_offset(m_adst,
652 op->sym->auth.data.offset +
653 op->sym->auth.data.length);
656 adst = (uint8_t *)rte_pktmbuf_append(m_asrc,
657 sess->auth.digest_length);
660 arg.cipher.iv = rte_crypto_op_ctod_offset(op, uint8_t *,
661 sess->cipher.iv.offset);
662 arg.cipher.key = sess->cipher.key.data;
663 /* Acquire combined mode function */
664 crypto_func = sess->crypto_func;
665 ARMV8_CRYPTO_ASSERT(crypto_func != NULL);
666 error = crypto_func(csrc, cdst, clen, asrc, adst, alen, &arg);
668 op->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
672 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
673 if (sess->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY) {
674 if (memcmp(adst, op->sym->auth.digest.data,
675 sess->auth.digest_length) != 0) {
676 op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
678 /* Trim area used for digest from mbuf. */
679 rte_pktmbuf_trim(m_asrc,
680 sess->auth.digest_length);
684 /** Process crypto operation for mbuf */
686 process_op(const struct armv8_crypto_qp *qp, struct rte_crypto_op *op,
687 struct armv8_crypto_session *sess)
689 struct rte_mbuf *msrc, *mdst;
691 msrc = op->sym->m_src;
692 mdst = op->sym->m_dst ? op->sym->m_dst : op->sym->m_src;
694 op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
696 switch (sess->chain_order) {
697 case ARMV8_CRYPTO_CHAIN_CIPHER_AUTH:
698 case ARMV8_CRYPTO_CHAIN_AUTH_CIPHER: /* Fall through */
699 process_armv8_chained_op(op, sess, msrc, mdst);
702 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
706 /* Free session if a session-less crypto op */
707 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
708 memset(sess, 0, sizeof(struct armv8_crypto_session));
709 rte_mempool_put(qp->sess_mp, op->sym->session);
710 op->sym->session = NULL;
713 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
714 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
716 if (unlikely(op->status == RTE_CRYPTO_OP_STATUS_ERROR))
723 *------------------------------------------------------------------------------
725 *------------------------------------------------------------------------------
730 armv8_crypto_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
733 struct armv8_crypto_session *sess;
734 struct armv8_crypto_qp *qp = queue_pair;
737 for (i = 0; i < nb_ops; i++) {
738 sess = get_session(qp, ops[i]);
739 if (unlikely(sess == NULL))
742 retval = process_op(qp, ops[i], sess);
743 if (unlikely(retval < 0))
747 retval = rte_ring_enqueue_burst(qp->processed_ops, (void *)ops, i,
749 qp->stats.enqueued_count += retval;
754 retval = rte_ring_enqueue_burst(qp->processed_ops, (void *)ops, i,
757 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
759 qp->stats.enqueue_err_count++;
765 armv8_crypto_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
768 struct armv8_crypto_qp *qp = queue_pair;
770 unsigned int nb_dequeued = 0;
772 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
773 (void **)ops, nb_ops, NULL);
774 qp->stats.dequeued_count += nb_dequeued;
779 /** Create ARMv8 crypto device */
781 cryptodev_armv8_crypto_create(const char *name,
782 struct rte_vdev_device *vdev,
783 struct rte_crypto_vdev_init_params *init_params)
785 struct rte_cryptodev *dev;
786 struct armv8_crypto_private *internals;
788 /* Check CPU for support for AES instruction set */
789 if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
790 ARMV8_CRYPTO_LOG_ERR(
791 "AES instructions not supported by CPU");
795 /* Check CPU for support for SHA instruction set */
796 if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_SHA1) ||
797 !rte_cpu_get_flag_enabled(RTE_CPUFLAG_SHA2)) {
798 ARMV8_CRYPTO_LOG_ERR(
799 "SHA1/SHA2 instructions not supported by CPU");
803 /* Check CPU for support for Advance SIMD instruction set */
804 if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_NEON)) {
805 ARMV8_CRYPTO_LOG_ERR(
806 "Advanced SIMD instructions not supported by CPU");
810 if (init_params->name[0] == '\0')
811 snprintf(init_params->name, sizeof(init_params->name),
814 dev = rte_cryptodev_vdev_pmd_init(init_params->name,
815 sizeof(struct armv8_crypto_private),
816 init_params->socket_id,
819 ARMV8_CRYPTO_LOG_ERR("failed to create cryptodev vdev");
823 dev->driver_id = cryptodev_driver_id;
824 dev->dev_ops = rte_armv8_crypto_pmd_ops;
826 /* register rx/tx burst functions for data path */
827 dev->dequeue_burst = armv8_crypto_pmd_dequeue_burst;
828 dev->enqueue_burst = armv8_crypto_pmd_enqueue_burst;
830 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
831 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
832 RTE_CRYPTODEV_FF_CPU_NEON |
833 RTE_CRYPTODEV_FF_CPU_ARM_CE;
835 /* Set vector instructions mode supported */
836 internals = dev->data->dev_private;
838 internals->max_nb_qpairs = init_params->max_nb_queue_pairs;
839 internals->max_nb_sessions = init_params->max_nb_sessions;
844 ARMV8_CRYPTO_LOG_ERR(
845 "driver %s: cryptodev_armv8_crypto_create failed",
848 cryptodev_armv8_crypto_uninit(vdev);
852 /** Initialise ARMv8 crypto device */
854 cryptodev_armv8_crypto_init(struct rte_vdev_device *vdev)
856 struct rte_crypto_vdev_init_params init_params = {
857 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
858 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
863 const char *input_args;
865 name = rte_vdev_device_name(vdev);
868 input_args = rte_vdev_device_args(vdev);
869 rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
871 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
872 init_params.socket_id);
873 if (init_params.name[0] != '\0') {
874 RTE_LOG(INFO, PMD, " User defined name = %s\n",
877 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
878 init_params.max_nb_queue_pairs);
879 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
880 init_params.max_nb_sessions);
882 return cryptodev_armv8_crypto_create(name, vdev, &init_params);
885 /** Uninitialise ARMv8 crypto device */
887 cryptodev_armv8_crypto_uninit(struct rte_vdev_device *vdev)
891 name = rte_vdev_device_name(vdev);
896 "Closing ARMv8 crypto device %s on numa socket %u\n",
897 name, rte_socket_id());
902 static struct rte_vdev_driver armv8_crypto_drv = {
903 .probe = cryptodev_armv8_crypto_init,
904 .remove = cryptodev_armv8_crypto_uninit
907 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_ARMV8_PMD, armv8_crypto_drv);
908 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_ARMV8_PMD, cryptodev_armv8_pmd);
909 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_ARMV8_PMD,
910 "max_nb_queue_pairs=<int> "
911 "max_nb_sessions=<int> "
913 RTE_PMD_REGISTER_CRYPTO_DRIVER(armv8_crypto_drv, cryptodev_driver_id);