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 int plat_ic_is_spi(unsigned int id); 137 int plat_ic_is_ppi(unsigned int id); 138 int 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 void plat_system_reset(void) __dead2; 169 const char *plat_log_get_prefix(unsigned int log_level); 170 void bl2_plat_preload_setup(void); 171 void plat_setup_try_img_ops(const struct plat_try_images_ops *plat_try_ops); 172 173 #if MEASURED_BOOT 174 int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data); 175 int plat_mboot_measure_critical_data(unsigned int critical_data_id, 176 const void *base, 177 size_t size); 178 int plat_mboot_measure_key(const void *pk_oid, const void *pk_ptr, 179 size_t pk_len); 180 #else 181 static inline int plat_mboot_measure_image(unsigned int image_id __unused, 182 image_info_t *image_data __unused) 183 { 184 return 0; 185 } 186 static inline int plat_mboot_measure_critical_data( 187 unsigned int critical_data_id __unused, 188 const void *base __unused, 189 size_t size __unused) 190 { 191 return 0; 192 } 193 static inline int plat_mboot_measure_key(const void *pk_oid __unused, 194 const void *pk_ptr __unused, 195 size_t pk_len __unused) 196 { 197 return 0; 198 } 199 #endif /* MEASURED_BOOT */ 200 201 #if EARLY_CONSOLE 202 void plat_setup_early_console(void); 203 #else 204 static inline void plat_setup_early_console(void) 205 { 206 } 207 #endif /* EARLY_CONSOLE */ 208 209 /******************************************************************************* 210 * Mandatory BL1 functions 211 ******************************************************************************/ 212 void bl1_early_platform_setup(void); 213 void bl1_plat_arch_setup(void); 214 void bl1_platform_setup(void); 215 struct meminfo *bl1_plat_sec_mem_layout(void); 216 217 /******************************************************************************* 218 * Optional EL3 component functions in BL31 219 ******************************************************************************/ 220 221 /* SDEI platform functions */ 222 #if SDEI_SUPPORT 223 void plat_sdei_setup(void); 224 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); 225 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); 226 #endif 227 228 void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 229 void *handle, uint64_t flags); 230 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 231 void *handle, uint64_t flags); 232 233 /* 234 * The following function is mandatory when the 235 * firmware update feature is used. 236 */ 237 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 238 unsigned int flags); 239 240 /******************************************************************************* 241 * Optional BL1 functions (may be overridden) 242 ******************************************************************************/ 243 /* 244 * The following functions are used for image loading process in BL1. 245 */ 246 void bl1_plat_set_ep_info(unsigned int image_id, 247 struct entry_point_info *ep_info); 248 /* 249 * The following functions are mandatory when firmware update 250 * feature is used and optional otherwise. 251 */ 252 unsigned int bl1_plat_get_next_image_id(void); 253 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 254 255 /* 256 * The following functions are used by firmware update 257 * feature and may optionally be overridden. 258 */ 259 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 260 261 /* 262 * This BL1 function can be used by the platforms to update/use image 263 * information for a given `image_id`. 264 */ 265 int bl1_plat_handle_pre_image_load(unsigned int image_id); 266 int bl1_plat_handle_post_image_load(unsigned int image_id); 267 268 /* Utility functions */ 269 void bl1_plat_calc_bl2_layout(const meminfo_t *bl1_mem_layout, 270 meminfo_t *bl2_mem_layout); 271 272 #if MEASURED_BOOT 273 void bl1_plat_mboot_init(void); 274 void bl1_plat_mboot_finish(void); 275 #else 276 static inline void bl1_plat_mboot_init(void) 277 { 278 } 279 static inline void bl1_plat_mboot_finish(void) 280 { 281 } 282 #endif /* MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENT */ 283 284 /******************************************************************************* 285 * Mandatory BL2 functions 286 ******************************************************************************/ 287 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 288 void bl2_plat_arch_setup(void); 289 void bl2_platform_setup(void); 290 struct meminfo *bl2_plat_sec_mem_layout(void); 291 292 /* 293 * This function can be used by the platforms to update/use image 294 * information for given `image_id`. 295 */ 296 int bl2_plat_handle_pre_image_load(unsigned int image_id); 297 int bl2_plat_handle_post_image_load(unsigned int image_id); 298 299 /******************************************************************************* 300 * Optional BL2 functions (may be overridden) 301 ******************************************************************************/ 302 #if (MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENT) 303 void bl2_plat_mboot_init(void); 304 void bl2_plat_mboot_finish(void); 305 #if TRANSFER_LIST 306 int plat_handoff_mboot(const void *data, uint32_t data_size, void *tl_base); 307 #else 308 static inline int 309 plat_handoff_mboot(__unused const void *data, __unused uint32_t data_size, 310 __unused void *tl_base) 311 { 312 return -1; 313 } 314 #endif 315 #else 316 static inline void bl2_plat_mboot_init(void) 317 { 318 } 319 static inline void bl2_plat_mboot_finish(void) 320 { 321 } 322 #endif /* MEASURED_BOOT || DICE_PROTECTION_ENVIRONMENTs */ 323 324 /******************************************************************************* 325 * Mandatory BL2 at EL3 functions: Must be implemented 326 * if RESET_TO_BL2 image is supported 327 ******************************************************************************/ 328 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 329 u_register_t arg2, u_register_t arg3); 330 void bl2_el3_plat_arch_setup(void); 331 332 /******************************************************************************* 333 * Optional BL2 at EL3 functions (may be overridden) 334 ******************************************************************************/ 335 void bl2_el3_plat_prepare_exit(void); 336 337 /******************************************************************************* 338 * Mandatory BL2U functions. 339 ******************************************************************************/ 340 void bl2u_early_platform_setup(struct meminfo *mem_layout, 341 void *plat_info); 342 void bl2u_plat_arch_setup(void); 343 void bl2u_platform_setup(void); 344 345 /******************************************************************************* 346 * Conditionally mandatory BL2U functions for CSS platforms. 347 ******************************************************************************/ 348 /* 349 * This function is used to perform any platform-specific actions required to 350 * handle the BL2U_SCP firmware. 351 */ 352 int bl2u_plat_handle_scp_bl2u(void); 353 354 /******************************************************************************* 355 * Mandatory BL31 functions 356 ******************************************************************************/ 357 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 358 u_register_t arg2, u_register_t arg3); 359 void bl31_plat_arch_setup(void); 360 void bl31_platform_setup(void); 361 void bl31_plat_runtime_setup(void); 362 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 363 364 /******************************************************************************* 365 * Mandatory PSCI functions (BL31) 366 ******************************************************************************/ 367 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 368 const struct plat_psci_ops **psci_ops); 369 const unsigned char *plat_get_power_domain_tree_desc(void); 370 371 /******************************************************************************* 372 * Optional PSCI functions (BL31). 373 ******************************************************************************/ 374 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 375 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 376 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 377 const psci_power_state_t *state_info, 378 unsigned int last_cpu_idx); 379 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 380 const plat_local_state_t *states, 381 unsigned int ncpu); 382 383 /******************************************************************************* 384 * Mandatory BL31 functions when ENABLE_RME=1 385 ******************************************************************************/ 386 #if ENABLE_RME 387 388 int plat_rmmd_get_cca_attest_token(uintptr_t buf, size_t *len, 389 uintptr_t hash, size_t hash_size, 390 uint64_t *remaining_len); 391 int plat_rmmd_get_cca_realm_attest_key(uintptr_t buf, size_t *len, 392 unsigned int type); 393 /* The following 3 functions are to be implement if 394 * RMMD_ENABLE_EL3_TOKEN_SIGN=1. 395 * The following three functions are expected to return E_RMM_* error codes. 396 */ 397 int plat_rmmd_el3_token_sign_get_rak_pub(uintptr_t buf, size_t *len, 398 unsigned int type); 399 int plat_rmmd_el3_token_sign_push_req( 400 const struct el3_token_sign_request *req); 401 int plat_rmmd_el3_token_sign_pull_resp(struct el3_token_sign_response *resp); 402 size_t plat_rmmd_get_el3_rmm_shared_mem(uintptr_t *shared); 403 int plat_rmmd_load_manifest(struct rmm_manifest *manifest); 404 int plat_rmmd_mecid_key_update(uint16_t mecid); 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