blob: 744c22eba7a1c14fd9843305636f39f67e621bad [file] [log] [blame]
Dan Handley9df48042015-03-19 18:58:55 +00001/*
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
Yatharth Kochara65be2f2015-10-09 18:06:13 +010033#include <bl_common.h>
34#include <platform_def.h>
35
Dan Handley9df48042015-03-19 18:58:55 +000036/******************************************************************************
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
Dan Handley9df48042015-03-19 18:58:55 +000053/*
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 *
Juan Castillo7d199412015-12-14 09:35:25 +000058 * The TSP linker script includes some of these definitions to define the BL32
Dan Handley9df48042015-03-19 18:58:55 +000059 * 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
Soby Mathew70716d62015-07-13 16:26:11 +010073/*
74 * Macros to wrap declarations of deprecated APIs within Trusted Firmware.
Soby Mathew18a62042015-10-26 14:29:21 +000075 * The callers of these APIs will continue to compile with a warning as long
76 * as the build flag ERROR_DEPRECATED is zero.
Soby Mathew70716d62015-07-13 16:26:11 +010077 */
Soby Mathew70716d62015-07-13 16:26:11 +010078#define __warn_deprecated __attribute__ ((deprecated))
Dan Handley9df48042015-03-19 18:58:55 +000079
Yatharth Kochara65be2f2015-10-09 18:06:13 +010080#define BL2_IMAGE_DESC { \
81 .image_id = BL2_IMAGE_ID, \
82 .image_info.h.version = VERSION_1, \
83 .image_info.h.attr = SET_EXEC_STATE(EXECUTABLE),\
84 .image_info.image_base = BL2_BASE, \
85 .ep_info.h.attr = SET_SEC_STATE(SECURE), \
86 .ep_info.pc = BL2_BASE \
87}
88
Dan Handley9df48042015-03-19 18:58:55 +000089#endif /* __COMMON_DEF_H__ */
90