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 plat_ic_get_pending_interrupt_id(void); 62 uint32_t plat_ic_get_pending_interrupt_type(void); 63 uint32_t plat_ic_acknowledge_interrupt(void); 64 uint32_t plat_ic_get_interrupt_type(uint32_t id); 65 void plat_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 * This function allows the platform to change the entrypoint information for 85 * BL2, after BL1 has loaded BL2 into memory but before BL2 is executed. 86 */ 87 void bl1_plat_set_bl2_ep_info(struct image_info *image, 88 struct entry_point_info *ep); 89 90 /******************************************************************************* 91 * Optional BL1 functions (may be overridden) 92 ******************************************************************************/ 93 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 94 struct meminfo *bl2_mem_layout); 95 96 /******************************************************************************* 97 * Mandatory BL2 functions 98 ******************************************************************************/ 99 void bl2_plat_arch_setup(void); 100 void bl2_platform_setup(void); 101 struct meminfo *bl2_plat_sec_mem_layout(void); 102 103 /* 104 * This function returns a pointer to the shared memory that the platform has 105 * kept aside to pass trusted firmware related information that BL3-1 106 * could need 107 */ 108 struct bl31_params *bl2_plat_get_bl31_params(void); 109 110 /* 111 * This function returns a pointer to the shared memory that the platform 112 * has kept to point to entry point information of BL31 to BL2 113 */ 114 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 115 116 /* 117 * This function flushes to main memory all the params that are 118 * passed to BL3-1 119 */ 120 void bl2_plat_flush_bl31_params(void); 121 122 /* 123 * The next 2 functions allow the platform to change the entrypoint information 124 * for the mandatory 3rd level BL images, BL3-1 and BL3-3. This is done after 125 * BL2 has loaded those images into memory but before BL3-1 is executed. 126 */ 127 void bl2_plat_set_bl31_ep_info(struct image_info *image, 128 struct entry_point_info *ep); 129 130 void bl2_plat_set_bl33_ep_info(struct image_info *image, 131 struct entry_point_info *ep); 132 133 /* Gets the memory layout for BL3-3 */ 134 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 135 136 /******************************************************************************* 137 * Conditionally mandatory BL2 functions: must be implemented if BL3-0 image 138 * is supported 139 ******************************************************************************/ 140 /* Gets the memory layout for BL3-0 */ 141 void bl2_plat_get_bl30_meminfo(struct meminfo *mem_info); 142 143 /* 144 * This function is called after loading BL3-0 image and it is used to perform 145 * any platform-specific actions required to handle the SCP firmware. 146 */ 147 int bl2_plat_handle_bl30(struct image_info *bl30_image_info); 148 149 /******************************************************************************* 150 * Conditionally mandatory BL2 functions: must be implemented if BL3-2 image 151 * is supported 152 ******************************************************************************/ 153 void bl2_plat_set_bl32_ep_info(struct image_info *image, 154 struct entry_point_info *ep); 155 156 /* Gets the memory layout for BL3-2 */ 157 void bl2_plat_get_bl32_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_plat_get_next_image_ep_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(uint32_t flags); 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(uint32_t flags); 194 195 #endif /* __PLATFORM_H__ */ 196