Gitiles
Code Review Sign In
git01.mediatek.com / filogic / atf / cff4e296be0a3a03ff78c98cc28d3513e811f9b7 / . / include / bl_common.h
blob: 58accdb1c4d613285e9250083d98cda1c0069de4 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100[diff] [blame]1/*
2 * Copyright (c) 2013, ARM Limited. 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 * 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
66
67#ifndef __ASSEMBLY__
68/*******************************************************************************
69 * Structure used for telling the next BL how much of a particular type of
70 * memory is available for its use and how much is already used.
71 ******************************************************************************/
72typedef struct {
73 unsigned long total_base;
74 long total_size;
75 unsigned long free_base;
76 long free_size;
77 unsigned long attr;
78 unsigned long next;
79} meminfo;
80
81typedef struct {
82 unsigned long arg0;
83 unsigned long arg1;
84 unsigned long arg2;
85 unsigned long arg3;
86 unsigned long arg4;
87 unsigned long arg5;
88 unsigned long arg6;
89 unsigned long arg7;
90} aapcs64_params;
91
92/*******************************************************************************
93 * This structure represents the superset of information needed while switching
94 * exception levels. The only two mechanisms to do so are ERET & SMC. In case of
95 * SMC all members apart from 'aapcs64_params' will be ignored. The 'next'
96 * member is a placeholder for a complicated case in the distant future when BL2
97 * will load multiple BL3x images as well as a non-secure image. So multiple
98 * such structures will have to be passed to BL31 in S-EL3.
99 ******************************************************************************/
100typedef struct {
101 unsigned long entrypoint;
102 unsigned long spsr;
103 unsigned long security_state;
104 aapcs64_params args;
105 unsigned long next;
106} el_change_info;
107
108/*******************************************************************************
109 * Function & variable prototypes
110 ******************************************************************************/
111extern unsigned long page_align(unsigned long, unsigned);
112extern void change_security_state(unsigned int);
113extern int drop_el(aapcs64_params *, unsigned long, unsigned long);
114extern long raise_el(aapcs64_params *);
115extern long change_el(el_change_info *);
116extern unsigned long make_spsr(unsigned long, unsigned long, unsigned long);
117extern void init_bl2_mem_layout(meminfo *,
118 meminfo *,
119 unsigned int,
120 unsigned long) __attribute__((weak));
121extern void init_bl31_mem_layout(const meminfo *,
122 meminfo *,
123 unsigned int) __attribute__((weak));
124extern unsigned long load_image(meminfo *, const char *, unsigned int, unsigned long);
125extern int run_image(unsigned long,
126 unsigned long,
127 unsigned long,
128 meminfo *,
129 void *);
130extern unsigned long *get_el_change_mem_ptr(void);
131
132#endif /*__ASSEMBLY__*/
133
134#endif /* __BL_COMMON_H__ */