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 __BL_COMMON_H__ 32 #define __BL_COMMON_H__ 33 34 #define SECURE 0x0 35 #define NON_SECURE 0x1 36 #define PARAM_EP_SECURITY_MASK 0x1 37 38 #define UP 1 39 #define DOWN 0 40 41 /******************************************************************************* 42 * Constants for loading images. When BLx wants to load BLy, it looks at a 43 * meminfo structure to find the extents of free memory. Then depending upon 44 * how it has been configured, it can either load BLy at the top or bottom of 45 * the free memory. These constants indicate the choice. 46 * TODO: Make this configurable while building the trusted firmware. 47 ******************************************************************************/ 48 #define TOP_LOAD 0x1 49 #define BOT_LOAD !TOP_LOAD 50 #define LOAD_MASK (1 << 0) 51 52 /****************************************************************************** 53 * Opcode passed in x0 to tell next EL that we want to run an image. 54 * Corresponds to the function ID of the only SMC that the BL1 exception 55 * handlers service. That's why the chosen value is the first function ID of 56 * the ARM SMC64 range. 57 *****************************************************************************/ 58 #define RUN_IMAGE 0xC0000000 59 60 /******************************************************************************* 61 * Constants that allow assembler code to access members of and the 62 * 'entry_point_info' structure at their correct offsets. 63 ******************************************************************************/ 64 #define ENTRY_POINT_INFO_PC_OFFSET 0x08 65 #define ENTRY_POINT_INFO_ARGS_OFFSET 0x18 66 67 #define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK) 68 #define SET_SECURITY_STATE(x, security) \ 69 ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security)) 70 71 #define PARAM_EP 0x01 72 #define PARAM_IMAGE_BINARY 0x02 73 #define PARAM_BL31 0x03 74 75 #define VERSION_1 0x01 76 77 #define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \ 78 (_p)->h.type = (uint8_t)(_type); \ 79 (_p)->h.version = (uint8_t)(_ver); \ 80 (_p)->h.size = (uint16_t)sizeof(*_p); \ 81 (_p)->h.attr = (uint32_t)(_attr) ; \ 82 } while (0) 83 84 #ifndef __ASSEMBLY__ 85 #include <cdefs.h> /* For __dead2 */ 86 #include <cassert.h> 87 #include <stdint.h> 88 89 /******************************************************************************* 90 * Structure used for telling the next BL how much of a particular type of 91 * memory is available for its use and how much is already used. 92 ******************************************************************************/ 93 typedef struct meminfo { 94 unsigned long total_base; 95 long total_size; 96 unsigned long free_base; 97 long free_size; 98 unsigned long attr; 99 unsigned long next; 100 } meminfo_t; 101 102 typedef struct aapcs64_params { 103 unsigned long arg0; 104 unsigned long arg1; 105 unsigned long arg2; 106 unsigned long arg3; 107 unsigned long arg4; 108 unsigned long arg5; 109 unsigned long arg6; 110 unsigned long arg7; 111 } aapcs64_params_t; 112 113 /*************************************************************************** 114 * This structure provides version information and the size of the 115 * structure, attributes for the structure it represents 116 ***************************************************************************/ 117 typedef struct param_header { 118 uint8_t type; /* type of the structure */ 119 uint8_t version; /* version of this structure */ 120 uint16_t size; /* size of this structure in bytes */ 121 uint32_t attr; /* attributes: unused bits SBZ */ 122 } param_header_t; 123 124 /***************************************************************************** 125 * This structure represents the superset of information needed while 126 * switching exception levels. The only two mechanisms to do so are 127 * ERET & SMC. Security state is indicated using bit zero of header 128 * attribute 129 * NOTE: BL1 expects entrypoint followed by spsr while processing 130 * SMC to jump to BL31 from the start of entry_point_info 131 *****************************************************************************/ 132 typedef struct entry_point_info { 133 param_header_t h; 134 uintptr_t pc; 135 uint32_t spsr; 136 aapcs64_params_t args; 137 } entry_point_info_t; 138 139 /***************************************************************************** 140 * Image info binary provides information from the image loader that 141 * can be used by the firmware to manage available trusted RAM. 142 * More advanced firmware image formats can provide additional 143 * information that enables optimization or greater flexibility in the 144 * common firmware code 145 *****************************************************************************/ 146 typedef struct image_info { 147 param_header_t h; 148 uintptr_t image_base; /* physical address of base of image */ 149 uint32_t image_size; /* bytes read from image file */ 150 } image_info_t; 151 152 /******************************************************************************* 153 * This structure represents the superset of information that can be passed to 154 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 155 * populated only if BL2 detects its presence. A pointer to a structure of this 156 * type should be passed in X3 to BL31's cold boot entrypoint 157 * 158 * Use of this structure and the X3 parameter is not mandatory: the BL3-1 159 * platform code can use other mechanisms to provide the necessary information 160 * about BL3-2 and BL3-3 to the common and SPD code. 161 * 162 * BL3-1 image information is mandatory if this structure is used. If either of 163 * the optional BL3-2 and BL3-3 image information is not provided, this is 164 * indicated by the respective image_info pointers being zero. 165 ******************************************************************************/ 166 typedef struct bl31_params { 167 param_header_t h; 168 image_info_t *bl31_image_info; 169 entry_point_info_t *bl32_ep_info; 170 image_info_t *bl32_image_info; 171 entry_point_info_t *bl33_ep_info; 172 image_info_t *bl33_image_info; 173 } bl31_params_t; 174 175 176 /* 177 * Compile time assertions related to the 'entry_point_info' structure to 178 * ensure that the assembler and the compiler view of the offsets of 179 * the structure members is the same. 180 */ 181 CASSERT(ENTRY_POINT_INFO_PC_OFFSET == 182 __builtin_offsetof(entry_point_info_t, pc), \ 183 assert_BL31_pc_offset_mismatch); 184 185 CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \ 186 __builtin_offsetof(entry_point_info_t, args), \ 187 assert_BL31_args_offset_mismatch); 188 189 CASSERT(sizeof(unsigned long) == 190 __builtin_offsetof(entry_point_info_t, spsr) - \ 191 __builtin_offsetof(entry_point_info_t, pc), \ 192 assert_entrypoint_and_spsr_should_be_adjacent); 193 194 /******************************************************************************* 195 * Function & variable prototypes 196 ******************************************************************************/ 197 unsigned long page_align(unsigned long, unsigned); 198 void change_security_state(unsigned int); 199 void init_bl2_mem_layout(meminfo_t *, 200 meminfo_t *, 201 unsigned int, 202 unsigned long) __attribute__((weak)); 203 void init_bl31_mem_layout(const meminfo_t *, 204 meminfo_t *, 205 unsigned int) __attribute__((weak)); 206 unsigned long image_size(const char *); 207 int load_image(meminfo_t *, 208 const char *, 209 unsigned int, 210 unsigned long, 211 image_info_t *, 212 entry_point_info_t *); 213 unsigned long *get_el_change_mem_ptr(void); 214 extern const char build_message[]; 215 216 #endif /*__ASSEMBLY__*/ 217 218 #endif /* __BL_COMMON_H__ */ 219