[mirror_edk2.git] / MdePkg / Include / Base.h

/** @file\r
  Root include file for Mde Package Base type modules\r
\r
  This is the include file for any module of type base. Base modules only use \r
  types defined via this include file and can be ported easily to any \r
  environment. There are a set of base libraries in the Mde Package that can\r
  be used to implement base modules.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#ifndef __BASE_H__\r
#define __BASE_H__\r
\r
//\r
// Include processor specific binding\r
//\r
#include <ProcessorBind.h>\r
\r
\r
//\r
// 128 bit buffer containing a unique identifier value.  \r
// Unless otherwise specified, aligned on a 64 bit boundary.\r
//\r
typedef struct {\r
  UINT32  Data1;\r
  UINT16  Data2;\r
  UINT16  Data3;\r
  UINT8   Data4[8];\r
} GUID;\r
\r
//\r
// 8-bytes unsigned value that represents a physical system address.\r
//\r
typedef UINT64 PHYSICAL_ADDRESS;\r
\r
///\r
/// LIST_ENTRY definition.\r
///\r
typedef struct _LIST_ENTRY LIST_ENTRY;\r
\r
struct _LIST_ENTRY {\r
  LIST_ENTRY  *ForwardLink;\r
  LIST_ENTRY  *BackLink;\r
};\r
\r
//\r
// Modifiers to abstract standard types to aid in debug of problems\r
//\r
#define CONST     const\r
#define STATIC    static\r
#define VOID      void\r
\r
//\r
// Modifiers for Data Types used to self document code.\r
// This concept is borrowed for UEFI specification.\r
//\r
#define IN\r
#define OUT\r
#define OPTIONAL\r
\r
//\r
//  UEFI specification claims 1 and 0. We are concerned about the \r
//  complier portability so we did it this way.\r
//\r
#define TRUE  ((BOOLEAN)(1==1))\r
#define FALSE ((BOOLEAN)(0==1))\r
\r
//\r
// NULL pointer (VOID *)\r
//\r
#define NULL  ((VOID *) 0)\r
\r
\r
#define  BIT0     0x00000001\r
#define  BIT1     0x00000002\r
#define  BIT2     0x00000004\r
#define  BIT3     0x00000008\r
#define  BIT4     0x00000010\r
#define  BIT5     0x00000020\r
#define  BIT6     0x00000040\r
#define  BIT7     0x00000080\r
#define  BIT8     0x00000100\r
#define  BIT9     0x00000200\r
#define  BIT10    0x00000400\r
#define  BIT11    0x00000800\r
#define  BIT12    0x00001000\r
#define  BIT13    0x00002000\r
#define  BIT14    0x00004000\r
#define  BIT15    0x00008000\r
#define  BIT16    0x00010000\r
#define  BIT17    0x00020000\r
#define  BIT18    0x00040000\r
#define  BIT19    0x00080000\r
#define  BIT20    0x00100000\r
#define  BIT21    0x00200000\r
#define  BIT22    0x00400000\r
#define  BIT23    0x00800000\r
#define  BIT24    0x01000000\r
#define  BIT25    0x02000000\r
#define  BIT26    0x04000000\r
#define  BIT27    0x08000000\r
#define  BIT28    0x10000000\r
#define  BIT29    0x20000000\r
#define  BIT30    0x40000000\r
#define  BIT31    0x80000000\r
#define  BIT32    0x0000000100000000ULL\r
#define  BIT33    0x0000000200000000ULL\r
#define  BIT34    0x0000000400000000ULL\r
#define  BIT35    0x0000000800000000ULL\r
#define  BIT36    0x0000001000000000ULL\r
#define  BIT37    0x0000002000000000ULL\r
#define  BIT38    0x0000004000000000ULL\r
#define  BIT39    0x0000008000000000ULL\r
#define  BIT40    0x0000010000000000ULL\r
#define  BIT41    0x0000020000000000ULL\r
#define  BIT42    0x0000040000000000ULL\r
#define  BIT43    0x0000080000000000ULL\r
#define  BIT44    0x0000100000000000ULL\r
#define  BIT45    0x0000200000000000ULL\r
#define  BIT46    0x0000400000000000ULL\r
#define  BIT47    0x0000800000000000ULL\r
#define  BIT48    0x0001000000000000ULL\r
#define  BIT49    0x0002000000000000ULL\r
#define  BIT50    0x0004000000000000ULL\r
#define  BIT51    0x0008000000000000ULL\r
#define  BIT52    0x0010000000000000ULL\r
#define  BIT53    0x0020000000000000ULL\r
#define  BIT54    0x0040000000000000ULL\r
#define  BIT55    0x0080000000000000ULL\r
#define  BIT56    0x0100000000000000ULL\r
#define  BIT57    0x0200000000000000ULL\r
#define  BIT58    0x0400000000000000ULL\r
#define  BIT59    0x0800000000000000ULL\r
#define  BIT60    0x1000000000000000ULL\r
#define  BIT61    0x2000000000000000ULL\r
#define  BIT62    0x4000000000000000ULL\r
#define  BIT63    0x8000000000000000ULL\r
\r
//\r
//  Support for variable length argument lists using the ANSI standard.\r
//  \r
//  Since we are using the ANSI standard we used the standard naming and\r
//  did not follow the coding convention\r
//\r
//  VA_LIST  - typedef for argument list.\r
//  VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
//  VA_END (VA_LIST Marker) - Clear Marker\r
//  VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r
//    the ... list. You must know the size and pass it in this macro.\r
//\r
//  example:\r
//\r
//  UINTN\r
//  ExampleVarArg (\r
//    IN UINTN  NumberOfArgs,\r
//    ...\r
//    )\r
//  {\r
//    VA_LIST Marker;\r
//    UINTN   Index;\r
//    UINTN   Result;\r
//\r
//    //\r
//    // Initialize the Marker\r
//    //\r
//    VA_START (Marker, NumberOfArgs);\r
//    for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
//      //\r
//      // The ... list is a series of UINTN values, so average them up.\r
//      //\r
//      Result += VA_ARG (Marker, UINTN);\r
//    }\r
//\r
//    VA_END (Marker);\r
//    return Result\r
//  }\r
//\r
\r
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
\r
//\r
// Pointer to the start of a variable argument list. Same as UINT8 *.\r
//\r
typedef CHAR8 *VA_LIST;\r
\r
/**\r
  Retrieves a pointer to the beginning of a variable argument list based on \r
  the name of the parameter that immediately precedes the variable argument list. \r
\r
  This function initializes Marker to point to the beginning of the variable argument \r
  list that immediately follows Parameter.  The method for computing the pointer to the \r
  next argument in the argument list is CPU specific following the EFIAPI ABI.\r
\r
  @param   Marker       Pointer to the beginning of the variable argument list.\r
  @param   Parameter    The name of the parameter that immediately precedes \r
                        the variable argument list.\r
  \r
  @return  A pointer to the beginning of a variable argument list.\r
\r
**/\r
#define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\r
\r
/**\r
  Returns an argument of a specified type from a variable argument list and updates \r
  the pointer to the variable argument list to point to the next argument. \r
\r
  This function returns an argument of the type specified by TYPE from the beginning \r
  of the variable argument list specified by Marker.  Marker is then updated to point \r
  to the next argument in the variable argument list.  The method for computing the \r
  pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
\r
  @param   Marker   Pointer to the beginning of a variable argument list.\r
  @param   TYPE     The type of argument to retrieve from the beginning \r
                    of the variable argument list.\r
  \r
  @return  An argument of the type specified by TYPE.\r
\r
**/\r
#define VA_ARG(Marker, TYPE)   (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r
\r
/**\r
  Terminates the use of a variable argument list.\r
\r
  This function initializes Marker so it can no longer be used with VA_ARG().  \r
  After this macro is used, the only way to access the variable argument list again is \r
  by using VA_START() again.\r
\r
  @param   Marker   The variable to set to the beginning of the variable argument list.\r
  \r
**/\r
#define VA_END(Marker)      (Marker = (VA_LIST) 0)\r
\r
/**\r
  Macro that returns the byte offset of a field in a data structure. \r
\r
  This function returns the offset, in bytes, of field specified by Field from the \r
  beginning of the  data structure specified by TYPE. If TYPE does not contain Field, \r
  the module will not compile.  \r
\r
  @param   TYPE     The name of the data structure that contains the field specified by Field. \r
  @param   Field    The name of the field in the data structure.\r
  \r
  @return  Offset, in bytes, of field.\r
  \r
**/\r
#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
\r
/**\r
  Macro that returns a pointer to the data structure that contains a specified field of \r
  that data structure.  This is a lightweight method to hide information by placing a \r
  public data structure inside a larger private data structure and using a pointer to \r
  the public data structure to retrieve a pointer to the private data structure.\r
\r
  This function computes the offset, in bytes, of field specified by Field from the beginning \r
  of the  data structure specified by TYPE.  This offset is subtracted from Record, and is \r
  used to return a pointer to a data structure of the type specified by TYPE.If the data type \r
  specified by TYPE does not contain the field specified by Field, then the module will not compile. \r
   \r
  @param   Record   Pointer to the field specified by Field within a data structure of type TYPE. \r
  @param   TYPE     The name of the data structure type to return.  This data structure must \r
                    contain the field specified by Field. \r
  @param   Field    The name of the field in the data structure specified by TYPE to which Record points.\r
  \r
  @return  A pointer to the structure from one of it's elements.\r
  \r
**/\r
#define _CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
\r
/**\r
  Rounds a value up to the next boundary using a specified alignment.  \r
\r
  This function rounds Value up to the next boundary using the specified Alignment.  \r
  This aligned value is returned.  \r
\r
  @param   Value      The value to round up.\r
  @param   Alignment  The alignment boundary used to return the aligned value.\r
  \r
  @return  A value up to the next boundary.\r
  \r
**/\r
#define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
\r
/**\r
  Adjust a pointer by adding the minimum offset required for it to be aligned on \r
  a specified alignment boundary.  \r
\r
  This function rounds the pointer specified by Pointer to the next alignment boundary \r
  specified by Alignment. The pointer to the aligned address is returned.  \r
\r
  @param   Value      The value to round up.\r
  @param   Alignment  The alignment boundary to use to return an aligned pointer.\r
  \r
  @return  Pointer to the aligned address.\r
  \r
**/\r
#define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
\r
/**\r
  Rounds a value up to the next natural boundary for the current CPU.  \r
  This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.   \r
\r
  This function rounds the value specified by Value up to the next natural boundary for the \r
  current CPU. This rounded value is returned.  \r
\r
  @param   Value      The value to round up.\r
\r
  @return  Rounded value specified by Value.\r
  \r
**/\r
#define ALIGN_VARIABLE(Value)  ALIGN_VALUE ((Value), sizeof (UINTN))\r
  \r
\r
/**\r
  Return the maximum of two operands. \r
\r
  This macro returns the maximum of two operand specified by a and b.  \r
  Both a and b must be the same numerical types, signed or unsigned.\r
\r
  @param   TYPE     Any numerical data types.\r
  @param   a        The first operand with any numerical type.\r
  @param   b        The second operand. It should be the same any numerical type with a.\r
  \r
  @return  Maximum of two operands.\r
  \r
**/\r
#define MAX(a, b)                       \\r
  (((a) > (b)) ? (a) : (b))\r
\r
/**\r
  Return the minimum of two operands. \r
\r
  This macro returns the minimal of two operand specified by a and b.  \r
  Both a and b must be the same numerical types, signed or unsigned.\r
\r
  @param   TYPE     Any numerical data types.\r
  @param   a        The first operand with any numerical type.\r
  @param   b        The second operand. It should be the same any numerical type with a.\r
  \r
  @return  Minimum of two operands.\r
  \r
**/\r
\r
#define MIN(a, b)                       \\r
  (((a) < (b)) ? (a) : (b))\r
\r
\r
//\r
// EFI Error Codes common to all execution phases\r
//\r
\r
typedef INTN RETURN_STATUS;\r
\r
///\r
/// Set the upper bit to indicate EFI Error.\r
///\r
#define ENCODE_ERROR(a)              (MAX_BIT | (a))\r
\r
#define ENCODE_WARNING(a)            (a)\r
#define RETURN_ERROR(a)              ((INTN) (a) < 0)\r
\r
#define RETURN_SUCCESS               0\r
#define RETURN_LOAD_ERROR            ENCODE_ERROR (1)\r
#define RETURN_INVALID_PARAMETER     ENCODE_ERROR (2)\r
#define RETURN_UNSUPPORTED           ENCODE_ERROR (3)\r
#define RETURN_BAD_BUFFER_SIZE       ENCODE_ERROR (4)\r
#define RETURN_BUFFER_TOO_SMALL      ENCODE_ERROR (5)\r
#define RETURN_NOT_READY             ENCODE_ERROR (6)\r
#define RETURN_DEVICE_ERROR          ENCODE_ERROR (7)\r
#define RETURN_WRITE_PROTECTED       ENCODE_ERROR (8)\r
#define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)\r
#define RETURN_VOLUME_CORRUPTED      ENCODE_ERROR (10)\r
#define RETURN_VOLUME_FULL           ENCODE_ERROR (11)\r
#define RETURN_NO_MEDIA              ENCODE_ERROR (12)\r
#define RETURN_MEDIA_CHANGED         ENCODE_ERROR (13)\r
#define RETURN_NOT_FOUND             ENCODE_ERROR (14)\r
#define RETURN_ACCESS_DENIED         ENCODE_ERROR (15)\r
#define RETURN_NO_RESPONSE           ENCODE_ERROR (16)\r
#define RETURN_NO_MAPPING            ENCODE_ERROR (17)\r
#define RETURN_TIMEOUT               ENCODE_ERROR (18)\r
#define RETURN_NOT_STARTED           ENCODE_ERROR (19)\r
#define RETURN_ALREADY_STARTED       ENCODE_ERROR (20)\r
#define RETURN_ABORTED               ENCODE_ERROR (21)\r
#define RETURN_ICMP_ERROR            ENCODE_ERROR (22)\r
#define RETURN_TFTP_ERROR            ENCODE_ERROR (23)\r
#define RETURN_PROTOCOL_ERROR        ENCODE_ERROR (24)\r
#define RETURN_INCOMPATIBLE_VERSION  ENCODE_ERROR (25)\r
#define RETURN_SECURITY_VIOLATION    ENCODE_ERROR (26)\r
#define RETURN_CRC_ERROR             ENCODE_ERROR (27)\r
#define RETURN_END_OF_MEDIA          ENCODE_ERROR (28)\r
#define RETURN_END_OF_FILE           ENCODE_ERROR (31)\r
#define RETURN_INVALID_LANGUAGE      ENCODE_ERROR (32)\r
\r
\r
#define RETURN_WARN_UNKNOWN_GLYPH    ENCODE_WARNING (1)\r
#define RETURN_WARN_DELETE_FAILURE   ENCODE_WARNING (2)\r
#define RETURN_WARN_WRITE_FAILURE    ENCODE_WARNING (3)\r
#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
\r
/**\r
  Returns a 16-bit signature built from 2 ASCII characters.\r
  \r
  This macro returns a 16-bit value built from the two ASCII characters specified \r
  by A and B.\r
  \r
  @param  A    The first ASCII character.\r
  @param  B    The second ASCII character.\r
\r
  @return A 16-bit value built from the two ASCII characters specified by A and B.\r
\r
**/\r
#define SIGNATURE_16(A, B)        ((A) | (B << 8))\r
\r
/**\r
  Returns a 32-bit signature built from 4 ASCII characters.\r
  \r
  This macro returns a 32-bit value built from the four ASCII characters specified \r
  by A, B, C, and D.\r
  \r
  @param  A    The first ASCII character.\r
  @param  B    The second ASCII character.\r
  @param  C    The third ASCII character.\r
  @param  D    The fourth ASCII character.\r
\r
  @return A 32-bit value built from the two ASCII characters specified by A, B,\r
          C and D.\r
\r
**/\r
#define SIGNATURE_32(A, B, C, D)  (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r
\r
/**\r
  Returns a 64-bit signature built from 8 ASCII characters.\r
  \r
  This macro returns a 64-bit value built from the eight ASCII characters specified \r
  by A, B, C, D, E, F, G,and H.\r
  \r
  @param  A    The first ASCII character.\r
  @param  B    The second ASCII character.\r
  @param  C    The third ASCII character.\r
  @param  D    The fourth ASCII character.\r
  @param  E    The fifth ASCII character.\r
  @param  F    The sixth ASCII character.\r
  @param  G    The seventh ASCII character.\r
  @param  H    The eighth ASCII character.\r
\r
  @return A 64-bit value built from the two ASCII characters specified by A, B,\r
          C, D, E, F, G and H.\r
\r
**/\r
#define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
    (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
\r
#endif\r
\r
Commit	Line	Data
959ccb23	1	/** @file\r
959ccb23	2	Root include file for Mde Package Base type modules\r
	3	\r
	4	This is the include file for any module of type base. Base modules only use \r
	5	types defined via this include file and can be ported easily to any \r
	6	environment. There are a set of base libraries in the Mde Package that can\r
	7	be used to implement base modules.\r
	8	\r
3963c4bf	9	Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
959ccb23	10	All rights reserved. This program and the accompanying materials\r
	11	are licensed and made available under the terms and conditions of the BSD License\r
	12	which accompanies this distribution. The full text of the license may be found at\r
	13	http://opensource.org/licenses/bsd-license.php\r
	14	\r
	15	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	16	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	17	\r
	18	**/\r
	19	\r
	20	\r
	21	#ifndef __BASE_H__\r
	22	#define __BASE_H__\r
	23	\r
	24	//\r
	25	// Include processor specific binding\r
	26	//\r
	27	#include <ProcessorBind.h>\r
	28	\r
3963c4bf	29	\r
	30	//\r
	31	// 128 bit buffer containing a unique identifier value. \r
	32	// Unless otherwise specified, aligned on a 64 bit boundary.\r
	33	//\r
959ccb23	34	typedef struct {\r
	35	UINT32 Data1;\r
	36	UINT16 Data2;\r
	37	UINT16 Data3;\r
	38	UINT8 Data4[8];\r
	39	} GUID;\r
	40	\r
3963c4bf	41	//\r
	42	// 8-bytes unsigned value that represents a physical system address.\r
	43	//\r
959ccb23	44	typedef UINT64 PHYSICAL_ADDRESS;\r
959ccb23	45	\r
62991af2	46	///\r
	47	/// LIST_ENTRY definition.\r
	48	///\r
959ccb23	49	typedef struct _LIST_ENTRY LIST_ENTRY;\r
	50	\r
	51	struct _LIST_ENTRY {\r
	52	LIST_ENTRY *ForwardLink;\r
	53	LIST_ENTRY *BackLink;\r
	54	};\r
	55	\r
	56	//\r
3963c4bf	57	// Modifiers to abstract standard types to aid in debug of problems\r
959ccb23	58	//\r
	59	#define CONST const\r
	60	#define STATIC static\r
	61	#define VOID void\r
	62	\r
	63	//\r
	64	// Modifiers for Data Types used to self document code.\r
	65	// This concept is borrowed for UEFI specification.\r
	66	//\r
959ccb23	67	#define IN\r
	68	#define OUT\r
	69	#define OPTIONAL\r
959ccb23	70	\r
959ccb23	71	//\r
	72	// UEFI specification claims 1 and 0. We are concerned about the \r
	73	// complier portability so we did it this way.\r
	74	//\r
	75	#define TRUE ((BOOLEAN)(1==1))\r
959ccb23	76	#define FALSE ((BOOLEAN)(0==1))\r
959ccb23	77	\r
3963c4bf	78	//\r
	79	// NULL pointer (VOID *)\r
	80	//\r
959ccb23	81	#define NULL ((VOID *) 0)\r
959ccb23	82	\r
3963c4bf	83	\r
959ccb23	84	#define BIT0 0x00000001\r
	85	#define BIT1 0x00000002\r
	86	#define BIT2 0x00000004\r
	87	#define BIT3 0x00000008\r
	88	#define BIT4 0x00000010\r
	89	#define BIT5 0x00000020\r
	90	#define BIT6 0x00000040\r
	91	#define BIT7 0x00000080\r
	92	#define BIT8 0x00000100\r
	93	#define BIT9 0x00000200\r
	94	#define BIT10 0x00000400\r
	95	#define BIT11 0x00000800\r
	96	#define BIT12 0x00001000\r
	97	#define BIT13 0x00002000\r
	98	#define BIT14 0x00004000\r
	99	#define BIT15 0x00008000\r
	100	#define BIT16 0x00010000\r
	101	#define BIT17 0x00020000\r
	102	#define BIT18 0x00040000\r
	103	#define BIT19 0x00080000\r
	104	#define BIT20 0x00100000\r
	105	#define BIT21 0x00200000\r
	106	#define BIT22 0x00400000\r
	107	#define BIT23 0x00800000\r
	108	#define BIT24 0x01000000\r
	109	#define BIT25 0x02000000\r
	110	#define BIT26 0x04000000\r
	111	#define BIT27 0x08000000\r
	112	#define BIT28 0x10000000\r
	113	#define BIT29 0x20000000\r
	114	#define BIT30 0x40000000\r
	115	#define BIT31 0x80000000\r
4d24730c	116	#define BIT32 0x0000000100000000ULL\r
	117	#define BIT33 0x0000000200000000ULL\r
	118	#define BIT34 0x0000000400000000ULL\r
	119	#define BIT35 0x0000000800000000ULL\r
	120	#define BIT36 0x0000001000000000ULL\r
	121	#define BIT37 0x0000002000000000ULL\r
	122	#define BIT38 0x0000004000000000ULL\r
	123	#define BIT39 0x0000008000000000ULL\r
	124	#define BIT40 0x0000010000000000ULL\r
	125	#define BIT41 0x0000020000000000ULL\r
	126	#define BIT42 0x0000040000000000ULL\r
	127	#define BIT43 0x0000080000000000ULL\r
	128	#define BIT44 0x0000100000000000ULL\r
	129	#define BIT45 0x0000200000000000ULL\r
	130	#define BIT46 0x0000400000000000ULL\r
	131	#define BIT47 0x0000800000000000ULL\r
	132	#define BIT48 0x0001000000000000ULL\r
	133	#define BIT49 0x0002000000000000ULL\r
	134	#define BIT50 0x0004000000000000ULL\r
	135	#define BIT51 0x0008000000000000ULL\r
	136	#define BIT52 0x0010000000000000ULL\r
	137	#define BIT53 0x0020000000000000ULL\r
	138	#define BIT54 0x0040000000000000ULL\r
	139	#define BIT55 0x0080000000000000ULL\r
	140	#define BIT56 0x0100000000000000ULL\r
	141	#define BIT57 0x0200000000000000ULL\r
	142	#define BIT58 0x0400000000000000ULL\r
	143	#define BIT59 0x0800000000000000ULL\r
	144	#define BIT60 0x1000000000000000ULL\r
	145	#define BIT61 0x2000000000000000ULL\r
	146	#define BIT62 0x4000000000000000ULL\r
	147	#define BIT63 0x8000000000000000ULL\r
959ccb23	148	\r
	149	//\r
	150	// Support for variable length argument lists using the ANSI standard.\r
	151	// \r
3963c4bf	152	// Since we are using the ANSI standard we used the standard naming and\r
3963c4bf	153	// did not follow the coding convention\r
959ccb23	154	//\r
	155	// VA_LIST - typedef for argument list.\r
	156	// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
	157	// VA_END (VA_LIST Marker) - Clear Marker\r
3963c4bf	158	// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r
959ccb23	159	// the ... list. You must know the size and pass it in this macro.\r
	160	//\r
	161	// example:\r
	162	//\r
	163	// UINTN\r
	164	// ExampleVarArg (\r
	165	// IN UINTN NumberOfArgs,\r
	166	// ...\r
	167	// )\r
	168	// {\r
	169	// VA_LIST Marker;\r
	170	// UINTN Index;\r
	171	// UINTN Result;\r
	172	//\r
	173	// //\r
	174	// // Initialize the Marker\r
	175	// //\r
	176	// VA_START (Marker, NumberOfArgs);\r
	177	// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
	178	// //\r
	179	// // The ... list is a series of UINTN values, so average them up.\r
	180	// //\r
	181	// Result += VA_ARG (Marker, UINTN);\r
	182	// }\r
	183	//\r
	184	// VA_END (Marker);\r
	185	// return Result\r
	186	// }\r
	187	//\r
	188	\r
	189	#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
	190	\r
	191	//\r
3963c4bf	192	// Pointer to the start of a variable argument list. Same as UINT8 *.\r
959ccb23	193	//\r
959ccb23	194	typedef CHAR8 *VA_LIST;\r
959ccb23	195	\r
3963c4bf	196	/**\r
	197	Retrieves a pointer to the beginning of a variable argument list based on \r
	198	the name of the parameter that immediately precedes the variable argument list. \r
	199	\r
	200	This function initializes Marker to point to the beginning of the variable argument \r
	201	list that immediately follows Parameter. The method for computing the pointer to the \r
	202	next argument in the argument list is CPU specific following the EFIAPI ABI.\r
	203	\r
	204	@param Marker Pointer to the beginning of the variable argument list.\r
	205	@param Parameter The name of the parameter that immediately precedes \r
	206	the variable argument list.\r
	207	\r
	208	@return A pointer to the beginning of a variable argument list.\r
	209	\r
	210	**/\r
	211	#define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\r
	212	\r
	213	/**\r
	214	Returns an argument of a specified type from a variable argument list and updates \r
	215	the pointer to the variable argument list to point to the next argument. \r
	216	\r
	217	This function returns an argument of the type specified by TYPE from the beginning \r
	218	of the variable argument list specified by Marker. Marker is then updated to point \r
	219	to the next argument in the variable argument list. The method for computing the \r
	220	pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
	221	\r
	222	@param Marker Pointer to the beginning of a variable argument list.\r
	223	@param TYPE The type of argument to retrieve from the beginning \r
	224	of the variable argument list.\r
	225	\r
	226	@return An argument of the type specified by TYPE.\r
	227	\r
	228	**/\r
	229	#define VA_ARG(Marker, TYPE) ((TYPE ) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r
	230	\r
	231	/**\r
	232	Terminates the use of a variable argument list.\r
	233	\r
	234	This function initializes Marker so it can no longer be used with VA_ARG(). \r
	235	After this macro is used, the only way to access the variable argument list again is \r
	236	by using VA_START() again.\r
	237	\r
	238	@param Marker The variable to set to the beginning of the variable argument list.\r
	239	\r
	240	**/\r
	241	#define VA_END(Marker) (Marker = (VA_LIST) 0)\r
	242	\r
	243	/**\r
	244	Macro that returns the byte offset of a field in a data structure. \r
	245	\r
	246	This function returns the offset, in bytes, of field specified by Field from the \r
	247	beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r
	248	the module will not compile. \r
	249	\r
	250	@param TYPE The name of the data structure that contains the field specified by Field. \r
	251	@param Field The name of the field in the data structure.\r
	252	\r
	253	@return Offset, in bytes, of field.\r
	254	\r
	255	**/\r
959ccb23	256	#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
959ccb23	257	\r
3963c4bf	258	/**\r
	259	Macro that returns a pointer to the data structure that contains a specified field of \r
	260	that data structure. This is a lightweight method to hide information by placing a \r
	261	public data structure inside a larger private data structure and using a pointer to \r
	262	the public data structure to retrieve a pointer to the private data structure.\r
	263	\r
	264	This function computes the offset, in bytes, of field specified by Field from the beginning \r
	265	of the data structure specified by TYPE. This offset is subtracted from Record, and is \r
	266	used to return a pointer to a data structure of the type specified by TYPE.If the data type \r
	267	specified by TYPE does not contain the field specified by Field, then the module will not compile. \r
	268	\r
	269	@param Record Pointer to the field specified by Field within a data structure of type TYPE. \r
	270	@param TYPE The name of the data structure type to return. This data structure must \r
	271	contain the field specified by Field. \r
	272	@param Field The name of the field in the data structure specified by TYPE to which Record points.\r
	273	\r
	274	@return A pointer to the structure from one of it's elements.\r
	275	\r
	276	**/\r
959ccb23	277	#define _CR(Record, TYPE, Field) ((TYPE ) ((CHAR8 ) (Record) - (CHAR8 ) &(((TYPE ) 0)->Field)))\r
959ccb23	278	\r
3963c4bf	279	/**\r
	280	Rounds a value up to the next boundary using a specified alignment. \r
	281	\r
	282	This function rounds Value up to the next boundary using the specified Alignment. \r
	283	This aligned value is returned. \r
	284	\r
	285	@param Value The value to round up.\r
	286	@param Alignment The alignment boundary used to return the aligned value.\r
	287	\r
	288	@return A value up to the next boundary.\r
	289	\r
	290	**/\r
3fef0f51	291	#define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
3fef0f51	292	\r
3963c4bf	293	/**\r
	294	Adjust a pointer by adding the minimum offset required for it to be aligned on \r
	295	a specified alignment boundary. \r
	296	\r
	297	This function rounds the pointer specified by Pointer to the next alignment boundary \r
	298	specified by Alignment. The pointer to the aligned address is returned. \r
	299	\r
	300	@param Value The value to round up.\r
	301	@param Alignment The alignment boundary to use to return an aligned pointer.\r
	302	\r
	303	@return Pointer to the aligned address.\r
	304	\r
	305	**/\r
3fef0f51	306	#define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
959ccb23	307	\r
3963c4bf	308	/**\r
	309	Rounds a value up to the next natural boundary for the current CPU. \r
	310	This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs. \r
	311	\r
	312	This function rounds the value specified by Value up to the next natural boundary for the \r
	313	current CPU. This rounded value is returned. \r
	314	\r
	315	@param Value The value to round up.\r
	316	\r
	317	@return Rounded value specified by Value.\r
	318	\r
	319	**/\r
3fef0f51	320	#define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r
3fef0f51	321	\r
959ccb23	322	\r
3963c4bf	323	/**\r
	324	Return the maximum of two operands. \r
	325	\r
	326	This macro returns the maximum of two operand specified by a and b. \r
	327	Both a and b must be the same numerical types, signed or unsigned.\r
	328	\r
	329	@param TYPE Any numerical data types.\r
	330	@param a The first operand with any numerical type.\r
	331	@param b The second operand. It should be the same any numerical type with a.\r
	332	\r
	333	@return Maximum of two operands.\r
	334	\r
	335	**/\r
959ccb23	336	#define MAX(a, b) \\r
	337	(((a) > (b)) ? (a) : (b))\r
	338	\r
3963c4bf	339	/**\r
	340	Return the minimum of two operands. \r
	341	\r
	342	This macro returns the minimal of two operand specified by a and b. \r
	343	Both a and b must be the same numerical types, signed or unsigned.\r
	344	\r
	345	@param TYPE Any numerical data types.\r
	346	@param a The first operand with any numerical type.\r
	347	@param b The second operand. It should be the same any numerical type with a.\r
	348	\r
	349	@return Minimum of two operands.\r
	350	\r
	351	**/\r
959ccb23	352	\r
959ccb23	353	#define MIN(a, b) \\r
	354	(((a) < (b)) ? (a) : (b))\r
	355	\r
	356	\r
	357	//\r
	358	// EFI Error Codes common to all execution phases\r
	359	//\r
	360	\r
	361	typedef INTN RETURN_STATUS;\r
	362	\r
62991af2	363	///\r
	364	/// Set the upper bit to indicate EFI Error.\r
	365	///\r
959ccb23	366	#define ENCODE_ERROR(a) (MAX_BIT \| (a))\r
	367	\r
	368	#define ENCODE_WARNING(a) (a)\r
cdebf6c6	369	#define RETURN_ERROR(a) ((INTN) (a) < 0)\r
959ccb23	370	\r
	371	#define RETURN_SUCCESS 0\r
	372	#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
	373	#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
	374	#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
	375	#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
	376	#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
	377	#define RETURN_NOT_READY ENCODE_ERROR (6)\r
	378	#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
	379	#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
	380	#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
	381	#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
	382	#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
	383	#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
	384	#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
	385	#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
	386	#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
	387	#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
	388	#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
	389	#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
	390	#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
	391	#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
	392	#define RETURN_ABORTED ENCODE_ERROR (21)\r
	393	#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
	394	#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
	395	#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
	396	#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
	397	#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
	398	#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
	399	#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
	400	#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
54cf8780	401	#define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r
54cf8780	402	\r
959ccb23	403	\r
	404	#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
	405	#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
	406	#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
	407	#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
	408	\r
a7cc3d26	409	/**\r
	410	Returns a 16-bit signature built from 2 ASCII characters.\r
	411	\r
3963c4bf	412	This macro returns a 16-bit value built from the two ASCII characters specified \r
	413	by A and B.\r
	414	\r
ee6c452c	415	@param A The first ASCII character.\r
ee6c452c	416	@param B The second ASCII character.\r
a7cc3d26	417	\r
	418	@return A 16-bit value built from the two ASCII characters specified by A and B.\r
	419	\r
	420	**/\r
13c31065	421	#define SIGNATURE_16(A, B) ((A) \| (B << 8))\r
a7cc3d26	422	\r
	423	/**\r
	424	Returns a 32-bit signature built from 4 ASCII characters.\r
	425	\r
3963c4bf	426	This macro returns a 32-bit value built from the four ASCII characters specified \r
	427	by A, B, C, and D.\r
	428	\r
ee6c452c	429	@param A The first ASCII character.\r
	430	@param B The second ASCII character.\r
	431	@param C The third ASCII character.\r
	432	@param D The fourth ASCII character.\r
a7cc3d26	433	\r
	434	@return A 32-bit value built from the two ASCII characters specified by A, B,\r
	435	C and D.\r
	436	\r
	437	**/\r
13c31065	438	#define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) \| (SIGNATURE_16 (C, D) << 16))\r
a7cc3d26	439	\r
	440	/**\r
	441	Returns a 64-bit signature built from 8 ASCII characters.\r
	442	\r
3963c4bf	443	This macro returns a 64-bit value built from the eight ASCII characters specified \r
	444	by A, B, C, D, E, F, G,and H.\r
	445	\r
ee6c452c	446	@param A The first ASCII character.\r
	447	@param B The second ASCII character.\r
	448	@param C The third ASCII character.\r
	449	@param D The fourth ASCII character.\r
	450	@param E The fifth ASCII character.\r
	451	@param F The sixth ASCII character.\r
	452	@param G The seventh ASCII character.\r
	453	@param H The eighth ASCII character.\r
a7cc3d26	454	\r
	455	@return A 64-bit value built from the two ASCII characters specified by A, B,\r
	456	C, D, E, F, G and H.\r
	457	\r
	458	**/\r
13c31065	459	#define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
	460	(SIGNATURE_32 (A, B, C, D) \| ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
	461	\r
959ccb23	462	#endif\r
959ccb23	463	\r