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