xref: /rk3399_ARM-atf/include/plat/common/common_def.h (revision e40e075f4ddf63aa84d2aaacb807ed40438f1d24)
1 /*
2  * Copyright (c) 2015-2017, 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 #ifndef __COMMON_DEF_H__
31 #define __COMMON_DEF_H__
32 
33 #include <bl_common.h>
34 #include <platform_def.h>
35 
36 /******************************************************************************
37  * Required platform porting definitions that are expected to be common to
38  * all platforms
39  *****************************************************************************/
40 
41 /*
42  * Platform binary types for linking
43  */
44 #ifdef AARCH32
45 #define PLATFORM_LINKER_FORMAT          "elf32-littlearm"
46 #define PLATFORM_LINKER_ARCH            arm
47 #else
48 #define PLATFORM_LINKER_FORMAT          "elf64-littleaarch64"
49 #define PLATFORM_LINKER_ARCH            aarch64
50 #endif /* AARCH32 */
51 
52 /*
53  * Generic platform constants
54  */
55 #define FIRMWARE_WELCOME_STR		"Booting Trusted Firmware\n"
56 
57 #if LOAD_IMAGE_V2
58 #define BL2_IMAGE_DESC {				\
59 	.image_id = BL2_IMAGE_ID,			\
60 	SET_STATIC_PARAM_HEAD(image_info, PARAM_EP,	\
61 		VERSION_2, image_info_t, 0),		\
62 	.image_info.image_base = BL2_BASE,		\
63 	.image_info.image_max_size = BL2_LIMIT - BL2_BASE,\
64 	SET_STATIC_PARAM_HEAD(ep_info, PARAM_EP,	\
65 		VERSION_2, entry_point_info_t, SECURE | EXECUTABLE),\
66 	.ep_info.pc = BL2_BASE,				\
67 }
68 #else /* LOAD_IMAGE_V2 */
69 #define BL2_IMAGE_DESC {				\
70 	.image_id = BL2_IMAGE_ID,			\
71 	SET_STATIC_PARAM_HEAD(image_info, PARAM_EP,	\
72 		VERSION_1, image_info_t, 0),		\
73 	.image_info.image_base = BL2_BASE,		\
74 	SET_STATIC_PARAM_HEAD(ep_info, PARAM_EP,	\
75 		VERSION_1, entry_point_info_t, SECURE | EXECUTABLE),\
76 	.ep_info.pc = BL2_BASE,				\
77 }
78 #endif /* LOAD_IMAGE_V2 */
79 
80 /*
81  * The following constants identify the extents of the code & read-only data
82  * regions. These addresses are used by the MMU setup code and therefore they
83  * must be page-aligned.
84  *
85  * When the code and read-only data are mapped as a single atomic section
86  * (i.e. when SEPARATE_CODE_AND_RODATA=0) then we treat the whole section as
87  * code by specifying the read-only data section as empty.
88  *
89  * BL1 is different than the other images in the sense that its read-write data
90  * originally lives in Trusted ROM and needs to be relocated in Trusted SRAM at
91  * run-time. Therefore, the read-write data in ROM can be mapped with the same
92  * memory attributes as the read-only data region. For this reason, BL1 uses
93  * different macros.
94  *
95  * Note that BL1_ROM_END is not necessarily aligned on a page boundary as it
96  * just points to the end of BL1's actual content in Trusted ROM. Therefore it
97  * needs to be rounded up to the next page size in order to map the whole last
98  * page of it with the right memory attributes.
99  */
100 #if SEPARATE_CODE_AND_RODATA
101 #define BL_CODE_BASE		(unsigned long)(&__TEXT_START__)
102 #define BL_CODE_END		(unsigned long)(&__TEXT_END__)
103 #define BL_RO_DATA_BASE		(unsigned long)(&__RODATA_START__)
104 #define BL_RO_DATA_END		(unsigned long)(&__RODATA_END__)
105 
106 #define BL1_CODE_END		BL_CODE_END
107 #define BL1_RO_DATA_BASE	(unsigned long)(&__RODATA_START__)
108 #define BL1_RO_DATA_END		round_up(BL1_ROM_END, PAGE_SIZE)
109 #else
110 #define BL_CODE_BASE		(unsigned long)(&__RO_START__)
111 #define BL_CODE_END		(unsigned long)(&__RO_END__)
112 #define BL_RO_DATA_BASE		0
113 #define BL_RO_DATA_END		0
114 
115 #define BL1_CODE_END		round_up(BL1_ROM_END, PAGE_SIZE)
116 #define BL1_RO_DATA_BASE	0
117 #define BL1_RO_DATA_END		0
118 #endif /* SEPARATE_CODE_AND_RODATA */
119 
120 /*
121  * The next 2 constants identify the extents of the coherent memory region.
122  * These addresses are used by the MMU setup code and therefore they must be
123  * page-aligned.  It is the responsibility of the linker script to ensure that
124  * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to
125  * page-aligned addresses.
126  */
127 #define BL_COHERENT_RAM_BASE	(unsigned long)(&__COHERENT_RAM_START__)
128 #define BL_COHERENT_RAM_END	(unsigned long)(&__COHERENT_RAM_END__)
129 
130 #endif /* __COMMON_DEF_H__ */
131