Gitiles
Code Review Sign In
git01.mediatek.com / filogic / atf / 561cd33eceaff56a1c6cabe5a3e6e03e21e9dc9a / . / include / bl_common.h
blob: 2d1d0db04101ed424f78d5cdbb345b304b257e0a [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100[diff] [blame]1/*
Dan Handleye83b0ca2014-01-14 18:17:09 +0000[diff] [blame]2 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-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
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 +0000[diff] [blame]66/*******************************************************************************
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 ******************************************************************************/
Harry Liebele22fb912014-01-03 14:18:15 +0000[diff] [blame]72#define CASSERT(cond, msg) typedef char msg[(cond) ? 1 : -1]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100[diff] [blame]73
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +0000[diff] [blame]74/******************************************************************************
75 * Opcode passed in x0 to tell next EL that we want to run an image.
76 * Corresponds to the function ID of the only SMC that the BL1 exception
77 * handlers service. That's why the chosen value is the first function ID of
78 * the ARM SMC64 range.
79 *****************************************************************************/
80#define RUN_IMAGE 0xC0000000
81
82
Achin Gupta4f6ad662013-10-25 09:08:21 +0100[diff] [blame]83#ifndef __ASSEMBLY__
84/*******************************************************************************
85 * Structure used for telling the next BL how much of a particular type of
86 * memory is available for its use and how much is already used.
87 ******************************************************************************/
88typedef struct {
89 unsigned long total_base;
90 long total_size;
91 unsigned long free_base;
92 long free_size;
93 unsigned long attr;
94 unsigned long next;
95} meminfo;
96
97typedef struct {
98 unsigned long arg0;
99 unsigned long arg1;
100 unsigned long arg2;
101 unsigned long arg3;
102 unsigned long arg4;
103 unsigned long arg5;
104 unsigned long arg6;
105 unsigned long arg7;
106} aapcs64_params;
107
108/*******************************************************************************
109 * This structure represents the superset of information needed while switching
110 * exception levels. The only two mechanisms to do so are ERET & SMC. In case of
111 * SMC all members apart from 'aapcs64_params' will be ignored. The 'next'
112 * member is a placeholder for a complicated case in the distant future when BL2
113 * will load multiple BL3x images as well as a non-secure image. So multiple
114 * such structures will have to be passed to BL31 in S-EL3.
115 ******************************************************************************/
116typedef struct {
117 unsigned long entrypoint;
118 unsigned long spsr;
119 unsigned long security_state;
120 aapcs64_params args;
121 unsigned long next;
122} el_change_info;
123
124/*******************************************************************************
125 * Function & variable prototypes
126 ******************************************************************************/
127extern unsigned long page_align(unsigned long, unsigned);
128extern void change_security_state(unsigned int);
129extern int drop_el(aapcs64_params *, unsigned long, unsigned long);
130extern long raise_el(aapcs64_params *);
131extern long change_el(el_change_info *);
132extern unsigned long make_spsr(unsigned long, unsigned long, unsigned long);
133extern void init_bl2_mem_layout(meminfo *,
134 meminfo *,
135 unsigned int,
136 unsigned long) __attribute__((weak));
137extern void init_bl31_mem_layout(const meminfo *,
138 meminfo *,
139 unsigned int) __attribute__((weak));
140extern unsigned long load_image(meminfo *, const char *, unsigned int, unsigned long);
141extern int run_image(unsigned long,
142 unsigned long,
143 unsigned long,
144 meminfo *,
145 void *);
146extern unsigned long *get_el_change_mem_ptr(void);
147
148#endif /*__ASSEMBLY__*/
149
150#endif /* __BL_COMMON_H__ */