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

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

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index 5922d536f163154da8851e5ee9e8917c90c55c1f..134567da4b5f3dc403a7f929dfe04f61d37664fb 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -1,14 +1,14 @@
 /** @file\r
   GUID used to identify Data Hub records logged by Status Code Protocol.\r
   \r
 /** @file\r
   GUID used to identify Data Hub records logged by Status Code Protocol.\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
 \r
 **/\r
 \r


@@ -16,7 +16,7 @@
 #define __DATA_HUB_STATUS_CODE_RECORD_H__\r
 \r
 ///\r
 #define __DATA_HUB_STATUS_CODE_RECORD_H__\r
 \r
 ///\r

-/// Global ID used to identify a structure of type DATA_HUB_STATUS_CODE_DATA_RECORD\r
+/// The Global ID used to identify a structure of type DATA_HUB_STATUS_CODE_DATA_RECORD.\r

 ///\r
 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \\r
   { \\r
 ///\r
 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \\r
   { \\r


@@ -24,7 +24,7 @@
   }\r
 \r
 ///\r
   }\r
 \r
 ///\r

-/// Data Hub data record that is used to store all the parameters passed into\r
+/// The Data Hub data record that is used to store all the parameters passed into\r

 /// the ReportStatusCode() service of the EFI_STATUS_CODE_PROTOCOL.\r
 ///\r
 typedef struct {\r
 /// the ReportStatusCode() service of the EFI_STATUS_CODE_PROTOCOL.\r
 ///\r
 typedef struct {\r


@@ -41,7 +41,7 @@ typedef struct {
 \r
   ///\r
   /// The enumeration of a hardware or software entity within\r
 \r
   ///\r
   /// The enumeration of a hardware or software entity within\r

-  /// the system.  Valid instance numbers start with 1\r
+  /// the system.  Valid instance numbers start with 1.\r

   ///\r
   UINT32                 Instance;\r
 \r
   ///\r
   UINT32                 Instance;\r
 \r


@@ -51,7 +51,7 @@ typedef struct {
   EFI_GUID               CallerId;\r
 \r
   ///\r
   EFI_GUID               CallerId;\r
 \r
   ///\r

-  /// Additional status code data\r
+  /// Additional status code data.\r

   ///\r
   EFI_STATUS_CODE_DATA   Data;\r
 } DATA_HUB_STATUS_CODE_DATA_RECORD;\r
   ///\r
   EFI_STATUS_CODE_DATA   Data;\r
 } DATA_HUB_STATUS_CODE_DATA_RECORD;\r

diff --git a/IntelFrameworkModulePkg/Include/Guid/IntelFrameworkModulePkgTokenSpace.h b/IntelFrameworkModulePkg/Include/Guid/IntelFrameworkModulePkgTokenSpace.h
index ac674b03454affe2ceeacd133c1001c4b4cfbbc4..d6f7d7f69b5fae422f331327cd3ea3ee957eb44c 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/IntelFrameworkModulePkgTokenSpace.h
+++ b/IntelFrameworkModulePkg/Include/Guid/IntelFrameworkModulePkgTokenSpace.h
@@ -1,22 +1,21 @@
 /** @file\r
   GUID for IntelFrameworkModulePkg PCD Token Space \r
 \r
 /** @file\r
   GUID for IntelFrameworkModulePkg PCD Token Space \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
-\r
+Copyright (c) 2009 - 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 _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_\r
 #define _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_\r
 \r
 ///\r
 **/\r
 \r
 #ifndef _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_\r
 #define _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_\r
 \r
 ///\r

-/// Global ID for the IntelFrameworkModulePkg PCD Token Space \r
+/// The Global ID for the IntelFrameworkModulePkg PCD Token Space .\r

 ///\r
 #define INTEL_FRAMEWORK_MODULEPKG_TOKEN_SPACE_GUID \\r
   { \\r
 ///\r
 #define INTEL_FRAMEWORK_MODULEPKG_TOKEN_SPACE_GUID \\r
   { \\r

diff --git a/IntelFrameworkModulePkg/Include/Guid/LzmaDecompress.h b/IntelFrameworkModulePkg/Include/Guid/LzmaDecompress.h
index 554f0c615b9614a66f930e81b339f988f06d5531..3eba33a7ca22dba76b4c9e9698f8a515378aeecc 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/LzmaDecompress.h
+++ b/IntelFrameworkModulePkg/Include/Guid/LzmaDecompress.h
@@ -1,13 +1,13 @@
 /** @file\r
 /** @file\r

-  Lzma Custom decompress algorithm Guid definition\r
+  Lzma Custom decompress algorithm Guid definition.\r

 \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
+Copyright (c) 2009 - 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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r


@@ -16,8 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __LZMA_DECOMPRESS_GUID_H__\r
 \r
 ///\r
 #define __LZMA_DECOMPRESS_GUID_H__\r
 \r
 ///\r

-/// Global ID used to identify a section of an FFS file of type \r
-/// EFI_SECTION_GUID_DEFINED whose contents have been compressed using LZMA.\r
+/// The Global ID used to identify a section of an FFS file of type \r
+/// EFI_SECTION_GUID_DEFINED, whose contents have been compressed using LZMA.\r

 ///\r
 #define LZMA_CUSTOM_DECOMPRESS_GUID  \\r
   { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF } }\r
 ///\r
 #define LZMA_CUSTOM_DECOMPRESS_GUID  \\r
   { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF } }\r

diff --git a/IntelFrameworkModulePkg/Include/Guid/TianoDecompress.h b/IntelFrameworkModulePkg/Include/Guid/TianoDecompress.h
index 7b978890507dac1cd1a7a06928b97f79104f375f..792cf5a3d8f6218063884d46077c1455981a7557 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/TianoDecompress.h
+++ b/IntelFrameworkModulePkg/Include/Guid/TianoDecompress.h
@@ -1,13 +1,13 @@
 /** @file\r
 /** @file\r

-  Tiano Custom decompress Guid definition\r
+  Tiano Custom decompress Guid definition.\r

   \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
+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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r


@@ -16,8 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __TIANO_CUSTOM_DECOMPRESS_GUID_H__\r
 \r
 ///\r
 #define __TIANO_CUSTOM_DECOMPRESS_GUID_H__\r
 \r
 ///\r

-/// Global ID used to identify a section of an FFS file of type \r
-/// EFI_SECTION_GUID_DEFINED whose contents have been compressed using \r
+/// The Global ID used to identify a section of an FFS file of type \r
+/// EFI_SECTION_GUID_DEFINED, whose contents have been compressed using \r

 /// Tiano Custom compression.\r
 ///\r
 #define TIANO_CUSTOM_DECOMPRESS_GUID  \\r
 /// Tiano Custom compression.\r
 ///\r
 #define TIANO_CUSTOM_DECOMPRESS_GUID  \\r

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index 8a0311597a98ab7efa6fb0eb03cfaf37a2b08418..6010b988550d7e122c2ad1d5a9bed31039137bb6 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -1,16 +1,16 @@
 /** @file\r
 /** @file\r

-  Generic BDS library defines general interfaces for BDS driver including:\r
-    1) BDS boot policy interface\r
-    2) BDS boot device connect interface\r
+  Generic BDS library defines general interfaces for a BDS driver, including:\r
+    1) BDS boot policy interface.\r
+    2) BDS boot device connect interface.\r

     3) BDS Misc interfaces for mainting boot variable, ouput string.\r
 \r
     3) BDS Misc interfaces for mainting boot variable, ouput string.\r
 \r

-Copyright (c) 2004 - 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
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+Copyright (c) 2004 - 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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r


@@ -22,12 +22,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 extern EFI_HANDLE mBdsImageHandle;\r
 \r
 ///\r
 extern EFI_HANDLE mBdsImageHandle;\r
 \r
 ///\r

-/// Constants which are variable names used to access variables\r
+/// Constants which are variable names used to access variables.\r

 ///\r
 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"\r
 \r
 ///\r
 ///\r
 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"\r
 \r
 ///\r

-/// Data structures and defines\r
+/// Data structures and defines.\r

 ///\r
 #define FRONT_PAGE_QUESTION_ID  0x0000\r
 #define FRONT_PAGE_DATA_WIDTH   0x01\r
 ///\r
 #define FRONT_PAGE_QUESTION_ID  0x0000\r
 #define FRONT_PAGE_DATA_WIDTH   0x01\r


@@ -58,13 +58,13 @@ extern EFI_HANDLE mBdsImageHandle;
 #define IS_LOAD_OPTION_TYPE(_c, _Mask)  (BOOLEAN) (((_c) & (_Mask)) != 0)\r
 \r
 ///\r
 #define IS_LOAD_OPTION_TYPE(_c, _Mask)  (BOOLEAN) (((_c) & (_Mask)) != 0)\r
 \r
 ///\r

-/// Define Maximum characters that will be accepted\r
+/// Define the maximum characters that will be accepted.\r

 ///\r
 #define MAX_CHAR            480\r
 #define MAX_CHAR_SIZE       (MAX_CHAR * 2)\r
 \r
 ///\r
 ///\r
 #define MAX_CHAR            480\r
 #define MAX_CHAR_SIZE       (MAX_CHAR * 2)\r
 \r
 ///\r

-/// Define maximum characters for boot option variable "BootXXXX"\r
+/// Define maximum characters for boot option variable "BootXXXX".\r

 ///\r
 #define BOOT_OPTION_MAX_CHAR 10\r
 \r
 ///\r
 #define BOOT_OPTION_MAX_CHAR 10\r
 \r


@@ -112,15 +112,15 @@ BdsLibBootNext (
 /**\r
   Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.\r
 \r
 /**\r
   Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.\r
 \r

-  @param  Option                 The boot option to be processed\r
+  @param  Option                 The boot option to be processed.\r

   @param  DevicePath             The device path describing where to load the\r
                                  boot image or the legcy BBS device path to boot\r
   @param  DevicePath             The device path describing where to load the\r
                                  boot image or the legcy BBS device path to boot\r

-                                 the legacy OS\r
+                                 the legacy OS.\r

   @param  ExitDataSize           The size of exit data.\r
   @param  ExitData               Data returned when Boot image failed.\r
 \r
   @retval EFI_SUCCESS            Boot from the input boot option succeeded.\r
   @param  ExitDataSize           The size of exit data.\r
   @param  ExitData               Data returned when Boot image failed.\r
 \r
   @retval EFI_SUCCESS            Boot from the input boot option succeeded.\r

-  @retval EFI_NOT_FOUND          The Device Path is not found in the system\r
+  @retval EFI_NOT_FOUND          The Device Path is not found in the system.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -174,12 +174,13 @@ BdsLibBootViaBootOption (
   It will excute once every boot.\r
   \r
   @param  BdsBootOptionList      The header of the linked list that indexed all\r
   It will excute once every boot.\r
   \r
   @param  BdsBootOptionList      The header of the linked list that indexed all\r

-                                 current boot options\r
+                                 current boot options.\r

 \r
 \r

-  @retval EFI_SUCCESS            Finished all the boot device enumerations and created\r
-                                 the boot option based on the boot device\r
+  @retval EFI_SUCCESS            Finished all the boot device enumerations and \r
+                                 created the boot option based on the boot device.\r

 \r
 \r

-  @retval EFI_OUT_OF_RESOURCES   Failed to enumerate the boot device and create the boot option list\r
+  @retval EFI_OUT_OF_RESOURCES   Failed to enumerate the boot device and create \r
+                                 the boot option list.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -188,12 +189,12 @@ BdsLibEnumerateAllBootOption (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Build the boot option with the handle parsed in\r
+  Build the boot option with the handle parsed in.\r

 \r
 \r

-  @param  Handle                 The handle representing the device path for which to create\r
-                                 boot option\r
-  @param  BdsBootOptionList      The header of the link list which indexed all\r
-                                 current boot options\r
+  @param  Handle                 The handle representing the device path for which \r
+                                 to create a boot option.\r
+  @param  BdsBootOptionList      The header of the link list that indexed all\r
+                                 current boot options.\r

   @param  String                 The description of the boot option.\r
 \r
 **/\r
   @param  String                 The description of the boot option.\r
 \r
 **/\r


@@ -210,9 +211,9 @@ BdsLibBuildOptionFromHandle (
   Build the on flash shell boot option with the handle parsed in.\r
 \r
   @param  Handle                 The handle which present the device path to create\r
   Build the on flash shell boot option with the handle parsed in.\r
 \r
   @param  Handle                 The handle which present the device path to create\r

-                                 on flash shell boot option\r
-  @param  BdsBootOptionList      The header of the link list which indexed all\r
-                                 current boot options\r
+                                 the on flash shell boot option.\r
+  @param  BdsBootOptionList      The header of the link list that indexed all\r
+                                 current boot options.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -226,11 +227,11 @@ BdsLibBuildOptionFromShell (
 // Bds misc lib functions\r
 //\r
 /**\r
 // Bds misc lib functions\r
 //\r
 /**\r

-  Get boot mode by looking up configuration table and parsing HOB list\r
+  Get boot mode by looking up the configuration table and parsing the HOB list.\r

 \r
 \r

-  @param  BootMode              Boot mode from PEI handoff HOB.\r
+  @param  BootMode              The boot mode from PEI handoff HOB.\r

 \r
 \r

-  @retval EFI_SUCCESS           Successfully get boot mode\r
+  @retval EFI_SUCCESS           Successfully got boot mode.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -244,7 +245,7 @@ BdsLibGetBootMode (
   The function will go through the driver option link list, and then load and start\r
   every driver to which the driver option device path points.\r
 \r
   The function will go through the driver option link list, and then load and start\r
   every driver to which the driver option device path points.\r
 \r

-  @param  BdsDriverLists        The header of the current driver option link list\r
+  @param  BdsDriverLists        The header of the current driver option link list.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -259,14 +260,14 @@ BdsLibLoadDrivers (
 \r
   BdsLibVariableToOption () for each UINT16 in the variables.\r
 \r
 \r
   BdsLibVariableToOption () for each UINT16 in the variables.\r
 \r

-  @param  BdsCommonOptionList   The header of the option list base on variable\r
-                                VariableName\r
-  @param  VariableName          EFI Variable name indicate the BootOrder or\r
-                                DriverOrder\r
+  @param  BdsCommonOptionList   The header of the option list base on the variable\r
+                                VariableName.\r
+  @param  VariableName          An EFI Variable name indicate the BootOrder or\r
+                                DriverOrder.\r

 \r
 \r

-  @retval EFI_SUCCESS           Success create the boot option or driver option\r
-                                list\r
-  @retval EFI_OUT_OF_RESOURCES  Failed to get the boot option or driver option list\r
+  @retval EFI_SUCCESS           Successfully created the boot option or driver option\r
+                                list.\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to get the boot option or the driver option list.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -277,15 +278,16 @@ BdsLibBuildOptionFromVar (
 \r
 /**\r
   This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated\r
 \r
 /**\r
   This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated\r

-  buffer and the size of the buffer. If failure, return NULL.\r
+  buffer and the size of the buffer. If it fails, return NULL.\r

 \r
 \r

-  @param  Name                  String part of EFI variable name\r
-  @param  VendorGuid            GUID part of EFI variable name\r
-  @param  VariableSize          Returns the size of the EFI variable that was read\r
+  @param  Name                  The string part of the  EFI variable name.\r
+  @param  VendorGuid            The GUID part of the EFI variable name.\r
+  @param  VariableSize          Returns the size of the EFI variable that was read.\r

 \r
 \r

-  @return                       Dynamically allocated memory that contains a copy of the EFI variable\r
-                                Caller is responsible freeing the buffer.\r
-  @retval NULL                  Variable was not read\r
+  @return                       Dynamically allocated memory that contains a copy \r
+                                of the EFI variable. The caller is responsible for \r
+                                freeing the buffer.\r
+  @retval NULL                  The variable was not read.\r

 \r
 **/\r
 VOID *\r
 \r
 **/\r
 VOID *\r


@@ -300,11 +302,11 @@ BdsLibGetVariableAndSize (
 /**\r
   This function prints a series of strings.\r
 \r
 /**\r
   This function prints a series of strings.\r
 \r

-  @param  ConOut                Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
-  @param  ...                   A variable argument list containing series of\r
+  @param  ConOut                A pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
+  @param  ...                   A variable argument list containing a series of\r

                                 strings, the last string must be NULL.\r
 \r
                                 strings, the last string must be NULL.\r
 \r

-  @retval EFI_SUCCESS           Success print out the string using ConOut.\r
+  @retval EFI_SUCCESS           Successfully printed out the string using ConOut.\r

   @retval EFI_STATUS            Return the status of the ConOut->OutputString ().\r
 \r
 **/\r
   @retval EFI_STATUS            Return the status of the ConOut->OutputString ().\r
 \r
 **/\r


@@ -320,12 +322,12 @@ BdsLibOutputStrings (
   build boot#### or driver#### will also be linked to BdsCommonOptionList.\r
 \r
   @param  BdsCommonOptionList   The header of the boot#### or driver#### option\r
   build boot#### or driver#### will also be linked to BdsCommonOptionList.\r
 \r
   @param  BdsCommonOptionList   The header of the boot#### or driver#### option\r

-                                link list\r
+                                link list.\r

   @param  VariableName          EFI Variable name, indicates if it is boot#### or\r
   @param  VariableName          EFI Variable name, indicates if it is boot#### or\r

-                                driver####\r
+                                driver####.\r

 \r
 \r

-  @retval BDS_COMMON_OPTION     The option that was created\r
-  @retval NULL                  Failed to get the new option\r
+  @retval BDS_COMMON_OPTION     The option that was created.\r
+  @retval NULL                  Failed to get the new option.\r

 \r
 **/\r
 BDS_COMMON_OPTION *\r
 \r
 **/\r
 BDS_COMMON_OPTION *\r


@@ -341,14 +343,14 @@ BdsLibVariableToOption (
   to BdsOptionList and also update to the VariableName. After the boot#### or\r
   driver#### updated, the BootOrder or DriverOrder will also be updated.\r
 \r
   to BdsOptionList and also update to the VariableName. After the boot#### or\r
   driver#### updated, the BootOrder or DriverOrder will also be updated.\r
 \r

-  @param  BdsOptionList         The header of the boot#### or driver#### link list\r
-  @param  DevicePath            The device path which the boot#### or driver####\r
-                                option present\r
-  @param  String                The description of the boot#### or driver####\r
-  @param  VariableName          Indicate if the boot#### or driver#### option\r
+  @param  BdsOptionList         The header of the boot#### or driver#### link list.\r
+  @param  DevicePath            The device path that the boot#### or driver####\r
+                                option present.\r
+  @param  String                The description of the boot#### or driver####.\r
+  @param  VariableName          Indicate if the boot#### or driver#### option.\r

 \r
 \r

-  @retval EFI_SUCCESS           The boot#### or driver#### have been success\r
-                                registered\r
+  @retval EFI_SUCCESS           The boot#### or driver#### have been successfully\r
+                                registered.\r

   @retval EFI_STATUS            Return the status of gRT->SetVariable ().\r
 \r
 **/\r
   @retval EFI_STATUS            Return the status of gRT->SetVariable ().\r
 \r
 **/\r


@@ -386,16 +388,16 @@ BdsLibConnectAll (
 \r
 /**\r
   This function creates all handles associated with the given device\r
 \r
 /**\r
   This function creates all handles associated with the given device\r

-  path node. If the handle associated with one device path node can not\r
+  path node. If the handle associated with one device path node cannot\r

   be created, then it tries to execute the dispatch to load the missing drivers.  \r
 \r
   @param  DevicePathToConnect   The device path to be connected. Can be\r
   be created, then it tries to execute the dispatch to load the missing drivers.  \r
 \r
   @param  DevicePathToConnect   The device path to be connected. Can be\r

-                                a multi-instance device path\r
+                                a multi-instance device path.\r

 \r
   @retval EFI_SUCCESS           All handles associates with every device path node\r
 \r
   @retval EFI_SUCCESS           All handles associates with every device path node\r

-                                were created\r
-  @retval EFI_OUT_OF_RESOURCES  Not enough resources to create new handles\r
-  @retval EFI_NOT_FOUND         At least one handle could not be created\r
+                                were created.\r
+  @retval EFI_OUT_OF_RESOURCES  Not enough resources to create new handles.\r
+  @retval EFI_NOT_FOUND         At least one handle could not be created.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -405,8 +407,13 @@ BdsLibConnectDevicePath (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  This function will connect all current system handles recursively.     gBS->ConnectController() service is invoked for each handle exist in system handler buffer.  If the handle is bus type handler, all childrens also will be connected recursively  by gBS->ConnectController().\r
-  @retval EFI_SUCCESS           All handles and child handles have been                                connected  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().\r
+  This function will connect all current system handles recursively.     \r
+  gBS->ConnectController() service is invoked for each handle exist in system handler buffer.  \r
+  If the handle is bus type handler, all childrens also will be connected recursively  by gBS->ConnectController().\r
+  \r
+  @retval EFI_SUCCESS           All handles and child handles have been\r
+                                connected.  \r
+  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -415,8 +422,11 @@ BdsLibConnectAllEfi (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  This function will disconnect all current system handles.     gBS->DisconnectController() is invoked for each handle exists in system handle buffer.  If handle is a bus type handle, all childrens also are disconnected recursively by  gBS->DisconnectController().\r
-  @retval EFI_SUCCESS           All handles have been disconnected\r
+  This function will disconnect all current system handles.     \r
+  gBS->DisconnectController() is invoked for each handle exists in system handle buffer.  \r
+  If handle is a bus type handle, all childrens also are disconnected recursively by  gBS->DisconnectController().\r
+  \r
+  @retval EFI_SUCCESS           All handles have been disconnected.\r

   @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r
 \r
 **/\r
   @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r
 \r
 **/\r


@@ -460,12 +470,12 @@ BdsLibConnectAllDefaultConsoles (
   This function updates the console variable based on ConVarName. It can\r
   add or remove one specific console device path from the variable\r
 \r
   This function updates the console variable based on ConVarName. It can\r
   add or remove one specific console device path from the variable\r
 \r

-  @param  ConVarName               Console-related variable name: ConIn, ConOut,\r
+  @param  ConVarName               The console-related variable name: ConIn, ConOut,\r

                                    ErrOut.\r
   @param  CustomizedConDevicePath  The console device path to be added to\r
                                    ErrOut.\r
   @param  CustomizedConDevicePath  The console device path to be added to\r

-                                   the console variable ConVarName. Can not be multi-instance.\r
+                                   the console variable ConVarName. Cannot be multi-instance.\r

   @param  ExclusiveDevicePath      The console device path to be removed\r
   @param  ExclusiveDevicePath      The console device path to be removed\r

-                                   from the console variable ConVarName. Can not be multi-instance.\r
+                                   from the console variable ConVarName. Cannot be multi-instance.\r

 \r
   @retval EFI_UNSUPPORTED          The added device path is the same as a removed one.\r
   @retval EFI_SUCCESS              Successfully added or removed the device path from the\r
 \r
   @retval EFI_UNSUPPORTED          The added device path is the same as a removed one.\r
   @retval EFI_SUCCESS              Successfully added or removed the device path from the\r


@@ -486,7 +496,7 @@ BdsLibUpdateConsoleVariable (
   instance connects successfully, then this function\r
   will return success.\r
 \r
   instance connects successfully, then this function\r
   will return success.\r
 \r

-  @param  ConVarName               Console related variable name, ConIn, ConOut,\r
+  @param  ConVarName               The console related variable name: ConIn, ConOut,\r

                                    ErrOut.\r
 \r
   @retval EFI_NOT_FOUND            No console devices were connected successfully\r
                                    ErrOut.\r
 \r
   @retval EFI_NOT_FOUND            No console devices were connected successfully\r


@@ -504,7 +514,7 @@ BdsLibConnectConsoleVariable (
 // Bds device path related lib functions\r
 //\r
 /**\r
 // Bds device path related lib functions\r
 //\r
 /**\r

-  Delete the instance in Multi that overlaps with Single \r
+  Delete the instance in Multi that overlaps with Single. \r

 \r
   @param  Multi                 A pointer to a multi-instance device path data\r
                                 structure.\r
 \r
   @param  Multi                 A pointer to a multi-instance device path data\r
                                 structure.\r


@@ -512,7 +522,7 @@ BdsLibConnectConsoleVariable (
                                 structure.\r
 \r
   @return This function removes the device path instances in Multi that overlap\r
                                 structure.\r
 \r
   @return This function removes the device path instances in Multi that overlap\r

-   Single, and returns the resulting device path. If there is no\r
+          Single, and returns the resulting device path. If there is no\r

           remaining device path as a result, this function will return NULL.\r
 \r
 **/\r
           remaining device path as a result, this function will return NULL.\r
 \r
 **/\r


@@ -524,7 +534,7 @@ BdsLibDelPartMatchInstance (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Function compares a device path data structure to that of all the nodes of a\r
+  This function compares a device path data structure to that of all the nodes of a\r

   second device path instance.\r
 \r
   @param  Multi                 A pointer to a multi-instance device path data\r
   second device path instance.\r
 \r
   @param  Multi                 A pointer to a multi-instance device path data\r


@@ -532,8 +542,10 @@ BdsLibDelPartMatchInstance (
   @param  Single                A pointer to a single-instance device path data\r
                                 structure.\r
 \r
   @param  Single                A pointer to a single-instance device path data\r
                                 structure.\r
 \r

-  @retval TRUE                  If the Single device path is contained within Multi device path.\r
-  @retval FALSE                 The Single device path is not contained within Multi device path.\r
+  @retval TRUE                  If the Single device path is contained within a \r
+                                Multi device path.\r
+  @retval FALSE                 The Single device path is not contained within a \r
+                                Multi device path.\r

 \r
 **/\r
 BOOLEAN\r
 \r
 **/\r
 BOOLEAN\r


@@ -548,7 +560,7 @@ BdsLibMatchDevicePaths (
 \r
   @param DevPath                  A pointer to the device path structure.\r
 \r
 \r
   @param DevPath                  A pointer to the device path structure.\r
 \r

-  @return A new allocated Unicode string that represents the device path.\r
+  @return A newly allocated Unicode string that represents the device path.\r

 \r
 **/\r
 CHAR16 *\r
 \r
 **/\r
 CHAR16 *\r


@@ -636,9 +648,9 @@ ShadowAllOptionRom (
 /**\r
   Delete all the invalid legacy boot options.\r
 \r
 /**\r
   Delete all the invalid legacy boot options.\r
 \r

-  @retval EFI_SUCCESS             All invalide legacy boot options are deleted.\r
-  @retval EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.\r
-  @retval EFI_NOT_FOUND           Fail to retrieve variable of boot order.\r
+  @retval EFI_SUCCESS             All invalid legacy boot options are deleted.\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate necessary memory.\r
+  @retval EFI_NOT_FOUND           Failed to retrieve variable of boot order.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -650,7 +662,7 @@ BdsDeleteAllInvalidLegacyBootOptions (
 /**\r
   Add the legacy boot options from BBS table if they do not exist.\r
 \r
 /**\r
   Add the legacy boot options from BBS table if they do not exist.\r
 \r

-  @retval EFI_SUCCESS          The boot options are added successfully \r
+  @retval EFI_SUCCESS          The boot options were added successfully, \r

                                or they are already in boot options.\r
   @retval EFI_NOT_FOUND        No legacy boot options is found.\r
   @retval EFI_OUT_OF_RESOURCE  No enough memory.\r
                                or they are already in boot options.\r
   @retval EFI_NOT_FOUND        No legacy boot options is found.\r
   @retval EFI_OUT_OF_RESOURCE  No enough memory.\r


@@ -666,11 +678,11 @@ BdsAddNonExistingLegacyBootOptions (
   Add the legacy boot devices from BBS table into \r
   the legacy device boot order.\r
 \r
   Add the legacy boot devices from BBS table into \r
   the legacy device boot order.\r
 \r

-  @retval EFI_SUCCESS           The boot devices are added successfully.\r
+  @retval EFI_SUCCESS           The boot devices were added successfully.\r

   @retval EFI_NOT_FOUND         The legacy boot devices are not found.\r
   @retval EFI_NOT_FOUND         The legacy boot devices are not found.\r

-  @retval EFI_OUT_OF_RESOURCES  Memmory or storage is not enough.\r
-  @retval EFI_DEVICE_ERROR      Fail to add the legacy device boot order into EFI variable\r
-                                because of hardware error.\r
+  @retval EFI_OUT_OF_RESOURCES  Memory or storage is not enough.\r
+  @retval EFI_DEVICE_ERROR      Failed to add the legacy device boot order into EFI variable\r
+                                because of a hardware error.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -681,9 +693,9 @@ BdsUpdateLegacyDevOrder (
 /**\r
   Refresh the boot priority for BBS entries based on boot option entry and boot order.\r
 \r
 /**\r
   Refresh the boot priority for BBS entries based on boot option entry and boot order.\r
 \r

-  @param  Entry             The boot option is to be checked for refresh BBS table.\r
+  @param  Entry             The boot option is to be checked for a refreshed BBS table.\r

   \r
   \r

-  @retval EFI_SUCCESS           The boot priority for BBS entries is refreshed successfully.\r
+  @retval EFI_SUCCESS           The boot priority for BBS entries refreshed successfully.\r

   @retval EFI_NOT_FOUND         BBS entries can't be found.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to get the legacy device boot order.\r
 **/\r
   @retval EFI_NOT_FOUND         BBS entries can't be found.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to get the legacy device boot order.\r
 **/\r


@@ -697,13 +709,13 @@ BdsRefreshBbsTableForBoot (
   Delete the Boot Option from EFI Variable. The Boot Order Arrray\r
   is also updated.\r
 \r
   Delete the Boot Option from EFI Variable. The Boot Order Arrray\r
   is also updated.\r
 \r

-  @param OptionNumber    The number of Boot option want to be deleted.\r
+  @param OptionNumber    The number of Boot options wanting to be deleted.\r

   @param BootOrder       The Boot Order array.\r
   @param BootOrderSize   The size of the Boot Order Array.\r
 \r
   @param BootOrder       The Boot Order array.\r
   @param BootOrderSize   The size of the Boot Order Array.\r
 \r

-  @retval  EFI_SUCCESS           The Boot Option Variable was found and removed\r
-  @retval  EFI_UNSUPPORTED       The Boot Option Variable store was inaccessible\r
-  @retval  EFI_NOT_FOUND         The Boot Option Variable was not found\r
+  @retval  EFI_SUCCESS           The Boot Option Variable was found and removed.\r
+  @retval  EFI_UNSUPPORTED       The Boot Option Variable store was inaccessible.\r
+  @retval  EFI_NOT_FOUND         The Boot Option Variable was not found.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -718,7 +730,7 @@ BdsDeleteBootOption (
 //\r
 /**\r
   Enable the setup browser reset reminder feature.\r
 //\r
 /**\r
   Enable the setup browser reset reminder feature.\r

-  This routine is used in platform tip. If the platform policy needs the feature, use the routine to enable it.\r
+  This routine is used in a platform tip. If the platform policy needs the feature, use the routine to enable it.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -729,7 +741,7 @@ EnableResetReminderFeature (
 \r
 /**\r
   Disable the setup browser reset reminder feature.\r
 \r
 /**\r
   Disable the setup browser reset reminder feature.\r

-  This routine is used in platform tip. If the platform policy does not want the feature, use the routine to disable it.\r
+  This routine is used in a platform tip. If the platform policy does not want the feature, use the routine to disable it.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -795,19 +807,19 @@ SetupResetReminder (
 \r
 \r
 ///\r
 \r
 \r
 ///\r

-/// Define the boot type which to classify the boot option type\r
-/// Different boot option type could have different boot behavior\r
-/// Use their device path node (Type + SubType) as type value\r
-/// The boot type here can be added according to requirement\r
+/// Define the boot type with which to classify the boot option type.\r
+/// Different boot option types could have different boot behaviors.\r
+/// Use their device path node (Type + SubType) as the type value.\r
+/// The boot type here can be added according to requirements.\r

 ///\r
 \r
 ///\r
 ///\r
 \r
 ///\r

-/// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value\r
+/// ACPI boot type. For ACPI devices, using sub-types to distinguish devices is not allowed, so hardcode their values.\r

 ///\r
 #define  BDS_EFI_ACPI_FLOPPY_BOOT         0x0201\r
 ///\r
 /// Message boot type\r
 ///\r
 #define  BDS_EFI_ACPI_FLOPPY_BOOT         0x0201\r
 ///\r
 /// Message boot type\r

-/// If a device path of boot option only point to a message node, the boot option is message boot type\r
+/// If a device path of boot option only points to a message node, the boot option is a message boot type.\r

 ///\r
 #define  BDS_EFI_MESSAGE_ATAPI_BOOT       0x0301 // Type 03; Sub-Type 01\r
 #define  BDS_EFI_MESSAGE_SCSI_BOOT        0x0302 // Type 03; Sub-Type 02\r
 ///\r
 #define  BDS_EFI_MESSAGE_ATAPI_BOOT       0x0301 // Type 03; Sub-Type 01\r
 #define  BDS_EFI_MESSAGE_SCSI_BOOT        0x0302 // Type 03; Sub-Type 02\r


@@ -818,22 +830,22 @@ SetupResetReminder (
 \r
 ///\r
 /// Media boot type\r
 \r
 ///\r
 /// Media boot type\r

-/// If a device path of boot option contain a media node, the boot option is media boot type\r
+/// If a device path of boot option contains a media node, the boot option is media boot type.\r

 ///\r
 #define  BDS_EFI_MEDIA_HD_BOOT            0x0401 // Type 04; Sub-Type 01\r
 #define  BDS_EFI_MEDIA_CDROM_BOOT         0x0402 // Type 04; Sub-Type 02\r
 ///\r
 /// BBS boot type\r
 ///\r
 #define  BDS_EFI_MEDIA_HD_BOOT            0x0401 // Type 04; Sub-Type 01\r
 #define  BDS_EFI_MEDIA_CDROM_BOOT         0x0402 // Type 04; Sub-Type 02\r
 ///\r
 /// BBS boot type\r

-/// If a device path of boot option contain a BBS node, the boot option is BBS boot type\r
+/// If a device path of boot option contains a BBS node, the boot option is BBS boot type.\r

 ///\r
 #define  BDS_LEGACY_BBS_BOOT              0x0501 //  Type 05; Sub-Type 01\r
 \r
 #define  BDS_EFI_UNSUPPORT                0xFFFF\r
 \r
 /**\r
 ///\r
 #define  BDS_LEGACY_BBS_BOOT              0x0501 //  Type 05; Sub-Type 01\r
 \r
 #define  BDS_EFI_UNSUPPORT                0xFFFF\r
 \r
 /**\r

-  Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path\r
+  Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path.\r

 \r
 \r

-  @param  BlockIoDevicePath      Multi device path instances to check\r
+  @param  BlockIoDevicePath      Multi device path instances to check.\r

   @param  HardDriveDevicePath    A device path starting with a hard drive media\r
                                  device path.\r
 \r
   @param  HardDriveDevicePath    A device path starting with a hard drive media\r
                                  device path.\r
 \r


@@ -859,7 +871,7 @@ MatchPartitionDevicePathNode (
 \r
   @param  HardDriveDevicePath    EFI Device Path to boot, if it starts with a hard\r
                                  drive media device path.\r
 \r
   @param  HardDriveDevicePath    EFI Device Path to boot, if it starts with a hard\r
                                  drive media device path.\r

-  @return A Pointer to the full device path or NULL if a valid Hard Drive devic path\r
+  @return A Pointer to the full device path, or NULL if a valid Hard Drive devic path\r

           cannot be found.\r
 \r
 **/\r
           cannot be found.\r
 \r
 **/\r


@@ -875,7 +887,7 @@ BdsExpandPartitionPartialDevicePathToFull (
   Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.\r
   Third, detect the the default boot file in the Media, and return the removable Media handle.\r
 \r
   Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.\r
   Third, detect the the default boot file in the Media, and return the removable Media handle.\r
 \r

-  @param  DevicePath             Device Path to a  bootable device\r
+  @param  DevicePath             The Device Path to a  bootable device.\r

 \r
   @return  The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.\r
 \r
 \r
   @return  The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.\r
 \r


@@ -891,11 +903,11 @@ BdsLibGetBootableHandle (
   Checks whether the Device path in a boot option points to a valid bootable device, and if the device\r
   is ready to boot now.\r
 \r
   Checks whether the Device path in a boot option points to a valid bootable device, and if the device\r
   is ready to boot now.\r
 \r

-  @param  DevPath     the Device path in a boot option\r
-  @param  CheckMedia  if true, check whether the device is ready to boot now.\r
+  @param  DevPath     The Device path in a boot option.\r
+  @param  CheckMedia  If true, check whether the device is ready to boot now.\r

 \r
 \r

-  @retval TRUE        the Device path is valid\r
-  @retval FALSE       the Device path is invalid\r
+  @retval TRUE        The Device path is valid.\r
+  @retval FALSE       The Device path is invalid.\r

 \r
 **/\r
 BOOLEAN\r
 \r
 **/\r
 BOOLEAN\r


@@ -912,12 +924,12 @@ BdsLibIsValidEFIBootOptDevicePath (
   device, this function checks whether the description conflicts with other auto-created\r
   boot options.\r
 \r
   device, this function checks whether the description conflicts with other auto-created\r
   boot options.\r
 \r

-  @param  DevPath     the Device path in a boot option\r
-  @param  CheckMedia  if true, checks if the device is ready to boot now.\r
-  @param  Description the description of a boot option\r
+  @param  DevPath     The Device path in a boot option.\r
+  @param  CheckMedia  If true, checks if the device is ready to boot now.\r
+  @param  Description The description of a boot option.\r

 \r
 \r

-  @retval TRUE        the Device path is valid\r
-  @retval FALSE       the Device path is invalid\r
+  @retval TRUE        The Device path is valid.\r
+  @retval FALSE       The Device path is invalid.\r

 \r
 **/\r
 BOOLEAN\r
 \r
 **/\r
 BOOLEAN\r


@@ -931,9 +943,9 @@ BdsLibIsValidEFIBootOptDevicePathExt (
 /**\r
   For a bootable Device path, return its boot type.\r
 \r
 /**\r
   For a bootable Device path, return its boot type.\r
 \r

-  @param  DevicePath                      The bootable device Path to check\r
+  @param  DevicePath                      The bootable device Path to check.\r

 \r
 \r

-  @retval BDS_EFI_MEDIA_HD_BOOT           If given device path contains MEDIA_DEVICE_PATH type device path node                                           which subtype is MEDIA_HARDDRIVE_DP  @retval BDS_EFI_MEDIA_CDROM_BOOT        If given device path contains MEDIA_DEVICE_PATH type device path node                                          which subtype is MEDIA_CDROM_DP  @retval BDS_EFI_ACPI_FLOPPY_BOOT        If given device path contains ACPI_DEVICE_PATH type device path node                                          which HID is floppy device.  @retval BDS_EFI_MESSAGE_ATAPI_BOOT      If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_ATAPI_DP.  @retval BDS_EFI_MESSAGE_SCSI_BOOT       If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_SCSI_DP.  @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_USB_DP.  @retval BDS_EFI_MESSAGE_MISC_BOOT       If the device path not contains any media device path node,  and                                          its last device path node point to a message device path node.  @retval BDS_LEGACY_BBS_BOOT             If given device path contains BBS_DEVICE_PATH type device path node.  @retval BDS_EFI_UNSUPPORT               An EFI Removable BlockIO device path not point to a media and message device,   \r
+  @retval BDS_EFI_MEDIA_HD_BOOT           The given device path contains MEDIA_DEVICE_PATH type device path node.                                           which subtype is MEDIA_HARDDRIVE_DP  @retval BDS_EFI_MEDIA_CDROM_BOOT        If given device path contains MEDIA_DEVICE_PATH type device path node                                          which subtype is MEDIA_CDROM_DP  @retval BDS_EFI_ACPI_FLOPPY_BOOT        If given device path contains ACPI_DEVICE_PATH type device path node                                          which HID is floppy device.  @retval BDS_EFI_MESSAGE_ATAPI_BOOT      If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_ATAPI_DP.  @retval BDS_EFI_MESSAGE_SCSI_BOOT       If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_SCSI_DP.  @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_USB_DP.  @retval BDS_EFI_MESSAGE_MISC_BOOT       If the device path not contains any media device path node,  and                                          its last device path node point to a message device path node.  @retval BDS_LEGACY_BBS_BOOT             If given device path contains BBS_DEVICE_PATH type device path node.  @retval BDS_EFI_UNSUPPORT               An EFI Removable BlockIO device path not point to a media and message device,   \r

 **/\r
 UINT32\r
 EFIAPI\r
 **/\r
 UINT32\r
 EFIAPI\r


@@ -956,11 +968,11 @@ BdsLibSaveMemoryTypeInformation (
 /**\r
   Identify a user and, if authenticated, returns the current user profile handle.\r
 \r
 /**\r
   Identify a user and, if authenticated, returns the current user profile handle.\r
 \r

-  @param[out]  User           Point to user profile handle.\r
+  @param[out]  User           Points to the user profile handle.\r

   \r
   \r

-  @retval EFI_SUCCESS         User is successfully identified, or user identification\r
+  @retval EFI_SUCCESS         The user is successfully identified, or user identification\r

                               is not supported.\r
                               is not supported.\r

-  @retval EFI_ACCESS_DENIED   User is not successfully identified\r
+  @retval EFI_ACCESS_DENIED   The user was not successfully identified.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -975,17 +987,17 @@ BdsLibUserIdentify (
   FV address maybe changes for memory layout adjust from time to time, use this funciton\r
   could promise the Fv file device path is right.\r
 \r
   FV address maybe changes for memory layout adjust from time to time, use this funciton\r
   could promise the Fv file device path is right.\r
 \r

-  @param  DevicePath             on input, the Fv file device path to check. On\r
+  @param  DevicePath             On input, the Fv file device path to check. On\r

                                  output, the updated valid Fv file device path\r
                                  output, the updated valid Fv file device path\r

-  @param  FileGuid               the Fv file GUID\r
+  @param  FileGuid               the Fv file GUID.\r

 \r
 \r

-  @retval EFI_INVALID_PARAMETER  the input DevicePath or FileGuid is invalid\r
-  @retval EFI_UNSUPPORTED        the input DevicePath does not contain an Fv file\r
-                                 GUID at all\r
-  @retval EFI_ALREADY_STARTED    the input DevicePath has pointed to the Fv file and is\r
-                                 valid\r
-  @retval EFI_SUCCESS            successfully updated the invalid DevicePath\r
-                                 and returned the updated device path in DevicePath\r
+  @retval EFI_INVALID_PARAMETER  The input DevicePath or FileGuid is invalid.\r
+  @retval EFI_UNSUPPORTED        The input DevicePath does not contain an Fv file\r
+                                 GUID at all.\r
+  @retval EFI_ALREADY_STARTED    The input DevicePath has pointed to the Fv file and is\r
+                                 valid.\r
+  @retval EFI_SUCCESS            Successfully updated the invalid DevicePath\r
+                                 and returned the updated device path in DevicePath.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -998,13 +1010,13 @@ BdsLibUpdateFvFileDevicePath (
 \r
 /**\r
   Connect the specific USB device that matches the RemainingDevicePath,\r
 \r
 /**\r
   Connect the specific USB device that matches the RemainingDevicePath,\r

-  and whose bus is determined by Host Controller (Uhci or Ehci)\r
+  and whose bus is determined by Host Controller (Uhci or Ehci).\r

 \r
   @param  HostControllerPI      Uhci (0x00) or Ehci (0x20) or Both uhci and ehci\r
 \r
   @param  HostControllerPI      Uhci (0x00) or Ehci (0x20) or Both uhci and ehci\r

-                                (0xFF)\r
-  @param  RemainingDevicePath   a short-form device path that starts with the first\r
+                                (0xFF).\r
+  @param  RemainingDevicePath   A short-form device path that starts with the first\r

                                 element being a USB WWID or a USB Class device\r
                                 element being a USB WWID or a USB Class device\r

-                                path\r
+                                path.\r

 \r
   @retval EFI_SUCCESS           The specific Usb device is connected successfully.\r
   @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF) \r
 \r
   @retval EFI_SUCCESS           The specific Usb device is connected successfully.\r
   @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF) \r


@@ -1026,8 +1038,8 @@ BdsLibConnectUsbDevByShortFormDP(
 /**\r
   Convert Vendor device path to a device name.\r
 \r
 /**\r
   Convert Vendor device path to a device name.\r
 \r

-  @param  Str      The buffer storing device name\r
-  @param  DevPath  Pointer to vendor device path\r
+  @param  Str      The buffer storing device name.\r
+  @param  DevPath  The pointer to vendor device path.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -1037,11 +1049,11 @@ DevPathVendor (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Concatenates a formatted unicode string to allocated pool.\r
+  Concatenates a formatted unicode string to an allocated pool.\r

   The caller must free the resulting buffer.\r
 \r
   @param  Str      Tracks the allocated pool, size in use, and amount of pool allocated.\r
   The caller must free the resulting buffer.\r
 \r
   @param  Str      Tracks the allocated pool, size in use, and amount of pool allocated.\r

-  @param  Fmt      The format string\r
+  @param  Fmt      The format string.\r

   @param  ...      The data will be printed.\r
 \r
   @return Allocated buffer with the formatted string printed in it.\r
   @param  ...      The data will be printed.\r
 \r
   @return Allocated buffer with the formatted string printed in it.\r


@@ -1061,10 +1073,10 @@ CatPrint (
   Use SystemTable ConOut to stop video based Simple Text Out consoles from going\r
   to the video device. Put up LogoFile on every video device that is a console.\r
 \r
   Use SystemTable ConOut to stop video based Simple Text Out consoles from going\r
   to the video device. Put up LogoFile on every video device that is a console.\r
 \r

-  @param[in]  LogoFile   File name of logo to display on the center of the screen.\r
+  @param[in]  LogoFile   The file name of logo to display on the center of the screen.\r

 \r
   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
 \r
   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r

-  @retval EFI_UNSUPPORTED Logo not found\r
+  @retval EFI_UNSUPPORTED Logo not found.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -1076,7 +1088,7 @@ EnableQuietBoot (
 \r
 /**\r
   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The \r
 \r
 /**\r
   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The \r

-  Simple Text Out screens will now be synced up with all non video output devices\r
+  Simple Text Out screens will now be synced up with all non-video output devices.\r

 \r
   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
 \r
 \r
   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
 \r

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index d2099f142cc9222ff3bbe72577f1193abcc6eee0..b09f4f53a93179b8722cc4a79a029f7df9b6c563 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
@@ -2,13 +2,13 @@
   Platform BDS library definition. A platform can implement \r
   instances to support platform-specific behavior.\r
 \r
   Platform BDS library definition. A platform can implement \r
   instances to support platform-specific behavior.\r
 \r

-Copyright (c) 2008 - 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
+Copyright (c) 2008 - 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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r


@@ -25,7 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param  Level         The memory test intensive level.\r
 \r
 \r
   @param  Level         The memory test intensive level.\r
 \r

-  @retval EFI_STATUS    Success test all the system memory and update\r
+  @retval EFI_STATUS    Successfully test all the system memory, and update\r

                         the memory resource\r
 \r
 **/\r
                         the memory resource\r
 \r
 **/\r


@@ -37,7 +37,7 @@ EFI_STATUS
 \r
 /**\r
   This routine is called to see if there are any capsules we need to process.\r
 \r
 /**\r
   This routine is called to see if there are any capsules we need to process.\r

-  If the boot mode is not UPDATE, then we do nothing. Otherwise find the\r
+  If the boot mode is not UPDATE, then we do nothing. Otherwise, find the\r

   capsule HOBS and produce firmware volumes for them via the DXE service.\r
   Then call the dispatcher to dispatch drivers from them. Finally, check\r
   the status of the updates.\r
   capsule HOBS and produce firmware volumes for them via the DXE service.\r
   Then call the dispatcher to dispatch drivers from them. Finally, check\r
   the status of the updates.\r


@@ -48,10 +48,10 @@ EFI_STATUS
   clear the capsule variable so on the next reset PEI does not see it and\r
   think there is a capsule available.\r
 \r
   clear the capsule variable so on the next reset PEI does not see it and\r
   think there is a capsule available.\r
 \r

-  @param BootMode                 the current boot mode\r
+  @param BootMode                 The current boot mode\r

 \r
 \r

-  @retval EFI_INVALID_PARAMETER   boot mode is not correct for an update\r
-  @retval EFI_SUCCESS             There is no error when processing capsule\r
+  @retval EFI_INVALID_PARAMETER   The boot mode is not correct for an update.\r
+  @retval EFI_SUCCESS             There is no error when processing a capsule.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -94,10 +94,10 @@ PlatformBdsPolicyBehavior (
 /**\r
   Hook point for a user-provided function, for after a boot attempt fails. \r
 \r
 /**\r
   Hook point for a user-provided function, for after a boot attempt fails. \r
 \r

-  @param  Option                  Pointer to Boot Option that failed to boot.\r
-  @param  Status                  Status returned from failed boot.\r
-  @param  ExitData                Exit data returned from failed boot.\r
-  @param  ExitDataSize            Exit data size returned from failed boot.\r
+  @param  Option                  A pointer to Boot Option that failed to boot.\r
+  @param  Status                  The status returned from failed boot.\r
+  @param  ExitData                The exit data returned from failed boot.\r
+  @param  ExitDataSize            The exit data size returned from failed boot.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -115,7 +115,7 @@ PlatformBdsBootFail (
   interactive mode and stop processing the BootOrder list in this case. This\r
   is also a platform implementation, and can be customized by an IBV/OEM.\r
 \r
   interactive mode and stop processing the BootOrder list in this case. This\r
   is also a platform implementation, and can be customized by an IBV/OEM.\r
 \r

-  @param  Option                  Pointer to Boot Option that successfully booted.\r
+  @param  Option                  A pointer to the Boot Option that successfully booted.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -141,10 +141,10 @@ PlatformBdsLockNonUpdatableFlash (
   presses will be ignored until the Password is typed in. The only way to\r
   disable the password is to type it in to a ConIn device.\r
 \r
   presses will be ignored until the Password is typed in. The only way to\r
   disable the password is to type it in to a ConIn device.\r
 \r

-  @param  Password        Password used to lock ConIn device.\r
+  @param  Password        The password used to lock ConIn device.\r

 \r
 \r

-  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
-  @retval EFI_UNSUPPORTED Password not found\r
+  @retval EFI_SUCCESS     Lock the Console In Spliter virtual handle successfully.\r
+  @retval EFI_UNSUPPORTED Password not found.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
index 4445d98ff7ab54dcf7d88610ecce0dd394803ed6..b31be2ff4f8a99f72175ac90f306bbf4aba5dc8a 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
@@ -2,14 +2,14 @@
   EFI ISA ACPI Protocol is used to enumerate and manage all the ISA controllers on\r
   the platform's ISA Bus.\r
 \r
   EFI ISA ACPI Protocol is used to enumerate and manage all the ISA controllers on\r
   the platform's ISA Bus.\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
 \r
 **/\r
 \r


@@ -17,7 +17,7 @@
 #define __ISA_ACPI_H_\r
 \r
 ///\r
 #define __ISA_ACPI_H_\r
 \r
 ///\r

-/// Global ID for the EFI ISA ACPI Protocol\r
+/// Global ID for the EFI ISA ACPI Protocol.\r

 ///\r
 #define EFI_ISA_ACPI_PROTOCOL_GUID \\r
   { \\r
 ///\r
 #define EFI_ISA_ACPI_PROTOCOL_GUID \\r
   { \\r


@@ -30,65 +30,65 @@
 typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;\r
 \r
 ///\r
 typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;\r
 \r
 ///\r

-/// ISA ACPI Protocol interrupt resource attributes\r
+/// ISA ACPI Protocol interrupt resource attributes.\r

 ///\r
 ///\r

-#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_EDGE_SENSITIVE   0x01   ///< Edge triggered interrupt on a rising edge\r
-#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_EDGE_SENSITIVE    0x02   ///< Edge triggered interrupt on a falling edge\r
-#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_LEVEL_SENSITIVE  0x04   ///< Level sensitive interrupt active high\r
-#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_LEVEL_SENSITIVE   0x08   ///< Level sensitive interrupt active low\r
+#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_EDGE_SENSITIVE   0x01   ///< Edge triggered interrupt on a rising edge.\r
+#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_EDGE_SENSITIVE    0x02   ///< Edge triggered interrupt on a falling edge.\r
+#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_LEVEL_SENSITIVE  0x04   ///< Level sensitive interrupt active high.\r
+#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_LEVEL_SENSITIVE   0x08   ///< Level sensitive interrupt active low.\r

 \r
 ///\r
 \r
 ///\r

-/// ISA ACPI Protocol DMA resource attributes\r
+/// ISA ACPI Protocol DMA resource attributes.\r

 ///\r
 ///\r

-#define EFI_ISA_ACPI_DMA_SPEED_TYPE_MASK                 0x03   ///< Bit mask of supported DMA speed attributes\r
-#define EFI_ISA_ACPI_DMA_SPEED_TYPE_COMPATIBILITY        0x00   ///< ISA controller supports compatibility mode DMA transfers\r
-#define EFI_ISA_ACPI_DMA_SPEED_TYPE_A                    0x01   ///< ISA controller supports type A DMA transfers \r
-#define EFI_ISA_ACPI_DMA_SPEED_TYPE_B                    0x02   ///< ISA controller supports type B DMA transfers\r
-#define EFI_ISA_ACPI_DMA_SPEED_TYPE_F                    0x03   ///< ISA controller supports type F DMA transfers\r
-#define EFI_ISA_ACPI_DMA_COUNT_BY_BYTE                   0x04   ///< ISA controller increments DMA address by bytes (8-bit)\r
-#define EFI_ISA_ACPI_DMA_COUNT_BY_WORD                   0x08   ///< ISA controller increments DMA address by words (16-bit)\r
-#define EFI_ISA_ACPI_DMA_BUS_MASTER                      0x10   ///< ISA controller is a DMA bus master\r
-#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT             0x20   ///< ISA controller only supports 8-bit DMA transfers\r
-#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT  0x40   ///< ISA controller both 8-bit and 16-bit DMA transfers\r
-#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_16_BIT            0x80   ///< ISA controller only supports 16-bit DMA transfers\r
+#define EFI_ISA_ACPI_DMA_SPEED_TYPE_MASK                 0x03   ///< Bit mask of supported DMA speed attributes.\r
+#define EFI_ISA_ACPI_DMA_SPEED_TYPE_COMPATIBILITY        0x00   ///< ISA controller supports compatibility mode DMA transfers.\r
+#define EFI_ISA_ACPI_DMA_SPEED_TYPE_A                    0x01   ///< ISA controller supports type A DMA transfers.\r
+#define EFI_ISA_ACPI_DMA_SPEED_TYPE_B                    0x02   ///< ISA controller supports type B DMA transfers.\r
+#define EFI_ISA_ACPI_DMA_SPEED_TYPE_F                    0x03   ///< ISA controller supports type F DMA transfers.\r
+#define EFI_ISA_ACPI_DMA_COUNT_BY_BYTE                   0x04   ///< ISA controller increments DMA address by bytes (8-bit).\r
+#define EFI_ISA_ACPI_DMA_COUNT_BY_WORD                   0x08   ///< ISA controller increments DMA address by words (16-bit).\r
+#define EFI_ISA_ACPI_DMA_BUS_MASTER                      0x10   ///< ISA controller is a DMA bus master.\r
+#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT             0x20   ///< ISA controller only supports 8-bit DMA transfers.\r
+#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT  0x40   ///< ISA controller both 8-bit and 16-bit DMA transfers.\r
+#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_16_BIT            0x80   ///< ISA controller only supports 16-bit DMA transfers.\r

 \r
 ///\r
 /// ISA ACPI Protocol MMIO resource attributes\r
 ///\r
 \r
 ///\r
 /// ISA ACPI Protocol MMIO resource attributes\r
 ///\r

-#define EFI_ISA_ACPI_MEMORY_WIDTH_MASK                   0x03   ///< Bit mask of supported ISA memory width attributes\r
-#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT                  0x00   ///< ISA MMIO region only supports 8-bit access\r
-#define EFI_ISA_ACPI_MEMORY_WIDTH_16_BIT                 0x01   ///< ISA MMIO region only supports 16-bit access\r
-#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT_AND_16_BIT       0x02   ///< ISA MMIO region supports both 8-bit and 16-bit access \r
-#define EFI_ISA_ACPI_MEMORY_WRITEABLE                    0x04   ///< ISA MMIO region supports write transactions\r
-#define EFI_ISA_ACPI_MEMORY_CACHEABLE                    0x08   ///< ISA MMIO region supports being cached\r
-#define EFI_ISA_ACPI_MEMORY_SHADOWABLE                   0x10   ///< ISA MMIO region may be shadowed\r
-#define EFI_ISA_ACPI_MEMORY_EXPANSION_ROM                0x20   ///< ISA MMIO region is an expansion ROM\r
+#define EFI_ISA_ACPI_MEMORY_WIDTH_MASK                   0x03   ///< Bit mask of supported ISA memory width attributes.\r
+#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT                  0x00   ///< ISA MMIO region only supports 8-bit access.\r
+#define EFI_ISA_ACPI_MEMORY_WIDTH_16_BIT                 0x01   ///< ISA MMIO region only supports 16-bit access.\r
+#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT_AND_16_BIT       0x02   ///< ISA MMIO region supports both 8-bit and 16-bit access.\r
+#define EFI_ISA_ACPI_MEMORY_WRITEABLE                    0x04   ///< ISA MMIO region supports write transactions.\r
+#define EFI_ISA_ACPI_MEMORY_CACHEABLE                    0x08   ///< ISA MMIO region supports being cached.\r
+#define EFI_ISA_ACPI_MEMORY_SHADOWABLE                   0x10   ///< ISA MMIO region may be shadowed.\r
+#define EFI_ISA_ACPI_MEMORY_EXPANSION_ROM                0x20   ///< ISA MMIO region is an expansion ROM.\r

 \r
 ///\r
 /// ISA ACPI Protocol I/O resource attributes\r
 ///\r
 \r
 ///\r
 /// ISA ACPI Protocol I/O resource attributes\r
 ///\r

-#define EFI_ISA_ACPI_IO_DECODE_10_BITS                   0x01    ///< ISA controllers uses a 10-bit address decoder for I/O cycles\r
-#define EFI_ISA_ACPI_IO_DECODE_16_BITS                   0x02    ///< ISA controllers uses a 16-bit address decoder for I/O cycles\r
+#define EFI_ISA_ACPI_IO_DECODE_10_BITS                   0x01    ///< ISA controllers uses a 10-bit address decoder for I/O cycles.\r
+#define EFI_ISA_ACPI_IO_DECODE_16_BITS                   0x02    ///< ISA controllers uses a 16-bit address decoder for I/O cycles.\r

 \r
 ///\r
 /// EFI ISA ACPI resource type \r
 ///\r
 typedef enum {\r
 \r
 ///\r
 /// EFI ISA ACPI resource type \r
 ///\r
 typedef enum {\r

-  EfiIsaAcpiResourceEndOfList,    ///< Marks the end if a resource list\r
-  EfiIsaAcpiResourceIo,           ///< ISA I/O port resource range\r
-  EfiIsaAcpiResourceMemory,       ///< ISA MMIO resource range \r
-  EfiIsaAcpiResourceDma,          ///< ISA DMA resource \r
-  EfiIsaAcpiResourceInterrupt     ///< ISA interrupt resource\r
+  EfiIsaAcpiResourceEndOfList,    ///< Marks the end if a resource list.\r
+  EfiIsaAcpiResourceIo,           ///< ISA I/O port resource range.\r
+  EfiIsaAcpiResourceMemory,       ///< ISA MMIO resource range.\r
+  EfiIsaAcpiResourceDma,          ///< ISA DMA resource. \r
+  EfiIsaAcpiResourceInterrupt     ///< ISA interrupt resource.\r

 } EFI_ISA_ACPI_RESOURCE_TYPE;\r
 \r
 ///\r
 /// EFI ISA ACPI generic resource structure\r
 ///\r
 typedef struct {\r
 } EFI_ISA_ACPI_RESOURCE_TYPE;\r
 \r
 ///\r
 /// EFI ISA ACPI generic resource structure\r
 ///\r
 typedef struct {\r

-  EFI_ISA_ACPI_RESOURCE_TYPE  Type;         ///< The type of resource (I/O, MMIO, DMA, Interrupt)\r
+  EFI_ISA_ACPI_RESOURCE_TYPE  Type;         ///< The type of resource (I/O, MMIO, DMA, Interrupt).\r

   UINT32                      Attribute;    ///< Bit mask of attributes associated with this resource.  See EFI_ISA_ACPI_xxx macros for valid combinations.\r
   UINT32                      Attribute;    ///< Bit mask of attributes associated with this resource.  See EFI_ISA_ACPI_xxx macros for valid combinations.\r

-  UINT32                      StartRange;   ///< The start of the resource range\r
-  UINT32                      EndRange;     ///< The end of the resource range\r
+  UINT32                      StartRange;   ///< The start of the resource range.\r
+  UINT32                      EndRange;     ///< The end of the resource range.\r

 } EFI_ISA_ACPI_RESOURCE;\r
 \r
 ///\r
 } EFI_ISA_ACPI_RESOURCE;\r
 \r
 ///\r


@@ -103,8 +103,8 @@ typedef struct {
 /// EFI ISA ACPI resource list\r
 ///\r
 typedef struct {\r
 /// EFI ISA ACPI resource list\r
 ///\r
 typedef struct {\r

-  EFI_ISA_ACPI_DEVICE_ID  Device;          ///< The ACPI HID/UID associated with an ISA controller\r
-  EFI_ISA_ACPI_RESOURCE   *ResourceItem;   ///< Pointer to the list of resources associated with an ISA controller\r
+  EFI_ISA_ACPI_DEVICE_ID  Device;          ///< The ACPI HID/UID associated with an ISA controller.\r
+  EFI_ISA_ACPI_RESOURCE   *ResourceItem;   ///< A pointer to the list of resources associated with an ISA controller.\r

 } EFI_ISA_ACPI_RESOURCE_LIST;\r
 \r
 /**\r
 } EFI_ISA_ACPI_RESOURCE_LIST;\r
 \r
 /**\r


@@ -118,8 +118,8 @@ typedef struct {
   If Device is a pointer to the last ISA controller on the ISA bus, then \r
   EFI_NOT_FOUND is returned.\r
 \r
   If Device is a pointer to the last ISA controller on the ISA bus, then \r
   EFI_NOT_FOUND is returned.\r
 \r

-  @param[in]  This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[out] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
+  @param[in]  This     The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[out] Device   The pointer to an ISA controller named by ACPI HID/UID.\r

 \r
   @retval EFI_SUCCESS    The next ISA controller on the ISA bus was returned.\r
   @retval EFI_NOT_FOUND  No device found.\r
 \r
   @retval EFI_SUCCESS    The next ISA controller on the ISA bus was returned.\r
   @retval EFI_NOT_FOUND  No device found.\r


@@ -140,12 +140,12 @@ EFI_STATUS
   If the power state is sucessfully set on the ISA Controller, then\r
   EFI_SUCCESS is returned.\r
 \r
   If the power state is sucessfully set on the ISA Controller, then\r
   EFI_SUCCESS is returned.\r
 \r

-  @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[in] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
+  @param[in] This     The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in] Device   The pointer to an ISA controller named by ACPI HID/UID.\r

   @param[in] OnOff    TRUE denotes on, FALSE denotes off.\r
 \r
   @retval EFI_SUCCESS   Successfully set the power state of the ISA controller.\r
   @param[in] OnOff    TRUE denotes on, FALSE denotes off.\r
 \r
   @retval EFI_SUCCESS   Successfully set the power state of the ISA controller.\r

-  @retval Other         The ISA controller cound not be placed in the requested power state.\r
+  @retval Other         The ISA controller could not be placed in the requested power state.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -163,9 +163,9 @@ EFI_STATUS
   assigned to the ISA controller specified by Device.  These resources\r
   are returned in ResourceList.\r
 \r
   assigned to the ISA controller specified by Device.  These resources\r
   are returned in ResourceList.\r
 \r

-  @param[in]  This          Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[in]  Device        Pointer to an ISA controller named by ACPI HID/UID.\r
-  @param[out] ResourceList  Pointer to the current resource list for Device.\r
+  @param[in]  This          The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in]  Device        The pointer to an ISA controller named by ACPI HID/UID.\r
+  @param[out] ResourceList  The pointer to the current resource list for Device.\r

 \r
   @retval EFI_SUCCESS    Successfully retrieved the current resource list.\r
   @retval EFI_NOT_FOUND  The resource list could not be retrieved.\r
 \r
   @retval EFI_SUCCESS    Successfully retrieved the current resource list.\r
   @retval EFI_NOT_FOUND  The resource list could not be retrieved.\r


@@ -186,9 +186,9 @@ EFI_STATUS
   Retrieves the possible sets of I/O, MMIO, DMA, and interrupt resources for the\r
   ISA controller specified by Device.  The sets are returned in ResourceList.\r
 \r
   Retrieves the possible sets of I/O, MMIO, DMA, and interrupt resources for the\r
   ISA controller specified by Device.  The sets are returned in ResourceList.\r
 \r

-  @param[in]  This           Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[in]  Device         Pointer to an ISA controller named by ACPI HID/UID.\r
-  @param[out] ResourceList   Pointer to the returned list of resource lists.\r
+  @param[in]  This           The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in]  Device         The pointer to an ISA controller named by ACPI HID/UID.\r
+  @param[out] ResourceList   The pointer to the returned list of resource lists.\r

 \r
   @retval EFI_UNSUPPORTED  This service is not supported.\r
 \r
 \r
   @retval EFI_UNSUPPORTED  This service is not supported.\r
 \r


@@ -207,9 +207,9 @@ EFI_STATUS
   Assigns the I/O, MMIO, DMA, and interrupt resources specified by ResourceList\r
   to the ISA controller specified by Device.  ResourceList must match a resource list returned by GetPosResource() for the same ISA controller.\r
 \r
   Assigns the I/O, MMIO, DMA, and interrupt resources specified by ResourceList\r
   to the ISA controller specified by Device.  ResourceList must match a resource list returned by GetPosResource() for the same ISA controller.\r
 \r

-  @param[in] This           Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[in] Device         Pointer to an ISA controller named by ACPI HID/UID.\r
-  @param[in] ResourceList   Pointer to a resources list that must be one of the \r
+  @param[in] This           The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in] Device         The pointer to an ISA controller named by ACPI HID/UID.\r
+  @param[in] ResourceList   The pointer to a resources list that must be one of the \r

                             resource lists returned by GetPosResource() for the\r
                             ISA controller specified by Device.\r
 \r
                             resource lists returned by GetPosResource() for the\r
                             ISA controller specified by Device.\r
 \r


@@ -228,13 +228,13 @@ EFI_STATUS
 /**\r
   Enables or disables an ISA controller.\r
 \r
 /**\r
   Enables or disables an ISA controller.\r
 \r

-  @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[in] Device   Pointer to the ISA controller to enable/disable.\r
+  @param[in] This     The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in] Device   The pointer to the ISA controller to enable/disable.\r

   @param[in] Enable   TRUE to enable the ISA controller.  FALSE to disable the\r
                       ISA controller.\r
 \r
   @retval EFI_SUCCESS   Successfully enabled/disabled the ISA controller.\r
   @param[in] Enable   TRUE to enable the ISA controller.  FALSE to disable the\r
                       ISA controller.\r
 \r
   @retval EFI_SUCCESS   Successfully enabled/disabled the ISA controller.\r

-  @retval Other         The ISA controller cound not be placed in the requested state.\r
+  @retval Other         The ISA controller could not be placed in the requested state.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -249,8 +249,8 @@ EFI_STATUS
   Initializes an ISA controller, so that it can be used.  This service must be called\r
   before SetResource(), EnableDevice(), or SetPower() will behave as expected.\r
 \r
   Initializes an ISA controller, so that it can be used.  This service must be called\r
   before SetResource(), EnableDevice(), or SetPower() will behave as expected.\r
 \r

-  @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
-  @param[in] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
+  @param[in] This     The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in] Device   The pointer to an ISA controller named by ACPI HID/UID.\r

 \r
   @retval EFI_SUCCESS   Successfully initialized an ISA controller.\r
   @retval Other         The ISA controller could not be initialized.\r
 \r
   @retval EFI_SUCCESS   Successfully initialized an ISA controller.\r
   @retval Other         The ISA controller could not be initialized.\r


@@ -269,7 +269,7 @@ EFI_STATUS
   This service must be called before any of the other services in this\r
   protocol will function as expected.\r
  \r
   This service must be called before any of the other services in this\r
   protocol will function as expected.\r
  \r

-  @param[in] This  Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
+  @param[in] This  The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r

 \r
   @retval EFI_SUCCESS   Successfully initialized all required hardware states.\r
   @retval Other         The ISA interface could not be initialized.\r
 \r
   @retval EFI_SUCCESS   Successfully initialized all required hardware states.\r
   @retval Other         The ISA interface could not be initialized.\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
index 395f295479c7f7f5fa2279698891db859f9886d3..8322df85119565e32348aaea8099c6de935e25d8 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
@@ -2,14 +2,14 @@
   ISA I/O Protocol is used by ISA device drivers to perform I/O, MMIO and DMA \r
   operations on the ISA controllers they manage.\r
   \r
   ISA I/O Protocol is used by ISA device drivers to perform I/O, MMIO and DMA \r
   operations on the ISA controllers they manage.\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
 \r
 **/\r
 \r


@@ -27,51 +27,51 @@
   }\r
 \r
 ///\r
   }\r
 \r
 ///\r

-/// Forward declaration for the EFI_ISA_IO_PROTOCOL\r
+/// Forward declaration for the EFI_ISA_IO_PROTOCOL.\r

 ///\r
 typedef struct _EFI_ISA_IO_PROTOCOL EFI_ISA_IO_PROTOCOL;\r
 \r
 ///\r
 ///\r
 typedef struct _EFI_ISA_IO_PROTOCOL EFI_ISA_IO_PROTOCOL;\r
 \r
 ///\r

-/// Width of EFI_ISA_IO_PROTOCOL I/O Port and MMIO operations\r
+/// Width of EFI_ISA_IO_PROTOCOL I/O Port and MMIO operations.\r

 ///\r
 typedef enum {\r
 ///\r
 typedef enum {\r

-  EfiIsaIoWidthUint8 = 0,      ///< 8-bit operation\r
-  EfiIsaIoWidthUint16,         ///< 16-bit operation\r
+  EfiIsaIoWidthUint8 = 0,      ///< 8-bit operation.\r
+  EfiIsaIoWidthUint16,         ///< 16-bit operation.\r

   EfiIsaIoWidthUint32,         ///< 32-bit operation\r
   EfiIsaIoWidthReserved,\r
   EfiIsaIoWidthUint32,         ///< 32-bit operation\r
   EfiIsaIoWidthReserved,\r

-  EfiIsaIoWidthFifoUint8,      ///< 8-bit FIFO operation\r
-  EfiIsaIoWidthFifoUint16,     ///< 16-bit FIFO operation\r
-  EfiIsaIoWidthFifoUint32,     ///< 32-bit FIFO operation\r
+  EfiIsaIoWidthFifoUint8,      ///< 8-bit FIFO operation.\r
+  EfiIsaIoWidthFifoUint16,     ///< 16-bit FIFO operation.\r
+  EfiIsaIoWidthFifoUint32,     ///< 32-bit FIFO operation.\r

   EfiIsaIoWidthFifoReserved,\r
   EfiIsaIoWidthFifoReserved,\r

-  EfiIsaIoWidthFillUint8,      ///< 8-bit Fill operation\r
-  EfiIsaIoWidthFillUint16,     ///< 16-bit Fill operation\r
-  EfiIsaIoWidthFillUint32,     ///< 32-bit Fill operation\r
+  EfiIsaIoWidthFillUint8,      ///< 8-bit Fill operation.\r
+  EfiIsaIoWidthFillUint16,     ///< 16-bit Fill operation.\r
+  EfiIsaIoWidthFillUint32,     ///< 32-bit Fill operation.\r

   EfiIsaIoWidthFillReserved,\r
   EfiIsaIoWidthMaximum\r
 } EFI_ISA_IO_PROTOCOL_WIDTH;\r
 \r
 ///\r
   EfiIsaIoWidthFillReserved,\r
   EfiIsaIoWidthMaximum\r
 } EFI_ISA_IO_PROTOCOL_WIDTH;\r
 \r
 ///\r

-/// Attributes for the EFI_ISA_IO_PROTOCOL common DMA buffer allocations\r
+/// Attributes for the EFI_ISA_IO_PROTOCOL common DMA buffer allocations.\r

 ///\r
 ///\r

-#define EFI_ISA_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE  0x080    ///< Map a memory range so write are combined\r
-#define EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED         0x800    ///< Map a memory range so all read and write accesses are cached\r
-#define EFI_ISA_IO_ATTRIBUTE_MEMORY_DISABLE        0x1000   ///< Disable a memory range \r
+#define EFI_ISA_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE  0x080    ///< Map a memory range so write are combined.\r
+#define EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED         0x800    ///< Map a memory range so all read and write accesses are cached.\r
+#define EFI_ISA_IO_ATTRIBUTE_MEMORY_DISABLE        0x1000   ///< Disable a memory range.\r

 \r
 ///\r
 /// Channel attribute for EFI_ISA_IO_PROTOCOL slave DMA requests\r
 ///\r
 \r
 ///\r
 /// Channel attribute for EFI_ISA_IO_PROTOCOL slave DMA requests\r
 ///\r

-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_COMPATIBLE  0x001   ///< Set the speed of the DMA transfer in compatible mode\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_A           0x002   ///< Not supported\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_B           0x004   ///< Not supported\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_C           0x008   ///< Not supported\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8           0x010   ///< Request 8-bit DMA transfers.  Only available on channels 0..3\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_16          0x020   ///< Request 16-bit DMA transfers.  Only available on channels 4..7\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE       0x040   ///< Request a single DMA transfer\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE       0x080   ///< Request multiple DMA transfers until TC (Terminal Count) or EOP (End of Process)\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_AUTO_INITIALIZE   0x100   ///< Automatically reload base and count at the end of the DMA transfer\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_COMPATIBLE  0x001   ///< Set the speed of the DMA transfer in compatible mode.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_A           0x002   ///< Not supported.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_B           0x004   ///< Not supported.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_C           0x008   ///< Not supported.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8           0x010   ///< Request 8-bit DMA transfers.  Only available on channels 0..3.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_16          0x020   ///< Request 16-bit DMA transfers.  Only available on channels 4..7.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE       0x040   ///< Request a single DMA transfer.\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE       0x080   ///< Request multiple DMA transfers until TC (Terminal Count) or EOP (End of Process).\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_AUTO_INITIALIZE   0x100   ///< Automatically reload base and count at the end of the DMA transfer.\r

 \r
 ///\r
 \r
 ///\r

-/// The DMA opreration type for EFI_ISA_IO_PROTOCOL DMA requests\r
+/// The DMA opreration type for EFI_ISA_IO_PROTOCOL DMA requests.\r

 ///\r
 typedef enum {\r
   ///\r
 ///\r
 typedef enum {\r
   ///\r


@@ -128,7 +128,7 @@ EFI_STATUS
   );\r
 \r
 ///\r
   );\r
 \r
 ///\r

-/// Structure of functions for accessing ISA I/O and MMIO space\r
+/// Structure of functions for accessing ISA I/O and MMIO space.\r

 ///\r
 typedef struct {\r
   ///\r
 ///\r
 typedef struct {\r
   ///\r


@@ -147,9 +147,9 @@ typedef struct {
 \r
   @param[in] This         A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
   @param[in] Width        Specifies the width of the MMIO copy operation.\r
 \r
   @param[in] This         A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
   @param[in] Width        Specifies the width of the MMIO copy operation.\r

-  @param[in] DestOffset   The offset of the destination in ISA MMIO space\r
-  @param[in] SrcOffset    The offset of the source in ISA MMIO space\r
-  @param[in] Count        The number tranfers to perform for this copy operation\r
+  @param[in] DestOffset   The offset of the destination in ISA MMIO space.\r
+  @param[in] SrcOffset    The offset of the source in ISA MMIO space.\r
+  @param[in] Count        The number tranfers to perform for this copy operation.\r

 \r
   @retval EFI_SUCCESS             The data was copied sucessfully.\r
   @retval EFI_UNSUPPORTED         The DestOffset or SrcOffset is not valid for this device.\r
 \r
   @retval EFI_SUCCESS             The data was copied sucessfully.\r
   @retval EFI_UNSUPPORTED         The DestOffset or SrcOffset is not valid for this device.\r


@@ -237,7 +237,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Unmaps a memory region that was previously mapped with EFI_ISA_IO_PROTOCOL.Map()\r
+  Unmaps a memory region that was previously mapped with EFI_ISA_IO_PROTOCOL.Map().\r

 \r
   The EFI_ISA_IO_PROTOCOL.Map() operation is completed and any corresponding \r
   resources are released.  If the operation was EfiIsaIoOperationSlaveWrite \r
 \r
   The EFI_ISA_IO_PROTOCOL.Map() operation is completed and any corresponding \r
   resources are released.  If the operation was EfiIsaIoOperationSlaveWrite \r


@@ -270,8 +270,8 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS             The requested memory pages were allocated.\r
   @retval EFI_INVALID_PARAMETER   Type is invalid.\r
 \r
   @retval EFI_SUCCESS             The requested memory pages were allocated.\r
   @retval EFI_INVALID_PARAMETER   Type is invalid.\r

-  @retval EFI_INVALID_PARAMETER   MemoryType is invalid\r
-  @retval EFI_INVALID_PARAMETER   HostAddress is NULL\r
+  @retval EFI_INVALID_PARAMETER   MemoryType is invalid.\r
+  @retval EFI_INVALID_PARAMETER   HostAddress is NULL.\r

   @retval EFI_UNSUPPORTED         Attributes is unsupported.\r
   @retval EFI_UNSUPPORTED         The memory range specified by HostAddress, Pages,\r
                                   and Type is not available for common buffer use.\r
   @retval EFI_UNSUPPORTED         Attributes is unsupported.\r
   @retval EFI_UNSUPPORTED         The memory range specified by HostAddress, Pages,\r
                                   and Type is not available for common buffer use.\r


@@ -290,7 +290,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Frees a common buffer that was allocated with EFI_ISA_IO_PROTOCOL.AllocateBuffer()\r
+  Frees a common buffer that was allocated with EFI_ISA_IO_PROTOCOL.AllocateBuffer().\r

 \r
   @param[in] This          A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
   @param[in] Pages         The number of pages to free from the previously allocated common buffer.\r
 \r
   @param[in] This          A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
   @param[in] Pages         The number of pages to free from the previously allocated common buffer.\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
index 147916e1f9dcfeb3faa6c2b3b53f1d931416e4d0..57782101ddea4dc6dc183f829cb873a5d1b835d4 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
@@ -2,13 +2,13 @@
   The OEM Badging Protocol defines the interface to get the OEM badging \r
   image with the display attribute. This protocol can be produced based on OEM badging images.\r
 \r
   The OEM Badging Protocol defines the interface to get the OEM badging \r
   image with the display attribute. This protocol can be produced based on OEM badging images.\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
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r


@@ -50,16 +50,17 @@ typedef enum {
 \r
   Load an OEM badge image and return its data and attributes.\r
 \r
 \r
   Load an OEM badge image and return its data and attributes.\r
 \r

-  @param This              Pointer to this protocol instance.\r
+  @param This              The pointer to this protocol instance.\r

   @param Instance          The visible image instance is found.\r
   @param Instance          The visible image instance is found.\r

-  @param Format            Format of the image. Examples: BMP, JPEG.\r
-  @param ImageData         Image data for the badge file. Currently only supports the .bmp file format. \r
-  @param ImageSize         Size of the image returned.\r
-  @param Attribute         Display attributes of the image returned.\r
-  @param CoordinateX       X coordinate of the image.\r
-  @param CoordinateY       Y coordinate of the image.\r
-\r
-  @retval EFI_SUCCESS      Image has been fetched successfully.\r
+  @param Format            The format of the image. Examples: BMP, JPEG.\r
+  @param ImageData         The image data for the badge file. Currently only \r
+                           supports the .bmp file format. \r
+  @param ImageSize         The size of the image returned.\r
+  @param Attribute         The display attributes of the image returned.\r
+  @param CoordinateX       The X coordinate of the image.\r
+  @param CoordinateY       The Y coordinate of the image.\r
+\r
+  @retval EFI_SUCCESS      The image was fetched successfully.\r

   @retval EFI_NOT_FOUND    The specified image could not be found.\r
 \r
 **/\r
   @retval EFI_NOT_FOUND    The specified image could not be found.\r
 \r
 **/\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h b/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h
index 0ea26bdfc5c7def1e2717091286d1753b0386eaa..039296c78c09bb7dbc5150cea7ffd1bbe5631acf 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h
@@ -1,12 +1,12 @@
 /** @file\r
 /** @file\r

-  PS/2 policy protocol abstracts the specific platform initialization and setting.\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
+  PS/2 policy protocol abstracts the specific platform initialization and settings.\r
+\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
 \r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
index d5ee730aad7207c03ba44c5af7199355044366e5..164644aa12a9ab0a37448efaffa0332f0834b308 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
@@ -1,14 +1,14 @@
 /** @file\r
 /** @file\r

-  VGA Mini Port Protocol that is used to set the text display mode of a VGA controller.\r
+  The VGA Mini Port Protocol used to set the text display mode of a VGA controller.\r

 \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
 \r
 **/\r
 \r


@@ -16,7 +16,7 @@
 #define __VGA_MINI_PORT_H_\r
 \r
 ///\r
 #define __VGA_MINI_PORT_H_\r
 \r
 ///\r

-/// Global ID for the EFI_VGA_MINI_PORT_PROTOCOL\r
+/// Global ID for the EFI_VGA_MINI_PORT_PROTOCOL.\r

 ///\r
 #define EFI_VGA_MINI_PORT_PROTOCOL_GUID \\r
   { \\r
 ///\r
 #define EFI_VGA_MINI_PORT_PROTOCOL_GUID \\r
   { \\r


@@ -24,7 +24,7 @@
   }\r
 \r
 ///\r
   }\r
 \r
 ///\r

-/// Forward declaration for the EFI_VGA_MINI_PORT_PROTOCOL\r
+/// Forward declaration for the EFI_VGA_MINI_PORT_PROTOCOL.\r

 ///\r
 typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;\r
 \r
 ///\r
 typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;\r
 \r


@@ -42,7 +42,7 @@ typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;
   @param[in] This         A pointer to the EFI_VGA_MINI_PORT_PROTOCOL instance.\r
   @param[in] ModeNumber   The requested mode number.  0 for 80x25.  1 for 80x5.\r
 \r
   @param[in] This         A pointer to the EFI_VGA_MINI_PORT_PROTOCOL instance.\r
   @param[in] ModeNumber   The requested mode number.  0 for 80x25.  1 for 80x5.\r
 \r

-  @retval EFI_SUCCESS        The mode number was set\r
+  @retval EFI_SUCCESS        The mode number was set.\r

   @retval EFI_UNSUPPORTED    The mode number specified by ModeNumber is not supported.\r
   @retval EFI_DEVICE_ERROR   The device is not functioning properly.\r
   \r
   @retval EFI_UNSUPPORTED    The mode number specified by ModeNumber is not supported.\r
   @retval EFI_DEVICE_ERROR   The device is not functioning properly.\r
   \r

diff --git a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc
index 450f04b6eb9725b9d5bd4504be037f4ce4626ca0..c6d6a1d68943cf39faed5d5a8bf99040eec66075 100644 (file)
--- a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc
+++ b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc
@@ -3,18 +3,19 @@
 #\r
 # This file is used to build all modules in IntelFrameworkModulePkg.\r
 #\r
 #\r
 # This file is used to build all modules in IntelFrameworkModulePkg.\r
 #\r

-# Copyright (c) 2007 - 2010, Intel Corporation\r
-#\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) 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
 # 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
+##              \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
 # Defines Section - statements that will be processed to create a Makefile.\r
 ################################################################################\r
 #\r
 # Defines Section - statements that will be processed to create a Makefile.\r