]> Git Repo - linux.git/blob - drivers/crypto/caam/ctrl.c
Merge patch series "riscv: Extension parsing fixes"
[linux.git] / drivers / crypto / caam / ctrl.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /* * CAAM control-plane driver backend
3  * Controller-level driver, kernel property detection, initialization
4  *
5  * Copyright 2008-2012 Freescale Semiconductor, Inc.
6  * Copyright 2018-2019, 2023 NXP
7  */
8
9 #include <linux/device.h>
10 #include <linux/of_address.h>
11 #include <linux/of_irq.h>
12 #include <linux/platform_device.h>
13 #include <linux/sys_soc.h>
14 #include <linux/fsl/mc.h>
15
16 #include "compat.h"
17 #include "debugfs.h"
18 #include "regs.h"
19 #include "intern.h"
20 #include "jr.h"
21 #include "desc_constr.h"
22 #include "ctrl.h"
23
24 bool caam_dpaa2;
25 EXPORT_SYMBOL(caam_dpaa2);
26
27 #ifdef CONFIG_CAAM_QI
28 #include "qi.h"
29 #endif
30
31 /*
32  * Descriptor to instantiate RNG State Handle 0 in normal mode and
33  * load the JDKEK, TDKEK and TDSK registers
34  */
35 static void build_instantiation_desc(u32 *desc, int handle, int do_sk)
36 {
37         u32 *jump_cmd, op_flags;
38
39         init_job_desc(desc, 0);
40
41         op_flags = OP_TYPE_CLASS1_ALG | OP_ALG_ALGSEL_RNG |
42                         (handle << OP_ALG_AAI_SHIFT) | OP_ALG_AS_INIT |
43                         OP_ALG_PR_ON;
44
45         /* INIT RNG in non-test mode */
46         append_operation(desc, op_flags);
47
48         if (!handle && do_sk) {
49                 /*
50                  * For SH0, Secure Keys must be generated as well
51                  */
52
53                 /* wait for done */
54                 jump_cmd = append_jump(desc, JUMP_CLASS_CLASS1);
55                 set_jump_tgt_here(desc, jump_cmd);
56
57                 /*
58                  * load 1 to clear written reg:
59                  * resets the done interrupt and returns the RNG to idle.
60                  */
61                 append_load_imm_u32(desc, 1, LDST_SRCDST_WORD_CLRW);
62
63                 /* Initialize State Handle  */
64                 append_operation(desc, OP_TYPE_CLASS1_ALG | OP_ALG_ALGSEL_RNG |
65                                  OP_ALG_AAI_RNG4_SK);
66         }
67
68         append_jump(desc, JUMP_CLASS_CLASS1 | JUMP_TYPE_HALT);
69 }
70
71 /* Descriptor for deinstantiation of State Handle 0 of the RNG block. */
72 static void build_deinstantiation_desc(u32 *desc, int handle)
73 {
74         init_job_desc(desc, 0);
75
76         /* Uninstantiate State Handle 0 */
77         append_operation(desc, OP_TYPE_CLASS1_ALG | OP_ALG_ALGSEL_RNG |
78                          (handle << OP_ALG_AAI_SHIFT) | OP_ALG_AS_INITFINAL);
79
80         append_jump(desc, JUMP_CLASS_CLASS1 | JUMP_TYPE_HALT);
81 }
82
83 static const struct of_device_id imx8m_machine_match[] = {
84         { .compatible = "fsl,imx8mm", },
85         { .compatible = "fsl,imx8mn", },
86         { .compatible = "fsl,imx8mp", },
87         { .compatible = "fsl,imx8mq", },
88         { .compatible = "fsl,imx8ulp", },
89         { }
90 };
91
92 /*
93  * run_descriptor_deco0 - runs a descriptor on DECO0, under direct control of
94  *                        the software (no JR/QI used).
95  * @ctrldev - pointer to device
96  * @status - descriptor status, after being run
97  *
98  * Return: - 0 if no error occurred
99  *         - -ENODEV if the DECO couldn't be acquired
100  *         - -EAGAIN if an error occurred while executing the descriptor
101  */
102 static inline int run_descriptor_deco0(struct device *ctrldev, u32 *desc,
103                                         u32 *status)
104 {
105         struct caam_drv_private *ctrlpriv = dev_get_drvdata(ctrldev);
106         struct caam_ctrl __iomem *ctrl = ctrlpriv->ctrl;
107         struct caam_deco __iomem *deco = ctrlpriv->deco;
108         unsigned int timeout = 100000;
109         u32 deco_dbg_reg, deco_state, flags;
110         int i;
111
112
113         if (ctrlpriv->virt_en == 1 ||
114             /*
115              * Apparently on i.MX8M{Q,M,N,P} it doesn't matter if virt_en == 1
116              * and the following steps should be performed regardless
117              */
118             of_match_node(imx8m_machine_match, of_root)) {
119                 clrsetbits_32(&ctrl->deco_rsr, 0, DECORSR_JR0);
120
121                 while (!(rd_reg32(&ctrl->deco_rsr) & DECORSR_VALID) &&
122                        --timeout)
123                         cpu_relax();
124
125                 timeout = 100000;
126         }
127
128         clrsetbits_32(&ctrl->deco_rq, 0, DECORR_RQD0ENABLE);
129
130         while (!(rd_reg32(&ctrl->deco_rq) & DECORR_DEN0) &&
131                                                                  --timeout)
132                 cpu_relax();
133
134         if (!timeout) {
135                 dev_err(ctrldev, "failed to acquire DECO 0\n");
136                 clrsetbits_32(&ctrl->deco_rq, DECORR_RQD0ENABLE, 0);
137                 return -ENODEV;
138         }
139
140         for (i = 0; i < desc_len(desc); i++)
141                 wr_reg32(&deco->descbuf[i], caam32_to_cpu(*(desc + i)));
142
143         flags = DECO_JQCR_WHL;
144         /*
145          * If the descriptor length is longer than 4 words, then the
146          * FOUR bit in JRCTRL register must be set.
147          */
148         if (desc_len(desc) >= 4)
149                 flags |= DECO_JQCR_FOUR;
150
151         /* Instruct the DECO to execute it */
152         clrsetbits_32(&deco->jr_ctl_hi, 0, flags);
153
154         timeout = 10000000;
155         do {
156                 deco_dbg_reg = rd_reg32(&deco->desc_dbg);
157
158                 if (ctrlpriv->era < 10)
159                         deco_state = (deco_dbg_reg & DESC_DBG_DECO_STAT_MASK) >>
160                                      DESC_DBG_DECO_STAT_SHIFT;
161                 else
162                         deco_state = (rd_reg32(&deco->dbg_exec) &
163                                       DESC_DER_DECO_STAT_MASK) >>
164                                      DESC_DER_DECO_STAT_SHIFT;
165
166                 /*
167                  * If an error occurred in the descriptor, then
168                  * the DECO status field will be set to 0x0D
169                  */
170                 if (deco_state == DECO_STAT_HOST_ERR)
171                         break;
172
173                 cpu_relax();
174         } while ((deco_dbg_reg & DESC_DBG_DECO_STAT_VALID) && --timeout);
175
176         *status = rd_reg32(&deco->op_status_hi) &
177                   DECO_OP_STATUS_HI_ERR_MASK;
178
179         if (ctrlpriv->virt_en == 1)
180                 clrsetbits_32(&ctrl->deco_rsr, DECORSR_JR0, 0);
181
182         /* Mark the DECO as free */
183         clrsetbits_32(&ctrl->deco_rq, DECORR_RQD0ENABLE, 0);
184
185         if (!timeout)
186                 return -EAGAIN;
187
188         return 0;
189 }
190
191 /*
192  * deinstantiate_rng - builds and executes a descriptor on DECO0,
193  *                     which deinitializes the RNG block.
194  * @ctrldev - pointer to device
195  * @state_handle_mask - bitmask containing the instantiation status
196  *                      for the RNG4 state handles which exist in
197  *                      the RNG4 block: 1 if it's been instantiated
198  *
199  * Return: - 0 if no error occurred
200  *         - -ENOMEM if there isn't enough memory to allocate the descriptor
201  *         - -ENODEV if DECO0 couldn't be acquired
202  *         - -EAGAIN if an error occurred when executing the descriptor
203  */
204 static int deinstantiate_rng(struct device *ctrldev, int state_handle_mask)
205 {
206         u32 *desc, status;
207         int sh_idx, ret = 0;
208
209         desc = kmalloc(CAAM_CMD_SZ * 3, GFP_KERNEL);
210         if (!desc)
211                 return -ENOMEM;
212
213         for (sh_idx = 0; sh_idx < RNG4_MAX_HANDLES; sh_idx++) {
214                 /*
215                  * If the corresponding bit is set, then it means the state
216                  * handle was initialized by us, and thus it needs to be
217                  * deinitialized as well
218                  */
219                 if ((1 << sh_idx) & state_handle_mask) {
220                         /*
221                          * Create the descriptor for deinstantating this state
222                          * handle
223                          */
224                         build_deinstantiation_desc(desc, sh_idx);
225
226                         /* Try to run it through DECO0 */
227                         ret = run_descriptor_deco0(ctrldev, desc, &status);
228
229                         if (ret ||
230                             (status && status != JRSTA_SSRC_JUMP_HALT_CC)) {
231                                 dev_err(ctrldev,
232                                         "Failed to deinstantiate RNG4 SH%d\n",
233                                         sh_idx);
234                                 break;
235                         }
236                         dev_info(ctrldev, "Deinstantiated RNG4 SH%d\n", sh_idx);
237                 }
238         }
239
240         kfree(desc);
241
242         return ret;
243 }
244
245 static void devm_deinstantiate_rng(void *data)
246 {
247         struct device *ctrldev = data;
248         struct caam_drv_private *ctrlpriv = dev_get_drvdata(ctrldev);
249
250         /*
251          * De-initialize RNG state handles initialized by this driver.
252          * In case of SoCs with Management Complex, RNG is managed by MC f/w.
253          */
254         if (ctrlpriv->rng4_sh_init)
255                 deinstantiate_rng(ctrldev, ctrlpriv->rng4_sh_init);
256 }
257
258 /*
259  * instantiate_rng - builds and executes a descriptor on DECO0,
260  *                   which initializes the RNG block.
261  * @ctrldev - pointer to device
262  * @state_handle_mask - bitmask containing the instantiation status
263  *                      for the RNG4 state handles which exist in
264  *                      the RNG4 block: 1 if it's been instantiated
265  *                      by an external entry, 0 otherwise.
266  * @gen_sk  - generate data to be loaded into the JDKEK, TDKEK and TDSK;
267  *            Caution: this can be done only once; if the keys need to be
268  *            regenerated, a POR is required
269  *
270  * Return: - 0 if no error occurred
271  *         - -ENOMEM if there isn't enough memory to allocate the descriptor
272  *         - -ENODEV if DECO0 couldn't be acquired
273  *         - -EAGAIN if an error occurred when executing the descriptor
274  *            f.i. there was a RNG hardware error due to not "good enough"
275  *            entropy being acquired.
276  */
277 static int instantiate_rng(struct device *ctrldev, int state_handle_mask,
278                            int gen_sk)
279 {
280         struct caam_drv_private *ctrlpriv = dev_get_drvdata(ctrldev);
281         struct caam_ctrl __iomem *ctrl;
282         u32 *desc, status = 0, rdsta_val;
283         int ret = 0, sh_idx;
284
285         ctrl = (struct caam_ctrl __iomem *)ctrlpriv->ctrl;
286         desc = kmalloc(CAAM_CMD_SZ * 7, GFP_KERNEL);
287         if (!desc)
288                 return -ENOMEM;
289
290         for (sh_idx = 0; sh_idx < RNG4_MAX_HANDLES; sh_idx++) {
291                 const u32 rdsta_if = RDSTA_IF0 << sh_idx;
292                 const u32 rdsta_pr = RDSTA_PR0 << sh_idx;
293                 const u32 rdsta_mask = rdsta_if | rdsta_pr;
294
295                 /* Clear the contents before using the descriptor */
296                 memset(desc, 0x00, CAAM_CMD_SZ * 7);
297
298                 /*
299                  * If the corresponding bit is set, this state handle
300                  * was initialized by somebody else, so it's left alone.
301                  */
302                 if (rdsta_if & state_handle_mask) {
303                         if (rdsta_pr & state_handle_mask)
304                                 continue;
305
306                         dev_info(ctrldev,
307                                  "RNG4 SH%d was previously instantiated without prediction resistance. Tearing it down\n",
308                                  sh_idx);
309
310                         ret = deinstantiate_rng(ctrldev, rdsta_if);
311                         if (ret)
312                                 break;
313                 }
314
315                 /* Create the descriptor for instantiating RNG State Handle */
316                 build_instantiation_desc(desc, sh_idx, gen_sk);
317
318                 /* Try to run it through DECO0 */
319                 ret = run_descriptor_deco0(ctrldev, desc, &status);
320
321                 /*
322                  * If ret is not 0, or descriptor status is not 0, then
323                  * something went wrong. No need to try the next state
324                  * handle (if available), bail out here.
325                  * Also, if for some reason, the State Handle didn't get
326                  * instantiated although the descriptor has finished
327                  * without any error (HW optimizations for later
328                  * CAAM eras), then try again.
329                  */
330                 if (ret)
331                         break;
332
333                 rdsta_val = rd_reg32(&ctrl->r4tst[0].rdsta) & RDSTA_MASK;
334                 if ((status && status != JRSTA_SSRC_JUMP_HALT_CC) ||
335                     (rdsta_val & rdsta_mask) != rdsta_mask) {
336                         ret = -EAGAIN;
337                         break;
338                 }
339
340                 dev_info(ctrldev, "Instantiated RNG4 SH%d\n", sh_idx);
341         }
342
343         kfree(desc);
344
345         if (ret)
346                 return ret;
347
348         return devm_add_action_or_reset(ctrldev, devm_deinstantiate_rng, ctrldev);
349 }
350
351 /*
352  * kick_trng - sets the various parameters for enabling the initialization
353  *             of the RNG4 block in CAAM
354  * @dev - pointer to the controller device
355  * @ent_delay - Defines the length (in system clocks) of each entropy sample.
356  */
357 static void kick_trng(struct device *dev, int ent_delay)
358 {
359         struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
360         struct caam_ctrl __iomem *ctrl;
361         struct rng4tst __iomem *r4tst;
362         u32 val, rtsdctl;
363
364         ctrl = (struct caam_ctrl __iomem *)ctrlpriv->ctrl;
365         r4tst = &ctrl->r4tst[0];
366
367         /*
368          * Setting both RTMCTL:PRGM and RTMCTL:TRNG_ACC causes TRNG to
369          * properly invalidate the entropy in the entropy register and
370          * force re-generation.
371          */
372         clrsetbits_32(&r4tst->rtmctl, 0, RTMCTL_PRGM | RTMCTL_ACC);
373
374         /*
375          * Performance-wise, it does not make sense to
376          * set the delay to a value that is lower
377          * than the last one that worked (i.e. the state handles
378          * were instantiated properly).
379          */
380         rtsdctl = rd_reg32(&r4tst->rtsdctl);
381         val = (rtsdctl & RTSDCTL_ENT_DLY_MASK) >> RTSDCTL_ENT_DLY_SHIFT;
382         if (ent_delay > val) {
383                 val = ent_delay;
384                 /* min. freq. count, equal to 1/4 of the entropy sample length */
385                 wr_reg32(&r4tst->rtfrqmin, val >> 2);
386                 /* disable maximum frequency count */
387                 wr_reg32(&r4tst->rtfrqmax, RTFRQMAX_DISABLE);
388         }
389
390         wr_reg32(&r4tst->rtsdctl, (val << RTSDCTL_ENT_DLY_SHIFT) |
391                  RTSDCTL_SAMP_SIZE_VAL);
392
393         /*
394          * To avoid reprogramming the self-test parameters over and over again,
395          * use RTSDCTL[SAMP_SIZE] as an indicator.
396          */
397         if ((rtsdctl & RTSDCTL_SAMP_SIZE_MASK) != RTSDCTL_SAMP_SIZE_VAL) {
398                 wr_reg32(&r4tst->rtscmisc, (2 << 16) | 32);
399                 wr_reg32(&r4tst->rtpkrrng, 570);
400                 wr_reg32(&r4tst->rtpkrmax, 1600);
401                 wr_reg32(&r4tst->rtscml, (122 << 16) | 317);
402                 wr_reg32(&r4tst->rtscrl[0], (80 << 16) | 107);
403                 wr_reg32(&r4tst->rtscrl[1], (57 << 16) | 62);
404                 wr_reg32(&r4tst->rtscrl[2], (39 << 16) | 39);
405                 wr_reg32(&r4tst->rtscrl[3], (27 << 16) | 26);
406                 wr_reg32(&r4tst->rtscrl[4], (19 << 16) | 18);
407                 wr_reg32(&r4tst->rtscrl[5], (18 << 16) | 17);
408         }
409
410         /*
411          * select raw sampling in both entropy shifter
412          * and statistical checker; ; put RNG4 into run mode
413          */
414         clrsetbits_32(&r4tst->rtmctl, RTMCTL_PRGM | RTMCTL_ACC,
415                       RTMCTL_SAMP_MODE_RAW_ES_SC);
416 }
417
418 static int caam_get_era_from_hw(struct caam_perfmon __iomem *perfmon)
419 {
420         static const struct {
421                 u16 ip_id;
422                 u8 maj_rev;
423                 u8 era;
424         } id[] = {
425                 {0x0A10, 1, 1},
426                 {0x0A10, 2, 2},
427                 {0x0A12, 1, 3},
428                 {0x0A14, 1, 3},
429                 {0x0A14, 2, 4},
430                 {0x0A16, 1, 4},
431                 {0x0A10, 3, 4},
432                 {0x0A11, 1, 4},
433                 {0x0A18, 1, 4},
434                 {0x0A11, 2, 5},
435                 {0x0A12, 2, 5},
436                 {0x0A13, 1, 5},
437                 {0x0A1C, 1, 5}
438         };
439         u32 ccbvid, id_ms;
440         u8 maj_rev, era;
441         u16 ip_id;
442         int i;
443
444         ccbvid = rd_reg32(&perfmon->ccb_id);
445         era = (ccbvid & CCBVID_ERA_MASK) >> CCBVID_ERA_SHIFT;
446         if (era)        /* This is '0' prior to CAAM ERA-6 */
447                 return era;
448
449         id_ms = rd_reg32(&perfmon->caam_id_ms);
450         ip_id = (id_ms & SECVID_MS_IPID_MASK) >> SECVID_MS_IPID_SHIFT;
451         maj_rev = (id_ms & SECVID_MS_MAJ_REV_MASK) >> SECVID_MS_MAJ_REV_SHIFT;
452
453         for (i = 0; i < ARRAY_SIZE(id); i++)
454                 if (id[i].ip_id == ip_id && id[i].maj_rev == maj_rev)
455                         return id[i].era;
456
457         return -ENOTSUPP;
458 }
459
460 /**
461  * caam_get_era() - Return the ERA of the SEC on SoC, based
462  * on "sec-era" optional property in the DTS. This property is updated
463  * by u-boot.
464  * In case this property is not passed an attempt to retrieve the CAAM
465  * era via register reads will be made.
466  *
467  * @perfmon:    Performance Monitor Registers
468  */
469 static int caam_get_era(struct caam_perfmon __iomem *perfmon)
470 {
471         struct device_node *caam_node;
472         int ret;
473         u32 prop;
474
475         caam_node = of_find_compatible_node(NULL, NULL, "fsl,sec-v4.0");
476         ret = of_property_read_u32(caam_node, "fsl,sec-era", &prop);
477         of_node_put(caam_node);
478
479         if (!ret)
480                 return prop;
481         else
482                 return caam_get_era_from_hw(perfmon);
483 }
484
485 /*
486  * ERRATA: imx6 devices (imx6D, imx6Q, imx6DL, imx6S, imx6DP and imx6QP)
487  * have an issue wherein AXI bus transactions may not occur in the correct
488  * order. This isn't a problem running single descriptors, but can be if
489  * running multiple concurrent descriptors. Reworking the driver to throttle
490  * to single requests is impractical, thus the workaround is to limit the AXI
491  * pipeline to a depth of 1 (from it's default of 4) to preclude this situation
492  * from occurring.
493  */
494 static void handle_imx6_err005766(u32 __iomem *mcr)
495 {
496         if (of_machine_is_compatible("fsl,imx6q") ||
497             of_machine_is_compatible("fsl,imx6dl") ||
498             of_machine_is_compatible("fsl,imx6qp"))
499                 clrsetbits_32(mcr, MCFGR_AXIPIPE_MASK,
500                               1 << MCFGR_AXIPIPE_SHIFT);
501 }
502
503 static const struct of_device_id caam_match[] = {
504         {
505                 .compatible = "fsl,sec-v4.0",
506         },
507         {
508                 .compatible = "fsl,sec4.0",
509         },
510         {},
511 };
512 MODULE_DEVICE_TABLE(of, caam_match);
513
514 struct caam_imx_data {
515         bool page0_access;
516         const struct clk_bulk_data *clks;
517         int num_clks;
518 };
519
520 static const struct clk_bulk_data caam_imx6_clks[] = {
521         { .id = "ipg" },
522         { .id = "mem" },
523         { .id = "aclk" },
524         { .id = "emi_slow" },
525 };
526
527 static const struct caam_imx_data caam_imx6_data = {
528         .page0_access = true,
529         .clks = caam_imx6_clks,
530         .num_clks = ARRAY_SIZE(caam_imx6_clks),
531 };
532
533 static const struct clk_bulk_data caam_imx7_clks[] = {
534         { .id = "ipg" },
535         { .id = "aclk" },
536 };
537
538 static const struct caam_imx_data caam_imx7_data = {
539         .page0_access = true,
540         .clks = caam_imx7_clks,
541         .num_clks = ARRAY_SIZE(caam_imx7_clks),
542 };
543
544 static const struct clk_bulk_data caam_imx6ul_clks[] = {
545         { .id = "ipg" },
546         { .id = "mem" },
547         { .id = "aclk" },
548 };
549
550 static const struct caam_imx_data caam_imx6ul_data = {
551         .page0_access = true,
552         .clks = caam_imx6ul_clks,
553         .num_clks = ARRAY_SIZE(caam_imx6ul_clks),
554 };
555
556 static const struct clk_bulk_data caam_vf610_clks[] = {
557         { .id = "ipg" },
558 };
559
560 static const struct caam_imx_data caam_vf610_data = {
561         .page0_access = true,
562         .clks = caam_vf610_clks,
563         .num_clks = ARRAY_SIZE(caam_vf610_clks),
564 };
565
566 static const struct caam_imx_data caam_imx8ulp_data;
567
568 static const struct soc_device_attribute caam_imx_soc_table[] = {
569         { .soc_id = "i.MX6UL", .data = &caam_imx6ul_data },
570         { .soc_id = "i.MX6*",  .data = &caam_imx6_data },
571         { .soc_id = "i.MX7*",  .data = &caam_imx7_data },
572         { .soc_id = "i.MX8M*", .data = &caam_imx7_data },
573         { .soc_id = "i.MX8ULP", .data = &caam_imx8ulp_data },
574         { .soc_id = "VF*",     .data = &caam_vf610_data },
575         { .family = "Freescale i.MX" },
576         { /* sentinel */ }
577 };
578
579 static void disable_clocks(void *data)
580 {
581         struct caam_drv_private *ctrlpriv = data;
582
583         clk_bulk_disable_unprepare(ctrlpriv->num_clks, ctrlpriv->clks);
584 }
585
586 static int init_clocks(struct device *dev, const struct caam_imx_data *data)
587 {
588         struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
589         int ret;
590
591         ctrlpriv->num_clks = data->num_clks;
592         ctrlpriv->clks = devm_kmemdup(dev, data->clks,
593                                       data->num_clks * sizeof(data->clks[0]),
594                                       GFP_KERNEL);
595         if (!ctrlpriv->clks)
596                 return -ENOMEM;
597
598         ret = devm_clk_bulk_get(dev, ctrlpriv->num_clks, ctrlpriv->clks);
599         if (ret) {
600                 dev_err(dev,
601                         "Failed to request all necessary clocks\n");
602                 return ret;
603         }
604
605         ret = clk_bulk_prepare_enable(ctrlpriv->num_clks, ctrlpriv->clks);
606         if (ret) {
607                 dev_err(dev,
608                         "Failed to prepare/enable all necessary clocks\n");
609                 return ret;
610         }
611
612         return devm_add_action_or_reset(dev, disable_clocks, ctrlpriv);
613 }
614
615 static void caam_remove_debugfs(void *root)
616 {
617         debugfs_remove_recursive(root);
618 }
619
620 #ifdef CONFIG_FSL_MC_BUS
621 static bool check_version(struct fsl_mc_version *mc_version, u32 major,
622                           u32 minor, u32 revision)
623 {
624         if (mc_version->major > major)
625                 return true;
626
627         if (mc_version->major == major) {
628                 if (mc_version->minor > minor)
629                         return true;
630
631                 if (mc_version->minor == minor &&
632                     mc_version->revision > revision)
633                         return true;
634         }
635
636         return false;
637 }
638 #endif
639
640 static bool needs_entropy_delay_adjustment(void)
641 {
642         if (of_machine_is_compatible("fsl,imx6sx"))
643                 return true;
644         return false;
645 }
646
647 static int caam_ctrl_rng_init(struct device *dev)
648 {
649         struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
650         struct caam_ctrl __iomem *ctrl = ctrlpriv->ctrl;
651         int ret, gen_sk, ent_delay = RTSDCTL_ENT_DLY_MIN;
652         u8 rng_vid;
653
654         if (ctrlpriv->era < 10) {
655                 struct caam_perfmon __iomem *perfmon;
656
657                 perfmon = ctrlpriv->total_jobrs ?
658                           (struct caam_perfmon __iomem *)&ctrlpriv->jr[0]->perfmon :
659                           (struct caam_perfmon __iomem *)&ctrl->perfmon;
660
661                 rng_vid = (rd_reg32(&perfmon->cha_id_ls) &
662                            CHA_ID_LS_RNG_MASK) >> CHA_ID_LS_RNG_SHIFT;
663         } else {
664                 struct version_regs __iomem *vreg;
665
666                 vreg = ctrlpriv->total_jobrs ?
667                         (struct version_regs __iomem *)&ctrlpriv->jr[0]->vreg :
668                         (struct version_regs __iomem *)&ctrl->vreg;
669
670                 rng_vid = (rd_reg32(&vreg->rng) & CHA_VER_VID_MASK) >>
671                           CHA_VER_VID_SHIFT;
672         }
673
674         /*
675          * If SEC has RNG version >= 4 and RNG state handle has not been
676          * already instantiated, do RNG instantiation
677          * In case of SoCs with Management Complex, RNG is managed by MC f/w.
678          */
679         if (!(ctrlpriv->mc_en && ctrlpriv->pr_support) && rng_vid >= 4) {
680                 ctrlpriv->rng4_sh_init =
681                         rd_reg32(&ctrl->r4tst[0].rdsta);
682                 /*
683                  * If the secure keys (TDKEK, JDKEK, TDSK), were already
684                  * generated, signal this to the function that is instantiating
685                  * the state handles. An error would occur if RNG4 attempts
686                  * to regenerate these keys before the next POR.
687                  */
688                 gen_sk = ctrlpriv->rng4_sh_init & RDSTA_SKVN ? 0 : 1;
689                 ctrlpriv->rng4_sh_init &= RDSTA_MASK;
690                 do {
691                         int inst_handles =
692                                 rd_reg32(&ctrl->r4tst[0].rdsta) & RDSTA_MASK;
693                         /*
694                          * If either SH were instantiated by somebody else
695                          * (e.g. u-boot) then it is assumed that the entropy
696                          * parameters are properly set and thus the function
697                          * setting these (kick_trng(...)) is skipped.
698                          * Also, if a handle was instantiated, do not change
699                          * the TRNG parameters.
700                          */
701                         if (needs_entropy_delay_adjustment())
702                                 ent_delay = 12000;
703                         if (!(ctrlpriv->rng4_sh_init || inst_handles)) {
704                                 dev_info(dev,
705                                          "Entropy delay = %u\n",
706                                          ent_delay);
707                                 kick_trng(dev, ent_delay);
708                                 ent_delay += 400;
709                         }
710                         /*
711                          * if instantiate_rng(...) fails, the loop will rerun
712                          * and the kick_trng(...) function will modify the
713                          * upper and lower limits of the entropy sampling
714                          * interval, leading to a successful initialization of
715                          * the RNG.
716                          */
717                         ret = instantiate_rng(dev, inst_handles,
718                                               gen_sk);
719                         /*
720                          * Entropy delay is determined via TRNG characterization.
721                          * TRNG characterization is run across different voltages
722                          * and temperatures.
723                          * If worst case value for ent_dly is identified,
724                          * the loop can be skipped for that platform.
725                          */
726                         if (needs_entropy_delay_adjustment())
727                                 break;
728                         if (ret == -EAGAIN)
729                                 /*
730                                  * if here, the loop will rerun,
731                                  * so don't hog the CPU
732                                  */
733                                 cpu_relax();
734                 } while ((ret == -EAGAIN) && (ent_delay < RTSDCTL_ENT_DLY_MAX));
735                 if (ret) {
736                         dev_err(dev, "failed to instantiate RNG");
737                         return ret;
738                 }
739                 /*
740                  * Set handles initialized by this module as the complement of
741                  * the already initialized ones
742                  */
743                 ctrlpriv->rng4_sh_init = ~ctrlpriv->rng4_sh_init & RDSTA_MASK;
744
745                 /* Enable RDB bit so that RNG works faster */
746                 clrsetbits_32(&ctrl->scfgr, 0, SCFGR_RDBENABLE);
747         }
748
749         return 0;
750 }
751
752 /* Indicate if the internal state of the CAAM is lost during PM */
753 static int caam_off_during_pm(void)
754 {
755         bool not_off_during_pm = of_machine_is_compatible("fsl,imx6q") ||
756                                  of_machine_is_compatible("fsl,imx6qp") ||
757                                  of_machine_is_compatible("fsl,imx6dl");
758
759         return not_off_during_pm ? 0 : 1;
760 }
761
762 static void caam_state_save(struct device *dev)
763 {
764         struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
765         struct caam_ctl_state *state = &ctrlpriv->state;
766         struct caam_ctrl __iomem *ctrl = ctrlpriv->ctrl;
767         u32 deco_inst, jr_inst;
768         int i;
769
770         state->mcr = rd_reg32(&ctrl->mcr);
771         state->scfgr = rd_reg32(&ctrl->scfgr);
772
773         deco_inst = (rd_reg32(&ctrl->perfmon.cha_num_ms) &
774                      CHA_ID_MS_DECO_MASK) >> CHA_ID_MS_DECO_SHIFT;
775         for (i = 0; i < deco_inst; i++) {
776                 state->deco_mid[i].liodn_ms =
777                         rd_reg32(&ctrl->deco_mid[i].liodn_ms);
778                 state->deco_mid[i].liodn_ls =
779                         rd_reg32(&ctrl->deco_mid[i].liodn_ls);
780         }
781
782         jr_inst = (rd_reg32(&ctrl->perfmon.cha_num_ms) &
783                    CHA_ID_MS_JR_MASK) >> CHA_ID_MS_JR_SHIFT;
784         for (i = 0; i < jr_inst; i++) {
785                 state->jr_mid[i].liodn_ms =
786                         rd_reg32(&ctrl->jr_mid[i].liodn_ms);
787                 state->jr_mid[i].liodn_ls =
788                         rd_reg32(&ctrl->jr_mid[i].liodn_ls);
789         }
790 }
791
792 static void caam_state_restore(const struct device *dev)
793 {
794         const struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
795         const struct caam_ctl_state *state = &ctrlpriv->state;
796         struct caam_ctrl __iomem *ctrl = ctrlpriv->ctrl;
797         u32 deco_inst, jr_inst;
798         int i;
799
800         wr_reg32(&ctrl->mcr, state->mcr);
801         wr_reg32(&ctrl->scfgr, state->scfgr);
802
803         deco_inst = (rd_reg32(&ctrl->perfmon.cha_num_ms) &
804                      CHA_ID_MS_DECO_MASK) >> CHA_ID_MS_DECO_SHIFT;
805         for (i = 0; i < deco_inst; i++) {
806                 wr_reg32(&ctrl->deco_mid[i].liodn_ms,
807                          state->deco_mid[i].liodn_ms);
808                 wr_reg32(&ctrl->deco_mid[i].liodn_ls,
809                          state->deco_mid[i].liodn_ls);
810         }
811
812         jr_inst = (rd_reg32(&ctrl->perfmon.cha_num_ms) &
813                    CHA_ID_MS_JR_MASK) >> CHA_ID_MS_JR_SHIFT;
814         for (i = 0; i < jr_inst; i++) {
815                 wr_reg32(&ctrl->jr_mid[i].liodn_ms,
816                          state->jr_mid[i].liodn_ms);
817                 wr_reg32(&ctrl->jr_mid[i].liodn_ls,
818                          state->jr_mid[i].liodn_ls);
819         }
820
821         if (ctrlpriv->virt_en == 1)
822                 clrsetbits_32(&ctrl->jrstart, 0, JRSTART_JR0_START |
823                               JRSTART_JR1_START | JRSTART_JR2_START |
824                               JRSTART_JR3_START);
825 }
826
827 static int caam_ctrl_suspend(struct device *dev)
828 {
829         const struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
830
831         if (ctrlpriv->caam_off_during_pm && !ctrlpriv->optee_en)
832                 caam_state_save(dev);
833
834         return 0;
835 }
836
837 static int caam_ctrl_resume(struct device *dev)
838 {
839         struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev);
840         int ret = 0;
841
842         if (ctrlpriv->caam_off_during_pm && !ctrlpriv->optee_en) {
843                 caam_state_restore(dev);
844
845                 /* HW and rng will be reset so deinstantiation can be removed */
846                 devm_remove_action(dev, devm_deinstantiate_rng, dev);
847                 ret = caam_ctrl_rng_init(dev);
848         }
849
850         return ret;
851 }
852
853 static DEFINE_SIMPLE_DEV_PM_OPS(caam_ctrl_pm_ops, caam_ctrl_suspend, caam_ctrl_resume);
854
855 /* Probe routine for CAAM top (controller) level */
856 static int caam_probe(struct platform_device *pdev)
857 {
858         int ret, ring;
859         u64 caam_id;
860         const struct soc_device_attribute *imx_soc_match;
861         struct device *dev;
862         struct device_node *nprop, *np;
863         struct caam_ctrl __iomem *ctrl;
864         struct caam_drv_private *ctrlpriv;
865         struct caam_perfmon __iomem *perfmon;
866         struct dentry *dfs_root;
867         u32 scfgr, comp_params;
868         int pg_size;
869         int BLOCK_OFFSET = 0;
870         bool reg_access = true;
871         const struct caam_imx_data *imx_soc_data;
872
873         ctrlpriv = devm_kzalloc(&pdev->dev, sizeof(*ctrlpriv), GFP_KERNEL);
874         if (!ctrlpriv)
875                 return -ENOMEM;
876
877         dev = &pdev->dev;
878         dev_set_drvdata(dev, ctrlpriv);
879         nprop = pdev->dev.of_node;
880
881         imx_soc_match = soc_device_match(caam_imx_soc_table);
882         if (!imx_soc_match && of_match_node(imx8m_machine_match, of_root))
883                 return -EPROBE_DEFER;
884
885         caam_imx = (bool)imx_soc_match;
886
887         ctrlpriv->caam_off_during_pm = caam_imx && caam_off_during_pm();
888
889         if (imx_soc_match) {
890                 /*
891                  * Until Layerscape and i.MX OP-TEE get in sync,
892                  * only i.MX OP-TEE use cases disallow access to
893                  * caam page 0 (controller) registers.
894                  */
895                 np = of_find_compatible_node(NULL, NULL, "linaro,optee-tz");
896                 ctrlpriv->optee_en = !!np;
897                 of_node_put(np);
898
899                 reg_access = !ctrlpriv->optee_en;
900
901                 if (!imx_soc_match->data) {
902                         dev_err(dev, "No clock data provided for i.MX SoC");
903                         return -EINVAL;
904                 }
905
906                 imx_soc_data = imx_soc_match->data;
907                 reg_access = reg_access && imx_soc_data->page0_access;
908                 /*
909                  * CAAM clocks cannot be controlled from kernel.
910                  */
911                 if (!imx_soc_data->num_clks)
912                         goto iomap_ctrl;
913
914                 ret = init_clocks(dev, imx_soc_match->data);
915                 if (ret)
916                         return ret;
917         }
918
919 iomap_ctrl:
920         /* Get configuration properties from device tree */
921         /* First, get register page */
922         ctrl = devm_of_iomap(dev, nprop, 0, NULL);
923         ret = PTR_ERR_OR_ZERO(ctrl);
924         if (ret) {
925                 dev_err(dev, "caam: of_iomap() failed\n");
926                 return ret;
927         }
928
929         ring = 0;
930         for_each_available_child_of_node(nprop, np)
931                 if (of_device_is_compatible(np, "fsl,sec-v4.0-job-ring") ||
932                     of_device_is_compatible(np, "fsl,sec4.0-job-ring")) {
933                         u32 reg;
934
935                         if (of_property_read_u32_index(np, "reg", 0, &reg)) {
936                                 dev_err(dev, "%s read reg property error\n",
937                                         np->full_name);
938                                 continue;
939                         }
940
941                         ctrlpriv->jr[ring] = (struct caam_job_ring __iomem __force *)
942                                              ((__force uint8_t *)ctrl + reg);
943
944                         ctrlpriv->total_jobrs++;
945                         ring++;
946                 }
947
948         /*
949          * Wherever possible, instead of accessing registers from the global page,
950          * use the alias registers in the first (cf. DT nodes order)
951          * job ring's page.
952          */
953         perfmon = ring ? (struct caam_perfmon __iomem *)&ctrlpriv->jr[0]->perfmon :
954                          (struct caam_perfmon __iomem *)&ctrl->perfmon;
955
956         caam_little_end = !(bool)(rd_reg32(&perfmon->status) &
957                                   (CSTA_PLEND | CSTA_ALT_PLEND));
958         comp_params = rd_reg32(&perfmon->comp_parms_ms);
959         if (reg_access && comp_params & CTPR_MS_PS &&
960             rd_reg32(&ctrl->mcr) & MCFGR_LONG_PTR)
961                 caam_ptr_sz = sizeof(u64);
962         else
963                 caam_ptr_sz = sizeof(u32);
964         caam_dpaa2 = !!(comp_params & CTPR_MS_DPAA2);
965         ctrlpriv->qi_present = !!(comp_params & CTPR_MS_QI_MASK);
966
967 #ifdef CONFIG_CAAM_QI
968         /* If (DPAA 1.x) QI present, check whether dependencies are available */
969         if (ctrlpriv->qi_present && !caam_dpaa2) {
970                 ret = qman_is_probed();
971                 if (!ret) {
972                         return -EPROBE_DEFER;
973                 } else if (ret < 0) {
974                         dev_err(dev, "failing probe due to qman probe error\n");
975                         return -ENODEV;
976                 }
977
978                 ret = qman_portals_probed();
979                 if (!ret) {
980                         return -EPROBE_DEFER;
981                 } else if (ret < 0) {
982                         dev_err(dev, "failing probe due to qman portals probe error\n");
983                         return -ENODEV;
984                 }
985         }
986 #endif
987
988         /* Allocating the BLOCK_OFFSET based on the supported page size on
989          * the platform
990          */
991         pg_size = (comp_params & CTPR_MS_PG_SZ_MASK) >> CTPR_MS_PG_SZ_SHIFT;
992         if (pg_size == 0)
993                 BLOCK_OFFSET = PG_SIZE_4K;
994         else
995                 BLOCK_OFFSET = PG_SIZE_64K;
996
997         ctrlpriv->ctrl = (struct caam_ctrl __iomem __force *)ctrl;
998         ctrlpriv->assure = (struct caam_assurance __iomem __force *)
999                            ((__force uint8_t *)ctrl +
1000                             BLOCK_OFFSET * ASSURE_BLOCK_NUMBER
1001                            );
1002         ctrlpriv->deco = (struct caam_deco __iomem __force *)
1003                          ((__force uint8_t *)ctrl +
1004                          BLOCK_OFFSET * DECO_BLOCK_NUMBER
1005                          );
1006
1007         /* Get the IRQ of the controller (for security violations only) */
1008         ctrlpriv->secvio_irq = irq_of_parse_and_map(nprop, 0);
1009         np = of_find_compatible_node(NULL, NULL, "fsl,qoriq-mc");
1010         ctrlpriv->mc_en = !!np;
1011         of_node_put(np);
1012
1013 #ifdef CONFIG_FSL_MC_BUS
1014         if (ctrlpriv->mc_en) {
1015                 struct fsl_mc_version *mc_version;
1016
1017                 mc_version = fsl_mc_get_version();
1018                 if (mc_version)
1019                         ctrlpriv->pr_support = check_version(mc_version, 10, 20,
1020                                                              0);
1021                 else
1022                         return -EPROBE_DEFER;
1023         }
1024 #endif
1025
1026         if (!reg_access)
1027                 goto set_dma_mask;
1028
1029         /*
1030          * Enable DECO watchdogs and, if this is a PHYS_ADDR_T_64BIT kernel,
1031          * long pointers in master configuration register.
1032          * In case of SoCs with Management Complex, MC f/w performs
1033          * the configuration.
1034          */
1035         if (!ctrlpriv->mc_en)
1036                 clrsetbits_32(&ctrl->mcr, MCFGR_AWCACHE_MASK,
1037                               MCFGR_AWCACHE_CACH | MCFGR_AWCACHE_BUFF |
1038                               MCFGR_WDENABLE | MCFGR_LARGE_BURST);
1039
1040         handle_imx6_err005766(&ctrl->mcr);
1041
1042         /*
1043          *  Read the Compile Time parameters and SCFGR to determine
1044          * if virtualization is enabled for this platform
1045          */
1046         scfgr = rd_reg32(&ctrl->scfgr);
1047
1048         ctrlpriv->virt_en = 0;
1049         if (comp_params & CTPR_MS_VIRT_EN_INCL) {
1050                 /* VIRT_EN_INCL = 1 & VIRT_EN_POR = 1 or
1051                  * VIRT_EN_INCL = 1 & VIRT_EN_POR = 0 & SCFGR_VIRT_EN = 1
1052                  */
1053                 if ((comp_params & CTPR_MS_VIRT_EN_POR) ||
1054                     (!(comp_params & CTPR_MS_VIRT_EN_POR) &&
1055                        (scfgr & SCFGR_VIRT_EN)))
1056                                 ctrlpriv->virt_en = 1;
1057         } else {
1058                 /* VIRT_EN_INCL = 0 && VIRT_EN_POR_VALUE = 1 */
1059                 if (comp_params & CTPR_MS_VIRT_EN_POR)
1060                                 ctrlpriv->virt_en = 1;
1061         }
1062
1063         if (ctrlpriv->virt_en == 1)
1064                 clrsetbits_32(&ctrl->jrstart, 0, JRSTART_JR0_START |
1065                               JRSTART_JR1_START | JRSTART_JR2_START |
1066                               JRSTART_JR3_START);
1067
1068 set_dma_mask:
1069         ret = dma_set_mask_and_coherent(dev, caam_get_dma_mask(dev));
1070         if (ret) {
1071                 dev_err(dev, "dma_set_mask_and_coherent failed (%d)\n", ret);
1072                 return ret;
1073         }
1074
1075         ctrlpriv->era = caam_get_era(perfmon);
1076         ctrlpriv->domain = iommu_get_domain_for_dev(dev);
1077
1078         dfs_root = debugfs_create_dir(dev_name(dev), NULL);
1079         if (IS_ENABLED(CONFIG_DEBUG_FS)) {
1080                 ret = devm_add_action_or_reset(dev, caam_remove_debugfs,
1081                                                dfs_root);
1082                 if (ret)
1083                         return ret;
1084         }
1085
1086         caam_debugfs_init(ctrlpriv, perfmon, dfs_root);
1087
1088         /* Check to see if (DPAA 1.x) QI present. If so, enable */
1089         if (ctrlpriv->qi_present && !caam_dpaa2) {
1090                 ctrlpriv->qi = (struct caam_queue_if __iomem __force *)
1091                                ((__force uint8_t *)ctrl +
1092                                  BLOCK_OFFSET * QI_BLOCK_NUMBER
1093                                );
1094                 /* This is all that's required to physically enable QI */
1095                 wr_reg32(&ctrlpriv->qi->qi_control_lo, QICTL_DQEN);
1096
1097                 /* If QMAN driver is present, init CAAM-QI backend */
1098 #ifdef CONFIG_CAAM_QI
1099                 ret = caam_qi_init(pdev);
1100                 if (ret)
1101                         dev_err(dev, "caam qi i/f init failed: %d\n", ret);
1102 #endif
1103         }
1104
1105         /* If no QI and no rings specified, quit and go home */
1106         if ((!ctrlpriv->qi_present) && (!ctrlpriv->total_jobrs)) {
1107                 dev_err(dev, "no queues configured, terminating\n");
1108                 return -ENOMEM;
1109         }
1110
1111         comp_params = rd_reg32(&perfmon->comp_parms_ls);
1112         ctrlpriv->blob_present = !!(comp_params & CTPR_LS_BLOB);
1113
1114         /*
1115          * Some SoCs like the LS1028A (non-E) indicate CTPR_LS_BLOB support,
1116          * but fail when actually using it due to missing AES support, so
1117          * check both here.
1118          */
1119         if (ctrlpriv->era < 10) {
1120                 ctrlpriv->blob_present = ctrlpriv->blob_present &&
1121                         (rd_reg32(&perfmon->cha_num_ls) & CHA_ID_LS_AES_MASK);
1122         } else {
1123                 struct version_regs __iomem *vreg;
1124
1125                 vreg =  ctrlpriv->total_jobrs ?
1126                         (struct version_regs __iomem *)&ctrlpriv->jr[0]->vreg :
1127                         (struct version_regs __iomem *)&ctrl->vreg;
1128
1129                 ctrlpriv->blob_present = ctrlpriv->blob_present &&
1130                         (rd_reg32(&vreg->aesa) & CHA_VER_MISC_AES_NUM_MASK);
1131         }
1132
1133         if (reg_access) {
1134                 ret = caam_ctrl_rng_init(dev);
1135                 if (ret)
1136                         return ret;
1137         }
1138
1139         caam_id = (u64)rd_reg32(&perfmon->caam_id_ms) << 32 |
1140                   (u64)rd_reg32(&perfmon->caam_id_ls);
1141
1142         /* Report "alive" for developer to see */
1143         dev_info(dev, "device ID = 0x%016llx (Era %d)\n", caam_id,
1144                  ctrlpriv->era);
1145         dev_info(dev, "job rings = %d, qi = %d\n",
1146                  ctrlpriv->total_jobrs, ctrlpriv->qi_present);
1147
1148         ret = devm_of_platform_populate(dev);
1149         if (ret)
1150                 dev_err(dev, "JR platform devices creation error\n");
1151
1152         return ret;
1153 }
1154
1155 static struct platform_driver caam_driver = {
1156         .driver = {
1157                 .name = "caam",
1158                 .of_match_table = caam_match,
1159                 .pm = pm_ptr(&caam_ctrl_pm_ops),
1160         },
1161         .probe       = caam_probe,
1162 };
1163
1164 module_platform_driver(caam_driver);
1165
1166 MODULE_LICENSE("GPL");
1167 MODULE_DESCRIPTION("FSL CAAM request backend");
1168 MODULE_AUTHOR("Freescale Semiconductor - NMG/STC");
This page took 0.105918 seconds and 4 git commands to generate.