1 // SPDX-License-Identifier: BSD-3-Clause
2 /*
3 * Reference to the ARM TF Project,
4 * plat/arm/common/arm_bl2_setup.c
5 * Portions copyright (c) 2013-2016, ARM Limited and Contributors. All rights
6 * reserved.
7 * Copyright (C) 2016 Rockchip Electronic Co.,Ltd
8 * Written by Kever Yang <kever.yang@rock-chips.com>
9 * Copyright (C) 2017 Theobroma Systems Design und Consulting GmbH
10 */
11
12 #include <atf_common.h>
13 #include <cpu_func.h>
14 #include <errno.h>
15 #include <image.h>
16 #include <log.h>
17 #include <spl.h>
18 #include <asm/cache.h>
19
20 /* Holds all the structures we need for bl31 parameter passing */
21 struct bl2_to_bl31_params_mem {
22 struct bl31_params bl31_params;
23 struct atf_image_info bl31_image_info;
24 struct atf_image_info bl32_image_info;
25 struct atf_image_info bl33_image_info;
26 struct entry_point_info bl33_ep_info;
27 struct entry_point_info bl32_ep_info;
28 struct entry_point_info bl31_ep_info;
29 };
30
31 struct bl2_to_bl31_params_mem_v2 {
32 struct bl_params bl_params;
33 struct bl_params_node bl31_params_node;
34 struct bl_params_node bl32_params_node;
35 struct bl_params_node bl33_params_node;
36 struct atf_image_info bl31_image_info;
37 struct atf_image_info bl32_image_info;
38 struct atf_image_info bl33_image_info;
39 struct entry_point_info bl33_ep_info;
40 struct entry_point_info bl32_ep_info;
41 struct entry_point_info bl31_ep_info;
42 };
43
bl2_plat_get_bl31_params_default(ulong bl32_entry,ulong bl33_entry,ulong fdt_addr)44 struct bl31_params *bl2_plat_get_bl31_params_default(ulong bl32_entry,
45 ulong bl33_entry,
46 ulong fdt_addr)
47 {
48 static struct bl2_to_bl31_params_mem bl31_params_mem;
49 struct bl31_params *bl2_to_bl31_params;
50 struct entry_point_info *bl32_ep_info;
51 struct entry_point_info *bl33_ep_info;
52
53 /*
54 * Initialise the memory for all the arguments that needs to
55 * be passed to BL31
56 */
57 memset(&bl31_params_mem, 0, sizeof(struct bl2_to_bl31_params_mem));
58
59 /* Assign memory for TF related information */
60 bl2_to_bl31_params = &bl31_params_mem.bl31_params;
61 SET_PARAM_HEAD(bl2_to_bl31_params, ATF_PARAM_BL31, ATF_VERSION_1, 0);
62
63 /* Fill BL31 related information */
64 bl2_to_bl31_params->bl31_image_info = &bl31_params_mem.bl31_image_info;
65 SET_PARAM_HEAD(bl2_to_bl31_params->bl31_image_info,
66 ATF_PARAM_IMAGE_BINARY, ATF_VERSION_1, 0);
67
68 /* Fill BL32 related information */
69 bl2_to_bl31_params->bl32_ep_info = &bl31_params_mem.bl32_ep_info;
70 bl32_ep_info = &bl31_params_mem.bl32_ep_info;
71 SET_PARAM_HEAD(bl32_ep_info, ATF_PARAM_EP, ATF_VERSION_1,
72 ATF_EP_SECURE);
73
74 /* secure payload is optional, so set pc to 0 if absent */
75 bl32_ep_info->args.arg3 = fdt_addr;
76 bl32_ep_info->pc = bl32_entry ? bl32_entry : 0;
77 bl32_ep_info->spsr = SPSR_64(MODE_EL1, MODE_SP_ELX,
78 DISABLE_ALL_EXECPTIONS);
79
80 bl2_to_bl31_params->bl32_image_info = &bl31_params_mem.bl32_image_info;
81 SET_PARAM_HEAD(bl2_to_bl31_params->bl32_image_info,
82 ATF_PARAM_IMAGE_BINARY, ATF_VERSION_1, 0);
83
84 /* Fill BL33 related information */
85 bl2_to_bl31_params->bl33_ep_info = &bl31_params_mem.bl33_ep_info;
86 bl33_ep_info = &bl31_params_mem.bl33_ep_info;
87 SET_PARAM_HEAD(bl33_ep_info, ATF_PARAM_EP, ATF_VERSION_1,
88 ATF_EP_NON_SECURE);
89
90 /* BL33 expects to receive the primary CPU MPID (through x0) */
91 bl33_ep_info->args.arg0 = 0xffff & read_mpidr();
92 bl33_ep_info->pc = bl33_entry;
93 bl33_ep_info->spsr = SPSR_64(MODE_EL2, MODE_SP_ELX,
94 DISABLE_ALL_EXECPTIONS);
95
96 bl2_to_bl31_params->bl33_image_info = &bl31_params_mem.bl33_image_info;
97 SET_PARAM_HEAD(bl2_to_bl31_params->bl33_image_info,
98 ATF_PARAM_IMAGE_BINARY, ATF_VERSION_1, 0);
99
100 return bl2_to_bl31_params;
101 }
102
bl2_plat_get_bl31_params(ulong bl32_entry,ulong bl33_entry,ulong fdt_addr)103 __weak struct bl31_params *bl2_plat_get_bl31_params(ulong bl32_entry,
104 ulong bl33_entry,
105 ulong fdt_addr)
106 {
107 return bl2_plat_get_bl31_params_default(bl32_entry, bl33_entry,
108 fdt_addr);
109 }
110
bl2_plat_get_bl31_params_v2_default(ulong bl32_entry,ulong bl33_entry,ulong fdt_addr)111 struct bl_params *bl2_plat_get_bl31_params_v2_default(ulong bl32_entry,
112 ulong bl33_entry,
113 ulong fdt_addr)
114 {
115 static struct bl2_to_bl31_params_mem_v2 bl31_params_mem;
116 struct bl_params *bl_params;
117 struct bl_params_node *bl_params_node;
118
119 /*
120 * Initialise the memory for all the arguments that needs to
121 * be passed to BL31
122 */
123 memset(&bl31_params_mem, 0, sizeof(bl31_params_mem));
124
125 /* Assign memory for TF related information */
126 bl_params = &bl31_params_mem.bl_params;
127 SET_PARAM_HEAD(bl_params, ATF_PARAM_BL_PARAMS, ATF_VERSION_2, 0);
128 bl_params->head = &bl31_params_mem.bl31_params_node;
129
130 /* Fill BL31 related information */
131 bl_params_node = &bl31_params_mem.bl31_params_node;
132 bl_params_node->image_id = ATF_BL31_IMAGE_ID;
133 bl_params_node->image_info = &bl31_params_mem.bl31_image_info;
134 bl_params_node->ep_info = &bl31_params_mem.bl31_ep_info;
135 bl_params_node->next_params_info = &bl31_params_mem.bl32_params_node;
136 SET_PARAM_HEAD(bl_params_node->image_info, ATF_PARAM_IMAGE_BINARY,
137 ATF_VERSION_2, 0);
138
139 /* Fill BL32 related information */
140 bl_params_node = &bl31_params_mem.bl32_params_node;
141 bl_params_node->image_id = ATF_BL32_IMAGE_ID;
142 bl_params_node->image_info = &bl31_params_mem.bl32_image_info;
143 bl_params_node->ep_info = &bl31_params_mem.bl32_ep_info;
144 bl_params_node->next_params_info = &bl31_params_mem.bl33_params_node;
145 SET_PARAM_HEAD(bl_params_node->ep_info, ATF_PARAM_EP,
146 ATF_VERSION_2, ATF_EP_SECURE);
147
148 /* secure payload is optional, so set pc to 0 if absent */
149 bl_params_node->ep_info->args.arg3 = fdt_addr;
150 bl_params_node->ep_info->pc = bl32_entry ? bl32_entry : 0;
151 bl_params_node->ep_info->spsr = SPSR_64(MODE_EL1, MODE_SP_ELX,
152 DISABLE_ALL_EXECPTIONS);
153 SET_PARAM_HEAD(bl_params_node->image_info, ATF_PARAM_IMAGE_BINARY,
154 ATF_VERSION_2, 0);
155
156 /* Fill BL33 related information */
157 bl_params_node = &bl31_params_mem.bl33_params_node;
158 bl_params_node->image_id = ATF_BL33_IMAGE_ID;
159 bl_params_node->image_info = &bl31_params_mem.bl33_image_info;
160 bl_params_node->ep_info = &bl31_params_mem.bl33_ep_info;
161 bl_params_node->next_params_info = NULL;
162 SET_PARAM_HEAD(bl_params_node->ep_info, ATF_PARAM_EP,
163 ATF_VERSION_2, ATF_EP_NON_SECURE);
164
165 /* BL33 expects to receive the primary CPU MPID (through x0) */
166 bl_params_node->ep_info->args.arg0 = 0xffff & read_mpidr();
167 bl_params_node->ep_info->pc = bl33_entry;
168 bl_params_node->ep_info->spsr = SPSR_64(MODE_EL2, MODE_SP_ELX,
169 DISABLE_ALL_EXECPTIONS);
170 SET_PARAM_HEAD(bl_params_node->image_info, ATF_PARAM_IMAGE_BINARY,
171 ATF_VERSION_2, 0);
172
173 return bl_params;
174 }
175
bl2_plat_get_bl31_params_v2(ulong bl32_entry,ulong bl33_entry,ulong fdt_addr)176 __weak struct bl_params *bl2_plat_get_bl31_params_v2(ulong bl32_entry,
177 ulong bl33_entry,
178 ulong fdt_addr)
179 {
180 return bl2_plat_get_bl31_params_v2_default(bl32_entry, bl33_entry,
181 fdt_addr);
182 }
183
raw_write_daif(unsigned int daif)184 static inline void raw_write_daif(unsigned int daif)
185 {
186 __asm__ __volatile__("msr DAIF, %x0\n\t" : : "r" (daif) : "memory");
187 }
188
189 typedef void __noreturn (*atf_entry_t)(struct bl31_params *params, void *plat_params);
190
bl31_entry(ulong bl31_entry,ulong bl32_entry,ulong bl33_entry,ulong fdt_addr)191 static void __noreturn bl31_entry(ulong bl31_entry, ulong bl32_entry,
192 ulong bl33_entry, ulong fdt_addr)
193 {
194 atf_entry_t atf_entry = (atf_entry_t)bl31_entry;
195 void *bl31_params;
196
197 if (CONFIG_IS_ENABLED(ATF_LOAD_IMAGE_V2))
198 bl31_params = bl2_plat_get_bl31_params_v2(bl32_entry,
199 bl33_entry,
200 fdt_addr);
201 else
202 bl31_params = bl2_plat_get_bl31_params(bl32_entry, bl33_entry,
203 fdt_addr);
204
205 raw_write_daif(SPSR_EXCEPTION_MASK);
206 if (!CONFIG_IS_ENABLED(SYS_DCACHE_OFF))
207 dcache_disable();
208
209 atf_entry(bl31_params, (void *)fdt_addr);
210 }
211
spl_fit_images_find(void * blob,int os)212 static int spl_fit_images_find(void *blob, int os)
213 {
214 int parent, node, ndepth = 0;
215 const void *data;
216
217 if (!blob)
218 return -FDT_ERR_BADMAGIC;
219
220 parent = fdt_path_offset(blob, "/fit-images");
221 if (parent < 0)
222 return -FDT_ERR_NOTFOUND;
223
224 for (node = fdt_next_node(blob, parent, &ndepth);
225 (node >= 0) && (ndepth > 0);
226 node = fdt_next_node(blob, node, &ndepth)) {
227 if (ndepth != 1)
228 continue;
229
230 data = fdt_getprop(blob, node, FIT_OS_PROP, NULL);
231 if (!data)
232 continue;
233
234 if (genimg_get_os_id(data) == os)
235 return node;
236 };
237
238 return -FDT_ERR_NOTFOUND;
239 }
240
spl_fit_images_get_entry(void * blob,int node)241 ulong spl_fit_images_get_entry(void *blob, int node)
242 {
243 ulong val;
244 int ret;
245
246 ret = fit_image_get_entry(blob, node, &val);
247 if (ret)
248 ret = fit_image_get_load(blob, node, &val);
249
250 debug("%s: entry point 0x%lx\n", __func__, val);
251 return val;
252 }
253
spl_invoke_atf(struct spl_image_info * spl_image)254 void __noreturn spl_invoke_atf(struct spl_image_info *spl_image)
255 {
256 ulong bl32_entry = 0;
257 ulong bl33_entry = CONFIG_TEXT_BASE;
258 void *blob = spl_image->fdt_addr;
259 ulong platform_param = (ulong)blob;
260 int node;
261
262 /*
263 * Find the OP-TEE binary (in /fit-images) load address or
264 * entry point (if different) and pass it as the BL3-2 entry
265 * point, this is optional.
266 */
267 node = spl_fit_images_find(blob, IH_OS_TEE);
268 if (node >= 0)
269 bl32_entry = spl_fit_images_get_entry(blob, node);
270
271 /*
272 * Find the U-Boot binary (in /fit-images) load addreess or
273 * entry point (if different) and pass it as the BL3-3 entry
274 * point.
275 * This will need to be extended to support Falcon mode.
276 */
277
278 node = spl_fit_images_find(blob, IH_OS_U_BOOT);
279 if (node >= 0)
280 bl33_entry = spl_fit_images_get_entry(blob, node);
281
282 /*
283 * If ATF_NO_PLATFORM_PARAM is set, we override the platform
284 * parameter and always pass 0. This is a workaround for
285 * older ATF versions that have insufficiently robust (or
286 * overzealous) argument validation.
287 */
288 if (CONFIG_IS_ENABLED(ATF_NO_PLATFORM_PARAM))
289 platform_param = 0;
290
291 /*
292 * We don't provide a BL3-2 entry yet, but this will be possible
293 * using similar logic.
294 */
295 bl31_entry(spl_image->entry_point, bl32_entry,
296 bl33_entry, platform_param);
297 }
298