]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Function description in baselib.h is not clear. change it to comply with Doxgen format.
authoreric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 9 Sep 2008 06:22:30 +0000 (06:22 +0000)
committereric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 9 Sep 2008 06:22:30 +0000 (06:22 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5862 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/BaseLib.h
MdePkg/Library/BaseLib/CheckSum.c
MdePkg/Library/BaseLib/String.c

index b2db844fc97c340255db35cbf3575ea03e5baeba..3d7afd4649e8c0ce9136a6729d1044fe8fde4478 100644 (file)
 #ifndef __BASE_LIB__\r
 #define __BASE_LIB__\r
 \r
-//\r
-// Definitions for architecture specific types\r
-// These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER\r
-//\r
-\r
 ///\r
-/// SPIN_LOCK\r
+/// Definitions for SPIN_LOCK\r
 ///\r
 typedef volatile UINTN              SPIN_LOCK;\r
 \r
+//\r
+// Definitions for architecture specific types\r
+//\r
 #if   defined (MDE_CPU_IA32)\r
 ///\r
 /// IA32 context buffer used by SetJump() and LongJump()\r
@@ -271,8 +269,8 @@ StrSize (
   @param  FirstString   Pointer to a Null-terminated Unicode string.\r
   @param  SecondString  Pointer to a Null-terminated Unicode string.\r
 \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -309,8 +307,8 @@ StrCmp (
   @param  SecondString  Pointer to a Null-terminated Unicode string.\r
   @param  Length        Maximum number of Unicode characters to compare.\r
 \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -430,7 +428,7 @@ StrnCat (
   @param  SearchString Pointer to a Null-terminated Unicode string to search for.\r
 \r
   @retval NULL            If the SearchString does not appear in String.\r
-  @retval !NULL           If there is a match.\r
+  @return others          If there is a match.\r
 \r
 **/\r
 CHAR16 *\r
@@ -627,7 +625,7 @@ NibbleToHexChar (
 /** \r
   Convert binary buffer to a Unicode String in a specified sequence. \r
 \r
-  This function converts bytes in the binary Buffer Buf to a Unicode String Str. \r
+  This function converts bytes in the memory block pointed by Buffer to a Unicode String Str. \r
   Each byte will be represented by two Unicode characters. For example, byte 0xA1 will \r
   be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character \r
   for the Most Significant Nibble will be put before the Unicode Character for the Least Significant\r
@@ -716,6 +714,10 @@ HexStringToBuf (
 \r
   If Digit is NULL, then ASSERT.\r
 \r
+  @param  Digit       The output hexadecimal digit.\r
+\r
+  @param  Char        The input Unicode character.\r
+\r
   @retval TRUE        Char is in the range of Hexadecimal number. Digit is updated\r
                       to the byte value of the number.\r
   @retval FALSE       Char is not in the range of Hexadecimal number. Digit is keep\r
@@ -901,8 +903,8 @@ AsciiStrSize (
   @param  FirstString   Pointer to a Null-terminated ASCII string.\r
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -936,10 +938,10 @@ AsciiStrCmp (
   @param  FirstString   Pointer to a Null-terminated ASCII string.\r
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval 0   FirstString is identical to SecondString using case insensitive\r
-              comparisons.\r
-  @retval !=0 FirstString is not identical to SecondString using case\r
-              insensitive comparisons.\r
+  @retval 0      FirstString is identical to SecondString using case insensitive\r
+                 comparisons.\r
+  @return others FirstString is not identical to SecondString using case\r
+                 insensitive comparisons.\r
 \r
 **/\r
 INTN\r
@@ -974,8 +976,8 @@ AsciiStriCmp (
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
   @param  Length        Maximum number of ASCII characters for compare.\r
   \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -1081,11 +1083,11 @@ AsciiStrnCat (
   String contains more than PcdMaximumAsciiStringLength Unicode characters\r
   not including the Null-terminator, then ASSERT().\r
 \r
-  @param  String                                 Pointer to a Null-terminated ASCII string.\r
-  @param  SearchString   Pointer to a Null-terminated ASCII string to search for.\r
+  @param  String          Pointer to a Null-terminated ASCII string.\r
+  @param  SearchString    Pointer to a Null-terminated ASCII string to search for.\r
 \r
   @retval NULL            If the SearchString does not appear in String.\r
-  @retval !NULL           If there is a match.\r
+  @return others          If there is a match.\r
 \r
 **/\r
 CHAR8 *\r
@@ -3270,8 +3272,8 @@ InterlockedCompareExchangePointer (
   If Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer .\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer .\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -3296,9 +3298,8 @@ CalculateSum8 (
   If Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-\r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -3324,8 +3325,8 @@ CalculateCheckSum8 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -3352,8 +3353,8 @@ CalculateSum16 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -3379,8 +3380,8 @@ CalculateCheckSum16 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -3407,8 +3408,8 @@ CalculateSum32 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -3434,8 +3435,8 @@ CalculateCheckSum32 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -3462,8 +3463,8 @@ CalculateSum64 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -3476,9 +3477,9 @@ CalculateCheckSum64 (
   );\r
 \r
 \r
-//\r
-// Base Library CPU Functions\r
-//\r
+///\r
+/// Base Library CPU Functions\r
+///\r
 typedef\r
 VOID\r
 (EFIAPI *SWITCH_STACK_ENTRY_POINT)(\r
@@ -4915,12 +4916,10 @@ AsmSwitchStackAndBackingStore (
   IN      VOID                      *NewBsp\r
   );\r
 \r
-\r
-//\r
-// Bugbug: This call should be removed after\r
-//         the PalCall Instance issue has been fixed.\r
-//\r
 /**\r
+  @todo   This call should be removed after the PalCall\r
+          Instance issue has been fixed.\r
+\r
   Performs a PAL call using static calling convention.\r
 \r
   An internal function to perform a PAL call using static calling convention.\r
@@ -4946,124 +4945,122 @@ PalCallStatic (
 \r
 \r
 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)\r
-//\r
-// IA32 and X64 Specific Functions\r
-//\r
-//\r
-// Byte packed structure for 16-bit Real Mode EFLAGS\r
-//\r
+///\r
+/// IA32 and X64 Specific Functions\r
+/// Byte packed structure for 16-bit Real Mode EFLAGS\r
+///\r
 typedef union {\r
   struct {\r
-    UINT32  CF:1;           // Carry Flag\r
-    UINT32  Reserved_0:1;   // Reserved\r
-    UINT32  PF:1;           // Parity Flag\r
-    UINT32  Reserved_1:1;   // Reserved\r
-    UINT32  AF:1;           // Auxiliary Carry Flag\r
-    UINT32  Reserved_2:1;   // Reserved\r
-    UINT32  ZF:1;           // Zero Flag\r
-    UINT32  SF:1;           // Sign Flag\r
-    UINT32  TF:1;           // Trap Flag\r
-    UINT32  IF:1;           // Interrupt Enable Flag\r
-    UINT32  DF:1;           // Direction Flag\r
-    UINT32  OF:1;           // Overflow Flag\r
-    UINT32  IOPL:2;         // I/O Privilege Level\r
-    UINT32  NT:1;           // Nested Task\r
-    UINT32  Reserved_3:1;   // Reserved\r
+    UINT32  CF:1;           /// Carry Flag\r
+    UINT32  Reserved_0:1;   /// Reserved\r
+    UINT32  PF:1;           /// Parity Flag\r
+    UINT32  Reserved_1:1;   /// Reserved\r
+    UINT32  AF:1;           /// Auxiliary Carry Flag\r
+    UINT32  Reserved_2:1;   /// Reserved\r
+    UINT32  ZF:1;           /// Zero Flag\r
+    UINT32  SF:1;           /// Sign Flag\r
+    UINT32  TF:1;           /// Trap Flag\r
+    UINT32  IF:1;           /// Interrupt Enable Flag\r
+    UINT32  DF:1;           /// Direction Flag\r
+    UINT32  OF:1;           /// Overflow Flag\r
+    UINT32  IOPL:2;         /// I/O Privilege Level\r
+    UINT32  NT:1;           /// Nested Task\r
+    UINT32  Reserved_3:1;   /// Reserved\r
   } Bits;\r
   UINT16    Uint16;\r
 } IA32_FLAGS16;\r
 \r
-//\r
-// Byte packed structure for EFLAGS/RFLAGS\r
-// 32-bits on IA-32\r
-// 64-bits on X64.  The upper 32-bits on X64 are reserved\r
-//\r
+///\r
+/// Byte packed structure for EFLAGS/RFLAGS\r
+/// 32-bits on IA-32\r
+/// 64-bits on X64.  The upper 32-bits on X64 are reserved\r
+///\r
 typedef union {\r
   struct {\r
-    UINT32  CF:1;           // Carry Flag\r
-    UINT32  Reserved_0:1;   // Reserved\r
-    UINT32  PF:1;           // Parity Flag\r
-    UINT32  Reserved_1:1;   // Reserved\r
-    UINT32  AF:1;           // Auxiliary Carry Flag\r
-    UINT32  Reserved_2:1;   // Reserved\r
-    UINT32  ZF:1;           // Zero Flag\r
-    UINT32  SF:1;           // Sign Flag\r
-    UINT32  TF:1;           // Trap Flag\r
-    UINT32  IF:1;           // Interrupt Enable Flag\r
-    UINT32  DF:1;           // Direction Flag\r
-    UINT32  OF:1;           // Overflow Flag\r
-    UINT32  IOPL:2;         // I/O Privilege Level\r
-    UINT32  NT:1;           // Nested Task\r
-    UINT32  Reserved_3:1;   // Reserved\r
-    UINT32  RF:1;           // Resume Flag\r
-    UINT32  VM:1;           // Virtual 8086 Mode\r
-    UINT32  AC:1;           // Alignment Check\r
-    UINT32  VIF:1;          // Virtual Interrupt Flag\r
-    UINT32  VIP:1;          // Virtual Interrupt Pending\r
-    UINT32  ID:1;           // ID Flag\r
-    UINT32  Reserved_4:10;  // Reserved\r
+    UINT32  CF:1;           /// Carry Flag\r
+    UINT32  Reserved_0:1;   /// Reserved\r
+    UINT32  PF:1;           /// Parity Flag\r
+    UINT32  Reserved_1:1;   /// Reserved\r
+    UINT32  AF:1;           /// Auxiliary Carry Flag\r
+    UINT32  Reserved_2:1;   /// Reserved\r
+    UINT32  ZF:1;           /// Zero Flag\r
+    UINT32  SF:1;           /// Sign Flag\r
+    UINT32  TF:1;           /// Trap Flag\r
+    UINT32  IF:1;           /// Interrupt Enable Flag\r
+    UINT32  DF:1;           /// Direction Flag\r
+    UINT32  OF:1;           /// Overflow Flag\r
+    UINT32  IOPL:2;         /// I/O Privilege Level\r
+    UINT32  NT:1;           /// Nested Task\r
+    UINT32  Reserved_3:1;   /// Reserved\r
+    UINT32  RF:1;           /// Resume Flag\r
+    UINT32  VM:1;           /// Virtual 8086 Mode\r
+    UINT32  AC:1;           /// Alignment Check\r
+    UINT32  VIF:1;          /// Virtual Interrupt Flag\r
+    UINT32  VIP:1;          /// Virtual Interrupt Pending\r
+    UINT32  ID:1;           /// ID Flag\r
+    UINT32  Reserved_4:10;  /// Reserved\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_EFLAGS32;\r
 \r
-//\r
-// Byte packed structure for Control Register 0 (CR0)\r
-// 32-bits on IA-32\r
-// 64-bits on X64.  The upper 32-bits on X64 are reserved\r
-//\r
+///\r
+/// Byte packed structure for Control Register 0 (CR0)\r
+/// 32-bits on IA-32\r
+/// 64-bits on X64.  The upper 32-bits on X64 are reserved\r
+///\r
 typedef union {\r
   struct {\r
-    UINT32  PE:1;           // Protection Enable\r
-    UINT32  MP:1;           // Monitor Coprocessor\r
-    UINT32  EM:1;           // Emulation\r
-    UINT32  TS:1;           // Task Switched\r
-    UINT32  ET:1;           // Extension Type\r
-    UINT32  NE:1;           // Numeric Error\r
-    UINT32  Reserved_0:10;  // Reserved\r
-    UINT32  WP:1;           // Write Protect\r
-    UINT32  Reserved_1:1;   // Reserved\r
-    UINT32  AM:1;           // Alignment Mask\r
-    UINT32  Reserved_2:10;  // Reserved\r
-    UINT32  NW:1;           // Mot Write-through\r
-    UINT32  CD:1;           // Cache Disable\r
-    UINT32  PG:1;           // Paging\r
+    UINT32  PE:1;           /// Protection Enable\r
+    UINT32  MP:1;           /// Monitor Coprocessor\r
+    UINT32  EM:1;           /// Emulation\r
+    UINT32  TS:1;           /// Task Switched\r
+    UINT32  ET:1;           /// Extension Type\r
+    UINT32  NE:1;           /// Numeric Error\r
+    UINT32  Reserved_0:10;  /// Reserved\r
+    UINT32  WP:1;           /// Write Protect\r
+    UINT32  Reserved_1:1;   /// Reserved\r
+    UINT32  AM:1;           /// Alignment Mask\r
+    UINT32  Reserved_2:10;  /// Reserved\r
+    UINT32  NW:1;           /// Mot Write-through\r
+    UINT32  CD:1;           /// Cache Disable\r
+    UINT32  PG:1;           /// Paging\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_CR0;\r
 \r
-//\r
-// Byte packed structure for Control Register 4 (CR4)\r
-// 32-bits on IA-32\r
-// 64-bits on X64.  The upper 32-bits on X64 are reserved\r
-//\r
+///\r
+/// Byte packed structure for Control Register 4 (CR4)\r
+/// 32-bits on IA-32\r
+/// 64-bits on X64.  The upper 32-bits on X64 are reserved\r
+///\r
 typedef union {\r
   struct {\r
-    UINT32  VME:1;          // Virtual-8086 Mode Extensions\r
-    UINT32  PVI:1;          // Protected-Mode Virtual Interrupts\r
-    UINT32  TSD:1;          // Time Stamp Disable\r
-    UINT32  DE:1;           // Debugging Extensions\r
-    UINT32  PSE:1;          // Page Size Extensions\r
-    UINT32  PAE:1;          // Physical Address Extension\r
-    UINT32  MCE:1;          // Machine Check Enable\r
-    UINT32  PGE:1;          // Page Global Enable\r
-    UINT32  PCE:1;          // Performance Monitoring Counter\r
-                            // Enable\r
-    UINT32  OSFXSR:1;       // Operating System Support for\r
-                            // FXSAVE and FXRSTOR instructions\r
-    UINT32  OSXMMEXCPT:1;   // Operating System Support for\r
-                            // Unmasked SIMD Floating Point\r
-                            // Exceptions\r
-    UINT32  Reserved_0:2;   // Reserved\r
-    UINT32  VMXE:1;         // VMX Enable\r
-    UINT32  Reserved_1:18;  // Reseved\r
+    UINT32  VME:1;          /// Virtual-8086 Mode Extensions\r
+    UINT32  PVI:1;          /// Protected-Mode Virtual Interrupts\r
+    UINT32  TSD:1;          /// Time Stamp Disable\r
+    UINT32  DE:1;           /// Debugging Extensions\r
+    UINT32  PSE:1;          /// Page Size Extensions\r
+    UINT32  PAE:1;          /// Physical Address Extension\r
+    UINT32  MCE:1;          /// Machine Check Enable\r
+    UINT32  PGE:1;          /// Page Global Enable\r
+    UINT32  PCE:1;          /// Performance Monitoring Counter\r
+                            /// Enable\r
+    UINT32  OSFXSR:1;       /// Operating System Support for\r
+                            /// FXSAVE and FXRSTOR instructions\r
+    UINT32  OSXMMEXCPT:1;   /// Operating System Support for\r
+                            /// Unmasked SIMD Floating Point\r
+                            /// Exceptions\r
+    UINT32  Reserved_0:2;   /// Reserved\r
+    UINT32  VMXE:1;         /// VMX Enable\r
+    UINT32  Reserved_1:18;  /// Reseved\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_CR4;\r
 \r
-//\r
-// Byte packed structure for an IDTR, GDTR, LDTR descriptor\r
-/// @bug  How to make this structure byte-packed in a compiler independent way?\r
-//\r
+///\r
+/// Byte packed structure for an IDTR, GDTR, LDTR descriptor\r
+/// @todo  How to make this structure byte-packed in a compiler independent way?\r
+///\r
 #pragma pack (1)\r
 typedef struct {\r
   UINT16  Limit;\r
@@ -5077,30 +5074,30 @@ typedef struct {
 #define IA32_IDT_GATE_TYPE_INTERRUPT_32  0x8E\r
 #define IA32_IDT_GATE_TYPE_TRAP_32       0x8F\r
 \r
-//\r
-// Byte packed structure for an Interrupt Gate Descriptor\r
-//\r
+///\r
+/// Byte packed structure for an Interrupt Gate Descriptor\r
+///\r
 typedef union {\r
   struct {\r
-    UINT32  OffsetLow:16;   // Offset bits 15..0\r
-    UINT32  Selector:16;    // Selector\r
-    UINT32  Reserved_0:8;   // Reserved\r
-    UINT32  GateType:8;     // Gate Type.  See #defines above\r
-    UINT32  OffsetHigh:16;  // Offset bits 31..16\r
+    UINT32  OffsetLow:16;   /// Offset bits 15..0\r
+    UINT32  Selector:16;    /// Selector\r
+    UINT32  Reserved_0:8;   /// Reserved\r
+    UINT32  GateType:8;     /// Gate Type.  See #defines above\r
+    UINT32  OffsetHigh:16;  /// Offset bits 31..16\r
   } Bits;\r
   UINT64  Uint64;\r
 } IA32_IDT_GATE_DESCRIPTOR;\r
 \r
-//\r
-// Byte packed structure for an FP/SSE/SSE2 context\r
-//\r
+///\r
+/// Byte packed structure for an FP/SSE/SSE2 context\r
+///\r
 typedef struct {\r
   UINT8  Buffer[512];\r
 } IA32_FX_BUFFER;\r
 \r
-//\r
-// Structures for the 16-bit real mode thunks\r
-//\r
+///\r
+/// Structures for the 16-bit real mode thunks\r
+///\r
 typedef struct {\r
   UINT32                            Reserved1;\r
   UINT32                            Reserved2;\r
@@ -5164,9 +5161,9 @@ typedef union {
   IA32_BYTE_REGS                    H;\r
 } IA32_REGISTER_SET;\r
 \r
-//\r
-// Byte packed structure for an 16-bit real mode thunks\r
-//\r
+///\r
+/// Byte packed structure for an 16-bit real mode thunks\r
+///\r
 typedef struct {\r
   IA32_REGISTER_SET                 *RealModeState;\r
   VOID                              *RealModeBuffer;\r
@@ -7221,10 +7218,6 @@ AsmPrepareAndThunk16 (
   IN OUT  THUNK_CONTEXT             *ThunkContext\r
   );\r
 \r
-#else\r
-\r
-#endif\r
-\r
 #endif\r
 \r
 \r
index 8612c7c392bb574930d4f1a0456ef27fefd77731..78ff00c451004b22b42b215b7d8d6a36e0acaa00 100644 (file)
@@ -31,8 +31,8 @@
   If Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer .\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer .\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -70,9 +70,8 @@ CalculateSum8 (
   If Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-\r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -107,8 +106,8 @@ CalculateCheckSum8 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -152,8 +151,8 @@ CalculateSum16 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -189,8 +188,8 @@ CalculateCheckSum16 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -234,8 +233,8 @@ CalculateSum32 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -271,8 +270,8 @@ CalculateCheckSum32 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -316,8 +315,8 @@ CalculateSum64 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
index 6b68bb2eeca8b3fa0a087709f40b3d893a81a2ab..2379c23450b240c5ec81004adeacb892070a83d5 100644 (file)
@@ -229,8 +229,8 @@ StrSize (
   @param  FirstString   Pointer to a Null-terminated Unicode string.\r
   @param  SecondString  Pointer to a Null-terminated Unicode string.\r
 \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -279,8 +279,8 @@ StrCmp (
   @param  SecondString  Pointer to a Null-terminated Unicode string.\r
   @param  Length        Maximum number of Unicode characters to compare.\r
 \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -438,7 +438,7 @@ StrnCat (
   @param  SearchString  Pointer to a Null-terminated Unicode string to search for.\r
 \r
   @retval NULL            If the SearchString does not appear in String.\r
-  @retval !NULL           If there is a match.\r
+  @return others          If there is a match.\r
 \r
 **/\r
 CHAR16 *\r
@@ -1265,8 +1265,8 @@ AsciiStrSize (
   @param  FirstString   Pointer to a Null-terminated ASCII string.\r
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -1362,10 +1362,10 @@ InternalAsciiHexCharToUintn (
   @param  FirstString   Pointer to a Null-terminated ASCII string.\r
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval 0   FirstString is identical to SecondString using case insensitive\r
-              comparisons.\r
-  @retval !=0 FirstString is not identical to SecondString using case\r
-              insensitive comparisons.\r
+  @retval 0      FirstString is identical to SecondString using case insensitive\r
+                 comparisons.\r
+  @return others FirstString is not identical to SecondString using case\r
+                 insensitive comparisons.\r
 \r
 **/\r
 INTN\r
@@ -1420,8 +1420,8 @@ AsciiStriCmp (
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
   @param  Length        Maximum number of ASCII characters to compare.\r
                         \r
-  @retval 0   FirstString is identical to SecondString.\r
-  @retval !=0 FirstString is not identical to SecondString.\r
+  @retval 0      FirstString is identical to SecondString.\r
+  @return others FirstString is not identical to SecondString.\r
 \r
 **/\r
 INTN\r
@@ -1568,7 +1568,7 @@ AsciiStrnCat (
   @param  SearchString    Pointer to a Null-terminated ASCII string to search for.\r
 \r
   @retval NULL            If the SearchString does not appear in String.\r
-  @retval !NULL           If there is a match.\r
+  @return others          If there is a match.\r
 \r
 **/\r
 CHAR8 *\r
@@ -2103,7 +2103,7 @@ NibbleToHexChar (
 /** \r
   Convert binary buffer to a Unicode String in a specified sequence. \r
 \r
-  This function converts bytes in the binary Buffer Buf to a Unicode String Str. \r
+  This function converts bytes in the memory block pointed by Buffer to a Unicode String Str. \r
   Each byte will be represented by two Unicode characters. For example, byte 0xA1 will \r
   be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character \r
   for the Most Significant Nibble will be put before the Unicode Character for the Least Significant\r
@@ -2278,6 +2278,10 @@ HexStringToBuf (
   L'A' will be converted to 0x0A. \r
 \r
   If Digit is NULL, then ASSERT.\r
+  \r
+  @param  Digit       The output hexadecimal digit.\r
+\r
+  @param  Char        The input Unicode character.\r
 \r
   @retval TRUE        Char is in the range of Hexadecimal number. Digit is updated\r
                       to the byte value of the number.\r