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 * Macro to flag a compile time assertion. It uses the preprocessor to generate 53 * an invalid C construct if 'cond' evaluates to false. 54 * The following compilation error is triggered if the assertion fails: 55 * "error: size of array 'msg' is negative" 56 ******************************************************************************/ 57 #define CASSERT(cond, msg) typedef char msg[(cond) ? 1 : -1] 58 59 /****************************************************************************** 60 * Opcode passed in x0 to tell next EL that we want to run an image. 61 * Corresponds to the function ID of the only SMC that the BL1 exception 62 * handlers service. That's why the chosen value is the first function ID of 63 * the ARM SMC64 range. 64 *****************************************************************************/ 65 #define RUN_IMAGE 0xC0000000 66 67 68 #ifndef __ASSEMBLY__ 69 #include <stdio.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 { 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; 83 84 typedef struct { 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; 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 ******************************************************************************/ 100 typedef struct { 101 unsigned long entrypoint; 102 unsigned long spsr; 103 unsigned long security_state; 104 aapcs64_params args; 105 } el_change_info; 106 107 /******************************************************************************* 108 * This structure represents the superset of information that can be passed to 109 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 110 * populated only if BL2 detects its presence. 111 ******************************************************************************/ 112 typedef struct { 113 meminfo bl31_meminfo; 114 el_change_info bl32_image_info; 115 meminfo bl32_meminfo; 116 el_change_info bl33_image_info; 117 meminfo bl33_meminfo; 118 } bl31_args; 119 120 /******************************************************************************* 121 * Function & variable prototypes 122 ******************************************************************************/ 123 extern unsigned long page_align(unsigned long, unsigned); 124 extern void change_security_state(unsigned int); 125 extern void __dead2 drop_el(aapcs64_params *, unsigned long, unsigned long); 126 extern void __dead2 raise_el(aapcs64_params *); 127 extern void __dead2 change_el(el_change_info *); 128 extern unsigned long make_spsr(unsigned long, unsigned long, unsigned long); 129 extern void init_bl2_mem_layout(meminfo *, 130 meminfo *, 131 unsigned int, 132 unsigned long) __attribute__((weak)); 133 extern void init_bl31_mem_layout(const meminfo *, 134 meminfo *, 135 unsigned int) __attribute__((weak)); 136 extern unsigned long image_size(const char *); 137 extern unsigned long load_image(meminfo *, 138 const char *, 139 unsigned int, 140 unsigned long); 141 extern void __dead2 run_image(unsigned long entrypoint, 142 unsigned long spsr, 143 unsigned long security_state, 144 void *first_arg, 145 void *second_arg); 146 extern unsigned long *get_el_change_mem_ptr(void); 147 extern const char build_message[]; 148 149 #endif /*__ASSEMBLY__*/ 150 151 #endif /* __BL_COMMON_H__ */ 152