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