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