//\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
+///\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
//\r
typedef UINT64 PHYSICAL_ADDRESS;\r
\r
-//\r
-// LIST_ENTRY definition.\r
-//\r
+///\r
+/// LIST_ENTRY structure definition.\r
+///\r
typedef struct _LIST_ENTRY LIST_ENTRY;\r
\r
+///\r
+/// _LIST_ENTRY structure definition.\r
+///\r
struct _LIST_ENTRY {\r
LIST_ENTRY *ForwardLink;\r
LIST_ENTRY *BackLink;\r
//\r
// Modifiers to abstract standard types to aid in debug of problems\r
//\r
+\r
+///\r
+/// Datum is read-only\r
+///\r
#define CONST const\r
+\r
+///\r
+/// Datum is scoped to the current file or function\r
+///\r
#define STATIC static\r
+\r
+///\r
+/// Undeclared type\r
+///\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
+\r
+///\r
+/// Datum is passed to the function\r
+///\r
#define IN\r
+\r
+///\r
+/// Datum is returned from the function\r
+///\r
#define OUT\r
+\r
+///\r
+/// Passing the datum to the function is optional, and a NULL\r
+/// be passed if the value is not supplied.\r
+///\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
+\r
+///\r
+/// Boolean true value. UEFI Specification defines this value to be 1,\r
+/// but this form is more portable.\r
+///\r
#define TRUE ((BOOLEAN)(1==1))\r
+\r
+///\r
+/// Boolean false value. UEFI Specification defines this value to be 0,\r
+/// but this form is more portable.\r
+///\r
#define FALSE ((BOOLEAN)(0==1))\r
\r
-//\r
-// NULL pointer (VOID *)\r
-//\r
+///\r
+/// NULL pointer (VOID *)\r
+///\r
#define NULL ((VOID *) 0)\r
\r
\r
#define BIT29 0x20000000\r
#define BIT30 0x40000000\r
#define BIT31 0x80000000\r
-#define BIT32 0x0000000100000000UL\r
-#define BIT33 0x0000000200000000UL\r
-#define BIT34 0x0000000400000000UL\r
-#define BIT35 0x0000000800000000UL\r
-#define BIT36 0x0000001000000000UL\r
-#define BIT37 0x0000002000000000UL\r
-#define BIT38 0x0000004000000000UL\r
-#define BIT39 0x0000008000000000UL\r
-#define BIT40 0x0000010000000000UL\r
-#define BIT41 0x0000020000000000UL\r
-#define BIT42 0x0000040000000000UL\r
-#define BIT43 0x0000080000000000UL\r
-#define BIT44 0x0000100000000000UL\r
-#define BIT45 0x0000200000000000UL\r
-#define BIT46 0x0000400000000000UL\r
-#define BIT47 0x0000800000000000UL\r
-#define BIT48 0x0001000000000000UL\r
-#define BIT49 0x0002000000000000UL\r
-#define BIT50 0x0004000000000000UL\r
-#define BIT51 0x0008000000000000UL\r
-#define BIT52 0x0010000000000000UL\r
-#define BIT53 0x0020000000000000UL\r
-#define BIT54 0x0040000000000000UL\r
-#define BIT55 0x0080000000000000UL\r
-#define BIT56 0x0100000000000000UL\r
-#define BIT57 0x0200000000000000UL\r
-#define BIT58 0x0400000000000000UL\r
-#define BIT59 0x0800000000000000UL\r
-#define BIT60 0x1000000000000000UL\r
-#define BIT61 0x2000000000000000UL\r
-#define BIT62 0x4000000000000000UL\r
-#define BIT63 0x8000000000000000UL\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
//\r
\r
+/**\r
+ Return the size of argument that has been aligned to sizeof (UINTN).\r
+\r
+ @param n The parameter size is to be aligned.\r
+\r
+ @return The aligned size\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
+///\r
+/// Pointer to the start of a variable argument list. Same as CHAR8 *.\r
+///\r
typedef CHAR8 *VA_LIST;\r
\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
+#define BASE_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
#define MIN(a, b) \\r
(((a) < (b)) ? (a) : (b))\r
\r
-\r
//\r
-// EFI Error Codes common to all execution phases\r
+// Status 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
+ Produces a RETURN_STATUS code with the highest bit set. \r
+\r
+ @param StatusCode The status code value to convert into a warning code. \r
+ StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
\r
-#define ENCODE_WARNING(a) (a)\r
-#define RETURN_ERROR(a) ((INTN) (a) < 0)\r
+ @return The value specified by StatusCode with the highest bit set.\r
+\r
+**/\r
+#define ENCODE_ERROR(StatusCode) (MAX_BIT | (StatusCode))\r
\r
+/**\r
+ Produces a RETURN_STATUS code with the highest bit clear. \r
+\r
+ @param StatusCode The status code value to convert into a warning code. \r
+ StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
+\r
+ @return The value specified by StatusCode with the highest bit clear.\r
+\r
+**/\r
+#define ENCODE_WARNING(StatusCode) (StatusCode)\r
+\r
+/**\r
+ Returns TRUE if a specified RETURN_STATUS code is an error code. \r
+\r
+ This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. \r
+ \r
+ @param StatusCode The status code value to evaluate.\r
+\r
+ @retval TRUE The high bit of StatusCode is set.\r
+ @retval FALSE The high bit of StatusCode is clear.\r
+\r
+**/\r
+#define RETURN_ERROR(StatusCode) ((INTN) (StatusCode) < 0)\r
+\r
+///\r
+/// The operation completed successfully.\r
+///\r
#define RETURN_SUCCESS 0\r
+\r
+///\r
+/// The image failed to load.\r
+///\r
#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
+\r
+///\r
+/// The parameter was incorrect.\r
+///\r
#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
+\r
+///\r
+/// The operation is not supported.\r
+///\r
#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
+\r
+///\r
+/// The buffer was not the proper size for the request.\r
+///\r
#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
+\r
+///\r
+/// The buffer was not large enough to hold the requested data.\r
+/// The required buffer size is returned in the appropriate\r
+/// parameter when this error occurs.\r
+///\r
#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
+\r
+///\r
+/// There is no data pending upon return.\r
+///\r
#define RETURN_NOT_READY ENCODE_ERROR (6)\r
+\r
+///\r
+/// The physical device reported an error while attempting the\r
+/// operation.\r
+///\r
#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
+\r
+///\r
+/// The device can not be written to.\r
+///\r
#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
+\r
+///\r
+/// The resource has run out.\r
+///\r
#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
+\r
+///\r
+/// An inconsistency was detected on the file system causing the \r
+/// operation to fail.\r
+///\r
#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
+\r
+///\r
+/// There is no more space on the file system.\r
+///\r
#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
+\r
+///\r
+/// The device does not contain any medium to perform the \r
+/// operation.\r
+///\r
#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
+\r
+///\r
+/// The medium in the device has changed since the last\r
+/// access.\r
+///\r
#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
+\r
+///\r
+/// The item was not found.\r
+///\r
#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
+\r
+///\r
+/// Access was denied.\r
+///\r
#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
+\r
+///\r
+/// The server was not found or did not respond to the request.\r
+///\r
#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
+\r
+///\r
+/// A mapping to the device does not exist.\r
+///\r
#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
+\r
+///\r
+/// A timeout time expired.\r
+///\r
#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
+\r
+///\r
+/// The protocol has not been started.\r
+///\r
#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
+\r
+///\r
+/// The protocol has already been started.\r
+///\r
#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
+\r
+///\r
+/// The operation was aborted.\r
+///\r
#define RETURN_ABORTED ENCODE_ERROR (21)\r
+\r
+///\r
+/// An ICMP error occurred during the network operation.\r
+///\r
#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
+\r
+///\r
+/// A TFTP error occurred during the network operation.\r
+///\r
#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
+\r
+///\r
+/// A protocol error occurred during the network operation.\r
+///\r
#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
+\r
+///\r
+/// A function encountered an internal version that was\r
+/// incompatible with a version requested by the caller.\r
+///\r
#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
+\r
+///\r
+/// The function was not performed due to a security violation.\r
+///\r
#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
+\r
+///\r
+/// A CRC error was detected.\r
+///\r
#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
+\r
+///\r
+/// Beginning or end of media was reached.\r
+///\r
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
+\r
+///\r
+/// The end of the file was reached.\r
+///\r
#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
+\r
+///\r
+/// The language specified was invalid.\r
+///\r
#define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r
\r
\r
+///\r
+/// The Unicode string contained one or more characters that\r
+/// the device could not render and were skipped.\r
+///\r
#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
+\r
+///\r
+/// The handle was closed, but the file was not deleted.\r
+///\r
#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
+\r
+///\r
+/// The handle was closed, but the data to the file was not\r
+/// flushed properly.\r
+///\r
#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
+\r
+///\r
+/// The resulting buffer was too small, and the data was \r
+/// truncated to the buffer size.\r
+///\r
#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
\r
/**\r
projects / mirror_edk2.git / blobdiff