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