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