X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FBase.h;h=5b1f418d1af4d9c9c0d356d718584c0119751e0f;hp=015ae667ecc15f7a03965ea768571450c333d5f8;hb=a89fa50ccf7a29405e3d24c49625dbd70cdba9fa;hpb=727501bb17c4182e42438b7715383cc5f15434a0
diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index 015ae667ec..5b1f418d1a 100644
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -6,11 +6,12 @@
environment. There are a set of base libraries in the Mde Package that can
be used to implement base modules.
-Copyright (c) 2006 - 2008, Intel Corporation
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -26,6 +27,83 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
//
#include
+//
+// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
+// Section 2.3.1 of the UEFI 2.3 Specification. Generates a divide by zero
+// error or a zero size array declaration in the preprocessor if the size is
+// incorrect. These are declared as "extern" so the space for these arrays will
+// not be in the modules.
+//
+extern UINT8 _VerifySizeOfBoolean [(sizeof(BOOLEAN) == 1) / (sizeof(BOOLEAN) == 1)];
+extern UINT8 _VerifySizeOfInt8 [(sizeof(INT8) == 1) / (sizeof(INT8) == 1)];
+extern UINT8 _VerifySizeOfUint8 [(sizeof(UINT8) == 1) / (sizeof(UINT8) == 1)];
+extern UINT8 _VerifySizeOfInt16 [(sizeof(INT16) == 2) / (sizeof(INT16) == 2)];
+extern UINT8 _VerifySizeOfUint16 [(sizeof(UINT16) == 2) / (sizeof(UINT16) == 2)];
+extern UINT8 _VerifySizeOfInt32 [(sizeof(INT32) == 4) / (sizeof(INT32) == 4)];
+extern UINT8 _VerifySizeOfUint32 [(sizeof(UINT32) == 4) / (sizeof(UINT32) == 4)];
+extern UINT8 _VerifySizeOfInt64 [(sizeof(INT64) == 8) / (sizeof(INT64) == 8)];
+extern UINT8 _VerifySizeOfUint64 [(sizeof(UINT64) == 8) / (sizeof(UINT64) == 8)];
+extern UINT8 _VerifySizeOfChar8 [(sizeof(CHAR8) == 1) / (sizeof(CHAR8) == 1)];
+extern UINT8 _VerifySizeOfChar16 [(sizeof(CHAR16) == 2) / (sizeof(CHAR16) == 2)];
+
+//
+// The Microsoft* C compiler can removed references to unreferenced data items
+// if the /OPT:REF linker option is used. We defined a macro as this is a
+// a non standard extension
+//
+#if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
+ ///
+ /// Remove global variable from the linked image if there are no references to
+ /// it after all compiler and linker optimizations have been performed.
+ ///
+ ///
+ #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
+#else
+ ///
+ /// Remove the global variable from the linked image if there are no references
+ /// to it after all compiler and linker optimizations have been performed.
+ ///
+ ///
+ #define GLOBAL_REMOVE_IF_UNREFERENCED
+#endif
+
+//
+// For symbol name in GNU assembly code, an extra "_" is necessary
+//
+#if defined(__GNUC__)
+ ///
+ /// Private worker functions for ASM_PFX()
+ ///
+ #define _CONCATENATE(a, b) __CONCATENATE(a, b)
+ #define __CONCATENATE(a, b) a ## b
+
+ ///
+ /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
+ /// on symbols in assembly language.
+ ///
+ #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
+#endif
+
+#if __APPLE__
+ //
+ // Apple extension that is used by the linker to optimize code size
+ // with assembly functions. Put at the end of your .S files
+ //
+ #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
+#else
+ #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
+#endif
+
+#ifdef __CC_ARM
+ //
+ // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
+ // as a prefix for the structure.
+ //
+ #define PACKED __packed
+#else
+ #define PACKED
+#endif
+
///
/// 128 bit buffer containing a unique identifier value.
/// Unless otherwise specified, aligned on a 64 bit boundary.
@@ -60,17 +138,17 @@ struct _LIST_ENTRY {
//
///
-/// Datum is read-only
+/// Datum is read-only.
///
#define CONST const
///
-/// Datum is scoped to the current file or function
+/// Datum is scoped to the current file or function.
///
#define STATIC static
///
-/// Undeclared type
+/// Undeclared type.
///
#define VOID void
@@ -80,18 +158,18 @@ struct _LIST_ENTRY {
//
///
-/// Datum is passed to the function
+/// Datum is passed to the function.
///
#define IN
///
-/// Datum is returned from the function
+/// Datum is returned from the function.
///
#define OUT
///
/// Passing the datum to the function is optional, and a NULL
-/// be passed if the value is not supplied.
+/// is passed if the value is not supplied.
///
#define OPTIONAL
@@ -183,6 +261,116 @@ struct _LIST_ENTRY {
#define BIT62 0x4000000000000000ULL
#define BIT63 0x8000000000000000ULL
+#define SIZE_1KB 0x00000400
+#define SIZE_2KB 0x00000800
+#define SIZE_4KB 0x00001000
+#define SIZE_8KB 0x00002000
+#define SIZE_16KB 0x00004000
+#define SIZE_32KB 0x00008000
+#define SIZE_64KB 0x00010000
+#define SIZE_128KB 0x00020000
+#define SIZE_256KB 0x00040000
+#define SIZE_512KB 0x00080000
+#define SIZE_1MB 0x00100000
+#define SIZE_2MB 0x00200000
+#define SIZE_4MB 0x00400000
+#define SIZE_8MB 0x00800000
+#define SIZE_16MB 0x01000000
+#define SIZE_32MB 0x02000000
+#define SIZE_64MB 0x04000000
+#define SIZE_128MB 0x08000000
+#define SIZE_256MB 0x10000000
+#define SIZE_512MB 0x20000000
+#define SIZE_1GB 0x40000000
+#define SIZE_2GB 0x80000000
+#define SIZE_4GB 0x0000000100000000ULL
+#define SIZE_8GB 0x0000000200000000ULL
+#define SIZE_16GB 0x0000000400000000ULL
+#define SIZE_32GB 0x0000000800000000ULL
+#define SIZE_64GB 0x0000001000000000ULL
+#define SIZE_128GB 0x0000002000000000ULL
+#define SIZE_256GB 0x0000004000000000ULL
+#define SIZE_512GB 0x0000008000000000ULL
+#define SIZE_1TB 0x0000010000000000ULL
+#define SIZE_2TB 0x0000020000000000ULL
+#define SIZE_4TB 0x0000040000000000ULL
+#define SIZE_8TB 0x0000080000000000ULL
+#define SIZE_16TB 0x0000100000000000ULL
+#define SIZE_32TB 0x0000200000000000ULL
+#define SIZE_64TB 0x0000400000000000ULL
+#define SIZE_128TB 0x0000800000000000ULL
+#define SIZE_256TB 0x0001000000000000ULL
+#define SIZE_512TB 0x0002000000000000ULL
+#define SIZE_1PB 0x0004000000000000ULL
+#define SIZE_2PB 0x0008000000000000ULL
+#define SIZE_4PB 0x0010000000000000ULL
+#define SIZE_8PB 0x0020000000000000ULL
+#define SIZE_16PB 0x0040000000000000ULL
+#define SIZE_32PB 0x0080000000000000ULL
+#define SIZE_64PB 0x0100000000000000ULL
+#define SIZE_128PB 0x0200000000000000ULL
+#define SIZE_256PB 0x0400000000000000ULL
+#define SIZE_512PB 0x0800000000000000ULL
+#define SIZE_1EB 0x1000000000000000ULL
+#define SIZE_2EB 0x2000000000000000ULL
+#define SIZE_4EB 0x4000000000000000ULL
+#define SIZE_8EB 0x8000000000000000ULL
+
+#define BASE_1KB 0x00000400
+#define BASE_2KB 0x00000800
+#define BASE_4KB 0x00001000
+#define BASE_8KB 0x00002000
+#define BASE_16KB 0x00004000
+#define BASE_32KB 0x00008000
+#define BASE_64KB 0x00010000
+#define BASE_128KB 0x00020000
+#define BASE_256KB 0x00040000
+#define BASE_512KB 0x00080000
+#define BASE_1MB 0x00100000
+#define BASE_2MB 0x00200000
+#define BASE_4MB 0x00400000
+#define BASE_8MB 0x00800000
+#define BASE_16MB 0x01000000
+#define BASE_32MB 0x02000000
+#define BASE_64MB 0x04000000
+#define BASE_128MB 0x08000000
+#define BASE_256MB 0x10000000
+#define BASE_512MB 0x20000000
+#define BASE_1GB 0x40000000
+#define BASE_2GB 0x80000000
+#define BASE_4GB 0x0000000100000000ULL
+#define BASE_8GB 0x0000000200000000ULL
+#define BASE_16GB 0x0000000400000000ULL
+#define BASE_32GB 0x0000000800000000ULL
+#define BASE_64GB 0x0000001000000000ULL
+#define BASE_128GB 0x0000002000000000ULL
+#define BASE_256GB 0x0000004000000000ULL
+#define BASE_512GB 0x0000008000000000ULL
+#define BASE_1TB 0x0000010000000000ULL
+#define BASE_2TB 0x0000020000000000ULL
+#define BASE_4TB 0x0000040000000000ULL
+#define BASE_8TB 0x0000080000000000ULL
+#define BASE_16TB 0x0000100000000000ULL
+#define BASE_32TB 0x0000200000000000ULL
+#define BASE_64TB 0x0000400000000000ULL
+#define BASE_128TB 0x0000800000000000ULL
+#define BASE_256TB 0x0001000000000000ULL
+#define BASE_512TB 0x0002000000000000ULL
+#define BASE_1PB 0x0004000000000000ULL
+#define BASE_2PB 0x0008000000000000ULL
+#define BASE_4PB 0x0010000000000000ULL
+#define BASE_8PB 0x0020000000000000ULL
+#define BASE_16PB 0x0040000000000000ULL
+#define BASE_32PB 0x0080000000000000ULL
+#define BASE_64PB 0x0100000000000000ULL
+#define BASE_128PB 0x0200000000000000ULL
+#define BASE_256PB 0x0400000000000000ULL
+#define BASE_512PB 0x0800000000000000ULL
+#define BASE_1EB 0x1000000000000000ULL
+#define BASE_2EB 0x2000000000000000ULL
+#define BASE_4EB 0x4000000000000000ULL
+#define BASE_8EB 0x8000000000000000ULL
+
//
// Support for variable length argument lists using the ANSI standard.
//
@@ -226,26 +414,69 @@ struct _LIST_ENTRY {
/**
Return the size of argument that has been aligned to sizeof (UINTN).
- @param n The parameter size is to be aligned.
+ @param n The parameter size to be aligned.
- @return The aligned size
+ @return The aligned size.
**/
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
+#if defined(__CC_ARM)
+//
+// RVCT ARM variable argument list support.
+//
+
+///
+/// Variable used to traverse the list of arguments. This type can vary by
+/// implementation and could be an array or structure.
+///
+#ifdef __APCS_ADSABI
+ typedef int *va_list[1];
+ #define VA_LIST va_list
+#else
+ typedef struct __va_list { void *__ap; } va_list;
+ #define VA_LIST va_list
+#endif
+
+#define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
+
+#define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
+
+#define VA_END(Marker) ((void)0)
+
+#elif defined(__GNUC__)
+//
+// Use GCC built-in macros for variable argument lists.
+//
+
+///
+/// Variable used to traverse the list of arguments. This type can vary by
+/// implementation and could be an array or structure.
+///
+typedef __builtin_va_list VA_LIST;
+
+#define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
+
+#define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
+
+#define VA_END(Marker) __builtin_va_end (Marker)
+
+#else
///
-/// Pointer to the start of a variable argument list. Same as CHAR8 *.
+/// Variable used to traverse the list of arguments. This type can vary by
+/// implementation and could be an array or structure.
///
typedef CHAR8 *VA_LIST;
/**
- Retrieves a pointer to the beginning of a variable argument list based on
+ Retrieves a pointer to the beginning of a variable argument list, based on
the name of the parameter that immediately precedes the variable argument list.
- This function initializes Marker to point to the beginning of the variable argument
- list that immediately follows Parameter. The method for computing the pointer to the
- next argument in the argument list is CPU specific following the EFIAPI ABI.
+ This function initializes Marker to point to the beginning of the variable
+ argument list that immediately follows Parameter. The method for computing the
+ pointer to the next argument in the argument list is CPU-specific following the
+ EFIAPI ABI.
- @param Marker Pointer to the beginning of the variable argument list.
+ @param Marker The VA_LIST used to traverse the list of arguments.
@param Parameter The name of the parameter that immediately precedes
the variable argument list.
@@ -261,9 +492,9 @@ typedef CHAR8 *VA_LIST;
This function returns an argument of the type specified by TYPE from the beginning
of the variable argument list specified by Marker. Marker is then updated to point
to the next argument in the variable argument list. The method for computing the
- pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
+ pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
- @param Marker Pointer to the beginning of a variable argument list.
+ @param Marker VA_LIST used to traverse the list of arguments.
@param TYPE The type of argument to retrieve from the beginning
of the variable argument list.
@@ -276,16 +507,50 @@ typedef CHAR8 *VA_LIST;
Terminates the use of a variable argument list.
This function initializes Marker so it can no longer be used with VA_ARG().
- After this macro is used, the only way to access the variable argument list again is
+ After this macro is used, the only way to access the variable argument list is
by using VA_START() again.
- @param Marker The variable to set to the beginning of the variable argument list.
+ @param Marker VA_LIST used to traverse the list of arguments.
**/
#define VA_END(Marker) (Marker = (VA_LIST) 0)
+#endif
+
+///
+/// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
+///
+typedef UINTN *BASE_LIST;
+
+/**
+ Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
+
+ @param TYPE The date type to determine the size of.
+
+ @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
+**/
+#define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
+
+/**
+ Returns an argument of a specified type from a variable argument list and updates
+ the pointer to the variable argument list to point to the next argument.
+
+ This function returns an argument of the type specified by TYPE from the beginning
+ of the variable argument list specified by Marker. Marker is then updated to point
+ to the next argument in the variable argument list. The method for computing the
+ pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
+
+ @param Marker The pointer to the beginning of a variable argument list.
+ @param TYPE The type of argument to retrieve from the beginning
+ of the variable argument list.
+
+ @return An argument of the type specified by TYPE.
+
+**/
+#define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
+
/**
- Macro that returns the byte offset of a field in a data structure.
+ The macro that returns the byte offset of a field in a data structure.
This function returns the offset, in bytes, of field specified by Field from the
beginning of the data structure specified by TYPE. If TYPE does not contain Field,
@@ -307,7 +572,7 @@ typedef CHAR8 *VA_LIST;
This function computes the offset, in bytes, of field specified by Field from the beginning
of the data structure specified by TYPE. This offset is subtracted from Record, and is
- used to return a pointer to a data structure of the type specified by TYPE.If the data type
+ used to return a pointer to a data structure of the type specified by TYPE. If the data type
specified by TYPE does not contain the field specified by Field, then the module will not compile.
@param Record Pointer to the field specified by Field within a data structure of type TYPE.
@@ -341,7 +606,7 @@ typedef CHAR8 *VA_LIST;
This function rounds the pointer specified by Pointer to the next alignment boundary
specified by Alignment. The pointer to the aligned address is returned.
- @param Value The value to round up.
+ @param Pointer The pointer to round up.
@param Alignment The alignment boundary to use to return an aligned pointer.
@return Pointer to the aligned address.
@@ -370,9 +635,9 @@ typedef CHAR8 *VA_LIST;
This macro returns the maximum of two operand specified by a and b.
Both a and b must be the same numerical types, signed or unsigned.
- @param TYPE Any numerical data types.
@param a The first operand with any numerical type.
- @param b The second operand. It should be the same any numerical type with a.
+ @param b The second operand. Can be any numerical type as long as is
+ the same type as a.
@return Maximum of two operands.
@@ -386,7 +651,6 @@ typedef CHAR8 *VA_LIST;
This macro returns the minimal of two operand specified by a and b.
Both a and b must be the same numerical types, signed or unsigned.
- @param TYPE Any numerical data types.
@param a The first operand with any numerical type.
@param b The second operand. It should be the same any numerical type with a.
@@ -400,42 +664,42 @@ typedef CHAR8 *VA_LIST;
//
// Status codes common to all execution phases
//
-typedef INTN RETURN_STATUS;
+typedef UINTN RETURN_STATUS;
/**
Produces a RETURN_STATUS code with the highest bit set.
- @param StatusCode The status code value to convert into a warning code.
+ @param StatusCode The status code value to convert into a warning code.
StatusCode must be in the range 0x00000000..0x7FFFFFFF.
@return The value specified by StatusCode with the highest bit set.
**/
-#define ENCODE_ERROR(StatusCode) (MAX_BIT | (StatusCode))
+#define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
/**
Produces a RETURN_STATUS code with the highest bit clear.
- @param StatusCode The status code value to convert into a warning code.
+ @param StatusCode The status code value to convert into a warning code.
StatusCode must be in the range 0x00000000..0x7FFFFFFF.
@return The value specified by StatusCode with the highest bit clear.
**/
-#define ENCODE_WARNING(StatusCode) (StatusCode)
+#define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
/**
Returns TRUE if a specified RETURN_STATUS code is an error code.
- This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned.
+ This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
- @param StatusCode The status code value to evaluate.
+ @param StatusCode The status code value to evaluate.
@retval TRUE The high bit of StatusCode is set.
@retval FALSE The high bit of StatusCode is clear.
**/
-#define RETURN_ERROR(StatusCode) ((INTN) (StatusCode) < 0)
+#define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
///
/// The operation completed successfully.
@@ -585,7 +849,7 @@ typedef INTN RETURN_STATUS;
#define RETURN_CRC_ERROR ENCODE_ERROR (27)
///
-/// Beginning or end of media was reached.
+/// The beginning or end of media was reached.
///
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
@@ -601,7 +865,7 @@ typedef INTN RETURN_STATUS;
///
-/// The Unicode string contained one or more characters that
+/// The string contained one or more characters that
/// the device could not render and were skipped.
///
#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)