2 Root include file for Mde Package Base type modules
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.
9 Copyright (c) 2006 - 2013, 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.
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.
26 // Include processor specific binding
28 #include <ProcessorBind.h>
32 Verifies the storage size of a given data type.
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.
38 @param TYPE The date type to determine the size of.
39 @param Size The expected size for the TYPE.
42 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
45 // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
46 // Section 2.3.1 of the UEFI 2.3 Specification.
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);
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
65 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
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.
71 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
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.
78 #define GLOBAL_REMOVE_IF_UNREFERENCED
82 // For symbol name in GNU assembly code, an extra "_" is necessary
86 /// Private worker functions for ASM_PFX()
88 #define _CONCATENATE(a, b) __CONCATENATE(a, b)
89 #define __CONCATENATE(a, b) a ## b
92 /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
93 /// on symbols in assembly language.
95 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
100 // Apple extension that is used by the linker to optimize code size
101 // with assembly functions. Put at the end of your .S files
103 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
105 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
110 // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
111 // as a prefix for the structure.
113 #define PACKED __packed
119 /// 128 bit buffer containing a unique identifier value.
120 /// Unless otherwise specified, aligned on a 64 bit boundary.
130 // 8-bytes unsigned value that represents a physical system address.
132 typedef UINT64 PHYSICAL_ADDRESS
;
135 /// LIST_ENTRY structure definition.
137 typedef struct _LIST_ENTRY LIST_ENTRY
;
140 /// _LIST_ENTRY structure definition.
143 LIST_ENTRY
*ForwardLink
;
144 LIST_ENTRY
*BackLink
;
148 // Modifiers to abstract standard types to aid in debug of problems
152 /// Datum is read-only.
157 /// Datum is scoped to the current file or function.
159 #define STATIC static
167 // Modifiers for Data Types used to self document code.
168 // This concept is borrowed for UEFI specification.
172 /// Datum is passed to the function.
177 /// Datum is returned from the function.
182 /// Passing the datum to the function is optional, and a NULL
183 /// is passed if the value is not supplied.
188 // UEFI specification claims 1 and 0. We are concerned about the
189 // complier portability so we did it this way.
193 /// Boolean true value. UEFI Specification defines this value to be 1,
194 /// but this form is more portable.
196 #define TRUE ((BOOLEAN)(1==1))
199 /// Boolean false value. UEFI Specification defines this value to be 0,
200 /// but this form is more portable.
202 #define FALSE ((BOOLEAN)(0==1))
205 /// NULL pointer (VOID *)
207 #define NULL ((VOID *) 0)
210 /// Maximum values for common UEFI Data Types
212 #define MAX_INT8 ((INT8)0x7F)
213 #define MAX_UINT8 ((UINT8)0xFF)
214 #define MAX_INT16 ((INT16)0x7FFF)
215 #define MAX_UINT16 ((UINT16)0xFFFF)
216 #define MAX_INT32 ((INT32)0x7FFFFFFF)
217 #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
218 #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
219 #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
221 #define BIT0 0x00000001
222 #define BIT1 0x00000002
223 #define BIT2 0x00000004
224 #define BIT3 0x00000008
225 #define BIT4 0x00000010
226 #define BIT5 0x00000020
227 #define BIT6 0x00000040
228 #define BIT7 0x00000080
229 #define BIT8 0x00000100
230 #define BIT9 0x00000200
231 #define BIT10 0x00000400
232 #define BIT11 0x00000800
233 #define BIT12 0x00001000
234 #define BIT13 0x00002000
235 #define BIT14 0x00004000
236 #define BIT15 0x00008000
237 #define BIT16 0x00010000
238 #define BIT17 0x00020000
239 #define BIT18 0x00040000
240 #define BIT19 0x00080000
241 #define BIT20 0x00100000
242 #define BIT21 0x00200000
243 #define BIT22 0x00400000
244 #define BIT23 0x00800000
245 #define BIT24 0x01000000
246 #define BIT25 0x02000000
247 #define BIT26 0x04000000
248 #define BIT27 0x08000000
249 #define BIT28 0x10000000
250 #define BIT29 0x20000000
251 #define BIT30 0x40000000
252 #define BIT31 0x80000000
253 #define BIT32 0x0000000100000000ULL
254 #define BIT33 0x0000000200000000ULL
255 #define BIT34 0x0000000400000000ULL
256 #define BIT35 0x0000000800000000ULL
257 #define BIT36 0x0000001000000000ULL
258 #define BIT37 0x0000002000000000ULL
259 #define BIT38 0x0000004000000000ULL
260 #define BIT39 0x0000008000000000ULL
261 #define BIT40 0x0000010000000000ULL
262 #define BIT41 0x0000020000000000ULL
263 #define BIT42 0x0000040000000000ULL
264 #define BIT43 0x0000080000000000ULL
265 #define BIT44 0x0000100000000000ULL
266 #define BIT45 0x0000200000000000ULL
267 #define BIT46 0x0000400000000000ULL
268 #define BIT47 0x0000800000000000ULL
269 #define BIT48 0x0001000000000000ULL
270 #define BIT49 0x0002000000000000ULL
271 #define BIT50 0x0004000000000000ULL
272 #define BIT51 0x0008000000000000ULL
273 #define BIT52 0x0010000000000000ULL
274 #define BIT53 0x0020000000000000ULL
275 #define BIT54 0x0040000000000000ULL
276 #define BIT55 0x0080000000000000ULL
277 #define BIT56 0x0100000000000000ULL
278 #define BIT57 0x0200000000000000ULL
279 #define BIT58 0x0400000000000000ULL
280 #define BIT59 0x0800000000000000ULL
281 #define BIT60 0x1000000000000000ULL
282 #define BIT61 0x2000000000000000ULL
283 #define BIT62 0x4000000000000000ULL
284 #define BIT63 0x8000000000000000ULL
286 #define SIZE_1KB 0x00000400
287 #define SIZE_2KB 0x00000800
288 #define SIZE_4KB 0x00001000
289 #define SIZE_8KB 0x00002000
290 #define SIZE_16KB 0x00004000
291 #define SIZE_32KB 0x00008000
292 #define SIZE_64KB 0x00010000
293 #define SIZE_128KB 0x00020000
294 #define SIZE_256KB 0x00040000
295 #define SIZE_512KB 0x00080000
296 #define SIZE_1MB 0x00100000
297 #define SIZE_2MB 0x00200000
298 #define SIZE_4MB 0x00400000
299 #define SIZE_8MB 0x00800000
300 #define SIZE_16MB 0x01000000
301 #define SIZE_32MB 0x02000000
302 #define SIZE_64MB 0x04000000
303 #define SIZE_128MB 0x08000000
304 #define SIZE_256MB 0x10000000
305 #define SIZE_512MB 0x20000000
306 #define SIZE_1GB 0x40000000
307 #define SIZE_2GB 0x80000000
308 #define SIZE_4GB 0x0000000100000000ULL
309 #define SIZE_8GB 0x0000000200000000ULL
310 #define SIZE_16GB 0x0000000400000000ULL
311 #define SIZE_32GB 0x0000000800000000ULL
312 #define SIZE_64GB 0x0000001000000000ULL
313 #define SIZE_128GB 0x0000002000000000ULL
314 #define SIZE_256GB 0x0000004000000000ULL
315 #define SIZE_512GB 0x0000008000000000ULL
316 #define SIZE_1TB 0x0000010000000000ULL
317 #define SIZE_2TB 0x0000020000000000ULL
318 #define SIZE_4TB 0x0000040000000000ULL
319 #define SIZE_8TB 0x0000080000000000ULL
320 #define SIZE_16TB 0x0000100000000000ULL
321 #define SIZE_32TB 0x0000200000000000ULL
322 #define SIZE_64TB 0x0000400000000000ULL
323 #define SIZE_128TB 0x0000800000000000ULL
324 #define SIZE_256TB 0x0001000000000000ULL
325 #define SIZE_512TB 0x0002000000000000ULL
326 #define SIZE_1PB 0x0004000000000000ULL
327 #define SIZE_2PB 0x0008000000000000ULL
328 #define SIZE_4PB 0x0010000000000000ULL
329 #define SIZE_8PB 0x0020000000000000ULL
330 #define SIZE_16PB 0x0040000000000000ULL
331 #define SIZE_32PB 0x0080000000000000ULL
332 #define SIZE_64PB 0x0100000000000000ULL
333 #define SIZE_128PB 0x0200000000000000ULL
334 #define SIZE_256PB 0x0400000000000000ULL
335 #define SIZE_512PB 0x0800000000000000ULL
336 #define SIZE_1EB 0x1000000000000000ULL
337 #define SIZE_2EB 0x2000000000000000ULL
338 #define SIZE_4EB 0x4000000000000000ULL
339 #define SIZE_8EB 0x8000000000000000ULL
341 #define BASE_1KB 0x00000400
342 #define BASE_2KB 0x00000800
343 #define BASE_4KB 0x00001000
344 #define BASE_8KB 0x00002000
345 #define BASE_16KB 0x00004000
346 #define BASE_32KB 0x00008000
347 #define BASE_64KB 0x00010000
348 #define BASE_128KB 0x00020000
349 #define BASE_256KB 0x00040000
350 #define BASE_512KB 0x00080000
351 #define BASE_1MB 0x00100000
352 #define BASE_2MB 0x00200000
353 #define BASE_4MB 0x00400000
354 #define BASE_8MB 0x00800000
355 #define BASE_16MB 0x01000000
356 #define BASE_32MB 0x02000000
357 #define BASE_64MB 0x04000000
358 #define BASE_128MB 0x08000000
359 #define BASE_256MB 0x10000000
360 #define BASE_512MB 0x20000000
361 #define BASE_1GB 0x40000000
362 #define BASE_2GB 0x80000000
363 #define BASE_4GB 0x0000000100000000ULL
364 #define BASE_8GB 0x0000000200000000ULL
365 #define BASE_16GB 0x0000000400000000ULL
366 #define BASE_32GB 0x0000000800000000ULL
367 #define BASE_64GB 0x0000001000000000ULL
368 #define BASE_128GB 0x0000002000000000ULL
369 #define BASE_256GB 0x0000004000000000ULL
370 #define BASE_512GB 0x0000008000000000ULL
371 #define BASE_1TB 0x0000010000000000ULL
372 #define BASE_2TB 0x0000020000000000ULL
373 #define BASE_4TB 0x0000040000000000ULL
374 #define BASE_8TB 0x0000080000000000ULL
375 #define BASE_16TB 0x0000100000000000ULL
376 #define BASE_32TB 0x0000200000000000ULL
377 #define BASE_64TB 0x0000400000000000ULL
378 #define BASE_128TB 0x0000800000000000ULL
379 #define BASE_256TB 0x0001000000000000ULL
380 #define BASE_512TB 0x0002000000000000ULL
381 #define BASE_1PB 0x0004000000000000ULL
382 #define BASE_2PB 0x0008000000000000ULL
383 #define BASE_4PB 0x0010000000000000ULL
384 #define BASE_8PB 0x0020000000000000ULL
385 #define BASE_16PB 0x0040000000000000ULL
386 #define BASE_32PB 0x0080000000000000ULL
387 #define BASE_64PB 0x0100000000000000ULL
388 #define BASE_128PB 0x0200000000000000ULL
389 #define BASE_256PB 0x0400000000000000ULL
390 #define BASE_512PB 0x0800000000000000ULL
391 #define BASE_1EB 0x1000000000000000ULL
392 #define BASE_2EB 0x2000000000000000ULL
393 #define BASE_4EB 0x4000000000000000ULL
394 #define BASE_8EB 0x8000000000000000ULL
397 // Support for variable length argument lists using the ANSI standard.
399 // Since we are using the ANSI standard we used the standard naming and
400 // did not follow the coding convention
402 // VA_LIST - typedef for argument list.
403 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
404 // VA_END (VA_LIST Marker) - Clear Marker
405 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
406 // the ... list. You must know the size and pass it in this macro.
407 // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
413 // IN UINTN NumberOfArgs,
422 // // Initialize the Marker
424 // VA_START (Marker, NumberOfArgs);
425 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
427 // // The ... list is a series of UINTN values, so average them up.
429 // Result += VA_ARG (Marker, UINTN);
438 Return the size of argument that has been aligned to sizeof (UINTN).
440 @param n The parameter size to be aligned.
442 @return The aligned size.
444 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
446 #if defined(__CC_ARM)
448 // RVCT ARM variable argument list support.
452 /// Variable used to traverse the list of arguments. This type can vary by
453 /// implementation and could be an array or structure.
456 typedef int *va_list[1];
457 #define VA_LIST va_list
459 typedef struct __va_list
{ void *__ap
; } va_list;
460 #define VA_LIST va_list
463 #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
465 #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
467 #define VA_END(Marker) ((void)0)
469 // For some ARM RVCT compilers, __va_copy is not defined
471 #define __va_copy(dest, src) ((void)((dest) = (src)))
474 #define VA_COPY(Dest, Start) __va_copy (Dest, Start)
476 #elif defined(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS)
478 // Use GCC built-in macros for variable argument lists.
482 /// Variable used to traverse the list of arguments. This type can vary by
483 /// implementation and could be an array or structure.
485 typedef __builtin_va_list VA_LIST
;
487 #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
489 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
491 #define VA_END(Marker) __builtin_va_end (Marker)
493 #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
497 /// Variable used to traverse the list of arguments. This type can vary by
498 /// implementation and could be an array or structure.
500 typedef CHAR8
*VA_LIST
;
503 Retrieves a pointer to the beginning of a variable argument list, based on
504 the name of the parameter that immediately precedes the variable argument list.
506 This function initializes Marker to point to the beginning of the variable
507 argument list that immediately follows Parameter. The method for computing the
508 pointer to the next argument in the argument list is CPU-specific following the
511 @param Marker The VA_LIST used to traverse the list of arguments.
512 @param Parameter The name of the parameter that immediately precedes
513 the variable argument list.
515 @return A pointer to the beginning of a variable argument list.
518 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
521 Returns an argument of a specified type from a variable argument list and updates
522 the pointer to the variable argument list to point to the next argument.
524 This function returns an argument of the type specified by TYPE from the beginning
525 of the variable argument list specified by Marker. Marker is then updated to point
526 to the next argument in the variable argument list. The method for computing the
527 pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
529 @param Marker VA_LIST used to traverse the list of arguments.
530 @param TYPE The type of argument to retrieve from the beginning
531 of the variable argument list.
533 @return An argument of the type specified by TYPE.
536 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
539 Terminates the use of a variable argument list.
541 This function initializes Marker so it can no longer be used with VA_ARG().
542 After this macro is used, the only way to access the variable argument list is
543 by using VA_START() again.
545 @param Marker VA_LIST used to traverse the list of arguments.
548 #define VA_END(Marker) (Marker = (VA_LIST) 0)
551 Initializes a VA_LIST as a copy of an existing VA_LIST.
553 This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
554 followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
555 the present state of Start.
557 @param Dest VA_LIST used to traverse the list of arguments.
558 @param Start VA_LIST used to traverse the list of arguments.
561 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
566 /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
568 typedef UINTN
*BASE_LIST
;
571 Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
573 @param TYPE The date type to determine the size of.
575 @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
577 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
580 Returns an argument of a specified type from a variable argument list and updates
581 the pointer to the variable argument list to point to the next argument.
583 This function returns an argument of the type specified by TYPE from the beginning
584 of the variable argument list specified by Marker. Marker is then updated to point
585 to the next argument in the variable argument list. The method for computing the
586 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
588 @param Marker The pointer to the beginning of a variable argument list.
589 @param TYPE The type of argument to retrieve from the beginning
590 of the variable argument list.
592 @return An argument of the type specified by TYPE.
595 #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
598 The macro that returns the byte offset of a field in a data structure.
600 This function returns the offset, in bytes, of field specified by Field from the
601 beginning of the data structure specified by TYPE. If TYPE does not contain Field,
602 the module will not compile.
604 @param TYPE The name of the data structure that contains the field specified by Field.
605 @param Field The name of the field in the data structure.
607 @return Offset, in bytes, of field.
612 #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
617 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
621 Macro that returns a pointer to the data structure that contains a specified field of
622 that data structure. This is a lightweight method to hide information by placing a
623 public data structure inside a larger private data structure and using a pointer to
624 the public data structure to retrieve a pointer to the private data structure.
626 This function computes the offset, in bytes, of field specified by Field from the beginning
627 of the data structure specified by TYPE. This offset is subtracted from Record, and is
628 used to return a pointer to a data structure of the type specified by TYPE. If the data type
629 specified by TYPE does not contain the field specified by Field, then the module will not compile.
631 @param Record Pointer to the field specified by Field within a data structure of type TYPE.
632 @param TYPE The name of the data structure type to return. This data structure must
633 contain the field specified by Field.
634 @param Field The name of the field in the data structure specified by TYPE to which Record points.
636 @return A pointer to the structure from one of it's elements.
639 #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
642 Rounds a value up to the next boundary using a specified alignment.
644 This function rounds Value up to the next boundary using the specified Alignment.
645 This aligned value is returned.
647 @param Value The value to round up.
648 @param Alignment The alignment boundary used to return the aligned value.
650 @return A value up to the next boundary.
653 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
656 Adjust a pointer by adding the minimum offset required for it to be aligned on
657 a specified alignment boundary.
659 This function rounds the pointer specified by Pointer to the next alignment boundary
660 specified by Alignment. The pointer to the aligned address is returned.
662 @param Pointer The pointer to round up.
663 @param Alignment The alignment boundary to use to return an aligned pointer.
665 @return Pointer to the aligned address.
668 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
671 Rounds a value up to the next natural boundary for the current CPU.
672 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
674 This function rounds the value specified by Value up to the next natural boundary for the
675 current CPU. This rounded value is returned.
677 @param Value The value to round up.
679 @return Rounded value specified by Value.
682 #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
686 Return the maximum of two operands.
688 This macro returns the maximum of two operand specified by a and b.
689 Both a and b must be the same numerical types, signed or unsigned.
691 @param a The first operand with any numerical type.
692 @param b The second operand. Can be any numerical type as long as is
695 @return Maximum of two operands.
699 (((a) > (b)) ? (a) : (b))
702 Return the minimum of two operands.
704 This macro returns the minimal of two operand specified by a and b.
705 Both a and b must be the same numerical types, signed or unsigned.
707 @param a The first operand with any numerical type.
708 @param b The second operand. It should be the same any numerical type with a.
710 @return Minimum of two operands.
714 (((a) < (b)) ? (a) : (b))
717 Return the absolute value of a signed operand.
719 This macro returns the absolute value of the signed operand specified by a.
721 @param a The signed operand.
723 @return The absolute value of the signed operand.
727 (((a) < 0) ? (-(a)) : (a))
730 // Status codes common to all execution phases
732 typedef UINTN RETURN_STATUS
;
735 Produces a RETURN_STATUS code with the highest bit set.
737 @param StatusCode The status code value to convert into a warning code.
738 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
740 @return The value specified by StatusCode with the highest bit set.
743 #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
746 Produces a RETURN_STATUS code with the highest bit clear.
748 @param StatusCode The status code value to convert into a warning code.
749 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
751 @return The value specified by StatusCode with the highest bit clear.
754 #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
757 Returns TRUE if a specified RETURN_STATUS code is an error code.
759 This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
761 @param StatusCode The status code value to evaluate.
763 @retval TRUE The high bit of StatusCode is set.
764 @retval FALSE The high bit of StatusCode is clear.
767 #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
770 /// The operation completed successfully.
772 #define RETURN_SUCCESS 0
775 /// The image failed to load.
777 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
780 /// The parameter was incorrect.
782 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
785 /// The operation is not supported.
787 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
790 /// The buffer was not the proper size for the request.
792 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
795 /// The buffer was not large enough to hold the requested data.
796 /// The required buffer size is returned in the appropriate
797 /// parameter when this error occurs.
799 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
802 /// There is no data pending upon return.
804 #define RETURN_NOT_READY ENCODE_ERROR (6)
807 /// The physical device reported an error while attempting the
810 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
813 /// The device can not be written to.
815 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
818 /// The resource has run out.
820 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
823 /// An inconsistency was detected on the file system causing the
824 /// operation to fail.
826 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
829 /// There is no more space on the file system.
831 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
834 /// The device does not contain any medium to perform the
837 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
840 /// The medium in the device has changed since the last
843 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
846 /// The item was not found.
848 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
851 /// Access was denied.
853 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
856 /// The server was not found or did not respond to the request.
858 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
861 /// A mapping to the device does not exist.
863 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
866 /// A timeout time expired.
868 #define RETURN_TIMEOUT ENCODE_ERROR (18)
871 /// The protocol has not been started.
873 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
876 /// The protocol has already been started.
878 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
881 /// The operation was aborted.
883 #define RETURN_ABORTED ENCODE_ERROR (21)
886 /// An ICMP error occurred during the network operation.
888 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
891 /// A TFTP error occurred during the network operation.
893 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
896 /// A protocol error occurred during the network operation.
898 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
901 /// A function encountered an internal version that was
902 /// incompatible with a version requested by the caller.
904 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
907 /// The function was not performed due to a security violation.
909 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
912 /// A CRC error was detected.
914 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
917 /// The beginning or end of media was reached.
919 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
922 /// The end of the file was reached.
924 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
927 /// The language specified was invalid.
929 #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
932 /// The security status of the data is unknown or compromised
933 /// and the data must be updated or replaced to restore a valid
936 #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
939 /// The string contained one or more characters that
940 /// the device could not render and were skipped.
942 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
945 /// The handle was closed, but the file was not deleted.
947 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
950 /// The handle was closed, but the data to the file was not
951 /// flushed properly.
953 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
956 /// The resulting buffer was too small, and the data was
957 /// truncated to the buffer size.
959 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
962 /// The data has not been updated within the timeframe set by
963 /// local policy for this type of data.
965 #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
968 Returns a 16-bit signature built from 2 ASCII characters.
970 This macro returns a 16-bit value built from the two ASCII characters specified
973 @param A The first ASCII character.
974 @param B The second ASCII character.
976 @return A 16-bit value built from the two ASCII characters specified by A and B.
979 #define SIGNATURE_16(A, B) ((A) | (B << 8))
982 Returns a 32-bit signature built from 4 ASCII characters.
984 This macro returns a 32-bit value built from the four ASCII characters specified
987 @param A The first ASCII character.
988 @param B The second ASCII character.
989 @param C The third ASCII character.
990 @param D The fourth ASCII character.
992 @return A 32-bit value built from the two ASCII characters specified by A, B,
996 #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
999 Returns a 64-bit signature built from 8 ASCII characters.
1001 This macro returns a 64-bit value built from the eight ASCII characters specified
1002 by A, B, C, D, E, F, G,and H.
1004 @param A The first ASCII character.
1005 @param B The second ASCII character.
1006 @param C The third ASCII character.
1007 @param D The fourth ASCII character.
1008 @param E The fifth ASCII character.
1009 @param F The sixth ASCII character.
1010 @param G The seventh ASCII character.
1011 @param H The eighth ASCII character.
1013 @return A 64-bit value built from the two ASCII characters specified by A, B,
1014 C, D, E, F, G and H.
1017 #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
1018 (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))