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