1 /*
2 * Copyright (c) 2013-2021, ARM Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7 #ifndef PLATFORM_H
8 #define PLATFORM_H
9
10 #include <stdint.h>
11
12 #include <lib/psci/psci.h>
13 #if defined(SPD_spmd)
14 #include <services/spm_core_manifest.h>
15 #endif
16 #if TRNG_SUPPORT
17 #include "plat_trng.h"
18 #endif
19 #include <drivers/fwu/fwu_metadata.h>
20
21 /*******************************************************************************
22 * Forward declarations
23 ******************************************************************************/
24 struct auth_img_desc_s;
25 struct meminfo;
26 struct image_info;
27 struct entry_point_info;
28 struct image_desc;
29 struct bl_load_info;
30 struct bl_params;
31 struct mmap_region;
32 struct spm_mm_boot_info;
33 struct sp_res_desc;
34 enum fw_enc_status_t;
35
36 /*******************************************************************************
37 * plat_get_rotpk_info() flags
38 ******************************************************************************/
39 #define ROTPK_IS_HASH (1 << 0)
40 /* Flag used to skip verification of the certificate ROTPK while the platform
41 ROTPK is not deployed */
42 #define ROTPK_NOT_DEPLOYED (1 << 1)
43
44 /*******************************************************************************
45 * plat_get_enc_key_info() flags
46 ******************************************************************************/
47 /*
48 * Flag used to notify caller that information provided in key buffer is an
49 * identifier rather than an actual key.
50 */
51 #define ENC_KEY_IS_IDENTIFIER (1 << 0)
52
53 /*******************************************************************************
54 * Function declarations
55 ******************************************************************************/
56 /*******************************************************************************
57 * Mandatory common functions
58 ******************************************************************************/
59 unsigned int plat_get_syscnt_freq2(void);
60
61 int plat_get_image_source(unsigned int image_id,
62 uintptr_t *dev_handle,
63 uintptr_t *image_spec);
64 uintptr_t plat_get_ns_image_entrypoint(void);
65 unsigned int plat_my_core_pos(void);
66 int plat_core_pos_by_mpidr(u_register_t mpidr);
67 int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
68
69 #if STACK_PROTECTOR_ENABLED
70 /*
71 * Return a new value to be used for the stack protection's canary.
72 *
73 * Ideally, this value is a random number that is impossible to predict by an
74 * attacker.
75 */
76 u_register_t plat_get_stack_protector_canary(void);
77 #endif /* STACK_PROTECTOR_ENABLED */
78
79 /*******************************************************************************
80 * Mandatory interrupt management functions
81 ******************************************************************************/
82 uint32_t plat_ic_get_pending_interrupt_id(void);
83 uint32_t plat_ic_get_pending_interrupt_type(void);
84 uint32_t plat_ic_acknowledge_interrupt(void);
85 uint32_t plat_ic_get_interrupt_type(uint32_t id);
86 void plat_ic_end_of_interrupt(uint32_t id);
87 uint32_t plat_interrupt_type_to_line(uint32_t type,
88 uint32_t security_state);
89
90 /*******************************************************************************
91 * Optional interrupt management functions, depending on chosen EL3 components.
92 ******************************************************************************/
93 unsigned int plat_ic_get_running_priority(void);
94 int plat_ic_is_spi(unsigned int id);
95 int plat_ic_is_ppi(unsigned int id);
96 int plat_ic_is_sgi(unsigned int id);
97 unsigned int plat_ic_get_interrupt_active(unsigned int id);
98 void plat_ic_disable_interrupt(unsigned int id);
99 void plat_ic_enable_interrupt(unsigned int id);
100 int plat_ic_has_interrupt_type(unsigned int type);
101 void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
102 void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
103 void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
104 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
105 u_register_t mpidr);
106 void plat_ic_set_interrupt_pending(unsigned int id);
107 void plat_ic_clear_interrupt_pending(unsigned int id);
108 unsigned int plat_ic_set_priority_mask(unsigned int mask);
109 unsigned int plat_ic_get_interrupt_id(unsigned int raw);
110
111 /*******************************************************************************
112 * Optional common functions (may be overridden)
113 ******************************************************************************/
114 uintptr_t plat_get_my_stack(void);
115 void plat_report_exception(unsigned int exception_type);
116 int plat_crash_console_init(void);
117 int plat_crash_console_putc(int c);
118 void plat_crash_console_flush(void);
119 void plat_error_handler(int err) __dead2;
120 void plat_panic_handler(void) __dead2;
121 const char *plat_log_get_prefix(unsigned int log_level);
122 void bl2_plat_preload_setup(void);
123 int plat_try_next_boot_source(void);
124
125 #if MEASURED_BOOT
126 int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data);
127 #else
plat_mboot_measure_image(unsigned int image_id __unused,image_info_t * image_data __unused)128 static inline int plat_mboot_measure_image(unsigned int image_id __unused,
129 image_info_t *image_data __unused)
130 {
131 return 0;
132 }
133 #endif /* MEASURED_BOOT */
134
135 /*******************************************************************************
136 * Mandatory BL1 functions
137 ******************************************************************************/
138 void bl1_early_platform_setup(void);
139 void bl1_plat_arch_setup(void);
140 void bl1_platform_setup(void);
141 struct meminfo *bl1_plat_sec_mem_layout(void);
142
143 /*******************************************************************************
144 * Optional EL3 component functions in BL31
145 ******************************************************************************/
146
147 /* SDEI platform functions */
148 #if SDEI_SUPPORT
149 void plat_sdei_setup(void);
150 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
151 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
152 #endif
153
154 void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
155 void *handle, uint64_t flags);
156 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
157 void *handle, uint64_t flags);
158
159 /*
160 * The following function is mandatory when the
161 * firmware update feature is used.
162 */
163 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
164 unsigned int flags);
165
166 /*******************************************************************************
167 * Optional BL1 functions (may be overridden)
168 ******************************************************************************/
169 /*
170 * The following functions are used for image loading process in BL1.
171 */
172 void bl1_plat_set_ep_info(unsigned int image_id,
173 struct entry_point_info *ep_info);
174 /*
175 * The following functions are mandatory when firmware update
176 * feature is used and optional otherwise.
177 */
178 unsigned int bl1_plat_get_next_image_id(void);
179 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
180
181 /*
182 * The following functions are used by firmware update
183 * feature and may optionally be overridden.
184 */
185 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
186
187 /*
188 * This BL1 function can be used by the platforms to update/use image
189 * information for a given `image_id`.
190 */
191 int bl1_plat_handle_pre_image_load(unsigned int image_id);
192 int bl1_plat_handle_post_image_load(unsigned int image_id);
193
194 #if MEASURED_BOOT
195 void bl1_plat_mboot_init(void);
196 void bl1_plat_mboot_finish(void);
197 #else
bl1_plat_mboot_init(void)198 static inline void bl1_plat_mboot_init(void)
199 {
200 }
bl1_plat_mboot_finish(void)201 static inline void bl1_plat_mboot_finish(void)
202 {
203 }
204 #endif /* MEASURED_BOOT */
205
206 /*******************************************************************************
207 * Mandatory BL2 functions
208 ******************************************************************************/
209 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3);
210 void bl2_plat_arch_setup(void);
211 void bl2_platform_setup(void);
212 struct meminfo *bl2_plat_sec_mem_layout(void);
213
214 /*
215 * This function can be used by the platforms to update/use image
216 * information for given `image_id`.
217 */
218 int bl2_plat_handle_pre_image_load(unsigned int image_id);
219 int bl2_plat_handle_post_image_load(unsigned int image_id);
220
221 /*******************************************************************************
222 * Optional BL2 functions (may be overridden)
223 ******************************************************************************/
224 #if MEASURED_BOOT
225 void bl2_plat_mboot_init(void);
226 void bl2_plat_mboot_finish(void);
227 #else
bl2_plat_mboot_init(void)228 static inline void bl2_plat_mboot_init(void)
229 {
230 }
bl2_plat_mboot_finish(void)231 static inline void bl2_plat_mboot_finish(void)
232 {
233 }
234 #endif /* MEASURED_BOOT */
235
236 /*******************************************************************************
237 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
238 * supported
239 ******************************************************************************/
240 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
241 u_register_t arg2, u_register_t arg3);
242 void bl2_el3_plat_arch_setup(void);
243
244 /*******************************************************************************
245 * Optional BL2 at EL3 functions (may be overridden)
246 ******************************************************************************/
247 void bl2_el3_plat_prepare_exit(void);
248
249 /*******************************************************************************
250 * Mandatory BL2U functions.
251 ******************************************************************************/
252 void bl2u_early_platform_setup(struct meminfo *mem_layout,
253 void *plat_info);
254 void bl2u_plat_arch_setup(void);
255 void bl2u_platform_setup(void);
256
257 /*******************************************************************************
258 * Conditionally mandatory BL2U functions for CSS platforms.
259 ******************************************************************************/
260 /*
261 * This function is used to perform any platform-specific actions required to
262 * handle the BL2U_SCP firmware.
263 */
264 int bl2u_plat_handle_scp_bl2u(void);
265
266 /*******************************************************************************
267 * Mandatory BL31 functions
268 ******************************************************************************/
269 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
270 u_register_t arg2, u_register_t arg3);
271 void bl31_plat_arch_setup(void);
272 void bl31_platform_setup(void);
273 void bl31_plat_runtime_setup(void);
274 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
275
276 /*******************************************************************************
277 * Mandatory PSCI functions (BL31)
278 ******************************************************************************/
279 int plat_setup_psci_ops(uintptr_t sec_entrypoint,
280 const struct plat_psci_ops **psci_ops);
281 const unsigned char *plat_get_power_domain_tree_desc(void);
282
283 /*******************************************************************************
284 * Optional PSCI functions (BL31).
285 ******************************************************************************/
286 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
287 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
288 u_register_t plat_psci_stat_get_residency(unsigned int lvl,
289 const psci_power_state_t *state_info,
290 unsigned int last_cpu_idx);
291 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
292 const plat_local_state_t *states,
293 unsigned int ncpu);
294
295 /*******************************************************************************
296 * Optional BL31 functions (may be overridden)
297 ******************************************************************************/
298 void bl31_plat_enable_mmu(uint32_t flags);
299
300 /*******************************************************************************
301 * Optional BL32 functions (may be overridden)
302 ******************************************************************************/
303 void bl32_plat_enable_mmu(uint32_t flags);
304
305 /*******************************************************************************
306 * Trusted Board Boot functions
307 ******************************************************************************/
308 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
309 unsigned int *flags);
310 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
311 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
312 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
313 unsigned int nv_ctr);
314 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
315 int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key,
316 size_t *key_len, unsigned int *flags,
317 const uint8_t *img_id, size_t img_id_len);
318
319 /*******************************************************************************
320 * Secure Partitions functions
321 ******************************************************************************/
322 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
323 const struct spm_mm_boot_info *plat_get_secure_partition_boot_info(
324 void *cookie);
325 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
326 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
327 void **rd_base, size_t *rd_size);
328 #if defined(SPD_spmd)
329 int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest,
330 const void *pm_addr);
331 #endif
332 /*******************************************************************************
333 * Mandatory BL image load functions(may be overridden).
334 ******************************************************************************/
335 /*
336 * This function returns pointer to the list of images that the
337 * platform has populated to load.
338 */
339 struct bl_load_info *plat_get_bl_image_load_info(void);
340
341 /*
342 * This function returns a pointer to the shared memory that the
343 * platform has kept aside to pass trusted firmware related
344 * information that next BL image could need.
345 */
346 struct bl_params *plat_get_next_bl_params(void);
347
348 /*
349 * This function flushes to main memory all the params that are
350 * passed to next image.
351 */
352 void plat_flush_next_bl_params(void);
353
354 /*
355 * The below function enable Trusted Firmware components like SPDs which
356 * haven't migrated to the new platform API to compile on platforms which
357 * have the compatibility layer disabled.
358 */
359 unsigned int platform_core_pos_helper(unsigned long mpidr);
360
361 /*
362 * Optional function to get SOC version
363 */
364 int32_t plat_get_soc_version(void);
365
366 /*
367 * Optional function to get SOC revision
368 */
369 int32_t plat_get_soc_revision(void);
370
371 /*
372 * Optional function to check for SMCCC function availability for platform
373 */
374 int32_t plat_is_smccc_feature_available(u_register_t fid);
375
376 /*******************************************************************************
377 * FWU platform specific functions
378 ******************************************************************************/
379 int plat_fwu_set_metadata_image_source(unsigned int image_id,
380 uintptr_t *dev_handle,
381 uintptr_t *image_spec);
382 void plat_fwu_set_images_source(struct fwu_metadata *metadata);
383
384 #endif /* PLATFORM_H */
385