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