Add comments for the MACRO follow the Spec, and change some definition not match...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6852 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index ad044b1615891f3414fadfa0826b5ef52251bf99..e33135675c9bda533ab71b65bc9102ec9c665825 100644 (file)
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -6,7 +6,7 @@
   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 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
 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 +26,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 #include <ProcessorBind.h>\r
 \r
+\r
+//\r
+// 128 bit buffer containing a unique identifier value.  \r
+// Unless otherwise specified, aligned on a 64 bit boundary.\r
+//\r
 typedef struct {\r
   UINT32  Data1;\r
   UINT16  Data2;\r
@@ -33,11 +38,14 @@ typedef struct {
   UINT8   Data4[8];\r
 } GUID;\r
 \r
+//\r
+// 8-bytes unsigned value that represents a physical system address.\r
+//\r
 typedef UINT64 PHYSICAL_ADDRESS;\r
 \r
-///\r
-/// LIST_ENTRY definition\r
-///\r
+//\r
+// LIST_ENTRY definition.\r
+//\r
 typedef struct _LIST_ENTRY LIST_ENTRY;\r
 \r
 struct _LIST_ENTRY {\r
@@ -46,7 +54,7 @@ struct _LIST_ENTRY {
 };\r
 \r
 //\r
-// Modifiers to absract standard types to aid in debug of problems\r
+// Modifiers to abstract standard types to aid in debug of problems\r
 //\r
 #define CONST     const\r
 #define STATIC    static\r
@@ -67,8 +75,12 @@ struct _LIST_ENTRY {
 #define TRUE  ((BOOLEAN)(1==1))\r
 #define FALSE ((BOOLEAN)(0==1))\r
 \r
+//\r
+// NULL pointer (VOID *)\r
+//\r
 #define NULL  ((VOID *) 0)\r
 \r
+\r
 #define  BIT0     0x00000001\r
 #define  BIT1     0x00000002\r
 #define  BIT2     0x00000004\r
@@ -137,13 +149,13 @@ struct _LIST_ENTRY {
 //\r
 //  Support for variable length argument lists using the ANSI standard.\r
 //  \r
-//  Since we are using the ANSI standard we used the standard nameing and\r
-//  did not folow the coding convention\r
+//  Since we are using the ANSI standard we used the standard naming and\r
+//  did not follow the coding convention\r
 //\r
 //  VA_LIST  - typedef for argument list.\r
 //  VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
 //  VA_END (VA_LIST Marker) - Clear Marker\r
-//  VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from\r
+//  VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r
 //    the ... list. You must know the size and pass it in this macro.\r
 //\r
 //  example:\r
@@ -177,54 +189,167 @@ struct _LIST_ENTRY {
 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
 \r
 //\r
-// Also support coding convention rules for var arg macros\r
+// Pointer to the start of a variable argument list. Same as UINT8 *.\r
 //\r
 typedef CHAR8 *VA_LIST;\r
-#define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))\r
-#define VA_ARG(ap, t)   (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))\r
-#define VA_END(ap)      (ap = (VA_LIST) 0)\r
 \r
-//\r
-// Macro that returns the byte offset of a field in a data structure. \r
-//\r
+/**\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
+\r
+  @param   Marker       Pointer to the beginning of the variable argument list.\r
+  @param   Parameter    The name of the parameter that immediately precedes \r
+                        the variable argument list.\r
+  \r
+  @return  A pointer to the beginning of a variable argument list.\r
+\r
+**/\r
+#define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\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 VA_ARG(Marker, TYPE)   (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r
+\r
+/**\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
+  by using VA_START() again.\r
+\r
+  @param   Marker   The variable to set to the beginning of the variable argument list.\r
+  \r
+**/\r
+#define VA_END(Marker)      (Marker = (VA_LIST) 0)\r
+\r
+/**\r
+  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
+  the module will not compile.  \r
+\r
+  @param   TYPE     The name of the data structure that contains the field specified by Field. \r
+  @param   Field    The name of the field in the data structure.\r
+  \r
+  @return  Offset, in bytes, of field.\r
+  \r
+**/\r
 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
 \r
-///\r
-///  CONTAINING_RECORD - returns a pointer to the structure\r
-///      from one of it's elements.\r
-///\r
+/**\r
+  Macro that returns a pointer to the data structure that contains a specified field of \r
+  that data structure.  This is a lightweight method to hide information by placing a \r
+  public data structure inside a larger private data structure and using a pointer to \r
+  the public data structure to retrieve a pointer to the private data structure.\r
+\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
+  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
+  @param   TYPE     The name of the data structure type to return.  This data structure must \r
+                    contain the field specified by Field. \r
+  @param   Field    The name of the field in the data structure specified by TYPE to which Record points.\r
+  \r
+  @return  A pointer to the structure from one of it's elements.\r
+  \r
+**/\r
 #define _CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
 \r
-///\r
-///  ALIGN_VALUE - aligns a value up to the next boundary of the given alignment.\r
-///\r
+/**\r
+  Rounds a value up to the next boundary using a specified alignment.  \r
+\r
+  This function rounds Value up to the next boundary using the specified Alignment.  \r
+  This aligned value is returned.  \r
+\r
+  @param   Value      The value to round up.\r
+  @param   Alignment  The alignment boundary used to return the aligned value.\r
+  \r
+  @return  A value up to the next boundary.\r
+  \r
+**/\r
 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
 \r
-///\r
-///  ALIGN_POINTER - aligns a pointer to the lowest boundry\r
-///\r
+/**\r
+  Adjust a pointer by adding the minimum offset required for it to be aligned on \r
+  a specified alignment boundary.  \r
+\r
+  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   Alignment  The alignment boundary to use to return an aligned pointer.\r
+  \r
+  @return  Pointer to the aligned address.\r
+  \r
+**/\r
 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
 \r
-///\r
-///  ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor\r
-///\r
+/**\r
+  Rounds a value up to the next natural boundary for the current CPU.  \r
+  This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.   \r
+\r
+  This function rounds the value specified by Value up to the next natural boundary for the \r
+  current CPU. This rounded value is returned.  \r
+\r
+  @param   Value      The value to round up.\r
+\r
+  @return  Rounded value specified by Value.\r
+  \r
+**/\r
 #define ALIGN_VARIABLE(Value)  ALIGN_VALUE ((Value), sizeof (UINTN))\r
   \r
 \r
-//\r
-// Return the maximum of two operands. \r
-// 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
+/**\r
+  Return the maximum of two operands. \r
+\r
+  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
+  @return  Maximum of two operands.\r
+  \r
+**/\r
 #define MAX(a, b)                       \\r
   (((a) > (b)) ? (a) : (b))\r
 \r
+/**\r
+  Return the minimum of two operands. \r
+\r
+  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
+  @return  Minimum of two operands.\r
+  \r
+**/\r
 \r
-//\r
-// Return the minimum of two operands. \r
-// 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
 #define MIN(a, b)                       \\r
   (((a) < (b)) ? (a) : (b))\r
 \r
@@ -235,9 +360,9 @@ typedef CHAR8 *VA_LIST;
 \r
 typedef INTN RETURN_STATUS;\r
 \r
-///\r
-/// Set the upper bit to indicate EFI Error.\r
-///\r
+//\r
+// Set the upper bit to indicate EFI Error.\r
+//\r
 #define ENCODE_ERROR(a)              (MAX_BIT | (a))\r
 \r
 #define ENCODE_WARNING(a)            (a)\r
@@ -284,6 +409,9 @@ typedef INTN RETURN_STATUS;
 /**\r
   Returns a 16-bit signature built from 2 ASCII characters.\r
   \r
+  This macro returns a 16-bit value built from the two ASCII characters specified \r
+  by A and B.\r
+  \r
   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
 \r
@@ -295,6 +423,9 @@ typedef INTN RETURN_STATUS;
 /**\r
   Returns a 32-bit signature built from 4 ASCII characters.\r
   \r
+  This macro returns a 32-bit value built from the four ASCII characters specified \r
+  by A, B, C, and D.\r
+  \r
   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
   @param  C    The third ASCII character.\r
@@ -309,6 +440,9 @@ typedef INTN RETURN_STATUS;
 /**\r
   Returns a 64-bit signature built from 8 ASCII characters.\r
   \r
+  This macro returns a 64-bit value built from the eight ASCII characters specified \r
+  by A, B, C, D, E, F, G,and H.\r
+  \r
   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
   @param  C    The third ASCII character.\r

diff --git a/MdePkg/Include/Ebc/ProcessorBind.h b/MdePkg/Include/Ebc/ProcessorBind.h
index 7c10230eedde9c25beda9b7ce3af8b0ae7bdcb65..b83ebe8766d939bbe3ad668eebaf43402b27c2fb 100644 (file)
--- a/MdePkg/Include/Ebc/ProcessorBind.h
+++ b/MdePkg/Include/Ebc/ProcessorBind.h
@@ -4,7 +4,7 @@
   We currently only have one EBC complier so there may be some Intel compiler\r
   specific functions in this file.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006, Intel Corporation<BR>                                                         \r
   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
@@ -68,7 +68,7 @@ typedef unsigned long         UINTN;
 ///\r
 /// Modifier to ensure that all protocol member functions and EFI intrinsics\r
 /// use the correct C calling convention. All protocol member functions and\r
-/// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
+/// EFI intrinsics are required to modify their member functions with EFIAPI.\r
 ///\r
 #define EFIAPI    \r
 \r
@@ -79,16 +79,18 @@ typedef unsigned long         UINTN;
 ///\r
 #define GLOBAL_REMOVE_IF_UNREFERENCED\r
 \r
+\r
 /**\r
   Return the pointer to the first instruction of a function given a function pointer.\r
   On EBC architectures, these two pointer values are the same, \r
   so the implementation of this macro is very simple.\r
   \r
-  @param  p A pointer to a function\r
+  @param  FunctionPointer   A pointer to a function.\r
 \r
   @return The pointer to the first instruction of a function given a function pointer.\r
 **/\r
-#define FUNCTION_ENTRY_POINT(p) (p)\r
+\r
+#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(FunctionPointer)\r
 \r
 #endif \r
 \r

diff --git a/MdePkg/Include/Ia32/ProcessorBind.h b/MdePkg/Include/Ia32/ProcessorBind.h
index c3ca840242d492758ff4047c86e0d5723a5e8f46..b3486ea8ef9b44af6f8b88741aa1f72371b1c474 100644 (file)
--- a/MdePkg/Include/Ia32/ProcessorBind.h
+++ b/MdePkg/Include/Ia32/ProcessorBind.h
@@ -1,7 +1,7 @@
 /** @file\r
   Processor or Compiler specific defines and types for Ia32 architecture.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006, Intel Corporation<BR>                                                         \r
   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
@@ -21,7 +21,7 @@
 #define MDE_CPU_IA32\r
 \r
 //\r
-// Make sure we are useing the correct packing rules per EFI specification\r
+// Make sure we are using the correct packing rules per EFI specification\r
 //\r
 #ifndef __GNUC__\r
 #pragma pack()\r
@@ -83,7 +83,7 @@
 #pragma warning ( disable : 4505 )\r
 \r
 //\r
-// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
+// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
 //\r
 #pragma warning ( disable : 4206 )\r
 \r
@@ -174,7 +174,7 @@ typedef INT32   INTN;
 //\r
 // Modifier to ensure that all protocol member functions and EFI intrinsics\r
 // use the correct C calling convention. All protocol member functions and\r
-// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
+// EFI intrinsics are required to modify their member functions with EFIAPI.\r
 //\r
 #if _MSC_EXTENSIONS\r
   ///\r
@@ -214,11 +214,12 @@ typedef INT32   INTN;
   On IA32 CPU architectures, these two pointer values are the same, \r
   so the implementation of this macro is very simple.\r
   \r
-  @param  p A pointer to a function\r
+  @param  FunctionPointer   A pointer to a function.\r
 \r
   @return The pointer to the first instruction of a function given a function pointer.\r
+  \r
 **/\r
-#define FUNCTION_ENTRY_POINT(p) (p)\r
+#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(FunctionPointer)\r
 \r
 #endif\r
 \r

diff --git a/MdePkg/Include/Ipf/ProcessorBind.h b/MdePkg/Include/Ipf/ProcessorBind.h
index 31940a578854d89591c89f5817aec6f08987c78f..16bba6589bc9ad3d5c0c4ddeb3efa44efb8d277f 100644 (file)
--- a/MdePkg/Include/Ipf/ProcessorBind.h
+++ b/MdePkg/Include/Ipf/ProcessorBind.h
@@ -1,7 +1,7 @@
 /** @file\r
   Processor or Compiler specific defines and types for Intel Itanium(TM).\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006, Intel Corporation<BR>\r
   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
@@ -23,7 +23,7 @@
 \r
 \r
 //\r
-// Make sure we are useing the correct packing rules per EFI specification\r
+// Make sure we are using the correct packing rules per EFI specification\r
 //\r
 #pragma pack()\r
 \r
@@ -94,7 +94,7 @@
 #pragma warning ( disable : 4505 )\r
 \r
 //\r
-// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
+// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
 //\r
 #pragma warning ( disable : 4206 )\r
 \r
@@ -108,7 +108,7 @@
 \r
   #if _MSC_EXTENSIONS\r
     //\r
-    // use Microsoft C complier dependent interger width types\r
+    // use Microsoft C complier dependent integer width types\r
     //\r
     typedef unsigned __int64    UINT64;\r
     typedef __int64             INT64;\r
@@ -200,7 +200,7 @@ typedef INT64   INTN;
 //\r
 // Modifier to ensure that all protocol member functions and EFI intrinsics\r
 // use the correct C calling convention. All protocol member functions and\r
-// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
+// EFI intrinsics are required to modify their member functions with EFIAPI.\r
 //\r
 #if _MSC_EXTENSIONS\r
   //\r
@@ -245,11 +245,12 @@ typedef struct {
   instruction of a function independent of the CPU architecture being used.  This is very \r
   useful when printing function addresses through DEBUG() macros.\r
   \r
-  @param  p A pointer to a function\r
+  @param  FunctionPointer   A pointer to a function.\r
 \r
   @return The pointer to the first instruction of a function given a function pointer.\r
+  \r
 **/\r
-#define FUNCTION_ENTRY_POINT(p) (((EFI_PLABEL *)(p))->EntryPoint)\r
+#define FUNCTION_ENTRY_POINT(FunctionPointer) (((EFI_PLABEL *)(FunctionPointer))->EntryPoint)\r
 \r
 #endif\r
 \r

diff --git a/MdePkg/Include/X64/ProcessorBind.h b/MdePkg/Include/X64/ProcessorBind.h
index 2609a8e427f94e09752bfeebf04bcfb563c9cbce..e4db64d39b98fa04fda82aeb37168ec7ec5ce4b1 100644 (file)
--- a/MdePkg/Include/X64/ProcessorBind.h
+++ b/MdePkg/Include/X64/ProcessorBind.h
@@ -1,7 +1,7 @@
 /** @file\r
   Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006, Intel Corporation<BR>                                                         \r
   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
@@ -22,7 +22,7 @@
 \r
 \r
 //\r
-// Make sure we are useing the correct packing rules per EFI specification\r
+// Make sure we are using the correct packing rules per EFI specification\r
 //\r
 #ifndef __GNUC__\r
 #pragma pack()\r
@@ -85,7 +85,7 @@
 #pragma warning ( disable : 4505 )\r
 \r
 //\r
-// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
+// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
 //\r
 #pragma warning ( disable : 4206 )\r
 \r
@@ -99,7 +99,7 @@
  \r
   #if _MSC_EXTENSIONS \r
     //\r
-    // use Microsoft C complier dependent interger width types \r
+    // use Microsoft C complier dependent integer width types \r
     //\r
     typedef unsigned __int64    UINT64;\r
     typedef __int64             INT64;\r
@@ -243,11 +243,12 @@ typedef INT64   INTN;
   On x64 CPU architectures, these two pointer values are the same, \r
   so the implementation of this macro is very simple.\r
   \r
-  @param  p A pointer to a function\r
+  @param  FunctionPointer   A pointer to a function.\r
 \r
   @return The pointer to the first instruction of a function given a function pointer.\r
+  \r
 **/\r
-#define FUNCTION_ENTRY_POINT(p) (p)\r
+#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(FunctionPointer)\r
 \r
 #endif\r
 \r