blob: 0af98d689647f7860bd01bc0181ea8110e4cbb4b [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Dan Handleyab2d31e2013-12-02 19:25:12 +00002 * Copyright (c) 2013, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
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 * Size of memory for sharing data while changing exception levels.
53 *
54 * There are 2 cases where this memory buffer is used:
55 *
56 * - when BL1 (running in EL3) passes control to BL2 (running in S-EL1).
57 * BL1 needs to pass the memory layout to BL2, to allow BL2 to find out
58 * how much free trusted ram remains;
59 *
60 * - when BL2 (running in S-EL1) passes control back to BL1 (running in EL3)
61 * to make it run BL31. BL2 needs to pass the memory layout, as well as
62 * information on how to pass control to the non-trusted software image.
63 ******************************************************************************/
64#define EL_CHANGE_MEM_SIZE (sizeof(meminfo) + sizeof(el_change_info))
65
Achin Gupta4a826dd2013-11-25 14:00:56 +000066/*******************************************************************************
67 * Macro to flag a compile time assertion. It uses the preprocessor to generate
68 * an invalid C construct if 'cond' evaluates to false.
69 * The following compilation error is triggered if the assertion fails:
70 * "error: size of array 'msg' is negative"
71 ******************************************************************************/
72#define CASSERT(cond, msg) typedef char msg[(cond) ? 0 : -1]
Achin Gupta4f6ad662013-10-25 09:08:21 +010073
74#ifndef __ASSEMBLY__
75/*******************************************************************************
76 * Structure used for telling the next BL how much of a particular type of
77 * memory is available for its use and how much is already used.
78 ******************************************************************************/
79typedef struct {
80 unsigned long total_base;
81 long total_size;
82 unsigned long free_base;
83 long free_size;
84 unsigned long attr;
85 unsigned long next;
86} meminfo;
87
88typedef struct {
89 unsigned long arg0;
90 unsigned long arg1;
91 unsigned long arg2;
92 unsigned long arg3;
93 unsigned long arg4;
94 unsigned long arg5;
95 unsigned long arg6;
96 unsigned long arg7;
97} aapcs64_params;
98
99/*******************************************************************************
100 * This structure represents the superset of information needed while switching
101 * exception levels. The only two mechanisms to do so are ERET & SMC. In case of
102 * SMC all members apart from 'aapcs64_params' will be ignored. The 'next'
103 * member is a placeholder for a complicated case in the distant future when BL2
104 * will load multiple BL3x images as well as a non-secure image. So multiple
105 * such structures will have to be passed to BL31 in S-EL3.
106 ******************************************************************************/
107typedef struct {
108 unsigned long entrypoint;
109 unsigned long spsr;
110 unsigned long security_state;
111 aapcs64_params args;
112 unsigned long next;
113} el_change_info;
114
115/*******************************************************************************
116 * Function & variable prototypes
117 ******************************************************************************/
118extern unsigned long page_align(unsigned long, unsigned);
119extern void change_security_state(unsigned int);
120extern int drop_el(aapcs64_params *, unsigned long, unsigned long);
121extern long raise_el(aapcs64_params *);
122extern long change_el(el_change_info *);
123extern unsigned long make_spsr(unsigned long, unsigned long, unsigned long);
124extern void init_bl2_mem_layout(meminfo *,
125 meminfo *,
126 unsigned int,
127 unsigned long) __attribute__((weak));
128extern void init_bl31_mem_layout(const meminfo *,
129 meminfo *,
130 unsigned int) __attribute__((weak));
131extern unsigned long load_image(meminfo *, const char *, unsigned int, unsigned long);
132extern int run_image(unsigned long,
133 unsigned long,
134 unsigned long,
135 meminfo *,
136 void *);
137extern unsigned long *get_el_change_mem_ptr(void);
138
139#endif /*__ASSEMBLY__*/
140
141#endif /* __BL_COMMON_H__ */