zynqmp-aes-gcm.c 12 KB

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