]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Base.h
Fix file headers and a few comments
[mirror_edk2.git] / MdePkg / Include / Base.h
index 33d192cd5f503150e0bc2c4c79dd32801e86fab2..2e2a771982a8f49929d2b700a20bce72d408949a 100644 (file)
@@ -7,6 +7,7 @@
   be used to implement base modules.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
 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
@@ -26,6 +27,64 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 #include <ProcessorBind.h>\r
 \r
+//\r
+// The Microsoft* C compiler can removed references to unreferenced data items\r
+//  if the /OPT:REF linker option is used. We defined a macro as this is a \r
+//  a non standard extension\r
+//\r
+#if defined(_MSC_EXTENSIONS)\r
+  ///\r
+  /// Remove global variable from the linked image if there are no references to \r
+  /// it after all compiler and linker optimizations have been performed.\r
+  ///\r
+  ///\r
+  #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
+#else\r
+  ///\r
+  /// Remove global variable from the linked image if there are no references to \r
+  /// it after all compiler and linker optimizations have been performed.\r
+  ///\r
+  ///\r
+  #define GLOBAL_REMOVE_IF_UNREFERENCED\r
+#endif\r
+\r
+//\r
+// For symbol name in GNU assembly code, an extra "_" is necessary\r
+//\r
+#if defined(__GNUC__)\r
+  ///\r
+  /// Private worker functions for ASM_PFX()\r
+  ///\r
+  #define _CONCATENATE(a, b)  __CONCATENATE(a, b)\r
+  #define __CONCATENATE(a, b) a ## b\r
+\r
+  ///\r
+  /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix\r
+  /// on symbols in assembly language.\r
+  ///\r
+  #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\r
+#endif\r
+\r
+#if __APPLE__\r
+  //\r
+  // Apple extension that is used by the linker to optimize code size \r
+  // with assembly functions. Put at the end of your .S files\r
+  //\r
+  #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED  .subsections_via_symbols\r
+#else\r
+  #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED\r
+#endif\r
+\r
+#ifdef __CC_ARM\r
+  //\r
+  // Older RVCT ARM compilers don't fully support #pragma pack and require __packed \r
+  // as a prefix for the structure.\r
+  //\r
+  #define PACKED  __packed\r
+#else\r
+  #define PACKED\r
+#endif\r
+\r
 ///\r
 /// 128 bit buffer containing a unique identifier value.  \r
 /// Unless otherwise specified, aligned on a 64 bit boundary.\r
@@ -342,8 +401,50 @@ struct _LIST_ENTRY {
 **/\r
 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
 \r
+#if defined(__CC_ARM)\r
+//\r
+// RVCT ARM variable argument list support.\r
+//\r
+\r
+///\r
+/// Variable used to traverse the list of arguments. This type can vary by \r
+/// implementation and could be an array or structure. \r
+///\r
+#ifdef __APCS_ADSABI\r
+  typedef int         *va_list[1];\r
+  #define VA_LIST     va_list\r
+#else\r
+  typedef struct __va_list { void *__ap; } va_list;\r
+  #define VA_LIST                          va_list\r
+#endif\r
+\r
+#define VA_START(Marker, Parameter)   __va_start(Marker, Parameter)\r
+\r
+#define VA_ARG(Marker, TYPE)          __va_arg(Marker, TYPE)\r
+\r
+#define VA_END(Marker)                ((void)0)\r
+\r
+#elif defined(__GNUC__)\r
+//\r
+// Use GCC built-in macros for variable argument lists.\r
+//\r
+\r
+///\r
+/// Variable used to traverse the list of arguments. This type can vary by \r
+/// implementation and could be an array or structure. \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
+/// Variable used to traverse the list of arguments. This type can vary by \r
+/// implementation and could be an array or structure. \r
 ///\r
 typedef CHAR8 *VA_LIST;\r
 \r
@@ -355,7 +456,7 @@ typedef CHAR8 *VA_LIST;
   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   Marker       VA_LIST used to traverse the list of arguments.\r
   @param   Parameter    The name of the parameter that immediately precedes \r
                         the variable argument list.\r
   \r
@@ -373,7 +474,7 @@ typedef CHAR8 *VA_LIST;
   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   Marker   VA_LIST used to traverse the list of arguments.\r
   @param   TYPE     The type of argument to retrieve from the beginning \r
                     of the variable argument list.\r
   \r
@@ -389,11 +490,45 @@ typedef CHAR8 *VA_LIST;
   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
+  @param   Marker   VA_LIST used to traverse the list of arguments.\r
   \r
 **/\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 the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.\r
+\r
+  @param  TYPE  The date type to determine the size of.\r
+\r
+  @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.\r
+**/\r
+#define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\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 *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r
+\r
 /**\r
   Macro that returns the byte offset of a field in a data structure. \r
 \r
@@ -417,7 +552,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
@@ -451,7 +586,7 @@ typedef CHAR8 *VA_LIST;
   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   Pointer    The pointer 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
@@ -480,7 +615,6 @@ typedef CHAR8 *VA_LIST;
   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
@@ -496,7 +630,6 @@ typedef CHAR8 *VA_LIST;
   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
@@ -521,7 +654,7 @@ typedef INTN RETURN_STATUS;
   @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
@@ -532,7 +665,7 @@ typedef INTN RETURN_STATUS;
   @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
@@ -545,7 +678,7 @@ typedef INTN RETURN_STATUS;
   @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