The return description for LibPcdSetx function is ambiguity. The actual meaning of...

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

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index 0e5ea1978d1eefd6966ba157a73e2b4ad2e7f596..4eedffde0b8ed1bb150530c7b758fbd92072fc93 100644 (file)
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -333,9 +333,18 @@ struct _LIST_ENTRY {
 //  }\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
 #if defined(__GNUC__)\r
 //\r
-// Use GCC builtin macros for variable argument lists.\r
+// Use GCC built-in macros for variable argument lists.\r
 //\r
 typedef __builtin_va_list VA_LIST;\r
 \r
@@ -346,15 +355,6 @@ typedef __builtin_va_list VA_LIST;
 #define VA_END(Marker)               __builtin_va_end (Marker)\r
 \r
 #else\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 CHAR8 *.\r
 ///\r
@@ -409,6 +409,29 @@ typedef CHAR8 *VA_LIST;
 \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
@@ -432,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