blob: f7b3b9c7d2918e967db4ca69b69303df047db1c8 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Roberto Vargas777dd432018-02-12 12:36:17 +00002 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta4f6ad662013-10-25 09:08:21 +01005 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef BL_COMMON_H
8#define BL_COMMON_H
Achin Gupta4f6ad662013-10-25 09:08:21 +01009
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <common/ep_info.h>
11#include <common/param_header.h>
12#include <lib/utils_def.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010013
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010014#define UP U(1)
15#define DOWN U(0)
Achin Gupta4f6ad662013-10-25 09:08:21 +010016
17/*******************************************************************************
Sandrine Bailleux467d0572014-06-24 14:02:34 +010018 * Constants to identify the location of a memory region in a given memory
19 * layout.
20******************************************************************************/
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010021#define TOP U(0x1)
22#define BOTTOM U(0x0)
Achin Gupta4f6ad662013-10-25 09:08:21 +010023
Yatharth Kochara65be2f2015-10-09 18:06:13 +010024/*
25 * The following are used for image state attributes.
26 * Image can only be in one of the following state.
27 */
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010028#define IMAGE_STATE_RESET U(0)
29#define IMAGE_STATE_COPIED U(1)
30#define IMAGE_STATE_COPYING U(2)
31#define IMAGE_STATE_AUTHENTICATED U(3)
32#define IMAGE_STATE_EXECUTED U(4)
33#define IMAGE_STATE_INTERRUPTED U(5)
Yatharth Kochara65be2f2015-10-09 18:06:13 +010034
Soby Mathewcc364842018-02-21 01:16:39 +000035#define IMAGE_ATTRIB_SKIP_LOADING U(0x02)
36#define IMAGE_ATTRIB_PLAT_SETUP U(0x04)
Dan Handley2bd4ef22014-04-09 13:14:54 +010037
Soby Mathewcc364842018-02-21 01:16:39 +000038#define INVALID_IMAGE_ID U(0xFFFFFFFF)
Yatharth Kochara65be2f2015-10-09 18:06:13 +010039
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010040/*******************************************************************************
41 * Constants to indicate type of exception to the common exception handler.
42 ******************************************************************************/
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010043#define SYNC_EXCEPTION_SP_EL0 U(0x0)
44#define IRQ_SP_EL0 U(0x1)
45#define FIQ_SP_EL0 U(0x2)
46#define SERROR_SP_EL0 U(0x3)
47#define SYNC_EXCEPTION_SP_ELX U(0x4)
48#define IRQ_SP_ELX U(0x5)
49#define FIQ_SP_ELX U(0x6)
50#define SERROR_SP_ELX U(0x7)
51#define SYNC_EXCEPTION_AARCH64 U(0x8)
52#define IRQ_AARCH64 U(0x9)
53#define FIQ_AARCH64 U(0xa)
54#define SERROR_AARCH64 U(0xb)
55#define SYNC_EXCEPTION_AARCH32 U(0xc)
56#define IRQ_AARCH32 U(0xd)
57#define FIQ_AARCH32 U(0xe)
58#define SERROR_AARCH32 U(0xf)
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010059
Vikram Kanigirida567432014-04-15 18:08:08 +010060#ifndef __ASSEMBLY__
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000061
Sandrine Bailleux467d0572014-06-24 14:02:34 +010062#include <stddef.h>
Soby Mathewb911cc72017-02-13 12:46:28 +000063#include <stdint.h>
Vikram Kanigiri725b1332015-03-04 10:34:27 +000064
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000065#include <lib/cassert.h>
Joel Hutton5cc3bc82018-03-21 11:40:57 +000066
Dan Handleyf05c1b52015-04-27 11:49:22 +010067/*
68 * Declarations of linker defined symbols to help determine memory layout of
69 * BL images
70 */
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010071#if SEPARATE_CODE_AND_RODATA
Joel Hutton5cc3bc82018-03-21 11:40:57 +000072IMPORT_SYM(unsigned long, __TEXT_START__, BL_CODE_BASE);
73IMPORT_SYM(unsigned long, __TEXT_END__, BL_CODE_END);
74IMPORT_SYM(unsigned long, __RODATA_START__, BL_RO_DATA_BASE);
75IMPORT_SYM(unsigned long, __RODATA_END__, BL_RO_DATA_END);
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010076#else
Joel Hutton5cc3bc82018-03-21 11:40:57 +000077IMPORT_SYM(unsigned long, __RO_START__, BL_CODE_BASE);
78IMPORT_SYM(unsigned long, __RO_END__, BL_CODE_END);
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010079#endif
80
Antonio Nino Diazb0fd0082018-12-18 13:49:46 +000081#if defined(IMAGE_BL1)
82IMPORT_SYM(uintptr_t, __BL1_ROM_END__, BL1_ROM_END);
83
84IMPORT_SYM(uintptr_t, __BL1_RAM_START__, BL1_RAM_BASE);
85IMPORT_SYM(uintptr_t, __BL1_RAM_END__, BL1_RAM_LIMIT);
86#elif defined(IMAGE_BL2)
Joel Hutton5cc3bc82018-03-21 11:40:57 +000087IMPORT_SYM(unsigned long, __BL2_END__, BL2_END);
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090088#elif defined(IMAGE_BL2U)
Joel Hutton5cc3bc82018-03-21 11:40:57 +000089IMPORT_SYM(unsigned long, __BL2U_END__, BL2U_END);
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090090#elif defined(IMAGE_BL31)
Soby Mathew4e28c202018-10-14 08:09:22 +010091IMPORT_SYM(unsigned long, __BL31_START__, BL31_START);
Joel Hutton5cc3bc82018-03-21 11:40:57 +000092IMPORT_SYM(unsigned long, __BL31_END__, BL31_END);
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090093#elif defined(IMAGE_BL32)
Joel Hutton5cc3bc82018-03-21 11:40:57 +000094IMPORT_SYM(unsigned long, __BL32_END__, BL32_END);
Dan Handleyf05c1b52015-04-27 11:49:22 +010095#endif /* IMAGE_BLX */
96
Antonio Nino Diazb0fd0082018-12-18 13:49:46 +000097/* The following symbols are only exported from the BL2 at EL3 linker script. */
98#if BL2_IN_XIP_MEM && defined(IMAGE_BL2)
99extern uintptr_t __BL2_ROM_END__;
100#define BL2_ROM_END (uintptr_t)(&__BL2_ROM_END__)
101
102extern uintptr_t __BL2_RAM_START__;
103extern uintptr_t __BL2_RAM_END__;
104#define BL2_RAM_BASE (uintptr_t)(&__BL2_RAM_START__)
105#define BL2_RAM_LIMIT (uintptr_t)(&__BL2_RAM_END__)
106#endif /* BL2_IN_XIP_MEM */
107
Joel Hutton5cc3bc82018-03-21 11:40:57 +0000108/*
109 * The next 2 constants identify the extents of the coherent memory region.
110 * These addresses are used by the MMU setup code and therefore they must be
111 * page-aligned. It is the responsibility of the linker script to ensure that
112 * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to
113 * page-aligned addresses.
114 */
Dan Handleyf05c1b52015-04-27 11:49:22 +0100115#if USE_COHERENT_MEM
Joel Hutton5cc3bc82018-03-21 11:40:57 +0000116IMPORT_SYM(unsigned long, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE);
117IMPORT_SYM(unsigned long, __COHERENT_RAM_END__, BL_COHERENT_RAM_END);
Dan Handleyf05c1b52015-04-27 11:49:22 +0100118#endif
119
Achin Gupta4f6ad662013-10-25 09:08:21 +0100120/*******************************************************************************
121 * Structure used for telling the next BL how much of a particular type of
122 * memory is available for its use and how much is already used.
123 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100124typedef struct meminfo {
Soby Mathewa0fedc42016-06-16 14:52:04 +0100125 uintptr_t total_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100126 size_t total_size;
Dan Handleye2712bc2014-04-10 15:37:22 +0100127} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100128
Vikram Kanigirida567432014-04-15 18:08:08 +0100129/*****************************************************************************
130 * Image info binary provides information from the image loader that
131 * can be used by the firmware to manage available trusted RAM.
132 * More advanced firmware image formats can provide additional
133 * information that enables optimization or greater flexibility in the
134 * common firmware code
135 *****************************************************************************/
136typedef struct image_info {
137 param_header_t h;
138 uintptr_t image_base; /* physical address of base of image */
139 uint32_t image_size; /* bytes read from image file */
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100140 uint32_t image_max_size;
Vikram Kanigirida567432014-04-15 18:08:08 +0100141} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100142
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100143/*****************************************************************************
144 * The image descriptor struct definition.
145 *****************************************************************************/
146typedef struct image_desc {
147 /* Contains unique image id for the image. */
148 unsigned int image_id;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100149 /*
150 * This member contains Image state information.
151 * Refer IMAGE_STATE_XXX defined above.
152 */
153 unsigned int state;
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000154 uint32_t copied_size; /* image size copied in blocks */
Soby Mathew6d4f2622016-01-12 10:30:59 +0000155 image_info_t image_info;
156 entry_point_info_t ep_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100157} image_desc_t;
158
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100159/* BL image node in the BL image loading sequence */
160typedef struct bl_load_info_node {
161 unsigned int image_id;
162 image_info_t *image_info;
163 struct bl_load_info_node *next_load_info;
164} bl_load_info_node_t;
165
166/* BL image head node in the BL image loading sequence */
167typedef struct bl_load_info {
168 param_header_t h;
169 bl_load_info_node_t *head;
170} bl_load_info_t;
171
172/* BL image node in the BL image execution sequence */
173typedef struct bl_params_node {
174 unsigned int image_id;
175 image_info_t *image_info;
176 entry_point_info_t *ep_info;
177 struct bl_params_node *next_params_info;
178} bl_params_node_t;
179
180/*
181 * BL image head node in the BL image execution sequence
182 * It is also used to pass information to next BL image.
183 */
184typedef struct bl_params {
185 param_header_t h;
186 bl_params_node_t *head;
187} bl_params_t;
188
Achin Guptae4d084e2014-02-19 17:18:23 +0000189/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100190 * Function & variable prototypes
191 ******************************************************************************/
Daniel Boulby4f3b6ed2018-05-04 11:18:26 +0100192size_t get_image_size(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100193
Sandrine Bailleuxb0e529b2016-11-08 14:27:10 +0000194int is_mem_free(uintptr_t free_base, size_t free_size,
195 uintptr_t addr, size_t size);
196
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100197int load_auth_image(unsigned int image_id, image_info_t *image_data);
198
Soby Mathew9fe88042018-03-26 12:43:37 +0100199#if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH)
200/*
201 * API to dynamically disable authentication. Only meant for development
202 * systems.
203 */
204void dyn_disable_auth(void);
205#endif
206
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100207extern const char build_message[];
208extern const char version_string[];
209
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100210void print_entry_point_info(const entry_point_info_t *ep_info);
Roberto Vargas2ca18d92018-02-12 12:36:17 +0000211uintptr_t page_align(uintptr_t value, unsigned dir);
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100212
Roberto Vargas344ff022018-10-19 16:44:18 +0100213struct mmap_region;
214
215void setup_page_tables(const struct mmap_region *bl_regions,
216 const struct mmap_region *plat_regions);
217
Achin Gupta4f6ad662013-10-25 09:08:21 +0100218#endif /*__ASSEMBLY__*/
219
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000220#endif /* BL_COMMON_H */