Loading...
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright (C) 2012-2019 ARM Limited or its affiliates. */
3
4#include <linux/kernel.h>
5#include <linux/module.h>
6
7#include <linux/crypto.h>
8#include <linux/moduleparam.h>
9#include <linux/types.h>
10#include <linux/interrupt.h>
11#include <linux/platform_device.h>
12#include <linux/slab.h>
13#include <linux/spinlock.h>
14#include <linux/of.h>
15#include <linux/clk.h>
16#include <linux/of_address.h>
17#include <linux/pm_runtime.h>
18
19#include "cc_driver.h"
20#include "cc_request_mgr.h"
21#include "cc_buffer_mgr.h"
22#include "cc_debugfs.h"
23#include "cc_cipher.h"
24#include "cc_aead.h"
25#include "cc_hash.h"
26#include "cc_sram_mgr.h"
27#include "cc_pm.h"
28#include "cc_fips.h"
29
30bool cc_dump_desc;
31module_param_named(dump_desc, cc_dump_desc, bool, 0600);
32MODULE_PARM_DESC(cc_dump_desc, "Dump descriptors to kernel log as debugging aid");
33bool cc_dump_bytes;
34module_param_named(dump_bytes, cc_dump_bytes, bool, 0600);
35MODULE_PARM_DESC(cc_dump_bytes, "Dump buffers to kernel log as debugging aid");
36
37static bool cc_sec_disable;
38module_param_named(sec_disable, cc_sec_disable, bool, 0600);
39MODULE_PARM_DESC(cc_sec_disable, "Disable security functions");
40
41struct cc_hw_data {
42 char *name;
43 enum cc_hw_rev rev;
44 u32 sig;
45 u32 cidr_0123;
46 u32 pidr_0124;
47 int std_bodies;
48};
49
50#define CC_NUM_IDRS 4
51#define CC_HW_RESET_LOOP_COUNT 10
52
53/* Note: PIDR3 holds CMOD/Rev so ignored for HW identification purposes */
54static const u32 pidr_0124_offsets[CC_NUM_IDRS] = {
55 CC_REG(PERIPHERAL_ID_0), CC_REG(PERIPHERAL_ID_1),
56 CC_REG(PERIPHERAL_ID_2), CC_REG(PERIPHERAL_ID_4)
57};
58
59static const u32 cidr_0123_offsets[CC_NUM_IDRS] = {
60 CC_REG(COMPONENT_ID_0), CC_REG(COMPONENT_ID_1),
61 CC_REG(COMPONENT_ID_2), CC_REG(COMPONENT_ID_3)
62};
63
64/* Hardware revisions defs. */
65
66/* The 703 is a OSCCA only variant of the 713 */
67static const struct cc_hw_data cc703_hw = {
68 .name = "703", .rev = CC_HW_REV_713, .cidr_0123 = 0xB105F00DU,
69 .pidr_0124 = 0x040BB0D0U, .std_bodies = CC_STD_OSCCA
70};
71
72static const struct cc_hw_data cc713_hw = {
73 .name = "713", .rev = CC_HW_REV_713, .cidr_0123 = 0xB105F00DU,
74 .pidr_0124 = 0x040BB0D0U, .std_bodies = CC_STD_ALL
75};
76
77static const struct cc_hw_data cc712_hw = {
78 .name = "712", .rev = CC_HW_REV_712, .sig = 0xDCC71200U,
79 .std_bodies = CC_STD_ALL
80};
81
82static const struct cc_hw_data cc710_hw = {
83 .name = "710", .rev = CC_HW_REV_710, .sig = 0xDCC63200U,
84 .std_bodies = CC_STD_ALL
85};
86
87static const struct cc_hw_data cc630p_hw = {
88 .name = "630P", .rev = CC_HW_REV_630, .sig = 0xDCC63000U,
89 .std_bodies = CC_STD_ALL
90};
91
92static const struct of_device_id arm_ccree_dev_of_match[] = {
93 { .compatible = "arm,cryptocell-703-ree", .data = &cc703_hw },
94 { .compatible = "arm,cryptocell-713-ree", .data = &cc713_hw },
95 { .compatible = "arm,cryptocell-712-ree", .data = &cc712_hw },
96 { .compatible = "arm,cryptocell-710-ree", .data = &cc710_hw },
97 { .compatible = "arm,cryptocell-630p-ree", .data = &cc630p_hw },
98 {}
99};
100MODULE_DEVICE_TABLE(of, arm_ccree_dev_of_match);
101
102static void init_cc_cache_params(struct cc_drvdata *drvdata)
103{
104 struct device *dev = drvdata_to_dev(drvdata);
105 u32 cache_params, ace_const, val;
106 u64 mask;
107
108 /* compute CC_AXIM_CACHE_PARAMS */
109 cache_params = cc_ioread(drvdata, CC_REG(AXIM_CACHE_PARAMS));
110 dev_dbg(dev, "Cache params previous: 0x%08X\n", cache_params);
111
112 /* non cached or write-back, write allocate */
113 val = drvdata->coherent ? 0xb : 0x2;
114
115 mask = CC_GENMASK(CC_AXIM_CACHE_PARAMS_AWCACHE);
116 cache_params &= ~mask;
117 cache_params |= FIELD_PREP(mask, val);
118
119 mask = CC_GENMASK(CC_AXIM_CACHE_PARAMS_AWCACHE_LAST);
120 cache_params &= ~mask;
121 cache_params |= FIELD_PREP(mask, val);
122
123 mask = CC_GENMASK(CC_AXIM_CACHE_PARAMS_ARCACHE);
124 cache_params &= ~mask;
125 cache_params |= FIELD_PREP(mask, val);
126
127 drvdata->cache_params = cache_params;
128
129 dev_dbg(dev, "Cache params current: 0x%08X\n", cache_params);
130
131 if (drvdata->hw_rev <= CC_HW_REV_710)
132 return;
133
134 /* compute CC_AXIM_ACE_CONST */
135 ace_const = cc_ioread(drvdata, CC_REG(AXIM_ACE_CONST));
136 dev_dbg(dev, "ACE-const previous: 0x%08X\n", ace_const);
137
138 /* system or outer-sharable */
139 val = drvdata->coherent ? 0x2 : 0x3;
140
141 mask = CC_GENMASK(CC_AXIM_ACE_CONST_ARDOMAIN);
142 ace_const &= ~mask;
143 ace_const |= FIELD_PREP(mask, val);
144
145 mask = CC_GENMASK(CC_AXIM_ACE_CONST_AWDOMAIN);
146 ace_const &= ~mask;
147 ace_const |= FIELD_PREP(mask, val);
148
149 dev_dbg(dev, "ACE-const current: 0x%08X\n", ace_const);
150
151 drvdata->ace_const = ace_const;
152}
153
154static u32 cc_read_idr(struct cc_drvdata *drvdata, const u32 *idr_offsets)
155{
156 int i;
157 union {
158 u8 regs[CC_NUM_IDRS];
159 __le32 val;
160 } idr;
161
162 for (i = 0; i < CC_NUM_IDRS; ++i)
163 idr.regs[i] = cc_ioread(drvdata, idr_offsets[i]);
164
165 return le32_to_cpu(idr.val);
166}
167
168void __dump_byte_array(const char *name, const u8 *buf, size_t len)
169{
170 char prefix[64];
171
172 if (!buf)
173 return;
174
175 snprintf(prefix, sizeof(prefix), "%s[%zu]: ", name, len);
176
177 print_hex_dump(KERN_DEBUG, prefix, DUMP_PREFIX_ADDRESS, 16, 1, buf,
178 len, false);
179}
180
181static irqreturn_t cc_isr(int irq, void *dev_id)
182{
183 struct cc_drvdata *drvdata = (struct cc_drvdata *)dev_id;
184 struct device *dev = drvdata_to_dev(drvdata);
185 u32 irr;
186 u32 imr;
187
188 /* STAT_OP_TYPE_GENERIC STAT_PHASE_0: Interrupt */
189 /* if driver suspended return, probably shared interrupt */
190 if (pm_runtime_suspended(dev))
191 return IRQ_NONE;
192
193 /* read the interrupt status */
194 irr = cc_ioread(drvdata, CC_REG(HOST_IRR));
195 dev_dbg(dev, "Got IRR=0x%08X\n", irr);
196
197 if (irr == 0) /* Probably shared interrupt line */
198 return IRQ_NONE;
199
200 imr = cc_ioread(drvdata, CC_REG(HOST_IMR));
201
202 /* clear interrupt - must be before processing events */
203 cc_iowrite(drvdata, CC_REG(HOST_ICR), irr);
204
205 drvdata->irq = irr;
206 /* Completion interrupt - most probable */
207 if (irr & drvdata->comp_mask) {
208 /* Mask all completion interrupts - will be unmasked in
209 * deferred service handler
210 */
211 cc_iowrite(drvdata, CC_REG(HOST_IMR), imr | drvdata->comp_mask);
212 irr &= ~drvdata->comp_mask;
213 complete_request(drvdata);
214 }
215#ifdef CONFIG_CRYPTO_FIPS
216 /* TEE FIPS interrupt */
217 if (irr & CC_GPR0_IRQ_MASK) {
218 /* Mask interrupt - will be unmasked in Deferred service
219 * handler
220 */
221 cc_iowrite(drvdata, CC_REG(HOST_IMR), imr | CC_GPR0_IRQ_MASK);
222 irr &= ~CC_GPR0_IRQ_MASK;
223 fips_handler(drvdata);
224 }
225#endif
226 /* AXI error interrupt */
227 if (irr & CC_AXI_ERR_IRQ_MASK) {
228 u32 axi_err;
229
230 /* Read the AXI error ID */
231 axi_err = cc_ioread(drvdata, CC_REG(AXIM_MON_ERR));
232 dev_dbg(dev, "AXI completion error: axim_mon_err=0x%08X\n",
233 axi_err);
234
235 irr &= ~CC_AXI_ERR_IRQ_MASK;
236 }
237
238 if (irr) {
239 dev_dbg_ratelimited(dev, "IRR includes unknown cause bits (0x%08X)\n",
240 irr);
241 /* Just warning */
242 }
243
244 return IRQ_HANDLED;
245}
246
247bool cc_wait_for_reset_completion(struct cc_drvdata *drvdata)
248{
249 unsigned int val;
250 unsigned int i;
251
252 /* 712/710/63 has no reset completion indication, always return true */
253 if (drvdata->hw_rev <= CC_HW_REV_712)
254 return true;
255
256 for (i = 0; i < CC_HW_RESET_LOOP_COUNT; i++) {
257 /* in cc7x3 NVM_IS_IDLE indicates that CC reset is
258 * completed and device is fully functional
259 */
260 val = cc_ioread(drvdata, CC_REG(NVM_IS_IDLE));
261 if (val & CC_NVM_IS_IDLE_MASK) {
262 /* hw indicate reset completed */
263 return true;
264 }
265 /* allow scheduling other process on the processor */
266 schedule();
267 }
268 /* reset not completed */
269 return false;
270}
271
272int init_cc_regs(struct cc_drvdata *drvdata)
273{
274 unsigned int val;
275 struct device *dev = drvdata_to_dev(drvdata);
276
277 /* Unmask all AXI interrupt sources AXI_CFG1 register */
278 /* AXI interrupt config are obsoleted startign at cc7x3 */
279 if (drvdata->hw_rev <= CC_HW_REV_712) {
280 val = cc_ioread(drvdata, CC_REG(AXIM_CFG));
281 cc_iowrite(drvdata, CC_REG(AXIM_CFG), val & ~CC_AXI_IRQ_MASK);
282 dev_dbg(dev, "AXIM_CFG=0x%08X\n",
283 cc_ioread(drvdata, CC_REG(AXIM_CFG)));
284 }
285
286 /* Clear all pending interrupts */
287 val = cc_ioread(drvdata, CC_REG(HOST_IRR));
288 dev_dbg(dev, "IRR=0x%08X\n", val);
289 cc_iowrite(drvdata, CC_REG(HOST_ICR), val);
290
291 /* Unmask relevant interrupt cause */
292 val = drvdata->comp_mask | CC_AXI_ERR_IRQ_MASK;
293
294 if (drvdata->hw_rev >= CC_HW_REV_712)
295 val |= CC_GPR0_IRQ_MASK;
296
297 cc_iowrite(drvdata, CC_REG(HOST_IMR), ~val);
298
299 cc_iowrite(drvdata, CC_REG(AXIM_CACHE_PARAMS), drvdata->cache_params);
300 if (drvdata->hw_rev >= CC_HW_REV_712)
301 cc_iowrite(drvdata, CC_REG(AXIM_ACE_CONST), drvdata->ace_const);
302
303 return 0;
304}
305
306static int init_cc_resources(struct platform_device *plat_dev)
307{
308 struct resource *req_mem_cc_regs = NULL;
309 struct cc_drvdata *new_drvdata;
310 struct device *dev = &plat_dev->dev;
311 struct device_node *np = dev->of_node;
312 u32 val, hw_rev_pidr, sig_cidr;
313 u64 dma_mask;
314 const struct cc_hw_data *hw_rev;
315 struct clk *clk;
316 int irq;
317 int rc = 0;
318
319 new_drvdata = devm_kzalloc(dev, sizeof(*new_drvdata), GFP_KERNEL);
320 if (!new_drvdata)
321 return -ENOMEM;
322
323 hw_rev = of_device_get_match_data(dev);
324 new_drvdata->hw_rev_name = hw_rev->name;
325 new_drvdata->hw_rev = hw_rev->rev;
326 new_drvdata->std_bodies = hw_rev->std_bodies;
327
328 if (hw_rev->rev >= CC_HW_REV_712) {
329 new_drvdata->axim_mon_offset = CC_REG(AXIM_MON_COMP);
330 new_drvdata->sig_offset = CC_REG(HOST_SIGNATURE_712);
331 new_drvdata->ver_offset = CC_REG(HOST_VERSION_712);
332 } else {
333 new_drvdata->axim_mon_offset = CC_REG(AXIM_MON_COMP8);
334 new_drvdata->sig_offset = CC_REG(HOST_SIGNATURE_630);
335 new_drvdata->ver_offset = CC_REG(HOST_VERSION_630);
336 }
337
338 new_drvdata->comp_mask = CC_COMP_IRQ_MASK;
339
340 platform_set_drvdata(plat_dev, new_drvdata);
341 new_drvdata->plat_dev = plat_dev;
342
343 clk = devm_clk_get_optional(dev, NULL);
344 if (IS_ERR(clk))
345 return dev_err_probe(dev, PTR_ERR(clk), "Error getting clock\n");
346 new_drvdata->clk = clk;
347
348 new_drvdata->coherent = of_dma_is_coherent(np);
349
350 /* Get device resources */
351 /* First CC registers space */
352 /* Map registers space */
353 new_drvdata->cc_base = devm_platform_get_and_ioremap_resource(plat_dev,
354 0, &req_mem_cc_regs);
355 if (IS_ERR(new_drvdata->cc_base))
356 return PTR_ERR(new_drvdata->cc_base);
357
358 dev_dbg(dev, "Got MEM resource (%s): %pR\n", req_mem_cc_regs->name,
359 req_mem_cc_regs);
360 dev_dbg(dev, "CC registers mapped from %pa to 0x%p\n",
361 &req_mem_cc_regs->start, new_drvdata->cc_base);
362
363 /* Then IRQ */
364 irq = platform_get_irq(plat_dev, 0);
365 if (irq < 0)
366 return irq;
367
368 init_completion(&new_drvdata->hw_queue_avail);
369
370 if (!dev->dma_mask)
371 dev->dma_mask = &dev->coherent_dma_mask;
372
373 dma_mask = DMA_BIT_MASK(DMA_BIT_MASK_LEN);
374 rc = dma_set_coherent_mask(dev, dma_mask);
375 if (rc) {
376 dev_err(dev, "Failed in dma_set_coherent_mask, mask=%llx\n",
377 dma_mask);
378 return rc;
379 }
380
381 rc = clk_prepare_enable(new_drvdata->clk);
382 if (rc) {
383 dev_err(dev, "Failed to enable clock");
384 return rc;
385 }
386
387 new_drvdata->sec_disabled = cc_sec_disable;
388
389 pm_runtime_set_autosuspend_delay(dev, CC_SUSPEND_TIMEOUT);
390 pm_runtime_use_autosuspend(dev);
391 pm_runtime_set_active(dev);
392 pm_runtime_enable(dev);
393 rc = pm_runtime_get_sync(dev);
394 if (rc < 0) {
395 dev_err(dev, "pm_runtime_get_sync() failed: %d\n", rc);
396 goto post_pm_err;
397 }
398
399 /* Wait for Cryptocell reset completion */
400 if (!cc_wait_for_reset_completion(new_drvdata)) {
401 dev_err(dev, "Cryptocell reset not completed");
402 }
403
404 if (hw_rev->rev <= CC_HW_REV_712) {
405 /* Verify correct mapping */
406 val = cc_ioread(new_drvdata, new_drvdata->sig_offset);
407 if (val != hw_rev->sig) {
408 dev_err(dev, "Invalid CC signature: SIGNATURE=0x%08X != expected=0x%08X\n",
409 val, hw_rev->sig);
410 rc = -EINVAL;
411 goto post_pm_err;
412 }
413 sig_cidr = val;
414 hw_rev_pidr = cc_ioread(new_drvdata, new_drvdata->ver_offset);
415 } else {
416 /* Verify correct mapping */
417 val = cc_read_idr(new_drvdata, pidr_0124_offsets);
418 if (val != hw_rev->pidr_0124) {
419 dev_err(dev, "Invalid CC PIDR: PIDR0124=0x%08X != expected=0x%08X\n",
420 val, hw_rev->pidr_0124);
421 rc = -EINVAL;
422 goto post_pm_err;
423 }
424 hw_rev_pidr = val;
425
426 val = cc_read_idr(new_drvdata, cidr_0123_offsets);
427 if (val != hw_rev->cidr_0123) {
428 dev_err(dev, "Invalid CC CIDR: CIDR0123=0x%08X != expected=0x%08X\n",
429 val, hw_rev->cidr_0123);
430 rc = -EINVAL;
431 goto post_pm_err;
432 }
433 sig_cidr = val;
434
435 /* Check HW engine configuration */
436 val = cc_ioread(new_drvdata, CC_REG(HOST_REMOVE_INPUT_PINS));
437 switch (val) {
438 case CC_PINS_FULL:
439 /* This is fine */
440 break;
441 case CC_PINS_SLIM:
442 if (new_drvdata->std_bodies & CC_STD_NIST) {
443 dev_warn(dev, "703 mode forced due to HW configuration.\n");
444 new_drvdata->std_bodies = CC_STD_OSCCA;
445 }
446 break;
447 default:
448 dev_err(dev, "Unsupported engines configuration.\n");
449 rc = -EINVAL;
450 goto post_pm_err;
451 }
452
453 /* Check security disable state */
454 val = cc_ioread(new_drvdata, CC_REG(SECURITY_DISABLED));
455 val &= CC_SECURITY_DISABLED_MASK;
456 new_drvdata->sec_disabled |= !!val;
457
458 if (!new_drvdata->sec_disabled) {
459 new_drvdata->comp_mask |= CC_CPP_SM4_ABORT_MASK;
460 if (new_drvdata->std_bodies & CC_STD_NIST)
461 new_drvdata->comp_mask |= CC_CPP_AES_ABORT_MASK;
462 }
463 }
464
465 if (new_drvdata->sec_disabled)
466 dev_info(dev, "Security Disabled mode is in effect. Security functions disabled.\n");
467
468 /* Display HW versions */
469 dev_info(dev, "ARM CryptoCell %s Driver: HW version 0x%08X/0x%8X, Driver version %s\n",
470 hw_rev->name, hw_rev_pidr, sig_cidr, DRV_MODULE_VERSION);
471 /* register the driver isr function */
472 rc = devm_request_irq(dev, irq, cc_isr, IRQF_SHARED, "ccree",
473 new_drvdata);
474 if (rc) {
475 dev_err(dev, "Could not register to interrupt %d\n", irq);
476 goto post_pm_err;
477 }
478 dev_dbg(dev, "Registered to IRQ: %d\n", irq);
479
480 init_cc_cache_params(new_drvdata);
481
482 rc = init_cc_regs(new_drvdata);
483 if (rc) {
484 dev_err(dev, "init_cc_regs failed\n");
485 goto post_pm_err;
486 }
487
488 rc = cc_debugfs_init(new_drvdata);
489 if (rc) {
490 dev_err(dev, "Failed registering debugfs interface\n");
491 goto post_regs_err;
492 }
493
494 rc = cc_fips_init(new_drvdata);
495 if (rc) {
496 dev_err(dev, "cc_fips_init failed 0x%x\n", rc);
497 goto post_debugfs_err;
498 }
499 rc = cc_sram_mgr_init(new_drvdata);
500 if (rc) {
501 dev_err(dev, "cc_sram_mgr_init failed\n");
502 goto post_fips_init_err;
503 }
504
505 new_drvdata->mlli_sram_addr =
506 cc_sram_alloc(new_drvdata, MAX_MLLI_BUFF_SIZE);
507 if (new_drvdata->mlli_sram_addr == NULL_SRAM_ADDR) {
508 rc = -ENOMEM;
509 goto post_fips_init_err;
510 }
511
512 rc = cc_req_mgr_init(new_drvdata);
513 if (rc) {
514 dev_err(dev, "cc_req_mgr_init failed\n");
515 goto post_fips_init_err;
516 }
517
518 rc = cc_buffer_mgr_init(new_drvdata);
519 if (rc) {
520 dev_err(dev, "cc_buffer_mgr_init failed\n");
521 goto post_req_mgr_err;
522 }
523
524 /* hash must be allocated first due to use of send_request_init()
525 * and dependency of AEAD on it
526 */
527 rc = cc_hash_alloc(new_drvdata);
528 if (rc) {
529 dev_err(dev, "cc_hash_alloc failed\n");
530 goto post_buf_mgr_err;
531 }
532
533 /* Allocate crypto algs */
534 rc = cc_cipher_alloc(new_drvdata);
535 if (rc) {
536 dev_err(dev, "cc_cipher_alloc failed\n");
537 goto post_hash_err;
538 }
539
540 rc = cc_aead_alloc(new_drvdata);
541 if (rc) {
542 dev_err(dev, "cc_aead_alloc failed\n");
543 goto post_cipher_err;
544 }
545
546 /* If we got here and FIPS mode is enabled
547 * it means all FIPS test passed, so let TEE
548 * know we're good.
549 */
550 cc_set_ree_fips_status(new_drvdata, true);
551
552 pm_runtime_put(dev);
553 return 0;
554
555post_cipher_err:
556 cc_cipher_free(new_drvdata);
557post_hash_err:
558 cc_hash_free(new_drvdata);
559post_buf_mgr_err:
560 cc_buffer_mgr_fini(new_drvdata);
561post_req_mgr_err:
562 cc_req_mgr_fini(new_drvdata);
563post_fips_init_err:
564 cc_fips_fini(new_drvdata);
565post_debugfs_err:
566 cc_debugfs_fini(new_drvdata);
567post_regs_err:
568 fini_cc_regs(new_drvdata);
569post_pm_err:
570 pm_runtime_put_noidle(dev);
571 pm_runtime_disable(dev);
572 pm_runtime_set_suspended(dev);
573 clk_disable_unprepare(new_drvdata->clk);
574 return rc;
575}
576
577void fini_cc_regs(struct cc_drvdata *drvdata)
578{
579 /* Mask all interrupts */
580 cc_iowrite(drvdata, CC_REG(HOST_IMR), 0xFFFFFFFF);
581}
582
583static void cleanup_cc_resources(struct platform_device *plat_dev)
584{
585 struct device *dev = &plat_dev->dev;
586 struct cc_drvdata *drvdata =
587 (struct cc_drvdata *)platform_get_drvdata(plat_dev);
588
589 cc_aead_free(drvdata);
590 cc_cipher_free(drvdata);
591 cc_hash_free(drvdata);
592 cc_buffer_mgr_fini(drvdata);
593 cc_req_mgr_fini(drvdata);
594 cc_fips_fini(drvdata);
595 cc_debugfs_fini(drvdata);
596 fini_cc_regs(drvdata);
597 pm_runtime_put_noidle(dev);
598 pm_runtime_disable(dev);
599 pm_runtime_set_suspended(dev);
600 clk_disable_unprepare(drvdata->clk);
601}
602
603unsigned int cc_get_default_hash_len(struct cc_drvdata *drvdata)
604{
605 if (drvdata->hw_rev >= CC_HW_REV_712)
606 return HASH_LEN_SIZE_712;
607 else
608 return HASH_LEN_SIZE_630;
609}
610
611static int ccree_probe(struct platform_device *plat_dev)
612{
613 int rc;
614 struct device *dev = &plat_dev->dev;
615
616 /* Map registers space */
617 rc = init_cc_resources(plat_dev);
618 if (rc)
619 return rc;
620
621 dev_info(dev, "ARM ccree device initialized\n");
622
623 return 0;
624}
625
626static void ccree_remove(struct platform_device *plat_dev)
627{
628 struct device *dev = &plat_dev->dev;
629
630 dev_dbg(dev, "Releasing ccree resources...\n");
631
632 cleanup_cc_resources(plat_dev);
633
634 dev_info(dev, "ARM ccree device terminated\n");
635}
636
637static struct platform_driver ccree_driver = {
638 .driver = {
639 .name = "ccree",
640 .of_match_table = arm_ccree_dev_of_match,
641#ifdef CONFIG_PM
642 .pm = &ccree_pm,
643#endif
644 },
645 .probe = ccree_probe,
646 .remove_new = ccree_remove,
647};
648
649static int __init ccree_init(void)
650{
651 int rc;
652
653 cc_debugfs_global_init();
654
655 rc = platform_driver_register(&ccree_driver);
656 if (rc) {
657 cc_debugfs_global_fini();
658 return rc;
659 }
660
661 return 0;
662}
663module_init(ccree_init);
664
665static void __exit ccree_exit(void)
666{
667 platform_driver_unregister(&ccree_driver);
668 cc_debugfs_global_fini();
669}
670module_exit(ccree_exit);
671
672/* Module description */
673MODULE_DESCRIPTION("ARM TrustZone CryptoCell REE Driver");
674MODULE_VERSION(DRV_MODULE_VERSION);
675MODULE_AUTHOR("ARM");
676MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright (C) 2012-2018 ARM Limited or its affiliates. */
3
4#include <linux/kernel.h>
5#include <linux/module.h>
6
7#include <linux/crypto.h>
8#include <linux/moduleparam.h>
9#include <linux/types.h>
10#include <linux/interrupt.h>
11#include <linux/platform_device.h>
12#include <linux/slab.h>
13#include <linux/spinlock.h>
14#include <linux/of.h>
15#include <linux/clk.h>
16#include <linux/of_address.h>
17
18#include "cc_driver.h"
19#include "cc_request_mgr.h"
20#include "cc_buffer_mgr.h"
21#include "cc_debugfs.h"
22#include "cc_cipher.h"
23#include "cc_aead.h"
24#include "cc_hash.h"
25#include "cc_ivgen.h"
26#include "cc_sram_mgr.h"
27#include "cc_pm.h"
28#include "cc_fips.h"
29
30bool cc_dump_desc;
31module_param_named(dump_desc, cc_dump_desc, bool, 0600);
32MODULE_PARM_DESC(cc_dump_desc, "Dump descriptors to kernel log as debugging aid");
33
34bool cc_dump_bytes;
35module_param_named(dump_bytes, cc_dump_bytes, bool, 0600);
36MODULE_PARM_DESC(cc_dump_bytes, "Dump buffers to kernel log as debugging aid");
37
38struct cc_hw_data {
39 char *name;
40 enum cc_hw_rev rev;
41 u32 sig;
42};
43
44/* Hardware revisions defs. */
45
46static const struct cc_hw_data cc712_hw = {
47 .name = "712", .rev = CC_HW_REV_712, .sig = 0xDCC71200U
48};
49
50static const struct cc_hw_data cc710_hw = {
51 .name = "710", .rev = CC_HW_REV_710, .sig = 0xDCC63200U
52};
53
54static const struct cc_hw_data cc630p_hw = {
55 .name = "630P", .rev = CC_HW_REV_630, .sig = 0xDCC63000U
56};
57
58static const struct of_device_id arm_ccree_dev_of_match[] = {
59 { .compatible = "arm,cryptocell-712-ree", .data = &cc712_hw },
60 { .compatible = "arm,cryptocell-710-ree", .data = &cc710_hw },
61 { .compatible = "arm,cryptocell-630p-ree", .data = &cc630p_hw },
62 {}
63};
64MODULE_DEVICE_TABLE(of, arm_ccree_dev_of_match);
65
66void __dump_byte_array(const char *name, const u8 *buf, size_t len)
67{
68 char prefix[64];
69
70 if (!buf)
71 return;
72
73 snprintf(prefix, sizeof(prefix), "%s[%zu]: ", name, len);
74
75 print_hex_dump(KERN_DEBUG, prefix, DUMP_PREFIX_ADDRESS, 16, 1, buf,
76 len, false);
77}
78
79static irqreturn_t cc_isr(int irq, void *dev_id)
80{
81 struct cc_drvdata *drvdata = (struct cc_drvdata *)dev_id;
82 struct device *dev = drvdata_to_dev(drvdata);
83 u32 irr;
84 u32 imr;
85
86 /* STAT_OP_TYPE_GENERIC STAT_PHASE_0: Interrupt */
87
88 /* read the interrupt status */
89 irr = cc_ioread(drvdata, CC_REG(HOST_IRR));
90 dev_dbg(dev, "Got IRR=0x%08X\n", irr);
91 if (irr == 0) { /* Probably shared interrupt line */
92 dev_err(dev, "Got interrupt with empty IRR\n");
93 return IRQ_NONE;
94 }
95 imr = cc_ioread(drvdata, CC_REG(HOST_IMR));
96
97 /* clear interrupt - must be before processing events */
98 cc_iowrite(drvdata, CC_REG(HOST_ICR), irr);
99
100 drvdata->irq = irr;
101 /* Completion interrupt - most probable */
102 if (irr & CC_COMP_IRQ_MASK) {
103 /* Mask AXI completion interrupt - will be unmasked in
104 * Deferred service handler
105 */
106 cc_iowrite(drvdata, CC_REG(HOST_IMR), imr | CC_COMP_IRQ_MASK);
107 irr &= ~CC_COMP_IRQ_MASK;
108 complete_request(drvdata);
109 }
110#ifdef CONFIG_CRYPTO_FIPS
111 /* TEE FIPS interrupt */
112 if (irr & CC_GPR0_IRQ_MASK) {
113 /* Mask interrupt - will be unmasked in Deferred service
114 * handler
115 */
116 cc_iowrite(drvdata, CC_REG(HOST_IMR), imr | CC_GPR0_IRQ_MASK);
117 irr &= ~CC_GPR0_IRQ_MASK;
118 fips_handler(drvdata);
119 }
120#endif
121 /* AXI error interrupt */
122 if (irr & CC_AXI_ERR_IRQ_MASK) {
123 u32 axi_err;
124
125 /* Read the AXI error ID */
126 axi_err = cc_ioread(drvdata, CC_REG(AXIM_MON_ERR));
127 dev_dbg(dev, "AXI completion error: axim_mon_err=0x%08X\n",
128 axi_err);
129
130 irr &= ~CC_AXI_ERR_IRQ_MASK;
131 }
132
133 if (irr) {
134 dev_dbg(dev, "IRR includes unknown cause bits (0x%08X)\n",
135 irr);
136 /* Just warning */
137 }
138
139 return IRQ_HANDLED;
140}
141
142int init_cc_regs(struct cc_drvdata *drvdata, bool is_probe)
143{
144 unsigned int val, cache_params;
145 struct device *dev = drvdata_to_dev(drvdata);
146
147 /* Unmask all AXI interrupt sources AXI_CFG1 register */
148 val = cc_ioread(drvdata, CC_REG(AXIM_CFG));
149 cc_iowrite(drvdata, CC_REG(AXIM_CFG), val & ~CC_AXI_IRQ_MASK);
150 dev_dbg(dev, "AXIM_CFG=0x%08X\n",
151 cc_ioread(drvdata, CC_REG(AXIM_CFG)));
152
153 /* Clear all pending interrupts */
154 val = cc_ioread(drvdata, CC_REG(HOST_IRR));
155 dev_dbg(dev, "IRR=0x%08X\n", val);
156 cc_iowrite(drvdata, CC_REG(HOST_ICR), val);
157
158 /* Unmask relevant interrupt cause */
159 val = CC_COMP_IRQ_MASK | CC_AXI_ERR_IRQ_MASK;
160
161 if (drvdata->hw_rev >= CC_HW_REV_712)
162 val |= CC_GPR0_IRQ_MASK;
163
164 cc_iowrite(drvdata, CC_REG(HOST_IMR), ~val);
165
166 cache_params = (drvdata->coherent ? CC_COHERENT_CACHE_PARAMS : 0x0);
167
168 val = cc_ioread(drvdata, CC_REG(AXIM_CACHE_PARAMS));
169
170 if (is_probe)
171 dev_info(dev, "Cache params previous: 0x%08X\n", val);
172
173 cc_iowrite(drvdata, CC_REG(AXIM_CACHE_PARAMS), cache_params);
174 val = cc_ioread(drvdata, CC_REG(AXIM_CACHE_PARAMS));
175
176 if (is_probe)
177 dev_info(dev, "Cache params current: 0x%08X (expect: 0x%08X)\n",
178 val, cache_params);
179
180 return 0;
181}
182
183static int init_cc_resources(struct platform_device *plat_dev)
184{
185 struct resource *req_mem_cc_regs = NULL;
186 struct cc_drvdata *new_drvdata;
187 struct device *dev = &plat_dev->dev;
188 struct device_node *np = dev->of_node;
189 u32 signature_val;
190 u64 dma_mask;
191 const struct cc_hw_data *hw_rev;
192 const struct of_device_id *dev_id;
193 int rc = 0;
194
195 new_drvdata = devm_kzalloc(dev, sizeof(*new_drvdata), GFP_KERNEL);
196 if (!new_drvdata)
197 return -ENOMEM;
198
199 dev_id = of_match_node(arm_ccree_dev_of_match, np);
200 if (!dev_id)
201 return -ENODEV;
202
203 hw_rev = (struct cc_hw_data *)dev_id->data;
204 new_drvdata->hw_rev_name = hw_rev->name;
205 new_drvdata->hw_rev = hw_rev->rev;
206
207 if (hw_rev->rev >= CC_HW_REV_712) {
208 new_drvdata->hash_len_sz = HASH_LEN_SIZE_712;
209 new_drvdata->axim_mon_offset = CC_REG(AXIM_MON_COMP);
210 } else {
211 new_drvdata->hash_len_sz = HASH_LEN_SIZE_630;
212 new_drvdata->axim_mon_offset = CC_REG(AXIM_MON_COMP8);
213 }
214
215 platform_set_drvdata(plat_dev, new_drvdata);
216 new_drvdata->plat_dev = plat_dev;
217
218 new_drvdata->clk = of_clk_get(np, 0);
219 new_drvdata->coherent = of_dma_is_coherent(np);
220
221 /* Get device resources */
222 /* First CC registers space */
223 req_mem_cc_regs = platform_get_resource(plat_dev, IORESOURCE_MEM, 0);
224 /* Map registers space */
225 new_drvdata->cc_base = devm_ioremap_resource(dev, req_mem_cc_regs);
226 if (IS_ERR(new_drvdata->cc_base)) {
227 dev_err(dev, "Failed to ioremap registers");
228 return PTR_ERR(new_drvdata->cc_base);
229 }
230
231 dev_dbg(dev, "Got MEM resource (%s): %pR\n", req_mem_cc_regs->name,
232 req_mem_cc_regs);
233 dev_dbg(dev, "CC registers mapped from %pa to 0x%p\n",
234 &req_mem_cc_regs->start, new_drvdata->cc_base);
235
236 /* Then IRQ */
237 new_drvdata->irq = platform_get_irq(plat_dev, 0);
238 if (new_drvdata->irq < 0) {
239 dev_err(dev, "Failed getting IRQ resource\n");
240 return new_drvdata->irq;
241 }
242
243 rc = devm_request_irq(dev, new_drvdata->irq, cc_isr,
244 IRQF_SHARED, "ccree", new_drvdata);
245 if (rc) {
246 dev_err(dev, "Could not register to interrupt %d\n",
247 new_drvdata->irq);
248 return rc;
249 }
250 dev_dbg(dev, "Registered to IRQ: %d\n", new_drvdata->irq);
251
252 init_completion(&new_drvdata->hw_queue_avail);
253
254 if (!plat_dev->dev.dma_mask)
255 plat_dev->dev.dma_mask = &plat_dev->dev.coherent_dma_mask;
256
257 dma_mask = DMA_BIT_MASK(DMA_BIT_MASK_LEN);
258 while (dma_mask > 0x7fffffffUL) {
259 if (dma_supported(&plat_dev->dev, dma_mask)) {
260 rc = dma_set_coherent_mask(&plat_dev->dev, dma_mask);
261 if (!rc)
262 break;
263 }
264 dma_mask >>= 1;
265 }
266
267 if (rc) {
268 dev_err(dev, "Failed in dma_set_mask, mask=%pad\n", &dma_mask);
269 return rc;
270 }
271
272 rc = cc_clk_on(new_drvdata);
273 if (rc) {
274 dev_err(dev, "Failed to enable clock");
275 return rc;
276 }
277
278 /* Verify correct mapping */
279 signature_val = cc_ioread(new_drvdata, CC_REG(HOST_SIGNATURE));
280 if (signature_val != hw_rev->sig) {
281 dev_err(dev, "Invalid CC signature: SIGNATURE=0x%08X != expected=0x%08X\n",
282 signature_val, hw_rev->sig);
283 rc = -EINVAL;
284 goto post_clk_err;
285 }
286 dev_dbg(dev, "CC SIGNATURE=0x%08X\n", signature_val);
287
288 /* Display HW versions */
289 dev_info(dev, "ARM CryptoCell %s Driver: HW version 0x%08X, Driver version %s\n",
290 hw_rev->name, cc_ioread(new_drvdata, CC_REG(HOST_VERSION)),
291 DRV_MODULE_VERSION);
292
293 rc = init_cc_regs(new_drvdata, true);
294 if (rc) {
295 dev_err(dev, "init_cc_regs failed\n");
296 goto post_clk_err;
297 }
298
299 rc = cc_debugfs_init(new_drvdata);
300 if (rc) {
301 dev_err(dev, "Failed registering debugfs interface\n");
302 goto post_regs_err;
303 }
304
305 rc = cc_fips_init(new_drvdata);
306 if (rc) {
307 dev_err(dev, "CC_FIPS_INIT failed 0x%x\n", rc);
308 goto post_debugfs_err;
309 }
310 rc = cc_sram_mgr_init(new_drvdata);
311 if (rc) {
312 dev_err(dev, "cc_sram_mgr_init failed\n");
313 goto post_fips_init_err;
314 }
315
316 new_drvdata->mlli_sram_addr =
317 cc_sram_alloc(new_drvdata, MAX_MLLI_BUFF_SIZE);
318 if (new_drvdata->mlli_sram_addr == NULL_SRAM_ADDR) {
319 dev_err(dev, "Failed to alloc MLLI Sram buffer\n");
320 rc = -ENOMEM;
321 goto post_sram_mgr_err;
322 }
323
324 rc = cc_req_mgr_init(new_drvdata);
325 if (rc) {
326 dev_err(dev, "cc_req_mgr_init failed\n");
327 goto post_sram_mgr_err;
328 }
329
330 rc = cc_buffer_mgr_init(new_drvdata);
331 if (rc) {
332 dev_err(dev, "buffer_mgr_init failed\n");
333 goto post_req_mgr_err;
334 }
335
336 rc = cc_pm_init(new_drvdata);
337 if (rc) {
338 dev_err(dev, "ssi_power_mgr_init failed\n");
339 goto post_buf_mgr_err;
340 }
341
342 rc = cc_ivgen_init(new_drvdata);
343 if (rc) {
344 dev_err(dev, "cc_ivgen_init failed\n");
345 goto post_power_mgr_err;
346 }
347
348 /* Allocate crypto algs */
349 rc = cc_cipher_alloc(new_drvdata);
350 if (rc) {
351 dev_err(dev, "cc_cipher_alloc failed\n");
352 goto post_ivgen_err;
353 }
354
355 /* hash must be allocated before aead since hash exports APIs */
356 rc = cc_hash_alloc(new_drvdata);
357 if (rc) {
358 dev_err(dev, "cc_hash_alloc failed\n");
359 goto post_cipher_err;
360 }
361
362 rc = cc_aead_alloc(new_drvdata);
363 if (rc) {
364 dev_err(dev, "cc_aead_alloc failed\n");
365 goto post_hash_err;
366 }
367
368 /* If we got here and FIPS mode is enabled
369 * it means all FIPS test passed, so let TEE
370 * know we're good.
371 */
372 cc_set_ree_fips_status(new_drvdata, true);
373
374 return 0;
375
376post_hash_err:
377 cc_hash_free(new_drvdata);
378post_cipher_err:
379 cc_cipher_free(new_drvdata);
380post_ivgen_err:
381 cc_ivgen_fini(new_drvdata);
382post_power_mgr_err:
383 cc_pm_fini(new_drvdata);
384post_buf_mgr_err:
385 cc_buffer_mgr_fini(new_drvdata);
386post_req_mgr_err:
387 cc_req_mgr_fini(new_drvdata);
388post_sram_mgr_err:
389 cc_sram_mgr_fini(new_drvdata);
390post_fips_init_err:
391 cc_fips_fini(new_drvdata);
392post_debugfs_err:
393 cc_debugfs_fini(new_drvdata);
394post_regs_err:
395 fini_cc_regs(new_drvdata);
396post_clk_err:
397 cc_clk_off(new_drvdata);
398 return rc;
399}
400
401void fini_cc_regs(struct cc_drvdata *drvdata)
402{
403 /* Mask all interrupts */
404 cc_iowrite(drvdata, CC_REG(HOST_IMR), 0xFFFFFFFF);
405}
406
407static void cleanup_cc_resources(struct platform_device *plat_dev)
408{
409 struct cc_drvdata *drvdata =
410 (struct cc_drvdata *)platform_get_drvdata(plat_dev);
411
412 cc_aead_free(drvdata);
413 cc_hash_free(drvdata);
414 cc_cipher_free(drvdata);
415 cc_ivgen_fini(drvdata);
416 cc_pm_fini(drvdata);
417 cc_buffer_mgr_fini(drvdata);
418 cc_req_mgr_fini(drvdata);
419 cc_sram_mgr_fini(drvdata);
420 cc_fips_fini(drvdata);
421 cc_debugfs_fini(drvdata);
422 fini_cc_regs(drvdata);
423 cc_clk_off(drvdata);
424}
425
426int cc_clk_on(struct cc_drvdata *drvdata)
427{
428 struct clk *clk = drvdata->clk;
429 int rc;
430
431 if (IS_ERR(clk))
432 /* Not all devices have a clock associated with CCREE */
433 return 0;
434
435 rc = clk_prepare_enable(clk);
436 if (rc)
437 return rc;
438
439 return 0;
440}
441
442void cc_clk_off(struct cc_drvdata *drvdata)
443{
444 struct clk *clk = drvdata->clk;
445
446 if (IS_ERR(clk))
447 /* Not all devices have a clock associated with CCREE */
448 return;
449
450 clk_disable_unprepare(clk);
451}
452
453static int ccree_probe(struct platform_device *plat_dev)
454{
455 int rc;
456 struct device *dev = &plat_dev->dev;
457
458 /* Map registers space */
459 rc = init_cc_resources(plat_dev);
460 if (rc)
461 return rc;
462
463 dev_info(dev, "ARM ccree device initialized\n");
464
465 return 0;
466}
467
468static int ccree_remove(struct platform_device *plat_dev)
469{
470 struct device *dev = &plat_dev->dev;
471
472 dev_dbg(dev, "Releasing ccree resources...\n");
473
474 cleanup_cc_resources(plat_dev);
475
476 dev_info(dev, "ARM ccree device terminated\n");
477
478 return 0;
479}
480
481static struct platform_driver ccree_driver = {
482 .driver = {
483 .name = "ccree",
484 .of_match_table = arm_ccree_dev_of_match,
485#ifdef CONFIG_PM
486 .pm = &ccree_pm,
487#endif
488 },
489 .probe = ccree_probe,
490 .remove = ccree_remove,
491};
492
493static int __init ccree_init(void)
494{
495 int ret;
496
497 cc_hash_global_init();
498
499 ret = cc_debugfs_global_init();
500 if (ret)
501 return ret;
502
503 return platform_driver_register(&ccree_driver);
504}
505module_init(ccree_init);
506
507static void __exit ccree_exit(void)
508{
509 platform_driver_unregister(&ccree_driver);
510 cc_debugfs_global_fini();
511}
512module_exit(ccree_exit);
513
514/* Module description */
515MODULE_DESCRIPTION("ARM TrustZone CryptoCell REE Driver");
516MODULE_VERSION(DRV_MODULE_VERSION);
517MODULE_AUTHOR("ARM");
518MODULE_LICENSE("GPL v2");