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 * plat_get_rotpk_info() flags 48 ******************************************************************************/ 49 #define ROTPK_IS_HASH (1 << 0) 50 51 /******************************************************************************* 52 * Function declarations 53 ******************************************************************************/ 54 /******************************************************************************* 55 * Mandatory common functions 56 ******************************************************************************/ 57 uint64_t plat_get_syscnt_freq(void); 58 int plat_get_image_source(unsigned int image_id, 59 uintptr_t *dev_handle, 60 uintptr_t *image_spec); 61 unsigned long plat_get_ns_image_entrypoint(void); 62 63 /******************************************************************************* 64 * Mandatory interrupt management functions 65 ******************************************************************************/ 66 uint32_t plat_ic_get_pending_interrupt_id(void); 67 uint32_t plat_ic_get_pending_interrupt_type(void); 68 uint32_t plat_ic_acknowledge_interrupt(void); 69 uint32_t plat_ic_get_interrupt_type(uint32_t id); 70 void plat_ic_end_of_interrupt(uint32_t id); 71 uint32_t plat_interrupt_type_to_line(uint32_t type, 72 uint32_t security_state); 73 74 /******************************************************************************* 75 * Optional common functions (may be overridden) 76 ******************************************************************************/ 77 unsigned int platform_get_core_pos(unsigned long mpidr); 78 unsigned long platform_get_stack(unsigned long mpidr); 79 void plat_report_exception(unsigned long); 80 int plat_crash_console_init(void); 81 int plat_crash_console_putc(int c); 82 83 /******************************************************************************* 84 * Mandatory BL1 functions 85 ******************************************************************************/ 86 void bl1_early_platform_setup(void); 87 void bl1_plat_arch_setup(void); 88 void bl1_platform_setup(void); 89 struct meminfo *bl1_plat_sec_mem_layout(void); 90 91 /* 92 * This function allows the platform to change the entrypoint information for 93 * BL2, after BL1 has loaded BL2 into memory but before BL2 is executed. 94 */ 95 void bl1_plat_set_bl2_ep_info(struct image_info *image, 96 struct entry_point_info *ep); 97 98 /******************************************************************************* 99 * Optional BL1 functions (may be overridden) 100 ******************************************************************************/ 101 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 102 struct meminfo *bl2_mem_layout); 103 104 /******************************************************************************* 105 * Mandatory BL2 functions 106 ******************************************************************************/ 107 void bl2_early_platform_setup(struct meminfo *mem_layout); 108 void bl2_plat_arch_setup(void); 109 void bl2_platform_setup(void); 110 struct meminfo *bl2_plat_sec_mem_layout(void); 111 112 /* 113 * This function returns a pointer to the shared memory that the platform has 114 * kept aside to pass trusted firmware related information that BL3-1 115 * could need 116 */ 117 struct bl31_params *bl2_plat_get_bl31_params(void); 118 119 /* 120 * This function returns a pointer to the shared memory that the platform 121 * has kept to point to entry point information of BL31 to BL2 122 */ 123 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 124 125 /* 126 * This function flushes to main memory all the params that are 127 * passed to BL3-1 128 */ 129 void bl2_plat_flush_bl31_params(void); 130 131 /* 132 * The next 2 functions allow the platform to change the entrypoint information 133 * for the mandatory 3rd level BL images, BL3-1 and BL3-3. This is done after 134 * BL2 has loaded those images into memory but before BL3-1 is executed. 135 */ 136 void bl2_plat_set_bl31_ep_info(struct image_info *image, 137 struct entry_point_info *ep); 138 139 void bl2_plat_set_bl33_ep_info(struct image_info *image, 140 struct entry_point_info *ep); 141 142 /* Gets the memory layout for BL3-3 */ 143 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 144 145 /******************************************************************************* 146 * Conditionally mandatory BL2 functions: must be implemented if BL3-0 image 147 * is supported 148 ******************************************************************************/ 149 /* Gets the memory layout for BL3-0 */ 150 void bl2_plat_get_bl30_meminfo(struct meminfo *mem_info); 151 152 /* 153 * This function is called after loading BL3-0 image and it is used to perform 154 * any platform-specific actions required to handle the SCP firmware. 155 */ 156 int bl2_plat_handle_bl30(struct image_info *bl30_image_info); 157 158 /******************************************************************************* 159 * Conditionally mandatory BL2 functions: must be implemented if BL3-2 image 160 * is supported 161 ******************************************************************************/ 162 void bl2_plat_set_bl32_ep_info(struct image_info *image, 163 struct entry_point_info *ep); 164 165 /* Gets the memory layout for BL3-2 */ 166 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 167 168 /******************************************************************************* 169 * Optional BL2 functions (may be overridden) 170 ******************************************************************************/ 171 172 /******************************************************************************* 173 * Mandatory BL3-1 functions 174 ******************************************************************************/ 175 void bl31_early_platform_setup(struct bl31_params *from_bl2, 176 void *plat_params_from_bl2); 177 void bl31_plat_arch_setup(void); 178 void bl31_platform_setup(void); 179 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 180 181 /******************************************************************************* 182 * Mandatory PSCI functions (BL3-1) 183 ******************************************************************************/ 184 int platform_setup_pm(const struct plat_pm_ops **); 185 unsigned int plat_get_aff_count(unsigned int, unsigned long); 186 unsigned int plat_get_aff_state(unsigned int, unsigned long); 187 188 /******************************************************************************* 189 * Optional BL3-1 functions (may be overridden) 190 ******************************************************************************/ 191 void bl31_plat_enable_mmu(uint32_t flags); 192 193 /******************************************************************************* 194 * Optional BL3-2 functions (may be overridden) 195 ******************************************************************************/ 196 void bl32_plat_enable_mmu(uint32_t flags); 197 198 /******************************************************************************* 199 * Trusted Board Boot functions 200 ******************************************************************************/ 201 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 202 unsigned int *flags); 203 204 #endif /* __PLATFORM_H__ */ 205