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 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 ******************************************************************************/ 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 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 } 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 } 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 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 #if MEASURED_BOOT 285 void bl1_plat_mboot_init(void); 286 void bl1_plat_mboot_finish(void); 287 #else 288 static inline void bl1_plat_mboot_init(void) 289 { 290 } 291 static inline void bl1_plat_mboot_finish(void) 292 { 293 } 294 #endif /* MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENT */ 295 296 /******************************************************************************* 297 * Mandatory BL2 functions 298 ******************************************************************************/ 299 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 300 void bl2_plat_arch_setup(void); 301 void bl2_platform_setup(void); 302 struct meminfo *bl2_plat_sec_mem_layout(void); 303 304 /* 305 * This function can be used by the platforms to update/use image 306 * information for given `image_id`. 307 */ 308 int bl2_plat_handle_pre_image_load(unsigned int image_id); 309 int bl2_plat_handle_post_image_load(unsigned int image_id); 310 311 /******************************************************************************* 312 * Optional BL2 functions (may be overridden) 313 ******************************************************************************/ 314 #if (MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENT) 315 void bl2_plat_mboot_init(void); 316 void bl2_plat_mboot_finish(void); 317 #if TRANSFER_LIST 318 int plat_handoff_mboot(const void *data, uint32_t data_size, void *tl_base); 319 #else 320 static inline int 321 plat_handoff_mboot(__unused const void *data, __unused uint32_t data_size, 322 __unused void *tl_base) 323 { 324 return -1; 325 } 326 #endif 327 #else 328 static inline void bl2_plat_mboot_init(void) 329 { 330 } 331 static inline void bl2_plat_mboot_finish(void) 332 { 333 } 334 #endif /* MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENTs */ 335 336 /******************************************************************************* 337 * Mandatory BL2 at EL3 functions: Must be implemented 338 * if RESET_TO_BL2 image is supported 339 ******************************************************************************/ 340 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 341 u_register_t arg2, u_register_t arg3); 342 void bl2_el3_plat_arch_setup(void); 343 344 /******************************************************************************* 345 * Optional BL2 at EL3 functions (may be overridden) 346 ******************************************************************************/ 347 void bl2_el3_plat_prepare_exit(void); 348 349 /******************************************************************************* 350 * Mandatory BL2U functions. 351 ******************************************************************************/ 352 void bl2u_early_platform_setup(struct meminfo *mem_layout, 353 void *plat_info); 354 void bl2u_plat_arch_setup(void); 355 void bl2u_platform_setup(void); 356 357 /******************************************************************************* 358 * Conditionally mandatory BL2U functions for CSS platforms. 359 ******************************************************************************/ 360 /* 361 * This function is used to perform any platform-specific actions required to 362 * handle the BL2U_SCP firmware. 363 */ 364 int bl2u_plat_handle_scp_bl2u(void); 365 366 /******************************************************************************* 367 * Mandatory BL31 functions 368 ******************************************************************************/ 369 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 370 u_register_t arg2, u_register_t arg3); 371 void bl31_plat_arch_setup(void); 372 void bl31_platform_setup(void); 373 void bl31_plat_runtime_setup(void); 374 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 375 376 /******************************************************************************* 377 * Mandatory PSCI functions (BL31) 378 ******************************************************************************/ 379 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 380 const struct plat_psci_ops **psci_ops); 381 const unsigned char *plat_get_power_domain_tree_desc(void); 382 383 /******************************************************************************* 384 * Optional PSCI functions (BL31). 385 ******************************************************************************/ 386 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 387 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 388 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 389 const psci_power_state_t *state_info, 390 unsigned int last_cpu_idx); 391 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 392 const plat_local_state_t *states, 393 unsigned int ncpu); 394 395 /******************************************************************************* 396 * Mandatory BL31 functions when ENABLE_RME=1 397 ******************************************************************************/ 398 #if ENABLE_RME 399 400 int plat_rmmd_get_cca_attest_token(uintptr_t buf, size_t *len, 401 uintptr_t hash, size_t hash_size, 402 uint64_t *remaining_len); 403 int plat_rmmd_get_cca_realm_attest_key(uintptr_t buf, size_t *len, 404 unsigned int type); 405 /* The following 3 functions are to be implement if 406 * RMMD_ENABLE_EL3_TOKEN_SIGN=1. 407 * The following three functions are expected to return E_RMM_* error codes. 408 */ 409 int plat_rmmd_el3_token_sign_get_rak_pub(uintptr_t buf, size_t *len, 410 unsigned int type); 411 int plat_rmmd_el3_token_sign_push_req( 412 const struct el3_token_sign_request *req); 413 int plat_rmmd_el3_token_sign_pull_resp(struct el3_token_sign_response *resp); 414 size_t plat_rmmd_get_el3_rmm_shared_mem(uintptr_t *shared); 415 int plat_rmmd_load_manifest(struct rmm_manifest *manifest); 416 int plat_rmmd_mecid_key_update(uint16_t mecid, unsigned int reason); 417 uintptr_t plat_rmmd_reserve_memory(size_t size, unsigned long alignment); 418 419 /* The following 4 functions are to be implemented if 420 * RMMD_ENABLE_IDE_KEY_PROG=1. 421 * The following functions are expected to return E_RMM_* error codes. 422 */ 423 int plat_rmmd_el3_ide_key_program(uint64_t ecam_address, uint64_t root_port_id, 424 uint64_t ide_stream_info, 425 rp_ide_key_info_t *ide_key_info_ptr, 426 uint64_t request_id, uint64_t cookie); 427 int plat_rmmd_el3_ide_key_set_go(uint64_t ecam_address, uint64_t root_port_id, 428 uint64_t ide_stream_info, uint64_t request_id, 429 uint64_t cookie); 430 int plat_rmmd_el3_ide_key_set_stop(uint64_t ecam_address, uint64_t root_port_id, 431 uint64_t ide_stream_info, uint64_t request_id, 432 uint64_t cookie); 433 int plat_rmmd_el3_ide_km_pull_response(uint64_t ecam_address, uint64_t root_port_id, 434 uint64_t *req_resp, uint64_t *request_id, 435 uint64_t *cookie); 436 #endif /* ENABLE_RME */ 437 438 /******************************************************************************* 439 * Optional BL31 functions (may be overridden) 440 ******************************************************************************/ 441 void bl31_plat_enable_mmu(uint32_t flags); 442 443 /******************************************************************************* 444 * Optional BL32 functions (may be overridden) 445 ******************************************************************************/ 446 void bl32_plat_enable_mmu(uint32_t flags); 447 448 /******************************************************************************* 449 * Trusted Board Boot functions 450 ******************************************************************************/ 451 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 452 unsigned int *flags); 453 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 454 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 455 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 456 unsigned int nv_ctr); 457 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size); 458 int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key, 459 size_t *key_len, unsigned int *flags, 460 const uint8_t *img_id, size_t img_id_len); 461 462 /******************************************************************************* 463 * Secure Partitions functions 464 ******************************************************************************/ 465 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 466 const struct spm_mm_boot_info *plat_get_secure_partition_boot_info( 467 void *cookie); 468 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size); 469 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size, 470 void **rd_base, size_t *rd_size); 471 #if defined(SPD_spmd) 472 int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest, 473 const void *pm_addr); 474 #endif 475 #if defined(SPMC_AT_EL3) 476 int plat_spmc_shmem_datastore_get(uint8_t **datastore, size_t *size); 477 #endif 478 479 /******************************************************************************* 480 * Mandatory BL image load functions(may be overridden). 481 ******************************************************************************/ 482 /* 483 * This function returns pointer to the list of images that the 484 * platform has populated to load. 485 */ 486 struct bl_load_info *plat_get_bl_image_load_info(void); 487 488 /* 489 * This function returns a pointer to the shared memory that the 490 * platform has kept aside to pass trusted firmware related 491 * information that next BL image could need. 492 */ 493 struct bl_params *plat_get_next_bl_params(void); 494 495 /* 496 * This function flushes to main memory all the params that are 497 * passed to next image. 498 */ 499 void plat_flush_next_bl_params(void); 500 501 /* 502 * Optional function to get SOC version 503 */ 504 int32_t plat_get_soc_version(void); 505 506 /* 507 * Optional function to get SOC revision 508 */ 509 int32_t plat_get_soc_revision(void); 510 511 /* 512 * Optional function to get SoC name 513 */ 514 int32_t plat_get_soc_name(char *soc_name); 515 516 /* 517 * Optional function to check for SMCCC function availability for platform 518 */ 519 int32_t plat_is_smccc_feature_available(u_register_t fid); 520 521 /* 522 * Optional function to retrieve the base address of hardware DT from the 523 * platform. 524 */ 525 uintptr_t plat_get_hw_dt_base(void); 526 527 /******************************************************************************* 528 * FWU platform specific functions 529 ******************************************************************************/ 530 int plat_fwu_set_metadata_image_source(unsigned int image_id, 531 uintptr_t *dev_handle, 532 uintptr_t *image_spec); 533 void plat_fwu_set_images_source(const struct fwu_metadata *metadata); 534 uint32_t plat_fwu_get_boot_idx(void); 535 536 /* 537 * Optional function to indicate if cache management operations can be 538 * performed. 539 */ 540 #if CONDITIONAL_CMO 541 uint64_t plat_can_cmo(void); 542 #else 543 static inline uint64_t plat_can_cmo(void) 544 { 545 return 1; 546 } 547 #endif /* CONDITIONAL_CMO */ 548 549 #endif /* PLATFORM_H */ 550