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