1 /* 2 * Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef __PLATFORM_H__ 32 #define __PLATFORM_H__ 33 34 #include <psci.h> 35 #include <stdint.h> 36 #include <types.h> 37 38 39 /******************************************************************************* 40 * Forward declarations 41 ******************************************************************************/ 42 struct meminfo; 43 struct image_info; 44 struct entry_point_info; 45 struct bl31_params; 46 struct image_desc; 47 struct bl_load_info; 48 struct bl_params; 49 50 /******************************************************************************* 51 * plat_get_rotpk_info() flags 52 ******************************************************************************/ 53 #define ROTPK_IS_HASH (1 << 0) 54 /* Flag used to skip verification of the certificate ROTPK while the platform 55 ROTPK is not deployed */ 56 #define ROTPK_NOT_DEPLOYED (1 << 1) 57 58 /******************************************************************************* 59 * Function declarations 60 ******************************************************************************/ 61 /******************************************************************************* 62 * Mandatory common functions 63 ******************************************************************************/ 64 unsigned long long plat_get_syscnt_freq(void) __deprecated; 65 unsigned int plat_get_syscnt_freq2(void); 66 67 int plat_get_image_source(unsigned int image_id, 68 uintptr_t *dev_handle, 69 uintptr_t *image_spec); 70 uintptr_t plat_get_ns_image_entrypoint(void); 71 unsigned int plat_my_core_pos(void); 72 int plat_core_pos_by_mpidr(u_register_t mpidr); 73 74 /******************************************************************************* 75 * Mandatory interrupt management functions 76 ******************************************************************************/ 77 uint32_t plat_ic_get_pending_interrupt_id(void); 78 uint32_t plat_ic_get_pending_interrupt_type(void); 79 uint32_t plat_ic_acknowledge_interrupt(void); 80 uint32_t plat_ic_get_interrupt_type(uint32_t id); 81 void plat_ic_end_of_interrupt(uint32_t id); 82 uint32_t plat_interrupt_type_to_line(uint32_t type, 83 uint32_t security_state); 84 85 /******************************************************************************* 86 * Optional common functions (may be overridden) 87 ******************************************************************************/ 88 uintptr_t plat_get_my_stack(void); 89 void plat_report_exception(unsigned int exception_type); 90 int plat_crash_console_init(void); 91 int plat_crash_console_putc(int c); 92 void plat_error_handler(int err) __dead2; 93 void plat_panic_handler(void) __dead2; 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 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 257 const plat_local_state_t *states, 258 unsigned int ncpu); 259 260 /******************************************************************************* 261 * Optional BL31 functions (may be overridden) 262 ******************************************************************************/ 263 void bl31_plat_enable_mmu(uint32_t flags); 264 265 /******************************************************************************* 266 * Optional BL32 functions (may be overridden) 267 ******************************************************************************/ 268 void bl32_plat_enable_mmu(uint32_t flags); 269 270 /******************************************************************************* 271 * Trusted Board Boot functions 272 ******************************************************************************/ 273 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 274 unsigned int *flags); 275 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 276 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 277 278 #if LOAD_IMAGE_V2 279 /******************************************************************************* 280 * Mandatory BL image load functions(may be overridden). 281 ******************************************************************************/ 282 /* 283 * This function returns pointer to the list of images that the 284 * platform has populated to load. 285 */ 286 struct bl_load_info *plat_get_bl_image_load_info(void); 287 288 /* 289 * This function returns a pointer to the shared memory that the 290 * platform has kept aside to pass trusted firmware related 291 * information that next BL image could need. 292 */ 293 struct bl_params *plat_get_next_bl_params(void); 294 295 /* 296 * This function flushes to main memory all the params that are 297 * passed to next image. 298 */ 299 void plat_flush_next_bl_params(void); 300 301 #endif /* LOAD_IMAGE_V2 */ 302 303 #if ENABLE_PLAT_COMPAT 304 /* 305 * The below declarations are to enable compatibility for the platform ports 306 * using the old platform interface. 307 */ 308 309 /******************************************************************************* 310 * Optional common functions (may be overridden) 311 ******************************************************************************/ 312 unsigned int platform_get_core_pos(unsigned long mpidr); 313 314 /******************************************************************************* 315 * Mandatory PSCI Compatibility functions (BL31) 316 ******************************************************************************/ 317 int platform_setup_pm(const plat_pm_ops_t **); 318 319 unsigned int plat_get_aff_count(unsigned int, unsigned long); 320 unsigned int plat_get_aff_state(unsigned int, unsigned long); 321 #else 322 /* 323 * The below function enable Trusted Firmware components like SPDs which 324 * haven't migrated to the new platform API to compile on platforms which 325 * have the compatibility layer disabled. 326 */ 327 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 328 329 #endif /* __ENABLE_PLAT_COMPAT__ */ 330 #endif /* __PLATFORM_H__ */ 331