Grammatical and disclaimer changes (does not follow internal C coding stds.)
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 12 Mar 2010 22:19:12 +0000 (22:19 +0000)
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 12 Mar 2010 22:19:12 +0000 (22:19 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524

85 files changed:
MdePkg/Include/Base.h
MdePkg/Include/Ebc/ProcessorBind.h
MdePkg/Include/Guid/EventGroup.h
MdePkg/Include/Guid/FileInfo.h
MdePkg/Include/Guid/FileSystemInfo.h
MdePkg/Include/Guid/HiiPlatformSetupFormset.h
MdePkg/Include/IndustryStandard/Acpi10.h
MdePkg/Include/IndustryStandard/Atapi.h
MdePkg/Include/IndustryStandard/Pci.h
MdePkg/Include/IndustryStandard/Pci23.h
MdePkg/Include/IndustryStandard/PeImage.h
MdePkg/Include/IndustryStandard/Sal.h
MdePkg/Include/IndustryStandard/SmBios.h
MdePkg/Include/Library/BaseLib.h
MdePkg/Include/Library/BaseMemoryLib.h
MdePkg/Include/Library/DebugLib.h
MdePkg/Include/Library/DevicePathLib.h
MdePkg/Include/Library/DxeServicesLib.h
MdePkg/Include/Library/PeCoffGetEntryPointLib.h
MdePkg/Include/Library/PeCoffLib.h
MdePkg/Include/Library/PrintLib.h
MdePkg/Include/Library/ReportStatusCodeLib.h
MdePkg/Include/Library/UefiLib.h
MdePkg/Include/Library/UefiRuntimeLib.h
MdePkg/Include/Pi/PiDxeCis.h
MdePkg/Include/Pi/PiFirmwareFile.h
MdePkg/Include/Pi/PiHob.h
MdePkg/Include/Pi/PiMultiPhase.h
MdePkg/Include/Pi/PiPeiCis.h
MdePkg/Include/Pi/PiStatusCode.h
MdePkg/Include/PiDxe.h
MdePkg/Include/PiPei.h
MdePkg/Include/PiSmm.h
MdePkg/Include/Ppi/BlockIo.h
MdePkg/Include/Ppi/CpuIo.h
MdePkg/Include/Ppi/Pcd.h
MdePkg/Include/Ppi/ReadOnlyVariable2.h
MdePkg/Include/Ppi/SecPlatformInformation.h
MdePkg/Include/Protocol/Arp.h
MdePkg/Include/Protocol/AuthenticationInfo.h
MdePkg/Include/Protocol/Bis.h
MdePkg/Include/Protocol/ComponentName.h
MdePkg/Include/Protocol/DebugSupport.h
MdePkg/Include/Protocol/DevicePath.h
MdePkg/Include/Protocol/Dhcp4.h
MdePkg/Include/Protocol/DriverBinding.h
MdePkg/Include/Protocol/DriverDiagnostics.h
MdePkg/Include/Protocol/DriverFamilyOverride.h
MdePkg/Include/Protocol/FirmwareVolumeBlock.h
MdePkg/Include/Protocol/FormBrowser2.h
MdePkg/Include/Protocol/Hash.h
MdePkg/Include/Protocol/HiiConfigAccess.h
MdePkg/Include/Protocol/HiiConfigRouting.h
MdePkg/Include/Protocol/HiiDatabase.h
MdePkg/Include/Protocol/HiiFont.h
MdePkg/Include/Protocol/HiiString.h
MdePkg/Include/Protocol/IdeControllerInit.h
MdePkg/Include/Protocol/Ip4.h
MdePkg/Include/Protocol/Ip4Config.h
MdePkg/Include/Protocol/LoadFile.h
MdePkg/Include/Protocol/ManagedNetwork.h
MdePkg/Include/Protocol/MonotonicCounter.h
MdePkg/Include/Protocol/MpService.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
MdePkg/Include/Protocol/Pcd.h
MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
MdePkg/Include/Protocol/PciPlatform.h
MdePkg/Include/Protocol/PxeBaseCode.h
MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
MdePkg/Include/Protocol/SimpleFileSystem.h
MdePkg/Include/Protocol/SimpleNetwork.h
MdePkg/Include/Protocol/SimpleTextOut.h
MdePkg/Include/Protocol/TapeIo.h
MdePkg/Include/Protocol/TcgService.h
MdePkg/Include/Protocol/Tcp4.h
MdePkg/Include/Protocol/Udp4.h
MdePkg/Include/Protocol/UnicodeCollation.h
MdePkg/Include/Uefi.h
MdePkg/Include/Uefi/UefiBaseType.h
MdePkg/Include/Uefi/UefiGpt.h
MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
MdePkg/Include/Uefi/UefiMultiPhase.h
MdePkg/Include/Uefi/UefiPxe.h
MdePkg/Include/Uefi/UefiSpec.h

index 98fdca36a6dbe577dd162c4edb24b7b94424a6da..5eabb80eff4841d6dcb34437ba00f969477ef527 100644 (file)
@@ -6,12 +6,12 @@
   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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
 Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
-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
@@ -60,8 +60,8 @@ extern UINT8 _VerifySizeOfChar16  [(sizeof(CHAR16)  == 2) / (sizeof(CHAR16)  ==
   #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
@@ -138,17 +138,17 @@ struct _LIST_ENTRY {
 //\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
@@ -158,18 +158,18 @@ struct _LIST_ENTRY {
 //\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
@@ -414,9 +414,9 @@ struct _LIST_ENTRY {
 /**\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
@@ -468,14 +468,15 @@ typedef __builtin_va_list VA_LIST;
 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
@@ -491,7 +492,7 @@ typedef CHAR8 *VA_LIST;
   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
@@ -506,7 +507,7 @@ typedef CHAR8 *VA_LIST;
   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
@@ -539,7 +540,7 @@ typedef UINTN  *BASE_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   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
@@ -549,7 +550,7 @@ typedef UINTN  *BASE_LIST;
 #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
@@ -689,7 +690,7 @@ typedef UINTN RETURN_STATUS;
 /**\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
@@ -847,7 +848,7 @@ typedef UINTN RETURN_STATUS;
 #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
index 86b9b99408b34cc4bb3331d3dc22923bed119106..3eb3cf93570d81a25a087c4ea1d8d62c6c398d7e 100644 (file)
@@ -4,14 +4,14 @@
   We currently only have one EBC compiler so there may be some Intel compiler\r
   specific functions in this file.\r
 \r
-  Copyright (c) 2006 - 2009, 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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
 \r
@@ -37,19 +37,19 @@ typedef char                  INT8;
 ///\r
 typedef unsigned char         BOOLEAN;\r
 ///\r
-/// 1-byte unsigned value\r
+/// 1-byte unsigned value.\r
 ///\r
 typedef unsigned char         UINT8;\r
 ///\r
-/// 1-byte Character\r
+/// 1-byte Character.\r
 ///\r
 typedef char                  CHAR8;\r
 ///\r
-/// 2-byte signed value\r
+/// 2-byte signed value.\r
 ///\r
 typedef short                 INT16;\r
 ///\r
-/// 2-byte unsigned value\r
+/// 2-byte unsigned value.\r
 ///\r
 typedef unsigned short        UINT16;\r
 ///\r
@@ -58,19 +58,19 @@ typedef unsigned short        UINT16;
 ///\r
 typedef unsigned short        CHAR16;\r
 ///\r
-/// 4-byte signed value\r
+/// 4-byte signed value.\r
 ///\r
 typedef int                   INT32;\r
 ///\r
-/// 4-byte unsigned value\r
+/// 4-byte unsigned value.\r
 ///\r
 typedef unsigned int          UINT32;\r
 ///\r
-/// 8-byte signed value\r
+/// 8-byte signed value.\r
 ///\r
 typedef __int64               INT64;\r
 ///\r
-/// 8-byte unsigned value\r
+/// 8-byte unsigned value.\r
 ///\r
 typedef unsigned __int64      UINT64;\r
 \r
@@ -81,20 +81,20 @@ typedef unsigned __int64      UINT64;
 ///\r
 typedef long                  INTN;\r
 ///\r
-/// Unsigned value of native width.  (4 bytes on supported 32-bit processor instructions,\r
+/// The unsigned value of native width.  (4 bytes on supported 32-bit processor instructions;\r
 /// 8 bytes on supported 64-bit processor instructions)\r
-/// "long" type scales to the processor native size with EBC compiler\r
+/// "long" type scales to the processor native size with the EBC compiler.\r
 ///\r
 typedef unsigned long         UINTN;\r
 \r
 ///\r
 /// A value of native width with the highest bit set.\r
-/// Scalable macro to set the most significant bit in a natural number\r
+/// Scalable macro to set the most significant bit in a natural number.\r
 ///\r
 #define MAX_BIT     (1ULL << (sizeof (INTN) * 8 - 1)) \r
 ///\r
 /// A value of native width with the two highest bits set.\r
-/// Scalable macro to set the most 2 significant bits in a natural number\r
+/// Scalable macro to set the most 2 significant bits in a natural number.\r
 ///\r
 #define MAX_2_BITS  (3ULL << (sizeof (INTN) * 8 - 2))\r
 \r
index 47671f756536554a5847e48c36a6ab0cde57509c..16d5bd66b8f4247b06a546c38230846faf516b4e 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   GUIDs for gBS->CreateEventEx Event Groups. Defined in UEFI spec 2.0 and PI 1.2.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation                                                         \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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
 \r
index 20068f7e2e03913b2f39abe9c2d3a2d5c4dab7b5..5e8ecc848840661412352913ce5ef63f552c4792 100644 (file)
@@ -3,14 +3,14 @@
   and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
   This GUID is defined in UEFI specification.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
 \r
@@ -24,7 +24,7 @@
 \r
 typedef struct {\r
   ///\r
-  /// Size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
+  /// The size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
   ///\r
   UINT64    Size;\r
   ///\r
index b3f8f0b57695e6497606276d0e730427fddf20d1..7556746db1c7d33f5b48b3a386a1572df46bd73e 100644 (file)
@@ -3,14 +3,14 @@
   or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume.\r
   This GUID is defined in UEFI specification.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
 \r
@@ -24,7 +24,7 @@
 \r
 typedef struct {\r
   ///\r
-  /// Size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.\r
+  /// The size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.\r
   ///\r
   UINT64  Size;\r
   ///\r
index eed9a85f066a395d2d25d540ca4791e18f67164d..ae7046672171bf6fc9fda986f74f66612ab7cf4e 100644 (file)
@@ -2,14 +2,14 @@
   GUID indicates that the form set contains forms designed to be used \r
   for platform configuration and this form set will be displayed.\r
 \r
-  Copyright (c) 2009, Intel Corporation                                                         \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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
   @par Revision Reference:\r
   GUID defined in UEFI 2.1.\r
index b463d6ff280b1280563f3c8937fed7aa7b171555..f05346a50d469a46d25549092628964730b17df2 100644 (file)
@@ -1,14 +1,14 @@
 /** @file   \r
   ACPI 1.0b definitions from the ACPI Specification, revision 1.0b\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 \r
 #ifndef _ACPI_1_0_H_\r
@@ -16,7 +16,7 @@
 \r
 ///\r
 /// Common table header, this prefaces all ACPI tables, including FACS, but\r
-/// excluding the RSD PTR structure\r
+/// excluding the RSD PTR structure.\r
 ///\r
 typedef struct {\r
   UINT32  Signature;\r
@@ -25,7 +25,7 @@ typedef struct {
 \r
 #pragma pack(1)\r
 ///\r
-/// Common ACPI description table header.  This structure prefaces most ACPI tables.\r
+/// The common ACPI description table header.  This structure prefaces most ACPI tables.\r
 ///\r
 typedef struct {\r
   UINT32  Signature;\r
@@ -54,7 +54,7 @@ typedef struct {
 #define ACPI_ADDRESS_SPACE_TYPE_BUS   0x02\r
 \r
 ///\r
-/// Power Management Timer frequency is fixed at 3.579545MHz\r
+/// Power Management Timer frequency is fixed at 3.579545MHz.\r
 ///\r
 #define ACPI_TIMER_FREQUENCY       3579545\r
 \r
@@ -65,7 +65,7 @@ typedef struct {
 \r
 ///\r
 /// The commond definition of QWORD, DWORD, and WORD\r
-/// Address Space Descriptors\r
+/// Address Space Descriptors.\r
 ///\r
 typedef PACKED struct {\r
   UINT8   Desc;\r
@@ -83,7 +83,7 @@ typedef PACKED struct {
 #pragma pack()\r
 \r
 ///\r
-/// the End tag identifies an end of resource data.\r
+/// The End tag identifies an end of resource data.\r
 ///\r
 typedef struct {\r
   UINT8 Desc;\r
@@ -135,7 +135,7 @@ typedef struct {
 //\r
 \r
 ///\r
-/// Root System Description Pointer Structure\r
+/// Root System Description Pointer Structure.\r
 ///\r
 typedef struct {\r
   UINT64  Signature;\r
@@ -152,12 +152,12 @@ typedef struct {
 //\r
 \r
 ///\r
-/// RSDT Revision (as defined in ACPI 1.0b spec.)\r
+/// RSDT Revision (as defined in ACPI 1.0b specification).\r
 ///\r
 #define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
 \r
 ///\r
-/// Fixed ACPI Description Table Structure (FADT)\r
+/// Fixed ACPI Description Table Structure (FADT).\r
 ///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER Header;\r
@@ -203,7 +203,7 @@ typedef struct {
 } EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;\r
 \r
 ///\r
-/// FADT Version (as defined in ACPI 1.0b spec.)\r
+/// FADT Version (as defined in ACPI 1.0b specification).\r
 ///\r
 #define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION  0x01\r
 \r
@@ -223,7 +223,7 @@ typedef struct {
 #define EFI_ACPI_1_0_DCK_CAP              BIT9\r
 \r
 ///\r
-/// Firmware ACPI Control Structure\r
+/// Firmware ACPI Control Structure.\r
 ///\r
 typedef struct {\r
   UINT32  Signature;\r
@@ -236,14 +236,14 @@ typedef struct {
 } EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;\r
 \r
 ///\r
-/// Firmware Control Structure Feature Flags\r
+/// Firmware Control Structure Feature Flags.\r
 /// All other bits are reserved and must be set to 0.\r
 ///\r
 #define EFI_ACPI_1_0_S4BIOS_F             BIT0\r
 \r
 ///\r
 /// Multiple APIC Description Table header definition.  The rest of the table\r
-/// must be defined in a platform specific manner.\r
+/// must be defined in a platform-specific manner.\r
 ///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER Header;\r
@@ -252,7 +252,7 @@ typedef struct {
 } EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;\r
 \r
 ///\r
-/// MADT Revision (as defined in ACPI 1.0b spec.)\r
+/// MADT Revision (as defined in ACPI 1.0b specification).\r
 ///\r
 #define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01\r
 \r
@@ -278,7 +278,7 @@ typedef struct {
 //\r
 \r
 ///\r
-/// Processor Local APIC Structure Definition\r
+/// Processor Local APIC Structure Definition.\r
 ///\r
 typedef struct {\r
   UINT8   Type;\r
@@ -294,7 +294,7 @@ typedef struct {
 #define EFI_ACPI_1_0_LOCAL_APIC_ENABLED      BIT0\r
 \r
 ///\r
-/// IO APIC Structure\r
+/// IO APIC Structure.\r
 ///\r
 typedef struct {\r
   UINT8   Type;\r
@@ -306,7 +306,7 @@ typedef struct {
 } EFI_ACPI_1_0_IO_APIC_STRUCTURE;\r
 \r
 ///\r
-/// Interrupt Source Override Structure\r
+/// Interrupt Source Override Structure.\r
 ///\r
 typedef struct {\r
   UINT8   Type;\r
@@ -318,7 +318,7 @@ typedef struct {
 } EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;\r
 \r
 ///\r
-/// Non-Maskable Interrupt Source Structure\r
+/// Non-Maskable Interrupt Source Structure.\r
 ///\r
 typedef struct {\r
   UINT8   Type;\r
@@ -328,7 +328,7 @@ typedef struct {
 } EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;\r
 \r
 ///\r
-/// Local APIC NMI Structure\r
+/// Local APIC NMI Structure.\r
 ///\r
 typedef struct {\r
   UINT8   Type;\r
@@ -353,47 +353,47 @@ typedef struct {
 //\r
 \r
 ///\r
-/// "RSD PTR " Root System Description Pointer\r
+/// "RSD PTR " Root System Description Pointer.\r
 ///\r
 #define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE  SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')\r
 \r
 ///\r
-/// "APIC" Multiple APIC Description Table\r
+/// "APIC" Multiple APIC Description Table.\r
 ///\r
 #define EFI_ACPI_1_0_APIC_SIGNATURE  SIGNATURE_32('A', 'P', 'I', 'C')\r
 \r
 ///\r
-/// "DSDT" Differentiated System Description Table\r
+/// "DSDT" Differentiated System Description Table.\r
 ///\r
 #define EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('D', 'S', 'D', 'T')\r
 \r
 ///\r
-/// "FACS" Firmware ACPI Control Structure\r
+/// "FACS" Firmware ACPI Control Structure.\r
 ///\r
 #define EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE  SIGNATURE_32('F', 'A', 'C', 'S')\r
 \r
 ///\r
-/// "FACP" Fixed ACPI Description Table\r
+/// "FACP" Fixed ACPI Description Table.\r
 ///\r
 #define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('F', 'A', 'C', 'P')\r
 \r
 ///\r
-/// "PSDT" Persistent System Description Table\r
+/// "PSDT" Persistent System Description Table.\r
 ///\r
 #define EFI_ACPI_1_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('P', 'S', 'D', 'T')\r
 \r
 ///\r
-/// "RSDT" Root System Description Table\r
+/// "RSDT" Root System Description Table.\r
 ///\r
 #define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('R', 'S', 'D', 'T')\r
 \r
 ///\r
-/// "SBST" Smart Battery Specification Table\r
+/// "SBST" Smart Battery Specification Table.\r
 ///\r
 #define EFI_ACPI_1_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE  SIGNATURE_32('S', 'B', 'S', 'T')\r
 \r
 ///\r
-/// "SSDT" Secondary System Description Table\r
+/// "SSDT" Secondary System Description Table.\r
 ///\r
 #define EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('S', 'S', 'D', 'T')\r
 \r
index 276d364e674442f037bec426c62195dc10e35541..4c4588042a1fafe1d7a75ce36869fd8718357ed8 100644 (file)
@@ -2,13 +2,13 @@
   This file contains just some basic definitions that are needed by drivers\r
   that dealing with ATA/ATAPI interface.\r
 \r
-Copyright (c) 2007 - 2010, Intel Corporation\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
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+Copyright (c) 2007 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
@@ -19,16 +19,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #pragma pack(1)\r
 \r
 ///\r
-/// ATA5_IDENTIFY_DATA is defined in ATA-5\r
-/// (This structure is provided here mainly for backward-compatibility support.\r
-/// Old drivers may reference some field that is marked "obsolete" in \r
-/// ATA_IDENTIFY_DATA, which current conforms to ATA-8\r
+/// ATA5_IDENTIFY_DATA is defined in ATA-5.\r
+/// (This structure is provided mainly for backward-compatibility support.\r
+/// Old drivers may reference fields that are marked "obsolete" in \r
+/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.\r
 ///\r
 typedef struct {    \r
-  UINT16  config;             ///< General Configuration \r
-  UINT16  cylinders;          ///< Number of Cylinders \r
+  UINT16  config;             ///< General Configuration.\r
+  UINT16  cylinders;          ///< Number of Cylinders.\r
   UINT16  reserved_2; \r
-  UINT16  heads;              ///< Number of logical heads \r
+  UINT16  heads;              ///< Number of logical heads. \r
   UINT16  vendor_data1; \r
   UINT16  vendor_data2; \r
   UINT16  sectors_per_track; \r
@@ -77,14 +77,14 @@ typedef struct {
 } ATA5_IDENTIFY_DATA;\r
 \r
 ///\r
-/// ATA_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec\r
+/// ATA_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
 /// to define the data returned by an ATA device upon successful\r
-/// completion of the ATA IDENTIFY_DEVICE command\r
+/// completion of the ATA IDENTIFY_DEVICE command.\r
 ///\r
 typedef struct {\r
-  UINT16  config;                                  ///< General Configuration\r
+  UINT16  config;                                  ///< General Configuration.\r
   UINT16  obsolete_1;\r
-  UINT16  specific_config;                         ///< Specific Configuration\r
+  UINT16  specific_config;                         ///< Specific Configuration.\r
   UINT16  obsolete_3;\r
   UINT16  retired_4_5[2]; \r
   UINT16  obsolete_6;\r
@@ -114,7 +114,7 @@ typedef struct {
   UINT16  min_pio_cycle_time_with_flow_control; \r
   UINT16  reserved_69_74[6]; \r
   UINT16  queue_depth;     \r
-  UINT16  reserved_76_79[4];                       ///< reserved for Serial ATA\r
+  UINT16  reserved_76_79[4];                       ///< Reserved for Serial ATA.\r
   UINT16  major_version_no; \r
   UINT16  minor_version_no; \r
   UINT16  command_set_supported_82;                ///< word 82\r
@@ -176,14 +176,14 @@ typedef struct {
 } ATA_IDENTIFY_DATA;\r
 \r
 ///\r
-/// ATAPI_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec\r
+/// ATAPI_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
 /// to define the data returned by an ATAPI device upon successful\r
-/// completion of the ATA IDENTIFY_PACKET_DEVICE command\r
+/// completion of the ATA IDENTIFY_PACKET_DEVICE command.\r
 ///\r
 typedef struct {\r
-  UINT16  config;                                  ///< General Configuration\r
+  UINT16  config;                                  ///< General Configuration.\r
   UINT16  reserved_1;\r
-  UINT16  specific_config;                         ///< Specific Configuration\r
+  UINT16  specific_config;                         ///< Specific Configuration.\r
   UINT16  reserved_3_9[7];\r
   CHAR8   SerialNo[20];                            ///< word 10~19\r
   UINT16  reserved_20_22[3];\r
@@ -239,14 +239,14 @@ typedef struct {
 \r
 \r
 ///\r
-/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 peripheral_type;\r
   UINT8 RMB;\r
   UINT8 version;\r
   UINT8 response_data_format;\r
-  UINT8 addnl_length;     ///< n - 4, Numbers of bytes following this one\r
+  UINT8 addnl_length;     ///< n - 4, Numbers of bytes following this one.\r
   UINT8 reserved_5;\r
   UINT8 reserved_6;\r
   UINT8 reserved_7;\r
@@ -256,14 +256,14 @@ typedef struct {
   UINT8 vendor_specific_36_55[55 - 36 + 1];\r
   UINT8 reserved_56_95[95 - 56 + 1];\r
   ///\r
-  /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254\r
+  /// Vendor-specific parameters fields. The sizeof (ATAPI_INQUIRY_DATA) is 254\r
   /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.\r
   ///\r
   UINT8 vendor_specific_96_253[253 - 96 + 1];\r
 } ATAPI_INQUIRY_DATA;\r
 \r
 ///\r
-/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 error_code : 7;\r
@@ -291,7 +291,7 @@ typedef struct {
 } ATAPI_REQUEST_SENSE_DATA;\r
 \r
 ///\r
-/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 LastLba3;\r
@@ -306,7 +306,7 @@ typedef struct {
 \r
 ///\r
 /// Capacity List Header + Current/Maximum Capacity Descriptor,\r
-/// defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 reserved_0;\r
@@ -325,7 +325,7 @@ typedef struct {
 } ATAPI_READ_FORMAT_CAPACITY_DATA;\r
 \r
 ///\r
-/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -343,7 +343,7 @@ typedef struct {
 } ATAPI_TEST_UNIT_READY_CMD;\r
 \r
 ///\r
-/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -362,7 +362,7 @@ typedef struct {
 } ATAPI_INQUIRY_CMD;\r
 \r
 ///\r
-/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -381,7 +381,7 @@ typedef struct {
 } ATAPI_REQUEST_SENSE_CMD;\r
 \r
 ///\r
-/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -400,7 +400,7 @@ typedef struct {
 } ATAPI_READ10_CMD;\r
 \r
 ///\r
-/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -419,7 +419,7 @@ typedef struct {
 } ATAPI_READ_FORMAT_CAP_CMD;\r
 \r
 ///\r
-/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -439,8 +439,8 @@ typedef struct {
 } ATAPI_MODE_SENSE_CMD;\r
 \r
 ///\r
-/// ATAPI_PACKET_COMMAND is not defined in ATA specification.\r
-/// We add it here for the convenience for ATA/ATAPI module writer\r
+/// ATAPI_PACKET_COMMAND is not defined in the ATA specification.\r
+/// We add it here for the convenience of ATA/ATAPI module writers\r
 ///\r
 typedef union {\r
   UINT16                    Data16[6];\r
@@ -547,13 +547,13 @@ typedef union {
 #define ATA_CMD_WRITE_DMA_EXT         0x35   ///< defined from ATA-6\r
         \r
 ///\r
-/// default content of device control register, disable INT,\r
+/// Default content of device control register, disable INT,\r
 /// Bit3 is set to 1 according ATA-1\r
 ///\r
 #define ATA_DEFAULT_CTL           (0x0a)  \r
 ///\r
-/// default context of Device/Head Register,\r
-/// Bit7 and Bit5 are set to 1 for back-compatibilities\r
+/// Default context of Device/Head Register,\r
+/// Bit7 and Bit5 are set to 1 for back-compatibilities.\r
 ///\r
 #define ATA_DEFAULT_CMD           (0xa0)\r
 \r
@@ -598,7 +598,7 @@ typedef union {
 #define ATA_ASC_INVALID_FIELD               (0x24)\r
 #define ATA_ASC_WRITE_PROTECTED             (0x27)\r
 #define ATA_ASC_MEDIA_CHANGE                (0x28)\r
-#define ATA_ASC_RESET                       (0x29)  ///< Power On Reset or Bus Reset occurred\r
+#define ATA_ASC_RESET                       (0x29)  ///< Power On Reset or Bus Reset occurred.\r
 #define ATA_ASC_ILLEGAL_FIELD               (0x26)\r
 #define ATA_ASC_NO_MEDIA                    (0x3A)\r
 #define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)\r
@@ -636,8 +636,8 @@ typedef union {
 //\r
 // Device Control Register\r
 //\r
-#define ATA_CTLREG_SRST  BIT2  ///< Software Reset\r
-#define ATA_CTLREG_IEN_L BIT1  ///< Interrupt Enable #\r
+#define ATA_CTLREG_SRST  BIT2  ///< Software Reset.\r
+#define ATA_CTLREG_IEN_L BIT1  ///< Interrupt Enable #.\r
 \r
 #endif\r
 \r
index 2fcc8b6c4f14dfd179104380ca27eff489830653..1b2215d9fcdf542d3181cf978aff172197465c9e 100644 (file)
@@ -1,11 +1,14 @@
 /** @file\r
   Support for the latest PCI standard.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
   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
index 52d90e8fa60157154a15d7a2e36444e0ab7578f7..d9ad8ea0171307f6c7d7d5361bd202fb11fedece 100644 (file)
@@ -1,11 +1,11 @@
 /** @file\r
   Support for PCI 2.3 standard.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<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
-  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
@@ -18,7 +18,7 @@
 #include <IndustryStandard/Pci22.h>\r
 \r
 ///\r
-/// PCI_CLASS_MASS_STORAGE, Base Class 01h\r
+/// PCI_CLASS_MASS_STORAGE, Base Class 01h.\r
 ///\r
 ///@{\r
 #define PCI_CLASS_MASS_STORAGE_ATA       0x05\r
@@ -27,7 +27,7 @@
 ///@}\r
 \r
 ///\r
-/// PCI_CLASS_SERIAL, Base Class 0Ch\r
+/// PCI_CLASS_SERIAL, Base Class 0Ch.\r
 ///\r
 ///@{\r
 #define   PCI_IF_EHCI                      0x20\r
 #define PCI_EXP_MAX_CONFIG_OFFSET     0x1000\r
 \r
 ///\r
-/// PCI Capability List IDs and records\r
+/// PCI Capability List IDs and records.\r
 ///\r
 #define EFI_PCI_CAPABILITY_ID_PCIX    0x07\r
 \r
 #pragma pack(1)\r
 ///\r
 /// PCI-X Capabilities List, \r
-/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b\r
+/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b.\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -57,7 +57,7 @@ typedef struct {
 \r
 ///\r
 /// PCI-X Bridge Capabilities List, \r
-/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b\r
+/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b.\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
index 22f9149f18d746ca9abc4d72f90cbe76a59b5095..eb0ef976819a66c424287e76061efd3f7d9870c8 100644 (file)
@@ -7,15 +7,15 @@
   Common Object File Format Specification, Revision 8.0 - May 16, 2006. \r
   This file also includes some definitions in PI Specification, Revision 1.0.\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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
+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
+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
 **/\r
 \r
 /// under DOS it can print an error message.\r
 ///\r
 typedef struct {\r
-  UINT16  e_magic;    ///< Magic number\r
-  UINT16  e_cblp;     ///< Bytes on last page of file\r
-  UINT16  e_cp;       ///< Pages in file\r
-  UINT16  e_crlc;     ///< Relocations\r
-  UINT16  e_cparhdr;  ///< Size of header in paragraphs\r
-  UINT16  e_minalloc; ///< Minimum extra paragraphs needed\r
-  UINT16  e_maxalloc; ///< Maximum extra paragraphs needed\r
-  UINT16  e_ss;       ///< Initial (relative) SS value\r
-  UINT16  e_sp;       ///< Initial SP value\r
-  UINT16  e_csum;     ///< Checksum\r
-  UINT16  e_ip;       ///< Initial IP value\r
-  UINT16  e_cs;       ///< Initial (relative) CS value\r
-  UINT16  e_lfarlc;   ///< File address of relocation table\r
-  UINT16  e_ovno;     ///< Overlay number\r
-  UINT16  e_res[4];   ///< Reserved words\r
-  UINT16  e_oemid;    ///< OEM identifier (for e_oeminfo)\r
-  UINT16  e_oeminfo;  ///< OEM information; e_oemid specific\r
-  UINT16  e_res2[10]; ///< Reserved words\r
-  UINT32  e_lfanew;   ///< File address of new exe header\r
+  UINT16  e_magic;    ///< Magic number.\r
+  UINT16  e_cblp;     ///< Bytes on last page of file.\r
+  UINT16  e_cp;       ///< Pages in file.\r
+  UINT16  e_crlc;     ///< Relocations.\r
+  UINT16  e_cparhdr;  ///< Size of header in paragraphs.\r
+  UINT16  e_minalloc; ///< Minimum extra paragraphs needed.\r
+  UINT16  e_maxalloc; ///< Maximum extra paragraphs needed.\r
+  UINT16  e_ss;       ///< Initial (relative) SS value.\r
+  UINT16  e_sp;       ///< Initial SP value.\r
+  UINT16  e_csum;     ///< Checksum.\r
+  UINT16  e_ip;       ///< Initial IP value.\r
+  UINT16  e_cs;       ///< Initial (relative) CS value.\r
+  UINT16  e_lfarlc;   ///< File address of relocation table.\r
+  UINT16  e_ovno;     ///< Overlay number.\r
+  UINT16  e_res[4];   ///< Reserved words.\r
+  UINT16  e_oemid;    ///< OEM identifier (for e_oeminfo).\r
+  UINT16  e_oeminfo;  ///< OEM information; e_oemid specific.\r
+  UINT16  e_res2[10]; ///< Reserved words.\r
+  UINT32  e_lfanew;   ///< File address of new exe header.\r
 } EFI_IMAGE_DOS_HEADER;\r
 \r
 ///\r
-/// COFF File Header (Object and Image)\r
+/// COFF File Header (Object and Image).\r
 ///\r
 typedef struct {\r
   UINT16  Machine;\r
@@ -88,7 +88,7 @@ typedef struct {
 } EFI_IMAGE_FILE_HEADER;\r
 \r
 ///\r
-/// Size of EFI_IMAGE_FILE_HEADER\r
+/// Size of EFI_IMAGE_FILE_HEADER.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_FILE_HEADER        20\r
 \r
@@ -101,13 +101,13 @@ typedef struct {
 #define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED  BIT3     ///< 0x0008  Local symbols stripped from file.\r
 #define EFI_IMAGE_FILE_BYTES_REVERSED_LO    BIT7     ///< 0x0080  Bytes of machine word are reversed.\r
 #define EFI_IMAGE_FILE_32BIT_MACHINE        BIT8     ///< 0x0100  32 bit word machine.\r
-#define EFI_IMAGE_FILE_DEBUG_STRIPPED       BIT9     ///< 0x0200  Debugging info stripped from file in .DBG file\r
+#define EFI_IMAGE_FILE_DEBUG_STRIPPED       BIT9     ///< 0x0200  Debugging info stripped from file in .DBG file.\r
 #define EFI_IMAGE_FILE_SYSTEM               BIT12    ///< 0x1000  System File.\r
 #define EFI_IMAGE_FILE_DLL                  BIT13    ///< 0x2000  File is a DLL.\r
 #define EFI_IMAGE_FILE_BYTES_REVERSED_HI    BIT15    ///< 0x8000  Bytes of machine word are reversed.\r
 \r
 ///\r
-/// Header Data Directories\r
+/// Header Data Directories.\r
 ///\r
 typedef struct {\r
   UINT32  VirtualAddress;\r
@@ -140,7 +140,7 @@ typedef struct {
 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b\r
           \r
 ///\r
-/// Optional Header Standard Fields for PE32\r
+/// Optional Header Standard Fields for PE32.\r
 ///\r
 typedef struct {\r
   ///\r
@@ -154,7 +154,7 @@ typedef struct {
   UINT32                    SizeOfUninitializedData;\r
   UINT32                    AddressOfEntryPoint;\r
   UINT32                    BaseOfCode;\r
-  UINT32                    BaseOfData;  ///< PE32 contains this additional field, which is absent in PE32+\r
+  UINT32                    BaseOfData;  ///< PE32 contains this additional field, which is absent in PE32+.\r
   ///\r
   /// Optional Header Windows-Specific Fields.\r
   ///\r
@@ -191,7 +191,7 @@ typedef struct {
 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
 \r
 ///\r
-/// Optional Header Standard Fields for PE32+\r
+/// Optional Header Standard Fields for PE32+.\r
 ///\r
 typedef struct {\r
   ///\r
@@ -273,7 +273,7 @@ typedef struct {
 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
 \r
 ///\r
-/// Section Table, this table immediately follows the optional header\r
+/// Section Table. This table immediately follows the optional header.\r
 ///\r
 typedef struct {\r
   UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
@@ -292,7 +292,7 @@ typedef struct {
 } EFI_IMAGE_SECTION_HEADER;\r
 \r
 ///\r
-/// Size of EFI_IMAGE_SECTION_HEADER\r
+/// Size of EFI_IMAGE_SECTION_HEADER.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_SECTION_HEADER       40\r
          \r
@@ -326,7 +326,7 @@ typedef struct {
 #define EFI_IMAGE_SCN_MEM_WRITE                    BIT31  ///< 0x80000000\r
 \r
 ///\r
-/// Size of a Symbol Table Record\r
+/// Size of a Symbol Table Record.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_SYMBOL 18\r
 \r
@@ -439,15 +439,15 @@ typedef struct {
 //\r
 // I386 relocation types.\r
 //\r
-#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000  ///< Reference is absolute, no relocation is necessary\r
-#define EFI_IMAGE_REL_I386_DIR16    0x0001  ///< Direct 16-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_REL16    0x0002  ///< PC-relative 16-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_DIR32    0x0006  ///< Direct 32-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_DIR32NB  0x0007  ///< Direct 32-bit reference to the symbols virtual address, base not included\r
-#define EFI_IMAGE_REL_I386_SEG12    0x0009  ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address\r
+#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000  ///< Reference is absolute, no relocation is necessary.\r
+#define EFI_IMAGE_REL_I386_DIR16    0x0001  ///< Direct 16-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_REL16    0x0002  ///< PC-relative 16-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_DIR32    0x0006  ///< Direct 32-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_DIR32NB  0x0007  ///< Direct 32-bit reference to the symbols virtual address, base not included.\r
+#define EFI_IMAGE_REL_I386_SEG12    0x0009  ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.\r
 #define EFI_IMAGE_REL_I386_SECTION  0x000A\r
 #define EFI_IMAGE_REL_I386_SECREL   0x000B\r
-#define EFI_IMAGE_REL_I386_REL32    0x0014  ///< PC-relative 32-bit reference to the symbols virtual address\r
+#define EFI_IMAGE_REL_I386_REL32    0x0014  ///< PC-relative 32-bit reference to the symbols virtual address.\r
 \r
 // \r
 // x64 processor relocation types.\r
@@ -479,7 +479,7 @@ typedef struct {
 } EFI_IMAGE_BASE_RELOCATION;\r
 \r
 ///\r
-/// Size of EFI_IMAGE_BASE_RELOCATION\r
+/// Size of EFI_IMAGE_BASE_RELOCATION.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION  8\r
 \r
@@ -508,7 +508,7 @@ typedef struct {
 } EFI_IMAGE_LINENUMBER;\r
 \r
 ///\r
-/// Size of EFI_IMAGE_LINENUMBER\r
+/// Size of EFI_IMAGE_LINENUMBER.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
 \r
@@ -532,11 +532,11 @@ typedef struct {
   UINT8 GroupID[6];   ///< File member group id - decimal.\r
   UINT8 Mode[8];      ///< File member mode - octal.\r
   UINT8 Size[10];     ///< File member size - decimal.\r
-  UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A)\r
+  UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).\r
 } EFI_IMAGE_ARCHIVE_MEMBER_HEADER;\r
 \r
 ///\r
-/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER\r
+/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
 \r
@@ -546,7 +546,7 @@ typedef struct {
 //\r
 \r
 ///\r
-/// Export Directory Table\r
+/// Export Directory Table.\r
 ///\r
 typedef struct {\r
   UINT32  Characteristics;\r
@@ -563,7 +563,7 @@ typedef struct {
 } EFI_IMAGE_EXPORT_DIRECTORY;\r
 \r
 ///\r
-/// Hint/Name Table\r
+/// Hint/Name Table.\r
 ///\r
 typedef struct {\r
   UINT16  Hint;\r
@@ -571,7 +571,7 @@ typedef struct {
 } EFI_IMAGE_IMPORT_BY_NAME;\r
 \r
 ///\r
-/// Import Address Table RVA (Thunk Table)\r
+/// Import Address Table RVA (Thunk Table).\r
 ///\r
 typedef struct {\r
   union {\r
@@ -581,7 +581,7 @@ typedef struct {
   } u1;\r
 } EFI_IMAGE_THUNK_DATA;\r
 \r
-#define EFI_IMAGE_ORDINAL_FLAG              BIT31    ///< Flag for PE32\r
+#define EFI_IMAGE_ORDINAL_FLAG              BIT31    ///< Flag for PE32.\r
 #define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal)  ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)\r
 #define EFI_IMAGE_ORDINAL(Ordinal)          (Ordinal & 0xffff)\r
 \r
@@ -598,7 +598,7 @@ typedef struct {
 \r
 \r
 ///\r
-/// Debug Directory Format\r
+/// Debug Directory Format.\r
 ///\r
 typedef struct {\r
   UINT32  Characteristics;\r
@@ -607,14 +607,14 @@ typedef struct {
   UINT16  MinorVersion;\r
   UINT32  Type;\r
   UINT32  SizeOfData;\r
-  UINT32  RVA;           ///< The address of the debug data when loaded, relative to the image base\r
-  UINT32  FileOffset;    ///< The file pointer to the debug data\r
+  UINT32  RVA;           ///< The address of the debug data when loaded, relative to the image base.\r
+  UINT32  FileOffset;    ///< The file pointer to the debug data.\r
 } EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;\r
 \r
-#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2     ///< The Visual C++ debug information\r
+#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2     ///< The Visual C++ debug information.\r
 \r
 ///\r
-/// Debug Data Structure defined in Microsoft C++\r
+/// Debug Data Structure defined in Microsoft C++.\r
 ///\r
 #define CODEVIEW_SIGNATURE_NB10  SIGNATURE_32('N', 'B', '1', '0')\r
 typedef struct {\r
@@ -628,11 +628,11 @@ typedef struct {
 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;\r
 \r
 ///\r
-/// Debug Data Structure defined in Microsoft C++\r
+/// Debug Data Structure defined in Microsoft C++.\r
 ///\r
 #define CODEVIEW_SIGNATURE_RSDS  SIGNATURE_32('R', 'S', 'D', 'S')\r
 typedef struct {\r
-  UINT32  Signature;                        ///< "RSDS"\r
+  UINT32  Signature;                        ///< "RSDS".\r
   UINT32  Unknown;\r
   UINT32  Unknown2;\r
   UINT32  Unknown3;\r
@@ -645,11 +645,11 @@ typedef struct {
 \r
 \r
 ///\r
-/// Debug Data Structure defined by Apple Mach-O to Coff utility\r
+/// Debug Data Structure defined by Apple Mach-O to Coff utility.\r
 ///\r
 #define CODEVIEW_SIGNATURE_MTOC  SIGNATURE_32('M', 'T', 'O', 'C')\r
 typedef struct {\r
-  UINT32    Signature;                       ///< "MTOC"\r
+  UINT32    Signature;                       ///< "MTOC".\r
   GUID      MachOUuid;\r
   //\r
   //  Filename of .DLL (Mach-O with debug info) goes here\r
@@ -710,18 +710,18 @@ typedef struct {
 } EFI_IMAGE_RESOURCE_DATA_ENTRY;\r
 \r
 ///\r
-/// Header format for TE images, defined in PI Specification, 1.0\r
+/// Header format for TE images, defined in the PI Specification, 1.0.\r
 ///\r
 typedef struct {\r
-  UINT16                    Signature;            ///< signature for TE format = "VZ"\r
-  UINT16                    Machine;              ///< from the original file header\r
-  UINT8                     NumberOfSections;     ///< from the original file header\r
-  UINT8                     Subsystem;            ///< from original optional header\r
-  UINT16                    StrippedSize;         ///< how many bytes we removed from the header\r
-  UINT32                    AddressOfEntryPoint;  ///< offset to entry point -- from original optional header\r
-  UINT32                    BaseOfCode;           ///< from original image -- required for ITP debug\r
-  UINT64                    ImageBase;            ///< from original file header\r
-  EFI_IMAGE_DATA_DIRECTORY  DataDirectory[2];     ///< only base relocation and debug directory\r
+  UINT16                    Signature;            ///< The signature for TE format = "VZ".\r
+  UINT16                    Machine;              ///< From the original file header.\r
+  UINT8                     NumberOfSections;     ///< From the original file header.\r
+  UINT8                     Subsystem;            ///< From original optional header.\r
+  UINT16                    StrippedSize;         ///< Number of bytes we removed from the header.\r
+  UINT32                    AddressOfEntryPoint;  ///< Offset to entry point -- from original optional header.\r
+  UINT32                    BaseOfCode;           ///< From original image -- required for ITP debug.\r
+  UINT64                    ImageBase;            ///< From original file header.\r
+  EFI_IMAGE_DATA_DIRECTORY  DataDirectory[2];     ///< Only base relocation and debug directory.\r
 } EFI_TE_IMAGE_HEADER;\r
 \r
 \r
@@ -735,7 +735,7 @@ typedef struct {
 \r
 \r
 ///\r
-/// Union of PE32, PE32+, and TE headers\r
+/// Union of PE32, PE32+, and TE headers.\r
 ///\r
 typedef union {\r
   EFI_IMAGE_NT_HEADERS32   Pe32;\r
index cdc547a4e620f230135b2a40c351cd400018987e..093a681315756845c4ad5de2a1c8da2139e43d37 100644 (file)
@@ -2,14 +2,14 @@
   Main SAL API's defined in Intel Itanium Processor Family System Abstraction\r
   Layer Specification Revision 3.2 (December 2003)\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \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
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
 \r
@@ -26,7 +26,7 @@ typedef INTN EFI_SAL_STATUS;
 ///\r
 #define EFI_SAL_SUCCESS               ((EFI_SAL_STATUS) 0)\r
 ///\r
-/// Call completed without error but some information was lost due to overflow. \r
+/// Call completed without error, but some information was lost due to overflow. \r
 ///\r
 #define EFI_SAL_OVERFLOW              ((EFI_SAL_STATUS) 1)\r
 ///\r
@@ -63,23 +63,23 @@ typedef INTN EFI_SAL_STATUS;
 #define EFI_SAL_NOT_ENOUGH_SCRATCH    ((EFI_SAL_STATUS) - 9)\r
 \r
 ///\r
-/// Return registers from SAL\r
+/// Return registers from SAL.\r
 ///\r
 typedef struct {\r
   ///\r
-  /// SAL return status value in r8\r
+  /// SAL return status value in r8.\r
   ///\r
   EFI_SAL_STATUS  Status;\r
   ///\r
-  /// SAL returned value in r9\r
+  /// SAL returned value in r9.\r
   ///\r
   UINTN           r9;\r
   ///\r
-  /// SAL returned value in r10\r
+  /// SAL returned value in r10.\r
   ///\r
   UINTN           r10;\r
   ///\r
-  /// SAL returned value in r11\r
+  /// SAL returned value in r11.\r
   ///\r
   UINTN           r11;\r
 } SAL_RETURN_REGS;\r
@@ -96,11 +96,11 @@ typedef struct {
                              0x04XXXXXX to 0xFFFFFFFF - Reserved.\r
   @param  Arg1               The first parameter of the architected/OEM specific SAL functions.\r
   @param  Arg2               The second parameter of the architected/OEM specific SAL functions.\r
-  @param  Arg3               The third parameter passed to the ESAL function based\r
-  @param  Arg4               The fourth parameter passed to the ESAL function based\r
-  @param  Arg5               The fifth parameter passed to the ESAL function based\r
-  @param  Arg6               The sixth parameter passed to the ESAL function\r
-  @param  Arg7               The seventh parameter passed to the ESAL function based\r
+  @param  Arg3               The third parameter passed to the ESAL function based.\r
+  @param  Arg4               The fourth parameter passed to the ESAL function based.\r
+  @param  Arg5               The fifth parameter passed to the ESAL function based.\r
+  @param  Arg6               The sixth parameter passed to the ESAL function.\r
+  @param  Arg7               The seventh parameter passed to the ESAL function based.\r
 \r
   @return r8                 Return status: positive number indicates successful,\r
                              negative number indicates failure.\r
@@ -201,7 +201,7 @@ SAL_RETURN_REGS
 #define EFI_SAL_SET_INIT_VECTOR         0x1\r
 #define EFI_SAL_SET_BOOT_RENDEZ_VECTOR  0x2\r
 ///\r
-/// Format of length_cs_n argument.\r
+/// The format of a length_cs_n argument.\r
 ///\r
 typedef struct {\r
   UINT64  Length : 32;\r
@@ -267,7 +267,7 @@ typedef struct {
 #define EFI_SAL_PCI_COMPATIBLE_ADDRESS         0x0\r
 #define EFI_SAL_PCI_EXTENDED_REGISTER_ADDRESS  0x1\r
 ///\r
-/// Format of PCI Compatible Address\r
+/// The format of PCI Compatible Address.\r
 ///\r
 typedef struct {\r
   UINT64  Register : 8;\r
@@ -278,7 +278,7 @@ typedef struct {
   UINT64  Reserved : 32;\r
 } SAL_PCI_ADDRESS;\r
 ///\r
-/// Format of Extended Register Address\r
+/// The format of Extended Register Address.\r
 ///\r
 typedef struct {\r
   UINT64  Register : 8;\r
@@ -327,7 +327,7 @@ typedef struct {
   UINT8   Reserved2[40];\r
 } SAL_UPDATE_PAL_DATA_BLOCK;\r
 ///\r
-/// Data structure pointed by parameter param_buf.\r
+/// Data structure pointed by the parameter param_buf.\r
 /// It is a 16-byte aligned data structure in memory with a length of 32 bytes\r
 /// that describes the new firmware. This information is organized in the form\r
 /// of a linked list with each element describing one firmware component.\r
@@ -340,12 +340,12 @@ typedef struct _SAL_UPDATE_PAL_INFO_BLOCK {
 } SAL_UPDATE_PAL_INFO_BLOCK;\r
 \r
 ///\r
-/// SAL System Table Definitions\r
+/// SAL System Table Definitions.\r
 ///\r
 #pragma pack(1)\r
 typedef struct {\r
   ///\r
-  /// The ASCII string representation of "SST_" which confirms the presence of the table. \r
+  /// The ASCII string representation of "SST_" that confirms the presence of the table. \r
   /// \r
   UINT32  Signature;\r
   ///\r
@@ -355,7 +355,7 @@ typedef struct {
   UINT32  Length;\r
   ///\r
   /// The revision number of the Itanium Processor Family System Abstraction Layer\r
-  /// Specification supported by the SAL implementation in binary coded decimal (BCD) format.\r
+  /// Specification supported by the SAL implementation, in binary coded decimal (BCD) format.\r
   ///\r
   UINT16  SalRevision;\r
   ///\r
@@ -417,10 +417,10 @@ typedef struct {
 #define EFI_SAL_ST_AP_WAKEUP_SIZE          16\r
 \r
 ///\r
-/// Format of Entrypoint Descriptor Entry\r
+/// Format of Entrypoint Descriptor Entry.\r
 ///\r
 typedef struct {\r
-  UINT8   Type;         ///< Type here should be 0\r
+  UINT8   Type;         ///< Type here should be 0.\r
   UINT8   Reserved[7];\r
   UINT64  PalProcEntry;\r
   UINT64  SalProcEntry;\r
@@ -429,10 +429,10 @@ typedef struct {
 } SAL_ST_ENTRY_POINT_DESCRIPTOR;\r
 \r
 ///\r
-/// Format of Platform Features Descriptor Entry\r
+/// Format of Platform Features Descriptor Entry.\r
 ///\r
 typedef struct {\r
-  UINT8 Type;           ///< Type here should be 2\r
+  UINT8 Type;           ///< Type here should be 2.\r
   UINT8 PlatformFeatures;\r
   UINT8 Reserved[14];\r
 } SAL_ST_PLATFORM_FEATURES;\r
@@ -445,10 +445,10 @@ typedef struct {
 #define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04\r
 \r
 ///\r
-/// Format of Translation Register Descriptor Entry\r
+/// Format of Translation Register Descriptor Entry.\r
 ///\r
 typedef struct {\r
-  UINT8   Type;         ///< Type here should be 3\r
+  UINT8   Type;         ///< Type here should be 3.\r
   UINT8   TRType;\r
   UINT8   TRNumber;\r
   UINT8   Reserved[5];\r
@@ -464,7 +464,7 @@ typedef struct {
 #define EFI_SAL_ST_TR_USAGE_DATA        01\r
 \r
 ///\r
-/// Definition of Coherence Domain Information\r
+/// Definition of Coherence Domain Information.\r
 ///\r
 typedef struct {\r
   UINT64  NumberOfProcessors;\r
@@ -472,27 +472,27 @@ typedef struct {
 } SAL_COHERENCE_DOMAIN_INFO;\r
            \r
 ///\r
-/// Format of Purge Translation Cache Coherence Domain Entry\r
+/// Format of Purge Translation Cache Coherence Domain Entry.\r
 ///\r
 typedef struct {\r
-  UINT8                     Type;       ///< Type here should be 4\r
+  UINT8                     Type;       ///< Type here should be 4.\r
   UINT8                     Reserved[3];\r
   UINT32                    NumberOfDomains;\r
   SAL_COHERENCE_DOMAIN_INFO *DomainInformation;\r
 } SAL_ST_CACHE_COHERENCE_DECRIPTOR;\r
 \r
 ///\r
-/// Format of Application Processor Wake-Up Descriptor Entry\r
+/// Format of Application Processor Wake-Up Descriptor Entry.\r
 ///\r
 typedef struct {\r
-  UINT8   Type;                   ///< Type here should be 5\r
+  UINT8   Type;                   ///< Type here should be 5.\r
   UINT8   WakeUpType;\r
   UINT8   Reserved[6];\r
   UINT64  ExternalInterruptVector;\r
 } SAL_ST_AP_WAKEUP_DECRIPTOR;\r
 \r
 ///\r
-/// Format of Firmware Interface Table (FIT) Entry\r
+/// Format of Firmware Interface Table (FIT) Entry.\r
 ///\r
 typedef struct {\r
   UINT64  Address;\r
@@ -532,7 +532,7 @@ typedef struct {
 //\r
 \r
 ///\r
-/// Format of TimeStamp field in Record Header\r
+/// Format of TimeStamp field in Record Header.\r
 ///\r
 typedef struct {\r
   UINT8 Seconds;\r
@@ -545,7 +545,7 @@ typedef struct {
   UINT8 Century;\r
 } SAL_TIME_STAMP;\r
 ///\r
-/// Definition of Record Header\r
+/// Definition of Record Header.\r
 ///\r
 typedef struct {\r
   UINT64          RecordId;\r
@@ -557,7 +557,7 @@ typedef struct {
   UINT8           OemPlatformId[16];\r
 } SAL_RECORD_HEADER;\r
 ///\r
-/// Definition of Section Header\r
+/// Definition of Section Header.\r
 ///\r
 typedef struct {\r
   GUID      Guid;\r
@@ -568,7 +568,7 @@ typedef struct {
 } SAL_SEC_HEADER;\r
 \r
 ///\r
-/// GUID of Processor Machine Check Errors\r
+/// GUID of Processor Machine Check Errors.\r
 ///\r
 #define SAL_PROCESSOR_ERROR_RECORD_INFO \\r
   { \\r
@@ -583,7 +583,7 @@ typedef struct {
 #define TARGER_ID_VALID_BIT_MASK    0x8\r
 #define PRECISE_IP_VALID_BIT_MASK   0x10\r
 ///\r
-/// Definition of MOD_ERROR_INFO_STRUCT\r
+/// Definition of MOD_ERROR_INFO_STRUCT.\r
 ///\r
 typedef struct {\r
   UINT64  InfoValid : 1;\r
@@ -599,7 +599,7 @@ typedef struct {
   UINT64  Ip;\r
 } MOD_ERROR_INFO;\r
 ///\r
-/// Definition of CPUID_INFO_STRUCT\r
+/// Definition of CPUID_INFO_STRUCT.\r
 ///\r
 typedef struct {\r
   UINT8 CpuidInfo[40];\r
@@ -620,7 +620,7 @@ typedef struct {
 #define RR_VALID_BIT_MASK         0x10\r
 #define FR_VALID_BIT_MASK         0x20\r
 ///\r
-/// Definition of PSI_STATIC_STRUCT\r
+/// Definition of PSI_STATIC_STRUCT.\r
 ///\r
 typedef struct {\r
   UINT64    ValidFieldBits;\r
@@ -640,7 +640,7 @@ typedef struct {
 #define PROC_STATIC_STRUCT_VALID_BIT_MASK   0x8\r
 #define CPU_INFO_VALID_BIT_MASK             0x1000000\r
 ///\r
-/// Definition of Processor Machine Check Error Record\r
+/// Definition of Processor Machine Check Error Record.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER    SectionHeader;\r
@@ -658,7 +658,7 @@ typedef struct {
 } SAL_PROCESSOR_ERROR_RECORD;\r
 \r
 ///\r
-/// GUID of Platform Memory Device Error Info\r
+/// GUID of Platform Memory Device Error Info.\r
 ///\r
 #define SAL_MEMORY_ERROR_RECORD_INFO \\r
   { \\r
@@ -685,7 +685,7 @@ typedef struct {
 #define MEMORY_PLATFORM_OEM_ID_VALID_BIT_MASK             0x8000\r
 #define MEMORY_PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK    0x10000\r
 ///\r
-/// Definition of Platform Memory Device Error Info Record\r
+/// Definition of Platform Memory Device Error Info Record.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER  SectionHeader;\r
@@ -709,7 +709,7 @@ typedef struct {
 } SAL_MEMORY_ERROR_RECORD;\r
 \r
 ///\r
-/// GUID of Platform PCI Bus Error Info\r
+/// GUID of Platform PCI Bus Error Info.\r
 ///\r
 #define SAL_PCI_BUS_ERROR_RECORD_INFO \\r
   { \\r
@@ -731,7 +731,7 @@ typedef struct {
 #define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK  0x400\r
 \r
 ///\r
-/// Designated PCI Bus identifier\r
+/// Designated PCI Bus identifier.\r
 ///\r
 typedef struct {\r
   UINT8 BusNumber;\r
@@ -739,7 +739,7 @@ typedef struct {
 } PCI_BUS_ID;\r
 \r
 ///\r
-/// Definition of Platform PCI Bus Error Info Record\r
+/// Definition of Platform PCI Bus Error Info Record.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER  SectionHeader;\r
@@ -758,7 +758,7 @@ typedef struct {
 } SAL_PCI_BUS_ERROR_RECORD;\r
 \r
 ///\r
-/// GUID of Platform PCI Component Error Info\r
+/// GUID of Platform PCI Component Error Info.\r
 ///\r
 #define SAL_PCI_COMP_ERROR_RECORD_INFO \\r
   { \\r
@@ -774,7 +774,7 @@ typedef struct {
 #define PCI_COMP_REG_DATA_PAIR_VALID_BIT_MASK   0x10\r
 #define PCI_COMP_OEM_DATA_STRUCT_VALID_BIT_MASK 0x20\r
 ///\r
-/// Format of PCI Component Information to identify the device\r
+/// Format of PCI Component Information to identify the device.\r
 ///\r
 typedef struct {\r
   UINT16  VendorId;\r
@@ -787,7 +787,7 @@ typedef struct {
   UINT8   Reserved[5];\r
 } PCI_COMP_INFO;\r
 ///\r
-/// Definition of Platform PCI Component Error Info\r
+/// Definition of Platform PCI Component Error Info.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER  SectionHeader;\r
@@ -800,7 +800,7 @@ typedef struct {
 } SAL_PCI_COMPONENT_ERROR_RECORD;\r
 \r
 ///\r
-/// Platform SEL Device Error Info\r
+/// Platform SEL Device Error Info.\r
 ///\r
 #define SAL_SEL_DEVICE_ERROR_RECORD_INFO \\r
   { \\r
@@ -820,7 +820,7 @@ typedef struct {
 #define SEL_EVENT_DATA2_VALID_BIT_MASK    0x100;\r
 #define SEL_EVENT_DATA3_VALID_BIT_MASK    0x200;\r
 ///\r
-/// Definition of Platform SEL Device Error Info Record\r
+/// Definition of Platform SEL Device Error Info Record.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER  SectionHeader;\r
@@ -839,7 +839,7 @@ typedef struct {
 } SAL_SEL_DEVICE_ERROR_RECORD;\r
 \r
 ///\r
-/// GUID of Platform SMBIOS Device Error Info\r
+/// GUID of Platform SMBIOS Device Error Info.\r
 ///\r
 #define SAL_SMBIOS_ERROR_RECORD_INFO \\r
   { \\r
@@ -853,7 +853,7 @@ typedef struct {
 #define SMBIOS_TIME_STAMP_VALID_BIT_MASK  0x4\r
 #define SMBIOS_DATA_VALID_BIT_MASK        0x8\r
 ///\r
-/// Definition of Platform SMBIOS Device Error Info Record\r
+/// Definition of Platform SMBIOS Device Error Info Record.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER  SectionHeader;\r
@@ -864,7 +864,7 @@ typedef struct {
 } SAL_SMBIOS_DEVICE_ERROR_RECORD;\r
 \r
 ///\r
-/// GUID of Platform Specific Error Info\r
+/// GUID of Platform Specific Error Info.\r
 ///\r
 #define SAL_PLATFORM_ERROR_RECORD_INFO \\r
   { \\r
@@ -882,7 +882,7 @@ typedef struct {
 #define PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x40\r
 #define PLATFORM_OEM_DEVICE_PATH_VALID_BIT_MASK 0x80\r
 ///\r
-/// Definition of Platform Specific Error Info Record\r
+/// Definition of Platform Specific Error Info Record.\r
 ///\r
 typedef struct {\r
   SAL_SEC_HEADER  SectionHeader;\r
@@ -896,7 +896,7 @@ typedef struct {
 } SAL_PLATFORM_SPECIFIC_ERROR_RECORD;\r
 \r
 ///\r
-/// Union of all the possible SAL Error Record Types\r
+/// Union of all the possible SAL Error Record Types.\r
 ///\r
 typedef union {\r
   SAL_RECORD_HEADER                   *RecordHeader;\r
index 3799492368cfaf0a9a16bbd616c3d83445d768af..9768e9c253c77c53c9b0c6e876cf8b1c10e9de34 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   Industry Standard Definitions of SMBIOS Table Specification v2.6.1\r
 \r
-  Copyright (c) 2006 - 2010, Intel Corporation All rights\r
-  reserved. This program and the accompanying materials are\r
-  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
-\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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
 **/\r
 \r
@@ -23,8 +23,8 @@
 #define SMBIOS_HANDLE_RESERVED_BEGIN 0xFF00\r
 \r
 ///\r
-/// Reference SMBIOS 2.6, chapter 3.1.3\r
-/// Each text string is limited to 64 significant characters due to system MIF limitations\r
+/// Reference SMBIOS 2.6, chapter 3.1.3.\r
+/// Each text string is limited to 64 significant characters due to system MIF limitations.\r
 ///\r
 #define SMBIOS_STRING_MAX_LENGTH     64\r
 \r
@@ -42,7 +42,7 @@
 #define SMBIOS_TYPE_END_OF_TABLE     0x007F\r
 \r
 ///\r
-/// Smbios Table Entry Point Structure\r
+/// Smbios Table Entry Point Structure.\r
 ///\r
 #pragma pack(1)\r
 typedef struct {\r
@@ -63,7 +63,7 @@ typedef struct {
 } SMBIOS_TABLE_ENTRY_POINT;\r
 \r
 ///\r
-/// The Smbios structure header\r
+/// The Smbios structure header.\r
 ///\r
 typedef struct {\r
   UINT8   Type;\r
@@ -81,7 +81,7 @@ typedef UINT8 SMBIOS_TABLE_STRING;
 /// Defines which functions the BIOS supports. PCI, PCMCIA, Flash, etc. \r
 ///\r
 typedef struct {\r
-  UINT32  Reserved                          :2;  ///< Bits 0-1\r
+  UINT32  Reserved                          :2;  ///< Bits 0-1.\r
   UINT32  Unknown                           :1; \r
   UINT32  BiosCharacteristicsNotSupported   :1; \r
   UINT32  IsaIsSupported                    :1;  \r
@@ -117,7 +117,7 @@ typedef struct {
 } MISC_BIOS_CHARACTERISTICS;\r
 \r
 ///\r
-/// BIOS Characteristics Extension Byte 1 \r
+/// BIOS Characteristics Extension Byte 1 .\r
 /// This information, available for SMBIOS version 2.1 and later, appears at offset 12h \r
 /// within the BIOS Information  structure.\r
 ///\r
@@ -133,7 +133,7 @@ typedef struct {
 } MBCE_BIOS_RESERVED;\r
 \r
 ///\r
-/// BIOS Characteristics Extension Byte 2\r
+/// BIOS Characteristics Extension Byte 2.\r
 /// This information, available for SMBIOS version 2.3 and later, appears at offset 13h \r
 /// within the BIOS Information structure.\r
 ///\r
@@ -145,7 +145,7 @@ typedef struct {
 } MBCE_SYSTEM_RESERVED;\r
 \r
 ///\r
-/// BIOS Characteristics Extension Bytes\r
+/// BIOS Characteristics Extension Bytes.\r
 ///\r
 typedef struct {\r
   MBCE_BIOS_RESERVED    BiosReserved;\r
@@ -154,7 +154,7 @@ typedef struct {
 } MISC_BIOS_CHARACTERISTICS_EXTENSION;\r
 \r
 ///\r
-/// BIOS Information (Type 0)\r
+/// BIOS Information (Type 0).\r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE          Hdr;\r
@@ -172,7 +172,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE0;\r
 \r
 ///\r
-///  System Wake-up Type \r
+///  System Wake-up Type.\r
 ///\r
 typedef enum {  \r
   SystemWakeupTypeReserved         = 0x00,\r
@@ -187,7 +187,7 @@ typedef enum {
 } MISC_SYSTEM_WAKEUP_TYPE;\r
 \r
 ///\r
-/// System Information (Type 1)\r
+/// System Information (Type 1).\r
 /// \r
 /// The information in this structure defines attributes of the overall system and is \r
 /// intended to be associated with the Component ID group of the system's MIF.\r
@@ -201,13 +201,13 @@ typedef struct {
   SMBIOS_TABLE_STRING     Version;\r
   SMBIOS_TABLE_STRING     SerialNumber;\r
   GUID                    Uuid;\r
-  UINT8                   WakeUpType;           ///< enumeration value from MISC_SYSTEM_WAKEUP_TYPE\r
+  UINT8                   WakeUpType;           ///< The enumeration value from MISC_SYSTEM_WAKEUP_TYPE.\r
   SMBIOS_TABLE_STRING     SKUNumber;\r
   SMBIOS_TABLE_STRING     Family;\r
 } SMBIOS_TABLE_TYPE1;\r
 \r
 ///\r
-///  Base Board - Feature Flags \r
+///  Base Board - Feature Flags. \r
 ///\r
 typedef struct {\r
   UINT8  Motherboard           :1;\r
@@ -219,7 +219,7 @@ typedef struct {
 } BASE_BOARD_FEATURE_FLAGS;\r
 \r
 ///\r
-///  Base Board - Board Type\r
+///  Base Board - Board Type.\r
 ///\r
 typedef enum {  \r
   BaseBoardTypeUnknown                  = 0x1,\r
@@ -238,7 +238,7 @@ typedef enum {
 } BASE_BOARD_TYPE;\r
 \r
 ///\r
-/// Base Board (or Module) Information (Type 2)\r
+/// Base Board (or Module) Information (Type 2).\r
 ///\r
 /// The information in this structure defines attributes of a system baseboard - \r
 /// for example a motherboard, planar, or server blade or other standard system module.\r
@@ -253,7 +253,7 @@ typedef struct {
   BASE_BOARD_FEATURE_FLAGS  FeatureFlag;\r
   SMBIOS_TABLE_STRING       LocationInChassis;\r
   UINT16                    ChassisHandle;\r
-  UINT8                     BoardType;              ///< enumeration value from BASE_BOARD_TYPE\r
+  UINT8                     BoardType;              ///< The enumeration value from BASE_BOARD_TYPE.\r
   UINT8                     NumberOfContainedObjectHandles;\r
   UINT16                    ContainedObjectHandles[1];\r
 } SMBIOS_TABLE_TYPE2;\r
@@ -294,7 +294,7 @@ typedef enum {
 } MISC_CHASSIS_TYPE;\r
 \r
 ///\r
-/// System Enclosure or Chassis States \r
+/// System Enclosure or Chassis States .\r
 ///\r
 typedef enum {  \r
   ChassisStateOther           = 0x01,\r
@@ -306,7 +306,7 @@ typedef enum {
 } MISC_CHASSIS_STATE;\r
 \r
 ///\r
-/// System Enclosure or Chassis Security Status \r
+/// System Enclosure or Chassis Security Status.\r
 ///\r
 typedef enum {  \r
   ChassisSecurityStatusOther                          = 0x01,\r
@@ -327,7 +327,7 @@ typedef struct {
 \r
 \r
 ///\r
-/// System Enclosure or Chassis (Type 3)\r
+/// System Enclosure or Chassis (Type 3).\r
 ///\r
 /// The information in this structure defines attributes of the system's mechanical enclosure(s).  \r
 /// For example, if a system included a separate enclosure for its peripheral devices, \r
@@ -342,10 +342,10 @@ typedef struct {
   SMBIOS_TABLE_STRING         Version;\r
   SMBIOS_TABLE_STRING         SerialNumber;\r
   SMBIOS_TABLE_STRING         AssetTag;\r
-  UINT8                       BootupState;            ///< enumeration value from MISC_CHASSIS_STATE\r
-  UINT8                       PowerSupplyState;       ///< enumeration value from MISC_CHASSIS_STATE\r
-  UINT8                       ThermalState;           ///< enumeration value from MISC_CHASSIS_STATE\r
-  UINT8                       SecurityStatus;         ///< enumeration value from MISC_CHASSIS_SECURITY_STATE\r
+  UINT8                       BootupState;            ///< The enumeration value from MISC_CHASSIS_STATE.\r
+  UINT8                       PowerSupplyState;       ///< The enumeration value from MISC_CHASSIS_STATE.\r
+  UINT8                       ThermalState;           ///< The enumeration value from MISC_CHASSIS_STATE.\r
+  UINT8                       SecurityStatus;         ///< The enumeration value from MISC_CHASSIS_SECURITY_STATE.\r
   UINT8                       OemDefined[4];\r
   UINT8                       Height;\r
   UINT8                       NumberofPowerCords;\r
@@ -355,7 +355,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE3;\r
 \r
 ///\r
-/// Processor Information - Processor Type\r
+/// Processor Information - Processor Type.\r
 ///\r
 typedef enum {\r
   ProcessorOther   = 0x01,\r
@@ -367,7 +367,7 @@ typedef enum {
 } PROCESSOR_TYPE_DATA;\r
 \r
 ///\r
-/// Processor Information - Processor Family\r
+/// Processor Information - Processor Family.\r
 ///\r
 typedef enum {\r
   ProcessorFamilyOther                  = 0x01, \r
@@ -538,7 +538,7 @@ typedef enum {
 } PROCESSOR_FAMILY_DATA;\r
 \r
 ///\r
-/// Processor Information - Voltage \r
+/// Processor Information - Voltage. \r
 ///\r
 typedef struct {\r
   UINT8  ProcessorVoltageCapability5V        :1; \r
@@ -550,14 +550,14 @@ typedef struct {
 } PROCESSOR_VOLTAGE;\r
 \r
 ///\r
-/// Processor Information - Processor Upgrade \r
+/// Processor Information - Processor Upgrade.\r
 ///\r
 typedef enum {\r
   ProcessorUpgradeOther         = 0x01,\r
   ProcessorUpgradeUnknown       = 0x02,\r
   ProcessorUpgradeDaughterBoard = 0x03,\r
   ProcessorUpgradeZIFSocket     = 0x04,\r
-  ProcessorUpgradePiggyBack     = 0x05, ///< Replaceable\r
+  ProcessorUpgradePiggyBack     = 0x05, ///< Replaceable.\r
   ProcessorUpgradeNone          = 0x06,\r
   ProcessorUpgradeLIFSocket     = 0x07,\r
   ProcessorUpgradeSlot1         = 0x08,\r
@@ -566,7 +566,7 @@ typedef enum {
   ProcessorUpgradeSlotA         = 0x0B,\r
   ProcessorUpgradeSlotM         = 0x0C,\r
   ProcessorUpgradeSocket423     = 0x0D,\r
-  ProcessorUpgradeSocketA       = 0x0E, ///< Socket 462\r
+  ProcessorUpgradeSocketA       = 0x0E, ///< Socket 462.\r
   ProcessorUpgradeSocket478     = 0x0F,\r
   ProcessorUpgradeSocket754     = 0x10,\r
   ProcessorUpgradeSocket940     = 0x11,\r
@@ -634,19 +634,19 @@ typedef struct {
 } PROCESSOR_ID_DATA;\r
 \r
 ///\r
-/// Processor Information (Type 4)\r
+/// Processor Information (Type 4).\r
 ///\r
 /// The information in this structure defines the attributes of a single processor; \r
 /// a separate structure instance is provided for each system processor socket/slot. \r
 /// For example, a system with an IntelDX2 processor would have a single \r
-/// structure instance while a system with an IntelSX2 processor would have a structure\r
-/// to describe the main CPU and a second structure to describe the 80487 co-processor. \r
+/// structure instance, while a system with an IntelSX2 processor would have a structure\r
+/// to describe the main CPU, and a second structure to describe the 80487 co-processor. \r
 ///\r
 typedef struct { \r
   SMBIOS_STRUCTURE      Hdr;\r
   SMBIOS_TABLE_STRING   Socket;\r
-  UINT8                 ProcessorType;          ///< enumeration value from PROCESSOR_TYPE_DATA\r
-  UINT8                 ProcessorFamily;        ///< enumeration value from PROCESSOR_FAMILY_DATA\r
+  UINT8                 ProcessorType;          ///< The enumeration value from PROCESSOR_TYPE_DATA.\r
+  UINT8                 ProcessorFamily;        ///< The enumeration value from PROCESSOR_FAMILY_DATA.\r
   SMBIOS_TABLE_STRING   ProcessorManufacture;\r
   PROCESSOR_ID_DATA     ProcessorId;\r
   SMBIOS_TABLE_STRING   ProcessorVersion;\r
@@ -655,7 +655,7 @@ typedef struct {
   UINT16                MaxSpeed;\r
   UINT16                CurrentSpeed;\r
   UINT8                 Status;\r
-  UINT8                 ProcessorUpgrade;      ///< enumeration value from PROCESSOR_UPGRADE\r
+  UINT8                 ProcessorUpgrade;      ///< The enumeration value from PROCESSOR_UPGRADE.\r
   UINT16                L1CacheHandle;\r
   UINT16                L2CacheHandle;\r
   UINT16                L3CacheHandle;\r
@@ -676,7 +676,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE4;\r
 \r
 ///\r
-/// Memory Controller Error Detecting Method \r
+/// Memory Controller Error Detecting Method.\r
 ///\r
 typedef enum {  \r
   ErrorDetectingMethodOther   = 0x01,\r
@@ -690,7 +690,7 @@ typedef enum {
 } MEMORY_ERROR_DETECT_METHOD;\r
 \r
 ///\r
-/// Memory Controller Error Correcting Capability\r
+/// Memory Controller Error Correcting Capability.\r
 ///\r
 typedef struct {\r
   UINT8  Other                 :1;\r
@@ -703,7 +703,7 @@ typedef struct {
 } MEMORY_ERROR_CORRECT_CAPABILITY;\r
 \r
 ///\r
-/// Memory Controller Information - Interleave Support\r
+/// Memory Controller Information - Interleave Support.\r
 ///\r
 typedef enum {  \r
   MemoryInterleaveOther      = 0x01,\r
@@ -716,7 +716,7 @@ typedef enum {
 } MEMORY_SUPPORT_INTERLEAVE_TYPE;\r
 \r
 ///\r
-/// Memory Controller Information - Memory Speeds\r
+/// Memory Controller Information - Memory Speeds.\r
 ///\r
 typedef struct {\r
   UINT16     Other    :1;\r
@@ -728,23 +728,23 @@ typedef struct {
 } MEMORY_SPEED_TYPE;\r
 \r
 ///\r
-/// Memory Controller Information (Type 5, Obsolete)\r
+/// Memory Controller Information (Type 5, Obsolete).\r
 ///\r
 /// The information in this structure defines the attributes of the system's memory controller(s) \r
 /// and the supported attributes of any memory-modules present in the sockets controlled by \r
 /// this controller. \r
 /// Note: This structure, and its companion Memory Module Information (Type 6, Obsolete), \r
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)\r
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)\r
 /// and Memory Device (Type 17) structures should be used instead.  BIOS providers might\r
 /// choose to implement both memory description types to allow existing DMI browsers\r
 /// to properly display the system's memory attributes.\r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE                Hdr;\r
-  UINT8                           ErrDetectMethod;            ///< enumeration value from MEMORY_ERROR_DETECT_METHOD\r
+  UINT8                           ErrDetectMethod;            ///< The enumeration value from MEMORY_ERROR_DETECT_METHOD.\r
   MEMORY_ERROR_CORRECT_CAPABILITY ErrCorrectCapability;\r
-  UINT8                           SupportInterleave;          ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE\r
-  UINT8                           CurrentInterleave;          ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE      \r
+  UINT8                           SupportInterleave;          ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE.\r
+  UINT8                           CurrentInterleave;          ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE .     \r
   UINT8                           MaxMemoryModuleSize;\r
   MEMORY_SPEED_TYPE               SupportSpeed;\r
   UINT16                          SupportMemoryType;\r
@@ -772,7 +772,7 @@ typedef struct {
 } MEMORY_CURRENT_TYPE;\r
 \r
 ///\r
-/// Memory Module Information - Memory Size\r
+/// Memory Module Information - Memory Size.\r
 ///\r
 typedef struct {\r
   UINT8   InstalledOrEnabledSize  :7; ///< Size (n), where 2**n is the size in MB.\r
@@ -787,7 +787,7 @@ typedef struct {
 /// of each system memory module.  The supported attributes of each module are described \r
 /// by the "owning" Memory Controller Information structure.  \r
 /// Note:  This structure, and its companion Memory Controller Information (Type 5, Obsolete), \r
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)\r
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)\r
 /// and Memory Device (Type 17) structures should be used instead.\r
 ///\r
 typedef struct {\r
@@ -802,7 +802,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE6;\r
 \r
 ///\r
-/// Cache Information - SRAM Type\r
+/// Cache Information - SRAM Type.\r
 ///\r
 typedef struct {\r
   UINT16  Other         :1;\r
@@ -816,7 +816,7 @@ typedef struct {
 } CACHE_SRAM_TYPE_DATA;\r
 \r
 ///\r
-/// Cache Information - Error Correction Type \r
+/// Cache Information - Error Correction Type.\r
 ///\r
 typedef enum {\r
   CacheErrorOther     = 0x01,\r
@@ -828,7 +828,7 @@ typedef enum {
 } CACHE_ERROR_TYPE_DATA;\r
 \r
 ///\r
-/// Cache Information - System Cache Type \r
+/// Cache Information - System Cache Type. \r
 ///\r
 typedef enum {\r
   CacheTypeOther       = 0x01,\r
@@ -839,7 +839,7 @@ typedef enum {
 } CACHE_TYPE_DATA;\r
 \r
 ///\r
-/// Cache Information - Associativity \r
+/// Cache Information - Associativity. \r
 ///\r
 typedef enum {\r
   CacheAssociativityOther        = 0x01,\r
@@ -858,12 +858,12 @@ typedef enum {
 } CACHE_ASSOCIATIVITY_DATA;\r
 \r
 ///\r
-/// Cache Information (Type 7)\r
+/// Cache Information (Type 7).\r
 ///\r
-/// he information in this structure defines the attributes of CPU cache device in the system. \r
+/// The information in this structure defines the attributes of CPU cache device in the system. \r
 /// One structure is specified for each such device, whether the device is internal to\r
 /// or external to the CPU module.  Cache modules can be associated with a processor structure\r
-/// in one or two ways depending on the SMBIOS version.\r
+/// in one or two ways, depending on the SMBIOS version.\r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE          Hdr;\r
@@ -874,13 +874,13 @@ typedef struct {
   CACHE_SRAM_TYPE_DATA      SupportedSRAMType;\r
   CACHE_SRAM_TYPE_DATA      CurrentSRAMType;\r
   UINT8                     CacheSpeed;\r
-  UINT8                     ErrorCorrectionType;            ///< enumeration value from CACHE_ERROR_TYPE_DATA\r
-  UINT8                     SystemCacheType;                ///< enumeration value from CACHE_TYPE_DATA\r
-  UINT8                     Associativity;                  ///< enumeration value from CACHE_ASSOCIATIVITY_DATA\r
+  UINT8                     ErrorCorrectionType;            ///< The enumeration value from CACHE_ERROR_TYPE_DATA.\r
+  UINT8                     SystemCacheType;                ///< The enumeration value from CACHE_TYPE_DATA.\r
+  UINT8                     Associativity;                  ///< The enumeration value from CACHE_ASSOCIATIVITY_DATA.\r
 } SMBIOS_TABLE_TYPE7;\r
 \r
 ///\r
-/// Port Connector Information - Connector Types \r
+/// Port Connector Information - Connector Types. \r
 ///\r
 typedef enum {\r
   PortConnectorTypeNone                   = 0x00,\r
@@ -967,7 +967,7 @@ typedef enum {
 } MISC_PORT_TYPE;\r
 \r
 ///\r
-/// Port Connector Information (Type 8)\r
+/// Port Connector Information (Type 8).\r
 ///\r
 /// The information in this structure defines the attributes of a system port connector, \r
 /// e.g. parallel, serial, keyboard, or mouse ports.  The port's type and connector information \r
@@ -976,10 +976,10 @@ typedef enum {
 typedef struct {\r
   SMBIOS_STRUCTURE          Hdr;\r
   SMBIOS_TABLE_STRING       InternalReferenceDesignator;\r
-  UINT8                     InternalConnectorType;          ///< enumeration value from MISC_PORT_CONNECTOR_TYPE\r
+  UINT8                     InternalConnectorType;          ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.\r
   SMBIOS_TABLE_STRING       ExternalReferenceDesignator;\r
-  UINT8                     ExternalConnectorType;          ///< enumeration value from MISC_PORT_CONNECTOR_TYPE\r
-  UINT8                     PortType;                       ///< enumeration value from MISC_PORT_TYPE\r
+  UINT8                     ExternalConnectorType;          ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.\r
+  UINT8                     PortType;                       ///< The enumeration value from MISC_PORT_TYPE.\r
 } SMBIOS_TABLE_TYPE8;\r
 \r
 ///\r
@@ -1025,7 +1025,7 @@ typedef enum {
 } MISC_SLOT_TYPE;\r
 \r
 ///\r
-/// System Slots - Slot Data Bus Width\r
+/// System Slots - Slot Data Bus Width.\r
 ///\r
 typedef enum {\r
   SlotDataBusWidthOther      = 0x01,\r
@@ -1045,7 +1045,7 @@ typedef enum {
 } MISC_SLOT_DATA_BUS_WIDTH;\r
 \r
 ///\r
-/// System Slots - Current Usage\r
+/// System Slots - Current Usage.\r
 ///\r
 typedef enum {\r
   SlotUsageOther     = 0x01,\r
@@ -1055,7 +1055,7 @@ typedef enum {
 } MISC_SLOT_USAGE;\r
 \r
 ///\r
-/// System Slots - Slot Length \r
+/// System Slots - Slot Length. \r
 ///\r
 typedef enum {\r
   SlotLengthOther   = 0x01,\r
@@ -1065,7 +1065,7 @@ typedef enum {
 } MISC_SLOT_LENGTH;\r
 \r
 ///\r
-/// System Slots - Slot Characteristics 1 \r
+/// System Slots - Slot Characteristics 1. \r
 ///\r
 typedef struct {\r
   UINT8  CharacteristicsUnknown  :1;\r
@@ -1078,7 +1078,7 @@ typedef struct {
   UINT8  ModemRingResumeSupported:1;\r
 } MISC_SLOT_CHARACTERISTICS1;\r
 ///\r
-/// System Slots - Slot Characteristics 2  \r
+/// System Slots - Slot Characteristics 2.  \r
 ///\r
 typedef struct {\r
   UINT8  PmeSignalSupported      :1;\r
@@ -1097,10 +1097,10 @@ typedef struct {
 typedef struct {\r
   SMBIOS_STRUCTURE            Hdr;\r
   SMBIOS_TABLE_STRING         SlotDesignation;\r
-  UINT8                       SlotType;                 ///< enumeration value from MISC_SLOT_TYPE\r
-  UINT8                       SlotDataBusWidth;         ///< enumeration value from MISC_SLOT_DATA_BUS_WIDTH\r
-  UINT8                       CurrentUsage;             ///< enumeration value from MISC_SLOT_USAGE\r
-  UINT8                       SlotLength;               ///< enumeration value from MISC_SLOT_LENGTH\r
+  UINT8                       SlotType;                 ///< The enumeration value from MISC_SLOT_TYPE.\r
+  UINT8                       SlotDataBusWidth;         ///< The enumeration value from MISC_SLOT_DATA_BUS_WIDTH.\r
+  UINT8                       CurrentUsage;             ///< The enumeration value from MISC_SLOT_USAGE.\r
+  UINT8                       SlotLength;               ///< The enumeration value from MISC_SLOT_LENGTH.\r
   UINT16                      SlotID;\r
   MISC_SLOT_CHARACTERISTICS1  SlotCharacteristics1;\r
   MISC_SLOT_CHARACTERISTICS2  SlotCharacteristics2;\r
@@ -1113,7 +1113,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE9;\r
 \r
 ///\r
-/// On Board Devices Information - Device Types \r
+/// On Board Devices Information - Device Types. \r
 ///\r
 typedef enum {\r
   OnBoardDeviceTypeOther          = 0x01,\r
@@ -1129,13 +1129,13 @@ typedef enum {
 /// Device Item Entry\r
 ///\r
 typedef struct {\r
-  UINT8                     DeviceType;             ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE\r
-                                                    ///< Bit 7     - 1 : device enabled, 0 : device disabled\r
+  UINT8                     DeviceType;             ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE.\r
+                                                    ///< Bit 7     - 1 : device enabled, 0 : device disabled.\r
   SMBIOS_TABLE_STRING       DescriptionString;\r
 } DEVICE_STRUCT;\r
 \r
 ///\r
-/// On Board Devices Information (Type 10, obsolete)\r
+/// On Board Devices Information (Type 10, obsolete).\r
 ///\r
 /// Note: This structure is obsolete starting with version 2.6 specification; the Onboard Devices Extended \r
 /// Information (Type 41) structure should be used instead . BIOS providers can choose to implement both \r
@@ -1150,7 +1150,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE10;\r
 \r
 ///\r
-/// OEM Strings (Type 11)\r
+/// OEM Strings (Type 11).\r
 /// This structure contains free form strings defined by the OEM. Examples of this are: \r
 /// Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc. \r
 ///\r
@@ -1160,7 +1160,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE11;\r
 \r
 ///\r
-/// System Configuration Options (Type 12)\r
+/// System Configuration Options (Type 12).\r
 ///\r
 /// This structure contains information required to configure the base board's Jumpers and Switches. \r
 ///\r
@@ -1171,7 +1171,7 @@ typedef struct {
 \r
 \r
 ///\r
-/// BIOS Language Information (Type 13)\r
+/// BIOS Language Information (Type 13).\r
 ///\r
 /// The information in this structure defines the installable language attributes of the BIOS.  \r
 /// \r
@@ -1184,7 +1184,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE13;\r
 \r
 ///\r
-/// System Event Log - Event Log Types \r
+/// System Event Log - Event Log Types.\r
 /// \r
 typedef enum {\r
   EventLogTypeReserved         = 0x00,\r
@@ -1216,7 +1216,7 @@ typedef enum {
 } EVENT_LOG_TYPE_DATA;\r
 \r
 ///\r
-/// System Event Log - Variable Data Format Types \r
+/// System Event Log - Variable Data Format Types. \r
 /// \r
 typedef enum {\r
   EventLogVariableNone                        = 0x00,\r
@@ -1242,12 +1242,12 @@ typedef struct {
 /// Event Log Type Descriptors\r
 ///\r
 typedef struct {\r
-  UINT8                 LogType;                    ///< enumeration value from EVENT_LOG_TYPE_DATA\r
+  UINT8                 LogType;                    ///< The enumeration value from EVENT_LOG_TYPE_DATA.\r
   UINT8                 DataFormatType;\r
 } EVENT_LOG_TYPE;\r
 \r
 ///\r
-/// Group Associations (Type 14)\r
+/// Group Associations (Type 14).\r
 ///\r
 /// The Group Associations structure is provided for OEMs who want to specify \r
 /// the arrangement or hierarchy of certain components (including other Group Associations) \r
@@ -1260,7 +1260,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE14;\r
 \r
 ///\r
-/// System Event Log (Type 15)\r
+/// System Event Log (Type 15).\r
 ///\r
 /// The presence of this structure within the SMBIOS data returned for a system indicates \r
 /// that the system supports an event log.  An event log is a fixed-length area within a \r
@@ -1283,7 +1283,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE15;\r
 \r
 ///\r
-/// Physical Memory Array - Location\r
+/// Physical Memory Array - Location.\r
 ///\r
 typedef enum {\r
   MemoryArrayLocationOther                 = 0x01,\r
@@ -1303,7 +1303,7 @@ typedef enum {
 } MEMORY_ARRAY_LOCATION;\r
 \r
 ///\r
-/// Physical Memory Array - Use\r
+/// Physical Memory Array - Use.\r
 ///\r
 typedef enum {\r
   MemoryArrayUseOther                      = 0x01,\r
@@ -1316,7 +1316,7 @@ typedef enum {
 } MEMORY_ARRAY_USE;\r
 \r
 ///\r
-/// Physical Memory Array - Error Correction Types \r
+/// Physical Memory Array - Error Correction Types. \r
 ///\r
 typedef enum {\r
   MemoryErrorCorrectionOther               = 0x01,\r
@@ -1329,23 +1329,23 @@ typedef enum {
 } MEMORY_ERROR_CORRECTION;\r
 \r
 ///\r
-/// Physical Memory Array (Type 16)\r
+/// Physical Memory Array (Type 16).\r
 ///\r
 /// This structure describes a collection of memory devices that operate \r
 /// together to form a memory address space. \r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE          Hdr;\r
-  UINT8                     Location;                       ///< enumeration value from MEMORY_ARRAY_LOCATION\r
-  UINT8                     Use;                            ///< enumeration value from MEMORY_ARRAY_USE\r
-  UINT8                     MemoryErrorCorrection;          ///< enumeration value from MEMORY_ERROR_CORRECTION\r
+  UINT8                     Location;                       ///< The enumeration value from MEMORY_ARRAY_LOCATION.\r
+  UINT8                     Use;                            ///< The enumeration value from MEMORY_ARRAY_USE.\r
+  UINT8                     MemoryErrorCorrection;          ///< The enumeration value from MEMORY_ERROR_CORRECTION.\r
   UINT32                    MaximumCapacity;\r
   UINT16                    MemoryErrorInformationHandle;\r
   UINT16                    NumberOfMemoryDevices;\r
 } SMBIOS_TABLE_TYPE16;\r
 \r
 ///\r
-/// Memory Device - Form Factor\r
+/// Memory Device - Form Factor.\r
 ///\r
 typedef enum {\r
   MemoryFormFactorOther                    = 0x01,\r
@@ -1411,12 +1411,12 @@ typedef struct {
 } MEMORY_DEVICE_TYPE_DETAIL;\r
 \r
 ///\r
-/// Memory Device (Type 17)\r
+/// Memory Device (Type 17).\r
 ///\r
 /// This structure describes a single memory device that is part of \r
 /// a larger Physical Memory Array (Type 16).\r
 /// Note:  If a system includes memory-device sockets, the SMBIOS implementation \r
-/// includes a Memory Device structure instance for each slot whether or not the \r
+/// includes a Memory Device structure instance for each slot, whether or not the \r
 /// socket is currently populated.\r
 ///\r
 typedef struct {\r
@@ -1426,11 +1426,11 @@ typedef struct {
   UINT16                    TotalWidth;\r
   UINT16                    DataWidth;\r
   UINT16                    Size;\r
-  UINT8                     FormFactor;                     ///< enumeration value from MEMORY_FORM_FACTOR\r
+  UINT8                     FormFactor;                     ///< The enumeration value from MEMORY_FORM_FACTOR.\r
   UINT8                     DeviceSet;\r
   SMBIOS_TABLE_STRING       DeviceLocator;\r
   SMBIOS_TABLE_STRING       BankLocator;\r
-  UINT8                     MemoryType;                     ///< enumeration value from MEMORY_DEVICE_TYPE\r
+  UINT8                     MemoryType;                     ///< The enumeration value from MEMORY_DEVICE_TYPE.\r
   MEMORY_DEVICE_TYPE_DETAIL TypeDetail;\r
   UINT16                    Speed;\r
   SMBIOS_TABLE_STRING       Manufacturer;\r
@@ -1444,7 +1444,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE17;\r
 \r
 ///\r
-/// 32-bit Memory Error Information - Error Type \r
+/// 32-bit Memory Error Information - Error Type. \r
 ///\r
 typedef enum {  \r
   MemoryErrorOther             = 0x01,\r
@@ -1464,7 +1464,7 @@ typedef enum {
 } MEMORY_ERROR_TYPE;\r
 \r
 ///\r
-/// 32-bit Memory Error Information - Error Granularity \r
+/// 32-bit Memory Error Information - Error Granularity. \r
 ///\r
 typedef enum {  \r
   MemoryGranularityOther               = 0x01,\r
@@ -1474,7 +1474,7 @@ typedef enum {
 } MEMORY_ERROR_GRANULARITY;\r
 \r
 ///\r
-/// 32-bit Memory Error Information - Error Operation \r
+/// 32-bit Memory Error Information - Error Operation. \r
 ///\r
 typedef enum {  \r
   MemoryErrorOperationOther            = 0x01,\r
@@ -1485,16 +1485,16 @@ typedef enum {
 } MEMORY_ERROR_OPERATION;\r
 \r
 ///\r
-/// 32-bit Memory Error Information (Type 18)\r
+/// 32-bit Memory Error Information (Type 18).\r
 /// \r
 /// This structure identifies the specifics of an error that might be detected \r
 /// within a Physical Memory Array.\r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE          Hdr;\r
-  UINT8                     ErrorType;                  ///< enumeration value from MEMORY_ERROR_TYPE\r
-  UINT8                     ErrorGranularity;           ///< enumeration value from MEMORY_ERROR_GRANULARITY\r
-  UINT8                     ErrorOperation;             ///< enumeration value from MEMORY_ERROR_OPERATION\r
+  UINT8                     ErrorType;                  ///< The enumeration value from MEMORY_ERROR_TYPE.\r
+  UINT8                     ErrorGranularity;           ///< The enumeration value from MEMORY_ERROR_GRANULARITY.\r
+  UINT8                     ErrorOperation;             ///< The enumeration value from MEMORY_ERROR_OPERATION.\r
   UINT32                    VendorSyndrome;\r
   UINT32                    MemoryArrayErrorAddress;\r
   UINT32                    DeviceErrorAddress;\r
@@ -1502,7 +1502,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE18;\r
 \r
 ///\r
-/// Memory Array Mapped Address (Type 19)\r
+/// Memory Array Mapped Address (Type 19).\r
 ///\r
 /// This structure provides the address mapping for a Physical Memory Array.  \r
 /// One structure is present for each contiguous address range described.\r
@@ -1516,7 +1516,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE19;\r
 \r
 ///\r
-/// Memory Device Mapped Address (Type 20)\r
+/// Memory Device Mapped Address (Type 20).\r
 ///\r
 /// This structure maps memory address space usually to a device-level granularity.  \r
 /// One structure is present for each contiguous address range described. \r
@@ -1548,7 +1548,7 @@ typedef enum {
 } BUILTIN_POINTING_DEVICE_TYPE;\r
 \r
 ///\r
-/// Built-in Pointing Device - Interface\r
+/// Built-in Pointing Device - Interface.\r
 ///\r
 typedef enum {\r
   PointingDeviceInterfaceOther              = 0x01,\r
@@ -1565,16 +1565,16 @@ typedef enum {
 } BUILTIN_POINTING_DEVICE_INTERFACE;\r
 \r
 ///\r
-/// Built-in Pointing Device (Type 21)\r
+/// Built-in Pointing Device (Type 21).\r
 ///\r
 /// This structure describes the attributes of the built-in pointing device for the \r
-/// system - the presence of this structure does not imply that the built-in\r
+/// system. The presence of this structure does not imply that the built-in\r
 /// pointing device is active for the system's use! \r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE                  Hdr;\r
-  UINT8                             Type;                   ///< enumeration value from BUILTIN_POINTING_DEVICE_TYPE\r
-  UINT8                             Interface;              ///< enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE\r
+  UINT8                             Type;                   ///< The enumeration value from BUILTIN_POINTING_DEVICE_TYPE.\r
+  UINT8                             Interface;              ///< The enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE.\r
   UINT8                             NumberOfButtons;\r
 } SMBIOS_TABLE_TYPE21;\r
 \r
@@ -1593,7 +1593,7 @@ typedef enum {
 } PORTABLE_BATTERY_DEVICE_CHEMISTRY;\r
 \r
 ///\r
-/// Portable Battery (Type 22)\r
+/// Portable Battery (Type 22).\r
 ///\r
 /// This structure describes the attributes of the portable battery(s) for the system.  \r
 /// The structure contains the static attributes for the group.  Each structure describes \r
@@ -1606,7 +1606,7 @@ typedef struct {
   SMBIOS_TABLE_STRING               ManufactureDate;\r
   SMBIOS_TABLE_STRING               SerialNumber;\r
   SMBIOS_TABLE_STRING               DeviceName;\r
-  UINT8                             DeviceChemistry;              ///< enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY\r
+  UINT8                             DeviceChemistry;              ///< The enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY.\r
   UINT16                            DeviceCapacity;\r
   UINT16                            DesignVoltage;\r
   SMBIOS_TABLE_STRING               SBDSVersionNumber;\r
@@ -1637,7 +1637,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE23;\r
 \r
 ///\r
-/// Hardware Security (Type 24)\r
+/// Hardware Security (Type 24).\r
 ///\r
 /// This structure describes the system-wide hardware security settings. \r
 ///\r
@@ -1647,7 +1647,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE24;\r
 \r
 ///\r
-/// System Power Controls (Type 25)\r
+/// System Power Controls (Type 25).\r
 ///\r
 /// This structure describes the attributes for controlling the main power supply to the system. \r
 /// Software that interprets this structure uses the month, day, hour, minute, and second values \r
@@ -1664,7 +1664,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE25;\r
 \r
 ///\r
-/// Voltage Probe - Location and Status\r
+/// Voltage Probe - Location and Status.\r
 ///\r
 typedef struct {\r
   UINT8 VoltageProbeSite      :5;\r
@@ -1691,7 +1691,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE26;\r
 \r
 ///\r
-/// Cooling Device - Device Type and Status\r
+/// Cooling Device - Device Type and Status.\r
 ///\r
 typedef struct {\r
   UINT8 CoolingDevice       :5;\r
@@ -1714,7 +1714,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE27;\r
 \r
 ///\r
-/// Temperature Probe - Location and Status\r
+/// Temperature Probe - Location and Status.\r
 ///\r
 typedef struct {\r
   UINT8 TemperatureProbeSite   :5;\r
@@ -1722,7 +1722,7 @@ typedef struct {
 } MISC_TEMPERATURE_PROBE_LOCATION;\r
 \r
 ///\r
-/// Temperature Probe (Type 28)\r
+/// Temperature Probe (Type 28).\r
 ///\r
 /// This structure describes the attributes for a temperature probe in the system.  \r
 /// Each structure describes a single temperature probe. \r
@@ -1741,7 +1741,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE28;\r
 \r
 ///\r
-/// Electrical Current Probe - Location and Status\r
+/// Electrical Current Probe - Location and Status.\r
 ///\r
 typedef struct {\r
   UINT8 ElectricalCurrentProbeSite   :5;\r
@@ -1749,7 +1749,7 @@ typedef struct {
 } MISC_ELECTRICAL_CURRENT_PROBE_LOCATION;\r
 \r
 ///\r
-/// Electrical Current Probe (Type 29)\r
+/// Electrical Current Probe (Type 29).\r
 ///\r
 /// This structure describes the attributes for an electrical current probe in the system.\r
 /// Each structure describes a single electrical current probe. \r
@@ -1768,7 +1768,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE29;\r
 \r
 ///\r
-/// Out-of-Band Remote Access (Type 30)\r
+/// Out-of-Band Remote Access (Type 30).\r
 ///\r
 /// This structure describes the attributes and policy settings of a hardware facility \r
 /// that may be used to gain remote access to a hardware system when the operating system \r
@@ -1781,7 +1781,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE30;\r
 \r
 ///\r
-/// Boot Integrity Services (BIS) Entry Point (Type 31)\r
+/// Boot Integrity Services (BIS) Entry Point (Type 31).\r
 ///\r
 /// Structure type 31 (decimal) is reserved for use by the Boot Integrity Services (BIS). \r
 /// \r
@@ -1797,7 +1797,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE31;\r
 \r
 ///\r
-/// System Boot Information - System Boot Status\r
+/// System Boot Information - System Boot Status.\r
 ///\r
 typedef enum {\r
   BootInformationStatusNoError                  = 0x00,\r
@@ -1815,7 +1815,7 @@ typedef enum {
 } MISC_BOOT_INFORMATION_STATUS_DATA_TYPE;\r
 \r
 ///\r
-/// System Boot Information (Type 32)\r
+/// System Boot Information (Type 32).\r
 ///\r
 /// The client system firmware, e.g. BIOS, communicates the System Boot Status to the \r
 /// client's Pre-boot Execution Environment (PXE) boot image or OS-present management \r
@@ -1828,20 +1828,20 @@ typedef enum {
 typedef struct {\r
   SMBIOS_STRUCTURE                        Hdr;\r
   UINT8                                   Reserved[6];\r
-  UINT8                                   BootStatus;     ///< enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE\r
+  UINT8                                   BootStatus;     ///< The enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE.\r
 } SMBIOS_TABLE_TYPE32;\r
 \r
 ///\r
-/// 64-bit Memory Error Information (Type 33)\r
+/// 64-bit Memory Error Information (Type 33).\r
 ///\r
 /// This structure describes an error within a Physical Memory Array, \r
 /// when the error address is above 4G (0xFFFFFFFF).\r
 ///    \r
 typedef struct {\r
   SMBIOS_STRUCTURE          Hdr;\r
-  UINT8                     ErrorType;                    ///< enumeration value from MEMORY_ERROR_TYPE\r
-  UINT8                     ErrorGranularity;             ///< enumeration value from MEMORY_ERROR_GRANULARITY\r
-  UINT8                     ErrorOperation;               ///< enumeration value from MEMORY_ERROR_OPERATION\r
+  UINT8                     ErrorType;                    ///< The enumeration value from MEMORY_ERROR_TYPE.\r
+  UINT8                     ErrorGranularity;             ///< The enumeration value from MEMORY_ERROR_GRANULARITY.\r
+  UINT8                     ErrorOperation;               ///< The enumeration value from MEMORY_ERROR_OPERATION.\r
   UINT32                    VendorSyndrome;\r
   UINT64                    MemoryArrayErrorAddress;\r
   UINT64                    DeviceErrorAddress;\r
@@ -1849,7 +1849,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE33;\r
 \r
 ///\r
-/// Management Device -  Type \r
+/// Management Device -  Type. \r
 ///\r
 typedef enum {\r
   ManagementDeviceTypeOther      = 0x01,\r
@@ -1868,7 +1868,7 @@ typedef enum {
 } MISC_MANAGEMENT_DEVICE_TYPE;\r
 \r
 ///\r
-/// Management Device -  Address Type \r
+/// Management Device -  Address Type. \r
 ///\r
 typedef enum {\r
   ManagementDeviceAddressTypeOther   = 0x01,\r
@@ -1879,7 +1879,7 @@ typedef enum {
 } MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE;\r
 \r
 ///\r
-/// Management Device (Type 34)\r
+/// Management Device (Type 34).\r
 ///\r
 /// The information in this structure defines the attributes of a Management Device.  \r
 /// A Management Device might control one or more fans or voltage, current, or temperature\r
@@ -1888,9 +1888,9 @@ typedef enum {
 typedef struct {\r
   SMBIOS_STRUCTURE                      Hdr;\r
   SMBIOS_TABLE_STRING                   Description;\r
-  UINT8                                 Type;                     ///< enumeration value from MISC_MANAGEMENT_DEVICE_TYPE\r
+  UINT8                                 Type;                     ///< The enumeration value from MISC_MANAGEMENT_DEVICE_TYPE.\r
   UINT32                                Address;\r
-  UINT8                                 AddressType;              ///< enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE\r
+  UINT8                                 AddressType;              ///< The enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE.\r
 } SMBIOS_TABLE_TYPE34;\r
 \r
 ///\r
@@ -1908,7 +1908,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE35;\r
 \r
 ///\r
-/// Management Device Threshold Data (Type 36)\r
+/// Management Device Threshold Data (Type 36).\r
 ///\r
 /// The information in this structure defines threshold information for \r
 /// a component (probe or cooling-unit) contained within a Management Device.  \r
@@ -1924,7 +1924,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE36;\r
 \r
 ///\r
-/// Memory Channel Entry\r
+/// Memory Channel Entry.\r
 ///\r
 typedef struct {\r
   UINT8                 DeviceLoad;\r
@@ -1932,7 +1932,7 @@ typedef struct {
 } MEMORY_DEVICE;\r
 \r
 ///\r
-/// Memory Channel - Channel Type\r
+/// Memory Channel - Channel Type.\r
 ///\r
 typedef enum {\r
   MemoryChannelTypeOther       = 0x01,\r
@@ -1945,8 +1945,8 @@ typedef enum {
 /// Memory Channel (Type 37)\r
 ///\r
 /// The information in this structure provides the correlation between a Memory Channel\r
-/// and its associated Memory Devices.  Each device presents one or more loads to the channel; \r
-/// the sum of all device loads cannot exceed the channel's defined maximum.\r
+/// and its associated Memory Devices.  Each device presents one or more loads to the channel. \r
+/// The sum of all device loads cannot exceed the channel's defined maximum.\r
 ///\r
 typedef struct {\r
   SMBIOS_STRUCTURE      Hdr;\r
@@ -1961,21 +1961,21 @@ typedef struct {
 ///\r
 typedef enum {\r
   IPMIDeviceInfoInterfaceTypeUnknown       = 0x00,\r
-  IPMIDeviceInfoInterfaceTypeKCS           = 0x01, ///< Keyboard Controller Style\r
-  IPMIDeviceInfoInterfaceTypeSMIC          = 0x02, ///< Server Management Interface Chip\r
-  IPMIDeviceInfoInterfaceTypeBT            = 0x03, ///< Block Transfer\r
+  IPMIDeviceInfoInterfaceTypeKCS           = 0x01, ///< The Keyboard Controller Style.\r
+  IPMIDeviceInfoInterfaceTypeSMIC          = 0x02, ///< The Server Management Interface Chip.\r
+  IPMIDeviceInfoInterfaceTypeBT            = 0x03, ///< The Block Transfer\r
   IPMIDeviceInfoInterfaceTypeReserved      = 0x04\r
 } BMC_INTERFACE_TYPE;\r
 \r
 ///\r
-/// IPMI Device Information (Type 38)\r
+/// IPMI Device Information (Type 38).\r
 ///\r
 /// The information in this structure defines the attributes of an \r
 /// Intelligent Platform Management Interface (IPMI) Baseboard Management Controller (BMC).\r
 /// \r
 typedef struct {\r
   SMBIOS_STRUCTURE      Hdr;\r
-  UINT8                 InterfaceType;              ///< enumeration value from BMC_INTERFACE_TYPE\r
+  UINT8                 InterfaceType;              ///< The enumeration value from BMC_INTERFACE_TYPE.\r
   UINT8                 IPMISpecificationRevision;\r
   UINT8                 I2CSlaveAddress;\r
   UINT8                 NVStorageDeviceAddress;\r
@@ -1985,7 +1985,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE38;\r
 \r
 ///\r
-/// System Power Supply - Power Supply Characteristics\r
+/// System Power Supply - Power Supply Characteristics.\r
 ///\r
 typedef struct {\r
   UINT16                        PowerSupplyHotReplaceable:1;\r
@@ -1998,7 +1998,7 @@ typedef struct {
 } SYS_POWER_SUPPLY_CHARACTERISTICS;\r
 \r
 ///\r
-/// System Power Supply (Type 39)\r
+/// System Power Supply (Type 39).\r
 ///\r
 /// This structure identifies attributes of a system power supply.  One instance\r
 /// of this record is present for each possible power supply in a system.  \r
@@ -2021,7 +2021,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE39;\r
 \r
 ///\r
-/// Additional Information Entry Format \r
+/// Additional Information Entry Format. \r
 ///\r
 typedef struct {                       \r
   UINT8                   EntryLength; \r
@@ -2032,7 +2032,7 @@ typedef struct {
 }ADDITIONAL_INFORMATION_ENTRY;\r
 \r
 ///\r
-/// Additional Information (Type 40)\r
+/// Additional Information (Type 40).\r
 ///\r
 /// This structure is intended to provide additional information for handling unspecified \r
 /// enumerated values and interim field updates in another structure. \r
@@ -2044,7 +2044,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE40;\r
 \r
 ///\r
-/// Onboard Devices Extended Information - Onboard Device Types\r
+/// Onboard Devices Extended Information - Onboard Device Types.\r
 ///\r
 typedef enum{\r
   OnBoardDeviceExtendedTypeOther          = 0x01,\r
@@ -2060,7 +2060,7 @@ typedef enum{
 } ONBOARD_DEVICE_EXTENDED_INFO_TYPE;\r
 \r
 ///\r
-/// Onboard Devices Extended Information (Type 41)\r
+/// Onboard Devices Extended Information (Type 41).\r
 ///\r
 /// The information in this structure defines the attributes of devices that \r
 /// are onboard (soldered onto) a system element, usually the baseboard.  \r
@@ -2070,7 +2070,7 @@ typedef enum{
 typedef struct {\r
   SMBIOS_STRUCTURE                  Hdr;\r
   SMBIOS_TABLE_STRING               ReferenceDesignation;\r
-  UINT8                             DeviceType;             ///< enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE\r
+  UINT8                             DeviceType;             ///< The enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE\r
   UINT8                             DeviceTypeInstance;\r
   UINT16                            SegmentGroupNum;\r
   UINT8                             BusNum;\r
@@ -2092,7 +2092,7 @@ typedef struct {
 } SMBIOS_TABLE_TYPE127;\r
 \r
 ///\r
-/// Union of all the possible SMBIOS record types\r
+/// Union of all the possible SMBIOS record types.\r
 ///\r
 typedef union {\r
   SMBIOS_STRUCTURE      *Hdr;\r
index e63831e059c223a084c38b3c4344c83ac6f8f2fa..b7ec333945d26566ef21dda706ecb23637ba4f4c 100644 (file)
@@ -2,12 +2,12 @@
   Provides string functions, linked list functions, math functions, synchronization\r
   functions, and CPU architecture-specific functions.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
 Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
-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
@@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 #if   defined (MDE_CPU_IA32)\r
 ///\r
-/// IA-32 architecture context buffer used by SetJump() and LongJump()\r
+/// The IA-32 architecture context buffer used by SetJump() and LongJump().\r
 ///\r
 typedef struct {\r
   UINT32                            Ebx;\r
@@ -40,7 +40,7 @@ typedef struct {
 #if defined (MDE_CPU_IPF)\r
 \r
 ///\r
-/// Itanium architecture context buffer used by SetJump() and LongJump()\r
+/// The Itanium architecture context buffer used by SetJump() and LongJump().\r
 ///\r
 typedef struct {\r
   UINT64                            F2[2];\r
@@ -89,7 +89,7 @@ typedef struct {
 \r
 #if defined (MDE_CPU_X64)\r
 ///\r
-/// x64 architecture context buffer used by SetJump() and LongJump()\r
+/// The x64 architecture context buffer used by SetJump() and LongJump().\r
 ///\r
 typedef struct {\r
   UINT64                            Rbx;\r
@@ -103,7 +103,7 @@ typedef struct {
   UINT64                            R15;\r
   UINT64                            Rip;\r
   UINT64                            MxCsr;\r
-  UINT8                             XmmBuffer[160]; ///< XMM6-XMM15\r
+  UINT8                             XmmBuffer[160]; ///< XMM6-XMM15.\r
 } BASE_LIBRARY_JUMP_BUFFER;\r
 \r
 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8\r
@@ -112,7 +112,7 @@ typedef struct {
 \r
 #if defined (MDE_CPU_EBC)\r
 ///\r
-/// EBC context buffer used by SetJump() and LongJump()\r
+/// The EBC context buffer used by SetJump() and LongJump().\r
 ///\r
 typedef struct {\r
   UINT64                            R0;\r
@@ -129,7 +129,7 @@ typedef struct {
 #if defined (MDE_CPU_ARM)\r
 \r
 typedef struct {\r
-  UINT32    R3;  ///< Copy of R13\r
+  UINT32    R3;  ///< A copy of R13.\r
   UINT32    R4;\r
   UINT32    R5;\r
   UINT32    R6;\r
@@ -167,8 +167,8 @@ typedef struct {
   PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated Unicode string.\r
-  @param  Source      Pointer to a Null-terminated Unicode string.\r
+  @param  Destination The pointer to a Null-terminated Unicode string.\r
+  @param  Source      The pointer to a Null-terminated Unicode string.\r
 \r
   @return Destination.\r
 \r
@@ -182,7 +182,7 @@ StrCpy (
 \r
 \r
 /**\r
-  Copies up to a specified length from one Null-terminated Unicode string  to \r
+  Copies up to a specified length from one Null-terminated Unicode string to \r
   another Null-terminated Unicode string and returns the new Unicode string.\r
 \r
   This function copies the contents of the Unicode string Source to the Unicode\r
@@ -204,9 +204,9 @@ StrCpy (
   PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated Unicode string.\r
-  @param  Source      Pointer to a Null-terminated Unicode string.\r
-  @param  Length      Maximum number of Unicode characters to copy.\r
+  @param  Destination The pointer to a Null-terminated Unicode string.\r
+  @param  Source      The pointer to a Null-terminated Unicode string.\r
+  @param  Length      The maximum number of Unicode characters to copy.\r
 \r
   @return Destination.\r
 \r
@@ -257,7 +257,7 @@ StrLen (
   PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  String  Pointer to a Null-terminated Unicode string.\r
+  @param  String  The pointer to a Null-terminated Unicode string.\r
 \r
   @return The size of String.\r
 \r
@@ -287,11 +287,11 @@ StrSize (
   than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more\r
-  than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  FirstString   Pointer to a Null-terminated Unicode string.\r
-  @param  SecondString  Pointer to a Null-terminated Unicode string.\r
+  @param  FirstString   The pointer to a Null-terminated Unicode string.\r
+  @param  SecondString  The pointer to a Null-terminated Unicode string.\r
 \r
   @retval 0      FirstString is identical to SecondString.\r
   @return others FirstString is not identical to SecondString.\r
@@ -329,9 +329,9 @@ StrCmp (
   PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  FirstString   Pointer to a Null-terminated Unicode string.\r
-  @param  SecondString  Pointer to a Null-terminated Unicode string.\r
-  @param  Length        Maximum number of Unicode characters to compare.\r
+  @param  FirstString   The pointer to a Null-terminated Unicode string.\r
+  @param  SecondString  The pointer to a Null-terminated Unicode string.\r
+  @param  Length        The maximum number of Unicode characters to compare.\r
 \r
   @retval 0      FirstString is identical to SecondString.\r
   @return others FirstString is not identical to SecondString.\r
@@ -362,18 +362,18 @@ StrnCmp (
   If Source is not aligned on a 16-bit boundary, then ASSERT().\r
   If Source and Destination overlap, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and Destination contains more\r
-  than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and Source contains more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination\r
   and Source results in a Unicode string with more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated Unicode string.\r
-  @param  Source      Pointer to a Null-terminated Unicode string.\r
+  @param  Destination The pointer to a Null-terminated Unicode string.\r
+  @param  Source      The pointer to a Null-terminated Unicode string.\r
 \r
   @return Destination.\r
 \r
@@ -416,9 +416,9 @@ StrCat (
   and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength\r
   Unicode characters, not including the Null-terminator, then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated Unicode string.\r
-  @param  Source      Pointer to a Null-terminated Unicode string.\r
-  @param  Length      Maximum number of Unicode characters to concatenate from\r
+  @param  Destination The pointer to a Null-terminated Unicode string.\r
+  @param  Source      The pointer to a Null-terminated Unicode string.\r
+  @param  Length      The maximum number of Unicode characters to concatenate from\r
                       Source.\r
 \r
   @return Destination.\r
@@ -439,8 +439,7 @@ StrnCat (
   This function scans the contents of the Null-terminated Unicode string\r
   specified by String and returns the first occurrence of SearchString.\r
   If SearchString is not found in String, then NULL is returned.  If\r
-  the length of SearchString is zero, then String is\r
-  returned.\r
+  the length of SearchString is zero, then String is returned.\r
 \r
   If String is NULL, then ASSERT().\r
   If String is not aligned on a 16-bit boundary, then ASSERT().\r
@@ -449,10 +448,10 @@ StrnCat (
 \r
   If PcdMaximumUnicodeStringLength is not zero, and SearchString\r
   or String contains more than PcdMaximumUnicodeStringLength Unicode\r
-  characters not including the Null-terminator, then ASSERT().\r
+  characters, not including the Null-terminator, then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated Unicode string.\r
-  @param  SearchString    Pointer to a Null-terminated Unicode string to search for.\r
+  @param  String          The pointer to a Null-terminated Unicode string.\r
+  @param  SearchString    The pointer to a Null-terminated Unicode string to search for.\r
 \r
   @retval NULL            If the SearchString does not appear in String.\r
   @return others          If there is a match.\r
@@ -494,7 +493,7 @@ StrStr (
   more than PcdMaximumUnicodeStringLength Unicode characters not including\r
   the Null-terminator, then ASSERT().\r
 \r
-  @param  String      Pointer to a Null-terminated Unicode string.\r
+  @param  String      The pointer to a Null-terminated Unicode string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -534,7 +533,7 @@ StrDecimalToUintn (
   more than PcdMaximumUnicodeStringLength Unicode characters not including\r
   the Null-terminator, then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated Unicode string.\r
+  @param  String          The pointer to a Null-terminated Unicode string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -561,8 +560,8 @@ StrDecimalToUint64 (
   The function will ignore the pad space, which includes spaces or tab characters,\r
   before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or\r
   [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the\r
-  first valid hexadecimal digit. Then, the function stops at the first character that is\r
-  a not a valid hexadecimal character or NULL, whichever one comes first.\r
+  first valid hexadecimal digit. Then, the function stops at the first character \r
+  that is a not a valid hexadecimal character or NULL, whichever one comes first.\r
 \r
   If String is NULL, then ASSERT().\r
   If String is not aligned in a 16-bit boundary, then ASSERT().\r
@@ -576,7 +575,7 @@ StrDecimalToUint64 (
   PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated Unicode string.\r
+  @param  String          The pointer to a Null-terminated Unicode string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -618,7 +617,7 @@ StrHexToUintn (
   PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated Unicode string.\r
+  @param  String          The pointer to a Null-terminated Unicode string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -653,8 +652,8 @@ StrHexToUint64 (
   than PcdMaximumAsciiStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  Source        Pointer to a Null-terminated Unicode string.\r
-  @param  Destination   Pointer to a Null-terminated ASCII string.\r
+  @param  Source        The pointer to a Null-terminated Unicode string.\r
+  @param  Destination   The pointer to a Null-terminated ASCII string.\r
 \r
   @return Destination.\r
 \r
@@ -682,8 +681,8 @@ UnicodeStrToAsciiStr (
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated ASCII string.\r
-  @param  Source      Pointer to a Null-terminated ASCII string.\r
+  @param  Destination The pointer to a Null-terminated ASCII string.\r
+  @param  Source      The pointer to a Null-terminated ASCII string.\r
 \r
   @return Destination\r
 \r
@@ -716,9 +715,9 @@ AsciiStrCpy (
   PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated ASCII string.\r
-  @param  Source      Pointer to a Null-terminated ASCII string.\r
-  @param  Length      Maximum number of ASCII characters to copy.\r
+  @param  Destination The pointer to a Null-terminated ASCII string.\r
+  @param  Source      The pointer to a Null-terminated ASCII string.\r
+  @param  Length      The maximum number of ASCII characters to copy.\r
 \r
   @return Destination\r
 \r
@@ -744,7 +743,7 @@ AsciiStrnCpy (
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  String  Pointer to a Null-terminated ASCII string.\r
+  @param  String  The pointer to a Null-terminated ASCII string.\r
 \r
   @return The length of String.\r
 \r
@@ -768,7 +767,7 @@ AsciiStrLen (
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  String  Pointer to a Null-terminated ASCII string.\r
+  @param  String  The pointer to a Null-terminated ASCII string.\r
 \r
   @return The size of String.\r
 \r
@@ -799,8 +798,8 @@ AsciiStrSize (
   than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  FirstString   Pointer to a Null-terminated ASCII string.\r
-  @param  SecondString  Pointer to a Null-terminated ASCII string.\r
+  @param  FirstString   The pointer to a Null-terminated ASCII string.\r
+  @param  SecondString  The 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
@@ -834,8 +833,8 @@ AsciiStrCmp (
   than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  FirstString   Pointer to a Null-terminated ASCII string.\r
-  @param  SecondString  Pointer to a Null-terminated ASCII string.\r
+  @param  FirstString   The pointer to a Null-terminated ASCII string.\r
+  @param  SecondString  The pointer to a Null-terminated ASCII string.\r
 \r
   @retval ==0    FirstString is identical to SecondString using case insensitive\r
                  comparisons.\r
@@ -873,9 +872,9 @@ AsciiStriCmp (
   PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  FirstString   Pointer to a Null-terminated ASCII string.\r
-  @param  SecondString  Pointer to a Null-terminated ASCII string.\r
-  @param  Length        Maximum number of ASCII characters for compare.\r
+  @param  FirstString   The pointer to a Null-terminated ASCII string.\r
+  @param  SecondString  The pointer to a Null-terminated ASCII string.\r
+  @param  Length        The 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
@@ -911,8 +910,8 @@ AsciiStrnCmp (
   Source results in a ASCII string with more than PcdMaximumAsciiStringLength\r
   ASCII characters, then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated ASCII string.\r
-  @param  Source      Pointer to a Null-terminated ASCII string.\r
+  @param  Destination The pointer to a Null-terminated ASCII string.\r
+  @param  Source      The pointer to a Null-terminated ASCII string.\r
 \r
   @return Destination\r
 \r
@@ -953,9 +952,9 @@ AsciiStrCat (
   Source results in a ASCII string with more than PcdMaximumAsciiStringLength\r
   ASCII characters, not including the Null-terminator, then ASSERT().\r
 \r
-  @param  Destination Pointer to a Null-terminated ASCII string.\r
-  @param  Source      Pointer to a Null-terminated ASCII string.\r
-  @param  Length      Maximum number of ASCII characters to concatenate from\r
+  @param  Destination The pointer to a Null-terminated ASCII string.\r
+  @param  Source      The pointer to a Null-terminated ASCII string.\r
+  @param  Length      The maximum number of ASCII characters to concatenate from\r
                       Source.\r
 \r
   @return Destination\r
@@ -986,8 +985,8 @@ 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          The pointer to a Null-terminated ASCII string.\r
+  @param  SearchString    The pointer to a Null-terminated ASCII string to search for.\r
 \r
   @retval NULL            If the SearchString does not appear in String.\r
   @retval others          If there is a match return the first occurrence of SearchingString.\r
@@ -1027,9 +1026,9 @@ AsciiStrStr (
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated ASCII string.\r
+  @param  String          The pointer to a Null-terminated ASCII string.\r
 \r
-  @retval Value translated from String.\r
+  @retval The value translated from String.\r
 \r
 **/\r
 UINTN\r
@@ -1064,7 +1063,7 @@ AsciiStrDecimalToUintn (
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
   then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated ASCII string.\r
+  @param  String          The pointer to a Null-terminated ASCII string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -1105,7 +1104,7 @@ AsciiStrDecimalToUint64 (
   and String contains more than PcdMaximumAsciiStringLength ASCII characters not including\r
   the Null-terminator, then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated ASCII string.\r
+  @param  String          The pointer to a Null-terminated ASCII string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -1146,7 +1145,7 @@ AsciiStrHexToUintn (
   and String contains more than PcdMaximumAsciiStringLength ASCII characters not including\r
   the Null-terminator, then ASSERT().\r
 \r
-  @param  String          Pointer to a Null-terminated ASCII string.\r
+  @param  String          The pointer to a Null-terminated ASCII string.\r
 \r
   @retval Value translated from String.\r
 \r
@@ -1179,8 +1178,8 @@ AsciiStrHexToUint64 (
   PcdMaximumUnicodeStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
 \r
-  @param  Source        Pointer to a Null-terminated ASCII string.\r
-  @param  Destination   Pointer to a Null-terminated Unicode string.\r
+  @param  Source        The pointer to a Null-terminated ASCII string.\r
+  @param  Destination   The pointer to a Null-terminated Unicode string.\r
 \r
   @return Destination.\r
 \r
@@ -1383,7 +1382,7 @@ GetFirstNode (
   @param  List  A pointer to the head node of a doubly linked list.\r
   @param  Node  A pointer to a node in the doubly linked list.\r
 \r
-  @return Pointer to the next node if one exists. Otherwise List is returned.\r
+  @return The pointer to the next node if one exists. Otherwise List is returned.\r
 \r
 **/\r
 LIST_ENTRY *\r
@@ -1412,7 +1411,7 @@ GetNextNode (
   @param  List  A pointer to the head node of a doubly linked list.\r
   @param  Node  A pointer to a node in the doubly linked list.\r
  \r
-  @return Pointer to the previous node if one exists. Otherwise List is returned.\r
+  @return The pointer to the previous node if one exists. Otherwise List is returned.\r
  \r
 **/\r
 LIST_ENTRY *\r
@@ -1868,7 +1867,7 @@ GetPowerOfTwo64 (
 \r
 \r
 /**\r
-  Switches the endianess of a 16-bit integer.\r
+  Switches the endianness of a 16-bit integer.\r
 \r
   This function swaps the bytes in a 16-bit unsigned value to switch the value\r
   from little endian to big endian or vice versa. The byte swapped value is\r
@@ -1887,7 +1886,7 @@ SwapBytes16 (
 \r
 \r
 /**\r
-  Switches the endianess of a 32-bit integer.\r
+  Switches the endianness of a 32-bit integer.\r
 \r
   This function swaps the bytes in a 32-bit unsigned value to switch the value\r
   from little endian to big endian or vice versa. The byte swapped value is\r
@@ -1906,7 +1905,7 @@ SwapBytes32 (
 \r
 \r
 /**\r
-  Switches the endianess of a 64-bit integer.\r
+  Switches the endianness of a 64-bit integer.\r
 \r
   This function swaps the bytes in a 64-bit unsigned value to switch the value\r
   from little endian to big endian or vice versa. The byte swapped value is\r
@@ -1957,7 +1956,7 @@ MultU64x32 (
   @param  Multiplicand  A 64-bit unsigned value.\r
   @param  Multiplier    A 64-bit unsigned value.\r
 \r
-  @return Multiplicand * Multiplier\r
+  @return Multiplicand * Multiplier.\r
 \r
 **/\r
 UINT64\r
@@ -2003,7 +2002,7 @@ MultS64x64 (
   @param  Dividend  A 64-bit unsigned value.\r
   @param  Divisor   A 32-bit unsigned value.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 UINT64\r
@@ -2027,7 +2026,7 @@ DivU64x32 (
   @param  Dividend  A 64-bit unsigned value.\r
   @param  Divisor   A 32-bit unsigned value.\r
 \r
-  @return Dividend % Divisor\r
+  @return Dividend % Divisor.\r
 \r
 **/\r
 UINT32\r
@@ -2054,7 +2053,7 @@ ModU64x32 (
   @param  Remainder A pointer to a 32-bit unsigned value. This parameter is\r
                     optional and may be NULL.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 UINT64\r
@@ -2082,7 +2081,7 @@ DivU64x32Remainder (
   @param  Remainder A pointer to a 64-bit unsigned value. This parameter is\r
                     optional and may be NULL.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 UINT64\r
@@ -2114,7 +2113,7 @@ DivU64x64Remainder (
   @param  Remainder A pointer to a 64-bit signed value. This parameter is\r
                     optional and may be NULL.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 INT64\r
@@ -2134,7 +2133,7 @@ DivS64x64Remainder (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 16-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 16-bit value that may be unaligned.\r
 \r
   @return The 16-bit value read from Buffer.\r
 \r
@@ -2155,7 +2154,7 @@ ReadUnaligned16 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 16-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 16-bit value that may be unaligned.\r
   @param  Value   16-bit value to write to Buffer.\r
 \r
   @return The 16-bit value to write to Buffer.\r
@@ -2177,7 +2176,7 @@ WriteUnaligned16 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 24-bit value that may be unaligned.\r
 \r
   @return The 24-bit value read from Buffer.\r
 \r
@@ -2198,7 +2197,7 @@ ReadUnaligned24 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 24-bit value that may be unaligned.\r
   @param  Value   24-bit value to write to Buffer.\r
 \r
   @return The 24-bit value to write to Buffer.\r
@@ -2220,7 +2219,7 @@ WriteUnaligned24 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 32-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 32-bit value that may be unaligned.\r
 \r
   @return The 32-bit value read from Buffer.\r
 \r
@@ -2241,7 +2240,7 @@ ReadUnaligned32 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 32-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 32-bit value that may be unaligned.\r
   @param  Value   32-bit value to write to Buffer.\r
 \r
   @return The 32-bit value to write to Buffer.\r
@@ -2263,7 +2262,7 @@ WriteUnaligned32 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 64-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 64-bit value that may be unaligned.\r
 \r
   @return The 64-bit value read from Buffer.\r
 \r
@@ -2284,7 +2283,7 @@ ReadUnaligned64 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 64-bit value that may be unaligned.\r
+  @param  Buffer  The pointer to a 64-bit value that may be unaligned.\r
   @param  Value   64-bit value to write to Buffer.\r
 \r
   @return The 64-bit value to write to Buffer.\r
@@ -2704,7 +2703,7 @@ BitFieldWrite32 (
                     Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..31.\r
-  @param  OrData    The value to OR with the read value from the value\r
+  @param  OrData    The value to OR with the read value from the value.\r
 \r
   @return The new 32-bit value.\r
 \r
@@ -2965,7 +2964,7 @@ BitFieldAndThenOr64 (
   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  Buffer      The 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
@@ -2991,10 +2990,10 @@ CalculateSum8 (
   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 checksum operation.\r
+  @param  Buffer      The 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
+  @return Checksum    The two's complement checksum of Buffer.\r
 \r
 **/\r
 UINT8\r
@@ -3018,7 +3017,7 @@ 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  Buffer      The 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
@@ -3046,10 +3045,10 @@ 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  Buffer      The 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
+  @return Checksum    The two's complement checksum of Buffer.\r
 \r
 **/\r
 UINT16\r
@@ -3073,7 +3072,7 @@ 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  Buffer      The 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
@@ -3101,10 +3100,10 @@ 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  Buffer      The 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
+  @return Checksum    The two's complement checksum of Buffer.\r
 \r
 **/\r
 UINT32\r
@@ -3128,7 +3127,7 @@ 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  Buffer      The 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
@@ -3156,10 +3155,10 @@ 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  Buffer      The 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
+  @return Checksum    The two's complement checksum of Buffer.\r
 \r
 **/\r
 UINT64\r
@@ -3307,7 +3306,7 @@ EnableDisableInterrupts (
 /**\r
   Retrieves the current CPU interrupt state.\r
 \r
-  Returns TRUE is interrupts are currently enabled. Otherwise\r
+  Returns TRUE if interrupts are currently enabled. Otherwise\r
   returns FALSE.\r
 \r
   @retval TRUE  CPU interrupts are enabled.\r
@@ -3378,10 +3377,10 @@ CpuPause (
                       function.\r
   @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                       function.\r
-  @param  ...         This variable argument list is ignored for IA-32, x64, and EBC architectures.  \r
-                      For Itanium processors, this variable argument list is expected to contain \r
-                      a single parameter of type VOID * that specifies the new backing \r
-                      store pointer.\r
+  @param  ...         This variable argument list is ignored for IA-32, x64, and \r
+                      EBC architectures.  For Itanium processors, this variable \r
+                      argument list is expected to contain a single parameter of \r
+                      type VOID * that specifies the new backing store pointer.\r
 \r
 \r
 **/\r
@@ -3460,8 +3459,8 @@ AsmFlushCacheRange (
 \r
 \r
 /**\r
-  Executes a FC instruction\r
-  Executes a FC instruction on the cache line specified by Address.\r
+  Executes an FC instruction.\r
+  Executes an FC instruction on the cache line specified by Address.\r
   The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).\r
   An implementation may flush a larger region.  This function is only available on Itanium processors.\r
 \r
@@ -3478,14 +3477,14 @@ AsmFc (
 \r
 \r
 /**\r
-  Executes a FC.I instruction.\r
-  Executes a FC.I instruction on the cache line specified by Address.\r
+  Executes an FC.I instruction.\r
+  Executes an FC.I instruction on the cache line specified by Address.\r
   The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).\r
   An implementation may flush a larger region.  This function is only available on Itanium processors.\r
 \r
   @param Address    The Address of cache line to be flushed.\r
 \r
-  @return The address of FC.I instruction executed.\r
+  @return The address of the FC.I instruction executed.\r
 \r
 **/\r
 UINT64\r
@@ -4351,7 +4350,7 @@ AsmWriteLrr1 (
   \r
   The Instruction Breakpoint Registers are used in pairs.  The even numbered\r
   registers contain breakpoint addresses, and the odd numbered registers contain\r
-  breakpoint mask conditions.  At least 4 instruction registers pairs are implemented\r
+  breakpoint mask conditions.  At least four instruction registers pairs are implemented\r
   on all processor models.   Implemented registers are contiguous starting with\r
   register 0.  No parameter checking is performed on Index, and if the Index value\r
   is beyond the implemented IBR register range, a Reserved Register/Field fault may\r
@@ -4376,7 +4375,7 @@ AsmReadIbr (
 \r
   The Data Breakpoint Registers are used in pairs.  The even numbered registers\r
   contain breakpoint addresses, and odd numbered registers contain breakpoint\r
-  mask conditions.  At least 4 data registers pairs are implemented on all processor\r
+  mask conditions.  At least four data registers pairs are implemented on all processor\r
   models.  Implemented registers are contiguous starting with register 0.\r
   No parameter checking is performed on Index.  If the Index value is beyond\r
   the implemented DBR register range, a Reserved Register/Field fault may occur.\r
@@ -4399,8 +4398,8 @@ AsmReadDbr (
 /**\r
   Reads the current value of Performance Monitor Configuration Register (PMC).\r
 \r
-  All processor implementations provide at least 4 performance counters\r
-  (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow\r
+  All processor implementations provide at least four performance counters\r
+  (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow\r
   status registers (PMC [0]... PMC [3]).  Processor implementations may provide\r
   additional implementation-dependent PMC and PMD to increase the number of\r
   'generic' performance counters (PMC/PMD pairs).  The remainder of PMC and PMD\r
@@ -4453,7 +4452,7 @@ AsmReadPmd (
   Writes current value of Instruction Breakpoint Register specified by Index.\r
   The Instruction Breakpoint Registers are used in pairs.  The even numbered\r
   registers contain breakpoint addresses, and odd numbered registers contain\r
-  breakpoint mask conditions.  At least 4 instruction registers pairs are implemented\r
+  breakpoint mask conditions.  At least four instruction registers pairs are implemented\r
   on all processor models.  Implemented registers are contiguous starting with\r
   register 0.  No parameter checking is performed on Index.  If the Index value\r
   is beyond the implemented IBR register range, a Reserved Register/Field fault may\r
@@ -4481,7 +4480,7 @@ AsmWriteIbr (
   Writes current value of Data Breakpoint Register specified by Index.\r
   The Data Breakpoint Registers are used in pairs.  The even numbered registers\r
   contain breakpoint addresses, and odd numbered registers contain breakpoint\r
-  mask conditions.  At least 4 data registers pairs are implemented on all processor\r
+  mask conditions.  At least four data registers pairs are implemented on all processor\r
   models.  Implemented registers are contiguous starting with register 0.  No parameter\r
   checking is performed on Index.  If the Index value is beyond the implemented\r
   DBR register range, a Reserved Register/Field fault may occur.  The caller must\r
@@ -4507,8 +4506,8 @@ AsmWriteDbr (
   Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).\r
 \r
   Writes current value of Performance Monitor Configuration Register specified by Index.\r
-  All processor implementations provide at least 4 performance counters\r
-  (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status\r
+  All processor implementations provide at least four performance counters\r
+  (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow status\r
   registers (PMC [0]... PMC [3]).  Processor implementations may provide additional\r
   implementation-dependent PMC and PMD to increase the number of 'generic' performance\r
   counters (PMC/PMD pairs).  The remainder of PMC and PMD register set is implementation\r
@@ -4534,8 +4533,8 @@ AsmWritePmc (
   Writes the current value of 64-bit Performance Monitor Data Register (PMD).\r
 \r
   Writes current value of Performance Monitor Data Register specified by Index.\r
-  All processor implementations provide at least 4 performance counters\r
-  (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow\r
+  All processor implementations provide at least four performance counters\r
+  (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow\r
   status registers (PMC [0]... PMC [3]).  Processor implementations may provide\r
   additional implementation-dependent PMC and PMD to increase the number of 'generic'\r
   performance counters (PMC/PMD pairs).  The remainder of PMC and PMD register set\r
@@ -4609,7 +4608,7 @@ AsmReadSp (
 \r
 \r
 ///\r
-/// Valid Index value for AsmReadControlRegister()\r
+/// Valid Index value for AsmReadControlRegister().\r
 ///\r
 #define IPF_CONTROL_REGISTER_DCR   0\r
 #define IPF_CONTROL_REGISTER_ITM   1\r
@@ -4641,9 +4640,10 @@ AsmReadSp (
 /**\r
   Reads a 64-bit control register.\r
 \r
-  Reads and returns the control register specified by Index. The valid Index valued are defined\r
-  above in "Related Definitions".\r
-  If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned.  This function is only available on Itanium processors.\r
+  Reads and returns the control register specified by Index. The valid Index valued \r
+  are defined above in "Related Definitions".\r
+  If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned.  This function is only \r
+  available on Itanium processors.\r
 \r
   @param  Index                     The index of the control register to read.\r
 \r
@@ -4658,7 +4658,7 @@ AsmReadControlRegister (
 \r
 \r
 ///\r
-/// Valid Index value for AsmReadApplicationRegister()\r
+/// Valid Index value for AsmReadApplicationRegister().\r
 ///\r
 #define IPF_APPLICATION_REGISTER_K0        0\r
 #define IPF_APPLICATION_REGISTER_K1        1\r
@@ -4691,9 +4691,10 @@ AsmReadControlRegister (
 /**\r
   Reads a 64-bit application register.\r
 \r
-  Reads and returns the application register specified by Index. The valid Index valued are defined\r
-  above in "Related Definitions".\r
-  If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned.  This function is only available on Itanium processors.\r
+  Reads and returns the application register specified by Index. The valid Index \r
+  valued are defined above in "Related Definitions".\r
+  If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned.  This function is only \r
+  available on Itanium processors.\r
 \r
   @param  Index                     The index of the application register to read.\r
 \r
@@ -4817,119 +4818,119 @@ AsmPalCall (
 \r
 #if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)\r
 ///\r
-/// IA32 and x64 Specific Functions\r
-/// Byte packed structure for 16-bit Real Mode EFLAGS\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
+/// 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
+/// 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
+/// 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  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
+                            ///< 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
+                            ///< Exceptions.\r
+    UINT32  Reserved_0:2;   ///< Reserved.\r
     UINT32  VMXE:1;         ///< VMX Enable\r
-    UINT32  Reserved_1:18;  ///< Reserved\r
+    UINT32  Reserved_1:18;  ///< Reserved.\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_CR4;\r
 \r
 ///\r
-/// Byte packed structure for an IDTR, GDTR, LDTR descriptor\r
+/// Byte packed structure for an IDTR, GDTR, LDTR descriptor.\r
 ///\r
 #pragma pack (1)\r
 typedef struct {\r
@@ -4947,15 +4948,15 @@ typedef struct {
 \r
 #if defined (MDE_CPU_IA32)\r
 ///\r
-/// Byte packed structure for an IA-32 Interrupt Gate Descriptor\r
+/// Byte packed structure for an IA-32 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
@@ -4964,17 +4965,17 @@ typedef union {
 \r
 #if defined (MDE_CPU_X64)\r
 ///\r
-/// Byte packed structure for an x64 Interrupt Gate Descriptor\r
+/// Byte packed structure for an x64 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  OffsetUpper:32; ///< Offset bits 63..32\r
-    UINT32  Reserved_1:32;  ///< Reserved\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  OffsetUpper:32; ///< Offset bits 63..32.\r
+    UINT32  Reserved_1:32;  ///< Reserved.\r
   } Bits;\r
   struct {\r
     UINT64  Uint64;\r
@@ -4985,14 +4986,14 @@ typedef union {
 #endif\r
 \r
 ///\r
-/// Byte packed structure for an FP/SSE/SSE2 context\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
+/// Structures for the 16-bit real mode thunks.\r
 ///\r
 typedef struct {\r
   UINT32                            Reserved1;\r
@@ -5058,7 +5059,7 @@ typedef union {
 } IA32_REGISTER_SET;\r
 \r
 ///\r
-/// Byte packed structure for an 16-bit real mode thunks\r
+/// Byte packed structure for an 16-bit real mode thunks.\r
 ///\r
 typedef struct {\r
   IA32_REGISTER_SET                 *RealModeState;\r
@@ -5084,13 +5085,13 @@ typedef struct {
 \r
   @param  Index The 32-bit value to load into EAX prior to invoking the CPUID\r
                 instruction.\r
-  @param  Eax   Pointer to the 32-bit EAX value returned by the CPUID\r
+  @param  Eax   The pointer to the 32-bit EAX value returned by the CPUID\r
                 instruction. This is an optional parameter that may be NULL.\r
-  @param  Ebx   Pointer to the 32-bit EBX value returned by the CPUID\r
+  @param  Ebx   The pointer to the 32-bit EBX value returned by the CPUID\r
                 instruction. This is an optional parameter that may be NULL.\r
-  @param  Ecx   Pointer to the 32-bit ECX value returned by the CPUID\r
+  @param  Ecx   The pointer to the 32-bit ECX value returned by the CPUID\r
                 instruction. This is an optional parameter that may be NULL.\r
-  @param  Edx   Pointer to the 32-bit EDX value returned by the CPUID\r
+  @param  Edx   The pointer to the 32-bit EDX value returned by the CPUID\r
                 instruction. This is an optional parameter that may be NULL.\r
 \r
   @return Index.\r
@@ -5123,16 +5124,16 @@ AsmCpuid (
                     CPUID instruction.\r
   @param  SubIndex  The 32-bit value to load into ECX prior to invoking the\r
                     CPUID instruction.\r
-  @param  Eax       Pointer to the 32-bit EAX value returned by the CPUID\r
+  @param  Eax       The pointer to the 32-bit EAX value returned by the CPUID\r
                     instruction. This is an optional parameter that may be\r
                     NULL.\r
-  @param  Ebx       Pointer to the 32-bit EBX value returned by the CPUID\r
+  @param  Ebx       The pointer to the 32-bit EBX value returned by the CPUID\r
                     instruction. This is an optional parameter that may be\r
                     NULL.\r
-  @param  Ecx       Pointer to the 32-bit ECX value returned by the CPUID\r
+  @param  Ecx       The pointer to the 32-bit ECX value returned by the CPUID\r
                     instruction. This is an optional parameter that may be\r
                     NULL.\r
-  @param  Edx       Pointer to the 32-bit EDX value returned by the CPUID\r
+  @param  Edx       The pointer to the 32-bit EDX value returned by the CPUID\r
                     instruction. This is an optional parameter that may be\r
                     NULL.\r
 \r
@@ -6347,7 +6348,7 @@ AsmReadTr (
 \r
   If Gdtr is NULL, then ASSERT().\r
 \r
-  @param  Gdtr  Pointer to a GDTR descriptor.\r
+  @param  Gdtr  The pointer to a GDTR descriptor.\r
 \r
 **/\r
 VOID\r
@@ -6365,7 +6366,7 @@ AsmReadGdtr (
 \r
   If Gdtr is NULL, then ASSERT().\r
 \r
-  @param  Gdtr  Pointer to a GDTR descriptor.\r
+  @param  Gdtr  The pointer to a GDTR descriptor.\r
 \r
 **/\r
 VOID\r
@@ -6383,7 +6384,7 @@ AsmWriteGdtr (
 \r
   If Idtr is NULL, then ASSERT().\r
 \r
-  @param  Idtr  Pointer to a IDTR descriptor.\r
+  @param  Idtr  The pointer to a IDTR descriptor.\r
 \r
 **/\r
 VOID\r
@@ -6401,7 +6402,7 @@ AsmReadIdtr (
 \r
   If Idtr is NULL, then ASSERT().\r
 \r
-  @param  Idtr  Pointer to a IDTR descriptor.\r
+  @param  Idtr  The pointer to a IDTR descriptor.\r
 \r
 **/\r
 VOID\r
@@ -6453,7 +6454,7 @@ AsmWriteLdtr (
   If Buffer is NULL, then ASSERT().\r
   If Buffer is not aligned on a 16-byte boundary, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
+  @param  Buffer  The pointer to a buffer to save the floating point/SSE/SSE2 context.\r
 \r
 **/\r
 VOID\r
@@ -6474,7 +6475,7 @@ AsmFxSave (
   If Buffer is not aligned on a 16-byte boundary, then ASSERT().\r
   If Buffer was not saved with AsmFxSave(), then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
+  @param  Buffer  The pointer to a buffer to save the floating point/SSE/SSE2 context.\r
 \r
 **/\r
 VOID\r
@@ -6862,7 +6863,7 @@ AsmInvd (
                         addressing mode, then LinearAddress is a virtual\r
                         address.\r
 \r
-  @return LinearAddress\r
+  @return LinearAddress.\r
 **/\r
 VOID *\r
 EFIAPI\r
@@ -7147,7 +7148,7 @@ AsmPrepareThunk16 (
   ThunkAttributes, then ASSERT().\r
 \r
   This interface is limited to be used in either physical mode or virtual modes with paging enabled where the\r
-  virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.\r
+  virtual to physical mappings for ThunkContext.RealModeBuffer are mapped 1:1.\r
 \r
   @param  ThunkContext  A pointer to the context structure that describes the\r
                         16-bit real mode code to call.\r
index 47033d70a0974ec31b20e75dcbee17fa4548dd71..0a543116890fcbe63fa6a647ac17ad38e9ac4a7a 100644 (file)
@@ -5,11 +5,11 @@
   These functions should be used in place of coding your own loops to do equivalent common functions. \r
   This allows optimized library implementations to help increase performance. \r
 \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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -29,9 +29,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
 \r
-  @param  DestinationBuffer   Pointer to the destination buffer of the memory copy.\r
-  @param  SourceBuffer        Pointer to the source buffer of the memory copy.\r
-  @param  Length              Number of bytes to copy from SourceBuffer to DestinationBuffer.\r
+  @param  DestinationBuffer   The pointer to the destination buffer of the memory copy.\r
+  @param  SourceBuffer        The pointer to the source buffer of the memory copy.\r
+  @param  Length              The number of bytes to copy from SourceBuffer to DestinationBuffer.\r
 \r
   @return DestinationBuffer.\r
 \r
@@ -51,9 +51,9 @@ CopyMem (
   \r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer    Memory to set.\r
-  @param  Length    Number of bytes to set.\r
-  @param  Value     Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer    The memory to set.\r
+  @param  Length    The number of bytes to set.\r
+  @param  Value     The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -78,9 +78,9 @@ SetMem (
   If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -105,9 +105,9 @@ SetMem16 (
   If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -132,9 +132,9 @@ SetMem32 (
   If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -159,9 +159,9 @@ SetMem64 (
   If Buffer is not aligned on a UINTN boundary, then ASSERT().\r
   If Length is not aligned on a UINTN boundary, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -182,8 +182,8 @@ SetMemN (
   If Length > 0 and Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to fill with zeros.\r
-  @param  Length      Number of bytes in Buffer to fill with zeros.\r
+  @param  Buffer      The pointer to the target buffer to fill with zeros.\r
+  @param  Length      The number of bytes in Buffer to fill with zeros.\r
 \r
   @return Buffer.\r
 \r
@@ -208,9 +208,9 @@ ZeroMem (
   If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
 \r
-  @param  DestinationBuffer Pointer to the destination buffer to compare.\r
-  @param  SourceBuffer      Pointer to the source buffer to compare.\r
-  @param  Length            Number of bytes to compare.\r
+  @param  DestinationBuffer The pointer to the destination buffer to compare.\r
+  @param  SourceBuffer      The pointer to the source buffer to compare.\r
+  @param  Length            The number of bytes to compare.\r
 \r
   @return 0                 All Length bytes of the two buffers are identical.\r
   @retval Non-zero          The first mismatched byte in SourceBuffer subtracted from the first\r
@@ -237,11 +237,11 @@ CompareMem (
   If Length > 0 and Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\r
-  @param  Value       Value to search for in the target buffer.\r
+  @param  Buffer      The pointer to the target buffer to scan.\r
+  @param  Length      The number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -266,11 +266,11 @@ ScanMem8 (
   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 target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\r
-  @param  Value       Value to search for in the target buffer.\r
+  @param  Buffer      The pointer to the target buffer to scan.\r
+  @param  Length      The number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -295,11 +295,11 @@ ScanMem16 (
   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 target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\r
-  @param  Value       Value to search for in the target buffer.\r
+  @param  Buffer      The pointer to the target buffer to scan.\r
+  @param  Length      The number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -324,11 +324,11 @@ ScanMem32 (
   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 target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\r
-  @param  Value       Value to search for in the target buffer.\r
+  @param  Buffer      The pointer to the target buffer to scan.\r
+  @param  Length      The number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -353,11 +353,11 @@ ScanMem64 (
   If Length is not aligned on a UINTN boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\r
-  @param  Value       Value to search for in the target buffer.\r
+  @param  Buffer      The pointer to the target buffer to scan.\r
+  @param  Length      The number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -377,8 +377,8 @@ ScanMemN (
   If DestinationGuid is NULL, then ASSERT().\r
   If SourceGuid is NULL, then ASSERT().\r
 \r
-  @param  DestinationGuid   Pointer to the destination GUID.\r
-  @param  SourceGuid        Pointer to the source GUID.\r
+  @param  DestinationGuid   The pointer to the destination GUID.\r
+  @param  SourceGuid        The pointer to the source GUID.\r
 \r
   @return DestinationGuid.\r
 \r
@@ -428,11 +428,11 @@ CompareGuid (
   If Length is not aligned on a 128-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer  Pointer to the target buffer to scan.\r
-  @param  Length  Number of bytes in Buffer to scan.\r
-  @param  Guid    Value to search for in the target buffer.\r
+  @param  Buffer  The pointer to the target buffer to scan.\r
+  @param  Length  The number of bytes in Buffer to scan.\r
+  @param  Guid    The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching Guid in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching Guid in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
index bf38fd8bf573506f905f368c2ef2e60611b6212b..bbc974a3755782f2d41ac4e9fe6d2697ef1ec6e8 100644 (file)
@@ -8,11 +8,11 @@
   of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
   defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
 \r
-Copyright (c) 2006 - 2010, 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -82,8 +82,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If Format is NULL, then ASSERT().\r
 \r
   @param  ErrorLevel  The error level of the debug message.\r
-  @param  Format      Format string for the debug message to print.\r
-  @param  ...         Variable argument list whose contents are accessed \r
+  @param  Format      The format string for the debug message to print.\r
+  @param  ...         The variable argument list whose contents are accessed \r
                       based on the format string specified by Format.\r
 \r
 **/\r
@@ -112,9 +112,9 @@ DebugPrint (
   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
 \r
-  @param  FileName     Pointer to the name of the source file that generated the assert condition.\r
+  @param  FileName     The pointer to the name of the source file that generated the assert condition.\r
   @param  LineNumber   The line number in the source file that generated the assert condition\r
-  @param  Description  Pointer to the description of the assert condition.\r
+  @param  Description  The pointer to the description of the assert condition.\r
 \r
 **/\r
 VOID\r
@@ -135,10 +135,10 @@ DebugAssert (
   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 target buffer to be filled with PcdDebugClearMemoryValue.\r
-  @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
+  @param   Buffer  The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
+  @param   Length  The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
 \r
-  @return  Buffer  Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
+  @return  Buffer  The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
 \r
 **/\r
 VOID *\r
@@ -153,7 +153,7 @@ DebugClearMemory (
   Returns TRUE if ASSERT() macros are enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
-  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
+  PcdDebugProperyMask is set.  Otherwise, FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
@@ -170,7 +170,7 @@ DebugAssertEnabled (
   Returns TRUE if DEBUG() macros are enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
-  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
+  PcdDebugProperyMask is set.  Otherwise, FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
@@ -187,7 +187,7 @@ DebugPrintEnabled (
   Returns TRUE if DEBUG_CODE() macros are enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
-  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
+  PcdDebugProperyMask is set.  Otherwise, FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
@@ -204,7 +204,7 @@ DebugCodeEnabled (
   Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
-  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
+  PcdDebugProperyMask is set.  Otherwise, FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
@@ -251,7 +251,7 @@ DebugClearMemoryEnabled (
   DebugAssert() is called passing in the source filename, source line number, \r
   and Expression.\r
 \r
-  @param  Expression  Boolean expression\r
+  @param  Expression  Boolean expression.\r
 \r
 **/\r
 #if !defined(MDEPKG_NDEBUG)       \r
@@ -335,7 +335,7 @@ DebugClearMemoryEnabled (
                   parameter that may be NULL.  If it is NULL, then the entire \r
                   handle database is searched.\r
 \r
-  @param  Guid    Pointer to a protocol GUID.\r
+  @param  Guid    The pointer to a protocol GUID.\r
 \r
 **/\r
 #if !defined(MDEPKG_NDEBUG)\r
@@ -372,7 +372,7 @@ DebugClearMemoryEnabled (
 \r
 \r
 /**  \r
-  Macro that marks the end of debug source code.\r
+  The macro that marks the end of debug source code.\r
 \r
   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
   then this macro marks the end of source code that is included in a module.  \r
@@ -384,7 +384,7 @@ DebugClearMemoryEnabled (
 \r
 \r
 /**  \r
-  Macro that declares a section of debug source code.\r
+  The macro that declares a section of debug source code.\r
 \r
   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
   then the source code specified by Expression is included in a module.  \r
@@ -398,12 +398,12 @@ DebugClearMemoryEnabled (
 \r
 \r
 /**  \r
-  Macro that calls DebugClearMemory() to clear a buffer to a default value.\r
+  The macro that calls DebugClearMemory() to clear a buffer to a default value.\r
 \r
   If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, \r
   then this macro calls DebugClearMemory() passing in Address and Length.\r
 \r
-  @param  Address  Pointer to a buffer.\r
+  @param  Address  The pointer to a buffer.\r
   @param  Length   The number of bytes in the buffer to set.\r
 \r
 **/\r
@@ -419,13 +419,13 @@ DebugClearMemoryEnabled (
   Macro that calls DebugAssert() if the containing record does not have a \r
   matching signature.  If the signatures matches, then a pointer to the data \r
   structure that contains a specified field of that data structure is returned.  \r
-  This is a light weight method hide information by placing a public data \r
+  This is a lightweight method hide information by placing a public data \r
   structure inside a larger private data structure and using a pointer to the \r
   public data structure to retrieve a pointer to the private data structure.\r
 \r
   If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit \r
   of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes,\r
-  of field specified by Field from the beginning of the  data structure specified \r
+  of the field specified by Field from the beginning of the data structure specified \r
   by TYPE.  This offset is subtracted from Record, and is used to return a pointer \r
   to a data structure of the type specified by TYPE.\r
 \r
@@ -445,7 +445,7 @@ DebugClearMemoryEnabled (
   If TYPE does not contain a field called Signature, then the module will not \r
   compile.\r
 \r
-  @param  Record         Pointer to the field specified by Field within a data \r
+  @param  Record         The pointer to the field specified by Field within a data \r
                          structure of type TYPE.\r
 \r
   @param  TYPE           The name of the data structure type to return  This \r
index 32f18f814872d2526319e355fa5c29f487c2e76a..f4e5ddd24cbd6603445cd6d153720874bd7e6a07 100644 (file)
@@ -4,11 +4,11 @@
   This library provides defines, macros, and functions to help create and parse \r
   EFI_DEVICE_PATH_PROTOCOL structures.\r
 \r
-Copyright (c) 2006 - 2009, 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -97,7 +97,8 @@ NextDevicePathNode (
 \r
 /**\r
   Determines if a device path node is an end node of a device path.\r
-  This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path.\r
+  This includes nodes that are the end of a device path instance and nodes that \r
+  are the end of an entire device path.\r
 \r
   Determines if the device path node specified by Node is an end node of a device path.  \r
   This includes nodes that are the end of a device path instance and nodes that are the \r
@@ -212,7 +213,7 @@ SetDevicePathEndNode (
 \r
   @param  DevicePath                 A pointer to a device path data structure.\r
   \r
-  @retval 0       If DevicePath is NULL.\r
+  @retval 0       DevicePath is NULL.\r
   @retval Others  The size of a device path in bytes.\r
 \r
 **/\r
@@ -234,7 +235,7 @@ GetDevicePathSize (
   \r
   @param  DevicePath                 A pointer to a device path data structure.\r
 \r
-  @retval NULL    If DevicePath is NULL.\r
+  @retval NULL    DevicePath is NULL.\r
   @retval Others  A pointer to the duplicated device path.\r
   \r
 **/\r
@@ -291,7 +292,7 @@ AppendDevicePath (
   @param  DevicePath                 A pointer to a device path data structure.\r
   @param  DevicePathNode             A pointer to a single device path node.\r
 \r
-  @retval NULL      If there is not enough memory for the new device path.\r
+  @retval NULL      There is not enough memory for the new device path.\r
   @retval Others    A pointer to the new device path if success.\r
                     A copy of DevicePathNode followed by an end-of-device-path node \r
                     if both FirstDevicePath and SecondDevicePath are NULL.\r
@@ -398,7 +399,7 @@ CreateDeviceNode (
   @param  DevicePath                 A pointer to a device path data structure.\r
 \r
   @retval  TRUE                      DevicePath is multi-instance.\r
-  @retval  FALSE                     DevicePath is not multi-instance or DevicePath is NULL.\r
+  @retval  FALSE                     DevicePath is not multi-instance, or DevicePath is NULL.\r
 \r
 **/\r
 BOOLEAN\r
index abfdde6d6237b22929702b9470ac43f3ae28fd31..d1dd8fffd0c38231b2b544d5ed728df3503208e5 100644 (file)
@@ -2,14 +2,14 @@
   MDE DXE Services Library provides functions that simplify the development of DXE Drivers.  \r
   These functions help access data from sections of FFS files or from file path.\r
 \r
-  Copyright (c) 2008 - 2010, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
+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
 **/\r
 \r
   If Size is NULL, then ASSERT().\r
 \r
 \r
-  @param  NameGuid             A pointer to to the FFS filename GUID to search for within \r
-                               any of the firmware volumes in the platform. \r
-  @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
-  @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
-  @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  \r
-                               It is the caller's responsibility to free this buffer using FreePool().\r
+  @param  NameGuid             A pointer to to the FFS filename GUID to search for  \r
+                               within any of the firmware volumes in the platform. \r
+  @param  SectionType          Indicates the FFS section type to search for within \r
+                               the FFS file specified by NameGuid.\r
+  @param  SectionInstance      Indicates which section instance within the FFS file \r
+                               specified by NameGuid to retrieve.\r
+  @param  Buffer               On output, a pointer to a callee-allocated buffer \r
+                               containing the FFS file section that was found.  \r
+                               It is the caller's responsibility to free this \r
+                               buffer using FreePool().\r
   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.\r
 \r
   @retval  EFI_SUCCESS          The specified FFS section was returned.\r
   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.\r
-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
-  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.\r
-  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that \r
-                                contains the matching FFS section does not allow reads.\r
+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+                                the matching FFS section.\r
+  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a \r
+                                device error.\r
+  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the \r
+                                firmware volume that contains the matching FFS \r
+                                section does not allow reads.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -83,21 +90,29 @@ GetSectionFromAnyFv  (
   If Buffer is NULL, then ASSERT().\r
   If Size is NULL, then ASSERT().\r
 \r
-  @param  NameGuid             A pointer to to the FFS filename GUID to search for within \r
-                               the firmware volumes that the currently executing module was loaded from.\r
-  @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
-  @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
-  @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  \r
-                               It is the caller's responsibility to free this buffer using FreePool().\r
+  @param  NameGuid             A pointer to to the FFS filename GUID to search for  \r
+                               within the firmware volumes that the currently \r
+                               executing module was loaded from.\r
+  @param  SectionType          Indicates the FFS section type to search for within \r
+                               the FFS file specified by NameGuid.\r
+  @param  SectionInstance      Indicates which section instance within the FFS \r
+                               file specified by NameGuid to retrieve.\r
+  @param  Buffer               On output, a pointer to a callee allocated buffer \r
+                               containing the FFS file section that was found.  \r
+                               It is the caller's responsibility to free this buffer \r
+                               using FreePool().\r
   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.\r
 \r
 \r
   @retval  EFI_SUCCESS          The specified FFS section was returned.\r
   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.\r
-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
-  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.\r
-  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that \r
-                                contains the matching FFS section does not allow reads.  \r
+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+                                the matching FFS section.\r
+  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a \r
+                                device error.\r
+  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the \r
+                                firmware volume that contains the matching FFS \r
+                                section does not allow reads.  \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -129,20 +144,27 @@ GetSectionFromFv (
   If Size is NULL, then ASSERT().\r
 \r
 \r
-  @param  SectionType          Indicates the FFS section type to search for within the FFS file \r
-                               that the currently executing module was loaded from.\r
-  @param  SectionInstance      Indicates which section instance to retrieve within the FFS file \r
-                               that the currently executing module was loaded from.\r
-  @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  \r
-                               It is the caller's responsibility to free this buffer using FreePool().\r
+  @param  SectionType          Indicates the FFS section type to search for within  \r
+                               the FFS file that the currently executing module \r
+                               was loaded from.\r
+  @param  SectionInstance      Indicates which section instance to retrieve within \r
+                               the FFS file that the currently executing module \r
+                               was loaded from.\r
+  @param  Buffer               On output, a pointer to a callee allocated buffer \r
+                               containing the FFS file section that was found.  \r
+                               It is the caller's responsibility to free this buffer \r
+                               using FreePool().\r
   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.\r
 \r
   @retval  EFI_SUCCESS          The specified FFS section was returned.\r
   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.\r
-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
-  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.\r
-  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that \r
-                                contains the matching FFS section does not allow reads.  \r
+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+                                the matching FFS section.\r
+  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a \r
+                                device error.\r
+  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the \r
+                                firmware volume that contains the matching FFS \r
+                                section does not allow reads.  \r
   \r
 **/\r
 EFI_STATUS\r
@@ -167,17 +189,19 @@ GetSectionFromFfs (
   If FileSize is NULL, then NULL is returned.\r
   If AuthenticationStatus is NULL, then NULL is returned.\r
 \r
-  @param[in]       BootPolicy           Policy for Open Image File.If TRUE, indicates that the request \r
-                                        originates from the boot manager, and that the boot manager is\r
-                                        attempting to load FilePath as a boot selection. If FALSE, \r
-                                        then FilePath must match an exact file to be loaded.\r
-  @param[in]       FilePath             Pointer to the device path of the file that is absracted to\r
+  @param[in]       BootPolicy           The policy for Open Image File.If TRUE, \r
+                                        indicates that the request originates from \r
+                                        the boot manager, and that the boot manager is\r
+                                        attempting to load FilePath as a boot selection. \r
+                                        If FALSE, then FilePath must match an exact \r
+                                        file to be loaded.\r
+  @param[in]       FilePath             Pointer to the device path of the file that is abstracted to\r
                                         the file buffer.\r
   @param[out]      FileSize             Pointer to the size of the abstracted file buffer.\r
   @param[out]      AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication\r
                                         status is returned.\r
 \r
-  @retval NULL   File is NULL, or FileSize is NULL. Or the file can't be found.\r
+  @retval NULL   File is NULL, or FileSize is NULL, or the file can't be found.\r
   @retval other  The abstracted file buffer. The caller is responsible to free memory.\r
 **/\r
 VOID *\r
index e14ea2043380b7285c64d4210b384d01a20ad004..0308bef97d2e409d77d968e5de54612e09d30542 100644 (file)
@@ -1,11 +1,11 @@
 /** @file\r
   Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation                                                         \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
-http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -25,8 +25,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If Pe32Data is NULL, then ASSERT().\r
   If EntryPoint is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data                  Pointer to the PE/COFF image that is loaded in system memory.\r
-  @param  EntryPoint                Pointer to entry point to the PE/COFF image to return.\r
+  @param  Pe32Data                  The pointer to the PE/COFF image that is loaded in system memory.\r
+  @param  EntryPoint                The pointer to entry point to the PE/COFF image to return.\r
 \r
   @retval RETURN_SUCCESS            EntryPoint was returned.\r
   @retval RETURN_INVALID_PARAMETER  The entry point could not be found in the PE/COFF image.\r
@@ -45,7 +45,7 @@ PeCoffLoaderGetEntryPoint (
   Returns the machine type from the PE/COFF image specified by Pe32Data.\r
   If Pe32Data is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
+  @param  Pe32Data   The pointer to the PE/COFF image that is loaded in system\r
                      memory.\r
 \r
   @return Machine type or zero if not a valid image.\r
@@ -69,10 +69,10 @@ PeCoffLoaderGetMachineType (
   then NULL is returned.\r
   If Pe32Data is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
+  @param  Pe32Data   The pointer to the PE/COFF image that is loaded in system\r
                      memory.\r
 \r
-  @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL\r
+  @return The PDB file name for the PE/COFF image specified by Pe32Data, or NULL\r
           if it cannot be retrieved.\r
 \r
 **/\r
@@ -89,10 +89,10 @@ PeCoffLoaderGetPdbPointer (
   Returns the size of the PE/COFF header specified by Pe32Data.\r
   If Pe32Data is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
+  @param  Pe32Data   The pointer to the PE/COFF image that is loaded in system\r
                      memory.\r
 \r
-  @return Size of PE/COFF header in bytes or zero if not a valid image.\r
+  @return Size of PE/COFF header in bytes, or zero if not a valid image.\r
 \r
 **/\r
 UINT32\r
index fabce4b122842375f03da3f3edca49e8c93fe647..44f30d686f623624af23869eb9944aa473183977 100644 (file)
@@ -5,12 +5,11 @@
   IA-32, x86, IPF, and EBC processor types. The library functions are memory-based \r
   and can be ported easily to any environment.\r
   \r
-Copyright (c) 2006 - 2008, 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
-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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -60,9 +59,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                           On output, the number of bytes actually read.\r
   @param  Buffer          Output buffer that contains the data read from the PE/COFF image.\r
   \r
-  @retval RETURN_SUCCESS            The specified portion of the PE/COFF image was read and the size \r
-  @retval RETURN_DEVICE_ERROR       The specified portion of the PE/COFF image could not be read due \r
-                                    to a device error.\r
+  @retval RETURN_SUCCESS            The specified portion of the PE/COFF image was \r
+                                    read and the size \r
+  @retval RETURN_DEVICE_ERROR       The specified portion of the PE/COFF image \r
+                                    could not be read due to a device error.\r
 \r
 **/\r
 typedef\r
@@ -75,20 +75,20 @@ RETURN_STATUS
   );\r
 \r
 ///\r
-/// Context structure used while PE/COFF image is being loaded and relocated\r
+/// The context structure used while PE/COFF image is being loaded and relocated.\r
 ///\r
 typedef struct {\r
   ///\r
-  /// Is set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header\r
+  /// Set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header.\r
   ///\r
   PHYSICAL_ADDRESS                  ImageAddress;\r
   ///\r
-  /// Is set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.\r
+  /// Set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.\r
   /// Image size includes the size of Debug Entry if it is present.\r
   ///\r
   UINT64                            ImageSize;\r
   ///\r
-  /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non zero,\r
+  /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non-zero,\r
   /// PeCoffLoaderRelocateImage() will relocate the image using this base address.\r
   /// If the DestinationAddress is zero, the ImageAddress will be used as the base\r
   /// address of relocation.\r
@@ -115,18 +115,18 @@ typedef struct {
   ///\r
   VOID                              *FixupData;\r
   ///\r
-  /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header\r
+  /// Set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.\r
   /// If the image is a TE image, then this field is set to 0.\r
   ///\r
   UINT32                            SectionAlignment;\r
   ///\r
   /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.\r
-  /// If the PE/COFF image does not start with a DOS header, this value is zero; \r
-  /// otherwise, it's the offset to the PE/COFF header.\r
+  /// If the PE/COFF image does not start with a DOS header, this value is zero. \r
+  /// Otherwise, it's the offset to the PE/COFF header.\r
   ///\r
   UINT32                            PeCoffHeaderOffset;\r
   ///\r
-  /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory\r
+  /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory,\r
   /// if it exists in the image\r
   ///\r
   UINT32                            DebugDirectoryEntryRva;\r
@@ -155,7 +155,7 @@ typedef struct {
   /// Not used by this library class. Other library classes that layer on top of this library \r
   /// class fill in this value as part of their GetImageInfo call.\r
   /// This allows the caller of the library to know what type of memory needs to be allocated\r
-  /// to load and relocate the image\r
+  /// to load and relocate the image.\r
   ///\r
   UINT32                            ImageDataMemoryType;\r
   ///\r
@@ -164,11 +164,11 @@ typedef struct {
   UINT32                            ImageError;\r
   ///\r
   /// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must\r
-  /// allocate before calling PeCoffLoaderRelocateImage()\r
+  /// allocate before calling PeCoffLoaderRelocateImage().\r
   ///\r
   UINTN                             FixupDataSize;\r
   ///\r
-  /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header\r
+  /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header.\r
   ///\r
   UINT16                            Machine;\r
   ///\r
@@ -188,8 +188,8 @@ typedef struct {
   BOOLEAN                           IsTeImage;\r
   ///\r
   /// Set by PeCoffLoaderLoadImage() to the HII resource offset\r
-  /// if the image contains a custom PE/COFF resource with the type 'HII';\r
-  /// otherwise, the entry remains to be 0.\r
+  /// if the image contains a custom PE/COFF resource with the type 'HII'.\r
+  /// Otherwise, the entry remains to be 0.\r
   ///\r
   PHYSICAL_ADDRESS                  HiiResourceData;\r
   ///\r
@@ -213,8 +213,9 @@ typedef struct {
   The ImageRead and Handle fields of ImageContext structure must be valid prior \r
   to invoking this service.\r
 \r
-  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
-                                    image that needs to be examined by this function.\r
+  @param  ImageContext              The pointer to the image context structure that \r
+                                    describes the PE/COFF image that needs to be \r
+                                    examined by this function.\r
 \r
   @retval RETURN_SUCCESS            The information on the PE/COFF image was collected.\r
   @retval RETURN_INVALID_PARAMETER  ImageContext is NULL.\r
@@ -246,7 +247,7 @@ PeCoffLoaderGetImageInfo (
   cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
   prior to transferring control to a PE/COFF image that is loaded using this library.\r
 \r
-  @param  ImageContext        Pointer to the image context structure that describes the PE/COFF\r
+  @param  ImageContext        The pointer to the image context structure that describes the PE/COFF\r
                               image that is being relocated.\r
 \r
   @retval RETURN_SUCCESS      The PE/COFF image was relocated.\r
@@ -280,7 +281,7 @@ PeCoffLoaderRelocateImage (
   cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
   prior to transferring control to a PE/COFF image that is loaded using this library.\r
 \r
-  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
+  @param  ImageContext              The pointer to the image context structure that describes the PE/COFF\r
                                     image that is being loaded.\r
 \r
   @retval RETURN_SUCCESS            The PE/COFF image was loaded into the buffer specified by\r
@@ -315,13 +316,13 @@ PeCoffLoaderLoadImage (
   If ReadSize is NULL, then ASSERT().\r
   If Buffer is NULL, then ASSERT().\r
 \r
-  @param  FileHandle        Pointer to base of the input stream\r
+  @param  FileHandle        The pointer to base of the input stream\r
   @param  FileOffset        Offset into the PE/COFF image to begin the read operation.\r
   @param  ReadSize          On input, the size in bytes of the requested read operation.  \r
                             On output, the number of bytes actually read.\r
   @param  Buffer            Output buffer that contains the data read from the PE/COFF image.\r
 \r
-  @retval RETURN_SUCCESS    Data is read from FileOffset from the Handle into \r
+  @retval RETURN_SUCCESS    The data is read from FileOffset from the Handle into \r
                             the buffer.\r
 **/\r
 RETURN_STATUS\r
@@ -348,7 +349,7 @@ PeCoffLoaderImageReadFromMemory (
   cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
   prior to transferring control to a PE/COFF image that is loaded using this library.\r
 \r
-  @param  ImageBase          Base address of a PE/COFF image that has been loaded \r
+  @param  ImageBase          The base address of a PE/COFF image that has been loaded \r
                              and relocated into system memory.\r
   @param  VirtImageBase      The request virtual address that the PE/COFF image is to\r
                              be fixed up for.\r
index 2b020384ef2d4ca24cfadcf67541c4c91c2b8a18..59c3e112067415c83eef56cf89828b535013cccb 100644 (file)
@@ -2,11 +2,11 @@
   Provides services to print a formatted string to a buffer. All combinations of\r
   Unicode and ASCII strings are supported.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation\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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -177,8 +177,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 ///\r
 /// Define the maximum number of characters that are required to\r
-/// encode a decimal, hexadecimal, GUID, or TIME value with a NULL \r
-/// terminator.\r
+/// encode with a NULL terminator a decimal, hexadecimal, GUID,   \r
+/// or TIME value.\r
 ///  \r
 ///  Maximum Length Decimal String     = 28\r
 ///    "-9,223,372,036,854,775,808"\r
@@ -202,14 +202,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 /**\r
   Produces a Null-terminated Unicode string in an output buffer based on \r
-  a Null-terminated Unicode format string and a VA_LIST argument list\r
+  a Null-terminated Unicode format string and a VA_LIST argument list.\r
   \r
   Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
   and BufferSize.  \r
   The Unicode string is produced by parsing the format string specified by FormatString.  \r
   Arguments are pulled from the variable argument list specified by Marker based on the \r
   contents of the format string.  \r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  The number of Unicode characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -218,10 +218,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
   ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
@@ -230,7 +230,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param  FormatString    Null-terminated Unicode format string.\r
   @param  Marker          VA_LIST marker for the variable argument list.\r
   \r
-  @return The number of Unicode characters in the produced output buffer not including the\r
+  @return The number of Unicode characters in the produced output buffer, not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -245,14 +245,14 @@ UnicodeVSPrint (
 \r
 /**\r
   Produces a Null-terminated Unicode string in an output buffer based on \r
-  a Null-terminated Unicode format string and a BASE_LIST argument list\r
+  a Null-terminated Unicode format string and a BASE_LIST argument list.\r
   \r
   Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
   and BufferSize.  \r
   The Unicode string is produced by parsing the format string specified by FormatString.  \r
   Arguments are pulled from the variable argument list specified by Marker based on the \r
   contents of the format string.  \r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  The number of Unicode characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -261,10 +261,10 @@ UnicodeVSPrint (
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
   ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
@@ -273,7 +273,7 @@ UnicodeVSPrint (
   @param  FormatString    Null-terminated Unicode format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
   \r
-  @return The number of Unicode characters in the produced output buffer not including the\r
+  @return The number of Unicode characters in the produced output buffer, not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -294,7 +294,7 @@ UnicodeBSPrint (
   and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  The number of Unicode characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -312,11 +312,11 @@ UnicodeBSPrint (
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    A null-terminated Unicode format string.\r
+  @param  ...             The variable argument list whose contents are accessed based on the \r
                           format string specified by FormatString.\r
   \r
-  @return The number of Unicode characters in the produced output buffer not including the\r
+  @return The number of Unicode characters in the produced output buffer, not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -338,7 +338,7 @@ UnicodeSPrint (
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on the \r
   contents of the format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  The number of Unicode characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -346,16 +346,16 @@ UnicodeSPrint (
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
   ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
+  @param  FormatString    A null-terminated ASCII format string.\r
   @param  Marker          VA_LIST marker for the variable argument list.\r
   \r
   @return The number of Unicode characters in the produced output buffer not including the\r
@@ -380,7 +380,7 @@ UnicodeVSPrintAsciiFormat (
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on the \r
   contents of the format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  The number of Unicode characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -388,19 +388,19 @@ UnicodeVSPrintAsciiFormat (
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
   ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
-  @param  Marker          BASE_LIST marker for the variable argument list.\r
+  @param  FormatString    A null-terminated ASCII format string.\r
+  @param  Marker          BASE_LIST marker for the variable argument list.\r
   \r
-  @return The number of Unicode characters in the produced output buffer not including the\r
+  @return The number of Unicode characters in the produced output buffer, not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -422,7 +422,7 @@ UnicodeBSPrintAsciiFormat (
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the \r
   format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  The number of Unicode characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -430,20 +430,20 @@ UnicodeBSPrintAsciiFormat (
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
   ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  contains more than PcdMaximumUnicodeStringLength Unicode characters, the\r
   Null-terminator, then ASSERT().\r
 \r
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
+  @param  FormatString    A null-terminated ASCII format string.\r
   @param  ...             Variable argument list whose contents are accessed based on the \r
                           format string specified by FormatString.\r
   \r
-  @return The number of Unicode characters in the produced output buffer not including the\r
+  @return The number of Unicode characters in the produced output buffer, not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -462,7 +462,7 @@ UnicodeSPrintAsciiFormat (
   Converts the decimal number specified by Value to a Null-terminated Unicode \r
   string specified by Buffer containing at most Width characters. No padding of spaces \r
   is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
-  The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
+  The number of Unicode characters in Buffer is returned, not including the Null-terminator.\r
   If the conversion contains more than Width characters, then only the first\r
   Width characters are returned, and the total number of characters \r
   required to perform the conversion is returned.\r
@@ -487,14 +487,14 @@ UnicodeSPrintAsciiFormat (
   If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
   If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
 \r
-  @param  Buffer  Pointer to the output buffer for the produced Null-terminated\r
+  @param  Buffer  The pointer to the output buffer for the produced Null-terminated\r
                   Unicode string.\r
   @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.\r
   @param  Value   The 64-bit signed value to convert to a string.\r
   @param  Width   The maximum number of Unicode characters to place in Buffer, not including\r
                   the Null-terminator.\r
   \r
-  @return The number of Unicode characters in Buffer not including the Null-terminator.\r
+  @return The number of Unicode characters in Buffer, not including the Null-terminator.\r
 \r
 **/\r
 UINTN\r
@@ -515,26 +515,26 @@ UnicodeValueToString (
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on \r
   the contents of the format string.\r
-  The number of ASCII characters in the produced output buffer is returned not including\r
+  The number of ASCII characters in the produced output buffer is returned, not including\r
   the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
   ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
-  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+  contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
   Null-terminator, then ASSERT().\r
 \r
   @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
                  &nbs