Root include file for Mde Package Base type modules.
|
Data Structures |
| struct | GUID |
| struct | _LIST_ENTRY |
Defines |
| #define | CONST const |
| #define | STATIC static |
| #define | VOID void |
| #define | IN |
| #define | OUT |
| #define | OPTIONAL |
| #define | TRUE ((BOOLEAN)(1==1)) |
| #define | FALSE ((BOOLEAN)(0==1)) |
| #define | NULL ((VOID *) 0) |
| #define | BIT0 0x00000001 |
| #define | BIT1 0x00000002 |
| #define | BIT2 0x00000004 |
| #define | BIT3 0x00000008 |
| #define | BIT4 0x00000010 |
| #define | BIT5 0x00000020 |
| #define | BIT6 0x00000040 |
| #define | BIT7 0x00000080 |
| #define | BIT8 0x00000100 |
| #define | BIT9 0x00000200 |
| #define | BIT10 0x00000400 |
| #define | BIT11 0x00000800 |
| #define | BIT12 0x00001000 |
| #define | BIT13 0x00002000 |
| #define | BIT14 0x00004000 |
| #define | BIT15 0x00008000 |
| #define | BIT16 0x00010000 |
| #define | BIT17 0x00020000 |
| #define | BIT18 0x00040000 |
| #define | BIT19 0x00080000 |
| #define | BIT20 0x00100000 |
| #define | BIT21 0x00200000 |
| #define | BIT22 0x00400000 |
| #define | BIT23 0x00800000 |
| #define | BIT24 0x01000000 |
| #define | BIT25 0x02000000 |
| #define | BIT26 0x04000000 |
| #define | BIT27 0x08000000 |
| #define | BIT28 0x10000000 |
| #define | BIT29 0x20000000 |
| #define | BIT30 0x40000000 |
| #define | BIT31 0x80000000 |
| #define | BIT32 0x0000000100000000UL |
| #define | BIT33 0x0000000200000000UL |
| #define | BIT34 0x0000000400000000UL |
| #define | BIT35 0x0000000800000000UL |
| #define | BIT36 0x0000001000000000UL |
| #define | BIT37 0x0000002000000000UL |
| #define | BIT38 0x0000004000000000UL |
| #define | BIT39 0x0000008000000000UL |
| #define | BIT40 0x0000010000000000UL |
| #define | BIT41 0x0000020000000000UL |
| #define | BIT42 0x0000040000000000UL |
| #define | BIT43 0x0000080000000000UL |
| #define | BIT44 0x0000100000000000UL |
| #define | BIT45 0x0000200000000000UL |
| #define | BIT46 0x0000400000000000UL |
| #define | BIT47 0x0000800000000000UL |
| #define | BIT48 0x0001000000000000UL |
| #define | BIT49 0x0002000000000000UL |
| #define | BIT50 0x0004000000000000UL |
| #define | BIT51 0x0008000000000000UL |
| #define | BIT52 0x0010000000000000UL |
| #define | BIT53 0x0020000000000000UL |
| #define | BIT54 0x0040000000000000UL |
| #define | BIT55 0x0080000000000000UL |
| #define | BIT56 0x0100000000000000UL |
| #define | BIT57 0x0200000000000000UL |
| #define | BIT58 0x0400000000000000UL |
| #define | BIT59 0x0800000000000000UL |
| #define | BIT60 0x1000000000000000UL |
| #define | BIT61 0x2000000000000000UL |
| #define | BIT62 0x4000000000000000UL |
| #define | BIT63 0x8000000000000000UL |
| #define | _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1)) |
| #define | VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v)) |
| #define | VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t))) |
| #define | VA_END(ap) (ap = (VA_LIST) 0) |
| #define | OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field)) |
| #define | _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field))) |
| | CONTAINING_RECORD - returns a pointer to the structure from one of it's elements.
|
| #define | ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1))) |
| | ALIGN_VALUE - aligns a value up to the next boundary of the given alignment.
|
| #define | ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment)))) |
| | ALIGN_POINTER - aligns a pointer to the lowest boundry.
|
| #define | ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN)) |
| | ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor.
|
| #define | MAX(a, b) (((a) > (b)) ? (a) : (b)) |
| #define | MIN(a, b) (((a) < (b)) ? (a) : (b)) |
| #define | ENCODE_ERROR(a) (MAX_BIT | (a)) |
| | Set the upper bit to indicate EFI Error.
|
| #define | ENCODE_WARNING(a) (a) |
| #define | RETURN_ERROR(a) ((INTN) (a) < 0) |
| #define | RETURN_SUCCESS 0 |
| #define | RETURN_LOAD_ERROR ENCODE_ERROR (1) |
| #define | RETURN_INVALID_PARAMETER ENCODE_ERROR (2) |
| #define | RETURN_UNSUPPORTED ENCODE_ERROR (3) |
| #define | RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4) |
| #define | RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5) |
| #define | RETURN_NOT_READY ENCODE_ERROR (6) |
| #define | RETURN_DEVICE_ERROR ENCODE_ERROR (7) |
| #define | RETURN_WRITE_PROTECTED ENCODE_ERROR (8) |
| #define | RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9) |
| #define | RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10) |
| #define | RETURN_VOLUME_FULL ENCODE_ERROR (11) |
| #define | RETURN_NO_MEDIA ENCODE_ERROR (12) |
| #define | RETURN_MEDIA_CHANGED ENCODE_ERROR (13) |
| #define | RETURN_NOT_FOUND ENCODE_ERROR (14) |
| #define | RETURN_ACCESS_DENIED ENCODE_ERROR (15) |
| #define | RETURN_NO_RESPONSE ENCODE_ERROR (16) |
| #define | RETURN_NO_MAPPING ENCODE_ERROR (17) |
| #define | RETURN_TIMEOUT ENCODE_ERROR (18) |
| #define | RETURN_NOT_STARTED ENCODE_ERROR (19) |
| #define | RETURN_ALREADY_STARTED ENCODE_ERROR (20) |
| #define | RETURN_ABORTED ENCODE_ERROR (21) |
| #define | RETURN_ICMP_ERROR ENCODE_ERROR (22) |
| #define | RETURN_TFTP_ERROR ENCODE_ERROR (23) |
| #define | RETURN_PROTOCOL_ERROR ENCODE_ERROR (24) |
| #define | RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25) |
| #define | RETURN_SECURITY_VIOLATION ENCODE_ERROR (26) |
| #define | RETURN_CRC_ERROR ENCODE_ERROR (27) |
| #define | RETURN_END_OF_MEDIA ENCODE_ERROR (28) |
| #define | RETURN_END_OF_FILE ENCODE_ERROR (31) |
| #define | RETURN_INVALID_LANGUAGE ENCODE_ERROR (32) |
| #define | RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1) |
| #define | RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2) |
| #define | RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3) |
| #define | RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4) |
| #define | SIGNATURE_16(A, B) ((A) | (B << 8)) |
| | Returns a 16-bit signature built from 2 ASCII characters.
|
| #define | SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16)) |
| | Returns a 32-bit signature built from 4 ASCII characters.
|
| #define | SIGNATURE_64(A, B, C, D, E, F, G, H) (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32)) |
| | Returns a 64-bit signature built from 8 ASCII characters.
|
Typedefs |
| typedef UINT64 | PHYSICAL_ADDRESS |
| typedef struct _LIST_ENTRY | LIST_ENTRY |
| | LIST_ENTRY definition.
|
| typedef CHAR8 * | VA_LIST |
| typedef INTN | RETURN_STATUS |
Root include file for Mde Package Base type modules.
This is the include file for any module of type base. Base modules only use types defined via this include file and can be ported easily to any environment. There are a set of base libraries in the Mde Package that can be used to implement base modules.
Copyright (c) 2006 - 2008, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
