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