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