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