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