1 /*- 2 * Copyright (c) 2005-2008 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD: src/sys/crypto/via/padlock.c,v 1.23 2009/02/05 19:30:28 imp Exp $ 27 */ 28 29 #include <sys/param.h> 30 #include <sys/systm.h> 31 #include <sys/kernel.h> 32 #include <sys/module.h> 33 #include <sys/lock.h> 34 #include <sys/spinlock.h> 35 #include <sys/spinlock2.h> 36 #include <sys/malloc.h> 37 #include <sys/libkern.h> 38 #if defined(__x86_64__) || defined(__i386__) 39 #include <machine/cpufunc.h> 40 #include <machine/cputypes.h> 41 #include <machine/md_var.h> 42 #include <machine/specialreg.h> 43 #endif 44 45 #include <opencrypto/cryptodev.h> 46 47 #include <dev/crypto/padlock/padlock.h> 48 49 #include <sys/kobj.h> 50 #include <sys/bus.h> 51 #include "cryptodev_if.h" 52 53 /* 54 * Technical documentation about the PadLock engine can be found here: 55 * 56 * http://www.via.com.tw/en/downloads/whitepapers/initiatives/padlock/programming_guide.pdf 57 */ 58 59 static int padlock_newsession(device_t, uint32_t *sidp, struct cryptoini *cri); 60 static int padlock_freesession(device_t, uint64_t tid); 61 static void padlock_freesession_one(struct padlock_softc *sc, 62 struct padlock_session *ses, int locked); 63 static int padlock_process(device_t, struct cryptop *crp, int hint __unused); 64 65 MALLOC_DEFINE(M_PADLOCK, "padlock_data", "PadLock Data"); 66 67 static void 68 padlock_identify(driver_t *drv, device_t parent) 69 { 70 /* NB: order 10 is so we get attached after h/w devices */ 71 /* XXX: wouldn't bet about this BUS_ADD_CHILD correctness */ 72 if (device_find_child(parent, "padlock", -1) == NULL && 73 BUS_ADD_CHILD(parent, parent, 10, "padlock", -1) == 0) 74 panic("padlock: could not attach"); 75 } 76 77 static int 78 padlock_probe(device_t dev) 79 { 80 char capp[256]; 81 82 #if defined(__x86_64__) || defined(__i386__) 83 /* If there is no AES support, we has nothing to do here. */ 84 if (!(via_feature_xcrypt & VIA_HAS_AES)) { 85 device_printf(dev, "No ACE support.\n"); 86 return (EINVAL); 87 } 88 strlcpy(capp, "AES-CBC", sizeof(capp)); 89 #if 0 90 strlcat(capp, ",AES-EBC", sizeof(capp)); 91 strlcat(capp, ",AES-CFB", sizeof(capp)); 92 strlcat(capp, ",AES-OFB", sizeof(capp)); 93 #endif 94 if (via_feature_xcrypt & VIA_HAS_SHA) { 95 strlcat(capp, ",SHA1", sizeof(capp)); 96 strlcat(capp, ",SHA256", sizeof(capp)); 97 } 98 #if 0 99 if (via_feature_xcrypt & VIA_HAS_AESCTR) 100 strlcat(capp, ",AES-CTR", sizeof(capp)); 101 if (via_feature_xcrypt & VIA_HAS_MM) 102 strlcat(capp, ",RSA", sizeof(capp)); 103 #endif 104 105 if (via_feature_rng & VIA_HAS_RNG) 106 strlcat(capp, ",RNG", sizeof(capp)); 107 108 device_set_desc_copy(dev, capp); 109 return (0); 110 #else 111 return (EINVAL); 112 #endif 113 } 114 115 static int 116 padlock_attach(device_t dev) 117 { 118 struct padlock_softc *sc = device_get_softc(dev); 119 120 TAILQ_INIT(&sc->sc_sessions); 121 sc->sc_sid = 1; 122 123 sc->sc_cid = crypto_get_driverid(dev, CRYPTOCAP_F_HARDWARE); 124 if (sc->sc_cid < 0) { 125 device_printf(dev, "Could not get crypto driver id.\n"); 126 return (ENOMEM); 127 } 128 129 spin_init(&sc->sc_sessions_lock, "padlock"); 130 crypto_register(sc->sc_cid, CRYPTO_AES_CBC, 0, 0); 131 crypto_register(sc->sc_cid, CRYPTO_MD5_HMAC, 0, 0); 132 crypto_register(sc->sc_cid, CRYPTO_SHA1_HMAC, 0, 0); 133 crypto_register(sc->sc_cid, CRYPTO_RIPEMD160_HMAC, 0, 0); 134 crypto_register(sc->sc_cid, CRYPTO_SHA2_256_HMAC, 0, 0); 135 crypto_register(sc->sc_cid, CRYPTO_SHA2_384_HMAC, 0, 0); 136 crypto_register(sc->sc_cid, CRYPTO_SHA2_512_HMAC, 0, 0); 137 138 if (via_feature_rng & VIA_HAS_RNG) 139 padlock_rng_init(sc); 140 141 return (0); 142 } 143 144 static int 145 padlock_detach(device_t dev) 146 { 147 struct padlock_softc *sc = device_get_softc(dev); 148 struct padlock_session *ses; 149 150 spin_lock(&sc->sc_sessions_lock); 151 TAILQ_FOREACH(ses, &sc->sc_sessions, ses_next) { 152 if (ses->ses_used) { 153 spin_unlock(&sc->sc_sessions_lock); 154 device_printf(dev, 155 "Cannot detach, sessions still active.\n"); 156 return (EBUSY); 157 } 158 } 159 while ((ses = TAILQ_FIRST(&sc->sc_sessions)) != NULL) { 160 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next); 161 kfree(ses->ses_freeaddr, M_PADLOCK); 162 } 163 spin_unlock(&sc->sc_sessions_lock); 164 spin_uninit(&sc->sc_sessions_lock); 165 crypto_unregister_all(sc->sc_cid); 166 167 if (via_feature_rng & VIA_HAS_RNG) 168 padlock_rng_uninit(sc); 169 170 return (0); 171 } 172 173 static int 174 padlock_newsession(device_t dev, uint32_t *sidp, struct cryptoini *cri) 175 { 176 struct padlock_softc *sc = device_get_softc(dev); 177 struct padlock_session *ases, *ses = NULL; 178 struct cryptoini *encini, *macini; 179 int error; 180 181 if (sidp == NULL || cri == NULL) 182 return (EINVAL); 183 184 encini = macini = NULL; 185 for (; cri != NULL; cri = cri->cri_next) { 186 switch (cri->cri_alg) { 187 case CRYPTO_NULL_HMAC: 188 case CRYPTO_MD5_HMAC: 189 case CRYPTO_SHA1_HMAC: 190 case CRYPTO_RIPEMD160_HMAC: 191 case CRYPTO_SHA2_256_HMAC: 192 case CRYPTO_SHA2_384_HMAC: 193 case CRYPTO_SHA2_512_HMAC: 194 if (macini != NULL) 195 return (EINVAL); 196 macini = cri; 197 break; 198 case CRYPTO_AES_CBC: 199 if (encini != NULL) 200 return (EINVAL); 201 encini = cri; 202 break; 203 default: 204 return (EINVAL); 205 } 206 } 207 208 /* 209 * We only support HMAC algorithms to be able to work with 210 * ipsec(4), so if we are asked only for authentication without 211 * encryption, don't pretend we can accellerate it. 212 */ 213 if (encini == NULL) 214 return (EINVAL); 215 216 /* 217 * Let's look for a free session structure. 218 */ 219 spin_lock(&sc->sc_sessions_lock); 220 /* 221 * Free sessions goes first, so if first session is used, we need to 222 * allocate one. 223 */ 224 ses = TAILQ_FIRST(&sc->sc_sessions); 225 if (ses == NULL || ses->ses_used) { 226 ses = kmalloc(sizeof(*ses) + 16, M_PADLOCK, M_NOWAIT | M_ZERO); 227 if (ses == NULL) { 228 spin_unlock(&sc->sc_sessions_lock); 229 return (ENOMEM); 230 } 231 /* Check if 'ses' is 16-byte aligned. If not, align it. */ 232 if (((uintptr_t)ses & 0xf) != 0) { 233 ases = PADLOCK_ALIGN(ses); 234 ases->ses_freeaddr = ses; 235 ses = ases; 236 } else { 237 ses->ses_freeaddr = ses; 238 } 239 ses->ses_id = sc->sc_sid++; 240 } else { 241 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next); 242 } 243 ses->ses_used = 1; 244 TAILQ_INSERT_TAIL(&sc->sc_sessions, ses, ses_next); 245 spin_unlock(&sc->sc_sessions_lock); 246 247 error = padlock_cipher_setup(ses, encini); 248 if (error != 0) { 249 padlock_freesession_one(sc, ses, 0); 250 return (error); 251 } 252 253 if (macini != NULL) { 254 error = padlock_hash_setup(ses, macini); 255 if (error != 0) { 256 padlock_freesession_one(sc, ses, 0); 257 return (error); 258 } 259 } 260 261 *sidp = ses->ses_id; 262 return (0); 263 } 264 265 static void 266 padlock_freesession_one(struct padlock_softc *sc, struct padlock_session *ses, 267 int locked) 268 { 269 uint32_t sid = ses->ses_id; 270 void *freeaddr = ses->ses_freeaddr; 271 272 if (!locked) 273 spin_lock(&sc->sc_sessions_lock); 274 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next); 275 padlock_hash_free(ses); 276 bzero(ses, sizeof(*ses)); 277 ses->ses_used = 0; 278 ses->ses_id = sid; 279 ses->ses_freeaddr = freeaddr; 280 TAILQ_INSERT_HEAD(&sc->sc_sessions, ses, ses_next); 281 if (!locked) 282 spin_unlock(&sc->sc_sessions_lock); 283 } 284 285 static int 286 padlock_freesession(device_t dev, uint64_t tid) 287 { 288 struct padlock_softc *sc = device_get_softc(dev); 289 struct padlock_session *ses; 290 uint32_t sid = ((uint32_t)tid) & 0xffffffff; 291 292 spin_lock(&sc->sc_sessions_lock); 293 TAILQ_FOREACH_REVERSE(ses, &sc->sc_sessions, padlock_sessions_head, 294 ses_next) { 295 if (ses->ses_id == sid) 296 break; 297 } 298 if (ses == NULL) { 299 spin_unlock(&sc->sc_sessions_lock); 300 return (EINVAL); 301 } 302 padlock_freesession_one(sc, ses, 1); 303 spin_unlock(&sc->sc_sessions_lock); 304 return (0); 305 } 306 307 static int 308 padlock_process(device_t dev, struct cryptop *crp, int hint __unused) 309 { 310 struct padlock_softc *sc = device_get_softc(dev); 311 struct padlock_session *ses = NULL; 312 struct cryptodesc *crd, *enccrd, *maccrd; 313 int error = 0; 314 315 enccrd = maccrd = NULL; 316 317 /* Sanity check. */ 318 if (crp == NULL) 319 return (EINVAL); 320 321 if (crp->crp_callback == NULL || crp->crp_desc == NULL) { 322 error = EINVAL; 323 goto out; 324 } 325 326 for (crd = crp->crp_desc; crd != NULL; crd = crd->crd_next) { 327 switch (crd->crd_alg) { 328 case CRYPTO_NULL_HMAC: 329 case CRYPTO_MD5_HMAC: 330 case CRYPTO_SHA1_HMAC: 331 case CRYPTO_RIPEMD160_HMAC: 332 case CRYPTO_SHA2_256_HMAC: 333 case CRYPTO_SHA2_384_HMAC: 334 case CRYPTO_SHA2_512_HMAC: 335 if (maccrd != NULL) { 336 error = EINVAL; 337 goto out; 338 } 339 maccrd = crd; 340 break; 341 case CRYPTO_AES_CBC: 342 if (enccrd != NULL) { 343 error = EINVAL; 344 goto out; 345 } 346 enccrd = crd; 347 break; 348 default: 349 return (EINVAL); 350 } 351 } 352 if (enccrd == NULL || (enccrd->crd_len % AES_BLOCK_LEN) != 0) { 353 error = EINVAL; 354 goto out; 355 } 356 357 spin_lock(&sc->sc_sessions_lock); /* XXX: was rd lock */ 358 TAILQ_FOREACH_REVERSE(ses, &sc->sc_sessions, padlock_sessions_head, 359 ses_next) { 360 if (ses->ses_id == (crp->crp_sid & 0xffffffff)) 361 break; 362 } 363 spin_unlock(&sc->sc_sessions_lock); /* XXX: was rd lock */ 364 if (ses == NULL) { 365 error = EINVAL; 366 goto out; 367 } 368 369 /* Perform data authentication if requested before encryption. */ 370 if (maccrd != NULL && maccrd->crd_next == enccrd) { 371 error = padlock_hash_process(ses, maccrd, crp); 372 if (error != 0) 373 goto out; 374 } 375 376 error = padlock_cipher_process(ses, enccrd, crp); 377 if (error != 0) 378 goto out; 379 380 /* Perform data authentication if requested after encryption. */ 381 if (maccrd != NULL && enccrd->crd_next == maccrd) { 382 error = padlock_hash_process(ses, maccrd, crp); 383 if (error != 0) 384 goto out; 385 } 386 387 out: 388 #if 0 389 /* 390 * This code is not necessary, because contexts will be freed on next 391 * padlock_setup_mackey() call or at padlock_freesession() call. 392 */ 393 if (ses != NULL && maccrd != NULL && 394 (maccrd->crd_flags & CRD_F_KEY_EXPLICIT) != 0) { 395 padlock_free_ctx(ses->ses_axf, ses->ses_ictx); 396 padlock_free_ctx(ses->ses_axf, ses->ses_octx); 397 } 398 #endif 399 crp->crp_etype = error; 400 crypto_done(crp); 401 return (error); 402 } 403 404 static device_method_t padlock_methods[] = { 405 DEVMETHOD(device_identify, padlock_identify), 406 DEVMETHOD(device_probe, padlock_probe), 407 DEVMETHOD(device_attach, padlock_attach), 408 DEVMETHOD(device_detach, padlock_detach), 409 410 DEVMETHOD(cryptodev_newsession, padlock_newsession), 411 DEVMETHOD(cryptodev_freesession,padlock_freesession), 412 DEVMETHOD(cryptodev_process, padlock_process), 413 414 DEVMETHOD_END 415 }; 416 417 static driver_t padlock_driver = { 418 "padlock", 419 padlock_methods, 420 sizeof(struct padlock_softc), 421 }; 422 static devclass_t padlock_devclass; 423 424 /* XXX where to attach */ 425 DRIVER_MODULE(padlock, nexus, padlock_driver, padlock_devclass, NULL, NULL); 426 MODULE_VERSION(padlock, 1); 427 MODULE_DEPEND(padlock, crypto, 1, 1, 1); 428