2849ae903a35975f408688bc1478124bcc00d25a
[mirror_edk2.git] / MdePkg / 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 - 2007, 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
27 #define MEMORY_FENCE() MemoryFence ()
28 #define BREAKPOINT() CpuBreakpoint ()
29 #define DEADLOOP() CpuDeadLoop ()
30
31 typedef struct {
32 UINT32 Data1;
33 UINT16 Data2;
34 UINT16 Data3;
35 UINT8 Data4[8];
36 } GUID;
37
38
39 //
40 // Modifiers to absract standard types to aid in debug of problems
41 //
42 #define CONST const
43 #define STATIC static
44 #define VOID void
45
46 //
47 // Modifiers for Data Types used to self document code.
48 // This concept is borrowed for UEFI specification.
49 //
50 #ifndef IN
51 //
52 // Some other envirnments use this construct, so #ifndef to prevent
53 // mulitple definition.
54 //
55 #define IN
56 #define OUT
57 #define OPTIONAL
58 #endif
59
60 //
61 // Constants. They may exist in other build structures, so #ifndef them.
62 //
63 #ifndef TRUE
64 //
65 // UEFI specification claims 1 and 0. We are concerned about the
66 // complier portability so we did it this way.
67 //
68 #define TRUE ((BOOLEAN)(1==1))
69 #endif
70
71 #ifndef FALSE
72 #define FALSE ((BOOLEAN)(0==1))
73 #endif
74
75 #ifndef NULL
76 #define NULL ((VOID *) 0)
77 #endif
78
79 #define BIT0 0x00000001
80 #define BIT1 0x00000002
81 #define BIT2 0x00000004
82 #define BIT3 0x00000008
83 #define BIT4 0x00000010
84 #define BIT5 0x00000020
85 #define BIT6 0x00000040
86 #define BIT7 0x00000080
87 #define BIT8 0x00000100
88 #define BIT9 0x00000200
89 #define BIT10 0x00000400
90 #define BIT11 0x00000800
91 #define BIT12 0x00001000
92 #define BIT13 0x00002000
93 #define BIT14 0x00004000
94 #define BIT15 0x00008000
95 #define BIT16 0x00010000
96 #define BIT17 0x00020000
97 #define BIT18 0x00040000
98 #define BIT19 0x00080000
99 #define BIT20 0x00100000
100 #define BIT21 0x00200000
101 #define BIT22 0x00400000
102 #define BIT23 0x00800000
103 #define BIT24 0x01000000
104 #define BIT25 0x02000000
105 #define BIT26 0x04000000
106 #define BIT27 0x08000000
107 #define BIT28 0x10000000
108 #define BIT29 0x20000000
109 #define BIT30 0x40000000
110 #define BIT31 0x80000000
111 #define BIT32 0x0000000100000000UL
112 #define BIT33 0x0000000200000000UL
113 #define BIT34 0x0000000400000000UL
114 #define BIT35 0x0000000800000000UL
115 #define BIT36 0x0000001000000000UL
116 #define BIT37 0x0000002000000000UL
117 #define BIT38 0x0000004000000000UL
118 #define BIT39 0x0000008000000000UL
119 #define BIT40 0x0000010000000000UL
120 #define BIT41 0x0000020000000000UL
121 #define BIT42 0x0000040000000000UL
122 #define BIT43 0x0000080000000000UL
123 #define BIT44 0x0000100000000000UL
124 #define BIT45 0x0000200000000000UL
125 #define BIT46 0x0000400000000000UL
126 #define BIT47 0x0000800000000000UL
127 #define BIT48 0x0001000000000000UL
128 #define BIT49 0x0002000000000000UL
129 #define BIT50 0x0004000000000000UL
130 #define BIT51 0x0008000000000000UL
131 #define BIT52 0x0010000000000000UL
132 #define BIT53 0x0020000000000000UL
133 #define BIT54 0x0040000000000000UL
134 #define BIT55 0x0080000000000000UL
135 #define BIT56 0x0100000000000000UL
136 #define BIT57 0x0200000000000000UL
137 #define BIT58 0x0400000000000000UL
138 #define BIT59 0x0800000000000000UL
139 #define BIT60 0x1000000000000000UL
140 #define BIT61 0x2000000000000000UL
141 #define BIT62 0x4000000000000000UL
142 #define BIT63 0x8000000000000000UL
143
144 //
145 // Support for variable length argument lists using the ANSI standard.
146 //
147 // Since we are using the ANSI standard we used the standard nameing and
148 // did not folow the coding convention
149 //
150 // VA_LIST - typedef for argument list.
151 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
152 // VA_END (VA_LIST Marker) - Clear Marker
153 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from
154 // the ... list. You must know the size and pass it in this macro.
155 //
156 // example:
157 //
158 // UINTN
159 // ExampleVarArg (
160 // IN UINTN NumberOfArgs,
161 // ...
162 // )
163 // {
164 // VA_LIST Marker;
165 // UINTN Index;
166 // UINTN Result;
167 //
168 // //
169 // // Initialize the Marker
170 // //
171 // VA_START (Marker, NumberOfArgs);
172 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
173 // //
174 // // The ... list is a series of UINTN values, so average them up.
175 // //
176 // Result += VA_ARG (Marker, UINTN);
177 // }
178 //
179 // VA_END (Marker);
180 // return Result
181 // }
182 //
183
184 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
185
186 //
187 // Also support coding convention rules for var arg macros
188 //
189 #ifndef VA_START
190
191 typedef CHAR8 *VA_LIST;
192 #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))
193 #define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))
194 #define VA_END(ap) (ap = (VA_LIST) 0)
195
196 #endif
197
198 ///
199 /// CONTAINING_RECORD - returns a pointer to the structure
200 /// from one of it's elements.
201 ///
202 #define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
203
204 ///
205 /// ALIGN_POINTER - aligns a pointer to the lowest boundry
206 ///
207 #define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))
208
209 ///
210 /// ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor
211 ///
212 #define ALIGN_VARIABLE(Value, Adjustment) \
213 Adjustment = 0U; \
214 if ((UINTN) (Value) % sizeof (UINTN)) { \
215 (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \
216 } \
217 (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))
218
219 //
220 // Return the maximum of two operands.
221 // This macro returns the maximum of two operand specified by a and b.
222 // Both a and b must be the same numerical types, signed or unsigned.
223 //
224 #define MAX(a, b) \
225 (((a) > (b)) ? (a) : (b))
226
227
228 //
229 // Return the minimum of two operands.
230 // This macro returns the minimal of two operand specified by a and b.
231 // Both a and b must be the same numerical types, signed or unsigned.
232 //
233 #define MIN(a, b) \
234 (((a) < (b)) ? (a) : (b))
235
236
237 //
238 // EFI Error Codes common to all execution phases
239 //
240
241 typedef INTN RETURN_STATUS;
242
243 ///
244 /// Set the upper bit to indicate EFI Error.
245 ///
246 #define ENCODE_ERROR(a) (MAX_BIT | (a))
247
248 #define ENCODE_WARNING(a) (a)
249 #define RETURN_ERROR(a) ((a) < 0)
250
251 #define RETURN_SUCCESS 0
252 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
253 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
254 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
255 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
256 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
257 #define RETURN_NOT_READY ENCODE_ERROR (6)
258 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
259 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
260 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
261 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
262 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
263 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
264 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
265 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
266 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
267 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
268 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
269 #define RETURN_TIMEOUT ENCODE_ERROR (18)
270 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
271 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
272 #define RETURN_ABORTED ENCODE_ERROR (21)
273 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
274 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
275 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
276 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
277 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
278 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
279 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
280 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
281
282 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
283 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
284 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
285 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
286
287 typedef UINT64 PHYSICAL_ADDRESS;
288
289 //
290 // LIST_ENTRY definition
291 //
292 typedef struct _LIST_ENTRY LIST_ENTRY;
293
294 struct _LIST_ENTRY {
295 LIST_ENTRY *ForwardLink;
296 LIST_ENTRY *BackLink;
297 };
298
299 #endif