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