1 /* 2 * Copyright (c) 2013-2023, 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_get_interrupt_id(unsigned int raw); 140 141 /******************************************************************************* 142 * Optional common functions (may be overridden) 143 ******************************************************************************/ 144 uintptr_t plat_get_my_stack(void); 145 void plat_report_exception(unsigned int exception_type); 146 void plat_report_prefetch_abort(unsigned int fault_address); 147 void plat_report_data_abort(unsigned int fault_address); 148 int plat_crash_console_init(void); 149 int plat_crash_console_putc(int c); 150 void plat_crash_console_flush(void); 151 void plat_error_handler(int err) __dead2; 152 void plat_panic_handler(void) __dead2; 153 void plat_system_reset(void) __dead2; 154 const char *plat_log_get_prefix(unsigned int log_level); 155 void bl2_plat_preload_setup(void); 156 int plat_try_next_boot_source(void); 157 158 #if MEASURED_BOOT 159 int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data); 160 int plat_mboot_measure_critical_data(unsigned int critical_data_id, 161 const void *base, 162 size_t size); 163 int plat_mboot_measure_key(const void *pk_oid, const void *pk_ptr, 164 size_t pk_len); 165 #else 166 static inline int plat_mboot_measure_image(unsigned int image_id __unused, 167 image_info_t *image_data __unused) 168 { 169 return 0; 170 } 171 static inline int plat_mboot_measure_critical_data( 172 unsigned int critical_data_id __unused, 173 const void *base __unused, 174 size_t size __unused) 175 { 176 return 0; 177 } 178 static inline int plat_mboot_measure_key(const void *pk_oid __unused, 179 const void *pk_ptr __unused, 180 size_t pk_len __unused) 181 { 182 return 0; 183 } 184 #endif /* MEASURED_BOOT */ 185 186 /******************************************************************************* 187 * Mandatory BL1 functions 188 ******************************************************************************/ 189 void bl1_early_platform_setup(void); 190 void bl1_plat_arch_setup(void); 191 void bl1_platform_setup(void); 192 struct meminfo *bl1_plat_sec_mem_layout(void); 193 194 /******************************************************************************* 195 * Optional EL3 component functions in BL31 196 ******************************************************************************/ 197 198 /* SDEI platform functions */ 199 #if SDEI_SUPPORT 200 void plat_sdei_setup(void); 201 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); 202 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); 203 #endif 204 205 void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 206 void *handle, uint64_t flags); 207 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 208 void *handle, uint64_t flags); 209 210 /* 211 * The following function is mandatory when the 212 * firmware update feature is used. 213 */ 214 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 215 unsigned int flags); 216 217 /******************************************************************************* 218 * Optional BL1 functions (may be overridden) 219 ******************************************************************************/ 220 /* 221 * The following functions are used for image loading process in BL1. 222 */ 223 void bl1_plat_set_ep_info(unsigned int image_id, 224 struct entry_point_info *ep_info); 225 /* 226 * The following functions are mandatory when firmware update 227 * feature is used and optional otherwise. 228 */ 229 unsigned int bl1_plat_get_next_image_id(void); 230 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 231 232 /* 233 * The following functions are used by firmware update 234 * feature and may optionally be overridden. 235 */ 236 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 237 238 /* 239 * This BL1 function can be used by the platforms to update/use image 240 * information for a given `image_id`. 241 */ 242 int bl1_plat_handle_pre_image_load(unsigned int image_id); 243 int bl1_plat_handle_post_image_load(unsigned int image_id); 244 245 #if MEASURED_BOOT 246 void bl1_plat_mboot_init(void); 247 void bl1_plat_mboot_finish(void); 248 #else 249 static inline void bl1_plat_mboot_init(void) 250 { 251 } 252 static inline void bl1_plat_mboot_finish(void) 253 { 254 } 255 #endif /* MEASURED_BOOT */ 256 257 /******************************************************************************* 258 * Mandatory BL2 functions 259 ******************************************************************************/ 260 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 261 void bl2_plat_arch_setup(void); 262 void bl2_platform_setup(void); 263 struct meminfo *bl2_plat_sec_mem_layout(void); 264 265 /* 266 * This function can be used by the platforms to update/use image 267 * information for given `image_id`. 268 */ 269 int bl2_plat_handle_pre_image_load(unsigned int image_id); 270 int bl2_plat_handle_post_image_load(unsigned int image_id); 271 272 /******************************************************************************* 273 * Optional BL2 functions (may be overridden) 274 ******************************************************************************/ 275 #if MEASURED_BOOT 276 void bl2_plat_mboot_init(void); 277 void bl2_plat_mboot_finish(void); 278 #else 279 static inline void bl2_plat_mboot_init(void) 280 { 281 } 282 static inline void bl2_plat_mboot_finish(void) 283 { 284 } 285 #endif /* MEASURED_BOOT */ 286 287 /******************************************************************************* 288 * Mandatory BL2 at EL3 functions: Must be implemented 289 * if RESET_TO_BL2 image is supported 290 ******************************************************************************/ 291 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 292 u_register_t arg2, u_register_t arg3); 293 void bl2_el3_plat_arch_setup(void); 294 295 /******************************************************************************* 296 * Optional BL2 at EL3 functions (may be overridden) 297 ******************************************************************************/ 298 void bl2_el3_plat_prepare_exit(void); 299 300 /******************************************************************************* 301 * Mandatory BL2U functions. 302 ******************************************************************************/ 303 void bl2u_early_platform_setup(struct meminfo *mem_layout, 304 void *plat_info); 305 void bl2u_plat_arch_setup(void); 306 void bl2u_platform_setup(void); 307 308 /******************************************************************************* 309 * Conditionally mandatory BL2U functions for CSS platforms. 310 ******************************************************************************/ 311 /* 312 * This function is used to perform any platform-specific actions required to 313 * handle the BL2U_SCP firmware. 314 */ 315 int bl2u_plat_handle_scp_bl2u(void); 316 317 /******************************************************************************* 318 * Mandatory BL31 functions 319 ******************************************************************************/ 320 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 321 u_register_t arg2, u_register_t arg3); 322 void bl31_plat_arch_setup(void); 323 void bl31_platform_setup(void); 324 void bl31_plat_runtime_setup(void); 325 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 326 327 /******************************************************************************* 328 * Mandatory PSCI functions (BL31) 329 ******************************************************************************/ 330 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 331 const struct plat_psci_ops **psci_ops); 332 const unsigned char *plat_get_power_domain_tree_desc(void); 333 334 /******************************************************************************* 335 * Optional PSCI functions (BL31). 336 ******************************************************************************/ 337 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 338 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 339 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 340 const psci_power_state_t *state_info, 341 unsigned int last_cpu_idx); 342 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 343 const plat_local_state_t *states, 344 unsigned int ncpu); 345 346 /******************************************************************************* 347 * Mandatory BL31 functions when ENABLE_RME=1 348 ******************************************************************************/ 349 #if ENABLE_RME 350 int plat_rmmd_get_cca_attest_token(uintptr_t buf, size_t *len, 351 uintptr_t hash, size_t hash_size); 352 int plat_rmmd_get_cca_realm_attest_key(uintptr_t buf, size_t *len, 353 unsigned int type); 354 size_t plat_rmmd_get_el3_rmm_shared_mem(uintptr_t *shared); 355 int plat_rmmd_load_manifest(struct rmm_manifest *manifest); 356 #endif 357 358 /******************************************************************************* 359 * Optional BL31 functions (may be overridden) 360 ******************************************************************************/ 361 void bl31_plat_enable_mmu(uint32_t flags); 362 363 /******************************************************************************* 364 * Optional BL32 functions (may be overridden) 365 ******************************************************************************/ 366 void bl32_plat_enable_mmu(uint32_t flags); 367 368 /******************************************************************************* 369 * Trusted Board Boot functions 370 ******************************************************************************/ 371 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 372 unsigned int *flags); 373 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 374 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 375 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 376 unsigned int nv_ctr); 377 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size); 378 int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key, 379 size_t *key_len, unsigned int *flags, 380 const uint8_t *img_id, size_t img_id_len); 381 382 /******************************************************************************* 383 * Secure Partitions functions 384 ******************************************************************************/ 385 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 386 const struct spm_mm_boot_info *plat_get_secure_partition_boot_info( 387 void *cookie); 388 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size); 389 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size, 390 void **rd_base, size_t *rd_size); 391 #if defined(SPD_spmd) 392 int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest, 393 const void *pm_addr); 394 #endif 395 #if defined(SPMC_AT_EL3) 396 int plat_spmc_shmem_datastore_get(uint8_t **datastore, size_t *size); 397 #endif 398 399 /******************************************************************************* 400 * Mandatory BL image load functions(may be overridden). 401 ******************************************************************************/ 402 /* 403 * This function returns pointer to the list of images that the 404 * platform has populated to load. 405 */ 406 struct bl_load_info *plat_get_bl_image_load_info(void); 407 408 /* 409 * This function returns a pointer to the shared memory that the 410 * platform has kept aside to pass trusted firmware related 411 * information that next BL image could need. 412 */ 413 struct bl_params *plat_get_next_bl_params(void); 414 415 /* 416 * This function flushes to main memory all the params that are 417 * passed to next image. 418 */ 419 void plat_flush_next_bl_params(void); 420 421 /* 422 * The below function enable Trusted Firmware components like SPDs which 423 * haven't migrated to the new platform API to compile on platforms which 424 * have the compatibility layer disabled. 425 */ 426 unsigned int platform_core_pos_helper(unsigned long mpidr); 427 428 /* 429 * Optional function to get SOC version 430 */ 431 int32_t plat_get_soc_version(void); 432 433 /* 434 * Optional function to get SOC revision 435 */ 436 int32_t plat_get_soc_revision(void); 437 438 /* 439 * Optional function to check for SMCCC function availability for platform 440 */ 441 int32_t plat_is_smccc_feature_available(u_register_t fid); 442 443 /******************************************************************************* 444 * FWU platform specific functions 445 ******************************************************************************/ 446 int plat_fwu_set_metadata_image_source(unsigned int image_id, 447 uintptr_t *dev_handle, 448 uintptr_t *image_spec); 449 void plat_fwu_set_images_source(const struct fwu_metadata *metadata); 450 uint32_t plat_fwu_get_boot_idx(void); 451 452 /* 453 * Optional function to indicate if cache management operations can be 454 * performed. 455 */ 456 #if CONDITIONAL_CMO 457 uint64_t plat_can_cmo(void); 458 #else 459 static inline uint64_t plat_can_cmo(void) 460 { 461 return 1; 462 } 463 #endif /* CONDITIONAL_CMO */ 464 465 #endif /* PLATFORM_H */ 466