[efi] Add processor binding headers for ARM and AArch64
[ipxe.git] / src / include / ipxe / efi / Arm / ProcessorBind.h
1 /** @file
2 Processor or Compiler specific defines and types for ARM.
3
4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
5 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #ifndef __PROCESSOR_BIND_H__
17 #define __PROCESSOR_BIND_H__
18
19 FILE_LICENCE ( BSD3 );
20
21 ///
22 /// Define the processor type so other code can make processor based choices
23 ///
24 #define MDE_CPU_ARM
25
26 //
27 // Make sure we are using the correct packing rules per EFI specification
28 //
29 #ifndef __GNUC__
30 #pragma pack()
31 #endif
32
33 #if _MSC_EXTENSIONS
34 //
35 // use Microsoft* C complier dependent integer width types
36 //
37 typedef unsigned __int64 UINT64;
38 typedef __int64 INT64;
39 typedef unsigned __int32 UINT32;
40 typedef __int32 INT32;
41 typedef unsigned short UINT16;
42 typedef unsigned short CHAR16;
43 typedef short INT16;
44 typedef unsigned char BOOLEAN;
45 typedef unsigned char UINT8;
46 typedef char CHAR8;
47 typedef signed char INT8;
48 #else
49 //
50 // Assume standard ARM alignment.
51 // Need to check portability of long long
52 //
53 typedef unsigned long long UINT64;
54 typedef long long INT64;
55 typedef unsigned int UINT32;
56 typedef int INT32;
57 typedef unsigned short UINT16;
58 typedef unsigned short CHAR16;
59 typedef short INT16;
60 typedef unsigned char BOOLEAN;
61 typedef unsigned char UINT8;
62 typedef char CHAR8;
63 typedef signed char INT8;
64 #endif
65
66 ///
67 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
68 /// 8 bytes on supported 64-bit processor instructions)
69 ///
70 typedef UINT32 UINTN;
71
72 ///
73 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
74 /// 8 bytes on supported 64-bit processor instructions)
75 ///
76 typedef INT32 INTN;
77
78 //
79 // Processor specific defines
80 //
81
82 ///
83 /// A value of native width with the highest bit set.
84 ///
85 #define MAX_BIT 0x80000000
86
87 ///
88 /// A value of native width with the two highest bits set.
89 ///
90 #define MAX_2_BITS 0xC0000000
91
92 ///
93 /// Maximum legal ARM address
94 ///
95 #define MAX_ADDRESS 0xFFFFFFFF
96
97 ///
98 /// Maximum legal ARM INTN and UINTN values.
99 ///
100 #define MAX_INTN ((INTN)0x7FFFFFFF)
101 #define MAX_UINTN ((UINTN)0xFFFFFFFF)
102
103 ///
104 /// The stack alignment required for ARM
105 ///
106 #define CPU_STACK_ALIGNMENT sizeof(UINT64)
107
108 //
109 // Modifier to ensure that all protocol member functions and EFI intrinsics
110 // use the correct C calling convention. All protocol member functions and
111 // EFI intrinsics are required to modify their member functions with EFIAPI.
112 //
113 #define EFIAPI
114
115 // When compiling with Clang, we still use GNU as for the assembler, so we still
116 // need to define the GCC_ASM* macros.
117 #if defined(__GNUC__) || defined(__clang__)
118 ///
119 /// For GNU assembly code, .global or .globl can declare global symbols.
120 /// Define this macro to unify the usage.
121 ///
122 #define ASM_GLOBAL .globl
123
124 #if !defined(__APPLE__)
125 ///
126 /// ARM EABI defines that the linker should not manipulate call relocations
127 /// (do bl/blx conversion) unless the target symbol has function type.
128 /// CodeSourcery 2010.09 started requiring the .type to function properly
129 ///
130 #define INTERWORK_FUNC(func__) .type ASM_PFX(func__), %function
131
132 #define GCC_ASM_EXPORT(func__) \
133 .global _CONCATENATE (__USER_LABEL_PREFIX__, func__) ;\
134 .type ASM_PFX(func__), %function
135
136 #define GCC_ASM_IMPORT(func__) \
137 .extern _CONCATENATE (__USER_LABEL_PREFIX__, func__)
138
139 #else
140 //
141 // .type not supported by Apple Xcode tools
142 //
143 #define INTERWORK_FUNC(func__)
144
145 #define GCC_ASM_EXPORT(func__) \
146 .globl _CONCATENATE (__USER_LABEL_PREFIX__, func__) \
147
148 #define GCC_ASM_IMPORT(name)
149
150 #endif
151 #endif
152
153 /**
154 Return the pointer to the first instruction of a function given a function pointer.
155 On ARM CPU architectures, these two pointer values are the same,
156 so the implementation of this macro is very simple.
157
158 @param FunctionPointer A pointer to a function.
159
160 @return The pointer to the first instruction of a function given a function pointer.
161
162 **/
163 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)
164
165 #ifndef __USER_LABEL_PREFIX__
166 #define __USER_LABEL_PREFIX__
167 #endif
168
169 #endif
170
171