xref: /rk3399_ARM-atf/include/plat/common/common_def.h (revision 532ed6183868036e4a4f83cd7a71b93266a3bdb7)
1 /*
2  * Copyright (c) 2015-2016, 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 #define PLATFORM_LINKER_FORMAT          "elf64-littleaarch64"
45 #define PLATFORM_LINKER_ARCH            aarch64
46 
47 
48 /*
49  * Generic platform constants
50  */
51 #define FIRMWARE_WELCOME_STR		"Booting Trusted Firmware\n"
52 
53 /*
54  * Some of the platform porting definitions use the 'ull' suffix in order to
55  * avoid subtle integer overflow errors due to implicit integer type promotion
56  * when working with 32-bit values.
57  *
58  * The TSP linker script includes some of these definitions to define the BL32
59  * memory map, but the GNU LD does not support the 'ull' suffix, causing the
60  * build process to fail. To solve this problem, the auxiliary macro MAKE_ULL(x)
61  * will add the 'ull' suffix only when the macro __LINKER__  is not defined
62  * (__LINKER__ is defined in the command line to preprocess the linker script).
63  * Constants in the linker script will not have the 'ull' suffix, but this is
64  * not a problem since the linker evaluates all constant expressions to 64 bit
65  * (assuming the target architecture is 64 bit).
66  */
67 #ifndef __LINKER__
68   #define MAKE_ULL(x)			x##ull
69 #else
70   #define MAKE_ULL(x)			x
71 #endif
72 
73 #define BL2_IMAGE_DESC {				\
74 	.image_id = BL2_IMAGE_ID,			\
75 	SET_STATIC_PARAM_HEAD(image_info, PARAM_EP,	\
76 		VERSION_1, image_info_t, 0),		\
77 	.image_info.image_base = BL2_BASE,		\
78 	SET_STATIC_PARAM_HEAD(ep_info, PARAM_EP,	\
79 		VERSION_1, entry_point_info_t, SECURE | EXECUTABLE),\
80 	.ep_info.pc = BL2_BASE,				\
81 }
82 
83 /*
84  * The following constants identify the extents of the code & read-only data
85  * regions. These addresses are used by the MMU setup code and therefore they
86  * must be page-aligned.
87  *
88  * When the code and read-only data are mapped as a single atomic section
89  * (i.e. when SEPARATE_CODE_AND_RODATA=0) then we treat the whole section as
90  * code by specifying the read-only data section as empty.
91  *
92  * BL1 is different than the other images in the sense that its read-write data
93  * originally lives in Trusted ROM and needs to be relocated in Trusted SRAM at
94  * run-time. Therefore, the read-write data in ROM can be mapped with the same
95  * memory attributes as the read-only data region. For this reason, BL1 uses
96  * different macros.
97  *
98  * Note that BL1_ROM_END is not necessarily aligned on a page boundary as it
99  * just points to the end of BL1's actual content in Trusted ROM. Therefore it
100  * needs to be rounded up to the next page size in order to map the whole last
101  * page of it with the right memory attributes.
102  */
103 #if SEPARATE_CODE_AND_RODATA
104 #define BL_CODE_BASE		(unsigned long)(&__TEXT_START__)
105 #define BL_CODE_LIMIT		(unsigned long)(&__TEXT_END__)
106 #define BL_RO_DATA_BASE		(unsigned long)(&__RODATA_START__)
107 #define BL_RO_DATA_LIMIT	(unsigned long)(&__RODATA_END__)
108 
109 #define BL1_CODE_LIMIT		BL_CODE_LIMIT
110 #define BL1_RO_DATA_BASE	(unsigned long)(&__RODATA_START__)
111 #define BL1_RO_DATA_LIMIT	round_up(BL1_ROM_END, PAGE_SIZE)
112 #else
113 #define BL_CODE_BASE		(unsigned long)(&__RO_START__)
114 #define BL_CODE_LIMIT		(unsigned long)(&__RO_END__)
115 #define BL_RO_DATA_BASE		0
116 #define BL_RO_DATA_LIMIT	0
117 
118 #define BL1_CODE_LIMIT		round_up(BL1_ROM_END, PAGE_SIZE)
119 #define BL1_RO_DATA_BASE	0
120 #define BL1_RO_DATA_LIMIT	0
121 #endif /* SEPARATE_CODE_AND_RODATA */
122 
123 #endif /* __COMMON_DEF_H__ */
124