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