Support building on x64 hosts.
[mirror_edk2.git] / Tools / Source / TianoTools / Include / Common / BaseTypes.h
1 /** @file
2 Processor or Compiler specific defines for all supported processors.
3
4 This file is stand alone self consistent set of definitions.
5
6 Copyright (c) 2006, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 Module Name: BaseTypes.h
16
17 **/
18
19 #ifndef __BASE_TYPES_H__
20 #define __BASE_TYPES_H__
21
22 //
23 // Include processor specific binding
24 //
25 #include <ProcessorBind.h>
26 #include <stdarg.h>
27
28 #define MEMORY_FENCE() MemoryFence ()
29 #define BREAKPOINT() CpuBreakpoint ()
30 #define DEADLOOP() CpuDeadLoop ()
31
32 typedef struct {
33 UINT32 Data1;
34 UINT16 Data2;
35 UINT16 Data3;
36 UINT8 Data4[8];
37 } GUID;
38
39
40 //
41 // Modifiers to absract standard types to aid in debug of problems
42 //
43 #define CONST const
44 #define STATIC static
45 #define VOID void
46
47 //
48 // Modifiers for Data Types used to self document code.
49 // This concept is borrowed for UEFI specification.
50 //
51 #ifndef IN
52 //
53 // Some other envirnments use this construct, so #ifndef to prevent
54 // mulitple definition.
55 //
56 #define IN
57 #define OUT
58 #define OPTIONAL
59 #endif
60
61 //
62 // Constants. They may exist in other build structures, so #ifndef them.
63 //
64 #ifndef TRUE
65 //
66 // BugBug: UEFI specification claims 1 and 0. We are concerned about the
67 // complier portability so we did it this way.
68 //
69 #define TRUE ((BOOLEAN)(1==1))
70 #endif
71
72 #ifndef FALSE
73 #define FALSE ((BOOLEAN)(0==1))
74 #endif
75
76 #ifndef NULL
77 #define NULL ((VOID *) 0)
78 #endif
79
80 //
81 // Support for variable length argument lists using the ANSI standard.
82 //
83 // Since we are using the ANSI standard we used the standard nameing and
84 // did not folow the coding convention
85 //
86 // VA_LIST - typedef for argument list.
87 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
88 // VA_END (VA_LIST Marker) - Clear Marker
89 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from
90 // the ... list. You must know the size and pass it in this macro.
91 //
92 // example:
93 //
94 // UINTN
95 // ExampleVarArg (
96 // IN UINTN NumberOfArgs,
97 // ...
98 // )
99 // {
100 // VA_LIST Marker;
101 // UINTN Index;
102 // UINTN Result;
103 //
104 // //
105 // // Initialize the Marker
106 // //
107 // VA_START (Marker, NumberOfArgs);
108 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
109 // //
110 // // The ... list is a series of UINTN values, so average them up.
111 // //
112 // Result += VA_ARG (Marker, UINTN);
113 // }
114 //
115 // VA_END (Marker);
116 // return Result
117 // }
118 //
119
120 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
121
122 //
123 // Also support coding convention rules for var arg macros
124 //
125 #ifndef VA_START
126
127 // typedef CHAR8 *VA_LIST;
128 // #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))
129 // #define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))
130 // #define VA_END(ap) (ap = (VA_LIST) 0)
131 // Use the native arguments for tools.
132 #define VA_START va_start
133 #define VA_ARG va_arg
134 #define VA_END va_end
135 #define VA_LIST va_list
136
137 #endif
138
139 ///
140 /// CONTAINING_RECORD - returns a pointer to the structure
141 /// from one of it's elements.
142 ///
143 #define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
144
145 ///
146 /// ALIGN_POINTER - aligns a pointer to the lowest boundry
147 ///
148 #define ALIGN_POINTER(p, s) ((VOID *) ((p) + (((s) - ((UINTN) (p))) & ((s) - 1))))
149
150 ///
151 /// ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor
152 ///
153 #define ALIGN_VARIABLE(Value, Adjustment) \
154 Adjustment = 0U; \
155 if ((UINTN) (Value) % sizeof (UINTN)) { \
156 (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \
157 } \
158 (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))
159
160 //
161 // EFI Error Codes common to all execution phases
162 //
163
164 typedef INTN RETURN_STATUS;
165
166 ///
167 /// Set the upper bit to indicate EFI Error.
168 ///
169 #define ENCODE_ERROR(a) (MAX_BIT | (a))
170
171 #define ENCODE_WARNING(a) (a)
172 #define RETURN_ERROR(a) ((a) < 0)
173
174 #define RETURN_SUCCESS 0
175 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
176 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
177 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
178 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
179 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
180 #define RETURN_NOT_READY ENCODE_ERROR (6)
181 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
182 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
183 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
184 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
185 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
186 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
187 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
188 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
189 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
190 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
191 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
192 #define RETURN_TIMEOUT ENCODE_ERROR (18)
193 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
194 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
195 #define RETURN_ABORTED ENCODE_ERROR (21)
196 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
197 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
198 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
199 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
200 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
201 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
202 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
203 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
204
205 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
206 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
207 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
208 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
209
210 typedef UINT64 PHYSICAL_ADDRESS;
211
212 #endif