2 * Copyright (c) 2005-2008 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
35 #include <sys/rwlock.h>
36 #include <sys/malloc.h>
37 #include <sys/libkern.h>
38 #if defined(__amd64__) || (defined(__i386__) && !defined(PC98))
39 #include <machine/cpufunc.h>
40 #include <machine/cputypes.h>
41 #include <machine/md_var.h>
42 #include <machine/specialreg.h>
45 #include <opencrypto/cryptodev.h>
47 #include <crypto/via/padlock.h>
51 #include "cryptodev_if.h"
54 * Technical documentation about the PadLock engine can be found here:
56 * http://www.via.com.tw/en/downloads/whitepapers/initiatives/padlock/programming_guide.pdf
59 struct padlock_softc {
62 TAILQ_HEAD(padlock_sessions_head, padlock_session) sc_sessions;
63 struct rwlock sc_sessions_lock;
66 static int padlock_newsession(device_t, uint32_t *sidp, struct cryptoini *cri);
67 static int padlock_freesession(device_t, uint64_t tid);
68 static void padlock_freesession_one(struct padlock_softc *sc,
69 struct padlock_session *ses, int locked);
70 static int padlock_process(device_t, struct cryptop *crp, int hint __unused);
72 MALLOC_DEFINE(M_PADLOCK, "padlock_data", "PadLock Data");
75 padlock_identify(driver_t *drv, device_t parent)
77 /* NB: order 10 is so we get attached after h/w devices */
78 if (device_find_child(parent, "padlock", -1) == NULL &&
79 BUS_ADD_CHILD(parent, 10, "padlock", -1) == 0)
80 panic("padlock: could not attach");
84 padlock_probe(device_t dev)
88 #if defined(__amd64__) || (defined(__i386__) && !defined(PC98))
89 /* If there is no AES support, we has nothing to do here. */
90 if (!(via_feature_xcrypt & VIA_HAS_AES)) {
91 device_printf(dev, "No ACE support.\n");
94 strlcpy(capp, "AES-CBC", sizeof(capp));
96 strlcat(capp, ",AES-EBC", sizeof(capp));
97 strlcat(capp, ",AES-CFB", sizeof(capp));
98 strlcat(capp, ",AES-OFB", sizeof(capp));
100 if (via_feature_xcrypt & VIA_HAS_SHA) {
101 strlcat(capp, ",SHA1", sizeof(capp));
102 strlcat(capp, ",SHA256", sizeof(capp));
105 if (via_feature_xcrypt & VIA_HAS_AESCTR)
106 strlcat(capp, ",AES-CTR", sizeof(capp));
107 if (via_feature_xcrypt & VIA_HAS_MM)
108 strlcat(capp, ",RSA", sizeof(capp));
110 device_set_desc_copy(dev, capp);
118 padlock_attach(device_t dev)
120 struct padlock_softc *sc = device_get_softc(dev);
122 TAILQ_INIT(&sc->sc_sessions);
125 sc->sc_cid = crypto_get_driverid(dev, CRYPTOCAP_F_HARDWARE);
126 if (sc->sc_cid < 0) {
127 device_printf(dev, "Could not get crypto driver id.\n");
131 rw_init(&sc->sc_sessions_lock, "padlock_lock");
132 crypto_register(sc->sc_cid, CRYPTO_AES_CBC, 0, 0);
133 crypto_register(sc->sc_cid, CRYPTO_MD5_HMAC, 0, 0);
134 crypto_register(sc->sc_cid, CRYPTO_SHA1_HMAC, 0, 0);
135 crypto_register(sc->sc_cid, CRYPTO_RIPEMD160_HMAC, 0, 0);
136 crypto_register(sc->sc_cid, CRYPTO_SHA2_256_HMAC, 0, 0);
137 crypto_register(sc->sc_cid, CRYPTO_SHA2_384_HMAC, 0, 0);
138 crypto_register(sc->sc_cid, CRYPTO_SHA2_512_HMAC, 0, 0);
143 padlock_detach(device_t dev)
145 struct padlock_softc *sc = device_get_softc(dev);
146 struct padlock_session *ses;
148 rw_wlock(&sc->sc_sessions_lock);
149 TAILQ_FOREACH(ses, &sc->sc_sessions, ses_next) {
151 rw_wunlock(&sc->sc_sessions_lock);
153 "Cannot detach, sessions still active.\n");
157 while ((ses = TAILQ_FIRST(&sc->sc_sessions)) != NULL) {
158 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next);
159 fpu_kern_free_ctx(ses->ses_fpu_ctx);
160 free(ses, M_PADLOCK);
162 rw_destroy(&sc->sc_sessions_lock);
163 crypto_unregister_all(sc->sc_cid);
168 padlock_newsession(device_t dev, uint32_t *sidp, struct cryptoini *cri)
170 struct padlock_softc *sc = device_get_softc(dev);
171 struct padlock_session *ses = NULL;
172 struct cryptoini *encini, *macini;
176 if (sidp == NULL || cri == NULL)
179 encini = macini = NULL;
180 for (; cri != NULL; cri = cri->cri_next) {
181 switch (cri->cri_alg) {
182 case CRYPTO_NULL_HMAC:
183 case CRYPTO_MD5_HMAC:
184 case CRYPTO_SHA1_HMAC:
185 case CRYPTO_RIPEMD160_HMAC:
186 case CRYPTO_SHA2_256_HMAC:
187 case CRYPTO_SHA2_384_HMAC:
188 case CRYPTO_SHA2_512_HMAC:
204 * We only support HMAC algorithms to be able to work with
205 * ipsec(4), so if we are asked only for authentication without
206 * encryption, don't pretend we can accellerate it.
212 * Let's look for a free session structure.
214 rw_wlock(&sc->sc_sessions_lock);
216 * Free sessions goes first, so if first session is used, we need to
219 ses = TAILQ_FIRST(&sc->sc_sessions);
220 if (ses == NULL || ses->ses_used) {
221 ses = malloc(sizeof(*ses), M_PADLOCK, M_NOWAIT | M_ZERO);
223 rw_wunlock(&sc->sc_sessions_lock);
226 ses->ses_fpu_ctx = fpu_kern_alloc_ctx(FPU_KERN_NORMAL |
228 if (ses->ses_fpu_ctx == NULL) {
229 free(ses, M_PADLOCK);
230 rw_wunlock(&sc->sc_sessions_lock);
233 ses->ses_id = sc->sc_sid++;
235 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next);
238 TAILQ_INSERT_TAIL(&sc->sc_sessions, ses, ses_next);
239 rw_wunlock(&sc->sc_sessions_lock);
241 error = padlock_cipher_setup(ses, encini);
243 padlock_freesession_one(sc, ses, 0);
247 if (macini != NULL) {
249 error = fpu_kern_enter(td, ses->ses_fpu_ctx, FPU_KERN_NORMAL |
252 error = padlock_hash_setup(ses, macini);
253 fpu_kern_leave(td, ses->ses_fpu_ctx);
256 padlock_freesession_one(sc, ses, 0);
266 padlock_freesession_one(struct padlock_softc *sc, struct padlock_session *ses,
269 struct fpu_kern_ctx *ctx;
270 uint32_t sid = ses->ses_id;
273 rw_wlock(&sc->sc_sessions_lock);
274 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next);
275 padlock_hash_free(ses);
276 ctx = ses->ses_fpu_ctx;
277 bzero(ses, sizeof(*ses));
280 ses->ses_fpu_ctx = ctx;
281 TAILQ_INSERT_HEAD(&sc->sc_sessions, ses, ses_next);
283 rw_wunlock(&sc->sc_sessions_lock);
287 padlock_freesession(device_t dev, uint64_t tid)
289 struct padlock_softc *sc = device_get_softc(dev);
290 struct padlock_session *ses;
291 uint32_t sid = ((uint32_t)tid) & 0xffffffff;
293 rw_wlock(&sc->sc_sessions_lock);
294 TAILQ_FOREACH_REVERSE(ses, &sc->sc_sessions, padlock_sessions_head,
296 if (ses->ses_id == sid)
300 rw_wunlock(&sc->sc_sessions_lock);
303 padlock_freesession_one(sc, ses, 1);
304 rw_wunlock(&sc->sc_sessions_lock);
309 padlock_process(device_t dev, struct cryptop *crp, int hint __unused)
311 struct padlock_softc *sc = device_get_softc(dev);
312 struct padlock_session *ses = NULL;
313 struct cryptodesc *crd, *enccrd, *maccrd;
316 enccrd = maccrd = NULL;
322 if (crp->crp_callback == NULL || crp->crp_desc == NULL) {
327 for (crd = crp->crp_desc; crd != NULL; crd = crd->crd_next) {
328 switch (crd->crd_alg) {
329 case CRYPTO_NULL_HMAC:
330 case CRYPTO_MD5_HMAC:
331 case CRYPTO_SHA1_HMAC:
332 case CRYPTO_RIPEMD160_HMAC:
333 case CRYPTO_SHA2_256_HMAC:
334 case CRYPTO_SHA2_384_HMAC:
335 case CRYPTO_SHA2_512_HMAC:
336 if (maccrd != NULL) {
343 if (enccrd != NULL) {
353 if (enccrd == NULL || (enccrd->crd_len % AES_BLOCK_LEN) != 0) {
358 rw_rlock(&sc->sc_sessions_lock);
359 TAILQ_FOREACH_REVERSE(ses, &sc->sc_sessions, padlock_sessions_head,
361 if (ses->ses_id == (crp->crp_sid & 0xffffffff))
364 rw_runlock(&sc->sc_sessions_lock);
370 /* Perform data authentication if requested before encryption. */
371 if (maccrd != NULL && maccrd->crd_next == enccrd) {
372 error = padlock_hash_process(ses, maccrd, crp);
377 error = padlock_cipher_process(ses, enccrd, crp);
381 /* Perform data authentication if requested after encryption. */
382 if (maccrd != NULL && enccrd->crd_next == maccrd) {
383 error = padlock_hash_process(ses, maccrd, crp);
391 * This code is not necessary, because contexts will be freed on next
392 * padlock_setup_mackey() call or at padlock_freesession() call.
394 if (ses != NULL && maccrd != NULL &&
395 (maccrd->crd_flags & CRD_F_KEY_EXPLICIT) != 0) {
396 padlock_free_ctx(ses->ses_axf, ses->ses_ictx);
397 padlock_free_ctx(ses->ses_axf, ses->ses_octx);
400 crp->crp_etype = error;
405 static device_method_t padlock_methods[] = {
406 DEVMETHOD(device_identify, padlock_identify),
407 DEVMETHOD(device_probe, padlock_probe),
408 DEVMETHOD(device_attach, padlock_attach),
409 DEVMETHOD(device_detach, padlock_detach),
411 DEVMETHOD(cryptodev_newsession, padlock_newsession),
412 DEVMETHOD(cryptodev_freesession,padlock_freesession),
413 DEVMETHOD(cryptodev_process, padlock_process),
418 static driver_t padlock_driver = {
421 sizeof(struct padlock_softc),
423 static devclass_t padlock_devclass;
425 /* XXX where to attach */
426 DRIVER_MODULE(padlock, nexus, padlock_driver, padlock_devclass, 0, 0);
427 MODULE_VERSION(padlock, 1);
428 MODULE_DEPEND(padlock, crypto, 1, 1, 1);