xref: /rk3399_ARM-atf/plat/st/stm32mp1/bl2_plat_setup.c (revision f2de48cb143c20ccd7a9c141df3d34cae74049de)
1 /*
2  * Copyright (c) 2015-2022, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <assert.h>
8 #include <errno.h>
9 #include <string.h>
10 
11 #include <arch_helpers.h>
12 #include <common/bl_common.h>
13 #include <common/debug.h>
14 #include <common/desc_image_load.h>
15 #include <drivers/generic_delay_timer.h>
16 #include <drivers/mmc.h>
17 #include <drivers/st/bsec.h>
18 #include <drivers/st/regulator_fixed.h>
19 #include <drivers/st/stm32_iwdg.h>
20 #include <drivers/st/stm32_uart.h>
21 #include <drivers/st/stm32mp1_clk.h>
22 #include <drivers/st/stm32mp1_pwr.h>
23 #include <drivers/st/stm32mp1_ram.h>
24 #include <drivers/st/stm32mp_pmic.h>
25 #include <lib/fconf/fconf.h>
26 #include <lib/fconf/fconf_dyn_cfg_getter.h>
27 #include <lib/mmio.h>
28 #include <lib/optee_utils.h>
29 #include <lib/xlat_tables/xlat_tables_v2.h>
30 #include <plat/common/platform.h>
31 
32 #include <platform_def.h>
33 #include <stm32mp_common.h>
34 #include <stm32mp1_dbgmcu.h>
35 
36 #if DEBUG
37 static const char debug_msg[] = {
38 	"***************************************************\n"
39 	"** DEBUG ACCESS PORT IS OPEN!                    **\n"
40 	"** This boot image is only for debugging purpose **\n"
41 	"** and is unsafe for production use.             **\n"
42 	"**                                               **\n"
43 	"** If you see this message and you are not       **\n"
44 	"** debugging report this immediately to your     **\n"
45 	"** vendor!                                       **\n"
46 	"***************************************************\n"
47 };
48 #endif
49 
50 #if STM32MP15
51 static struct stm32mp_auth_ops stm32mp1_auth_ops;
52 #endif
53 
54 static void print_reset_reason(void)
55 {
56 	uint32_t rstsr = mmio_read_32(stm32mp_rcc_base() + RCC_MP_RSTSCLRR);
57 
58 	if (rstsr == 0U) {
59 		WARN("Reset reason unknown\n");
60 		return;
61 	}
62 
63 	INFO("Reset reason (0x%x):\n", rstsr);
64 
65 	if ((rstsr & RCC_MP_RSTSCLRR_PADRSTF) == 0U) {
66 		if ((rstsr & RCC_MP_RSTSCLRR_STDBYRSTF) != 0U) {
67 			INFO("System exits from STANDBY\n");
68 			return;
69 		}
70 
71 		if ((rstsr & RCC_MP_RSTSCLRR_CSTDBYRSTF) != 0U) {
72 			INFO("MPU exits from CSTANDBY\n");
73 			return;
74 		}
75 	}
76 
77 	if ((rstsr & RCC_MP_RSTSCLRR_PORRSTF) != 0U) {
78 		INFO("  Power-on Reset (rst_por)\n");
79 		return;
80 	}
81 
82 	if ((rstsr & RCC_MP_RSTSCLRR_BORRSTF) != 0U) {
83 		INFO("  Brownout Reset (rst_bor)\n");
84 		return;
85 	}
86 
87 #if STM32MP15
88 	if ((rstsr & RCC_MP_RSTSCLRR_MCSYSRSTF) != 0U) {
89 		if ((rstsr & RCC_MP_RSTSCLRR_PADRSTF) != 0U) {
90 			INFO("  System reset generated by MCU (MCSYSRST)\n");
91 		} else {
92 			INFO("  Local reset generated by MCU (MCSYSRST)\n");
93 		}
94 		return;
95 	}
96 #endif
97 
98 	if ((rstsr & RCC_MP_RSTSCLRR_MPSYSRSTF) != 0U) {
99 		INFO("  System reset generated by MPU (MPSYSRST)\n");
100 		return;
101 	}
102 
103 	if ((rstsr & RCC_MP_RSTSCLRR_HCSSRSTF) != 0U) {
104 		INFO("  Reset due to a clock failure on HSE\n");
105 		return;
106 	}
107 
108 	if ((rstsr & RCC_MP_RSTSCLRR_IWDG1RSTF) != 0U) {
109 		INFO("  IWDG1 Reset (rst_iwdg1)\n");
110 		return;
111 	}
112 
113 	if ((rstsr & RCC_MP_RSTSCLRR_IWDG2RSTF) != 0U) {
114 		INFO("  IWDG2 Reset (rst_iwdg2)\n");
115 		return;
116 	}
117 
118 	if ((rstsr & RCC_MP_RSTSCLRR_MPUP0RSTF) != 0U) {
119 		INFO("  MPU Processor 0 Reset\n");
120 		return;
121 	}
122 
123 #if STM32MP15
124 	if ((rstsr & RCC_MP_RSTSCLRR_MPUP1RSTF) != 0U) {
125 		INFO("  MPU Processor 1 Reset\n");
126 		return;
127 	}
128 #endif
129 
130 	if ((rstsr & RCC_MP_RSTSCLRR_PADRSTF) != 0U) {
131 		INFO("  Pad Reset from NRST\n");
132 		return;
133 	}
134 
135 	if ((rstsr & RCC_MP_RSTSCLRR_VCORERSTF) != 0U) {
136 		INFO("  Reset due to a failure of VDD_CORE\n");
137 		return;
138 	}
139 
140 	ERROR("  Unidentified reset reason\n");
141 }
142 
143 void bl2_el3_early_platform_setup(u_register_t arg0,
144 				  u_register_t arg1 __unused,
145 				  u_register_t arg2 __unused,
146 				  u_register_t arg3 __unused)
147 {
148 	stm32mp_setup_early_console();
149 
150 	stm32mp_save_boot_ctx_address(arg0);
151 }
152 
153 void bl2_platform_setup(void)
154 {
155 	int ret;
156 
157 	ret = stm32mp1_ddr_probe();
158 	if (ret < 0) {
159 		ERROR("Invalid DDR init: error %d\n", ret);
160 		panic();
161 	}
162 
163 	/* Map DDR for binary load, now with cacheable attribute */
164 	ret = mmap_add_dynamic_region(STM32MP_DDR_BASE, STM32MP_DDR_BASE,
165 				      STM32MP_DDR_MAX_SIZE, MT_MEMORY | MT_RW | MT_SECURE);
166 	if (ret < 0) {
167 		ERROR("DDR mapping: error %d\n", ret);
168 		panic();
169 	}
170 
171 #if STM32MP_USE_STM32IMAGE
172 #ifdef AARCH32_SP_OPTEE
173 	INFO("BL2 runs OP-TEE setup\n");
174 #else
175 	INFO("BL2 runs SP_MIN setup\n");
176 #endif
177 #endif /* STM32MP_USE_STM32IMAGE */
178 }
179 
180 #if STM32MP15
181 static void update_monotonic_counter(void)
182 {
183 	uint32_t version;
184 	uint32_t otp;
185 
186 	CASSERT(STM32_TF_VERSION <= MAX_MONOTONIC_VALUE,
187 		assert_stm32mp1_monotonic_counter_reach_max);
188 
189 	/* Check if monotonic counter needs to be incremented */
190 	if (stm32_get_otp_index(MONOTONIC_OTP, &otp, NULL) != 0) {
191 		panic();
192 	}
193 
194 	if (stm32_get_otp_value_from_idx(otp, &version) != 0) {
195 		panic();
196 	}
197 
198 	if ((version + 1U) < BIT(STM32_TF_VERSION)) {
199 		uint32_t result;
200 
201 		/* Need to increment the monotonic counter. */
202 		version = BIT(STM32_TF_VERSION) - 1U;
203 
204 		result = bsec_program_otp(version, otp);
205 		if (result != BSEC_OK) {
206 			ERROR("BSEC: MONOTONIC_OTP program Error %u\n",
207 			      result);
208 			panic();
209 		}
210 		INFO("Monotonic counter has been incremented (value 0x%x)\n",
211 		     version);
212 	}
213 }
214 #endif
215 
216 void bl2_el3_plat_arch_setup(void)
217 {
218 	const char *board_model;
219 	boot_api_context_t *boot_context =
220 		(boot_api_context_t *)stm32mp_get_boot_ctx_address();
221 	uintptr_t pwr_base;
222 	uintptr_t rcc_base;
223 
224 	if (bsec_probe() != 0U) {
225 		panic();
226 	}
227 
228 	mmap_add_region(BL_CODE_BASE, BL_CODE_BASE,
229 			BL_CODE_END - BL_CODE_BASE,
230 			MT_CODE | MT_SECURE);
231 
232 #if STM32MP_USE_STM32IMAGE
233 #ifdef AARCH32_SP_OPTEE
234 	mmap_add_region(STM32MP_OPTEE_BASE, STM32MP_OPTEE_BASE,
235 			STM32MP_OPTEE_SIZE,
236 			MT_MEMORY | MT_RW | MT_SECURE);
237 #else
238 	/* Prevent corruption of preloaded BL32 */
239 	mmap_add_region(BL32_BASE, BL32_BASE,
240 			BL32_LIMIT - BL32_BASE,
241 			MT_RO_DATA | MT_SECURE);
242 #endif
243 #endif /* STM32MP_USE_STM32IMAGE */
244 
245 	/* Prevent corruption of preloaded Device Tree */
246 	mmap_add_region(DTB_BASE, DTB_BASE,
247 			DTB_LIMIT - DTB_BASE,
248 			MT_RO_DATA | MT_SECURE);
249 
250 	configure_mmu();
251 
252 	if (dt_open_and_check(STM32MP_DTB_BASE) < 0) {
253 		panic();
254 	}
255 
256 	pwr_base = stm32mp_pwr_base();
257 	rcc_base = stm32mp_rcc_base();
258 
259 	/*
260 	 * Disable the backup domain write protection.
261 	 * The protection is enable at each reset by hardware
262 	 * and must be disabled by software.
263 	 */
264 	mmio_setbits_32(pwr_base + PWR_CR1, PWR_CR1_DBP);
265 
266 	while ((mmio_read_32(pwr_base + PWR_CR1) & PWR_CR1_DBP) == 0U) {
267 		;
268 	}
269 
270 	/* Reset backup domain on cold boot cases */
271 	if ((mmio_read_32(rcc_base + RCC_BDCR) & RCC_BDCR_RTCSRC_MASK) == 0U) {
272 		mmio_setbits_32(rcc_base + RCC_BDCR, RCC_BDCR_VSWRST);
273 
274 		while ((mmio_read_32(rcc_base + RCC_BDCR) & RCC_BDCR_VSWRST) ==
275 		       0U) {
276 			;
277 		}
278 
279 		mmio_clrbits_32(rcc_base + RCC_BDCR, RCC_BDCR_VSWRST);
280 	}
281 
282 #if STM32MP15
283 	/* Disable MCKPROT */
284 	mmio_clrbits_32(rcc_base + RCC_TZCR, RCC_TZCR_MCKPROT);
285 #endif
286 
287 	/*
288 	 * Set minimum reset pulse duration to 31ms for discrete power
289 	 * supplied boards.
290 	 */
291 	if (dt_pmic_status() <= 0) {
292 		mmio_clrsetbits_32(rcc_base + RCC_RDLSICR,
293 				   RCC_RDLSICR_MRD_MASK,
294 				   31U << RCC_RDLSICR_MRD_SHIFT);
295 	}
296 
297 	generic_delay_timer_init();
298 
299 #if STM32MP_UART_PROGRAMMER
300 	/* Disable programmer UART before changing clock tree */
301 	if (boot_context->boot_interface_selected ==
302 	    BOOT_API_CTX_BOOT_INTERFACE_SEL_SERIAL_UART) {
303 		uintptr_t uart_prog_addr =
304 			get_uart_address(boot_context->boot_interface_instance);
305 
306 		stm32_uart_stop(uart_prog_addr);
307 	}
308 #endif
309 	if (stm32mp1_clk_probe() < 0) {
310 		panic();
311 	}
312 
313 	if (stm32mp1_clk_init() < 0) {
314 		panic();
315 	}
316 
317 	stm32_save_boot_interface(boot_context->boot_interface_selected,
318 				  boot_context->boot_interface_instance);
319 
320 #if STM32MP_USB_PROGRAMMER && STM32MP15
321 	/* Deconfigure all UART RX pins configured by ROM code */
322 	stm32mp1_deconfigure_uart_pins();
323 #endif
324 
325 	if (stm32mp_uart_console_setup() != 0) {
326 		goto skip_console_init;
327 	}
328 
329 	stm32mp_print_cpuinfo();
330 
331 	board_model = dt_get_board_model();
332 	if (board_model != NULL) {
333 		NOTICE("Model: %s\n", board_model);
334 	}
335 
336 	stm32mp_print_boardinfo();
337 
338 	if (boot_context->auth_status != BOOT_API_CTX_AUTH_NO) {
339 		NOTICE("Bootrom authentication %s\n",
340 		       (boot_context->auth_status == BOOT_API_CTX_AUTH_FAILED) ?
341 		       "failed" : "succeeded");
342 	}
343 
344 skip_console_init:
345 	if (fixed_regulator_register() != 0) {
346 		panic();
347 	}
348 
349 	if (dt_pmic_status() > 0) {
350 		initialize_pmic();
351 		if (pmic_voltages_init() != 0) {
352 			ERROR("PMIC voltages init failed\n");
353 			panic();
354 		}
355 		print_pmic_info_and_debug();
356 	}
357 
358 	stm32mp1_syscfg_init();
359 
360 	if (stm32_iwdg_init() < 0) {
361 		panic();
362 	}
363 
364 	stm32_iwdg_refresh();
365 
366 	if (bsec_read_debug_conf() != 0U) {
367 		if (stm32mp_is_closed_device()) {
368 #if DEBUG
369 			WARN("\n%s", debug_msg);
370 #else
371 			ERROR("***Debug opened on closed chip***\n");
372 #endif
373 		}
374 	}
375 
376 #if STM32MP15
377 	if (stm32mp_is_auth_supported()) {
378 		stm32mp1_auth_ops.check_key =
379 			boot_context->bootrom_ecdsa_check_key;
380 		stm32mp1_auth_ops.verify_signature =
381 			boot_context->bootrom_ecdsa_verify_signature;
382 
383 		stm32mp_init_auth(&stm32mp1_auth_ops);
384 	}
385 #endif
386 
387 	stm32mp1_arch_security_setup();
388 
389 	print_reset_reason();
390 
391 #if STM32MP15
392 	update_monotonic_counter();
393 #endif
394 
395 	stm32mp1_syscfg_enable_io_compensation_finish();
396 
397 #if !STM32MP_USE_STM32IMAGE
398 	fconf_populate("TB_FW", STM32MP_DTB_BASE);
399 #endif /* !STM32MP_USE_STM32IMAGE */
400 
401 	stm32mp_io_setup();
402 }
403 
404 /*******************************************************************************
405  * This function can be used by the platforms to update/use image
406  * information for given `image_id`.
407  ******************************************************************************/
408 int bl2_plat_handle_post_image_load(unsigned int image_id)
409 {
410 	int err = 0;
411 	bl_mem_params_node_t *bl_mem_params = get_bl_mem_params_node(image_id);
412 	bl_mem_params_node_t *bl32_mem_params;
413 	bl_mem_params_node_t *pager_mem_params __unused;
414 	bl_mem_params_node_t *paged_mem_params __unused;
415 #if !STM32MP_USE_STM32IMAGE
416 	const struct dyn_cfg_dtb_info_t *config_info;
417 	bl_mem_params_node_t *tos_fw_mem_params;
418 	unsigned int i;
419 	unsigned int idx;
420 	unsigned long long ddr_top __unused;
421 	const unsigned int image_ids[] = {
422 		BL32_IMAGE_ID,
423 		BL33_IMAGE_ID,
424 		HW_CONFIG_ID,
425 		TOS_FW_CONFIG_ID,
426 	};
427 #endif /* !STM32MP_USE_STM32IMAGE */
428 
429 	assert(bl_mem_params != NULL);
430 
431 	switch (image_id) {
432 #if !STM32MP_USE_STM32IMAGE
433 	case FW_CONFIG_ID:
434 		/* Set global DTB info for fixed fw_config information */
435 		set_config_info(STM32MP_FW_CONFIG_BASE, STM32MP_FW_CONFIG_MAX_SIZE, FW_CONFIG_ID);
436 		fconf_populate("FW_CONFIG", STM32MP_FW_CONFIG_BASE);
437 
438 		idx = dyn_cfg_dtb_info_get_index(TOS_FW_CONFIG_ID);
439 
440 		/* Iterate through all the fw config IDs */
441 		for (i = 0U; i < ARRAY_SIZE(image_ids); i++) {
442 			if ((image_ids[i] == TOS_FW_CONFIG_ID) && (idx == FCONF_INVALID_IDX)) {
443 				continue;
444 			}
445 
446 			bl_mem_params = get_bl_mem_params_node(image_ids[i]);
447 			assert(bl_mem_params != NULL);
448 
449 			config_info = FCONF_GET_PROPERTY(dyn_cfg, dtb, image_ids[i]);
450 			if (config_info == NULL) {
451 				continue;
452 			}
453 
454 			bl_mem_params->image_info.image_base = config_info->config_addr;
455 			bl_mem_params->image_info.image_max_size = config_info->config_max_size;
456 
457 			bl_mem_params->image_info.h.attr &= ~IMAGE_ATTRIB_SKIP_LOADING;
458 
459 			switch (image_ids[i]) {
460 			case BL32_IMAGE_ID:
461 				bl_mem_params->ep_info.pc = config_info->config_addr;
462 
463 				/* In case of OPTEE, initialize address space with tos_fw addr */
464 				pager_mem_params = get_bl_mem_params_node(BL32_EXTRA1_IMAGE_ID);
465 				pager_mem_params->image_info.image_base = config_info->config_addr;
466 				pager_mem_params->image_info.image_max_size =
467 					config_info->config_max_size;
468 
469 				/* Init base and size for pager if exist */
470 				paged_mem_params = get_bl_mem_params_node(BL32_EXTRA2_IMAGE_ID);
471 				paged_mem_params->image_info.image_base = STM32MP_DDR_BASE +
472 					(dt_get_ddr_size() - STM32MP_DDR_S_SIZE -
473 					 STM32MP_DDR_SHMEM_SIZE);
474 				paged_mem_params->image_info.image_max_size = STM32MP_DDR_S_SIZE;
475 				break;
476 
477 			case BL33_IMAGE_ID:
478 				bl_mem_params->ep_info.pc = config_info->config_addr;
479 				break;
480 
481 			case HW_CONFIG_ID:
482 			case TOS_FW_CONFIG_ID:
483 				break;
484 
485 			default:
486 				return -EINVAL;
487 			}
488 		}
489 		break;
490 #endif /* !STM32MP_USE_STM32IMAGE */
491 
492 	case BL32_IMAGE_ID:
493 		if (optee_header_is_valid(bl_mem_params->image_info.image_base)) {
494 			/* BL32 is OP-TEE header */
495 			bl_mem_params->ep_info.pc = bl_mem_params->image_info.image_base;
496 			pager_mem_params = get_bl_mem_params_node(BL32_EXTRA1_IMAGE_ID);
497 			paged_mem_params = get_bl_mem_params_node(BL32_EXTRA2_IMAGE_ID);
498 			assert((pager_mem_params != NULL) && (paged_mem_params != NULL));
499 
500 #if STM32MP_USE_STM32IMAGE && defined(AARCH32_SP_OPTEE)
501 			/* Set OP-TEE extra image load areas at run-time */
502 			pager_mem_params->image_info.image_base = STM32MP_OPTEE_BASE;
503 			pager_mem_params->image_info.image_max_size = STM32MP_OPTEE_SIZE;
504 
505 			paged_mem_params->image_info.image_base = STM32MP_DDR_BASE +
506 								  dt_get_ddr_size() -
507 								  STM32MP_DDR_S_SIZE -
508 								  STM32MP_DDR_SHMEM_SIZE;
509 			paged_mem_params->image_info.image_max_size = STM32MP_DDR_S_SIZE;
510 #endif /* STM32MP_USE_STM32IMAGE && defined(AARCH32_SP_OPTEE) */
511 
512 			err = parse_optee_header(&bl_mem_params->ep_info,
513 						 &pager_mem_params->image_info,
514 						 &paged_mem_params->image_info);
515 			if (err) {
516 				ERROR("OPTEE header parse error.\n");
517 				panic();
518 			}
519 
520 			/* Set optee boot info from parsed header data */
521 			bl_mem_params->ep_info.args.arg0 = paged_mem_params->image_info.image_base;
522 			bl_mem_params->ep_info.args.arg1 = 0; /* Unused */
523 			bl_mem_params->ep_info.args.arg2 = 0; /* No DT supported */
524 		} else {
525 #if !STM32MP_USE_STM32IMAGE
526 			bl_mem_params->ep_info.pc = bl_mem_params->image_info.image_base;
527 			tos_fw_mem_params = get_bl_mem_params_node(TOS_FW_CONFIG_ID);
528 			bl_mem_params->image_info.image_max_size +=
529 				tos_fw_mem_params->image_info.image_max_size;
530 #endif /* !STM32MP_USE_STM32IMAGE */
531 			bl_mem_params->ep_info.args.arg0 = 0;
532 		}
533 		break;
534 
535 	case BL33_IMAGE_ID:
536 		bl32_mem_params = get_bl_mem_params_node(BL32_IMAGE_ID);
537 		assert(bl32_mem_params != NULL);
538 		bl32_mem_params->ep_info.lr_svc = bl_mem_params->ep_info.pc;
539 #if !STM32MP_USE_STM32IMAGE && PSA_FWU_SUPPORT
540 		stm32mp1_fwu_set_boot_idx();
541 #endif /* !STM32MP_USE_STM32IMAGE && PSA_FWU_SUPPORT */
542 		break;
543 
544 	default:
545 		/* Do nothing in default case */
546 		break;
547 	}
548 
549 #if STM32MP_SDMMC || STM32MP_EMMC
550 	/*
551 	 * Invalidate remaining data read from MMC but not flushed by load_image_flush().
552 	 * We take the worst case which is 2 MMC blocks.
553 	 */
554 	if ((image_id != FW_CONFIG_ID) &&
555 	    ((bl_mem_params->image_info.h.attr & IMAGE_ATTRIB_SKIP_LOADING) == 0U)) {
556 		inv_dcache_range(bl_mem_params->image_info.image_base +
557 				 bl_mem_params->image_info.image_size,
558 				 2U * MMC_BLOCK_SIZE);
559 	}
560 #endif /* STM32MP_SDMMC || STM32MP_EMMC */
561 
562 	return err;
563 }
564 
565 void bl2_el3_plat_prepare_exit(void)
566 {
567 	uint16_t boot_itf = stm32mp_get_boot_itf_selected();
568 
569 	switch (boot_itf) {
570 #if STM32MP_UART_PROGRAMMER || STM32MP_USB_PROGRAMMER
571 	case BOOT_API_CTX_BOOT_INTERFACE_SEL_SERIAL_UART:
572 	case BOOT_API_CTX_BOOT_INTERFACE_SEL_SERIAL_USB:
573 		/* Invalidate the downloaded buffer used with io_memmap */
574 		inv_dcache_range(DWL_BUFFER_BASE, DWL_BUFFER_SIZE);
575 		break;
576 #endif /* STM32MP_UART_PROGRAMMER || STM32MP_USB_PROGRAMMER */
577 	default:
578 		/* Do nothing in default case */
579 		break;
580 	}
581 
582 	stm32mp1_security_setup();
583 }
584