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