xref: /rk3399_ARM-atf/include/plat/common/common_def.h (revision fd6007de64fd7e16f6d96972643434c04a77f1c6)
1 /*
2  * Copyright (c) 2015, 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 /******************************************************************************
34  * Required platform porting definitions that are expected to be common to
35  * all platforms
36  *****************************************************************************/
37 
38 /*
39  * Platform binary types for linking
40  */
41 #define PLATFORM_LINKER_FORMAT          "elf64-littleaarch64"
42 #define PLATFORM_LINKER_ARCH            aarch64
43 
44 
45 /*
46  * Generic platform constants
47  */
48 #define FIRMWARE_WELCOME_STR		"Booting Trusted Firmware\n"
49 
50 /*
51  * Some of the platform porting definitions use the 'ull' suffix in order to
52  * avoid subtle integer overflow errors due to implicit integer type promotion
53  * when working with 32-bit values.
54  *
55  * The TSP linker script includes some of these definitions to define the BL3-2
56  * memory map, but the GNU LD does not support the 'ull' suffix, causing the
57  * build process to fail. To solve this problem, the auxiliary macro MAKE_ULL(x)
58  * will add the 'ull' suffix only when the macro __LINKER__  is not defined
59  * (__LINKER__ is defined in the command line to preprocess the linker script).
60  * Constants in the linker script will not have the 'ull' suffix, but this is
61  * not a problem since the linker evaluates all constant expressions to 64 bit
62  * (assuming the target architecture is 64 bit).
63  */
64 #ifndef __LINKER__
65   #define MAKE_ULL(x)			x##ull
66 #else
67   #define MAKE_ULL(x)			x
68 #endif
69 
70 /*
71  * Macros to wrap declarations of deprecated APIs within Trusted Firmware.
72  * The callers of these APIs will continue to compile as long as the build
73  * flag WARN_DEPRECATED is zero. Else the compiler will emit a warning
74  * when the callers of these APIs are compiled.
75  */
76 #if WARN_DEPRECATED
77 #define __warn_deprecated	__attribute__ ((deprecated))
78 #else
79 #define __warn_deprecated
80 #endif
81 
82 #endif /* __COMMON_DEF_H__ */
83 
84