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