Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 1 | /* |
Dan Handley | e83b0ca | 2014-01-14 18:17:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 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 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 34 | #define SECURE 0x0 |
| 35 | #define NON_SECURE 0x1 |
Juan Castillo | f558cac | 2014-06-05 09:45:36 +0100 | [diff] [blame] | 36 | #define sec_state_is_valid(s) (((s) == SECURE) || ((s) == NON_SECURE)) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 37 | |
| 38 | #define UP 1 |
| 39 | #define DOWN 0 |
| 40 | |
| 41 | /******************************************************************************* |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 42 | * Constants to identify the location of a memory region in a given memory |
| 43 | * layout. |
| 44 | ******************************************************************************/ |
| 45 | #define TOP 0x1 |
| 46 | #define BOTTOM !TOP |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 47 | |
Sandrine Bailleux | ba6980a | 2013-12-02 15:41:25 +0000 | [diff] [blame] | 48 | /****************************************************************************** |
| 49 | * Opcode passed in x0 to tell next EL that we want to run an image. |
| 50 | * Corresponds to the function ID of the only SMC that the BL1 exception |
| 51 | * handlers service. That's why the chosen value is the first function ID of |
| 52 | * the ARM SMC64 range. |
| 53 | *****************************************************************************/ |
| 54 | #define RUN_IMAGE 0xC0000000 |
| 55 | |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 56 | /******************************************************************************* |
| 57 | * Constants that allow assembler code to access members of and the |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 58 | * 'entry_point_info' structure at their correct offsets. |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 59 | ******************************************************************************/ |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 60 | #define ENTRY_POINT_INFO_PC_OFFSET 0x08 |
| 61 | #define ENTRY_POINT_INFO_ARGS_OFFSET 0x18 |
Sandrine Bailleux | ba6980a | 2013-12-02 15:41:25 +0000 | [diff] [blame] | 62 | |
Andrew Thoelke | 4e12607 | 2014-06-04 21:10:52 +0100 | [diff] [blame] | 63 | #define PARAM_EP_SECURITY_MASK 0x1 |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 64 | #define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK) |
| 65 | #define SET_SECURITY_STATE(x, security) \ |
| 66 | ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security)) |
| 67 | |
Andrew Thoelke | 4e12607 | 2014-06-04 21:10:52 +0100 | [diff] [blame] | 68 | #define EP_EE_MASK 0x2 |
| 69 | #define EP_EE_LITTLE 0x0 |
| 70 | #define EP_EE_BIG 0x2 |
| 71 | #define EP_GET_EE(x) (x & EP_EE_MASK) |
| 72 | #define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee)) |
| 73 | |
| 74 | #define EP_ST_MASK 0x4 |
| 75 | #define EP_ST_DISABLE 0x0 |
| 76 | #define EP_ST_ENABLE 0x4 |
| 77 | #define EP_GET_ST(x) (x & EP_ST_MASK) |
| 78 | #define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee)) |
| 79 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 80 | #define PARAM_EP 0x01 |
| 81 | #define PARAM_IMAGE_BINARY 0x02 |
| 82 | #define PARAM_BL31 0x03 |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 83 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 84 | #define VERSION_1 0x01 |
| 85 | |
| 86 | #define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \ |
| 87 | (_p)->h.type = (uint8_t)(_type); \ |
| 88 | (_p)->h.version = (uint8_t)(_ver); \ |
| 89 | (_p)->h.size = (uint16_t)sizeof(*_p); \ |
| 90 | (_p)->h.attr = (uint32_t)(_attr) ; \ |
| 91 | } while (0) |
| 92 | |
| 93 | #ifndef __ASSEMBLY__ |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 94 | #include <cdefs.h> /* For __dead2 */ |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 95 | #include <cassert.h> |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 96 | #include <stdint.h> |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 97 | #include <stddef.h> |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 98 | |
Vikram Kanigiri | 725b133 | 2015-03-04 10:34:27 +0000 | [diff] [blame] | 99 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) |
| 100 | |
Dan Handley | f05c1b5 | 2015-04-27 11:49:22 +0100 | [diff] [blame] | 101 | /* |
| 102 | * Declarations of linker defined symbols to help determine memory layout of |
| 103 | * BL images |
| 104 | */ |
| 105 | extern unsigned long __RO_START__; |
| 106 | extern unsigned long __RO_END__; |
| 107 | #if IMAGE_BL2 |
| 108 | extern unsigned long __BL2_END__; |
| 109 | #elif IMAGE_BL31 |
| 110 | extern unsigned long __BL31_END__; |
| 111 | #elif IMAGE_BL32 |
| 112 | extern unsigned long __BL32_END__; |
| 113 | #endif /* IMAGE_BLX */ |
| 114 | |
| 115 | #if USE_COHERENT_MEM |
| 116 | extern unsigned long __COHERENT_RAM_START__; |
| 117 | extern unsigned long __COHERENT_RAM_END__; |
| 118 | #endif |
| 119 | |
| 120 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 121 | /******************************************************************************* |
| 122 | * Structure used for telling the next BL how much of a particular type of |
| 123 | * memory is available for its use and how much is already used. |
| 124 | ******************************************************************************/ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 125 | typedef struct meminfo { |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 126 | uint64_t total_base; |
| 127 | size_t total_size; |
| 128 | uint64_t free_base; |
| 129 | size_t free_size; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 130 | } meminfo_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 131 | |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 132 | typedef struct aapcs64_params { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 133 | unsigned long arg0; |
| 134 | unsigned long arg1; |
| 135 | unsigned long arg2; |
| 136 | unsigned long arg3; |
| 137 | unsigned long arg4; |
| 138 | unsigned long arg5; |
| 139 | unsigned long arg6; |
| 140 | unsigned long arg7; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 141 | } aapcs64_params_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 142 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 143 | /*************************************************************************** |
| 144 | * This structure provides version information and the size of the |
| 145 | * structure, attributes for the structure it represents |
| 146 | ***************************************************************************/ |
| 147 | typedef struct param_header { |
| 148 | uint8_t type; /* type of the structure */ |
| 149 | uint8_t version; /* version of this structure */ |
| 150 | uint16_t size; /* size of this structure in bytes */ |
| 151 | uint32_t attr; /* attributes: unused bits SBZ */ |
| 152 | } param_header_t; |
| 153 | |
| 154 | /***************************************************************************** |
| 155 | * This structure represents the superset of information needed while |
| 156 | * switching exception levels. The only two mechanisms to do so are |
| 157 | * ERET & SMC. Security state is indicated using bit zero of header |
| 158 | * attribute |
| 159 | * NOTE: BL1 expects entrypoint followed by spsr while processing |
| 160 | * SMC to jump to BL31 from the start of entry_point_info |
| 161 | *****************************************************************************/ |
| 162 | typedef struct entry_point_info { |
| 163 | param_header_t h; |
| 164 | uintptr_t pc; |
| 165 | uint32_t spsr; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 166 | aapcs64_params_t args; |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 167 | } entry_point_info_t; |
| 168 | |
| 169 | /***************************************************************************** |
| 170 | * Image info binary provides information from the image loader that |
| 171 | * can be used by the firmware to manage available trusted RAM. |
| 172 | * More advanced firmware image formats can provide additional |
| 173 | * information that enables optimization or greater flexibility in the |
| 174 | * common firmware code |
| 175 | *****************************************************************************/ |
| 176 | typedef struct image_info { |
| 177 | param_header_t h; |
| 178 | uintptr_t image_base; /* physical address of base of image */ |
| 179 | uint32_t image_size; /* bytes read from image file */ |
| 180 | } image_info_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 181 | |
| 182 | /******************************************************************************* |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 183 | * This structure represents the superset of information that can be passed to |
| 184 | * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 185 | * populated only if BL2 detects its presence. A pointer to a structure of this |
Sandrine Bailleux | acde8b0 | 2015-05-19 11:54:45 +0100 | [diff] [blame] | 186 | * type should be passed in X0 to BL3-1's cold boot entrypoint. |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 187 | * |
Sandrine Bailleux | acde8b0 | 2015-05-19 11:54:45 +0100 | [diff] [blame] | 188 | * Use of this structure and the X0 parameter is not mandatory: the BL3-1 |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 189 | * platform code can use other mechanisms to provide the necessary information |
| 190 | * about BL3-2 and BL3-3 to the common and SPD code. |
| 191 | * |
| 192 | * BL3-1 image information is mandatory if this structure is used. If either of |
| 193 | * the optional BL3-2 and BL3-3 image information is not provided, this is |
| 194 | * indicated by the respective image_info pointers being zero. |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 195 | ******************************************************************************/ |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 196 | typedef struct bl31_params { |
| 197 | param_header_t h; |
| 198 | image_info_t *bl31_image_info; |
| 199 | entry_point_info_t *bl32_ep_info; |
| 200 | image_info_t *bl32_image_info; |
| 201 | entry_point_info_t *bl33_ep_info; |
| 202 | image_info_t *bl33_image_info; |
| 203 | } bl31_params_t; |
| 204 | |
| 205 | |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 206 | /* |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 207 | * Compile time assertions related to the 'entry_point_info' structure to |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 208 | * ensure that the assembler and the compiler view of the offsets of |
| 209 | * the structure members is the same. |
| 210 | */ |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 211 | CASSERT(ENTRY_POINT_INFO_PC_OFFSET == |
| 212 | __builtin_offsetof(entry_point_info_t, pc), \ |
| 213 | assert_BL31_pc_offset_mismatch); |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 214 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 215 | CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \ |
| 216 | __builtin_offsetof(entry_point_info_t, args), \ |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 217 | assert_BL31_args_offset_mismatch); |
| 218 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 219 | CASSERT(sizeof(unsigned long) == |
| 220 | __builtin_offsetof(entry_point_info_t, spsr) - \ |
| 221 | __builtin_offsetof(entry_point_info_t, pc), \ |
Vikram Kanigiri | a3a5e4a | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 222 | assert_entrypoint_and_spsr_should_be_adjacent); |
| 223 | |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 224 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 225 | * Function & variable prototypes |
| 226 | ******************************************************************************/ |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 227 | unsigned long page_align(unsigned long, unsigned); |
| 228 | void change_security_state(unsigned int); |
Juan Castillo | 3a66aca | 2015-04-13 17:36:19 +0100 | [diff] [blame] | 229 | unsigned long image_size(unsigned int image_id); |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 230 | int load_image(meminfo_t *mem_layout, |
Juan Castillo | 3a66aca | 2015-04-13 17:36:19 +0100 | [diff] [blame] | 231 | unsigned int image_id, |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 232 | uint64_t image_base, |
| 233 | image_info_t *image_data, |
| 234 | entry_point_info_t *entry_point_info); |
Jon Medhurst | ecf0a71 | 2014-02-17 12:18:24 +0000 | [diff] [blame] | 235 | extern const char build_message[]; |
Juan Castillo | 04be3a5 | 2014-06-30 11:41:46 +0100 | [diff] [blame] | 236 | extern const char version_string[]; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 237 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 238 | void reserve_mem(uint64_t *free_base, size_t *free_size, |
| 239 | uint64_t addr, size_t size); |
| 240 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 241 | #endif /*__ASSEMBLY__*/ |
| 242 | |
| 243 | #endif /* __BL_COMMON_H__ */ |