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