Committing changes to the comments, after review with engineers.

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

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index e2142db1902a003d46271864b2536dc7a12b89bd..b3c748c3f6fff5acfa56d883d64efc561434a755 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -109,8 +109,7 @@ BdsLibBootNext (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Process the boot option follow the UEFI specification and\r
-  special treat the legacy boot option with BBS_DEVICE_PATH.\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  DevicePath             The device path describing where to load the\r
 \r
   @param  Option                 The boot option to be processed\r
   @param  DevicePath             The device path describing where to load the\r


@@ -255,7 +254,8 @@ BdsLibLoadDrivers (
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-  Process BootOrder, or DriverOrder variables, by calling\r
+  This function processes BootOrder or DriverOrder variables, by calling\r
+\r

   BdsLibVariableToOption () for each UINT16 in the variables.\r
 \r
   @param  BdsCommonOptionList   The header of the option list base on variable\r
   BdsLibVariableToOption () for each UINT16 in the variables.\r
 \r
   @param  BdsCommonOptionList   The header of the option list base on variable\r


@@ -384,7 +384,7 @@ BdsLibConnectAll (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  This function creates all handles associated with every device\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
   be created, then it tries to execute the dispatch to load the missing drivers.  \r
 \r
   path node. If the handle associated with one device path node can not\r
   be created, then it tries to execute the dispatch to load the missing drivers.  \r
 \r


@@ -430,7 +430,7 @@ BdsLibDisconnectAllEfi (
 //\r
 /**\r
   This function will search every simpletxt device in the current system,\r
 //\r
 /**\r
   This function will search every simpletxt device in the current system,\r

-  and make every simpletxt device as pertantial console device.\r
+  and make every simpletxt device a potential console device.\r

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


@@ -671,7 +671,7 @@ BdsUpdateLegacyDevOrder (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Set the boot priority for BBS entries based on boot option entry and boot order.\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
   \r
 \r
   @param  Entry             The boot option is to be checked for refresh BBS table.\r
   \r


@@ -686,7 +686,7 @@ BdsRefreshBbsTableForBoot (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Deletete the Boot Option from EFI Variable. The Boot Order Arrray\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
   is also updated.\r
 \r
   @param OptionNumber    The number of Boot option want to be deleted.\r


@@ -849,11 +849,11 @@ MatchPartitionDevicePathNode (
 \r
 /**\r
   Expand a device path that starts with a hard drive media device path node to be a\r
 \r
 /**\r
   Expand a device path that starts with a hard drive media device path node to be a\r

-  full device path that includes the full hardware path to the device. We need\r
-  to do this so it can be booted. As an optimizaiton the front match (the part point\r
-  to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable\r
-  so a connect all is not required on every boot. All successful history device path\r
-  which point to partition node (the front part) will be saved.\r
+  full device path that includes the full hardware path to the device. This function enables the device to boot. \r
+  To avoid requiring a connect on every boot, the front match is saved in a variable (the part point\r
+  to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).\r
+  All successful history device paths\r
+  that point to the front part of the partition node will be saved.\r

 \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

diff --git a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
index 63387f8aa56ed2b4a94eef069ca509a60e29c5c0..8b09e7843553ebba2b6ddf6e43ad9ea51c8a17db 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
@@ -33,14 +33,13 @@ OemHookStatusCodeInitialize (
 /**\r
   Report status code to OEM device.\r
  \r
 /**\r
   Report status code to OEM device.\r
  \r

-  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
+  @param  CodeType      Indicates the type of status code being reported.  \r

  \r
   @param  Value         Describes the current status of a hardware or software entity.  \r
                         This includes both an operation and classification information about the class and subclass.\r
                         For progress codes, the operation is the current activity. \r
                         For error codes, it is the exception.  For debug codes, it is not defined at this time. \r
  \r
   @param  Value         Describes the current status of a hardware or software entity.  \r
                         This includes both an operation and classification information about the class and subclass.\r
                         For progress codes, the operation is the current activity. \r
                         For error codes, it is the exception.  For debug codes, it is not defined at this time. \r

-                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
-                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
+                        Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification.\r

  \r
   @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                         A system may contain multiple entities that match a class/subclass pairing. \r
  \r
   @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                         A system may contain multiple entities that match a class/subclass pairing. \r

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index 96cd87d1cf95ee41e829aa51ca8a3d53fd5c064c..d2099f142cc9222ff3bbe72577f1193abcc6eee0 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
@@ -92,7 +92,7 @@ PlatformBdsPolicyBehavior (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Hook point after a boot attempt fails.\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
 \r
   @param  Option                  Pointer to Boot Option that failed to boot.\r
   @param  Status                  Status returned from failed boot.\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
index 819d5b499e159b4fb96d4144998994aea34cb65e..4445d98ff7ab54dcf7d88610ecce0dd394803ed6 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
@@ -271,7 +271,7 @@ EFI_STATUS
  \r
   @param[in] This  Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
 \r
  \r
   @param[in] This  Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
 \r

-  @retval EFI_SUCCESS   Successfully initialized the ISA interface.\r
+  @retval EFI_SUCCESS   Successfully initialized all required hardware states.\r

   @retval Other         The ISA interface could not be initialized.\r
 \r
 **/\r
   @retval Other         The ISA interface could not be initialized.\r
 \r
 **/\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
index a0d380878faf3213c6e5747f8de582eedde93526..147916e1f9dcfeb3faa6c2b3b53f1d931416e4d0 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
@@ -53,7 +53,7 @@ typedef enum {
   @param This              Pointer to this protocol instance.\r
   @param Instance          The visible image instance is found.\r
   @param Format            Format of the image. Examples: BMP, JPEG.\r
   @param This              Pointer to this protocol instance.\r
   @param Instance          The visible image instance is found.\r
   @param Format            Format of the image. Examples: BMP, JPEG.\r

-  @param ImageData         Image data returned.\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 ImageSize         Size of the image returned.\r
   @param Attribute         Display attributes of the image returned.\r
   @param CoordinateX       X coordinate of the image.\r

diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
index f8a73879a7cd9fae3a4c6987fac0fa10d9d7baa0..d5ee730aad7207c03ba44c5af7199355044366e5 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
@@ -61,7 +61,7 @@ struct _EFI_VGA_MINI_PORT_PROTOCOL {
   ///\r
   UINT64                      VgaMemoryOffset;\r
   ///\r
   ///\r
   UINT64                      VgaMemoryOffset;\r
   ///\r

-  /// I/O Port address for the VGA CRTC address register  Typically set to 0x3D4.\r
+  /// I/O Port address for the VGA CRTC address register. Typically set to 0x3D4.\r

   ///\r
   UINT64                      CrtcAddressRegisterOffset;\r
   ///\r
   ///\r
   UINT64                      CrtcAddressRegisterOffset;\r
   ///\r