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 0 35 #define NON_SECURE 1 36 37 #define UP 1 38 #define DOWN 0 39 40 /******************************************************************************* 41 * Constants for loading images. When BLx wants to load BLy, it looks at a 42 * meminfo structure to find the extents of free memory. Then depending upon 43 * how it has been configured, it can either load BLy at the top or bottom of 44 * the free memory. These constants indicate the choice. 45 * TODO: Make this configurable while building the trusted firmware. 46 ******************************************************************************/ 47 #define TOP_LOAD 0x1 48 #define BOT_LOAD !TOP_LOAD 49 #define LOAD_MASK (1 << 0) 50 51 /****************************************************************************** 52 * Opcode passed in x0 to tell next EL that we want to run an image. 53 * Corresponds to the function ID of the only SMC that the BL1 exception 54 * handlers service. That's why the chosen value is the first function ID of 55 * the ARM SMC64 range. 56 *****************************************************************************/ 57 #define RUN_IMAGE 0xC0000000 58 59 /******************************************************************************* 60 * Constants that allow assembler code to access members of and the 61 * 'el_change_info' structure at their correct offsets. 62 ******************************************************************************/ 63 #define EL_CHANGE_INFO_PC_OFFSET 0x0 64 #define EL_CHANGE_INFO_ARGS_OFFSET 0x18 65 66 #ifndef __ASSEMBLY__ 67 68 #include <cdefs.h> /* For __dead2 */ 69 #include <cassert.h> 70 71 /******************************************************************************* 72 * Structure used for telling the next BL how much of a particular type of 73 * memory is available for its use and how much is already used. 74 ******************************************************************************/ 75 typedef struct meminfo { 76 unsigned long total_base; 77 long total_size; 78 unsigned long free_base; 79 long free_size; 80 unsigned long attr; 81 unsigned long next; 82 } meminfo_t; 83 84 typedef struct aapcs64_params { 85 unsigned long arg0; 86 unsigned long arg1; 87 unsigned long arg2; 88 unsigned long arg3; 89 unsigned long arg4; 90 unsigned long arg5; 91 unsigned long arg6; 92 unsigned long arg7; 93 } aapcs64_params_t; 94 95 /******************************************************************************* 96 * This structure represents the superset of information needed while switching 97 * exception levels. The only two mechanisms to do so are ERET & SMC. In case of 98 * SMC all members apart from 'aapcs64_params' will be ignored. 99 * NOTE: BL1 expects entrypoint followed by spsr while processing SMC to jump 100 * to BL31 from the start of el_change_info 101 ******************************************************************************/ 102 typedef struct el_change_info { 103 unsigned long entrypoint; 104 unsigned long spsr; 105 unsigned long security_state; 106 aapcs64_params_t args; 107 } el_change_info_t; 108 109 /******************************************************************************* 110 * This structure represents the superset of information that can be passed to 111 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 112 * populated only if BL2 detects its presence. 113 ******************************************************************************/ 114 typedef struct bl31_args { 115 el_change_info_t bl31_image_info; 116 meminfo_t bl31_meminfo; 117 el_change_info_t bl32_image_info; 118 meminfo_t bl32_meminfo; 119 el_change_info_t bl33_image_info; 120 meminfo_t bl33_meminfo; 121 } bl31_args_t; 122 123 124 /* 125 * Compile time assertions related to the 'el_change_info' structure to 126 * ensure that the assembler and the compiler view of the offsets of 127 * the structure members is the same. 128 */ 129 CASSERT(EL_CHANGE_INFO_PC_OFFSET == \ 130 __builtin_offsetof(el_change_info_t, entrypoint), \ 131 assert_BL31_pc_offset_mismatch); 132 133 CASSERT(EL_CHANGE_INFO_ARGS_OFFSET == \ 134 __builtin_offsetof(el_change_info_t, args), \ 135 assert_BL31_args_offset_mismatch); 136 137 CASSERT(sizeof(unsigned long) == __builtin_offsetof(el_change_info_t, spsr) - \ 138 __builtin_offsetof(el_change_info_t, entrypoint), \ 139 assert_entrypoint_and_spsr_should_be_adjacent); 140 141 /******************************************************************************* 142 * Function & variable prototypes 143 ******************************************************************************/ 144 extern unsigned long page_align(unsigned long, unsigned); 145 extern void change_security_state(unsigned int); 146 extern void init_bl2_mem_layout(meminfo_t *, 147 meminfo_t *, 148 unsigned int, 149 unsigned long) __attribute__((weak)); 150 extern void init_bl31_mem_layout(const meminfo_t *, 151 meminfo_t *, 152 unsigned int) __attribute__((weak)); 153 extern unsigned long image_size(const char *); 154 extern unsigned long load_image(meminfo_t *, 155 const char *, 156 unsigned int, 157 unsigned long); 158 extern unsigned long *get_el_change_mem_ptr(void); 159 extern const char build_message[]; 160 161 #endif /*__ASSEMBLY__*/ 162 163 #endif /* __BL_COMMON_H__ */ 164