1 /* 2 * Copyright (c) 2013-2018, 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 <psci.h> 11 #include <stdint.h> 12 13 /******************************************************************************* 14 * Forward declarations 15 ******************************************************************************/ 16 struct auth_img_desc_s; 17 struct meminfo; 18 struct image_info; 19 struct entry_point_info; 20 struct bl31_params; 21 struct image_desc; 22 struct bl_load_info; 23 struct bl_params; 24 struct mmap_region; 25 struct secure_partition_boot_info; 26 27 /******************************************************************************* 28 * plat_get_rotpk_info() flags 29 ******************************************************************************/ 30 #define ROTPK_IS_HASH (1 << 0) 31 /* Flag used to skip verification of the certificate ROTPK while the platform 32 ROTPK is not deployed */ 33 #define ROTPK_NOT_DEPLOYED (1 << 1) 34 35 /******************************************************************************* 36 * Function declarations 37 ******************************************************************************/ 38 /******************************************************************************* 39 * Mandatory common functions 40 ******************************************************************************/ 41 unsigned long long plat_get_syscnt_freq(void) __deprecated; 42 unsigned int plat_get_syscnt_freq2(void); 43 44 int plat_get_image_source(unsigned int image_id, 45 uintptr_t *dev_handle, 46 uintptr_t *image_spec); 47 uintptr_t plat_get_ns_image_entrypoint(void); 48 unsigned int plat_my_core_pos(void); 49 int plat_core_pos_by_mpidr(u_register_t mpidr); 50 51 #if STACK_PROTECTOR_ENABLED 52 /* 53 * Return a new value to be used for the stack protection's canary. 54 * 55 * Ideally, this value is a random number that is impossible to predict by an 56 * attacker. 57 */ 58 u_register_t plat_get_stack_protector_canary(void); 59 #endif /* STACK_PROTECTOR_ENABLED */ 60 61 /******************************************************************************* 62 * Mandatory interrupt management functions 63 ******************************************************************************/ 64 uint32_t plat_ic_get_pending_interrupt_id(void); 65 uint32_t plat_ic_get_pending_interrupt_type(void); 66 uint32_t plat_ic_acknowledge_interrupt(void); 67 uint32_t plat_ic_get_interrupt_type(uint32_t id); 68 void plat_ic_end_of_interrupt(uint32_t id); 69 uint32_t plat_interrupt_type_to_line(uint32_t type, 70 uint32_t security_state); 71 72 /******************************************************************************* 73 * Optional interrupt management functions, depending on chosen EL3 components. 74 ******************************************************************************/ 75 unsigned int plat_ic_get_running_priority(void); 76 int plat_ic_is_spi(unsigned int id); 77 int plat_ic_is_ppi(unsigned int id); 78 int plat_ic_is_sgi(unsigned int id); 79 unsigned int plat_ic_get_interrupt_active(unsigned int id); 80 void plat_ic_disable_interrupt(unsigned int id); 81 void plat_ic_enable_interrupt(unsigned int id); 82 int plat_ic_has_interrupt_type(unsigned int type); 83 void plat_ic_set_interrupt_type(unsigned int id, unsigned int type); 84 void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority); 85 void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target); 86 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode, 87 u_register_t mpidr); 88 void plat_ic_set_interrupt_pending(unsigned int id); 89 void plat_ic_clear_interrupt_pending(unsigned int id); 90 unsigned int plat_ic_set_priority_mask(unsigned int mask); 91 unsigned int plat_ic_get_interrupt_id(unsigned int raw); 92 93 /******************************************************************************* 94 * Optional common functions (may be overridden) 95 ******************************************************************************/ 96 uintptr_t plat_get_my_stack(void); 97 void plat_report_exception(unsigned int exception_type); 98 int plat_crash_console_init(void); 99 int plat_crash_console_putc(int c); 100 int plat_crash_console_flush(void); 101 void plat_error_handler(int err) __dead2; 102 void plat_panic_handler(void) __dead2; 103 const char *plat_log_get_prefix(unsigned int log_level); 104 void bl2_plat_preload_setup(void); 105 int plat_try_next_boot_source(void); 106 int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size); 107 108 /******************************************************************************* 109 * Mandatory BL1 functions 110 ******************************************************************************/ 111 void bl1_early_platform_setup(void); 112 void bl1_plat_arch_setup(void); 113 void bl1_platform_setup(void); 114 struct meminfo *bl1_plat_sec_mem_layout(void); 115 116 /******************************************************************************* 117 * Optional EL3 component functions in BL31 118 ******************************************************************************/ 119 120 /* SDEI platform functions */ 121 #if SDEI_SUPPORT 122 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); 123 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); 124 #endif 125 126 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 127 void *handle, uint64_t flags); 128 129 /* 130 * The following function is mandatory when the 131 * firmware update feature is used. 132 */ 133 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 134 unsigned int flags); 135 136 /******************************************************************************* 137 * Optional BL1 functions (may be overridden) 138 ******************************************************************************/ 139 #if !ERROR_DEPRECATED 140 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 141 struct meminfo *bl2_mem_layout); 142 #endif 143 /* 144 * The following functions are used for image loading process in BL1. 145 */ 146 void bl1_plat_set_ep_info(unsigned int image_id, 147 struct entry_point_info *ep_info); 148 /* 149 * The following functions are mandatory when firmware update 150 * feature is used and optional otherwise. 151 */ 152 unsigned int bl1_plat_get_next_image_id(void); 153 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 154 155 /* 156 * The following functions are used by firmware update 157 * feature and may optionally be overridden. 158 */ 159 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 160 161 /* 162 * This BL1 function can be used by the platforms to update/use image 163 * information for a given `image_id`. 164 */ 165 int bl1_plat_handle_pre_image_load(unsigned int image_id); 166 int bl1_plat_handle_post_image_load(unsigned int image_id); 167 168 /******************************************************************************* 169 * Mandatory BL2 functions 170 ******************************************************************************/ 171 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 172 #if !ERROR_DEPRECATED 173 void bl2_early_platform_setup(struct meminfo *mem_layout); 174 #endif 175 void bl2_plat_arch_setup(void); 176 void bl2_platform_setup(void); 177 struct meminfo *bl2_plat_sec_mem_layout(void); 178 179 #if LOAD_IMAGE_V2 180 /* 181 * This function can be used by the platforms to update/use image 182 * information for given `image_id`. 183 */ 184 int bl2_plat_handle_pre_image_load(unsigned int image_id); 185 int bl2_plat_handle_post_image_load(unsigned int image_id); 186 187 #else /* LOAD_IMAGE_V2 */ 188 189 /* 190 * This function returns a pointer to the shared memory that the platform has 191 * kept aside to pass trusted firmware related information that BL31 192 * could need 193 */ 194 struct bl31_params *bl2_plat_get_bl31_params(void); 195 196 /* 197 * This function returns a pointer to the shared memory that the platform 198 * has kept to point to entry point information of BL31 to BL2 199 */ 200 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 201 202 /* 203 * This function flushes to main memory all the params that are 204 * passed to BL31 205 */ 206 void bl2_plat_flush_bl31_params(void); 207 208 /* 209 * The next 2 functions allow the platform to change the entrypoint information 210 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 211 * BL2 has loaded those images into memory but before BL31 is executed. 212 */ 213 void bl2_plat_set_bl31_ep_info(struct image_info *image, 214 struct entry_point_info *ep); 215 216 void bl2_plat_set_bl33_ep_info(struct image_info *image, 217 struct entry_point_info *ep); 218 219 /* Gets the memory layout for BL33 */ 220 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 221 222 /******************************************************************************* 223 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 224 * is supported 225 ******************************************************************************/ 226 /* Gets the memory layout for SCP_BL2 */ 227 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 228 229 /* 230 * This function is called after loading SCP_BL2 image and it is used to perform 231 * any platform-specific actions required to handle the SCP firmware. 232 */ 233 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 234 235 /******************************************************************************* 236 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 237 * is supported 238 ******************************************************************************/ 239 void bl2_plat_set_bl32_ep_info(struct image_info *image, 240 struct entry_point_info *ep); 241 242 /* Gets the memory layout for BL32 */ 243 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 244 245 #endif /* LOAD_IMAGE_V2 */ 246 247 /******************************************************************************* 248 * Optional BL2 functions (may be overridden) 249 ******************************************************************************/ 250 251 252 /******************************************************************************* 253 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is 254 * supported 255 ******************************************************************************/ 256 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 257 u_register_t arg2, u_register_t arg3); 258 void bl2_el3_plat_arch_setup(void); 259 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 #if !ERROR_DEPRECATED 287 #if LOAD_IMAGE_V2 288 void bl31_early_platform_setup(void *from_bl2, 289 void *plat_params_from_bl2); 290 #else 291 void bl31_early_platform_setup(struct bl31_params *from_bl2, 292 void *plat_params_from_bl2); 293 #endif 294 #endif /* ERROR_DEPRECATED */ 295 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 296 u_register_t arg2, u_register_t arg3); 297 void bl31_plat_arch_setup(void); 298 void bl31_platform_setup(void); 299 void bl31_plat_runtime_setup(void); 300 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 301 302 /******************************************************************************* 303 * Mandatory PSCI functions (BL31) 304 ******************************************************************************/ 305 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 306 const struct plat_psci_ops **psci_ops); 307 const unsigned char *plat_get_power_domain_tree_desc(void); 308 309 /******************************************************************************* 310 * Optional PSCI functions (BL31). 311 ******************************************************************************/ 312 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 313 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 314 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 315 const psci_power_state_t *state_info, 316 int last_cpu_idx); 317 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 318 const plat_local_state_t *states, 319 unsigned int ncpu); 320 321 /******************************************************************************* 322 * Optional BL31 functions (may be overridden) 323 ******************************************************************************/ 324 void bl31_plat_enable_mmu(uint32_t flags); 325 326 /******************************************************************************* 327 * Optional BL32 functions (may be overridden) 328 ******************************************************************************/ 329 void bl32_plat_enable_mmu(uint32_t flags); 330 331 /******************************************************************************* 332 * Trusted Board Boot functions 333 ******************************************************************************/ 334 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 335 unsigned int *flags); 336 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 337 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 338 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 339 unsigned int nv_ctr); 340 341 /******************************************************************************* 342 * Secure Partitions functions 343 ******************************************************************************/ 344 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 345 const struct secure_partition_boot_info *plat_get_secure_partition_boot_info( 346 void *cookie); 347 348 #if LOAD_IMAGE_V2 349 /******************************************************************************* 350 * Mandatory BL image load functions(may be overridden). 351 ******************************************************************************/ 352 /* 353 * This function returns pointer to the list of images that the 354 * platform has populated to load. 355 */ 356 struct bl_load_info *plat_get_bl_image_load_info(void); 357 358 /* 359 * This function returns a pointer to the shared memory that the 360 * platform has kept aside to pass trusted firmware related 361 * information that next BL image could need. 362 */ 363 struct bl_params *plat_get_next_bl_params(void); 364 365 /* 366 * This function flushes to main memory all the params that are 367 * passed to next image. 368 */ 369 void plat_flush_next_bl_params(void); 370 371 #endif /* LOAD_IMAGE_V2 */ 372 373 #if ENABLE_PLAT_COMPAT 374 /* 375 * The below declarations are to enable compatibility for the platform ports 376 * using the old platform interface. 377 */ 378 379 /******************************************************************************* 380 * Optional common functions (may be overridden) 381 ******************************************************************************/ 382 unsigned int platform_get_core_pos(unsigned long mpidr); 383 384 /******************************************************************************* 385 * Mandatory PSCI Compatibility functions (BL31) 386 ******************************************************************************/ 387 int platform_setup_pm(const plat_pm_ops_t **); 388 389 unsigned int plat_get_aff_count(unsigned int, unsigned long); 390 unsigned int plat_get_aff_state(unsigned int, unsigned long); 391 392 #else /* __ENABLE_PLAT_COMPAT__ */ 393 /* 394 * The below function enable Trusted Firmware components like SPDs which 395 * haven't migrated to the new platform API to compile on platforms which 396 * have the compatibility layer disabled. 397 */ 398 unsigned int platform_core_pos_helper(unsigned long mpidr); 399 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 400 401 #endif /* __ENABLE_PLAT_COMPAT__ */ 402 403 #endif /* PLATFORM_H */ 404