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/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); 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); 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 /* Clear the contents before using the descriptor */ 289 memset(desc, 0x00, CAAM_CMD_SZ * 7); 290 291 /* 292 * If the corresponding bit is set, this state handle 293 * was initialized by somebody else, so it's left alone. 294 */ 295 if (rdsta_if & state_handle_mask) { 296 if (rdsta_pr & state_handle_mask) 297 continue; 298 299 dev_info(ctrldev, 300 "RNG4 SH%d was previously instantiated without prediction resistance. Tearing it down\n", 301 sh_idx); 302 303 ret = deinstantiate_rng(ctrldev, rdsta_if); 304 if (ret) 305 break; 306 } 307 308 /* Create the descriptor for instantiating RNG State Handle */ 309 build_instantiation_desc(desc, sh_idx, gen_sk); 310 311 /* Try to run it through DECO0 */ 312 ret = run_descriptor_deco0(ctrldev, desc, &status); 313 314 /* 315 * If ret is not 0, or descriptor status is not 0, then 316 * something went wrong. No need to try the next state 317 * handle (if available), bail out here. 318 * Also, if for some reason, the State Handle didn't get 319 * instantiated although the descriptor has finished 320 * without any error (HW optimizations for later 321 * CAAM eras), then try again. 322 */ 323 if (ret) 324 break; 325 326 rdsta_val = rd_reg32(&ctrl->r4tst[0].rdsta) & RDSTA_MASK; 327 if ((status && status != JRSTA_SSRC_JUMP_HALT_CC) || 328 (rdsta_val & rdsta_mask) != rdsta_mask) { 329 ret = -EAGAIN; 330 break; 331 } 332 333 dev_info(ctrldev, "Instantiated RNG4 SH%d\n", sh_idx); 334 } 335 336 kfree(desc); 337 338 if (ret) 339 return ret; 340 341 return devm_add_action_or_reset(ctrldev, devm_deinstantiate_rng, ctrldev); 342 } 343 344 /* 345 * kick_trng - sets the various parameters for enabling the initialization 346 * of the RNG4 block in CAAM 347 * @dev - pointer to the controller device 348 * @ent_delay - Defines the length (in system clocks) of each entropy sample. 349 */ 350 static void kick_trng(struct device *dev, int ent_delay) 351 { 352 struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev); 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_perfmon __iomem *perfmon) 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(&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(&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 * @perfmon: Performance Monitor Registers 449 */ 450 static int caam_get_era(struct caam_perfmon __iomem *perfmon) 451 { 452 struct device_node *caam_node; 453 int ret; 454 u32 prop; 455 456 caam_node = of_find_compatible_node(NULL, NULL, "fsl,sec-v4.0"); 457 ret = of_property_read_u32(caam_node, "fsl,sec-era", &prop); 458 of_node_put(caam_node); 459 460 if (!ret) 461 return prop; 462 else 463 return caam_get_era_from_hw(perfmon); 464 } 465 466 /* 467 * ERRATA: imx6 devices (imx6D, imx6Q, imx6DL, imx6S, imx6DP and imx6QP) 468 * have an issue wherein AXI bus transactions may not occur in the correct 469 * order. This isn't a problem running single descriptors, but can be if 470 * running multiple concurrent descriptors. Reworking the driver to throttle 471 * to single requests is impractical, thus the workaround is to limit the AXI 472 * pipeline to a depth of 1 (from it's default of 4) to preclude this situation 473 * from occurring. 474 */ 475 static void handle_imx6_err005766(u32 __iomem *mcr) 476 { 477 if (of_machine_is_compatible("fsl,imx6q") || 478 of_machine_is_compatible("fsl,imx6dl") || 479 of_machine_is_compatible("fsl,imx6qp")) 480 clrsetbits_32(mcr, MCFGR_AXIPIPE_MASK, 481 1 << MCFGR_AXIPIPE_SHIFT); 482 } 483 484 static const struct of_device_id caam_match[] = { 485 { 486 .compatible = "fsl,sec-v4.0", 487 }, 488 { 489 .compatible = "fsl,sec4.0", 490 }, 491 {}, 492 }; 493 MODULE_DEVICE_TABLE(of, caam_match); 494 495 struct caam_imx_data { 496 const struct clk_bulk_data *clks; 497 int num_clks; 498 }; 499 500 static const struct clk_bulk_data caam_imx6_clks[] = { 501 { .id = "ipg" }, 502 { .id = "mem" }, 503 { .id = "aclk" }, 504 { .id = "emi_slow" }, 505 }; 506 507 static const struct caam_imx_data caam_imx6_data = { 508 .clks = caam_imx6_clks, 509 .num_clks = ARRAY_SIZE(caam_imx6_clks), 510 }; 511 512 static const struct clk_bulk_data caam_imx7_clks[] = { 513 { .id = "ipg" }, 514 { .id = "aclk" }, 515 }; 516 517 static const struct caam_imx_data caam_imx7_data = { 518 .clks = caam_imx7_clks, 519 .num_clks = ARRAY_SIZE(caam_imx7_clks), 520 }; 521 522 static const struct clk_bulk_data caam_imx6ul_clks[] = { 523 { .id = "ipg" }, 524 { .id = "mem" }, 525 { .id = "aclk" }, 526 }; 527 528 static const struct caam_imx_data caam_imx6ul_data = { 529 .clks = caam_imx6ul_clks, 530 .num_clks = ARRAY_SIZE(caam_imx6ul_clks), 531 }; 532 533 static const struct clk_bulk_data caam_vf610_clks[] = { 534 { .id = "ipg" }, 535 }; 536 537 static const struct caam_imx_data caam_vf610_data = { 538 .clks = caam_vf610_clks, 539 .num_clks = ARRAY_SIZE(caam_vf610_clks), 540 }; 541 542 static const struct soc_device_attribute caam_imx_soc_table[] = { 543 { .soc_id = "i.MX6UL", .data = &caam_imx6ul_data }, 544 { .soc_id = "i.MX6*", .data = &caam_imx6_data }, 545 { .soc_id = "i.MX7*", .data = &caam_imx7_data }, 546 { .soc_id = "i.MX8M*", .data = &caam_imx7_data }, 547 { .soc_id = "VF*", .data = &caam_vf610_data }, 548 { .family = "Freescale i.MX" }, 549 { /* sentinel */ } 550 }; 551 552 static void disable_clocks(void *data) 553 { 554 struct caam_drv_private *ctrlpriv = data; 555 556 clk_bulk_disable_unprepare(ctrlpriv->num_clks, ctrlpriv->clks); 557 } 558 559 static int init_clocks(struct device *dev, const struct caam_imx_data *data) 560 { 561 struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev); 562 int ret; 563 564 ctrlpriv->num_clks = data->num_clks; 565 ctrlpriv->clks = devm_kmemdup(dev, data->clks, 566 data->num_clks * sizeof(data->clks[0]), 567 GFP_KERNEL); 568 if (!ctrlpriv->clks) 569 return -ENOMEM; 570 571 ret = devm_clk_bulk_get(dev, ctrlpriv->num_clks, ctrlpriv->clks); 572 if (ret) { 573 dev_err(dev, 574 "Failed to request all necessary clocks\n"); 575 return ret; 576 } 577 578 ret = clk_bulk_prepare_enable(ctrlpriv->num_clks, ctrlpriv->clks); 579 if (ret) { 580 dev_err(dev, 581 "Failed to prepare/enable all necessary clocks\n"); 582 return ret; 583 } 584 585 return devm_add_action_or_reset(dev, disable_clocks, ctrlpriv); 586 } 587 588 static void caam_remove_debugfs(void *root) 589 { 590 debugfs_remove_recursive(root); 591 } 592 593 #ifdef CONFIG_FSL_MC_BUS 594 static bool check_version(struct fsl_mc_version *mc_version, u32 major, 595 u32 minor, u32 revision) 596 { 597 if (mc_version->major > major) 598 return true; 599 600 if (mc_version->major == major) { 601 if (mc_version->minor > minor) 602 return true; 603 604 if (mc_version->minor == minor && 605 mc_version->revision > revision) 606 return true; 607 } 608 609 return false; 610 } 611 #endif 612 613 static bool needs_entropy_delay_adjustment(void) 614 { 615 if (of_machine_is_compatible("fsl,imx6sx")) 616 return true; 617 return false; 618 } 619 620 static int caam_ctrl_rng_init(struct device *dev) 621 { 622 struct caam_drv_private *ctrlpriv = dev_get_drvdata(dev); 623 struct caam_ctrl __iomem *ctrl = ctrlpriv->ctrl; 624 int ret, gen_sk, ent_delay = RTSDCTL_ENT_DLY_MIN; 625 u8 rng_vid; 626 627 if (ctrlpriv->era < 10) { 628 struct caam_perfmon __iomem *perfmon; 629 630 perfmon = ctrlpriv->total_jobrs ? 631 (struct caam_perfmon __iomem *)&ctrlpriv->jr[0]->perfmon : 632 (struct caam_perfmon __iomem *)&ctrl->perfmon; 633 634 rng_vid = (rd_reg32(&perfmon->cha_id_ls) & 635 CHA_ID_LS_RNG_MASK) >> CHA_ID_LS_RNG_SHIFT; 636 } else { 637 struct version_regs __iomem *vreg; 638 639 vreg = ctrlpriv->total_jobrs ? 640 (struct version_regs __iomem *)&ctrlpriv->jr[0]->vreg : 641 (struct version_regs __iomem *)&ctrl->vreg; 642 643 rng_vid = (rd_reg32(&vreg->rng) & CHA_VER_VID_MASK) >> 644 CHA_VER_VID_SHIFT; 645 } 646 647 /* 648 * If SEC has RNG version >= 4 and RNG state handle has not been 649 * already instantiated, do RNG instantiation 650 * In case of SoCs with Management Complex, RNG is managed by MC f/w. 651 */ 652 if (!(ctrlpriv->mc_en && ctrlpriv->pr_support) && rng_vid >= 4) { 653 ctrlpriv->rng4_sh_init = 654 rd_reg32(&ctrl->r4tst[0].rdsta); 655 /* 656 * If the secure keys (TDKEK, JDKEK, TDSK), were already 657 * generated, signal this to the function that is instantiating 658 * the state handles. An error would occur if RNG4 attempts 659 * to regenerate these keys before the next POR. 660 */ 661 gen_sk = ctrlpriv->rng4_sh_init & RDSTA_SKVN ? 0 : 1; 662 ctrlpriv->rng4_sh_init &= RDSTA_MASK; 663 do { 664 int inst_handles = 665 rd_reg32(&ctrl->r4tst[0].rdsta) & RDSTA_MASK; 666 /* 667 * If either SH were instantiated by somebody else 668 * (e.g. u-boot) then it is assumed that the entropy 669 * parameters are properly set and thus the function 670 * setting these (kick_trng(...)) is skipped. 671 * Also, if a handle was instantiated, do not change 672 * the TRNG parameters. 673 */ 674 if (needs_entropy_delay_adjustment()) 675 ent_delay = 12000; 676 if (!(ctrlpriv->rng4_sh_init || inst_handles)) { 677 dev_info(dev, 678 "Entropy delay = %u\n", 679 ent_delay); 680 kick_trng(dev, ent_delay); 681 ent_delay += 400; 682 } 683 /* 684 * if instantiate_rng(...) fails, the loop will rerun 685 * and the kick_trng(...) function will modify the 686 * upper and lower limits of the entropy sampling 687 * interval, leading to a successful initialization of 688 * the RNG. 689 */ 690 ret = instantiate_rng(dev, inst_handles, 691 gen_sk); 692 /* 693 * Entropy delay is determined via TRNG characterization. 694 * TRNG characterization is run across different voltages 695 * and temperatures. 696 * If worst case value for ent_dly is identified, 697 * the loop can be skipped for that platform. 698 */ 699 if (needs_entropy_delay_adjustment()) 700 break; 701 if (ret == -EAGAIN) 702 /* 703 * if here, the loop will rerun, 704 * so don't hog the CPU 705 */ 706 cpu_relax(); 707 } while ((ret == -EAGAIN) && (ent_delay < RTSDCTL_ENT_DLY_MAX)); 708 if (ret) { 709 dev_err(dev, "failed to instantiate RNG"); 710 return ret; 711 } 712 /* 713 * Set handles initialized by this module as the complement of 714 * the already initialized ones 715 */ 716 ctrlpriv->rng4_sh_init = ~ctrlpriv->rng4_sh_init & RDSTA_MASK; 717 718 /* Enable RDB bit so that RNG works faster */ 719 clrsetbits_32(&ctrl->scfgr, 0, SCFGR_RDBENABLE); 720 } 721 722 return 0; 723 } 724 725 /* Probe routine for CAAM top (controller) level */ 726 static int caam_probe(struct platform_device *pdev) 727 { 728 int ret, ring; 729 u64 caam_id; 730 const struct soc_device_attribute *imx_soc_match; 731 struct device *dev; 732 struct device_node *nprop, *np; 733 struct caam_ctrl __iomem *ctrl; 734 struct caam_drv_private *ctrlpriv; 735 struct caam_perfmon __iomem *perfmon; 736 struct dentry *dfs_root; 737 u32 scfgr, comp_params; 738 int pg_size; 739 int BLOCK_OFFSET = 0; 740 bool reg_access = true; 741 742 ctrlpriv = devm_kzalloc(&pdev->dev, sizeof(*ctrlpriv), GFP_KERNEL); 743 if (!ctrlpriv) 744 return -ENOMEM; 745 746 dev = &pdev->dev; 747 dev_set_drvdata(dev, ctrlpriv); 748 nprop = pdev->dev.of_node; 749 750 imx_soc_match = soc_device_match(caam_imx_soc_table); 751 caam_imx = (bool)imx_soc_match; 752 753 if (imx_soc_match) { 754 /* 755 * Until Layerscape and i.MX OP-TEE get in sync, 756 * only i.MX OP-TEE use cases disallow access to 757 * caam page 0 (controller) registers. 758 */ 759 np = of_find_compatible_node(NULL, NULL, "linaro,optee-tz"); 760 ctrlpriv->optee_en = !!np; 761 of_node_put(np); 762 763 reg_access = !ctrlpriv->optee_en; 764 765 if (!imx_soc_match->data) { 766 dev_err(dev, "No clock data provided for i.MX SoC"); 767 return -EINVAL; 768 } 769 770 ret = init_clocks(dev, imx_soc_match->data); 771 if (ret) 772 return ret; 773 } 774 775 776 /* Get configuration properties from device tree */ 777 /* First, get register page */ 778 ctrl = devm_of_iomap(dev, nprop, 0, NULL); 779 ret = PTR_ERR_OR_ZERO(ctrl); 780 if (ret) { 781 dev_err(dev, "caam: of_iomap() failed\n"); 782 return ret; 783 } 784 785 ring = 0; 786 for_each_available_child_of_node(nprop, np) 787 if (of_device_is_compatible(np, "fsl,sec-v4.0-job-ring") || 788 of_device_is_compatible(np, "fsl,sec4.0-job-ring")) { 789 u32 reg; 790 791 if (of_property_read_u32_index(np, "reg", 0, ®)) { 792 dev_err(dev, "%s read reg property error\n", 793 np->full_name); 794 continue; 795 } 796 797 ctrlpriv->jr[ring] = (struct caam_job_ring __iomem __force *) 798 ((__force uint8_t *)ctrl + reg); 799 800 ctrlpriv->total_jobrs++; 801 ring++; 802 } 803 804 /* 805 * Wherever possible, instead of accessing registers from the global page, 806 * use the alias registers in the first (cf. DT nodes order) 807 * job ring's page. 808 */ 809 perfmon = ring ? (struct caam_perfmon __iomem *)&ctrlpriv->jr[0]->perfmon : 810 (struct caam_perfmon __iomem *)&ctrl->perfmon; 811 812 caam_little_end = !(bool)(rd_reg32(&perfmon->status) & 813 (CSTA_PLEND | CSTA_ALT_PLEND)); 814 comp_params = rd_reg32(&perfmon->comp_parms_ms); 815 if (reg_access && comp_params & CTPR_MS_PS && 816 rd_reg32(&ctrl->mcr) & MCFGR_LONG_PTR) 817 caam_ptr_sz = sizeof(u64); 818 else 819 caam_ptr_sz = sizeof(u32); 820 caam_dpaa2 = !!(comp_params & CTPR_MS_DPAA2); 821 ctrlpriv->qi_present = !!(comp_params & CTPR_MS_QI_MASK); 822 823 #ifdef CONFIG_CAAM_QI 824 /* If (DPAA 1.x) QI present, check whether dependencies are available */ 825 if (ctrlpriv->qi_present && !caam_dpaa2) { 826 ret = qman_is_probed(); 827 if (!ret) { 828 return -EPROBE_DEFER; 829 } else if (ret < 0) { 830 dev_err(dev, "failing probe due to qman probe error\n"); 831 return -ENODEV; 832 } 833 834 ret = qman_portals_probed(); 835 if (!ret) { 836 return -EPROBE_DEFER; 837 } else if (ret < 0) { 838 dev_err(dev, "failing probe due to qman portals probe error\n"); 839 return -ENODEV; 840 } 841 } 842 #endif 843 844 /* Allocating the BLOCK_OFFSET based on the supported page size on 845 * the platform 846 */ 847 pg_size = (comp_params & CTPR_MS_PG_SZ_MASK) >> CTPR_MS_PG_SZ_SHIFT; 848 if (pg_size == 0) 849 BLOCK_OFFSET = PG_SIZE_4K; 850 else 851 BLOCK_OFFSET = PG_SIZE_64K; 852 853 ctrlpriv->ctrl = (struct caam_ctrl __iomem __force *)ctrl; 854 ctrlpriv->assure = (struct caam_assurance __iomem __force *) 855 ((__force uint8_t *)ctrl + 856 BLOCK_OFFSET * ASSURE_BLOCK_NUMBER 857 ); 858 ctrlpriv->deco = (struct caam_deco __iomem __force *) 859 ((__force uint8_t *)ctrl + 860 BLOCK_OFFSET * DECO_BLOCK_NUMBER 861 ); 862 863 /* Get the IRQ of the controller (for security violations only) */ 864 ctrlpriv->secvio_irq = irq_of_parse_and_map(nprop, 0); 865 np = of_find_compatible_node(NULL, NULL, "fsl,qoriq-mc"); 866 ctrlpriv->mc_en = !!np; 867 of_node_put(np); 868 869 #ifdef CONFIG_FSL_MC_BUS 870 if (ctrlpriv->mc_en) { 871 struct fsl_mc_version *mc_version; 872 873 mc_version = fsl_mc_get_version(); 874 if (mc_version) 875 ctrlpriv->pr_support = check_version(mc_version, 10, 20, 876 0); 877 else 878 return -EPROBE_DEFER; 879 } 880 #endif 881 882 if (!reg_access) 883 goto set_dma_mask; 884 885 /* 886 * Enable DECO watchdogs and, if this is a PHYS_ADDR_T_64BIT kernel, 887 * long pointers in master configuration register. 888 * In case of SoCs with Management Complex, MC f/w performs 889 * the configuration. 890 */ 891 if (!ctrlpriv->mc_en) 892 clrsetbits_32(&ctrl->mcr, MCFGR_AWCACHE_MASK, 893 MCFGR_AWCACHE_CACH | MCFGR_AWCACHE_BUFF | 894 MCFGR_WDENABLE | MCFGR_LARGE_BURST); 895 896 handle_imx6_err005766(&ctrl->mcr); 897 898 /* 899 * Read the Compile Time parameters and SCFGR to determine 900 * if virtualization is enabled for this platform 901 */ 902 scfgr = rd_reg32(&ctrl->scfgr); 903 904 ctrlpriv->virt_en = 0; 905 if (comp_params & CTPR_MS_VIRT_EN_INCL) { 906 /* VIRT_EN_INCL = 1 & VIRT_EN_POR = 1 or 907 * VIRT_EN_INCL = 1 & VIRT_EN_POR = 0 & SCFGR_VIRT_EN = 1 908 */ 909 if ((comp_params & CTPR_MS_VIRT_EN_POR) || 910 (!(comp_params & CTPR_MS_VIRT_EN_POR) && 911 (scfgr & SCFGR_VIRT_EN))) 912 ctrlpriv->virt_en = 1; 913 } else { 914 /* VIRT_EN_INCL = 0 && VIRT_EN_POR_VALUE = 1 */ 915 if (comp_params & CTPR_MS_VIRT_EN_POR) 916 ctrlpriv->virt_en = 1; 917 } 918 919 if (ctrlpriv->virt_en == 1) 920 clrsetbits_32(&ctrl->jrstart, 0, JRSTART_JR0_START | 921 JRSTART_JR1_START | JRSTART_JR2_START | 922 JRSTART_JR3_START); 923 924 set_dma_mask: 925 ret = dma_set_mask_and_coherent(dev, caam_get_dma_mask(dev)); 926 if (ret) { 927 dev_err(dev, "dma_set_mask_and_coherent failed (%d)\n", ret); 928 return ret; 929 } 930 931 ctrlpriv->era = caam_get_era(perfmon); 932 ctrlpriv->domain = iommu_get_domain_for_dev(dev); 933 934 dfs_root = debugfs_create_dir(dev_name(dev), NULL); 935 if (IS_ENABLED(CONFIG_DEBUG_FS)) { 936 ret = devm_add_action_or_reset(dev, caam_remove_debugfs, 937 dfs_root); 938 if (ret) 939 return ret; 940 } 941 942 caam_debugfs_init(ctrlpriv, perfmon, dfs_root); 943 944 /* Check to see if (DPAA 1.x) QI present. If so, enable */ 945 if (ctrlpriv->qi_present && !caam_dpaa2) { 946 ctrlpriv->qi = (struct caam_queue_if __iomem __force *) 947 ((__force uint8_t *)ctrl + 948 BLOCK_OFFSET * QI_BLOCK_NUMBER 949 ); 950 /* This is all that's required to physically enable QI */ 951 wr_reg32(&ctrlpriv->qi->qi_control_lo, QICTL_DQEN); 952 953 /* If QMAN driver is present, init CAAM-QI backend */ 954 #ifdef CONFIG_CAAM_QI 955 ret = caam_qi_init(pdev); 956 if (ret) 957 dev_err(dev, "caam qi i/f init failed: %d\n", ret); 958 #endif 959 } 960 961 /* If no QI and no rings specified, quit and go home */ 962 if ((!ctrlpriv->qi_present) && (!ctrlpriv->total_jobrs)) { 963 dev_err(dev, "no queues configured, terminating\n"); 964 return -ENOMEM; 965 } 966 967 comp_params = rd_reg32(&perfmon->comp_parms_ls); 968 ctrlpriv->blob_present = !!(comp_params & CTPR_LS_BLOB); 969 970 /* 971 * Some SoCs like the LS1028A (non-E) indicate CTPR_LS_BLOB support, 972 * but fail when actually using it due to missing AES support, so 973 * check both here. 974 */ 975 if (ctrlpriv->era < 10) { 976 ctrlpriv->blob_present = ctrlpriv->blob_present && 977 (rd_reg32(&perfmon->cha_num_ls) & CHA_ID_LS_AES_MASK); 978 } else { 979 struct version_regs __iomem *vreg; 980 981 vreg = ctrlpriv->total_jobrs ? 982 (struct version_regs __iomem *)&ctrlpriv->jr[0]->vreg : 983 (struct version_regs __iomem *)&ctrl->vreg; 984 985 ctrlpriv->blob_present = ctrlpriv->blob_present && 986 (rd_reg32(&vreg->aesa) & CHA_VER_MISC_AES_NUM_MASK); 987 } 988 989 if (reg_access) { 990 ret = caam_ctrl_rng_init(dev); 991 if (ret) 992 return ret; 993 } 994 995 caam_id = (u64)rd_reg32(&perfmon->caam_id_ms) << 32 | 996 (u64)rd_reg32(&perfmon->caam_id_ls); 997 998 /* Report "alive" for developer to see */ 999 dev_info(dev, "device ID = 0x%016llx (Era %d)\n", caam_id, 1000 ctrlpriv->era); 1001 dev_info(dev, "job rings = %d, qi = %d\n", 1002 ctrlpriv->total_jobrs, ctrlpriv->qi_present); 1003 1004 ret = devm_of_platform_populate(dev); 1005 if (ret) 1006 dev_err(dev, "JR platform devices creation error\n"); 1007 1008 return ret; 1009 } 1010 1011 static struct platform_driver caam_driver = { 1012 .driver = { 1013 .name = "caam", 1014 .of_match_table = caam_match, 1015 }, 1016 .probe = caam_probe, 1017 }; 1018 1019 module_platform_driver(caam_driver); 1020 1021 MODULE_LICENSE("GPL"); 1022 MODULE_DESCRIPTION("FSL CAAM request backend"); 1023 MODULE_AUTHOR("Freescale Semiconductor - NMG/STC"); 1024