MdePkg: Update Base.h to fix compilation issues with ICC.
[mirror_edk2.git] / MdePkg / Include / Base.h
1 /** @file
2 Root include file for Mde Package Base type modules
3
4 This is the include file for any module of type base. Base modules only use
5 types defined via this include file and can be ported easily to any
6 environment. There are a set of base libraries in the Mde Package that can
7 be used to implement base modules.
8
9 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
10 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
11 This program and the accompanying materials
12 are licensed and made available under the terms and conditions of the BSD License
13 which accompanies this distribution. The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php.
15
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18
19 **/
20
21
22 #ifndef __BASE_H__
23 #define __BASE_H__
24
25 //
26 // Include processor specific binding
27 //
28 #include <ProcessorBind.h>
29
30 #if defined(_MSC_EXTENSIONS)
31 //
32 // Disable warning when last field of data structure is a zero sized array.
33 //
34 #pragma warning ( disable : 4200 )
35 #endif
36
37 /**
38 Verifies the storage size of a given data type.
39
40 This macro generates a divide by zero error or a zero size array declaration in
41 the preprocessor if the size is incorrect. These are declared as "extern" so
42 the space for these arrays will not be in the modules.
43
44 @param TYPE The date type to determine the size of.
45 @param Size The expected size for the TYPE.
46
47 **/
48 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
49
50 //
51 // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
52 // Section 2.3.1 of the UEFI 2.3 Specification.
53 //
54 VERIFY_SIZE_OF (BOOLEAN, 1);
55 VERIFY_SIZE_OF (INT8, 1);
56 VERIFY_SIZE_OF (UINT8, 1);
57 VERIFY_SIZE_OF (INT16, 2);
58 VERIFY_SIZE_OF (UINT16, 2);
59 VERIFY_SIZE_OF (INT32, 4);
60 VERIFY_SIZE_OF (UINT32, 4);
61 VERIFY_SIZE_OF (INT64, 8);
62 VERIFY_SIZE_OF (UINT64, 8);
63 VERIFY_SIZE_OF (CHAR8, 1);
64 VERIFY_SIZE_OF (CHAR16, 2);
65
66 //
67 // The Microsoft* C compiler can removed references to unreferenced data items
68 // if the /OPT:REF linker option is used. We defined a macro as this is a
69 // a non standard extension
70 //
71 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
72 ///
73 /// Remove global variable from the linked image if there are no references to
74 /// it after all compiler and linker optimizations have been performed.
75 ///
76 ///
77 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
78 #else
79 ///
80 /// Remove the global variable from the linked image if there are no references
81 /// to it after all compiler and linker optimizations have been performed.
82 ///
83 ///
84 #define GLOBAL_REMOVE_IF_UNREFERENCED
85 #endif
86
87 //
88 // For symbol name in assembly code, an extra "_" is sometimes necessary
89 //
90
91 ///
92 /// Private worker functions for ASM_PFX()
93 ///
94 #define _CONCATENATE(a, b) __CONCATENATE(a, b)
95 #define __CONCATENATE(a, b) a ## b
96
97 ///
98 /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
99 /// on symbols in assembly language.
100 ///
101 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
102
103 #if __APPLE__
104 //
105 // Apple extension that is used by the linker to optimize code size
106 // with assembly functions. Put at the end of your .S files
107 //
108 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
109 #else
110 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
111 #endif
112
113 #ifdef __CC_ARM
114 //
115 // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
116 // as a prefix for the structure.
117 //
118 #define PACKED __packed
119 #else
120 #define PACKED
121 #endif
122
123 ///
124 /// 128 bit buffer containing a unique identifier value.
125 /// Unless otherwise specified, aligned on a 64 bit boundary.
126 ///
127 typedef struct {
128 UINT32 Data1;
129 UINT16 Data2;
130 UINT16 Data3;
131 UINT8 Data4[8];
132 } GUID;
133
134 //
135 // 8-bytes unsigned value that represents a physical system address.
136 //
137 typedef UINT64 PHYSICAL_ADDRESS;
138
139 ///
140 /// LIST_ENTRY structure definition.
141 ///
142 typedef struct _LIST_ENTRY LIST_ENTRY;
143
144 ///
145 /// _LIST_ENTRY structure definition.
146 ///
147 struct _LIST_ENTRY {
148 LIST_ENTRY *ForwardLink;
149 LIST_ENTRY *BackLink;
150 };
151
152 //
153 // Modifiers to abstract standard types to aid in debug of problems
154 //
155
156 ///
157 /// Datum is read-only.
158 ///
159 #define CONST const
160
161 ///
162 /// Datum is scoped to the current file or function.
163 ///
164 #define STATIC static
165
166 ///
167 /// Undeclared type.
168 ///
169 #define VOID void
170
171 //
172 // Modifiers for Data Types used to self document code.
173 // This concept is borrowed for UEFI specification.
174 //
175
176 ///
177 /// Datum is passed to the function.
178 ///
179 #define IN
180
181 ///
182 /// Datum is returned from the function.
183 ///
184 #define OUT
185
186 ///
187 /// Passing the datum to the function is optional, and a NULL
188 /// is passed if the value is not supplied.
189 ///
190 #define OPTIONAL
191
192 //
193 // UEFI specification claims 1 and 0. We are concerned about the
194 // complier portability so we did it this way.
195 //
196
197 ///
198 /// Boolean true value. UEFI Specification defines this value to be 1,
199 /// but this form is more portable.
200 ///
201 #define TRUE ((BOOLEAN)(1==1))
202
203 ///
204 /// Boolean false value. UEFI Specification defines this value to be 0,
205 /// but this form is more portable.
206 ///
207 #define FALSE ((BOOLEAN)(0==1))
208
209 ///
210 /// NULL pointer (VOID *)
211 ///
212 #define NULL ((VOID *) 0)
213
214 ///
215 /// Maximum values for common UEFI Data Types
216 ///
217 #define MAX_INT8 ((INT8)0x7F)
218 #define MAX_UINT8 ((UINT8)0xFF)
219 #define MAX_INT16 ((INT16)0x7FFF)
220 #define MAX_UINT16 ((UINT16)0xFFFF)
221 #define MAX_INT32 ((INT32)0x7FFFFFFF)
222 #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
223 #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
224 #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
225
226 #define BIT0 0x00000001
227 #define BIT1 0x00000002
228 #define BIT2 0x00000004
229 #define BIT3 0x00000008
230 #define BIT4 0x00000010
231 #define BIT5 0x00000020
232 #define BIT6 0x00000040
233 #define BIT7 0x00000080
234 #define BIT8 0x00000100
235 #define BIT9 0x00000200
236 #define BIT10 0x00000400
237 #define BIT11 0x00000800
238 #define BIT12 0x00001000
239 #define BIT13 0x00002000
240 #define BIT14 0x00004000
241 #define BIT15 0x00008000
242 #define BIT16 0x00010000
243 #define BIT17 0x00020000
244 #define BIT18 0x00040000
245 #define BIT19 0x00080000
246 #define BIT20 0x00100000
247 #define BIT21 0x00200000
248 #define BIT22 0x00400000
249 #define BIT23 0x00800000
250 #define BIT24 0x01000000
251 #define BIT25 0x02000000
252 #define BIT26 0x04000000
253 #define BIT27 0x08000000
254 #define BIT28 0x10000000
255 #define BIT29 0x20000000
256 #define BIT30 0x40000000
257 #define BIT31 0x80000000
258 #define BIT32 0x0000000100000000ULL
259 #define BIT33 0x0000000200000000ULL
260 #define BIT34 0x0000000400000000ULL
261 #define BIT35 0x0000000800000000ULL
262 #define BIT36 0x0000001000000000ULL
263 #define BIT37 0x0000002000000000ULL
264 #define BIT38 0x0000004000000000ULL
265 #define BIT39 0x0000008000000000ULL
266 #define BIT40 0x0000010000000000ULL
267 #define BIT41 0x0000020000000000ULL
268 #define BIT42 0x0000040000000000ULL
269 #define BIT43 0x0000080000000000ULL
270 #define BIT44 0x0000100000000000ULL
271 #define BIT45 0x0000200000000000ULL
272 #define BIT46 0x0000400000000000ULL
273 #define BIT47 0x0000800000000000ULL
274 #define BIT48 0x0001000000000000ULL
275 #define BIT49 0x0002000000000000ULL
276 #define BIT50 0x0004000000000000ULL
277 #define BIT51 0x0008000000000000ULL
278 #define BIT52 0x0010000000000000ULL
279 #define BIT53 0x0020000000000000ULL
280 #define BIT54 0x0040000000000000ULL
281 #define BIT55 0x0080000000000000ULL
282 #define BIT56 0x0100000000000000ULL
283 #define BIT57 0x0200000000000000ULL
284 #define BIT58 0x0400000000000000ULL
285 #define BIT59 0x0800000000000000ULL
286 #define BIT60 0x1000000000000000ULL
287 #define BIT61 0x2000000000000000ULL
288 #define BIT62 0x4000000000000000ULL
289 #define BIT63 0x8000000000000000ULL
290
291 #define SIZE_1KB 0x00000400
292 #define SIZE_2KB 0x00000800
293 #define SIZE_4KB 0x00001000
294 #define SIZE_8KB 0x00002000
295 #define SIZE_16KB 0x00004000
296 #define SIZE_32KB 0x00008000
297 #define SIZE_64KB 0x00010000
298 #define SIZE_128KB 0x00020000
299 #define SIZE_256KB 0x00040000
300 #define SIZE_512KB 0x00080000
301 #define SIZE_1MB 0x00100000
302 #define SIZE_2MB 0x00200000
303 #define SIZE_4MB 0x00400000
304 #define SIZE_8MB 0x00800000
305 #define SIZE_16MB 0x01000000
306 #define SIZE_32MB 0x02000000
307 #define SIZE_64MB 0x04000000
308 #define SIZE_128MB 0x08000000
309 #define SIZE_256MB 0x10000000
310 #define SIZE_512MB 0x20000000
311 #define SIZE_1GB 0x40000000
312 #define SIZE_2GB 0x80000000
313 #define SIZE_4GB 0x0000000100000000ULL
314 #define SIZE_8GB 0x0000000200000000ULL
315 #define SIZE_16GB 0x0000000400000000ULL
316 #define SIZE_32GB 0x0000000800000000ULL
317 #define SIZE_64GB 0x0000001000000000ULL
318 #define SIZE_128GB 0x0000002000000000ULL
319 #define SIZE_256GB 0x0000004000000000ULL
320 #define SIZE_512GB 0x0000008000000000ULL
321 #define SIZE_1TB 0x0000010000000000ULL
322 #define SIZE_2TB 0x0000020000000000ULL
323 #define SIZE_4TB 0x0000040000000000ULL
324 #define SIZE_8TB 0x0000080000000000ULL
325 #define SIZE_16TB 0x0000100000000000ULL
326 #define SIZE_32TB 0x0000200000000000ULL
327 #define SIZE_64TB 0x0000400000000000ULL
328 #define SIZE_128TB 0x0000800000000000ULL
329 #define SIZE_256TB 0x0001000000000000ULL
330 #define SIZE_512TB 0x0002000000000000ULL
331 #define SIZE_1PB 0x0004000000000000ULL
332 #define SIZE_2PB 0x0008000000000000ULL
333 #define SIZE_4PB 0x0010000000000000ULL
334 #define SIZE_8PB 0x0020000000000000ULL
335 #define SIZE_16PB 0x0040000000000000ULL
336 #define SIZE_32PB 0x0080000000000000ULL
337 #define SIZE_64PB 0x0100000000000000ULL
338 #define SIZE_128PB 0x0200000000000000ULL
339 #define SIZE_256PB 0x0400000000000000ULL
340 #define SIZE_512PB 0x0800000000000000ULL
341 #define SIZE_1EB 0x1000000000000000ULL
342 #define SIZE_2EB 0x2000000000000000ULL
343 #define SIZE_4EB 0x4000000000000000ULL
344 #define SIZE_8EB 0x8000000000000000ULL
345
346 #define BASE_1KB 0x00000400
347 #define BASE_2KB 0x00000800
348 #define BASE_4KB 0x00001000
349 #define BASE_8KB 0x00002000
350 #define BASE_16KB 0x00004000
351 #define BASE_32KB 0x00008000
352 #define BASE_64KB 0x00010000
353 #define BASE_128KB 0x00020000
354 #define BASE_256KB 0x00040000
355 #define BASE_512KB 0x00080000
356 #define BASE_1MB 0x00100000
357 #define BASE_2MB 0x00200000
358 #define BASE_4MB 0x00400000
359 #define BASE_8MB 0x00800000
360 #define BASE_16MB 0x01000000
361 #define BASE_32MB 0x02000000
362 #define BASE_64MB 0x04000000
363 #define BASE_128MB 0x08000000
364 #define BASE_256MB 0x10000000
365 #define BASE_512MB 0x20000000
366 #define BASE_1GB 0x40000000
367 #define BASE_2GB 0x80000000
368 #define BASE_4GB 0x0000000100000000ULL
369 #define BASE_8GB 0x0000000200000000ULL
370 #define BASE_16GB 0x0000000400000000ULL
371 #define BASE_32GB 0x0000000800000000ULL
372 #define BASE_64GB 0x0000001000000000ULL
373 #define BASE_128GB 0x0000002000000000ULL
374 #define BASE_256GB 0x0000004000000000ULL
375 #define BASE_512GB 0x0000008000000000ULL
376 #define BASE_1TB 0x0000010000000000ULL
377 #define BASE_2TB 0x0000020000000000ULL
378 #define BASE_4TB 0x0000040000000000ULL
379 #define BASE_8TB 0x0000080000000000ULL
380 #define BASE_16TB 0x0000100000000000ULL
381 #define BASE_32TB 0x0000200000000000ULL
382 #define BASE_64TB 0x0000400000000000ULL
383 #define BASE_128TB 0x0000800000000000ULL
384 #define BASE_256TB 0x0001000000000000ULL
385 #define BASE_512TB 0x0002000000000000ULL
386 #define BASE_1PB 0x0004000000000000ULL
387 #define BASE_2PB 0x0008000000000000ULL
388 #define BASE_4PB 0x0010000000000000ULL
389 #define BASE_8PB 0x0020000000000000ULL
390 #define BASE_16PB 0x0040000000000000ULL
391 #define BASE_32PB 0x0080000000000000ULL
392 #define BASE_64PB 0x0100000000000000ULL
393 #define BASE_128PB 0x0200000000000000ULL
394 #define BASE_256PB 0x0400000000000000ULL
395 #define BASE_512PB 0x0800000000000000ULL
396 #define BASE_1EB 0x1000000000000000ULL
397 #define BASE_2EB 0x2000000000000000ULL
398 #define BASE_4EB 0x4000000000000000ULL
399 #define BASE_8EB 0x8000000000000000ULL
400
401 //
402 // Support for variable length argument lists using the ANSI standard.
403 //
404 // Since we are using the ANSI standard we used the standard naming and
405 // did not follow the coding convention
406 //
407 // VA_LIST - typedef for argument list.
408 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
409 // VA_END (VA_LIST Marker) - Clear Marker
410 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
411 // the ... list. You must know the size and pass it in this macro.
412 // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
413 //
414 // example:
415 //
416 // UINTN
417 // ExampleVarArg (
418 // IN UINTN NumberOfArgs,
419 // ...
420 // )
421 // {
422 // VA_LIST Marker;
423 // UINTN Index;
424 // UINTN Result;
425 //
426 // //
427 // // Initialize the Marker
428 // //
429 // VA_START (Marker, NumberOfArgs);
430 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
431 // //
432 // // The ... list is a series of UINTN values, so average them up.
433 // //
434 // Result += VA_ARG (Marker, UINTN);
435 // }
436 //
437 // VA_END (Marker);
438 // return Result
439 // }
440 //
441
442 /**
443 Return the size of argument that has been aligned to sizeof (UINTN).
444
445 @param n The parameter size to be aligned.
446
447 @return The aligned size.
448 **/
449 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
450
451 #if defined(__CC_ARM)
452 //
453 // RVCT ARM variable argument list support.
454 //
455
456 ///
457 /// Variable used to traverse the list of arguments. This type can vary by
458 /// implementation and could be an array or structure.
459 ///
460 #ifdef __APCS_ADSABI
461 typedef int *va_list[1];
462 #define VA_LIST va_list
463 #else
464 typedef struct __va_list { void *__ap; } va_list;
465 #define VA_LIST va_list
466 #endif
467
468 #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
469
470 #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
471
472 #define VA_END(Marker) ((void)0)
473
474 // For some ARM RVCT compilers, __va_copy is not defined
475 #ifndef __va_copy
476 #define __va_copy(dest, src) ((void)((dest) = (src)))
477 #endif
478
479 #define VA_COPY(Dest, Start) __va_copy (Dest, Start)
480
481 #elif defined(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS)
482 //
483 // Use GCC built-in macros for variable argument lists.
484 //
485
486 ///
487 /// Variable used to traverse the list of arguments. This type can vary by
488 /// implementation and could be an array or structure.
489 ///
490 typedef __builtin_va_list VA_LIST;
491
492 #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
493
494 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
495
496 #define VA_END(Marker) __builtin_va_end (Marker)
497
498 #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
499
500 #else
501 ///
502 /// Variable used to traverse the list of arguments. This type can vary by
503 /// implementation and could be an array or structure.
504 ///
505 typedef CHAR8 *VA_LIST;
506
507 /**
508 Retrieves a pointer to the beginning of a variable argument list, based on
509 the name of the parameter that immediately precedes the variable argument list.
510
511 This function initializes Marker to point to the beginning of the variable
512 argument list that immediately follows Parameter. The method for computing the
513 pointer to the next argument in the argument list is CPU-specific following the
514 EFIAPI ABI.
515
516 @param Marker The VA_LIST used to traverse the list of arguments.
517 @param Parameter The name of the parameter that immediately precedes
518 the variable argument list.
519
520 @return A pointer to the beginning of a variable argument list.
521
522 **/
523 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
524
525 /**
526 Returns an argument of a specified type from a variable argument list and updates
527 the pointer to the variable argument list to point to the next argument.
528
529 This function returns an argument of the type specified by TYPE from the beginning
530 of the variable argument list specified by Marker. Marker is then updated to point
531 to the next argument in the variable argument list. The method for computing the
532 pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
533
534 @param Marker VA_LIST used to traverse the list of arguments.
535 @param TYPE The type of argument to retrieve from the beginning
536 of the variable argument list.
537
538 @return An argument of the type specified by TYPE.
539
540 **/
541 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
542
543 /**
544 Terminates the use of a variable argument list.
545
546 This function initializes Marker so it can no longer be used with VA_ARG().
547 After this macro is used, the only way to access the variable argument list is
548 by using VA_START() again.
549
550 @param Marker VA_LIST used to traverse the list of arguments.
551
552 **/
553 #define VA_END(Marker) (Marker = (VA_LIST) 0)
554
555 /**
556 Initializes a VA_LIST as a copy of an existing VA_LIST.
557
558 This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
559 followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
560 the present state of Start.
561
562 @param Dest VA_LIST used to traverse the list of arguments.
563 @param Start VA_LIST used to traverse the list of arguments.
564
565 **/
566 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
567
568 #endif
569
570 ///
571 /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
572 ///
573 typedef UINTN *BASE_LIST;
574
575 /**
576 Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
577
578 @param TYPE The date type to determine the size of.
579
580 @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
581 **/
582 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
583
584 /**
585 Returns an argument of a specified type from a variable argument list and updates
586 the pointer to the variable argument list to point to the next argument.
587
588 This function returns an argument of the type specified by TYPE from the beginning
589 of the variable argument list specified by Marker. Marker is then updated to point
590 to the next argument in the variable argument list. The method for computing the
591 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
592
593 @param Marker The pointer to the beginning of a variable argument list.
594 @param TYPE The type of argument to retrieve from the beginning
595 of the variable argument list.
596
597 @return An argument of the type specified by TYPE.
598
599 **/
600 #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
601
602 /**
603 The macro that returns the byte offset of a field in a data structure.
604
605 This function returns the offset, in bytes, of field specified by Field from the
606 beginning of the data structure specified by TYPE. If TYPE does not contain Field,
607 the module will not compile.
608
609 @param TYPE The name of the data structure that contains the field specified by Field.
610 @param Field The name of the field in the data structure.
611
612 @return Offset, in bytes, of field.
613
614 **/
615 #ifdef __GNUC__
616 #if __GNUC__ >= 4
617 #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
618 #endif
619 #endif
620
621 #ifndef OFFSET_OF
622 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
623 #endif
624
625 /**
626 Macro that returns a pointer to the data structure that contains a specified field of
627 that data structure. This is a lightweight method to hide information by placing a
628 public data structure inside a larger private data structure and using a pointer to
629 the public data structure to retrieve a pointer to the private data structure.
630
631 This function computes the offset, in bytes, of field specified by Field from the beginning
632 of the data structure specified by TYPE. This offset is subtracted from Record, and is
633 used to return a pointer to a data structure of the type specified by TYPE. If the data type
634 specified by TYPE does not contain the field specified by Field, then the module will not compile.
635
636 @param Record Pointer to the field specified by Field within a data structure of type TYPE.
637 @param TYPE The name of the data structure type to return. This data structure must
638 contain the field specified by Field.
639 @param Field The name of the field in the data structure specified by TYPE to which Record points.
640
641 @return A pointer to the structure from one of it's elements.
642
643 **/
644 #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
645
646 /**
647 Rounds a value up to the next boundary using a specified alignment.
648
649 This function rounds Value up to the next boundary using the specified Alignment.
650 This aligned value is returned.
651
652 @param Value The value to round up.
653 @param Alignment The alignment boundary used to return the aligned value.
654
655 @return A value up to the next boundary.
656
657 **/
658 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
659
660 /**
661 Adjust a pointer by adding the minimum offset required for it to be aligned on
662 a specified alignment boundary.
663
664 This function rounds the pointer specified by Pointer to the next alignment boundary
665 specified by Alignment. The pointer to the aligned address is returned.
666
667 @param Pointer The pointer to round up.
668 @param Alignment The alignment boundary to use to return an aligned pointer.
669
670 @return Pointer to the aligned address.
671
672 **/
673 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
674
675 /**
676 Rounds a value up to the next natural boundary for the current CPU.
677 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
678
679 This function rounds the value specified by Value up to the next natural boundary for the
680 current CPU. This rounded value is returned.
681
682 @param Value The value to round up.
683
684 @return Rounded value specified by Value.
685
686 **/
687 #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
688
689
690 /**
691 Return the maximum of two operands.
692
693 This macro returns the maximum of two operand specified by a and b.
694 Both a and b must be the same numerical types, signed or unsigned.
695
696 @param a The first operand with any numerical type.
697 @param b The second operand. Can be any numerical type as long as is
698 the same type as a.
699
700 @return Maximum of two operands.
701
702 **/
703 #define MAX(a, b) \
704 (((a) > (b)) ? (a) : (b))
705
706 /**
707 Return the minimum of two operands.
708
709 This macro returns the minimal of two operand specified by a and b.
710 Both a and b must be the same numerical types, signed or unsigned.
711
712 @param a The first operand with any numerical type.
713 @param b The second operand. It should be the same any numerical type with a.
714
715 @return Minimum of two operands.
716
717 **/
718 #define MIN(a, b) \
719 (((a) < (b)) ? (a) : (b))
720
721 /**
722 Return the absolute value of a signed operand.
723
724 This macro returns the absolute value of the signed operand specified by a.
725
726 @param a The signed operand.
727
728 @return The absolute value of the signed operand.
729
730 **/
731 #define ABS(a) \
732 (((a) < 0) ? (-(a)) : (a))
733
734 //
735 // Status codes common to all execution phases
736 //
737 typedef UINTN RETURN_STATUS;
738
739 /**
740 Produces a RETURN_STATUS code with the highest bit set.
741
742 @param StatusCode The status code value to convert into a warning code.
743 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
744
745 @return The value specified by StatusCode with the highest bit set.
746
747 **/
748 #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
749
750 /**
751 Produces a RETURN_STATUS code with the highest bit clear.
752
753 @param StatusCode The status code value to convert into a warning code.
754 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
755
756 @return The value specified by StatusCode with the highest bit clear.
757
758 **/
759 #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
760
761 /**
762 Returns TRUE if a specified RETURN_STATUS code is an error code.
763
764 This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
765
766 @param StatusCode The status code value to evaluate.
767
768 @retval TRUE The high bit of StatusCode is set.
769 @retval FALSE The high bit of StatusCode is clear.
770
771 **/
772 #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
773
774 ///
775 /// The operation completed successfully.
776 ///
777 #define RETURN_SUCCESS 0
778
779 ///
780 /// The image failed to load.
781 ///
782 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
783
784 ///
785 /// The parameter was incorrect.
786 ///
787 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
788
789 ///
790 /// The operation is not supported.
791 ///
792 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
793
794 ///
795 /// The buffer was not the proper size for the request.
796 ///
797 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
798
799 ///
800 /// The buffer was not large enough to hold the requested data.
801 /// The required buffer size is returned in the appropriate
802 /// parameter when this error occurs.
803 ///
804 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
805
806 ///
807 /// There is no data pending upon return.
808 ///
809 #define RETURN_NOT_READY ENCODE_ERROR (6)
810
811 ///
812 /// The physical device reported an error while attempting the
813 /// operation.
814 ///
815 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
816
817 ///
818 /// The device can not be written to.
819 ///
820 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
821
822 ///
823 /// The resource has run out.
824 ///
825 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
826
827 ///
828 /// An inconsistency was detected on the file system causing the
829 /// operation to fail.
830 ///
831 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
832
833 ///
834 /// There is no more space on the file system.
835 ///
836 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
837
838 ///
839 /// The device does not contain any medium to perform the
840 /// operation.
841 ///
842 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
843
844 ///
845 /// The medium in the device has changed since the last
846 /// access.
847 ///
848 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
849
850 ///
851 /// The item was not found.
852 ///
853 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
854
855 ///
856 /// Access was denied.
857 ///
858 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
859
860 ///
861 /// The server was not found or did not respond to the request.
862 ///
863 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
864
865 ///
866 /// A mapping to the device does not exist.
867 ///
868 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
869
870 ///
871 /// A timeout time expired.
872 ///
873 #define RETURN_TIMEOUT ENCODE_ERROR (18)
874
875 ///
876 /// The protocol has not been started.
877 ///
878 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
879
880 ///
881 /// The protocol has already been started.
882 ///
883 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
884
885 ///
886 /// The operation was aborted.
887 ///
888 #define RETURN_ABORTED ENCODE_ERROR (21)
889
890 ///
891 /// An ICMP error occurred during the network operation.
892 ///
893 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
894
895 ///
896 /// A TFTP error occurred during the network operation.
897 ///
898 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
899
900 ///
901 /// A protocol error occurred during the network operation.
902 ///
903 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
904
905 ///
906 /// A function encountered an internal version that was
907 /// incompatible with a version requested by the caller.
908 ///
909 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
910
911 ///
912 /// The function was not performed due to a security violation.
913 ///
914 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
915
916 ///
917 /// A CRC error was detected.
918 ///
919 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
920
921 ///
922 /// The beginning or end of media was reached.
923 ///
924 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
925
926 ///
927 /// The end of the file was reached.
928 ///
929 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
930
931 ///
932 /// The language specified was invalid.
933 ///
934 #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
935
936 ///
937 /// The security status of the data is unknown or compromised
938 /// and the data must be updated or replaced to restore a valid
939 /// security status.
940 ///
941 #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
942
943 ///
944 /// A HTTP error occurred during the network operation.
945 ///
946 #define RETURN_HTTP_ERROR ENCODE_ERROR (35)
947
948 ///
949 /// The string contained one or more characters that
950 /// the device could not render and were skipped.
951 ///
952 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
953
954 ///
955 /// The handle was closed, but the file was not deleted.
956 ///
957 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
958
959 ///
960 /// The handle was closed, but the data to the file was not
961 /// flushed properly.
962 ///
963 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
964
965 ///
966 /// The resulting buffer was too small, and the data was
967 /// truncated to the buffer size.
968 ///
969 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
970
971 ///
972 /// The data has not been updated within the timeframe set by
973 /// local policy for this type of data.
974 ///
975 #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
976
977 /**
978 Returns a 16-bit signature built from 2 ASCII characters.
979
980 This macro returns a 16-bit value built from the two ASCII characters specified
981 by A and B.
982
983 @param A The first ASCII character.
984 @param B The second ASCII character.
985
986 @return A 16-bit value built from the two ASCII characters specified by A and B.
987
988 **/
989 #define SIGNATURE_16(A, B) ((A) | (B << 8))
990
991 /**
992 Returns a 32-bit signature built from 4 ASCII characters.
993
994 This macro returns a 32-bit value built from the four ASCII characters specified
995 by A, B, C, and D.
996
997 @param A The first ASCII character.
998 @param B The second ASCII character.
999 @param C The third ASCII character.
1000 @param D The fourth ASCII character.
1001
1002 @return A 32-bit value built from the two ASCII characters specified by A, B,
1003 C and D.
1004
1005 **/
1006 #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
1007
1008 /**
1009 Returns a 64-bit signature built from 8 ASCII characters.
1010
1011 This macro returns a 64-bit value built from the eight ASCII characters specified
1012 by A, B, C, D, E, F, G,and H.
1013
1014 @param A The first ASCII character.
1015 @param B The second ASCII character.
1016 @param C The third ASCII character.
1017 @param D The fourth ASCII character.
1018 @param E The fifth ASCII character.
1019 @param F The sixth ASCII character.
1020 @param G The seventh ASCII character.
1021 @param H The eighth ASCII character.
1022
1023 @return A 64-bit value built from the two ASCII characters specified by A, B,
1024 C, D, E, F, G and H.
1025
1026 **/
1027 #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
1028 (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
1029
1030 #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
1031 #pragma intrinsic(_ReturnAddress)
1032 /**
1033 Get the return address of the calling funcation.
1034
1035 Based on intrinsic function _ReturnAddress that provides the address of
1036 the instruction in the calling function that will be executed after
1037 control returns to the caller.
1038
1039 @param L Return Level.
1040
1041 @return The return address of the calling funcation or 0 if L != 0.
1042
1043 **/
1044 #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
1045 #elif defined(__GNUC__)
1046 void * __builtin_return_address (unsigned int level);
1047 /**
1048 Get the return address of the calling funcation.
1049
1050 Based on built-in Function __builtin_return_address that returns
1051 the return address of the current function, or of one of its callers.
1052
1053 @param L Return Level.
1054
1055 @return The return address of the calling funcation.
1056
1057 **/
1058 #define RETURN_ADDRESS(L) __builtin_return_address (L)
1059 #else
1060 /**
1061 Get the return address of the calling funcation.
1062
1063 @param L Return Level.
1064
1065 @return 0 as compilers don't support this feature.
1066
1067 **/
1068 #define RETURN_ADDRESS(L) ((VOID *) 0)
1069 #endif
1070
1071 #endif
1072