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 48 /******************************************************************************* 49 * plat_get_rotpk_info() flags 50 ******************************************************************************/ 51 #define ROTPK_IS_HASH (1 << 0) 52 /* Flag used to skip verification of the certificate ROTPK while the platform 53 ROTPK is not deployed */ 54 #define ROTPK_NOT_DEPLOYED (1 << 1) 55 56 /******************************************************************************* 57 * Function declarations 58 ******************************************************************************/ 59 /******************************************************************************* 60 * Mandatory common functions 61 ******************************************************************************/ 62 unsigned long long plat_get_syscnt_freq(void) __deprecated; 63 unsigned int plat_get_syscnt_freq2(void); 64 65 int plat_get_image_source(unsigned int image_id, 66 uintptr_t *dev_handle, 67 uintptr_t *image_spec); 68 uintptr_t plat_get_ns_image_entrypoint(void); 69 unsigned int plat_my_core_pos(void); 70 int plat_core_pos_by_mpidr(u_register_t mpidr); 71 72 /******************************************************************************* 73 * Mandatory interrupt management functions 74 ******************************************************************************/ 75 uint32_t plat_ic_get_pending_interrupt_id(void); 76 uint32_t plat_ic_get_pending_interrupt_type(void); 77 uint32_t plat_ic_acknowledge_interrupt(void); 78 uint32_t plat_ic_get_interrupt_type(uint32_t id); 79 void plat_ic_end_of_interrupt(uint32_t id); 80 uint32_t plat_interrupt_type_to_line(uint32_t type, 81 uint32_t security_state); 82 83 /******************************************************************************* 84 * Optional common functions (may be overridden) 85 ******************************************************************************/ 86 uintptr_t plat_get_my_stack(void); 87 void plat_report_exception(unsigned long); 88 int plat_crash_console_init(void); 89 int plat_crash_console_putc(int c); 90 void plat_error_handler(int err) __dead2; 91 void plat_panic_handler(void) __dead2; 92 93 /******************************************************************************* 94 * Mandatory BL1 functions 95 ******************************************************************************/ 96 void bl1_early_platform_setup(void); 97 void bl1_plat_arch_setup(void); 98 void bl1_platform_setup(void); 99 struct meminfo *bl1_plat_sec_mem_layout(void); 100 101 /* 102 * The following function is mandatory when the 103 * firmware update feature is used. 104 */ 105 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 106 unsigned int flags); 107 108 /******************************************************************************* 109 * Optional BL1 functions (may be overridden) 110 ******************************************************************************/ 111 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 112 struct meminfo *bl2_mem_layout); 113 114 /* 115 * The following functions are used for image loading process in BL1. 116 */ 117 void bl1_plat_set_ep_info(unsigned int image_id, 118 struct entry_point_info *ep_info); 119 /* 120 * The following functions are mandatory when firmware update 121 * feature is used and optional otherwise. 122 */ 123 unsigned int bl1_plat_get_next_image_id(void); 124 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 125 126 /* 127 * The following functions are used by firmware update 128 * feature and may optionally be overridden. 129 */ 130 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 131 132 133 /******************************************************************************* 134 * Mandatory BL2 functions 135 ******************************************************************************/ 136 void bl2_early_platform_setup(struct meminfo *mem_layout); 137 void bl2_plat_arch_setup(void); 138 void bl2_platform_setup(void); 139 struct meminfo *bl2_plat_sec_mem_layout(void); 140 141 /* 142 * This function returns a pointer to the shared memory that the platform has 143 * kept aside to pass trusted firmware related information that BL31 144 * could need 145 */ 146 struct bl31_params *bl2_plat_get_bl31_params(void); 147 148 /* 149 * This function returns a pointer to the shared memory that the platform 150 * has kept to point to entry point information of BL31 to BL2 151 */ 152 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 153 154 /* 155 * This function flushes to main memory all the params that are 156 * passed to BL31 157 */ 158 void bl2_plat_flush_bl31_params(void); 159 160 /* 161 * The next 2 functions allow the platform to change the entrypoint information 162 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 163 * BL2 has loaded those images into memory but before BL31 is executed. 164 */ 165 void bl2_plat_set_bl31_ep_info(struct image_info *image, 166 struct entry_point_info *ep); 167 168 void bl2_plat_set_bl33_ep_info(struct image_info *image, 169 struct entry_point_info *ep); 170 171 /* Gets the memory layout for BL33 */ 172 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 173 174 /******************************************************************************* 175 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 176 * is supported 177 ******************************************************************************/ 178 /* Gets the memory layout for SCP_BL2 */ 179 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 180 181 /* 182 * This function is called after loading SCP_BL2 image and it is used to perform 183 * any platform-specific actions required to handle the SCP firmware. 184 */ 185 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 186 187 /******************************************************************************* 188 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 189 * is supported 190 ******************************************************************************/ 191 void bl2_plat_set_bl32_ep_info(struct image_info *image, 192 struct entry_point_info *ep); 193 194 /* Gets the memory layout for BL32 */ 195 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 196 197 /******************************************************************************* 198 * Optional BL2 functions (may be overridden) 199 ******************************************************************************/ 200 201 /******************************************************************************* 202 * Mandatory BL2U functions. 203 ******************************************************************************/ 204 void bl2u_early_platform_setup(struct meminfo *mem_layout, 205 void *plat_info); 206 void bl2u_plat_arch_setup(void); 207 void bl2u_platform_setup(void); 208 209 /******************************************************************************* 210 * Conditionally mandatory BL2U functions for CSS platforms. 211 ******************************************************************************/ 212 /* 213 * This function is used to perform any platform-specific actions required to 214 * handle the BL2U_SCP firmware. 215 */ 216 int bl2u_plat_handle_scp_bl2u(void); 217 218 /******************************************************************************* 219 * Mandatory BL31 functions 220 ******************************************************************************/ 221 void bl31_early_platform_setup(struct bl31_params *from_bl2, 222 void *plat_params_from_bl2); 223 void bl31_plat_arch_setup(void); 224 void bl31_platform_setup(void); 225 void bl31_plat_runtime_setup(void); 226 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 227 228 /******************************************************************************* 229 * Mandatory PSCI functions (BL31) 230 ******************************************************************************/ 231 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 232 const struct plat_psci_ops **); 233 const unsigned char *plat_get_power_domain_tree_desc(void); 234 235 /******************************************************************************* 236 * Optional PSCI functions (BL31). 237 ******************************************************************************/ 238 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 239 const plat_local_state_t *states, 240 unsigned int ncpu); 241 242 /******************************************************************************* 243 * Optional BL31 functions (may be overridden) 244 ******************************************************************************/ 245 void bl31_plat_enable_mmu(uint32_t flags); 246 247 /******************************************************************************* 248 * Optional BL32 functions (may be overridden) 249 ******************************************************************************/ 250 void bl32_plat_enable_mmu(uint32_t flags); 251 252 /******************************************************************************* 253 * Trusted Board Boot functions 254 ******************************************************************************/ 255 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 256 unsigned int *flags); 257 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 258 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 259 260 #if ENABLE_PLAT_COMPAT 261 /* 262 * The below declarations are to enable compatibility for the platform ports 263 * using the old platform interface. 264 */ 265 266 /******************************************************************************* 267 * Optional common functions (may be overridden) 268 ******************************************************************************/ 269 unsigned int platform_get_core_pos(unsigned long mpidr); 270 271 /******************************************************************************* 272 * Mandatory PSCI Compatibility functions (BL31) 273 ******************************************************************************/ 274 int platform_setup_pm(const plat_pm_ops_t **); 275 276 unsigned int plat_get_aff_count(unsigned int, unsigned long); 277 unsigned int plat_get_aff_state(unsigned int, unsigned long); 278 #else 279 /* 280 * The below function enable Trusted Firmware components like SPDs which 281 * haven't migrated to the new platform API to compile on platforms which 282 * have the compatibility layer disabled. 283 */ 284 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 285 286 #endif /* __ENABLE_PLAT_COMPAT__ */ 287 #endif /* __PLATFORM_H__ */ 288