drivers/crypto/xilinx/zynqmp-aes-gcm.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Xilinx ZynqMP AES Driver.
   4  * Copyright (c) 2020 Xilinx Inc.
   5  */
   6
   7 #include <crypto/aes.h>
   8 #include <crypto/engine.h>
   9 #include <crypto/gcm.h>
  10 #include <crypto/internal/aead.h>
  11 #include <crypto/scatterwalk.h>
  12
  13 #include <linux/dma-mapping.h>
  14 #include <linux/module.h>
  15 #include <linux/of_device.h>
  16 #include <linux/platform_device.h>
  17
  18 #include <linux/firmware/xlnx-zynqmp.h>
  19
  20 #define ZYNQMP_DMA_BIT_MASK     32U
  21
  22 #define ZYNQMP_AES_KEY_SIZE             AES_KEYSIZE_256
  23 #define ZYNQMP_AES_AUTH_SIZE            16U
  24 #define ZYNQMP_KEY_SRC_SEL_KEY_LEN      1U
  25 #define ZYNQMP_AES_BLK_SIZE             1U
  26 #define ZYNQMP_AES_MIN_INPUT_BLK_SIZE   4U
  27 #define ZYNQMP_AES_WORD_LEN             4U
  28
  29 #define ZYNQMP_AES_GCM_TAG_MISMATCH_ERR         0x01
  30 #define ZYNQMP_AES_WRONG_KEY_SRC_ERR            0x13
  31 #define ZYNQMP_AES_PUF_NOT_PROGRAMMED           0xE300
  32
  33 enum zynqmp_aead_op {
  34         ZYNQMP_AES_DECRYPT = 0,
  35         ZYNQMP_AES_ENCRYPT
  36 };
  37
  38 enum zynqmp_aead_keysrc {
  39         ZYNQMP_AES_KUP_KEY = 0,
  40         ZYNQMP_AES_DEV_KEY,
  41         ZYNQMP_AES_PUF_KEY
  42 };
  43
  44 struct zynqmp_aead_drv_ctx {
  45         union {
  46                 struct aead_alg aead;
  47         } alg;
  48         struct device *dev;
  49         struct crypto_engine *engine;
  50 };
  51
  52 struct zynqmp_aead_hw_req {
  53         u64 src;
  54         u64 iv;
  55         u64 key;
  56         u64 dst;
  57         u64 size;
  58         u64 op;
  59         u64 keysrc;
  60 };
  61
  62 struct zynqmp_aead_tfm_ctx {
  63         struct crypto_engine_ctx engine_ctx;
  64         struct device *dev;
  65         u8 key[ZYNQMP_AES_KEY_SIZE];
  66         u8 *iv;
  67         u32 keylen;
  68         u32 authsize;
  69         enum zynqmp_aead_keysrc keysrc;
  70         struct crypto_aead *fbk_cipher;
  71 };
  72
  73 struct zynqmp_aead_req_ctx {
  74         enum zynqmp_aead_op op;
  75 };
  76
  77 static int zynqmp_aes_aead_cipher(struct aead_request *req)
  78 {
  79         struct crypto_aead *aead = crypto_aead_reqtfm(req);
  80         struct zynqmp_aead_tfm_ctx *tfm_ctx = crypto_aead_ctx(aead);
  81         struct zynqmp_aead_req_ctx *rq_ctx = aead_request_ctx(req);
  82         struct device *dev = tfm_ctx->dev;
  83         struct zynqmp_aead_hw_req *hwreq;
  84         dma_addr_t dma_addr_data, dma_addr_hw_req;
  85         unsigned int data_size;
  86         unsigned int status;
  87         int ret;
  88         size_t dma_size;
  89         char *kbuf;
  90         int err;
  91
  92         if (tfm_ctx->keysrc == ZYNQMP_AES_KUP_KEY)
  93                 dma_size = req->cryptlen + ZYNQMP_AES_KEY_SIZE
  94                            + GCM_AES_IV_SIZE;
  95         else
  96                 dma_size = req->cryptlen + GCM_AES_IV_SIZE;
  97
  98         kbuf = dma_alloc_coherent(dev, dma_size, &dma_addr_data, GFP_KERNEL);
  99         if (!kbuf)
 100                 return -ENOMEM;
 101
 102         hwreq = dma_alloc_coherent(dev, sizeof(struct zynqmp_aead_hw_req),
 103                                    &dma_addr_hw_req, GFP_KERNEL);
 104         if (!hwreq) {
 105                 dma_free_coherent(dev, dma_size, kbuf, dma_addr_data);
 106                 return -ENOMEM;
 107         }
 108
 109         data_size = req->cryptlen;
 110         scatterwalk_map_and_copy(kbuf, req->src, 0, req->cryptlen, 0);
 111         memcpy(kbuf + data_size, req->iv, GCM_AES_IV_SIZE);
 112
 113         hwreq->src = dma_addr_data;
 114         hwreq->dst = dma_addr_data;
 115         hwreq->iv = hwreq->src + data_size;
 116         hwreq->keysrc = tfm_ctx->keysrc;
 117         hwreq->op = rq_ctx->op;
 118
 119         if (hwreq->op == ZYNQMP_AES_ENCRYPT)
 120                 hwreq->size = data_size;
 121         else
 122                 hwreq->size = data_size - ZYNQMP_AES_AUTH_SIZE;
 123
 124         if (hwreq->keysrc == ZYNQMP_AES_KUP_KEY) {
 125                 memcpy(kbuf + data_size + GCM_AES_IV_SIZE,
 126                        tfm_ctx->key, ZYNQMP_AES_KEY_SIZE);
 127
 128                 hwreq->key = hwreq->src + data_size + GCM_AES_IV_SIZE;
 129         } else {
 130                 hwreq->key = 0;
 131         }
 132
 133         ret = zynqmp_pm_aes_engine(dma_addr_hw_req, &status);
 134
 135         if (ret) {
 136                 dev_err(dev, "ERROR: AES PM API failed\n");
 137                 err = ret;
 138         } else if (status) {
 139                 switch (status) {
 140                 case ZYNQMP_AES_GCM_TAG_MISMATCH_ERR:
 141                         dev_err(dev, "ERROR: Gcm Tag mismatch\n");
 142                         break;
 143                 case ZYNQMP_AES_WRONG_KEY_SRC_ERR:
 144                         dev_err(dev, "ERROR: Wrong KeySrc, enable secure mode\n");
 145                         break;
 146                 case ZYNQMP_AES_PUF_NOT_PROGRAMMED:
 147                         dev_err(dev, "ERROR: PUF is not registered\n");
 148                         break;
 149                 default:
 150                         dev_err(dev, "ERROR: Unknown error\n");
 151                         break;
 152                 }
 153                 err = -status;
 154         } else {
 155                 if (hwreq->op == ZYNQMP_AES_ENCRYPT)
 156                         data_size = data_size + ZYNQMP_AES_AUTH_SIZE;
 157                 else
 158                         data_size = data_size - ZYNQMP_AES_AUTH_SIZE;
 159
 160                 sg_copy_from_buffer(req->dst, sg_nents(req->dst),
 161                                     kbuf, data_size);
 162                 err = 0;
 163         }
 164
 165         if (kbuf) {
 166                 memzero_explicit(kbuf, dma_size);
 167                 dma_free_coherent(dev, dma_size, kbuf, dma_addr_data);
 168         }
 169         if (hwreq) {
 170                 memzero_explicit(hwreq, sizeof(struct zynqmp_aead_hw_req));
 171                 dma_free_coherent(dev, sizeof(struct zynqmp_aead_hw_req),
 172                                   hwreq, dma_addr_hw_req);
 173         }
 174         return err;
 175 }
 176
 177 static int zynqmp_fallback_check(struct zynqmp_aead_tfm_ctx *tfm_ctx,
 178                                  struct aead_request *req)
 179 {
 180         int need_fallback = 0;
 181         struct zynqmp_aead_req_ctx *rq_ctx = aead_request_ctx(req);
 182
 183         if (tfm_ctx->authsize != ZYNQMP_AES_AUTH_SIZE)
 184                 need_fallback = 1;
 185
 186         if (tfm_ctx->keysrc == ZYNQMP_AES_KUP_KEY &&
 187             tfm_ctx->keylen != ZYNQMP_AES_KEY_SIZE) {
 188                 need_fallback = 1;
 189         }
 190         if (req->assoclen != 0 ||
 191             req->cryptlen < ZYNQMP_AES_MIN_INPUT_BLK_SIZE) {
 192                 need_fallback = 1;
 193         }
 194         if ((req->cryptlen % ZYNQMP_AES_WORD_LEN) != 0)
 195                 need_fallback = 1;
 196
 197         if (rq_ctx->op == ZYNQMP_AES_DECRYPT &&
 198             req->cryptlen <= ZYNQMP_AES_AUTH_SIZE) {
 199                 need_fallback = 1;
 200         }
 201         return need_fallback;
 202 }
 203
 204 static int zynqmp_handle_aes_req(struct crypto_engine *engine,
 205                                  void *req)
 206 {
 207         struct aead_request *areq =
 208                                 container_of(req, struct aead_request, base);
 209         struct crypto_aead *aead = crypto_aead_reqtfm(req);
 210         struct zynqmp_aead_tfm_ctx *tfm_ctx = crypto_aead_ctx(aead);
 211         struct zynqmp_aead_req_ctx *rq_ctx = aead_request_ctx(areq);
 212         struct aead_request *subreq = aead_request_ctx(req);
 213         int need_fallback;
 214         int err;
 215
 216         need_fallback = zynqmp_fallback_check(tfm_ctx, areq);
 217
 218         if (need_fallback) {
 219                 aead_request_set_tfm(subreq, tfm_ctx->fbk_cipher);
 220
 221                 aead_request_set_callback(subreq, areq->base.flags,
 222                                           NULL, NULL);
 223                 aead_request_set_crypt(subreq, areq->src, areq->dst,
 224                                        areq->cryptlen, areq->iv);
 225                 aead_request_set_ad(subreq, areq->assoclen);
 226                 if (rq_ctx->op == ZYNQMP_AES_ENCRYPT)
 227                         err = crypto_aead_encrypt(subreq);
 228                 else
 229                         err = crypto_aead_decrypt(subreq);
 230         } else {
 231                 err = zynqmp_aes_aead_cipher(areq);
 232         }
 233
 234         local_bh_disable();
 235         crypto_finalize_aead_request(engine, areq, err);
 236         local_bh_enable();
 237
 238         return 0;
 239 }
 240
 241 static int zynqmp_aes_aead_setkey(struct crypto_aead *aead, const u8 *key,
 242                                   unsigned int keylen)
 243 {
 244         struct crypto_tfm *tfm = crypto_aead_tfm(aead);
 245         struct zynqmp_aead_tfm_ctx *tfm_ctx =
 246                         (struct zynqmp_aead_tfm_ctx *)crypto_tfm_ctx(tfm);
 247         unsigned char keysrc;
 248
 249         if (keylen == ZYNQMP_KEY_SRC_SEL_KEY_LEN) {
 250                 keysrc = *key;
 251                 if (keysrc == ZYNQMP_AES_KUP_KEY ||
 252                     keysrc == ZYNQMP_AES_DEV_KEY ||
 253                     keysrc == ZYNQMP_AES_PUF_KEY) {
 254                         tfm_ctx->keysrc = (enum zynqmp_aead_keysrc)keysrc;
 255                 } else {
 256                         tfm_ctx->keylen = keylen;
 257                 }
 258         } else {
 259                 tfm_ctx->keylen = keylen;
 260                 if (keylen == ZYNQMP_AES_KEY_SIZE) {
 261                         tfm_ctx->keysrc = ZYNQMP_AES_KUP_KEY;
 262                         memcpy(tfm_ctx->key, key, keylen);
 263                 }
 264         }
 265
 266         tfm_ctx->fbk_cipher->base.crt_flags &= ~CRYPTO_TFM_REQ_MASK;
 267         tfm_ctx->fbk_cipher->base.crt_flags |= (aead->base.crt_flags &
 268                                         CRYPTO_TFM_REQ_MASK);
 269
 270         return crypto_aead_setkey(tfm_ctx->fbk_cipher, key, keylen);
 271 }
 272
 273 static int zynqmp_aes_aead_setauthsize(struct crypto_aead *aead,
 274                                        unsigned int authsize)
 275 {
 276         struct crypto_tfm *tfm = crypto_aead_tfm(aead);
 277         struct zynqmp_aead_tfm_ctx *tfm_ctx =
 278                         (struct zynqmp_aead_tfm_ctx *)crypto_tfm_ctx(tfm);
 279
 280         tfm_ctx->authsize = authsize;
 281         return crypto_aead_setauthsize(tfm_ctx->fbk_cipher, authsize);
 282 }
 283
 284 static int zynqmp_aes_aead_encrypt(struct aead_request *req)
 285 {
 286         struct zynqmp_aead_drv_ctx *drv_ctx;
 287         struct crypto_aead *aead = crypto_aead_reqtfm(req);
 288         struct aead_alg *alg = crypto_aead_alg(aead);
 289         struct zynqmp_aead_req_ctx *rq_ctx = aead_request_ctx(req);
 290
 291         rq_ctx->op = ZYNQMP_AES_ENCRYPT;
 292         drv_ctx = container_of(alg, struct zynqmp_aead_drv_ctx, alg.aead);
 293
 294         return crypto_transfer_aead_request_to_engine(drv_ctx->engine, req);
 295 }
 296
 297 static int zynqmp_aes_aead_decrypt(struct aead_request *req)
 298 {
 299         struct zynqmp_aead_drv_ctx *drv_ctx;
 300         struct crypto_aead *aead = crypto_aead_reqtfm(req);
 301         struct aead_alg *alg = crypto_aead_alg(aead);
 302         struct zynqmp_aead_req_ctx *rq_ctx = aead_request_ctx(req);
 303
 304         rq_ctx->op = ZYNQMP_AES_DECRYPT;
 305         drv_ctx = container_of(alg, struct zynqmp_aead_drv_ctx, alg.aead);
 306
 307         return crypto_transfer_aead_request_to_engine(drv_ctx->engine, req);
 308 }
 309
 310 static int zynqmp_aes_aead_init(struct crypto_aead *aead)
 311 {
 312         struct crypto_tfm *tfm = crypto_aead_tfm(aead);
 313         struct zynqmp_aead_tfm_ctx *tfm_ctx =
 314                 (struct zynqmp_aead_tfm_ctx *)crypto_tfm_ctx(tfm);
 315         struct zynqmp_aead_drv_ctx *drv_ctx;
 316         struct aead_alg *alg = crypto_aead_alg(aead);
 317
 318         drv_ctx = container_of(alg, struct zynqmp_aead_drv_ctx, alg.aead);
 319         tfm_ctx->dev = drv_ctx->dev;
 320
 321         tfm_ctx->engine_ctx.op.do_one_request = zynqmp_handle_aes_req;
 322         tfm_ctx->engine_ctx.op.prepare_request = NULL;
 323         tfm_ctx->engine_ctx.op.unprepare_request = NULL;
 324
 325         tfm_ctx->fbk_cipher = crypto_alloc_aead(drv_ctx->alg.aead.base.cra_name,
 326                                                 0,
 327                                                 CRYPTO_ALG_NEED_FALLBACK);
 328
 329         if (IS_ERR(tfm_ctx->fbk_cipher)) {
 330                 pr_err("%s() Error: failed to allocate fallback for %s\n",
 331                        __func__, drv_ctx->alg.aead.base.cra_name);
 332                 return PTR_ERR(tfm_ctx->fbk_cipher);
 333         }
 334
 335         crypto_aead_set_reqsize(aead,
 336                                 max(sizeof(struct zynqmp_aead_req_ctx),
 337                                     sizeof(struct aead_request) +
 338                                     crypto_aead_reqsize(tfm_ctx->fbk_cipher)));
 339         return 0;
 340 }
 341
 342 static void zynqmp_aes_aead_exit(struct crypto_aead *aead)
 343 {
 344         struct crypto_tfm *tfm = crypto_aead_tfm(aead);
 345         struct zynqmp_aead_tfm_ctx *tfm_ctx =
 346                         (struct zynqmp_aead_tfm_ctx *)crypto_tfm_ctx(tfm);
 347
 348         if (tfm_ctx->fbk_cipher) {
 349                 crypto_free_aead(tfm_ctx->fbk_cipher);
 350                 tfm_ctx->fbk_cipher = NULL;
 351         }
 352         memzero_explicit(tfm_ctx, sizeof(struct zynqmp_aead_tfm_ctx));
 353 }
 354
 355 static struct zynqmp_aead_drv_ctx aes_drv_ctx = {
 356         .alg.aead = {
 357                 .setkey         = zynqmp_aes_aead_setkey,
 358                 .setauthsize    = zynqmp_aes_aead_setauthsize,
 359                 .encrypt        = zynqmp_aes_aead_encrypt,
 360                 .decrypt        = zynqmp_aes_aead_decrypt,
 361                 .init           = zynqmp_aes_aead_init,
 362                 .exit           = zynqmp_aes_aead_exit,
 363                 .ivsize         = GCM_AES_IV_SIZE,
 364                 .maxauthsize    = ZYNQMP_AES_AUTH_SIZE,
 365                 .base = {
 366                 .cra_name               = "gcm(aes)",
 367                 .cra_driver_name        = "xilinx-zynqmp-aes-gcm",
 368                 .cra_priority           = 200,
 369                 .cra_flags              = CRYPTO_ALG_TYPE_AEAD |
 370                                           CRYPTO_ALG_ASYNC |
 371                                           CRYPTO_ALG_ALLOCATES_MEMORY |
 372                                           CRYPTO_ALG_KERN_DRIVER_ONLY |
 373                                           CRYPTO_ALG_NEED_FALLBACK,
 374                 .cra_blocksize          = ZYNQMP_AES_BLK_SIZE,
 375                 .cra_ctxsize            = sizeof(struct zynqmp_aead_tfm_ctx),
 376                 .cra_module             = THIS_MODULE,
 377                 }
 378         }
 379 };
 380
 381 static int zynqmp_aes_aead_probe(struct platform_device *pdev)
 382 {
 383         struct device *dev = &pdev->dev;
 384         int err;
 385
 386         /* ZynqMP AES driver supports only one instance */
 387         if (!aes_drv_ctx.dev)
 388                 aes_drv_ctx.dev = dev;
 389         else
 390                 return -ENODEV;
 391
 392         err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(ZYNQMP_DMA_BIT_MASK));
 393         if (err < 0) {
 394                 dev_err(dev, "No usable DMA configuration\n");
 395                 return err;
 396         }
 397
 398         aes_drv_ctx.engine = crypto_engine_alloc_init(dev, 1);
 399         if (!aes_drv_ctx.engine) {
 400                 dev_err(dev, "Cannot alloc AES engine\n");
 401                 err = -ENOMEM;
 402                 goto err_engine;
 403         }
 404
 405         err = crypto_engine_start(aes_drv_ctx.engine);
 406         if (err) {
 407                 dev_err(dev, "Cannot start AES engine\n");
 408                 goto err_engine;
 409         }
 410
 411         err = crypto_register_aead(&aes_drv_ctx.alg.aead);
 412         if (err < 0) {
 413                 dev_err(dev, "Failed to register AEAD alg.\n");
 414                 goto err_aead;
 415         }
 416         return 0;
 417
 418 err_aead:
 419         crypto_unregister_aead(&aes_drv_ctx.alg.aead);
 420
 421 err_engine:
 422         if (aes_drv_ctx.engine)
 423                 crypto_engine_exit(aes_drv_ctx.engine);
 424
 425         return err;
 426 }
 427
 428 static int zynqmp_aes_aead_remove(struct platform_device *pdev)
 429 {
 430         crypto_engine_exit(aes_drv_ctx.engine);
 431         crypto_unregister_aead(&aes_drv_ctx.alg.aead);
 432
 433         return 0;
 434 }
 435
 436 static const struct of_device_id zynqmp_aes_dt_ids[] = {
 437         { .compatible = "xlnx,zynqmp-aes" },
 438         { /* sentinel */ }
 439 };
 440 MODULE_DEVICE_TABLE(of, zynqmp_aes_dt_ids);
 441
 442 static struct platform_driver zynqmp_aes_driver = {
 443         .probe  = zynqmp_aes_aead_probe,
 444         .remove = zynqmp_aes_aead_remove,
 445         .driver = {
 446                 .name           = "zynqmp-aes",
 447                 .of_match_table = zynqmp_aes_dt_ids,
 448         },
 449 };
 450
 451 module_platform_driver(zynqmp_aes_driver);
 452 MODULE_LICENSE("GPL");