Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / IsaAcpi.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
index 81e75f949ecce34d4343fef55abc13da29f4ddfc..819d5b499e159b4fb96d4144998994aea34cb65e 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
@@ -112,8 +112,8 @@ typedef struct {
 \r
   This service allows all the ISA controllers on an ISA bus to be enumerated.  If\r
   Device is a pointer to a NULL value, then the first ISA controller on the ISA\r
-  bus is returned in Device and EFI_SUCESS is returned.  If Device is a pointer \r
-  to value that was returned on a prior call to DeviceEnumerate(), then the next \r
+  bus is returned in Device and EFI_SUCCESS is returned.  If Device is a pointer \r
+  to a value that was returned on a prior call to DeviceEnumerate(), then the next \r
   ISA controller on the ISA bus is returned in Device and EFI_SUCCESS is returned.\r
   If Device is a pointer to the last ISA controller on the ISA bus, then \r
   EFI_NOT_FOUND is returned.\r
@@ -136,15 +136,13 @@ EFI_STATUS
   Sets the power state of an ISA controller.\r
 \r
   This services sets the power state of the ISA controller specified by Device to \r
-  the power state specified by OnOff.  If OnOff is TRUE, then power is applied to \r
-  the ISA controller.  If OnOff is FALSE, then power is remobed from the ISA \r
-  controller.  If the power state is sucessfully set on the ISA Controller, then\r
+  the power state specified by OnOff.  TRUE denotes on, FALSE denotes off. \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] OnOff    TRUE to apply power to the ISA controller.  FALSE to remove\r
-                      power from 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
@@ -159,7 +157,7 @@ EFI_STATUS
   );\r
   \r
 /**\r
-  Retrieves the current set of resource associated with an ISA controller.\r
+  Retrieves the current set of resources associated with an ISA controller.\r
 \r
   Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently \r
   assigned to the ISA controller specified by Device.  These resources\r
@@ -192,7 +190,7 @@ EFI_STATUS
   @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
 \r
-  @retval EFI_UNSUPPORTED  This services is not supported.\r
+  @retval EFI_UNSUPPORTED  This service is not supported.\r
 \r
 **/\r
 typedef\r
@@ -207,8 +205,7 @@ EFI_STATUS
   Assigns resources to an 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 on of the\r
-  possible resource lists returned by GetPosResource() for the same ISA controller.\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
@@ -249,7 +246,7 @@ EFI_STATUS
   );    \r
 \r
 /**\r
-  Places an ISA controller into a usable state.  This service must be called\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
@@ -267,8 +264,8 @@ EFI_STATUS
   );  \r
 \r
 /**\r
-  Initializes all the HW state required for the ISA controlers on the ISA bus \r
-  to be enumerated and managed by this rest of the services in this prorotol.\r
+  Initializes all the HW states required for the ISA controllers on the ISA bus \r
+  to be enumerated and managed by the rest of the services in this prorotol.\r
   This service must be called before any of the other services in this\r
   protocol will function as expected.\r
  \r
@@ -285,10 +282,10 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// The EFI_ISA_ACPI_PROTOCOL provides the services to enumberate and manage\r
-/// ISA controllers on an ISA bus.  This include the ability to initialize, \r
-/// enable, disable, and manag the power state of ISA controllers.  It also \r
-/// includes services to query current ressources, query possible resources, \r
+/// The EFI_ISA_ACPI_PROTOCOL provides the services to enumerate and manage\r
+/// ISA controllers on an ISA bus.  These services include the ability to initialize, \r
+/// enable, disable, and manage the power state of ISA controllers.  It also \r
+/// includes services to query current resources, query possible resources, \r
 /// and assign resources to an ISA controller.\r
 ///\r
 struct _EFI_ISA_ACPI_PROTOCOL {\r