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 #ifndef __ASSEMBLY__ 61 62 #include <cdefs.h> /* For __dead2 */ 63 64 /******************************************************************************* 65 * Structure used for telling the next BL how much of a particular type of 66 * memory is available for its use and how much is already used. 67 ******************************************************************************/ 68 typedef struct meminfo { 69 unsigned long total_base; 70 long total_size; 71 unsigned long free_base; 72 long free_size; 73 unsigned long attr; 74 unsigned long next; 75 } meminfo_t; 76 77 typedef struct aapcs64_params { 78 unsigned long arg0; 79 unsigned long arg1; 80 unsigned long arg2; 81 unsigned long arg3; 82 unsigned long arg4; 83 unsigned long arg5; 84 unsigned long arg6; 85 unsigned long arg7; 86 } aapcs64_params_t; 87 88 /******************************************************************************* 89 * This structure represents the superset of information needed while switching 90 * exception levels. The only two mechanisms to do so are ERET & SMC. In case of 91 * SMC all members apart from 'aapcs64_params' will be ignored. 92 ******************************************************************************/ 93 typedef struct el_change_info { 94 unsigned long entrypoint; 95 unsigned long spsr; 96 unsigned long security_state; 97 aapcs64_params_t args; 98 } el_change_info_t; 99 100 /******************************************************************************* 101 * This structure represents the superset of information that can be passed to 102 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 103 * populated only if BL2 detects its presence. 104 ******************************************************************************/ 105 typedef struct bl31_args { 106 meminfo_t bl31_meminfo; 107 el_change_info_t bl32_image_info; 108 meminfo_t bl32_meminfo; 109 el_change_info_t bl33_image_info; 110 meminfo_t bl33_meminfo; 111 } bl31_args_t; 112 113 /******************************************************************************* 114 * Function & variable prototypes 115 ******************************************************************************/ 116 extern unsigned long page_align(unsigned long, unsigned); 117 extern void change_security_state(unsigned int); 118 extern void __dead2 drop_el(aapcs64_params_t *, unsigned long, unsigned long); 119 extern void __dead2 raise_el(aapcs64_params_t *); 120 extern void __dead2 change_el(el_change_info_t *); 121 extern unsigned long make_spsr(unsigned long, unsigned long, unsigned long); 122 extern void init_bl2_mem_layout(meminfo_t *, 123 meminfo_t *, 124 unsigned int, 125 unsigned long) __attribute__((weak)); 126 extern void init_bl31_mem_layout(const meminfo_t *, 127 meminfo_t *, 128 unsigned int) __attribute__((weak)); 129 extern unsigned long image_size(const char *); 130 extern unsigned long load_image(meminfo_t *, 131 const char *, 132 unsigned int, 133 unsigned long); 134 extern void __dead2 run_image(unsigned long entrypoint, 135 unsigned long spsr, 136 unsigned long security_state, 137 void *first_arg, 138 void *second_arg); 139 extern unsigned long *get_el_change_mem_ptr(void); 140 extern const char build_message[]; 141 142 #endif /*__ASSEMBLY__*/ 143 144 #endif /* __BL_COMMON_H__ */ 145