environment. There are a set of base libraries in the Mde Package that can\r
be used to implement base modules.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
-Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
+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
-http://opensource.org/licenses/bsd-license.php\r
+http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
//\r
#include <ProcessorBind.h>\r
\r
+\r
+/**\r
+ Verifies the storage size of a given data type.\r
+ \r
+ This macro generates a divide by zero error or a zero size array declaration in\r
+ the preprocessor if the size is incorrect. These are declared as "extern" so\r
+ the space for these arrays will not be in the modules.\r
+\r
+ @param TYPE The date type to determine the size of.\r
+ @param Size The expected size for the TYPE.\r
+\r
+**/\r
+#define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]\r
+\r
//\r
// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with \r
-// Section 2.3.1 of the UEFI 2.3 Specification. Generates a divide by zero \r
-// error or a zero size array declaration in the preprocessor if the size is \r
-// incorrect. These are declared as "extern" so the space for these arrays will \r
-// not be in the modules.\r
+// Section 2.3.1 of the UEFI 2.3 Specification. \r
//\r
-extern UINT8 _VerifySizeOfBoolean [(sizeof(BOOLEAN) == 1) / (sizeof(BOOLEAN) == 1)];\r
-extern UINT8 _VerifySizeOfInt8 [(sizeof(INT8) == 1) / (sizeof(INT8) == 1)];\r
-extern UINT8 _VerifySizeOfUint8 [(sizeof(UINT8) == 1) / (sizeof(UINT8) == 1)];\r
-extern UINT8 _VerifySizeOfInt16 [(sizeof(INT16) == 2) / (sizeof(INT16) == 2)];\r
-extern UINT8 _VerifySizeOfUint16 [(sizeof(UINT16) == 2) / (sizeof(UINT16) == 2)];\r
-extern UINT8 _VerifySizeOfInt32 [(sizeof(INT32) == 4) / (sizeof(INT32) == 4)];\r
-extern UINT8 _VerifySizeOfUint32 [(sizeof(UINT32) == 4) / (sizeof(UINT32) == 4)];\r
-extern UINT8 _VerifySizeOfInt64 [(sizeof(INT64) == 8) / (sizeof(INT64) == 8)];\r
-extern UINT8 _VerifySizeOfUint64 [(sizeof(UINT64) == 8) / (sizeof(UINT64) == 8)];\r
-extern UINT8 _VerifySizeOfChar8 [(sizeof(CHAR8) == 1) / (sizeof(CHAR8) == 1)];\r
-extern UINT8 _VerifySizeOfChar16 [(sizeof(CHAR16) == 2) / (sizeof(CHAR16) == 2)];\r
+VERIFY_SIZE_OF (BOOLEAN, 1);\r
+VERIFY_SIZE_OF (INT8, 1);\r
+VERIFY_SIZE_OF (UINT8, 1);\r
+VERIFY_SIZE_OF (INT16, 2);\r
+VERIFY_SIZE_OF (UINT16, 2);\r
+VERIFY_SIZE_OF (INT32, 4);\r
+VERIFY_SIZE_OF (UINT32, 4);\r
+VERIFY_SIZE_OF (INT64, 8);\r
+VERIFY_SIZE_OF (UINT64, 8);\r
+VERIFY_SIZE_OF (CHAR8, 1);\r
+VERIFY_SIZE_OF (CHAR16, 2);\r
\r
//\r
// The Microsoft* C compiler can removed references to unreferenced data items\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
+ /// Remove the global variable from the linked image if there are no references \r
+ /// to it after all compiler and linker optimizations have been performed.\r
///\r
///\r
#define GLOBAL_REMOVE_IF_UNREFERENCED\r
//\r
\r
///\r
-/// Datum is read-only\r
+/// Datum is read-only.\r
///\r
#define CONST const\r
\r
///\r
-/// Datum is scoped to the current file or function\r
+/// Datum is scoped to the current file or function.\r
///\r
#define STATIC static\r
\r
///\r
-/// Undeclared type\r
+/// Undeclared type.\r
///\r
#define VOID void\r
\r
//\r
\r
///\r
-/// Datum is passed to the function\r
+/// Datum is passed to the function.\r
///\r
#define IN\r
\r
///\r
-/// Datum is returned from the function\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
+/// is passed if the value is not supplied.\r
///\r
#define OPTIONAL\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
+ @param n The parameter size to be aligned.\r
\r
- @return The aligned size\r
+ @return The aligned size.\r
**/\r
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
\r
typedef CHAR8 *VA_LIST;\r
\r
/**\r
- Retrieves a pointer to the beginning of a variable argument list based on \r
+ Retrieves a pointer to the beginning of a variable argument list, based on \r
the name of the parameter that immediately precedes the variable argument list. \r
\r
- This function initializes Marker to point to the beginning of the variable argument \r
- 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
+ This function initializes Marker to point to the beginning of the variable \r
+ argument list that immediately follows Parameter. The method for computing the \r
+ pointer to the next argument in the argument list is CPU-specific following the \r
+ EFIAPI ABI.\r
\r
- @param Marker VA_LIST used to traverse the list of arguments.\r
+ @param Marker The 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
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
+ pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r
\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
Terminates the use of a variable argument list.\r
\r
This function initializes Marker so it can no longer be used with VA_ARG(). \r
- After this macro is used, the only way to access the variable argument list again is \r
+ After this macro is used, the only way to access the variable argument list is \r
by using VA_START() again.\r
\r
@param Marker VA_LIST used to traverse the list of arguments.\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 Marker The 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
#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
+ The macro that returns the byte offset of a field in a data structure. \r
\r
This function returns the offset, in bytes, of field specified by Field from the \r
beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r
Both a and b must be the same numerical types, signed or unsigned.\r
\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
+ @param b The second operand. Can be any numerical type as long as is \r
+ the same type as a.\r
\r
@return Maximum of two operands.\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
+ 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
#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
\r
///\r
-/// Beginning or end of media was reached.\r
+/// The beginning or end of media was reached.\r
///\r
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
\r
projects / mirror_edk2.git / blobdiff