Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Acpi10.h

diff --git a/MdePkg/Include/IndustryStandard/Acpi10.h b/MdePkg/Include/IndustryStandard/Acpi10.h
index b463d6ff280b1280563f3c8937fed7aa7b171555..f05346a50d469a46d25549092628964730b17df2 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Acpi10.h
+++ b/MdePkg/Include/IndustryStandard/Acpi10.h
@@ -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