xref: /rk3399_ARM-atf/plat/st/common/stm32mp_common.c (revision 6dc5979a6cb2121e4c16e7bd62e24030e0f42755)
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 
10 #include <arch_helpers.h>
11 #include <common/debug.h>
12 #include <drivers/clk.h>
13 #include <drivers/delay_timer.h>
14 #include <drivers/st/stm32_console.h>
15 #include <drivers/st/stm32mp_clkfunc.h>
16 #include <drivers/st/stm32mp_reset.h>
17 #include <lib/smccc.h>
18 #include <lib/xlat_tables/xlat_tables_v2.h>
19 #include <plat/common/platform.h>
20 #include <services/arm_arch_svc.h>
21 
22 #include <platform_def.h>
23 
24 #define HEADER_VERSION_MAJOR_MASK	GENMASK(23, 16)
25 #define RESET_TIMEOUT_US_1MS		1000U
26 
27 static console_t console;
28 
29 uintptr_t plat_get_ns_image_entrypoint(void)
30 {
31 	return BL33_BASE;
32 }
33 
34 unsigned int plat_get_syscnt_freq2(void)
35 {
36 	return read_cntfrq_el0();
37 }
38 
39 static uintptr_t boot_ctx_address;
40 static uint16_t boot_itf_selected;
41 
42 void stm32mp_save_boot_ctx_address(uintptr_t address)
43 {
44 	boot_api_context_t *boot_context = (boot_api_context_t *)address;
45 
46 	boot_ctx_address = address;
47 	boot_itf_selected = boot_context->boot_interface_selected;
48 }
49 
50 uintptr_t stm32mp_get_boot_ctx_address(void)
51 {
52 	return boot_ctx_address;
53 }
54 
55 uint16_t stm32mp_get_boot_itf_selected(void)
56 {
57 	return boot_itf_selected;
58 }
59 
60 uintptr_t stm32mp_ddrctrl_base(void)
61 {
62 	return DDRCTRL_BASE;
63 }
64 
65 uintptr_t stm32mp_ddrphyc_base(void)
66 {
67 	return DDRPHYC_BASE;
68 }
69 
70 uintptr_t stm32mp_pwr_base(void)
71 {
72 	return PWR_BASE;
73 }
74 
75 uintptr_t stm32mp_rcc_base(void)
76 {
77 	return RCC_BASE;
78 }
79 
80 bool stm32mp_lock_available(void)
81 {
82 	const uint32_t c_m_bits = SCTLR_M_BIT | SCTLR_C_BIT;
83 
84 	/* The spinlocks are used only when MMU and data cache are enabled */
85 	return (read_sctlr() & c_m_bits) == c_m_bits;
86 }
87 
88 #if STM32MP_USE_STM32IMAGE
89 int stm32mp_check_header(boot_api_image_header_t *header, uintptr_t buffer)
90 {
91 	uint32_t i;
92 	uint32_t img_checksum = 0U;
93 
94 	/*
95 	 * Check header/payload validity:
96 	 *	- Header magic
97 	 *	- Header version
98 	 *	- Payload checksum
99 	 */
100 	if (header->magic != BOOT_API_IMAGE_HEADER_MAGIC_NB) {
101 		ERROR("Header magic\n");
102 		return -EINVAL;
103 	}
104 
105 	if ((header->header_version & HEADER_VERSION_MAJOR_MASK) !=
106 	    (BOOT_API_HEADER_VERSION & HEADER_VERSION_MAJOR_MASK)) {
107 		ERROR("Header version\n");
108 		return -EINVAL;
109 	}
110 
111 	for (i = 0U; i < header->image_length; i++) {
112 		img_checksum += *(uint8_t *)(buffer + i);
113 	}
114 
115 	if (header->payload_checksum != img_checksum) {
116 		ERROR("Checksum: 0x%x (awaited: 0x%x)\n", img_checksum,
117 		      header->payload_checksum);
118 		return -EINVAL;
119 	}
120 
121 	return 0;
122 }
123 #endif /* STM32MP_USE_STM32IMAGE */
124 
125 int stm32mp_map_ddr_non_cacheable(void)
126 {
127 	return  mmap_add_dynamic_region(STM32MP_DDR_BASE, STM32MP_DDR_BASE,
128 					STM32MP_DDR_MAX_SIZE,
129 					MT_NON_CACHEABLE | MT_RW | MT_SECURE);
130 }
131 
132 int stm32mp_unmap_ddr(void)
133 {
134 	return  mmap_remove_dynamic_region(STM32MP_DDR_BASE,
135 					   STM32MP_DDR_MAX_SIZE);
136 }
137 
138 int stm32_get_otp_index(const char *otp_name, uint32_t *otp_idx,
139 			uint32_t *otp_len)
140 {
141 	assert(otp_name != NULL);
142 	assert(otp_idx != NULL);
143 
144 	return dt_find_otp_name(otp_name, otp_idx, otp_len);
145 }
146 
147 int stm32_get_otp_value(const char *otp_name, uint32_t *otp_val)
148 {
149 	uint32_t otp_idx;
150 
151 	assert(otp_name != NULL);
152 	assert(otp_val != NULL);
153 
154 	if (stm32_get_otp_index(otp_name, &otp_idx, NULL) != 0) {
155 		return -1;
156 	}
157 
158 	if (stm32_get_otp_value_from_idx(otp_idx, otp_val) != 0) {
159 		ERROR("BSEC: %s Read Error\n", otp_name);
160 		return -1;
161 	}
162 
163 	return 0;
164 }
165 
166 int stm32_get_otp_value_from_idx(const uint32_t otp_idx, uint32_t *otp_val)
167 {
168 	uint32_t ret = BSEC_NOT_SUPPORTED;
169 
170 	assert(otp_val != NULL);
171 
172 #if defined(IMAGE_BL2)
173 	ret = bsec_shadow_read_otp(otp_val, otp_idx);
174 #elif defined(IMAGE_BL32)
175 	ret = bsec_read_otp(otp_val, otp_idx);
176 #else
177 #error "Not supported"
178 #endif
179 	if (ret != BSEC_OK) {
180 		ERROR("BSEC: idx=%u Read Error\n", otp_idx);
181 		return -1;
182 	}
183 
184 	return 0;
185 }
186 
187 #if  defined(IMAGE_BL2)
188 static void reset_uart(uint32_t reset)
189 {
190 	int ret;
191 
192 	ret = stm32mp_reset_assert(reset, RESET_TIMEOUT_US_1MS);
193 	if (ret != 0) {
194 		panic();
195 	}
196 
197 	udelay(2);
198 
199 	ret = stm32mp_reset_deassert(reset, RESET_TIMEOUT_US_1MS);
200 	if (ret != 0) {
201 		panic();
202 	}
203 
204 	mdelay(1);
205 }
206 #endif
207 
208 static void set_console(uintptr_t base, uint32_t clk_rate)
209 {
210 	unsigned int console_flags;
211 
212 	if (console_stm32_register(base, clk_rate,
213 				   (uint32_t)STM32MP_UART_BAUDRATE, &console) == 0) {
214 		panic();
215 	}
216 
217 	console_flags = CONSOLE_FLAG_BOOT | CONSOLE_FLAG_CRASH |
218 			CONSOLE_FLAG_TRANSLATE_CRLF;
219 #if !defined(IMAGE_BL2) && defined(DEBUG)
220 	console_flags |= CONSOLE_FLAG_RUNTIME;
221 #endif
222 
223 	console_set_scope(&console, console_flags);
224 }
225 
226 int stm32mp_uart_console_setup(void)
227 {
228 	struct dt_node_info dt_uart_info;
229 	uint32_t clk_rate = 0U;
230 	int result;
231 	uint32_t boot_itf __unused;
232 	uint32_t boot_instance __unused;
233 
234 	result = dt_get_stdout_uart_info(&dt_uart_info);
235 
236 	if ((result <= 0) ||
237 	    (dt_uart_info.status == DT_DISABLED)) {
238 		return -ENODEV;
239 	}
240 
241 #if defined(IMAGE_BL2)
242 	if ((dt_uart_info.clock < 0) ||
243 	    (dt_uart_info.reset < 0)) {
244 		return -ENODEV;
245 	}
246 #endif
247 
248 #if STM32MP_UART_PROGRAMMER || !defined(IMAGE_BL2)
249 	stm32_get_boot_interface(&boot_itf, &boot_instance);
250 
251 	if ((boot_itf == BOOT_API_CTX_BOOT_INTERFACE_SEL_SERIAL_UART) &&
252 	    (get_uart_address(boot_instance) == dt_uart_info.base)) {
253 		return -EACCES;
254 	}
255 #endif
256 
257 #if defined(IMAGE_BL2)
258 	if (dt_set_stdout_pinctrl() != 0) {
259 		return -ENODEV;
260 	}
261 
262 	clk_enable((unsigned long)dt_uart_info.clock);
263 
264 	reset_uart((uint32_t)dt_uart_info.reset);
265 
266 	clk_rate = clk_get_rate((unsigned long)dt_uart_info.clock);
267 #endif
268 
269 	set_console(dt_uart_info.base, clk_rate);
270 
271 	return 0;
272 }
273 
274 #if STM32MP_EARLY_CONSOLE
275 void stm32mp_setup_early_console(void)
276 {
277 #if defined(IMAGE_BL2) || STM32MP_RECONFIGURE_CONSOLE
278 	plat_crash_console_init();
279 #endif
280 	set_console(STM32MP_DEBUG_USART_BASE, STM32MP_DEBUG_USART_CLK_FRQ);
281 	NOTICE("Early console setup\n");
282 }
283 #endif /* STM32MP_EARLY_CONSOLE */
284 
285 /*****************************************************************************
286  * plat_is_smccc_feature_available() - This function checks whether SMCCC
287  *                                     feature is availabile for platform.
288  * @fid: SMCCC function id
289  *
290  * Return SMC_ARCH_CALL_SUCCESS if SMCCC feature is available and
291  * SMC_ARCH_CALL_NOT_SUPPORTED otherwise.
292  *****************************************************************************/
293 int32_t plat_is_smccc_feature_available(u_register_t fid)
294 {
295 	switch (fid) {
296 	case SMCCC_ARCH_SOC_ID:
297 		return SMC_ARCH_CALL_SUCCESS;
298 	default:
299 		return SMC_ARCH_CALL_NOT_SUPPORTED;
300 	}
301 }
302 
303 /* Get SOC version */
304 int32_t plat_get_soc_version(void)
305 {
306 	uint32_t chip_id = stm32mp_get_chip_dev_id();
307 	uint32_t manfid = SOC_ID_SET_JEP_106(JEDEC_ST_BKID, JEDEC_ST_MFID);
308 
309 	return (int32_t)(manfid | (chip_id & SOC_ID_IMPL_DEF_MASK));
310 }
311 
312 /* Get SOC revision */
313 int32_t plat_get_soc_revision(void)
314 {
315 	return (int32_t)(stm32mp_get_chip_version() & SOC_ID_REV_MASK);
316 }
317