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