1 /* 2 * Copyright (c) 2013-2017, 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 #include <types.h> 13 14 15 /******************************************************************************* 16 * Forward declarations 17 ******************************************************************************/ 18 struct auth_img_desc_s; 19 struct meminfo; 20 struct image_info; 21 struct entry_point_info; 22 struct bl31_params; 23 struct image_desc; 24 struct bl_load_info; 25 struct bl_params; 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 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 103 /******************************************************************************* 104 * Mandatory BL1 functions 105 ******************************************************************************/ 106 void bl1_early_platform_setup(void); 107 void bl1_plat_arch_setup(void); 108 void bl1_platform_setup(void); 109 struct meminfo *bl1_plat_sec_mem_layout(void); 110 111 /* 112 * The following function is mandatory when the 113 * firmware update feature is used. 114 */ 115 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 116 unsigned int flags); 117 118 /******************************************************************************* 119 * Optional BL1 functions (may be overridden) 120 ******************************************************************************/ 121 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 122 struct meminfo *bl2_mem_layout); 123 124 /* 125 * The following functions are used for image loading process in BL1. 126 */ 127 void bl1_plat_set_ep_info(unsigned int image_id, 128 struct entry_point_info *ep_info); 129 /* 130 * The following functions are mandatory when firmware update 131 * feature is used and optional otherwise. 132 */ 133 unsigned int bl1_plat_get_next_image_id(void); 134 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 135 136 /* 137 * The following functions are used by firmware update 138 * feature and may optionally be overridden. 139 */ 140 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 141 142 143 /******************************************************************************* 144 * Mandatory BL2 functions 145 ******************************************************************************/ 146 void bl2_early_platform_setup(struct meminfo *mem_layout); 147 void bl2_plat_arch_setup(void); 148 void bl2_platform_setup(void); 149 struct meminfo *bl2_plat_sec_mem_layout(void); 150 151 #if LOAD_IMAGE_V2 152 /* 153 * This function can be used by the platforms to update/use image 154 * information for given `image_id`. 155 */ 156 int bl2_plat_handle_post_image_load(unsigned int image_id); 157 158 #else /* LOAD_IMAGE_V2 */ 159 160 /* 161 * This function returns a pointer to the shared memory that the platform has 162 * kept aside to pass trusted firmware related information that BL31 163 * could need 164 */ 165 struct bl31_params *bl2_plat_get_bl31_params(void); 166 167 /* 168 * This function returns a pointer to the shared memory that the platform 169 * has kept to point to entry point information of BL31 to BL2 170 */ 171 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 172 173 /* 174 * This function flushes to main memory all the params that are 175 * passed to BL31 176 */ 177 void bl2_plat_flush_bl31_params(void); 178 179 /* 180 * The next 2 functions allow the platform to change the entrypoint information 181 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 182 * BL2 has loaded those images into memory but before BL31 is executed. 183 */ 184 void bl2_plat_set_bl31_ep_info(struct image_info *image, 185 struct entry_point_info *ep); 186 187 void bl2_plat_set_bl33_ep_info(struct image_info *image, 188 struct entry_point_info *ep); 189 190 /* Gets the memory layout for BL33 */ 191 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 192 193 /******************************************************************************* 194 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 195 * is supported 196 ******************************************************************************/ 197 /* Gets the memory layout for SCP_BL2 */ 198 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 199 200 /* 201 * This function is called after loading SCP_BL2 image and it is used to perform 202 * any platform-specific actions required to handle the SCP firmware. 203 */ 204 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 205 206 /******************************************************************************* 207 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 208 * is supported 209 ******************************************************************************/ 210 void bl2_plat_set_bl32_ep_info(struct image_info *image, 211 struct entry_point_info *ep); 212 213 /* Gets the memory layout for BL32 */ 214 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 215 216 #endif /* LOAD_IMAGE_V2 */ 217 218 /******************************************************************************* 219 * Optional BL2 functions (may be overridden) 220 ******************************************************************************/ 221 222 /******************************************************************************* 223 * Mandatory BL2U functions. 224 ******************************************************************************/ 225 void bl2u_early_platform_setup(struct meminfo *mem_layout, 226 void *plat_info); 227 void bl2u_plat_arch_setup(void); 228 void bl2u_platform_setup(void); 229 230 /******************************************************************************* 231 * Conditionally mandatory BL2U functions for CSS platforms. 232 ******************************************************************************/ 233 /* 234 * This function is used to perform any platform-specific actions required to 235 * handle the BL2U_SCP firmware. 236 */ 237 int bl2u_plat_handle_scp_bl2u(void); 238 239 /******************************************************************************* 240 * Mandatory BL31 functions 241 ******************************************************************************/ 242 #if LOAD_IMAGE_V2 243 void bl31_early_platform_setup(void *from_bl2, 244 void *plat_params_from_bl2); 245 #else 246 void bl31_early_platform_setup(struct bl31_params *from_bl2, 247 void *plat_params_from_bl2); 248 #endif 249 void bl31_plat_arch_setup(void); 250 void bl31_platform_setup(void); 251 void bl31_plat_runtime_setup(void); 252 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 253 254 /******************************************************************************* 255 * Mandatory PSCI functions (BL31) 256 ******************************************************************************/ 257 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 258 const struct plat_psci_ops **); 259 const unsigned char *plat_get_power_domain_tree_desc(void); 260 261 /******************************************************************************* 262 * Optional PSCI functions (BL31). 263 ******************************************************************************/ 264 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 265 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 266 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 267 const psci_power_state_t *state_info, 268 int last_cpu_index); 269 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 270 const plat_local_state_t *states, 271 unsigned int ncpu); 272 273 /******************************************************************************* 274 * Optional BL31 functions (may be overridden) 275 ******************************************************************************/ 276 void bl31_plat_enable_mmu(uint32_t flags); 277 278 /******************************************************************************* 279 * Optional BL32 functions (may be overridden) 280 ******************************************************************************/ 281 void bl32_plat_enable_mmu(uint32_t flags); 282 283 /******************************************************************************* 284 * Trusted Board Boot functions 285 ******************************************************************************/ 286 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 287 unsigned int *flags); 288 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 289 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 290 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 291 unsigned int nv_ctr); 292 293 #if LOAD_IMAGE_V2 294 /******************************************************************************* 295 * Mandatory BL image load functions(may be overridden). 296 ******************************************************************************/ 297 /* 298 * This function returns pointer to the list of images that the 299 * platform has populated to load. 300 */ 301 struct bl_load_info *plat_get_bl_image_load_info(void); 302 303 /* 304 * This function returns a pointer to the shared memory that the 305 * platform has kept aside to pass trusted firmware related 306 * information that next BL image could need. 307 */ 308 struct bl_params *plat_get_next_bl_params(void); 309 310 /* 311 * This function flushes to main memory all the params that are 312 * passed to next image. 313 */ 314 void plat_flush_next_bl_params(void); 315 316 #endif /* LOAD_IMAGE_V2 */ 317 318 #if ENABLE_PLAT_COMPAT 319 /* 320 * The below declarations are to enable compatibility for the platform ports 321 * using the old platform interface. 322 */ 323 324 /******************************************************************************* 325 * Optional common functions (may be overridden) 326 ******************************************************************************/ 327 unsigned int platform_get_core_pos(unsigned long mpidr); 328 329 /******************************************************************************* 330 * Mandatory PSCI Compatibility functions (BL31) 331 ******************************************************************************/ 332 int platform_setup_pm(const plat_pm_ops_t **); 333 334 unsigned int plat_get_aff_count(unsigned int, unsigned long); 335 unsigned int plat_get_aff_state(unsigned int, unsigned long); 336 #else /* __ENABLE_PLAT_COMPAT__ */ 337 /* 338 * The below function enable Trusted Firmware components like SPDs which 339 * haven't migrated to the new platform API to compile on platforms which 340 * have the compatibility layer disabled. 341 */ 342 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 343 344 #endif /* __ENABLE_PLAT_COMPAT__ */ 345 346 #endif /* __PLATFORM_H__ */ 347 348