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