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