1 /*
2 * Copyright (c) 2013-2025, 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 ENABLE_RME
17 #include <services/rmm_core_manifest.h>
18 #include <services/rmm_el3_token_sign.h>
19 #endif
20 #include <drivers/fwu/fwu_metadata.h>
21 #if TRNG_SUPPORT
22 #include "plat_trng.h"
23 #endif /* TRNG_SUPPORT */
24 #if DRTM_SUPPORT
25 #include "plat_drtm.h"
26 #endif /* DRTM_SUPPORT */
27 #if LFA_SUPPORT
28 #include "plat_lfa.h"
29 #endif /* LFA_SUPPORT */
30
31 /*******************************************************************************
32 * Forward declarations
33 ******************************************************************************/
34 struct auth_img_desc_s;
35 struct meminfo;
36 struct image_info;
37 struct entry_point_info;
38 struct image_desc;
39 struct bl_load_info;
40 struct bl_params;
41 struct mmap_region;
42 struct spm_mm_boot_info;
43 struct sp_res_desc;
44 struct rmm_manifest;
45 enum fw_enc_status_t;
46
47 /*******************************************************************************
48 * Structure populated by platform specific code to export routines which
49 * perform load images functions, and associated pointer to platform ops
50 ******************************************************************************/
51 struct plat_try_images_ops {
52 int (*next_instance)(unsigned int image_id);
53 };
54
55 extern const struct plat_try_images_ops *plat_try_img_ops;
56
57 /*******************************************************************************
58 * Structure populated by platform specific code to log if the primary GPT
59 * is corrupted
60 ******************************************************************************/
61 struct plat_log_gpt_corrupted {
62 uint8_t gpt_corrupted_info;
63 void (*plat_set_gpt_corruption)(uintptr_t gpt_corrupted_info_ptr, uint8_t flags);
64 void (*plat_log_gpt_corruption)(uintptr_t log_address, uint8_t gpt_corrupted_info);
65 };
66
67 extern const struct plat_log_gpt_corrupted *plat_log_gpt_ptr;
68
69 /*******************************************************************************
70 * plat_get_rotpk_info() flags
71 ******************************************************************************/
72 #define ROTPK_IS_HASH (1 << 0)
73
74 /* Flag used to skip verification of the certificate ROTPK while the platform
75 ROTPK is not deployed */
76 #define ROTPK_NOT_DEPLOYED (1 << 1)
77
is_rotpk_flags_valid(unsigned int flags)78 static inline bool is_rotpk_flags_valid(unsigned int flags)
79 {
80 unsigned int valid_flags = ROTPK_IS_HASH;
81 return (flags == ROTPK_NOT_DEPLOYED) || ((flags & ~valid_flags) == 0);
82 }
83
84 /*******************************************************************************
85 * plat_get_enc_key_info() flags
86 ******************************************************************************/
87 /*
88 * Flag used to notify caller that information provided in key buffer is an
89 * identifier rather than an actual key.
90 */
91 #define ENC_KEY_IS_IDENTIFIER (1 << 0)
92
93 /*******************************************************************************
94 * Function declarations
95 ******************************************************************************/
96 /*******************************************************************************
97 * Mandatory common functions
98 ******************************************************************************/
99 unsigned int plat_get_syscnt_freq2(void);
100
101 int plat_get_image_source(unsigned int image_id,
102 uintptr_t *dev_handle,
103 uintptr_t *image_spec);
104 uintptr_t plat_get_ns_image_entrypoint(void);
105 unsigned int plat_my_core_pos(void);
106 int plat_core_pos_by_mpidr(u_register_t mpidr);
107 int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
108
109 /*******************************************************************************
110 * Simple routine to determine whether a mpidr is valid or not.
111 ******************************************************************************/
is_valid_mpidr(u_register_t mpidr)112 static inline bool is_valid_mpidr(u_register_t mpidr)
113 {
114 int pos = plat_core_pos_by_mpidr(mpidr);
115
116 if ((pos < 0) || ((unsigned int)pos >= PLATFORM_CORE_COUNT)) {
117 return false;
118 }
119
120 return true;
121 }
122
123 #if STACK_PROTECTOR_ENABLED
124 /*
125 * Return a new value to be used for the stack protection's canary.
126 *
127 * Ideally, this value is a random number that is impossible to predict by an
128 * attacker.
129 */
130 u_register_t plat_get_stack_protector_canary(void);
131 #endif /* STACK_PROTECTOR_ENABLED */
132
133 /*******************************************************************************
134 * Mandatory interrupt management functions
135 ******************************************************************************/
136 uint32_t plat_ic_get_pending_interrupt_id(void);
137 uint32_t plat_ic_get_pending_interrupt_type(void);
138 uint32_t plat_ic_acknowledge_interrupt(void);
139 uint32_t plat_ic_get_interrupt_type(uint32_t id);
140 void plat_ic_end_of_interrupt(uint32_t id);
141 uint32_t plat_interrupt_type_to_line(uint32_t type,
142 uint32_t security_state);
143
144 /*******************************************************************************
145 * Optional interrupt management functions, depending on chosen EL3 components.
146 ******************************************************************************/
147 unsigned int plat_ic_get_running_priority(void);
148 bool plat_ic_is_spi(unsigned int id);
149 bool plat_ic_is_ppi(unsigned int id);
150 bool plat_ic_is_sgi(unsigned int id);
151 unsigned int plat_ic_get_interrupt_active(unsigned int id);
152 void plat_ic_disable_interrupt(unsigned int id);
153 void plat_ic_enable_interrupt(unsigned int id);
154 bool plat_ic_has_interrupt_type(unsigned int type);
155 void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
156 void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
157 void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
158 void plat_ic_raise_ns_sgi(int sgi_num, u_register_t target);
159 void plat_ic_raise_s_el1_sgi(int sgi_num, u_register_t target);
160 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
161 u_register_t mpidr);
162 void plat_ic_set_interrupt_pending(unsigned int id);
163 void plat_ic_clear_interrupt_pending(unsigned int id);
164 unsigned int plat_ic_set_priority_mask(unsigned int mask);
165 unsigned int plat_ic_deactivate_priority(unsigned int mask);
166 unsigned int plat_ic_get_interrupt_id(unsigned int raw);
167
168 /*******************************************************************************
169 * Optional common functions (may be overridden)
170 ******************************************************************************/
171 uintptr_t plat_get_my_stack(void);
172 void plat_report_exception(unsigned int exception_type);
173 void plat_report_prefetch_abort(unsigned int fault_address);
174 void plat_report_data_abort(unsigned int fault_address);
175 int plat_crash_console_init(void);
176 int plat_crash_console_putc(int c);
177 void plat_crash_console_flush(void);
178 void plat_error_handler(int err) __dead2;
179 void plat_panic_handler(void) __dead2;
180 const char *plat_log_get_prefix(unsigned int log_level);
181 void bl2_plat_preload_setup(void);
182 void plat_setup_try_img_ops(const struct plat_try_images_ops *plat_try_ops);
183 void plat_setup_log_gpt_corrupted(const struct plat_log_gpt_corrupted *log_gpt);
184
185 #if MEASURED_BOOT
186 int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data);
187 int plat_mboot_measure_critical_data(unsigned int critical_data_id,
188 const void *base,
189 size_t size);
190 int plat_mboot_measure_key(const void *pk_oid, const void *pk_ptr,
191 size_t pk_len);
192 #else
plat_mboot_measure_image(unsigned int image_id __unused,image_info_t * image_data __unused)193 static inline int plat_mboot_measure_image(unsigned int image_id __unused,
194 image_info_t *image_data __unused)
195 {
196 return 0;
197 }
plat_mboot_measure_critical_data(unsigned int critical_data_id __unused,const void * base __unused,size_t size __unused)198 static inline int plat_mboot_measure_critical_data(
199 unsigned int critical_data_id __unused,
200 const void *base __unused,
201 size_t size __unused)
202 {
203 return 0;
204 }
plat_mboot_measure_key(const void * pk_oid __unused,const void * pk_ptr __unused,size_t pk_len __unused)205 static inline int plat_mboot_measure_key(const void *pk_oid __unused,
206 const void *pk_ptr __unused,
207 size_t pk_len __unused)
208 {
209 return 0;
210 }
211 #endif /* MEASURED_BOOT */
212
213 #if EARLY_CONSOLE
214 void plat_setup_early_console(void);
215 #else
plat_setup_early_console(void)216 static inline void plat_setup_early_console(void)
217 {
218 }
219 #endif /* EARLY_CONSOLE */
220
221 /*******************************************************************************
222 * Mandatory BL1 functions
223 ******************************************************************************/
224 void bl1_early_platform_setup(void);
225 void bl1_plat_arch_setup(void);
226 void bl1_platform_setup(void);
227 struct meminfo *bl1_plat_sec_mem_layout(void);
228
229 /*******************************************************************************
230 * Optional EL3 component functions in BL31
231 ******************************************************************************/
232
233 /* SDEI platform functions */
234 #if SDEI_SUPPORT
235 void plat_sdei_setup(void);
236 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
237 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
238 #endif
239
240 void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
241 void *handle, uint64_t flags);
242 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
243 void *handle, uint64_t flags);
244
245 /*
246 * The following function is mandatory when the
247 * firmware update feature is used.
248 */
249 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
250 unsigned int flags);
251
252 /*******************************************************************************
253 * Optional BL1 functions (may be overridden)
254 ******************************************************************************/
255 /*
256 * The following functions are used for image loading process in BL1.
257 */
258 void bl1_plat_set_ep_info(unsigned int image_id,
259 struct entry_point_info *ep_info);
260 /*
261 * The following functions are mandatory when firmware update
262 * feature is used and optional otherwise.
263 */
264 unsigned int bl1_plat_get_next_image_id(void);
265 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
266
267 /*
268 * The following functions are used by firmware update
269 * feature and may optionally be overridden.
270 */
271 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
272
273 /*
274 * This BL1 function can be used by the platforms to update/use image
275 * information for a given `image_id`.
276 */
277 int bl1_plat_handle_pre_image_load(unsigned int image_id);
278 int bl1_plat_handle_post_image_load(unsigned int image_id);
279
280 /* Utility functions */
281 void bl1_plat_calc_bl2_layout(const meminfo_t *bl1_mem_layout,
282 meminfo_t *bl2_mem_layout);
283
284 bool bl1_plat_is_shared_nv_ctr(void);
285
286 #if MEASURED_BOOT
287 void bl1_plat_mboot_init(void);
288 void bl1_plat_mboot_finish(void);
289 #else
bl1_plat_mboot_init(void)290 static inline void bl1_plat_mboot_init(void)
291 {
292 }
bl1_plat_mboot_finish(void)293 static inline void bl1_plat_mboot_finish(void)
294 {
295 }
296 #endif /* MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENT */
297
298 /*******************************************************************************
299 * Mandatory BL2 functions
300 ******************************************************************************/
301 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3);
302 void bl2_plat_arch_setup(void);
303 void bl2_platform_setup(void);
304 struct meminfo *bl2_plat_sec_mem_layout(void);
305
306 /*
307 * This function can be used by the platforms to update/use image
308 * information for given `image_id`.
309 */
310 int bl2_plat_handle_pre_image_load(unsigned int image_id);
311 int bl2_plat_handle_post_image_load(unsigned int image_id);
312
313 /*******************************************************************************
314 * Optional BL2 functions (may be overridden)
315 ******************************************************************************/
316 #if (MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENT)
317 void bl2_plat_mboot_init(void);
318 void bl2_plat_mboot_finish(void);
319 #if TRANSFER_LIST
320 int plat_handoff_mboot(const void *data, uint32_t data_size, void *tl_base);
321 #else
322 static inline int
plat_handoff_mboot(__unused const void * data,__unused uint32_t data_size,__unused void * tl_base)323 plat_handoff_mboot(__unused const void *data, __unused uint32_t data_size,
324 __unused void *tl_base)
325 {
326 return -1;
327 }
328 #endif
329 #else
bl2_plat_mboot_init(void)330 static inline void bl2_plat_mboot_init(void)
331 {
332 }
bl2_plat_mboot_finish(void)333 static inline void bl2_plat_mboot_finish(void)
334 {
335 }
336 #endif /* MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENTs */
337
338 /*******************************************************************************
339 * Mandatory BL2 at EL3 functions: Must be implemented
340 * if RESET_TO_BL2 image is supported
341 ******************************************************************************/
342 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
343 u_register_t arg2, u_register_t arg3);
344 void bl2_el3_plat_arch_setup(void);
345
346 /*******************************************************************************
347 * Optional BL2 at EL3 functions (may be overridden)
348 ******************************************************************************/
349 void bl2_el3_plat_prepare_exit(void);
350
351 /*******************************************************************************
352 * Mandatory BL2U functions.
353 ******************************************************************************/
354 void bl2u_early_platform_setup(struct meminfo *mem_layout,
355 void *plat_info);
356 void bl2u_plat_arch_setup(void);
357 void bl2u_platform_setup(void);
358
359 /*******************************************************************************
360 * Conditionally mandatory BL2U functions for CSS platforms.
361 ******************************************************************************/
362 /*
363 * This function is used to perform any platform-specific actions required to
364 * handle the BL2U_SCP firmware.
365 */
366 int bl2u_plat_handle_scp_bl2u(void);
367
368 /*******************************************************************************
369 * Mandatory BL31 functions
370 ******************************************************************************/
371 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
372 u_register_t arg2, u_register_t arg3);
373 void bl31_plat_arch_setup(void);
374 void bl31_platform_setup(void);
375 void bl31_plat_runtime_setup(void);
376 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
377
378 /*******************************************************************************
379 * Mandatory PSCI functions (BL31)
380 ******************************************************************************/
381 int plat_setup_psci_ops(uintptr_t sec_entrypoint,
382 const struct plat_psci_ops **psci_ops);
383 const unsigned char *plat_get_power_domain_tree_desc(void);
384
385 /*******************************************************************************
386 * Optional PSCI functions (BL31).
387 ******************************************************************************/
388 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
389 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
390 u_register_t plat_psci_stat_get_residency(unsigned int lvl,
391 const psci_power_state_t *state_info,
392 unsigned int last_cpu_idx);
393 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
394 const plat_local_state_t *states,
395 unsigned int ncpu);
396
397 /*******************************************************************************
398 * Mandatory BL31 functions when ENABLE_RME=1
399 ******************************************************************************/
400 #if ENABLE_RME
401
402 int plat_rmmd_get_cca_attest_token(uintptr_t buf, size_t *len,
403 uintptr_t hash, size_t hash_size,
404 uint64_t *remaining_len);
405 int plat_rmmd_get_cca_realm_attest_key(uintptr_t buf, size_t *len,
406 unsigned int type);
407 /* The following 3 functions are to be implement if
408 * RMMD_ENABLE_EL3_TOKEN_SIGN=1.
409 * The following three functions are expected to return E_RMM_* error codes.
410 */
411 int plat_rmmd_el3_token_sign_get_rak_pub(uintptr_t buf, size_t *len,
412 unsigned int type);
413 int plat_rmmd_el3_token_sign_push_req(
414 const struct el3_token_sign_request *req);
415 int plat_rmmd_el3_token_sign_pull_resp(struct el3_token_sign_response *resp);
416 size_t plat_rmmd_get_el3_rmm_shared_mem(uintptr_t *shared);
417 int plat_rmmd_load_manifest(struct rmm_manifest *manifest);
418 int plat_rmmd_mecid_key_update(uint16_t mecid, unsigned int reason);
419 uintptr_t plat_rmmd_reserve_memory(size_t size, unsigned long alignment);
420
421 /* The following 4 functions are to be implemented if
422 * RMMD_ENABLE_IDE_KEY_PROG=1.
423 * The following functions are expected to return E_RMM_* error codes.
424 */
425 int plat_rmmd_el3_ide_key_program(uint64_t ecam_address, uint64_t root_port_id,
426 uint64_t ide_stream_info,
427 rp_ide_key_info_t *ide_key_info_ptr,
428 uint64_t request_id, uint64_t cookie);
429 int plat_rmmd_el3_ide_key_set_go(uint64_t ecam_address, uint64_t root_port_id,
430 uint64_t ide_stream_info, uint64_t request_id,
431 uint64_t cookie);
432 int plat_rmmd_el3_ide_key_set_stop(uint64_t ecam_address, uint64_t root_port_id,
433 uint64_t ide_stream_info, uint64_t request_id,
434 uint64_t cookie);
435 int plat_rmmd_el3_ide_km_pull_response(uint64_t ecam_address, uint64_t root_port_id,
436 uint64_t *req_resp, uint64_t *request_id,
437 uint64_t *cookie);
438 #endif /* ENABLE_RME */
439
440 /*******************************************************************************
441 * Optional BL31 functions (may be overridden)
442 ******************************************************************************/
443 void bl31_plat_enable_mmu(uint32_t flags);
444
445 /*******************************************************************************
446 * Optional BL32 functions (may be overridden)
447 ******************************************************************************/
448 void bl32_plat_enable_mmu(uint32_t flags);
449
450 /*******************************************************************************
451 * Trusted Board Boot functions
452 ******************************************************************************/
453 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
454 unsigned int *flags);
455 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
456 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
457 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
458 unsigned int nv_ctr);
459 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
460 int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key,
461 size_t *key_len, unsigned int *flags,
462 const uint8_t *img_id, size_t img_id_len);
463
464 /*******************************************************************************
465 * Secure Partitions functions
466 ******************************************************************************/
467 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
468 const struct spm_mm_boot_info *plat_get_secure_partition_boot_info(
469 void *cookie);
470 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
471 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
472 void **rd_base, size_t *rd_size);
473 #if defined(SPD_spmd)
474 int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest,
475 const void *pm_addr);
476 #endif
477 #if defined(SPMC_AT_EL3)
478 int plat_spmc_shmem_datastore_get(uint8_t **datastore, size_t *size);
479 #endif
480
481 /*******************************************************************************
482 * Mandatory BL image load functions(may be overridden).
483 ******************************************************************************/
484 /*
485 * This function returns pointer to the list of images that the
486 * platform has populated to load.
487 */
488 struct bl_load_info *plat_get_bl_image_load_info(void);
489
490 /*
491 * This function returns a pointer to the shared memory that the
492 * platform has kept aside to pass trusted firmware related
493 * information that next BL image could need.
494 */
495 struct bl_params *plat_get_next_bl_params(void);
496
497 /*
498 * This function flushes to main memory all the params that are
499 * passed to next image.
500 */
501 void plat_flush_next_bl_params(void);
502
503 /*
504 * Optional function to get SOC version
505 */
506 int32_t plat_get_soc_version(void);
507
508 /*
509 * Optional function to get SOC revision
510 */
511 int32_t plat_get_soc_revision(void);
512
513 /*
514 * Optional function to get SoC name
515 */
516 int32_t plat_get_soc_name(char *soc_name);
517
518 /*
519 * Optional function to check for SMCCC function availability for platform
520 */
521 int32_t plat_is_smccc_feature_available(u_register_t fid);
522
523 /*
524 * Optional function to retrieve the base address of hardware DT from the
525 * platform.
526 */
527 uintptr_t plat_get_hw_dt_base(void);
528
529 /*******************************************************************************
530 * FWU platform specific functions
531 ******************************************************************************/
532 int plat_fwu_set_metadata_image_source(unsigned int image_id,
533 uintptr_t *dev_handle,
534 uintptr_t *image_spec);
535 void plat_fwu_set_images_source(const struct fwu_metadata *metadata);
536 uint32_t plat_fwu_get_boot_idx(void);
537
538 /*
539 * Optional function to indicate if cache management operations can be
540 * performed.
541 */
542 #if CONDITIONAL_CMO
543 uint64_t plat_can_cmo(void);
544 #else
plat_can_cmo(void)545 static inline uint64_t plat_can_cmo(void)
546 {
547 return 1;
548 }
549 #endif /* CONDITIONAL_CMO */
550
551 #endif /* PLATFORM_H */
552