2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2017 Chelsio Communications, Inc.
5 * Copyright (c) 2017 Conrad Meyer <cem@FreeBSD.org>
7 * Largely borrowed from ccr(4), Written by: John Baldwin <jhb@FreeBSD.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
39 #include <sys/kernel.h>
40 #include <sys/malloc.h>
41 #include <sys/mutex.h>
42 #include <sys/module.h>
43 #include <sys/random.h>
44 #include <sys/sglist.h>
45 #include <sys/sysctl.h>
51 #include <dev/pci/pcivar.h>
53 #include <dev/random/randomdev.h>
55 #include <opencrypto/cryptodev.h>
56 #include <opencrypto/xform.h>
58 #include "cryptodev_if.h"
61 #include "ccp_hardware.h"
63 MALLOC_DEFINE(M_CCP, "ccp", "AMD CCP crypto");
66 * Need a global softc available for garbage random_source API, which lacks any
67 * context pointer. It's also handy for debugging.
69 struct ccp_softc *g_ccp_softc;
71 bool g_debug_print = false;
72 SYSCTL_BOOL(_hw_ccp, OID_AUTO, debug, CTLFLAG_RWTUN, &g_debug_print, 0,
73 "Set to enable debugging log messages");
79 { 0x14561022, "AMD CCP-5a" },
80 { 0x14681022, "AMD CCP-5b" },
81 { 0x15df1022, "AMD CCP-5a" },
84 static struct random_source random_ccp = {
85 .rs_ident = "AMD CCP TRNG",
86 .rs_source = RANDOM_PURE_CCP,
87 .rs_read = random_ccp_read,
91 * ccp_populate_sglist() generates a scatter/gather list that covers the entire
92 * crypto operation buffer.
95 ccp_populate_sglist(struct sglist *sg, struct crypto_buffer *cb)
100 switch (cb->cb_type) {
101 case CRYPTO_BUF_MBUF:
102 error = sglist_append_mbuf(sg, cb->cb_mbuf);
105 error = sglist_append_uio(sg, cb->cb_uio);
107 case CRYPTO_BUF_CONTIG:
108 error = sglist_append(sg, cb->cb_buf, cb->cb_buf_len);
110 case CRYPTO_BUF_VMPAGE:
111 error = sglist_append_vmpages(sg, cb->cb_vm_page,
112 cb->cb_vm_page_len, cb->cb_vm_page_offset);
121 ccp_probe(device_t dev)
126 id = pci_get_devid(dev);
127 for (ip = ccp_ids; ip < &ccp_ids[nitems(ccp_ids)]; ip++) {
128 if (id == ip->devid) {
129 device_set_desc(dev, ip->desc);
137 ccp_initialize_queues(struct ccp_softc *sc)
139 struct ccp_queue *qp;
142 for (i = 0; i < nitems(sc->queues); i++) {
147 mtx_init(&qp->cq_lock, "ccp queue", NULL, MTX_DEF);
148 /* XXX - arbitrarily chosen sizes */
149 qp->cq_sg_crp = sglist_alloc(32, M_WAITOK);
150 /* Two more SGEs than sg_crp to accommodate ipad. */
151 qp->cq_sg_ulptx = sglist_alloc(34, M_WAITOK);
152 qp->cq_sg_dst = sglist_alloc(2, M_WAITOK);
157 ccp_free_queues(struct ccp_softc *sc)
159 struct ccp_queue *qp;
162 for (i = 0; i < nitems(sc->queues); i++) {
165 mtx_destroy(&qp->cq_lock);
166 sglist_free(qp->cq_sg_crp);
167 sglist_free(qp->cq_sg_ulptx);
168 sglist_free(qp->cq_sg_dst);
173 ccp_attach(device_t dev)
175 struct ccp_softc *sc;
178 sc = device_get_softc(dev);
181 sc->cid = crypto_get_driverid(dev, sizeof(struct ccp_session),
182 CRYPTOCAP_F_HARDWARE);
184 device_printf(dev, "could not get crypto driver id\n");
188 error = ccp_hw_attach(dev);
192 mtx_init(&sc->lock, "ccp", NULL, MTX_DEF);
194 ccp_initialize_queues(sc);
196 if (g_ccp_softc == NULL) {
198 if ((sc->hw_features & VERSION_CAP_TRNG) != 0)
199 random_source_register(&random_ccp);
206 ccp_detach(device_t dev)
208 struct ccp_softc *sc;
210 sc = device_get_softc(dev);
213 sc->detaching = true;
214 mtx_unlock(&sc->lock);
216 crypto_unregister_all(sc->cid);
217 if (g_ccp_softc == sc && (sc->hw_features & VERSION_CAP_TRNG) != 0)
218 random_source_deregister(&random_ccp);
223 if (g_ccp_softc == sc)
226 mtx_destroy(&sc->lock);
231 ccp_init_hmac_digest(struct ccp_session *s, const char *key, int klen)
233 union authctx auth_ctx;
234 struct auth_hash *axf;
238 * If the key is larger than the block size, use the digest of
239 * the key as the key instead.
241 axf = s->hmac.auth_hash;
242 if (klen > axf->blocksize) {
243 axf->Init(&auth_ctx);
244 axf->Update(&auth_ctx, key, klen);
245 axf->Final(s->hmac.ipad, &auth_ctx);
246 explicit_bzero(&auth_ctx, sizeof(auth_ctx));
247 klen = axf->hashsize;
249 memcpy(s->hmac.ipad, key, klen);
251 memset(s->hmac.ipad + klen, 0, axf->blocksize - klen);
252 memcpy(s->hmac.opad, s->hmac.ipad, axf->blocksize);
254 for (i = 0; i < axf->blocksize; i++) {
255 s->hmac.ipad[i] ^= HMAC_IPAD_VAL;
256 s->hmac.opad[i] ^= HMAC_OPAD_VAL;
261 ccp_aes_check_keylen(int alg, int klen)
267 if (alg == CRYPTO_AES_XTS)
273 if (alg != CRYPTO_AES_XTS)
283 ccp_aes_setkey(struct ccp_session *s, int alg, const void *key, int klen)
287 if (alg == CRYPTO_AES_XTS)
288 kbits = (klen / 2) * 8;
294 s->blkcipher.cipher_type = CCP_AES_TYPE_128;
297 s->blkcipher.cipher_type = CCP_AES_TYPE_192;
300 s->blkcipher.cipher_type = CCP_AES_TYPE_256;
303 panic("should not get here");
306 s->blkcipher.key_len = klen;
307 memcpy(s->blkcipher.enckey, key, s->blkcipher.key_len);
311 ccp_auth_supported(struct ccp_softc *sc,
312 const struct crypto_session_params *csp)
315 if ((sc->hw_features & VERSION_CAP_SHA) == 0)
317 switch (csp->csp_auth_alg) {
318 case CRYPTO_SHA1_HMAC:
319 case CRYPTO_SHA2_256_HMAC:
320 case CRYPTO_SHA2_384_HMAC:
321 case CRYPTO_SHA2_512_HMAC:
322 if (csp->csp_auth_key == NULL)
332 ccp_cipher_supported(struct ccp_softc *sc,
333 const struct crypto_session_params *csp)
336 if ((sc->hw_features & VERSION_CAP_AES) == 0)
338 switch (csp->csp_cipher_alg) {
340 if (csp->csp_ivlen != AES_BLOCK_LEN)
344 if (csp->csp_ivlen != AES_BLOCK_LEN)
348 if (csp->csp_ivlen != AES_XTS_IV_LEN)
354 return (ccp_aes_check_keylen(csp->csp_cipher_alg,
355 csp->csp_cipher_klen));
359 ccp_probesession(device_t dev, const struct crypto_session_params *csp)
361 struct ccp_softc *sc;
363 if (csp->csp_flags != 0)
365 sc = device_get_softc(dev);
366 switch (csp->csp_mode) {
367 case CSP_MODE_DIGEST:
368 if (!ccp_auth_supported(sc, csp))
371 case CSP_MODE_CIPHER:
372 if (!ccp_cipher_supported(sc, csp))
376 switch (csp->csp_cipher_alg) {
377 case CRYPTO_AES_NIST_GCM_16:
378 if (csp->csp_ivlen != AES_GCM_IV_LEN)
380 if (csp->csp_auth_mlen < 0 ||
381 csp->csp_auth_mlen > AES_GMAC_HASH_LEN)
383 if ((sc->hw_features & VERSION_CAP_AES) == 0)
391 if (!ccp_auth_supported(sc, csp) ||
392 !ccp_cipher_supported(sc, csp))
399 return (CRYPTODEV_PROBE_HARDWARE);
403 ccp_newsession(device_t dev, crypto_session_t cses,
404 const struct crypto_session_params *csp)
406 struct ccp_softc *sc;
407 struct ccp_session *s;
408 struct auth_hash *auth_hash;
409 enum ccp_aes_mode cipher_mode;
413 /* XXX reconcile auth_mode with use by ccp_sha */
414 switch (csp->csp_auth_alg) {
415 case CRYPTO_SHA1_HMAC:
416 auth_hash = &auth_hash_hmac_sha1;
419 case CRYPTO_SHA2_256_HMAC:
420 auth_hash = &auth_hash_hmac_sha2_256;
421 auth_mode = SHA2_256;
423 case CRYPTO_SHA2_384_HMAC:
424 auth_hash = &auth_hash_hmac_sha2_384;
425 auth_mode = SHA2_384;
427 case CRYPTO_SHA2_512_HMAC:
428 auth_hash = &auth_hash_hmac_sha2_512;
429 auth_mode = SHA2_512;
437 switch (csp->csp_cipher_alg) {
439 cipher_mode = CCP_AES_MODE_CBC;
442 cipher_mode = CCP_AES_MODE_CTR;
444 case CRYPTO_AES_NIST_GCM_16:
445 cipher_mode = CCP_AES_MODE_GCTR;
448 cipher_mode = CCP_AES_MODE_XTS;
451 cipher_mode = CCP_AES_MODE_ECB;
455 sc = device_get_softc(dev);
458 mtx_unlock(&sc->lock);
462 s = crypto_get_driver_session(cses);
464 /* Just grab the first usable queue for now. */
465 for (q = 0; q < nitems(sc->queues); q++)
466 if ((sc->valid_queues & (1 << q)) != 0)
468 if (q == nitems(sc->queues)) {
469 mtx_unlock(&sc->lock);
474 switch (csp->csp_mode) {
481 case CSP_MODE_DIGEST:
484 case CSP_MODE_CIPHER:
489 if (s->mode == GCM) {
490 if (csp->csp_auth_mlen == 0)
491 s->gmac.hash_len = AES_GMAC_HASH_LEN;
493 s->gmac.hash_len = csp->csp_auth_mlen;
494 } else if (auth_hash != NULL) {
495 s->hmac.auth_hash = auth_hash;
496 s->hmac.auth_mode = auth_mode;
497 if (csp->csp_auth_mlen == 0)
498 s->hmac.hash_len = auth_hash->hashsize;
500 s->hmac.hash_len = csp->csp_auth_mlen;
501 ccp_init_hmac_digest(s, csp->csp_auth_key, csp->csp_auth_klen);
503 if (cipher_mode != CCP_AES_MODE_ECB) {
504 s->blkcipher.cipher_mode = cipher_mode;
505 if (csp->csp_cipher_key != NULL)
506 ccp_aes_setkey(s, csp->csp_cipher_alg,
507 csp->csp_cipher_key, csp->csp_cipher_klen);
511 mtx_unlock(&sc->lock);
517 ccp_freesession(device_t dev, crypto_session_t cses)
519 struct ccp_session *s;
521 s = crypto_get_driver_session(cses);
525 "session %p freed with %d pending requests\n", s,
531 ccp_process(device_t dev, struct cryptop *crp, int hint)
533 const struct crypto_session_params *csp;
534 struct ccp_softc *sc;
535 struct ccp_queue *qp;
536 struct ccp_session *s;
543 csp = crypto_get_params(crp->crp_session);
544 s = crypto_get_driver_session(crp->crp_session);
545 sc = device_get_softc(dev);
547 qp = &sc->queues[s->queue];
548 mtx_unlock(&sc->lock);
549 error = ccp_queue_acquire_reserve(qp, 1 /* placeholder */, M_NOWAIT);
554 error = ccp_populate_sglist(qp->cq_sg_crp, &crp->crp_buf);
558 if (crp->crp_auth_key != NULL) {
559 KASSERT(s->hmac.auth_hash != NULL, ("auth key without HMAC"));
560 ccp_init_hmac_digest(s, crp->crp_auth_key, csp->csp_auth_klen);
562 if (crp->crp_cipher_key != NULL)
563 ccp_aes_setkey(s, csp->csp_cipher_alg, crp->crp_cipher_key,
564 csp->csp_cipher_klen);
568 if (s->pending != 0) {
572 error = ccp_hmac(qp, s, crp);
575 if (s->pending != 0) {
579 error = ccp_blkcipher(qp, s, crp);
582 if (s->pending != 0) {
586 error = ccp_authenc(qp, s, crp);
589 if (s->pending != 0) {
593 error = ccp_gcm(qp, s, crp);
604 * Squash EAGAIN so callers don't uselessly and
605 * expensively retry if the ring was full.
611 ccp_queue_release(qp);
615 DPRINTF(dev, "%s: early error:%d\n", __func__, error);
616 crp->crp_etype = error;
622 static device_method_t ccp_methods[] = {
623 DEVMETHOD(device_probe, ccp_probe),
624 DEVMETHOD(device_attach, ccp_attach),
625 DEVMETHOD(device_detach, ccp_detach),
627 DEVMETHOD(cryptodev_probesession, ccp_probesession),
628 DEVMETHOD(cryptodev_newsession, ccp_newsession),
629 DEVMETHOD(cryptodev_freesession, ccp_freesession),
630 DEVMETHOD(cryptodev_process, ccp_process),
635 static driver_t ccp_driver = {
638 sizeof(struct ccp_softc)
641 static devclass_t ccp_devclass;
642 DRIVER_MODULE(ccp, pci, ccp_driver, ccp_devclass, NULL, NULL);
643 MODULE_VERSION(ccp, 1);
644 MODULE_DEPEND(ccp, crypto, 1, 1, 1);
645 MODULE_DEPEND(ccp, random_device, 1, 1, 1);
646 #if 0 /* There are enough known issues that we shouldn't load automatically */
647 MODULE_PNP_INFO("W32:vendor/device", pci, ccp, ccp_ids,
652 ccp_queue_reserve_space(struct ccp_queue *qp, unsigned n, int mflags)
654 struct ccp_softc *sc;
656 mtx_assert(&qp->cq_lock, MA_OWNED);
659 if (n < 1 || n >= (1 << sc->ring_size_order))
663 if (ccp_queue_get_ring_space(qp) >= n)
665 if ((mflags & M_WAITOK) == 0)
667 qp->cq_waiting = true;
668 msleep(&qp->cq_tail, &qp->cq_lock, 0, "ccpqfull", 0);
673 ccp_queue_acquire_reserve(struct ccp_queue *qp, unsigned n, int mflags)
677 mtx_lock(&qp->cq_lock);
678 qp->cq_acq_tail = qp->cq_tail;
679 error = ccp_queue_reserve_space(qp, n, mflags);
681 mtx_unlock(&qp->cq_lock);
686 ccp_queue_release(struct ccp_queue *qp)
689 mtx_assert(&qp->cq_lock, MA_OWNED);
690 if (qp->cq_tail != qp->cq_acq_tail) {
692 ccp_queue_write_tail(qp);
694 mtx_unlock(&qp->cq_lock);
698 ccp_queue_abort(struct ccp_queue *qp)
702 mtx_assert(&qp->cq_lock, MA_OWNED);
704 /* Wipe out any descriptors associated with this aborted txn. */
705 for (i = qp->cq_acq_tail; i != qp->cq_tail;
706 i = (i + 1) % (1 << qp->cq_softc->ring_size_order)) {
707 memset(&qp->desc_ring[i], 0, sizeof(qp->desc_ring[i]));
709 qp->cq_tail = qp->cq_acq_tail;
711 mtx_unlock(&qp->cq_lock);
715 #define _db_show_lock(lo) LOCK_CLASS(lo)->lc_ddb_show(lo)
716 #define db_show_lock(lk) _db_show_lock(&(lk)->lock_object)
718 db_show_ccp_sc(struct ccp_softc *sc)
721 db_printf("ccp softc at %p\n", sc);
722 db_printf(" cid: %d\n", (int)sc->cid);
724 db_printf(" lock: ");
725 db_show_lock(&sc->lock);
727 db_printf(" detaching: %d\n", (int)sc->detaching);
728 db_printf(" ring_size_order: %u\n", sc->ring_size_order);
730 db_printf(" hw_version: %d\n", (int)sc->hw_version);
731 db_printf(" hw_features: %b\n", (int)sc->hw_features,
732 "\20\24ELFC\23TRNG\22Zip_Compress\16Zip_Decompress\13ECC\12RSA"
733 "\11SHA\0103DES\07AES");
735 db_printf(" hw status:\n");
740 db_show_ccp_qp(struct ccp_queue *qp)
743 db_printf(" lock: ");
744 db_show_lock(&qp->cq_lock);
746 db_printf(" cq_qindex: %u\n", qp->cq_qindex);
747 db_printf(" cq_softc: %p\n", qp->cq_softc);
749 db_printf(" head: %u\n", qp->cq_head);
750 db_printf(" tail: %u\n", qp->cq_tail);
751 db_printf(" acq_tail: %u\n", qp->cq_acq_tail);
752 db_printf(" desc_ring: %p\n", qp->desc_ring);
753 db_printf(" completions_ring: %p\n", qp->completions_ring);
754 db_printf(" descriptors (phys): 0x%jx\n",
755 (uintmax_t)qp->desc_ring_bus_addr);
757 db_printf(" hw status:\n");
758 db_ccp_show_queue_hw(qp);
761 DB_SHOW_COMMAND(ccp, db_show_ccp)
763 struct ccp_softc *sc;
764 unsigned unit, qindex;
769 unit = (unsigned)addr;
771 sc = devclass_get_softc(ccp_devclass, unit);
773 db_printf("No such device ccp%u\n", unit);
782 qindex = (unsigned)count;
783 if (qindex >= nitems(sc->queues)) {
784 db_printf("No such queue %u\n", qindex);
787 db_show_ccp_qp(&sc->queues[qindex]);
791 db_printf("usage: show ccp <unit>[,<qindex>]\n");