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