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