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