1 /* 2 * Copyright (c) 2013-2014, 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 <stdint.h> 35 36 37 /******************************************************************************* 38 * Forward declarations 39 ******************************************************************************/ 40 struct plat_pm_ops; 41 struct meminfo; 42 struct image_info; 43 struct entry_point_info; 44 struct bl31_params; 45 46 /******************************************************************************* 47 * Function declarations 48 ******************************************************************************/ 49 /******************************************************************************* 50 * Mandatory common functions 51 ******************************************************************************/ 52 uint64_t plat_get_syscnt_freq(void); 53 int plat_get_image_source(const char *image_name, 54 uintptr_t *dev_handle, 55 uintptr_t *image_spec); 56 unsigned long plat_get_ns_image_entrypoint(void); 57 58 /******************************************************************************* 59 * Mandatory interrupt management functions 60 ******************************************************************************/ 61 uint32_t ic_get_pending_interrupt_id(void); 62 uint32_t ic_get_pending_interrupt_type(void); 63 uint32_t ic_acknowledge_interrupt(void); 64 uint32_t ic_get_interrupt_type(uint32_t id); 65 void ic_end_of_interrupt(uint32_t id); 66 uint32_t plat_interrupt_type_to_line(uint32_t type, 67 uint32_t security_state); 68 69 /******************************************************************************* 70 * Optional common functions (may be overridden) 71 ******************************************************************************/ 72 unsigned int platform_get_core_pos(unsigned long mpidr); 73 unsigned long platform_get_stack(unsigned long mpidr); 74 void plat_report_exception(unsigned long); 75 76 /******************************************************************************* 77 * Mandatory BL1 functions 78 ******************************************************************************/ 79 void bl1_plat_arch_setup(void); 80 void bl1_platform_setup(void); 81 struct meminfo *bl1_plat_sec_mem_layout(void); 82 83 /* 84 * Before calling this function BL2 is loaded in memory and its entrypoint 85 * is set by load_image. This is a placeholder for the platform to change 86 * the entrypoint of BL2 and set SPSR and security state. 87 * On FVP we are only setting the security state, entrypoint 88 */ 89 void bl1_plat_set_bl2_ep_info(struct image_info *image, 90 struct entry_point_info *ep); 91 92 /******************************************************************************* 93 * Optional BL1 functions (may be overridden) 94 ******************************************************************************/ 95 void init_bl2_mem_layout(struct meminfo *, 96 struct meminfo *, 97 unsigned int, 98 unsigned long); 99 100 /******************************************************************************* 101 * Mandatory BL2 functions 102 ******************************************************************************/ 103 void bl2_plat_arch_setup(void); 104 void bl2_platform_setup(void); 105 struct meminfo *bl2_plat_sec_mem_layout(void); 106 107 /* 108 * This function returns a pointer to the shared memory that the platform has 109 * kept aside to pass trusted firmware related information that BL3-1 110 * could need 111 */ 112 struct bl31_params *bl2_plat_get_bl31_params(void); 113 114 /* 115 * This function returns a pointer to the shared memory that the platform 116 * has kept to point to entry point information of BL31 to BL2 117 */ 118 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 119 120 /* 121 * This function flushes to main memory all the params that are 122 * passed to BL3-1 123 */ 124 void bl2_plat_flush_bl31_params(void); 125 126 /* 127 * Before calling this function BL31 is loaded in memory and its entrypoint 128 * is set by load_image. This is a placeholder for the platform to change 129 * the entrypoint of BL31 and set SPSR and security state. 130 * On FVP we are only setting the security state, entrypoint 131 */ 132 void bl2_plat_set_bl31_ep_info(struct image_info *image, 133 struct entry_point_info *ep); 134 135 /* 136 * Before calling this function BL32 is loaded in memory and its entrypoint 137 * is set by load_image. This is a placeholder for the platform to change 138 * the entrypoint of BL32 and set SPSR and security state. 139 * On FVP we are only setting the security state, entrypoint 140 */ 141 void bl2_plat_set_bl32_ep_info(struct image_info *image, 142 struct entry_point_info *ep); 143 144 /* 145 * Before calling this function BL33 is loaded in memory and its entrypoint 146 * is set by load_image. This is a placeholder for the platform to change 147 * the entrypoint of BL33 and set SPSR and security state. 148 * On FVP we are only setting the security state, entrypoint 149 */ 150 void bl2_plat_set_bl33_ep_info(struct image_info *image, 151 struct entry_point_info *ep); 152 153 /* Gets the memory layout for BL32 */ 154 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 155 156 /* Gets the memory layout for BL33 */ 157 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 158 159 /******************************************************************************* 160 * Optional BL2 functions (may be overridden) 161 ******************************************************************************/ 162 163 /******************************************************************************* 164 * Mandatory BL3-1 functions 165 ******************************************************************************/ 166 void bl31_early_platform_setup(struct bl31_params *from_bl2, 167 void *plat_params_from_bl2); 168 void bl31_plat_arch_setup(void); 169 void bl31_platform_setup(void); 170 struct entry_point_info *bl31_get_next_image_info(uint32_t type); 171 172 /******************************************************************************* 173 * Mandatory PSCI functions (BL3-1) 174 ******************************************************************************/ 175 int platform_setup_pm(const struct plat_pm_ops **); 176 int plat_get_max_afflvl(void); 177 unsigned int plat_get_aff_count(unsigned int, unsigned long); 178 unsigned int plat_get_aff_state(unsigned int, unsigned long); 179 180 /******************************************************************************* 181 * Optional BL3-1 functions (may be overridden) 182 ******************************************************************************/ 183 void bl31_plat_enable_mmu(); 184 185 /******************************************************************************* 186 * Mandatory BL3-2 functions (only if platform contains a BL3-2) 187 ******************************************************************************/ 188 void bl32_platform_setup(void); 189 190 /******************************************************************************* 191 * Optional BL3-2 functions (may be overridden) 192 ******************************************************************************/ 193 void bl32_plat_enable_mmu(); 194 195 #endif /* __PLATFORM_H__ */ 196