]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Base.h
Update comment for return description for PcdSetX macros.
[mirror_edk2.git] / MdePkg / Include / Base.h
index b7b65697872ed700f25c9079c318398745943723..4eedffde0b8ed1bb150530c7b758fbd92072fc93 100644 (file)
@@ -70,7 +70,7 @@ struct _LIST_ENTRY {
 #define STATIC    static\r
 \r
 ///\r
-/// Undclared type\r
+/// Undeclared type\r
 ///\r
 #define VOID      void\r
 \r
@@ -183,6 +183,116 @@ struct _LIST_ENTRY {
 #define  BIT62    0x4000000000000000ULL\r
 #define  BIT63    0x8000000000000000ULL\r
 \r
+#define  SIZE_1KB    0x00000400\r
+#define  SIZE_2KB    0x00000800\r
+#define  SIZE_4KB    0x00001000\r
+#define  SIZE_8KB    0x00002000\r
+#define  SIZE_16KB   0x00004000\r
+#define  SIZE_32KB   0x00008000\r
+#define  SIZE_64KB   0x00010000\r
+#define  SIZE_128KB  0x00020000\r
+#define  SIZE_256KB  0x00040000\r
+#define  SIZE_512KB  0x00080000\r
+#define  SIZE_1MB    0x00100000\r
+#define  SIZE_2MB    0x00200000\r
+#define  SIZE_4MB    0x00400000\r
+#define  SIZE_8MB    0x00800000\r
+#define  SIZE_16MB   0x01000000\r
+#define  SIZE_32MB   0x02000000\r
+#define  SIZE_64MB   0x04000000\r
+#define  SIZE_128MB  0x08000000\r
+#define  SIZE_256MB  0x10000000\r
+#define  SIZE_512MB  0x20000000\r
+#define  SIZE_1GB    0x40000000\r
+#define  SIZE_2GB    0x80000000\r
+#define  SIZE_4GB    0x0000000100000000ULL\r
+#define  SIZE_8GB    0x0000000200000000ULL\r
+#define  SIZE_16GB   0x0000000400000000ULL\r
+#define  SIZE_32GB   0x0000000800000000ULL\r
+#define  SIZE_64GB   0x0000001000000000ULL\r
+#define  SIZE_128GB  0x0000002000000000ULL\r
+#define  SIZE_256GB  0x0000004000000000ULL\r
+#define  SIZE_512GB  0x0000008000000000ULL\r
+#define  SIZE_1TB    0x0000010000000000ULL\r
+#define  SIZE_2TB    0x0000020000000000ULL\r
+#define  SIZE_4TB    0x0000040000000000ULL\r
+#define  SIZE_8TB    0x0000080000000000ULL\r
+#define  SIZE_16TB   0x0000100000000000ULL\r
+#define  SIZE_32TB   0x0000200000000000ULL\r
+#define  SIZE_64TB   0x0000400000000000ULL\r
+#define  SIZE_128TB  0x0000800000000000ULL\r
+#define  SIZE_256TB  0x0001000000000000ULL\r
+#define  SIZE_512TB  0x0002000000000000ULL\r
+#define  SIZE_1PB    0x0004000000000000ULL\r
+#define  SIZE_2PB    0x0008000000000000ULL\r
+#define  SIZE_4PB    0x0010000000000000ULL\r
+#define  SIZE_8PB    0x0020000000000000ULL\r
+#define  SIZE_16PB   0x0040000000000000ULL\r
+#define  SIZE_32PB   0x0080000000000000ULL\r
+#define  SIZE_64PB   0x0100000000000000ULL\r
+#define  SIZE_128PB  0x0200000000000000ULL\r
+#define  SIZE_256PB  0x0400000000000000ULL\r
+#define  SIZE_512PB  0x0800000000000000ULL\r
+#define  SIZE_1EB    0x1000000000000000ULL\r
+#define  SIZE_2EB    0x2000000000000000ULL\r
+#define  SIZE_4EB    0x4000000000000000ULL\r
+#define  SIZE_8EB    0x8000000000000000ULL\r
\r
+#define  BASE_1KB    0x00000400\r
+#define  BASE_2KB    0x00000800\r
+#define  BASE_4KB    0x00001000\r
+#define  BASE_8KB    0x00002000\r
+#define  BASE_16KB   0x00004000\r
+#define  BASE_32KB   0x00008000\r
+#define  BASE_64KB   0x00010000\r
+#define  BASE_128KB  0x00020000\r
+#define  BASE_256KB  0x00040000\r
+#define  BASE_512KB  0x00080000\r
+#define  BASE_1MB    0x00100000\r
+#define  BASE_2MB    0x00200000\r
+#define  BASE_4MB    0x00400000\r
+#define  BASE_8MB    0x00800000\r
+#define  BASE_16MB   0x01000000\r
+#define  BASE_32MB   0x02000000\r
+#define  BASE_64MB   0x04000000\r
+#define  BASE_128MB  0x08000000\r
+#define  BASE_256MB  0x10000000\r
+#define  BASE_512MB  0x20000000\r
+#define  BASE_1GB    0x40000000\r
+#define  BASE_2GB    0x80000000\r
+#define  BASE_4GB    0x0000000100000000ULL\r
+#define  BASE_8GB    0x0000000200000000ULL\r
+#define  BASE_16GB   0x0000000400000000ULL\r
+#define  BASE_32GB   0x0000000800000000ULL\r
+#define  BASE_64GB   0x0000001000000000ULL\r
+#define  BASE_128GB  0x0000002000000000ULL\r
+#define  BASE_256GB  0x0000004000000000ULL\r
+#define  BASE_512GB  0x0000008000000000ULL\r
+#define  BASE_1TB    0x0000010000000000ULL\r
+#define  BASE_2TB    0x0000020000000000ULL\r
+#define  BASE_4TB    0x0000040000000000ULL\r
+#define  BASE_8TB    0x0000080000000000ULL\r
+#define  BASE_16TB   0x0000100000000000ULL\r
+#define  BASE_32TB   0x0000200000000000ULL\r
+#define  BASE_64TB   0x0000400000000000ULL\r
+#define  BASE_128TB  0x0000800000000000ULL\r
+#define  BASE_256TB  0x0001000000000000ULL\r
+#define  BASE_512TB  0x0002000000000000ULL\r
+#define  BASE_1PB    0x0004000000000000ULL\r
+#define  BASE_2PB    0x0008000000000000ULL\r
+#define  BASE_4PB    0x0010000000000000ULL\r
+#define  BASE_8PB    0x0020000000000000ULL\r
+#define  BASE_16PB   0x0040000000000000ULL\r
+#define  BASE_32PB   0x0080000000000000ULL\r
+#define  BASE_64PB   0x0100000000000000ULL\r
+#define  BASE_128PB  0x0200000000000000ULL\r
+#define  BASE_256PB  0x0400000000000000ULL\r
+#define  BASE_512PB  0x0800000000000000ULL\r
+#define  BASE_1EB    0x1000000000000000ULL\r
+#define  BASE_2EB    0x2000000000000000ULL\r
+#define  BASE_4EB    0x4000000000000000ULL\r
+#define  BASE_8EB    0x8000000000000000ULL\r
+\r
 //\r
 //  Support for variable length argument lists using the ANSI standard.\r
 //  \r
@@ -232,6 +342,19 @@ struct _LIST_ENTRY {
 **/\r
 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
 \r
+#if defined(__GNUC__)\r
+//\r
+// Use GCC built-in macros for variable argument lists.\r
+//\r
+typedef __builtin_va_list VA_LIST;\r
+\r
+#define VA_START(Marker, Parameter)  __builtin_va_start (Marker, Parameter)\r
+\r
+#define VA_ARG(Marker, TYPE)         ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r
+\r
+#define VA_END(Marker)               __builtin_va_end (Marker)\r
+\r
+#else\r
 ///\r
 /// Pointer to the start of a variable argument list. Same as CHAR8 *.\r
 ///\r
@@ -284,6 +407,31 @@ typedef CHAR8 *VA_LIST;
 **/\r
 #define VA_END(Marker)      (Marker = (VA_LIST) 0)\r
 \r
+#endif\r
+\r
+///\r
+/// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.\r
+///\r
+typedef UINTN  *BASE_LIST;\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 BASE_ARG(Marker, TYPE) (*(TYPE *)((UINT8 *)(Marker = (BASE_LIST)((UINT8 *)Marker + _INT_SIZE_OF (TYPE))) - _INT_SIZE_OF (TYPE)))\r
+\r
 /**\r
   Macro that returns the byte offset of a field in a data structure. \r
 \r
@@ -307,7 +455,7 @@ typedef CHAR8 *VA_LIST;
 \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
+  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
@@ -405,37 +553,37 @@ typedef INTN RETURN_STATUS;
 /**\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
+  @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 set.\r
 \r
 **/\r
-#define ENCODE_ERROR(StatusCode)     (MAX_BIT | (StatusCode))\r
+#define ENCODE_ERROR(StatusCode)     ((RETURN_STATUS)(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
+  @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
+#define ENCODE_WARNING(StatusCode)   ((RETURN_STATUS)(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
+  @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
+#define RETURN_ERROR(StatusCode)     (((RETURN_STATUS)(StatusCode)) < 0)\r
 \r
 ///\r
 /// The operation completed successfully.\r
@@ -470,7 +618,7 @@ typedef INTN RETURN_STATUS;
 #define RETURN_BUFFER_TOO_SMALL      ENCODE_ERROR (5)\r
 \r
 ///\r
-/// There is no data oending upon return.\r
+/// There is no data pending upon return.\r
 ///\r
 #define RETURN_NOT_READY             ENCODE_ERROR (6)\r
 \r
@@ -491,7 +639,7 @@ typedef INTN RETURN_STATUS;
 #define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)\r
 \r
 ///\r
-/// An inconsistancy was detected on the file system causing the \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
@@ -554,23 +702,23 @@ typedef INTN RETURN_STATUS;
 #define RETURN_ABORTED               ENCODE_ERROR (21)\r
 \r
 ///\r
-/// An ICMP error occurred during the nrtwork operation.\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 nrtwork operation.\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 nrtwork operation.\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
-/// iuncomptible with a version requested by the caller.\r
+/// incompatible with a version requested by the caller.\r
 ///\r
 #define RETURN_INCOMPATIBLE_VERSION  ENCODE_ERROR (25)\r
 \r