]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
959ccb23 | 2 | Root include file for Mde Package Base type modules\r |
3 | \r | |
818ff8c2 | 4 | This is the include file for any module of type base. Base modules only use\r |
5 | types defined via this include file and can be ported easily to any\r | |
959ccb23 | 6 | environment. There are a set of base libraries in the Mde Package that can\r |
7 | be used to implement base modules.\r | |
8 | \r | |
ad1009ec | 9 | Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 | 10 | Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r |
9344f092 | 11 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
959ccb23 | 12 | \r |
13 | **/\r | |
14 | \r | |
959ccb23 | 15 | #ifndef __BASE_H__\r |
16 | #define __BASE_H__\r | |
17 | \r | |
18 | //\r | |
19 | // Include processor specific binding\r | |
20 | //\r | |
21 | #include <ProcessorBind.h>\r | |
22 | \r | |
2f88bd3a | 23 | #if defined (_MSC_EXTENSIONS)\r |
7849538e MK |
24 | //\r |
25 | // Disable warning when last field of data structure is a zero sized array.\r | |
26 | //\r | |
2f88bd3a | 27 | #pragma warning ( disable : 4200 )\r |
7849538e | 28 | #endif\r |
6c3fa13c | 29 | \r |
dda3a6ce | 30 | //\r |
31 | // The Microsoft* C compiler can removed references to unreferenced data items\r | |
818ff8c2 | 32 | // if the /OPT:REF linker option is used. We defined a macro as this is a\r |
dda3a6ce | 33 | // a non standard extension\r |
34 | //\r | |
2f88bd3a MK |
35 | #if defined (_MSC_VER) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)\r |
36 | ///\r | |
37 | /// Remove global variable from the linked image if there are no references to\r | |
38 | /// it after all compiler and linker optimizations have been performed.\r | |
39 | ///\r | |
40 | ///\r | |
41 | #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r | |
dda3a6ce | 42 | #else\r |
2f88bd3a MK |
43 | ///\r |
44 | /// Remove the global variable from the linked image if there are no references\r | |
45 | /// to it after all compiler and linker optimizations have been performed.\r | |
46 | ///\r | |
47 | ///\r | |
48 | #define GLOBAL_REMOVE_IF_UNREFERENCED\r | |
dda3a6ce | 49 | #endif\r |
50 | \r | |
001f28ca MH |
51 | //\r |
52 | // Should be used in combination with NORETURN to avoid 'noreturn' returns\r | |
53 | // warnings.\r | |
54 | //\r | |
55 | #ifndef UNREACHABLE\r | |
7423ba9d | 56 | #ifdef __GNUC__\r |
2f88bd3a MK |
57 | ///\r |
58 | /// Signal compilers and analyzers that this call is not reachable. It is\r | |
59 | /// up to the compiler to remove any code past that point.\r | |
60 | ///\r | |
61 | #define UNREACHABLE() __builtin_unreachable ()\r | |
001f28ca MH |
62 | #elif defined (__has_feature)\r |
63 | #if __has_builtin (__builtin_unreachable)\r | |
2f88bd3a MK |
64 | ///\r |
65 | /// Signal compilers and analyzers that this call is not reachable. It is\r | |
66 | /// up to the compiler to remove any code past that point.\r | |
67 | ///\r | |
68 | #define UNREACHABLE() __builtin_unreachable ()\r | |
001f28ca MH |
69 | #endif\r |
70 | #endif\r | |
71 | \r | |
72 | #ifndef UNREACHABLE\r | |
2f88bd3a MK |
73 | ///\r |
74 | /// Signal compilers and analyzers that this call is not reachable. It is\r | |
75 | /// up to the compiler to remove any code past that point.\r | |
76 | ///\r | |
77 | #define UNREACHABLE()\r | |
001f28ca MH |
78 | #endif\r |
79 | #endif\r | |
80 | \r | |
81 | //\r | |
82 | // Signaling compilers and analyzers that a certain function cannot return may\r | |
83 | // remove all following code and thus lead to better optimization and less\r | |
84 | // false positives.\r | |
85 | //\r | |
86 | #ifndef NORETURN\r | |
87 | #if defined (__GNUC__) || defined (__clang__)\r | |
2f88bd3a MK |
88 | ///\r |
89 | /// Signal compilers and analyzers that the function cannot return.\r | |
90 | /// It is up to the compiler to remove any code past a call to functions\r | |
91 | /// flagged with this attribute.\r | |
92 | ///\r | |
93 | #define NORETURN __attribute__((noreturn))\r | |
94 | #elif defined (_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)\r | |
95 | ///\r | |
96 | /// Signal compilers and analyzers that the function cannot return.\r | |
97 | /// It is up to the compiler to remove any code past a call to functions\r | |
98 | /// flagged with this attribute.\r | |
99 | ///\r | |
100 | #define NORETURN __declspec(noreturn)\r | |
001f28ca | 101 | #else\r |
2f88bd3a MK |
102 | ///\r |
103 | /// Signal compilers and analyzers that the function cannot return.\r | |
104 | /// It is up to the compiler to remove any code past a call to functions\r | |
105 | /// flagged with this attribute.\r | |
106 | ///\r | |
107 | #define NORETURN\r | |
001f28ca MH |
108 | #endif\r |
109 | #endif\r | |
110 | \r | |
111 | //\r | |
112 | // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'\r | |
113 | // returns warnings.\r | |
114 | //\r | |
115 | #ifndef ANALYZER_UNREACHABLE\r | |
116 | #ifdef __clang_analyzer__\r | |
117 | #if __has_builtin (__builtin_unreachable)\r | |
2f88bd3a MK |
118 | ///\r |
119 | /// Signal the analyzer that this call is not reachable.\r | |
120 | /// This excludes compilers.\r | |
121 | ///\r | |
122 | #define ANALYZER_UNREACHABLE() __builtin_unreachable ()\r | |
001f28ca MH |
123 | #endif\r |
124 | #endif\r | |
125 | \r | |
126 | #ifndef ANALYZER_UNREACHABLE\r | |
2f88bd3a MK |
127 | ///\r |
128 | /// Signal the analyzer that this call is not reachable.\r | |
129 | /// This excludes compilers.\r | |
130 | ///\r | |
131 | #define ANALYZER_UNREACHABLE()\r | |
001f28ca MH |
132 | #endif\r |
133 | #endif\r | |
134 | \r | |
135 | //\r | |
136 | // Static Analyzers may issue errors about potential NULL-dereferences when\r | |
137 | // dereferencing a pointer, that has been checked before, outside of a\r | |
138 | // NULL-check. This may lead to false positives, such as when using ASSERT()\r | |
139 | // for verification.\r | |
140 | //\r | |
141 | #ifndef ANALYZER_NORETURN\r | |
142 | #ifdef __has_feature\r | |
143 | #if __has_feature (attribute_analyzer_noreturn)\r | |
2f88bd3a MK |
144 | ///\r |
145 | /// Signal analyzers that the function cannot return.\r | |
146 | /// This excludes compilers.\r | |
147 | ///\r | |
148 | #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))\r | |
001f28ca MH |
149 | #endif\r |
150 | #endif\r | |
151 | \r | |
152 | #ifndef ANALYZER_NORETURN\r | |
2f88bd3a MK |
153 | ///\r |
154 | /// Signal the analyzer that the function cannot return.\r | |
155 | /// This excludes compilers.\r | |
156 | ///\r | |
157 | #define ANALYZER_NORETURN\r | |
001f28ca MH |
158 | #endif\r |
159 | #endif\r | |
160 | \r | |
2d94c38b M |
161 | ///\r |
162 | /// Tell the code optimizer that the function will return twice.\r | |
163 | /// This prevents wrong optimizations which can cause bugs.\r | |
164 | ///\r | |
165 | #ifndef RETURNS_TWICE\r | |
166 | #if defined (__GNUC__) || defined (__clang__)\r | |
2f88bd3a MK |
167 | ///\r |
168 | /// Tell the code optimizer that the function will return twice.\r | |
169 | /// This prevents wrong optimizations which can cause bugs.\r | |
170 | ///\r | |
171 | #define RETURNS_TWICE __attribute__((returns_twice))\r | |
2d94c38b | 172 | #else\r |
2f88bd3a MK |
173 | ///\r |
174 | /// Tell the code optimizer that the function will return twice.\r | |
175 | /// This prevents wrong optimizations which can cause bugs.\r | |
176 | ///\r | |
177 | #define RETURNS_TWICE\r | |
2d94c38b M |
178 | #endif\r |
179 | #endif\r | |
180 | \r | |
dda3a6ce | 181 | //\r |
02eef553 | 182 | // For symbol name in assembly code, an extra "_" is sometimes necessary\r |
dda3a6ce | 183 | //\r |
dda3a6ce | 184 | \r |
02eef553 JJ |
185 | ///\r |
186 | /// Private worker functions for ASM_PFX()\r | |
187 | ///\r | |
2f88bd3a MK |
188 | #define _CONCATENATE(a, b) __CONCATENATE(a, b)\r |
189 | #define __CONCATENATE(a, b) a ## b\r | |
02eef553 JJ |
190 | \r |
191 | ///\r | |
192 | /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix\r | |
193 | /// on symbols in assembly language.\r | |
194 | ///\r | |
2f88bd3a | 195 | #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\r |
dda3a6ce | 196 | \r |
63653ff8 | 197 | #ifdef __APPLE__\r |
2f88bd3a MK |
198 | //\r |
199 | // Apple extension that is used by the linker to optimize code size\r | |
200 | // with assembly functions. Put at the end of your .S files\r | |
201 | //\r | |
202 | #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols\r | |
dda3a6ce | 203 | #else\r |
2f88bd3a | 204 | #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED\r |
dda3a6ce | 205 | #endif\r |
206 | \r | |
2f88bd3a | 207 | #define PACKED\r |
dda3a6ce | 208 | \r |
f4ec40ab | 209 | ///\r |
818ff8c2 | 210 | /// 128 bit buffer containing a unique identifier value.\r |
f4ec40ab | 211 | /// Unless otherwise specified, aligned on a 64 bit boundary.\r |
212 | ///\r | |
959ccb23 | 213 | typedef struct {\r |
2f88bd3a MK |
214 | UINT32 Data1;\r |
215 | UINT16 Data2;\r | |
216 | UINT16 Data3;\r | |
217 | UINT8 Data4[8];\r | |
959ccb23 | 218 | } GUID;\r |
219 | \r | |
ab4de5c8 RN |
220 | ///\r |
221 | /// 4-byte buffer. An IPv4 internet protocol address.\r | |
222 | ///\r | |
223 | typedef struct {\r | |
2f88bd3a | 224 | UINT8 Addr[4];\r |
ab4de5c8 RN |
225 | } IPv4_ADDRESS;\r |
226 | \r | |
227 | ///\r | |
228 | /// 16-byte buffer. An IPv6 internet protocol address.\r | |
229 | ///\r | |
230 | typedef struct {\r | |
2f88bd3a | 231 | UINT8 Addr[16];\r |
ab4de5c8 RN |
232 | } IPv6_ADDRESS;\r |
233 | \r | |
3963c4bf | 234 | //\r |
235 | // 8-bytes unsigned value that represents a physical system address.\r | |
236 | //\r | |
959ccb23 | 237 | typedef UINT64 PHYSICAL_ADDRESS;\r |
238 | \r | |
62991af2 | 239 | ///\r |
f4ec40ab | 240 | /// LIST_ENTRY structure definition.\r |
62991af2 | 241 | ///\r |
959ccb23 | 242 | typedef struct _LIST_ENTRY LIST_ENTRY;\r |
243 | \r | |
f4ec40ab | 244 | ///\r |
245 | /// _LIST_ENTRY structure definition.\r | |
246 | ///\r | |
959ccb23 | 247 | struct _LIST_ENTRY {\r |
2f88bd3a MK |
248 | LIST_ENTRY *ForwardLink;\r |
249 | LIST_ENTRY *BackLink;\r | |
959ccb23 | 250 | };\r |
251 | \r | |
252 | //\r | |
3963c4bf | 253 | // Modifiers to abstract standard types to aid in debug of problems\r |
959ccb23 | 254 | //\r |
f4ec40ab | 255 | \r |
256 | ///\r | |
af2dc6a7 | 257 | /// Datum is read-only.\r |
f4ec40ab | 258 | ///\r |
2f88bd3a | 259 | #define CONST const\r |
f4ec40ab | 260 | \r |
261 | ///\r | |
af2dc6a7 | 262 | /// Datum is scoped to the current file or function.\r |
f4ec40ab | 263 | ///\r |
2f88bd3a | 264 | #define STATIC static\r |
f4ec40ab | 265 | \r |
266 | ///\r | |
af2dc6a7 | 267 | /// Undeclared type.\r |
f4ec40ab | 268 | ///\r |
2f88bd3a | 269 | #define VOID void\r |
959ccb23 | 270 | \r |
271 | //\r | |
272 | // Modifiers for Data Types used to self document code.\r | |
273 | // This concept is borrowed for UEFI specification.\r | |
274 | //\r | |
f4ec40ab | 275 | \r |
276 | ///\r | |
af2dc6a7 | 277 | /// Datum is passed to the function.\r |
f4ec40ab | 278 | ///\r |
959ccb23 | 279 | #define IN\r |
f4ec40ab | 280 | \r |
281 | ///\r | |
af2dc6a7 | 282 | /// Datum is returned from the function.\r |
f4ec40ab | 283 | ///\r |
959ccb23 | 284 | #define OUT\r |
f4ec40ab | 285 | \r |
286 | ///\r | |
287 | /// Passing the datum to the function is optional, and a NULL\r | |
af2dc6a7 | 288 | /// is passed if the value is not supplied.\r |
f4ec40ab | 289 | ///\r |
959ccb23 | 290 | #define OPTIONAL\r |
959ccb23 | 291 | \r |
959ccb23 | 292 | //\r |
818ff8c2 | 293 | // UEFI specification claims 1 and 0. We are concerned about the\r |
00b7cc0f | 294 | // compiler portability so we did it this way.\r |
959ccb23 | 295 | //\r |
f4ec40ab | 296 | \r |
297 | ///\r | |
298 | /// Boolean true value. UEFI Specification defines this value to be 1,\r | |
299 | /// but this form is more portable.\r | |
300 | ///\r | |
959ccb23 | 301 | #define TRUE ((BOOLEAN)(1==1))\r |
f4ec40ab | 302 | \r |
303 | ///\r | |
304 | /// Boolean false value. UEFI Specification defines this value to be 0,\r | |
305 | /// but this form is more portable.\r | |
306 | ///\r | |
2f88bd3a | 307 | #define FALSE ((BOOLEAN)(0==1))\r |
959ccb23 | 308 | \r |
f4ec40ab | 309 | ///\r |
310 | /// NULL pointer (VOID *)\r | |
311 | ///\r | |
959ccb23 | 312 | #define NULL ((VOID *) 0)\r |
959ccb23 | 313 | \r |
0c45a5b2 SB |
314 | //\r |
315 | // Null character\r | |
316 | //\r | |
2f88bd3a | 317 | #define CHAR_NULL 0x0000\r |
0c45a5b2 | 318 | \r |
068a82fc LG |
319 | ///\r |
320 | /// Maximum values for common UEFI Data Types\r | |
321 | ///\r | |
322 | #define MAX_INT8 ((INT8)0x7F)\r | |
323 | #define MAX_UINT8 ((UINT8)0xFF)\r | |
324 | #define MAX_INT16 ((INT16)0x7FFF)\r | |
325 | #define MAX_UINT16 ((UINT16)0xFFFF)\r | |
326 | #define MAX_INT32 ((INT32)0x7FFFFFFF)\r | |
327 | #define MAX_UINT32 ((UINT32)0xFFFFFFFF)\r | |
328 | #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)\r | |
329 | #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)\r | |
3963c4bf | 330 | \r |
d7a09cb8 SB |
331 | ///\r |
332 | /// Minimum values for the signed UEFI Data Types\r | |
333 | ///\r | |
334 | #define MIN_INT8 (((INT8) -127) - 1)\r | |
335 | #define MIN_INT16 (((INT16) -32767) - 1)\r | |
336 | #define MIN_INT32 (((INT32) -2147483647) - 1)\r | |
337 | #define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)\r | |
338 | \r | |
2f88bd3a MK |
339 | #define BIT0 0x00000001\r |
340 | #define BIT1 0x00000002\r | |
341 | #define BIT2 0x00000004\r | |
342 | #define BIT3 0x00000008\r | |
343 | #define BIT4 0x00000010\r | |
344 | #define BIT5 0x00000020\r | |
345 | #define BIT6 0x00000040\r | |
346 | #define BIT7 0x00000080\r | |
347 | #define BIT8 0x00000100\r | |
348 | #define BIT9 0x00000200\r | |
349 | #define BIT10 0x00000400\r | |
350 | #define BIT11 0x00000800\r | |
351 | #define BIT12 0x00001000\r | |
352 | #define BIT13 0x00002000\r | |
353 | #define BIT14 0x00004000\r | |
354 | #define BIT15 0x00008000\r | |
355 | #define BIT16 0x00010000\r | |
356 | #define BIT17 0x00020000\r | |
357 | #define BIT18 0x00040000\r | |
358 | #define BIT19 0x00080000\r | |
359 | #define BIT20 0x00100000\r | |
360 | #define BIT21 0x00200000\r | |
361 | #define BIT22 0x00400000\r | |
362 | #define BIT23 0x00800000\r | |
363 | #define BIT24 0x01000000\r | |
364 | #define BIT25 0x02000000\r | |
365 | #define BIT26 0x04000000\r | |
366 | #define BIT27 0x08000000\r | |
367 | #define BIT28 0x10000000\r | |
368 | #define BIT29 0x20000000\r | |
369 | #define BIT30 0x40000000\r | |
370 | #define BIT31 0x80000000\r | |
371 | #define BIT32 0x0000000100000000ULL\r | |
372 | #define BIT33 0x0000000200000000ULL\r | |
373 | #define BIT34 0x0000000400000000ULL\r | |
374 | #define BIT35 0x0000000800000000ULL\r | |
375 | #define BIT36 0x0000001000000000ULL\r | |
376 | #define BIT37 0x0000002000000000ULL\r | |
377 | #define BIT38 0x0000004000000000ULL\r | |
378 | #define BIT39 0x0000008000000000ULL\r | |
379 | #define BIT40 0x0000010000000000ULL\r | |
380 | #define BIT41 0x0000020000000000ULL\r | |
381 | #define BIT42 0x0000040000000000ULL\r | |
382 | #define BIT43 0x0000080000000000ULL\r | |
383 | #define BIT44 0x0000100000000000ULL\r | |
384 | #define BIT45 0x0000200000000000ULL\r | |
385 | #define BIT46 0x0000400000000000ULL\r | |
386 | #define BIT47 0x0000800000000000ULL\r | |
387 | #define BIT48 0x0001000000000000ULL\r | |
388 | #define BIT49 0x0002000000000000ULL\r | |
389 | #define BIT50 0x0004000000000000ULL\r | |
390 | #define BIT51 0x0008000000000000ULL\r | |
391 | #define BIT52 0x0010000000000000ULL\r | |
392 | #define BIT53 0x0020000000000000ULL\r | |
393 | #define BIT54 0x0040000000000000ULL\r | |
394 | #define BIT55 0x0080000000000000ULL\r | |
395 | #define BIT56 0x0100000000000000ULL\r | |
396 | #define BIT57 0x0200000000000000ULL\r | |
397 | #define BIT58 0x0400000000000000ULL\r | |
398 | #define BIT59 0x0800000000000000ULL\r | |
399 | #define BIT60 0x1000000000000000ULL\r | |
400 | #define BIT61 0x2000000000000000ULL\r | |
401 | #define BIT62 0x4000000000000000ULL\r | |
402 | #define BIT63 0x8000000000000000ULL\r | |
959ccb23 | 403 | \r |
2e121e9a | 404 | #define SIZE_1KB 0x00000400\r |
405 | #define SIZE_2KB 0x00000800\r | |
406 | #define SIZE_4KB 0x00001000\r | |
407 | #define SIZE_8KB 0x00002000\r | |
408 | #define SIZE_16KB 0x00004000\r | |
409 | #define SIZE_32KB 0x00008000\r | |
410 | #define SIZE_64KB 0x00010000\r | |
411 | #define SIZE_128KB 0x00020000\r | |
412 | #define SIZE_256KB 0x00040000\r | |
413 | #define SIZE_512KB 0x00080000\r | |
414 | #define SIZE_1MB 0x00100000\r | |
415 | #define SIZE_2MB 0x00200000\r | |
416 | #define SIZE_4MB 0x00400000\r | |
417 | #define SIZE_8MB 0x00800000\r | |
418 | #define SIZE_16MB 0x01000000\r | |
419 | #define SIZE_32MB 0x02000000\r | |
420 | #define SIZE_64MB 0x04000000\r | |
421 | #define SIZE_128MB 0x08000000\r | |
422 | #define SIZE_256MB 0x10000000\r | |
423 | #define SIZE_512MB 0x20000000\r | |
424 | #define SIZE_1GB 0x40000000\r | |
425 | #define SIZE_2GB 0x80000000\r | |
426 | #define SIZE_4GB 0x0000000100000000ULL\r | |
427 | #define SIZE_8GB 0x0000000200000000ULL\r | |
428 | #define SIZE_16GB 0x0000000400000000ULL\r | |
429 | #define SIZE_32GB 0x0000000800000000ULL\r | |
430 | #define SIZE_64GB 0x0000001000000000ULL\r | |
431 | #define SIZE_128GB 0x0000002000000000ULL\r | |
432 | #define SIZE_256GB 0x0000004000000000ULL\r | |
433 | #define SIZE_512GB 0x0000008000000000ULL\r | |
434 | #define SIZE_1TB 0x0000010000000000ULL\r | |
435 | #define SIZE_2TB 0x0000020000000000ULL\r | |
436 | #define SIZE_4TB 0x0000040000000000ULL\r | |
437 | #define SIZE_8TB 0x0000080000000000ULL\r | |
438 | #define SIZE_16TB 0x0000100000000000ULL\r | |
439 | #define SIZE_32TB 0x0000200000000000ULL\r | |
440 | #define SIZE_64TB 0x0000400000000000ULL\r | |
441 | #define SIZE_128TB 0x0000800000000000ULL\r | |
442 | #define SIZE_256TB 0x0001000000000000ULL\r | |
443 | #define SIZE_512TB 0x0002000000000000ULL\r | |
444 | #define SIZE_1PB 0x0004000000000000ULL\r | |
445 | #define SIZE_2PB 0x0008000000000000ULL\r | |
446 | #define SIZE_4PB 0x0010000000000000ULL\r | |
447 | #define SIZE_8PB 0x0020000000000000ULL\r | |
448 | #define SIZE_16PB 0x0040000000000000ULL\r | |
449 | #define SIZE_32PB 0x0080000000000000ULL\r | |
450 | #define SIZE_64PB 0x0100000000000000ULL\r | |
451 | #define SIZE_128PB 0x0200000000000000ULL\r | |
452 | #define SIZE_256PB 0x0400000000000000ULL\r | |
453 | #define SIZE_512PB 0x0800000000000000ULL\r | |
454 | #define SIZE_1EB 0x1000000000000000ULL\r | |
455 | #define SIZE_2EB 0x2000000000000000ULL\r | |
456 | #define SIZE_4EB 0x4000000000000000ULL\r | |
457 | #define SIZE_8EB 0x8000000000000000ULL\r | |
818ff8c2 | 458 | \r |
2e121e9a | 459 | #define BASE_1KB 0x00000400\r |
460 | #define BASE_2KB 0x00000800\r | |
461 | #define BASE_4KB 0x00001000\r | |
462 | #define BASE_8KB 0x00002000\r | |
463 | #define BASE_16KB 0x00004000\r | |
464 | #define BASE_32KB 0x00008000\r | |
465 | #define BASE_64KB 0x00010000\r | |
466 | #define BASE_128KB 0x00020000\r | |
467 | #define BASE_256KB 0x00040000\r | |
468 | #define BASE_512KB 0x00080000\r | |
469 | #define BASE_1MB 0x00100000\r | |
470 | #define BASE_2MB 0x00200000\r | |
471 | #define BASE_4MB 0x00400000\r | |
472 | #define BASE_8MB 0x00800000\r | |
473 | #define BASE_16MB 0x01000000\r | |
474 | #define BASE_32MB 0x02000000\r | |
475 | #define BASE_64MB 0x04000000\r | |
476 | #define BASE_128MB 0x08000000\r | |
477 | #define BASE_256MB 0x10000000\r | |
478 | #define BASE_512MB 0x20000000\r | |
479 | #define BASE_1GB 0x40000000\r | |
480 | #define BASE_2GB 0x80000000\r | |
481 | #define BASE_4GB 0x0000000100000000ULL\r | |
482 | #define BASE_8GB 0x0000000200000000ULL\r | |
483 | #define BASE_16GB 0x0000000400000000ULL\r | |
484 | #define BASE_32GB 0x0000000800000000ULL\r | |
485 | #define BASE_64GB 0x0000001000000000ULL\r | |
486 | #define BASE_128GB 0x0000002000000000ULL\r | |
487 | #define BASE_256GB 0x0000004000000000ULL\r | |
488 | #define BASE_512GB 0x0000008000000000ULL\r | |
489 | #define BASE_1TB 0x0000010000000000ULL\r | |
490 | #define BASE_2TB 0x0000020000000000ULL\r | |
491 | #define BASE_4TB 0x0000040000000000ULL\r | |
492 | #define BASE_8TB 0x0000080000000000ULL\r | |
493 | #define BASE_16TB 0x0000100000000000ULL\r | |
494 | #define BASE_32TB 0x0000200000000000ULL\r | |
495 | #define BASE_64TB 0x0000400000000000ULL\r | |
496 | #define BASE_128TB 0x0000800000000000ULL\r | |
497 | #define BASE_256TB 0x0001000000000000ULL\r | |
498 | #define BASE_512TB 0x0002000000000000ULL\r | |
499 | #define BASE_1PB 0x0004000000000000ULL\r | |
500 | #define BASE_2PB 0x0008000000000000ULL\r | |
501 | #define BASE_4PB 0x0010000000000000ULL\r | |
502 | #define BASE_8PB 0x0020000000000000ULL\r | |
503 | #define BASE_16PB 0x0040000000000000ULL\r | |
504 | #define BASE_32PB 0x0080000000000000ULL\r | |
505 | #define BASE_64PB 0x0100000000000000ULL\r | |
506 | #define BASE_128PB 0x0200000000000000ULL\r | |
507 | #define BASE_256PB 0x0400000000000000ULL\r | |
508 | #define BASE_512PB 0x0800000000000000ULL\r | |
509 | #define BASE_1EB 0x1000000000000000ULL\r | |
510 | #define BASE_2EB 0x2000000000000000ULL\r | |
511 | #define BASE_4EB 0x4000000000000000ULL\r | |
512 | #define BASE_8EB 0x8000000000000000ULL\r | |
513 | \r | |
959ccb23 | 514 | //\r |
e3e40c83 | 515 | // Support for variable argument lists in freestanding edk2 modules.\r |
818ff8c2 | 516 | //\r |
e3e40c83 Z |
517 | // For modules that use the ISO C library interfaces for variable\r |
518 | // argument lists, refer to "StdLib/Include/stdarg.h".\r | |
959ccb23 | 519 | //\r |
520 | // VA_LIST - typedef for argument list.\r | |
521 | // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r | |
522 | // VA_END (VA_LIST Marker) - Clear Marker\r | |
e3e40c83 Z |
523 | // VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from\r |
524 | // the ... list. You must know the type and pass it in this macro. Type\r | |
525 | // must be compatible with the type of the actual next argument (as promoted\r | |
526 | // according to the default argument promotions.)\r | |
265fa9fa | 527 | // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.\r |
959ccb23 | 528 | //\r |
e3e40c83 | 529 | // Example:\r |
959ccb23 | 530 | //\r |
531 | // UINTN\r | |
e3e40c83 | 532 | // EFIAPI\r |
959ccb23 | 533 | // ExampleVarArg (\r |
534 | // IN UINTN NumberOfArgs,\r | |
535 | // ...\r | |
536 | // )\r | |
537 | // {\r | |
538 | // VA_LIST Marker;\r | |
539 | // UINTN Index;\r | |
540 | // UINTN Result;\r | |
541 | //\r | |
542 | // //\r | |
543 | // // Initialize the Marker\r | |
544 | // //\r | |
545 | // VA_START (Marker, NumberOfArgs);\r | |
546 | // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r | |
547 | // //\r | |
e3e40c83 | 548 | // // The ... list is a series of UINTN values, so sum them up.\r |
959ccb23 | 549 | // //\r |
550 | // Result += VA_ARG (Marker, UINTN);\r | |
551 | // }\r | |
552 | //\r | |
553 | // VA_END (Marker);\r | |
e3e40c83 | 554 | // return Result;\r |
959ccb23 | 555 | // }\r |
556 | //\r | |
e3e40c83 Z |
557 | // Notes:\r |
558 | // - Functions that call VA_START() / VA_END() must have a variable\r | |
559 | // argument list and must be declared EFIAPI.\r | |
560 | // - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.\r | |
561 | // - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.\r | |
562 | //\r | |
0dcec411 | 563 | \r |
68167fed | 564 | /**\r |
565 | Return the size of argument that has been aligned to sizeof (UINTN).\r | |
566 | \r | |
af2dc6a7 | 567 | @param n The parameter size to be aligned.\r |
68167fed | 568 | \r |
af2dc6a7 | 569 | @return The aligned size.\r |
68167fed | 570 | **/\r |
2f88bd3a | 571 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r |
68167fed | 572 | \r |
48b919cb | 573 | #if defined (_M_ARM) || defined (_M_ARM64)\r |
79195517 PB |
574 | //\r |
575 | // MSFT ARM variable argument list support.\r | |
79195517 PB |
576 | //\r |
577 | \r | |
2f88bd3a | 578 | typedef char *VA_LIST;\r |
79195517 | 579 | \r |
2f88bd3a MK |
580 | #define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)\r |
581 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))\r | |
582 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r | |
583 | #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r | |
79195517 | 584 | \r |
2f88bd3a | 585 | #elif defined (__GNUC__) || defined (__clang__)\r |
48d5f9a5 | 586 | \r |
2f88bd3a | 587 | #if defined (MDE_CPU_X64) && !defined (NO_MSABI_VA_FUNCS)\r |
48d5f9a5 SS |
588 | //\r |
589 | // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.\r | |
590 | //\r | |
591 | ///\r | |
592 | /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI\r | |
593 | ///\r | |
594 | \r | |
595 | ///\r | |
596 | /// Variable used to traverse the list of arguments. This type can vary by\r | |
597 | /// implementation and could be an array or structure.\r | |
598 | ///\r | |
599 | typedef __builtin_ms_va_list VA_LIST;\r | |
600 | \r | |
601 | #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)\r | |
602 | \r | |
2f88bd3a | 603 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r |
48d5f9a5 | 604 | \r |
2f88bd3a | 605 | #define VA_END(Marker) __builtin_ms_va_end (Marker)\r |
48d5f9a5 | 606 | \r |
2f88bd3a | 607 | #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)\r |
48d5f9a5 | 608 | \r |
2f88bd3a | 609 | #else\r |
130a2eec | 610 | //\r |
1a2f870c | 611 | // Use GCC built-in macros for variable argument lists.\r |
130a2eec | 612 | //\r |
dda3a6ce | 613 | \r |
614 | ///\r | |
818ff8c2 | 615 | /// Variable used to traverse the list of arguments. This type can vary by\r |
616 | /// implementation and could be an array or structure.\r | |
dda3a6ce | 617 | ///\r |
130a2eec | 618 | typedef __builtin_va_list VA_LIST;\r |
619 | \r | |
6ed623e4 | 620 | #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)\r |
959ccb23 | 621 | \r |
2f88bd3a | 622 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r |
130a2eec | 623 | \r |
2f88bd3a | 624 | #define VA_END(Marker) __builtin_va_end (Marker)\r |
130a2eec | 625 | \r |
2f88bd3a | 626 | #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)\r |
265fa9fa | 627 | \r |
2f88bd3a | 628 | #endif\r |
48d5f9a5 | 629 | \r |
130a2eec | 630 | #else\r |
f4ec40ab | 631 | ///\r |
818ff8c2 | 632 | /// Variable used to traverse the list of arguments. This type can vary by\r |
633 | /// implementation and could be an array or structure.\r | |
f4ec40ab | 634 | ///\r |
959ccb23 | 635 | typedef CHAR8 *VA_LIST;\r |
959ccb23 | 636 | \r |
3963c4bf | 637 | /**\r |
818ff8c2 | 638 | Retrieves a pointer to the beginning of a variable argument list, based on\r |
639 | the name of the parameter that immediately precedes the variable argument list.\r | |
3963c4bf | 640 | \r |
818ff8c2 | 641 | This function initializes Marker to point to the beginning of the variable\r |
642 | argument list that immediately follows Parameter. The method for computing the\r | |
643 | pointer to the next argument in the argument list is CPU-specific following the\r | |
af2dc6a7 | 644 | EFIAPI ABI.\r |
3963c4bf | 645 | \r |
af2dc6a7 | 646 | @param Marker The VA_LIST used to traverse the list of arguments.\r |
818ff8c2 | 647 | @param Parameter The name of the parameter that immediately precedes\r |
3963c4bf | 648 | the variable argument list.\r |
818ff8c2 | 649 | \r |
3963c4bf | 650 | @return A pointer to the beginning of a variable argument list.\r |
651 | \r | |
652 | **/\r | |
2f88bd3a | 653 | #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r |
3963c4bf | 654 | \r |
655 | /**\r | |
818ff8c2 | 656 | Returns an argument of a specified type from a variable argument list and updates\r |
657 | the pointer to the variable argument list to point to the next argument.\r | |
3963c4bf | 658 | \r |
818ff8c2 | 659 | This function returns an argument of the type specified by TYPE from the beginning\r |
660 | of the variable argument list specified by Marker. Marker is then updated to point\r | |
661 | to the next argument in the variable argument list. The method for computing the\r | |
af2dc6a7 | 662 | pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r |
3963c4bf | 663 | \r |
dda3a6ce | 664 | @param Marker VA_LIST used to traverse the list of arguments.\r |
818ff8c2 | 665 | @param TYPE The type of argument to retrieve from the beginning\r |
3963c4bf | 666 | of the variable argument list.\r |
818ff8c2 | 667 | \r |
3963c4bf | 668 | @return An argument of the type specified by TYPE.\r |
669 | \r | |
670 | **/\r | |
2f88bd3a | 671 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r |
3963c4bf | 672 | \r |
673 | /**\r | |
674 | Terminates the use of a variable argument list.\r | |
675 | \r | |
818ff8c2 | 676 | This function initializes Marker so it can no longer be used with VA_ARG().\r |
677 | After this macro is used, the only way to access the variable argument list is\r | |
3963c4bf | 678 | by using VA_START() again.\r |
679 | \r | |
dda3a6ce | 680 | @param Marker VA_LIST used to traverse the list of arguments.\r |
818ff8c2 | 681 | \r |
3963c4bf | 682 | **/\r |
2f88bd3a | 683 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r |
3963c4bf | 684 | \r |
265fa9fa | 685 | /**\r |
686 | Initializes a VA_LIST as a copy of an existing VA_LIST.\r | |
687 | \r | |
688 | This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest\r | |
689 | followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach\r | |
9095d37b | 690 | the present state of Start.\r |
265fa9fa | 691 | \r |
692 | @param Dest VA_LIST used to traverse the list of arguments.\r | |
693 | @param Start VA_LIST used to traverse the list of arguments.\r | |
694 | \r | |
695 | **/\r | |
696 | #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r | |
697 | \r | |
130a2eec | 698 | #endif\r |
699 | \r | |
68167fed | 700 | ///\r |
701 | /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.\r | |
702 | ///\r | |
2f88bd3a | 703 | typedef UINTN *BASE_LIST;\r |
68167fed | 704 | \r |
2229029a | 705 | /**\r |
706 | Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.\r | |
707 | \r | |
708 | @param TYPE The date type to determine the size of.\r | |
709 | \r | |
710 | @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.\r | |
711 | **/\r | |
2f88bd3a | 712 | #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\r |
2229029a | 713 | \r |
68167fed | 714 | /**\r |
818ff8c2 | 715 | Returns an argument of a specified type from a variable argument list and updates\r |
716 | the pointer to the variable argument list to point to the next argument.\r | |
68167fed | 717 | \r |
818ff8c2 | 718 | This function returns an argument of the type specified by TYPE from the beginning\r |
719 | of the variable argument list specified by Marker. Marker is then updated to point\r | |
720 | to the next argument in the variable argument list. The method for computing the\r | |
68167fed | 721 | pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r |
722 | \r | |
af2dc6a7 | 723 | @param Marker The pointer to the beginning of a variable argument list.\r |
818ff8c2 | 724 | @param TYPE The type of argument to retrieve from the beginning\r |
68167fed | 725 | of the variable argument list.\r |
818ff8c2 | 726 | \r |
68167fed | 727 | @return An argument of the type specified by TYPE.\r |
728 | \r | |
729 | **/\r | |
2f88bd3a | 730 | #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r |
68167fed | 731 | \r |
3963c4bf | 732 | /**\r |
818ff8c2 | 733 | The macro that returns the byte offset of a field in a data structure.\r |
3963c4bf | 734 | \r |
818ff8c2 | 735 | This function returns the offset, in bytes, of field specified by Field from the\r |
736 | beginning of the data structure specified by TYPE. If TYPE does not contain Field,\r | |
737 | the module will not compile.\r | |
3963c4bf | 738 | \r |
818ff8c2 | 739 | @param TYPE The name of the data structure that contains the field specified by Field.\r |
3963c4bf | 740 | @param Field The name of the field in the data structure.\r |
818ff8c2 | 741 | \r |
3963c4bf | 742 | @return Offset, in bytes, of field.\r |
818ff8c2 | 743 | \r |
3963c4bf | 744 | **/\r |
2f88bd3a MK |
745 | #if (defined (__GNUC__) && __GNUC__ >= 4) || defined (__clang__)\r |
746 | #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))\r | |
818ff8c2 | 747 | #endif\r |
818ff8c2 | 748 | \r |
749 | #ifndef OFFSET_OF\r | |
2f88bd3a | 750 | #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r |
818ff8c2 | 751 | #endif\r |
959ccb23 | 752 | \r |
204ae9da VC |
753 | /**\r |
754 | Portable definition for compile time assertions.\r | |
755 | Equivalent to C11 static_assert macro from assert.h.\r | |
756 | \r | |
757 | @param Expression Boolean expression.\r | |
758 | @param Message Raised compiler diagnostic message when expression is false.\r | |
759 | \r | |
760 | **/\r | |
a3596a04 | 761 | #ifdef MDE_CPU_EBC\r |
2f88bd3a MK |
762 | #define STATIC_ASSERT(Expression, Message)\r |
763 | #elif defined (_MSC_EXTENSIONS)\r | |
764 | #define STATIC_ASSERT static_assert\r | |
204ae9da | 765 | #else\r |
2f88bd3a | 766 | #define STATIC_ASSERT _Static_assert\r |
204ae9da VC |
767 | #endif\r |
768 | \r | |
b03fb410 VC |
769 | //\r |
770 | // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with\r | |
771 | // Section 2.3.1 of the UEFI 2.3 Specification.\r | |
772 | //\r | |
773 | \r | |
774 | STATIC_ASSERT (sizeof (BOOLEAN) == 1, "sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements");\r | |
775 | STATIC_ASSERT (sizeof (INT8) == 1, "sizeof (INT8) does not meet UEFI Specification Data Type requirements");\r | |
776 | STATIC_ASSERT (sizeof (UINT8) == 1, "sizeof (UINT8) does not meet UEFI Specification Data Type requirements");\r | |
777 | STATIC_ASSERT (sizeof (INT16) == 2, "sizeof (INT16) does not meet UEFI Specification Data Type requirements");\r | |
778 | STATIC_ASSERT (sizeof (UINT16) == 2, "sizeof (UINT16) does not meet UEFI Specification Data Type requirements");\r | |
779 | STATIC_ASSERT (sizeof (INT32) == 4, "sizeof (INT32) does not meet UEFI Specification Data Type requirements");\r | |
780 | STATIC_ASSERT (sizeof (UINT32) == 4, "sizeof (UINT32) does not meet UEFI Specification Data Type requirements");\r | |
781 | STATIC_ASSERT (sizeof (INT64) == 8, "sizeof (INT64) does not meet UEFI Specification Data Type requirements");\r | |
782 | STATIC_ASSERT (sizeof (UINT64) == 8, "sizeof (UINT64) does not meet UEFI Specification Data Type requirements");\r | |
783 | STATIC_ASSERT (sizeof (CHAR8) == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");\r | |
784 | STATIC_ASSERT (sizeof (CHAR16) == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");\r | |
ad1009ec MK |
785 | STATIC_ASSERT (sizeof (L'A') == 2, "sizeof (L'A') does not meet UEFI Specification Data Type requirements");\r |
786 | STATIC_ASSERT (sizeof (L"A") == 4, "sizeof (L\"A\") does not meet UEFI Specification Data Type requirements");\r | |
b03fb410 VC |
787 | \r |
788 | //\r | |
789 | // The following three enum types are used to verify that the compiler\r | |
790 | // configuration for enum types is compliant with Section 2.3.1 of the\r | |
791 | // UEFI 2.3 Specification. These enum types and enum values are not\r | |
792 | // intended to be used. A prefix of '__' is used avoid conflicts with\r | |
793 | // other types.\r | |
794 | //\r | |
795 | typedef enum {\r | |
796 | __VerifyUint8EnumValue = 0xff\r | |
797 | } __VERIFY_UINT8_ENUM_SIZE;\r | |
798 | \r | |
799 | typedef enum {\r | |
800 | __VerifyUint16EnumValue = 0xffff\r | |
801 | } __VERIFY_UINT16_ENUM_SIZE;\r | |
802 | \r | |
803 | typedef enum {\r | |
804 | __VerifyUint32EnumValue = 0xffffffff\r | |
805 | } __VERIFY_UINT32_ENUM_SIZE;\r | |
806 | \r | |
807 | STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r | |
808 | STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r | |
809 | STATIC_ASSERT (sizeof (__VERIFY_UINT32_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r | |
810 | \r | |
3963c4bf | 811 | /**\r |
818ff8c2 | 812 | Macro that returns a pointer to the data structure that contains a specified field of\r |
813 | that data structure. This is a lightweight method to hide information by placing a\r | |
814 | public data structure inside a larger private data structure and using a pointer to\r | |
3963c4bf | 815 | the public data structure to retrieve a pointer to the private data structure.\r |
816 | \r | |
818ff8c2 | 817 | This function computes the offset, in bytes, of field specified by Field from the beginning\r |
818 | of the data structure specified by TYPE. This offset is subtracted from Record, and is\r | |
819 | used to return a pointer to a data structure of the type specified by TYPE. If the data type\r | |
820 | specified by TYPE does not contain the field specified by Field, then the module will not compile.\r | |
821 | \r | |
822 | @param Record Pointer to the field specified by Field within a data structure of type TYPE.\r | |
823 | @param TYPE The name of the data structure type to return. This data structure must\r | |
824 | contain the field specified by Field.\r | |
3963c4bf | 825 | @param Field The name of the field in the data structure specified by TYPE to which Record points.\r |
818ff8c2 | 826 | \r |
3963c4bf | 827 | @return A pointer to the structure from one of it's elements.\r |
818ff8c2 | 828 | \r |
3963c4bf | 829 | **/\r |
498cb29d | 830 | #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))\r |
959ccb23 | 831 | \r |
3963c4bf | 832 | /**\r |
818ff8c2 | 833 | Rounds a value up to the next boundary using a specified alignment.\r |
3963c4bf | 834 | \r |
818ff8c2 | 835 | This function rounds Value up to the next boundary using the specified Alignment.\r |
836 | This aligned value is returned.\r | |
3963c4bf | 837 | \r |
838 | @param Value The value to round up.\r | |
839 | @param Alignment The alignment boundary used to return the aligned value.\r | |
818ff8c2 | 840 | \r |
3963c4bf | 841 | @return A value up to the next boundary.\r |
818ff8c2 | 842 | \r |
3963c4bf | 843 | **/\r |
2f88bd3a | 844 | #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r |
3fef0f51 | 845 | \r |
3963c4bf | 846 | /**\r |
818ff8c2 | 847 | Adjust a pointer by adding the minimum offset required for it to be aligned on\r |
848 | a specified alignment boundary.\r | |
3963c4bf | 849 | \r |
818ff8c2 | 850 | This function rounds the pointer specified by Pointer to the next alignment boundary\r |
851 | specified by Alignment. The pointer to the aligned address is returned.\r | |
3963c4bf | 852 | \r |
f754f721 | 853 | @param Pointer The pointer to round up.\r |
3963c4bf | 854 | @param Alignment The alignment boundary to use to return an aligned pointer.\r |
818ff8c2 | 855 | \r |
3963c4bf | 856 | @return Pointer to the aligned address.\r |
818ff8c2 | 857 | \r |
3963c4bf | 858 | **/\r |
2f88bd3a | 859 | #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r |
959ccb23 | 860 | \r |
3963c4bf | 861 | /**\r |
818ff8c2 | 862 | Rounds a value up to the next natural boundary for the current CPU.\r |
863 | This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.\r | |
3963c4bf | 864 | \r |
818ff8c2 | 865 | This function rounds the value specified by Value up to the next natural boundary for the\r |
866 | current CPU. This rounded value is returned.\r | |
3963c4bf | 867 | \r |
868 | @param Value The value to round up.\r | |
869 | \r | |
870 | @return Rounded value specified by Value.\r | |
818ff8c2 | 871 | \r |
3963c4bf | 872 | **/\r |
3fef0f51 | 873 | #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r |
818ff8c2 | 874 | \r |
3963c4bf | 875 | /**\r |
818ff8c2 | 876 | Return the maximum of two operands.\r |
3963c4bf | 877 | \r |
818ff8c2 | 878 | This macro returns the maximum of two operand specified by a and b.\r |
3963c4bf | 879 | Both a and b must be the same numerical types, signed or unsigned.\r |
880 | \r | |
3963c4bf | 881 | @param a The first operand with any numerical type.\r |
818ff8c2 | 882 | @param b The second operand. Can be any numerical type as long as is\r |
a89fa50c | 883 | the same type as a.\r |
818ff8c2 | 884 | \r |
3963c4bf | 885 | @return Maximum of two operands.\r |
818ff8c2 | 886 | \r |
3963c4bf | 887 | **/\r |
959ccb23 | 888 | #define MAX(a, b) \\r |
889 | (((a) > (b)) ? (a) : (b))\r | |
890 | \r | |
3963c4bf | 891 | /**\r |
818ff8c2 | 892 | Return the minimum of two operands.\r |
3963c4bf | 893 | \r |
818ff8c2 | 894 | This macro returns the minimal of two operand specified by a and b.\r |
3963c4bf | 895 | Both a and b must be the same numerical types, signed or unsigned.\r |
896 | \r | |
3963c4bf | 897 | @param a The first operand with any numerical type.\r |
898 | @param b The second operand. It should be the same any numerical type with a.\r | |
818ff8c2 | 899 | \r |
3963c4bf | 900 | @return Minimum of two operands.\r |
818ff8c2 | 901 | \r |
3963c4bf | 902 | **/\r |
959ccb23 | 903 | #define MIN(a, b) \\r |
904 | (((a) < (b)) ? (a) : (b))\r | |
905 | \r | |
8b157410 | 906 | /**\r |
907 | Return the absolute value of a signed operand.\r | |
908 | \r | |
909 | This macro returns the absolute value of the signed operand specified by a.\r | |
910 | \r | |
911 | @param a The signed operand.\r | |
912 | \r | |
913 | @return The absolute value of the signed operand.\r | |
914 | \r | |
915 | **/\r | |
916 | #define ABS(a) \\r | |
917 | (((a) < 0) ? (-(a)) : (a))\r | |
918 | \r | |
959ccb23 | 919 | //\r |
f4ec40ab | 920 | // Status codes common to all execution phases\r |
959ccb23 | 921 | //\r |
6f906c39 | 922 | typedef UINTN RETURN_STATUS;\r |
959ccb23 | 923 | \r |
f4ec40ab | 924 | /**\r |
818ff8c2 | 925 | Produces a RETURN_STATUS code with the highest bit set.\r |
959ccb23 | 926 | \r |
818ff8c2 | 927 | @param StatusCode The status code value to convert into a warning code.\r |
f4ec40ab | 928 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
929 | \r | |
930 | @return The value specified by StatusCode with the highest bit set.\r | |
931 | \r | |
932 | **/\r | |
2f88bd3a | 933 | #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r |
959ccb23 | 934 | \r |
f4ec40ab | 935 | /**\r |
818ff8c2 | 936 | Produces a RETURN_STATUS code with the highest bit clear.\r |
f4ec40ab | 937 | \r |
818ff8c2 | 938 | @param StatusCode The status code value to convert into a warning code.\r |
f4ec40ab | 939 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
940 | \r | |
941 | @return The value specified by StatusCode with the highest bit clear.\r | |
942 | \r | |
943 | **/\r | |
2f88bd3a | 944 | #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))\r |
f4ec40ab | 945 | \r |
946 | /**\r | |
818ff8c2 | 947 | Returns TRUE if a specified RETURN_STATUS code is an error code.\r |
948 | \r | |
949 | This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.\r | |
f4ec40ab | 950 | \r |
40731047 | 951 | @param StatusCode The status code value to evaluate.\r |
f4ec40ab | 952 | \r |
953 | @retval TRUE The high bit of StatusCode is set.\r | |
954 | @retval FALSE The high bit of StatusCode is clear.\r | |
955 | \r | |
956 | **/\r | |
2f88bd3a | 957 | #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)\r |
f4ec40ab | 958 | \r |
959 | ///\r | |
960 | /// The operation completed successfully.\r | |
961 | ///\r | |
2f88bd3a | 962 | #define RETURN_SUCCESS 0\r |
f4ec40ab | 963 | \r |
964 | ///\r | |
965 | /// The image failed to load.\r | |
966 | ///\r | |
2f88bd3a | 967 | #define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r |
f4ec40ab | 968 | \r |
969 | ///\r | |
970 | /// The parameter was incorrect.\r | |
971 | ///\r | |
2f88bd3a | 972 | #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r |
f4ec40ab | 973 | \r |
974 | ///\r | |
975 | /// The operation is not supported.\r | |
976 | ///\r | |
2f88bd3a | 977 | #define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r |
f4ec40ab | 978 | \r |
979 | ///\r | |
980 | /// The buffer was not the proper size for the request.\r | |
981 | ///\r | |
2f88bd3a | 982 | #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r |
f4ec40ab | 983 | \r |
984 | ///\r | |
985 | /// The buffer was not large enough to hold the requested data.\r | |
986 | /// The required buffer size is returned in the appropriate\r | |
987 | /// parameter when this error occurs.\r | |
988 | ///\r | |
2f88bd3a | 989 | #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r |
f4ec40ab | 990 | \r |
991 | ///\r | |
80619162 | 992 | /// There is no data pending upon return.\r |
f4ec40ab | 993 | ///\r |
2f88bd3a | 994 | #define RETURN_NOT_READY ENCODE_ERROR (6)\r |
f4ec40ab | 995 | \r |
996 | ///\r | |
997 | /// The physical device reported an error while attempting the\r | |
998 | /// operation.\r | |
999 | ///\r | |
2f88bd3a | 1000 | #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r |
f4ec40ab | 1001 | \r |
1002 | ///\r | |
1003 | /// The device can not be written to.\r | |
1004 | ///\r | |
2f88bd3a | 1005 | #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r |
f4ec40ab | 1006 | \r |
1007 | ///\r | |
1008 | /// The resource has run out.\r | |
1009 | ///\r | |
2f88bd3a | 1010 | #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r |
f4ec40ab | 1011 | \r |
1012 | ///\r | |
818ff8c2 | 1013 | /// An inconsistency was detected on the file system causing the\r |
f4ec40ab | 1014 | /// operation to fail.\r |
1015 | ///\r | |
2f88bd3a | 1016 | #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r |
f4ec40ab | 1017 | \r |
1018 | ///\r | |
1019 | /// There is no more space on the file system.\r | |
1020 | ///\r | |
2f88bd3a | 1021 | #define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r |
f4ec40ab | 1022 | \r |
1023 | ///\r | |
818ff8c2 | 1024 | /// The device does not contain any medium to perform the\r |
f4ec40ab | 1025 | /// operation.\r |
1026 | ///\r | |
2f88bd3a | 1027 | #define RETURN_NO_MEDIA ENCODE_ERROR (12)\r |
f4ec40ab | 1028 | \r |
1029 | ///\r | |
1030 | /// The medium in the device has changed since the last\r | |
1031 | /// access.\r | |
1032 | ///\r | |
2f88bd3a | 1033 | #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r |
f4ec40ab | 1034 | \r |
1035 | ///\r | |
1036 | /// The item was not found.\r | |
1037 | ///\r | |
2f88bd3a | 1038 | #define RETURN_NOT_FOUND ENCODE_ERROR (14)\r |
f4ec40ab | 1039 | \r |
1040 | ///\r | |
1041 | /// Access was denied.\r | |
1042 | ///\r | |
2f88bd3a | 1043 | #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r |
f4ec40ab | 1044 | \r |
1045 | ///\r | |
1046 | /// The server was not found or did not respond to the request.\r | |
1047 | ///\r | |
2f88bd3a | 1048 | #define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r |
f4ec40ab | 1049 | \r |
1050 | ///\r | |
1051 | /// A mapping to the device does not exist.\r | |
1052 | ///\r | |
2f88bd3a | 1053 | #define RETURN_NO_MAPPING ENCODE_ERROR (17)\r |
f4ec40ab | 1054 | \r |
1055 | ///\r | |
1056 | /// A timeout time expired.\r | |
1057 | ///\r | |
2f88bd3a | 1058 | #define RETURN_TIMEOUT ENCODE_ERROR (18)\r |
f4ec40ab | 1059 | \r |
1060 | ///\r | |
1061 | /// The protocol has not been started.\r | |
1062 | ///\r | |
2f88bd3a | 1063 | #define RETURN_NOT_STARTED ENCODE_ERROR (19)\r |
f4ec40ab | 1064 | \r |
1065 | ///\r | |
1066 | /// The protocol has already been started.\r | |
1067 | ///\r | |
2f88bd3a | 1068 | #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r |
f4ec40ab | 1069 | \r |
1070 | ///\r | |
1071 | /// The operation was aborted.\r | |
1072 | ///\r | |
2f88bd3a | 1073 | #define RETURN_ABORTED ENCODE_ERROR (21)\r |
f4ec40ab | 1074 | \r |
1075 | ///\r | |
727501bb | 1076 | /// An ICMP error occurred during the network operation.\r |
f4ec40ab | 1077 | ///\r |
2f88bd3a | 1078 | #define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r |
f4ec40ab | 1079 | \r |
1080 | ///\r | |
727501bb | 1081 | /// A TFTP error occurred during the network operation.\r |
f4ec40ab | 1082 | ///\r |
2f88bd3a | 1083 | #define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r |
f4ec40ab | 1084 | \r |
1085 | ///\r | |
727501bb | 1086 | /// A protocol error occurred during the network operation.\r |
f4ec40ab | 1087 | ///\r |
2f88bd3a | 1088 | #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r |
f4ec40ab | 1089 | \r |
1090 | ///\r | |
1091 | /// A function encountered an internal version that was\r | |
727501bb | 1092 | /// incompatible with a version requested by the caller.\r |
f4ec40ab | 1093 | ///\r |
959ccb23 | 1094 | #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r |
f4ec40ab | 1095 | \r |
1096 | ///\r | |
1097 | /// The function was not performed due to a security violation.\r | |
1098 | ///\r | |
2f88bd3a | 1099 | #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r |
f4ec40ab | 1100 | \r |
1101 | ///\r | |
1102 | /// A CRC error was detected.\r | |
1103 | ///\r | |
2f88bd3a | 1104 | #define RETURN_CRC_ERROR ENCODE_ERROR (27)\r |
f4ec40ab | 1105 | \r |
1106 | ///\r | |
af2dc6a7 | 1107 | /// The beginning or end of media was reached.\r |
f4ec40ab | 1108 | ///\r |
2f88bd3a | 1109 | #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r |
f4ec40ab | 1110 | \r |
1111 | ///\r | |
1112 | /// The end of the file was reached.\r | |
1113 | ///\r | |
2f88bd3a | 1114 | #define RETURN_END_OF_FILE ENCODE_ERROR (31)\r |
f4ec40ab | 1115 | \r |
1116 | ///\r | |
1117 | /// The language specified was invalid.\r | |
1118 | ///\r | |
2f88bd3a | 1119 | #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r |
54cf8780 | 1120 | \r |
76336e4e SZ |
1121 | ///\r |
1122 | /// The security status of the data is unknown or compromised\r | |
1123 | /// and the data must be updated or replaced to restore a valid\r | |
1124 | /// security status.\r | |
1125 | ///\r | |
2f88bd3a | 1126 | #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)\r |
959ccb23 | 1127 | \r |
10a3840f ZL |
1128 | ///\r |
1129 | /// A HTTP error occurred during the network operation.\r | |
1130 | ///\r | |
2f88bd3a | 1131 | #define RETURN_HTTP_ERROR ENCODE_ERROR (35)\r |
10a3840f | 1132 | \r |
f4ec40ab | 1133 | ///\r |
fbf926ad | 1134 | /// The string contained one or more characters that\r |
f4ec40ab | 1135 | /// the device could not render and were skipped.\r |
1136 | ///\r | |
2f88bd3a | 1137 | #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r |
f4ec40ab | 1138 | \r |
1139 | ///\r | |
1140 | /// The handle was closed, but the file was not deleted.\r | |
1141 | ///\r | |
2f88bd3a | 1142 | #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r |
f4ec40ab | 1143 | \r |
1144 | ///\r | |
1145 | /// The handle was closed, but the data to the file was not\r | |
1146 | /// flushed properly.\r | |
1147 | ///\r | |
2f88bd3a | 1148 | #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r |
f4ec40ab | 1149 | \r |
1150 | ///\r | |
818ff8c2 | 1151 | /// The resulting buffer was too small, and the data was\r |
f4ec40ab | 1152 | /// truncated to the buffer size.\r |
1153 | ///\r | |
2f88bd3a | 1154 | #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r |
959ccb23 | 1155 | \r |
76336e4e SZ |
1156 | ///\r |
1157 | /// The data has not been updated within the timeframe set by\r | |
1158 | /// local policy for this type of data.\r | |
1159 | ///\r | |
2f88bd3a | 1160 | #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)\r |
76336e4e | 1161 | \r |
fed5f447 FS |
1162 | ///\r |
1163 | /// The resulting buffer contains UEFI-compliant file system.\r | |
1164 | ///\r | |
2f88bd3a | 1165 | #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)\r |
fed5f447 | 1166 | \r |
a7cc3d26 | 1167 | /**\r |
1168 | Returns a 16-bit signature built from 2 ASCII characters.\r | |
818ff8c2 | 1169 | \r |
1170 | This macro returns a 16-bit value built from the two ASCII characters specified\r | |
3963c4bf | 1171 | by A and B.\r |
818ff8c2 | 1172 | \r |
ee6c452c | 1173 | @param A The first ASCII character.\r |
1174 | @param B The second ASCII character.\r | |
a7cc3d26 | 1175 | \r |
1176 | @return A 16-bit value built from the two ASCII characters specified by A and B.\r | |
1177 | \r | |
1178 | **/\r | |
2f88bd3a | 1179 | #define SIGNATURE_16(A, B) ((A) | (B << 8))\r |
a7cc3d26 | 1180 | \r |
1181 | /**\r | |
1182 | Returns a 32-bit signature built from 4 ASCII characters.\r | |
818ff8c2 | 1183 | \r |
1184 | This macro returns a 32-bit value built from the four ASCII characters specified\r | |
3963c4bf | 1185 | by A, B, C, and D.\r |
818ff8c2 | 1186 | \r |
ee6c452c | 1187 | @param A The first ASCII character.\r |
1188 | @param B The second ASCII character.\r | |
1189 | @param C The third ASCII character.\r | |
1190 | @param D The fourth ASCII character.\r | |
a7cc3d26 | 1191 | \r |
1192 | @return A 32-bit value built from the two ASCII characters specified by A, B,\r | |
1193 | C and D.\r | |
1194 | \r | |
1195 | **/\r | |
13c31065 | 1196 | #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r |
a7cc3d26 | 1197 | \r |
1198 | /**\r | |
1199 | Returns a 64-bit signature built from 8 ASCII characters.\r | |
818ff8c2 | 1200 | \r |
1201 | This macro returns a 64-bit value built from the eight ASCII characters specified\r | |
3963c4bf | 1202 | by A, B, C, D, E, F, G,and H.\r |
818ff8c2 | 1203 | \r |
ee6c452c | 1204 | @param A The first ASCII character.\r |
1205 | @param B The second ASCII character.\r | |
1206 | @param C The third ASCII character.\r | |
1207 | @param D The fourth ASCII character.\r | |
1208 | @param E The fifth ASCII character.\r | |
1209 | @param F The sixth ASCII character.\r | |
1210 | @param G The seventh ASCII character.\r | |
1211 | @param H The eighth ASCII character.\r | |
a7cc3d26 | 1212 | \r |
1213 | @return A 64-bit value built from the two ASCII characters specified by A, B,\r | |
1214 | C, D, E, F, G and H.\r | |
1215 | \r | |
1216 | **/\r | |
13c31065 | 1217 | #define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r |
1218 | (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r | |
1219 | \r | |
2f88bd3a MK |
1220 | #if defined (_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)\r |
1221 | void *\r | |
1222 | _ReturnAddress (\r | |
1223 | void\r | |
1224 | );\r | |
1225 | \r | |
dad83a8c | 1226 | #pragma intrinsic(_ReturnAddress)\r |
1db55d6a | 1227 | \r |
2f88bd3a MK |
1228 | /**\r |
1229 | Get the return address of the calling function.\r | |
1230 | \r | |
1231 | Based on intrinsic function _ReturnAddress that provides the address of\r | |
1232 | the instruction in the calling function that will be executed after\r | |
1233 | control returns to the caller.\r | |
1db55d6a | 1234 | \r |
2f88bd3a | 1235 | @param L Return Level.\r |
1db55d6a | 1236 | \r |
2f88bd3a | 1237 | @return The return address of the calling function or 0 if L != 0.\r |
1db55d6a | 1238 | \r |
2f88bd3a MK |
1239 | **/\r |
1240 | #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)\r | |
70bebafd | 1241 | #elif defined (__GNUC__) || defined (__clang__)\r |
1db55d6a | 1242 | \r |
2f88bd3a MK |
1243 | /**\r |
1244 | Get the return address of the calling function.\r | |
1245 | \r | |
1246 | Based on built-in Function __builtin_return_address that returns\r | |
1247 | the return address of the current function, or of one of its callers.\r | |
1db55d6a | 1248 | \r |
2f88bd3a | 1249 | @param L Return Level.\r |
1db55d6a | 1250 | \r |
2f88bd3a | 1251 | @return The return address of the calling function.\r |
1db55d6a | 1252 | \r |
2f88bd3a MK |
1253 | **/\r |
1254 | #define RETURN_ADDRESS(L) __builtin_return_address (L)\r | |
dad83a8c | 1255 | #else\r |
1db55d6a | 1256 | \r |
2f88bd3a MK |
1257 | /**\r |
1258 | Get the return address of the calling function.\r | |
1db55d6a | 1259 | \r |
2f88bd3a | 1260 | @param L Return Level.\r |
1db55d6a | 1261 | \r |
2f88bd3a MK |
1262 | @return 0 as compilers don't support this feature.\r |
1263 | \r | |
1264 | **/\r | |
1265 | #define RETURN_ADDRESS(L) ((VOID *) 0)\r | |
dad83a8c SZ |
1266 | #endif\r |
1267 | \r | |
c3ead528 LE |
1268 | /**\r |
1269 | Return the number of elements in an array.\r | |
1270 | \r | |
1271 | @param Array An object of array type. Array is only used as an argument to\r | |
1272 | the sizeof operator, therefore Array is never evaluated. The\r | |
1273 | caller is responsible for ensuring that Array's type is not\r | |
1274 | incomplete; that is, Array must have known constant size.\r | |
1275 | \r | |
1276 | @return The number of elements in Array. The result has type UINTN.\r | |
1277 | \r | |
1278 | **/\r | |
2f88bd3a | 1279 | #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))\r |
c3ead528 | 1280 | \r |
959ccb23 | 1281 | #endif\r |