xref: /freebsd/sys/crypto/armv8/armv8_crypto.c (revision ce6a89e27cd190313be39bb479880aeda4778436)
1 /*-
2  * Copyright (c) 2005-2008 Pawel Jakub Dawidek <pjd@FreeBSD.org>
3  * Copyright (c) 2010 Konstantin Belousov <kib@FreeBSD.org>
4  * Copyright (c) 2014,2016 The FreeBSD Foundation
5  * All rights reserved.
6  *
7  * Portions of this software were developed by John-Mark Gurney
8  * under sponsorship of the FreeBSD Foundation and
9  * Rubicon Communications, LLC (Netgate).
10  *
11  * This software was developed by Andrew Turner under
12  * sponsorship from the FreeBSD Foundation.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 /*
37  * This is based on the aesni code.
38  */
39 
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
42 
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/bus.h>
47 #include <sys/endian.h>
48 #include <sys/lock.h>
49 #include <sys/malloc.h>
50 #include <sys/mbuf.h>
51 #include <sys/module.h>
52 #include <sys/mutex.h>
53 #include <sys/queue.h>
54 #include <sys/rwlock.h>
55 #include <sys/smp.h>
56 #include <sys/uio.h>
57 
58 #include <machine/vfp.h>
59 
60 #include <opencrypto/cryptodev.h>
61 #include <cryptodev_if.h>
62 #include <crypto/armv8/armv8_crypto.h>
63 #include <crypto/rijndael/rijndael.h>
64 
65 struct armv8_crypto_softc {
66 	int		dieing;
67 	int32_t		cid;
68 	struct rwlock	lock;
69 };
70 
71 static struct mtx *ctx_mtx;
72 static struct fpu_kern_ctx **ctx_vfp;
73 
74 #define AQUIRE_CTX(i, ctx)					\
75 	do {							\
76 		(i) = PCPU_GET(cpuid);				\
77 		mtx_lock(&ctx_mtx[(i)]);			\
78 		(ctx) = ctx_vfp[(i)];				\
79 	} while (0)
80 #define RELEASE_CTX(i, ctx)					\
81 	do {							\
82 		mtx_unlock(&ctx_mtx[(i)]);			\
83 		(i) = -1;					\
84 		(ctx) = NULL;					\
85 	} while (0)
86 
87 static int armv8_crypto_cipher_process(struct armv8_crypto_session *,
88     struct cryptop *);
89 
90 MALLOC_DEFINE(M_ARMV8_CRYPTO, "armv8_crypto", "ARMv8 Crypto Data");
91 
92 static void
93 armv8_crypto_identify(driver_t *drv, device_t parent)
94 {
95 
96 	/* NB: order 10 is so we get attached after h/w devices */
97 	if (device_find_child(parent, "armv8crypto", -1) == NULL &&
98 	    BUS_ADD_CHILD(parent, 10, "armv8crypto", -1) == 0)
99 		panic("ARMv8 crypto: could not attach");
100 }
101 
102 static int
103 armv8_crypto_probe(device_t dev)
104 {
105 	uint64_t reg;
106 	int ret = ENXIO;
107 
108 	reg = READ_SPECIALREG(id_aa64isar0_el1);
109 
110 	switch (ID_AA64ISAR0_AES_VAL(reg)) {
111 	case ID_AA64ISAR0_AES_BASE:
112 	case ID_AA64ISAR0_AES_PMULL:
113 		ret = 0;
114 		break;
115 	}
116 
117 	device_set_desc_copy(dev, "AES-CBC");
118 
119 	/* TODO: Check more fields as we support more features */
120 
121 	return (ret);
122 }
123 
124 static int
125 armv8_crypto_attach(device_t dev)
126 {
127 	struct armv8_crypto_softc *sc;
128 	int i;
129 
130 	sc = device_get_softc(dev);
131 	sc->dieing = 0;
132 
133 	sc->cid = crypto_get_driverid(dev, sizeof(struct armv8_crypto_session),
134 	    CRYPTOCAP_F_SOFTWARE | CRYPTOCAP_F_SYNC);
135 	if (sc->cid < 0) {
136 		device_printf(dev, "Could not get crypto driver id.\n");
137 		return (ENOMEM);
138 	}
139 
140 	rw_init(&sc->lock, "armv8crypto");
141 
142 	ctx_mtx = malloc(sizeof(*ctx_mtx) * (mp_maxid + 1), M_ARMV8_CRYPTO,
143 	    M_WAITOK|M_ZERO);
144 	ctx_vfp = malloc(sizeof(*ctx_vfp) * (mp_maxid + 1), M_ARMV8_CRYPTO,
145 	    M_WAITOK|M_ZERO);
146 
147 	CPU_FOREACH(i) {
148 		ctx_vfp[i] = fpu_kern_alloc_ctx(0);
149 		mtx_init(&ctx_mtx[i], "armv8cryptoctx", NULL, MTX_DEF|MTX_NEW);
150 	}
151 
152 	return (0);
153 }
154 
155 static int
156 armv8_crypto_detach(device_t dev)
157 {
158 	struct armv8_crypto_softc *sc;
159 	int i;
160 
161 	sc = device_get_softc(dev);
162 
163 	rw_wlock(&sc->lock);
164 	sc->dieing = 1;
165 	rw_wunlock(&sc->lock);
166 	crypto_unregister_all(sc->cid);
167 
168 	rw_destroy(&sc->lock);
169 
170 	CPU_FOREACH(i) {
171 		if (ctx_vfp[i] != NULL) {
172 			mtx_destroy(&ctx_mtx[i]);
173 			fpu_kern_free_ctx(ctx_vfp[i]);
174 		}
175 		ctx_vfp[i] = NULL;
176 	}
177 	free(ctx_mtx, M_ARMV8_CRYPTO);
178 	ctx_mtx = NULL;
179 	free(ctx_vfp, M_ARMV8_CRYPTO);
180 	ctx_vfp = NULL;
181 
182 	return (0);
183 }
184 
185 static int
186 armv8_crypto_probesession(device_t dev,
187     const struct crypto_session_params *csp)
188 {
189 
190 	if (csp->csp_flags != 0)
191 		return (EINVAL);
192 	switch (csp->csp_mode) {
193 	case CSP_MODE_CIPHER:
194 		switch (csp->csp_cipher_alg) {
195 		case CRYPTO_AES_CBC:
196 			if (csp->csp_ivlen != AES_BLOCK_LEN)
197 				return (EINVAL);
198 			switch (csp->csp_cipher_klen * 8) {
199 			case 128:
200 			case 192:
201 			case 256:
202 				break;
203 			default:
204 				return (EINVAL);
205 			}
206 			break;
207 		default:
208 			return (EINVAL);
209 		}
210 	default:
211 		return (EINVAL);
212 	}
213 	return (CRYPTODEV_PROBE_ACCEL_SOFTWARE);
214 }
215 
216 static void
217 armv8_crypto_cipher_setup(struct armv8_crypto_session *ses,
218     const struct crypto_session_params *csp)
219 {
220 	int i;
221 
222 	switch (csp->csp_cipher_klen * 8) {
223 	case 128:
224 		ses->rounds = AES128_ROUNDS;
225 		break;
226 	case 192:
227 		ses->rounds = AES192_ROUNDS;
228 		break;
229 	case 256:
230 		ses->rounds = AES256_ROUNDS;
231 		break;
232 	default:
233 		panic("invalid CBC key length");
234 	}
235 
236 	rijndaelKeySetupEnc(ses->enc_schedule, csp->csp_cipher_key,
237 	    csp->csp_cipher_klen * 8);
238 	rijndaelKeySetupDec(ses->dec_schedule, csp->csp_cipher_key,
239 	    csp->csp_cipher_klen * 8);
240 	for (i = 0; i < nitems(ses->enc_schedule); i++) {
241 		ses->enc_schedule[i] = bswap32(ses->enc_schedule[i]);
242 		ses->dec_schedule[i] = bswap32(ses->dec_schedule[i]);
243 	}
244 }
245 
246 static int
247 armv8_crypto_newsession(device_t dev, crypto_session_t cses,
248     const struct crypto_session_params *csp)
249 {
250 	struct armv8_crypto_softc *sc;
251 	struct armv8_crypto_session *ses;
252 
253 	sc = device_get_softc(dev);
254 	rw_wlock(&sc->lock);
255 	if (sc->dieing) {
256 		rw_wunlock(&sc->lock);
257 		return (EINVAL);
258 	}
259 
260 	ses = crypto_get_driver_session(cses);
261 	armv8_crypto_cipher_setup(ses, csp);
262 	rw_wunlock(&sc->lock);
263 	return (0);
264 }
265 
266 static int
267 armv8_crypto_process(device_t dev, struct cryptop *crp, int hint __unused)
268 {
269 	struct armv8_crypto_session *ses;
270 	int error;
271 
272 	/* We can only handle full blocks for now */
273 	if ((crp->crp_payload_length % AES_BLOCK_LEN) != 0) {
274 		error = EINVAL;
275 		goto out;
276 	}
277 
278 	ses = crypto_get_driver_session(crp->crp_session);
279 	error = armv8_crypto_cipher_process(ses, crp);
280 
281 out:
282 	crp->crp_etype = error;
283 	crypto_done(crp);
284 	return (error);
285 }
286 
287 static uint8_t *
288 armv8_crypto_cipher_alloc(struct cryptop *crp, int *allocated)
289 {
290 	uint8_t *addr;
291 
292 	addr = crypto_contiguous_subsegment(crp, crp->crp_payload_start,
293 	    crp->crp_payload_length);
294 	if (addr != NULL) {
295 		*allocated = 0;
296 		return (addr);
297 	}
298 	addr = malloc(crp->crp_payload_length, M_ARMV8_CRYPTO, M_NOWAIT);
299 	if (addr != NULL) {
300 		*allocated = 1;
301 		crypto_copydata(crp, crp->crp_payload_start,
302 		    crp->crp_payload_length, addr);
303 	} else
304 		*allocated = 0;
305 	return (addr);
306 }
307 
308 static int
309 armv8_crypto_cipher_process(struct armv8_crypto_session *ses,
310     struct cryptop *crp)
311 {
312 	const struct crypto_session_params *csp;
313 	struct fpu_kern_ctx *ctx;
314 	uint8_t *buf;
315 	uint8_t iv[AES_BLOCK_LEN];
316 	int allocated, i;
317 	int encflag;
318 	int kt;
319 
320 	csp = crypto_get_params(crp->crp_session);
321 	encflag = CRYPTO_OP_IS_ENCRYPT(crp->crp_op);
322 
323 	buf = armv8_crypto_cipher_alloc(crp, &allocated);
324 	if (buf == NULL)
325 		return (ENOMEM);
326 
327 	kt = is_fpu_kern_thread(0);
328 	if (!kt) {
329 		AQUIRE_CTX(i, ctx);
330 		fpu_kern_enter(curthread, ctx,
331 		    FPU_KERN_NORMAL | FPU_KERN_KTHR);
332 	}
333 
334 	if (crp->crp_cipher_key != NULL) {
335 		panic("armv8: new cipher key");
336 	}
337 
338 	/* Setup iv */
339 	if (crp->crp_flags & CRYPTO_F_IV_GENERATE) {
340 		arc4rand(iv, csp->csp_ivlen, 0);
341 		crypto_copyback(crp, crp->crp_iv_start, csp->csp_ivlen, iv);
342 	} else if (crp->crp_flags & CRYPTO_F_IV_SEPARATE)
343 		memcpy(iv, crp->crp_iv, csp->csp_ivlen);
344 	else
345 		crypto_copydata(crp, crp->crp_iv_start, csp->csp_ivlen, iv);
346 
347 	/* Do work */
348 	switch (csp->csp_cipher_alg) {
349 	case CRYPTO_AES_CBC:
350 		if (encflag)
351 			armv8_aes_encrypt_cbc(ses->rounds, ses->enc_schedule,
352 			    crp->crp_payload_length, buf, buf, iv);
353 		else
354 			armv8_aes_decrypt_cbc(ses->rounds, ses->dec_schedule,
355 			    crp->crp_payload_length, buf, iv);
356 		break;
357 	}
358 
359 	if (allocated)
360 		crypto_copyback(crp, crp->crp_payload_start,
361 		    crp->crp_payload_length, buf);
362 
363 	if (!kt) {
364 		fpu_kern_leave(curthread, ctx);
365 		RELEASE_CTX(i, ctx);
366 	}
367 	if (allocated) {
368 		bzero(buf, crp->crp_payload_length);
369 		free(buf, M_ARMV8_CRYPTO);
370 	}
371 	return (0);
372 }
373 
374 static device_method_t armv8_crypto_methods[] = {
375 	DEVMETHOD(device_identify,	armv8_crypto_identify),
376 	DEVMETHOD(device_probe,		armv8_crypto_probe),
377 	DEVMETHOD(device_attach,	armv8_crypto_attach),
378 	DEVMETHOD(device_detach,	armv8_crypto_detach),
379 
380 	DEVMETHOD(cryptodev_probesession, armv8_crypto_probesession),
381 	DEVMETHOD(cryptodev_newsession,	armv8_crypto_newsession),
382 	DEVMETHOD(cryptodev_process,	armv8_crypto_process),
383 
384 	DEVMETHOD_END,
385 };
386 
387 static DEFINE_CLASS_0(armv8crypto, armv8_crypto_driver, armv8_crypto_methods,
388     sizeof(struct armv8_crypto_softc));
389 static devclass_t armv8_crypto_devclass;
390 
391 DRIVER_MODULE(armv8crypto, nexus, armv8_crypto_driver, armv8_crypto_devclass,
392     0, 0);
393