]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/DriverHealth.h
Fix comment typos.
[mirror_edk2.git] / MdePkg / Include / Protocol / DriverHealth.h
index 78769aba24c367499bbd82295aa99e7e0db41a04..5116162cd274b5efe10f7e1d670825bb9f2b2446 100644 (file)
@@ -20,8 +20,8 @@
   may then need to be reconnected or the system may need to be rebooted for the \r
   configuration changes to take affect. \r
 \r
-  Copyright (c) 2009, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r
+  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
@@ -30,7 +30,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  This Protocol is defined in UEFI Specification 2.2 \r
+  This Protocol is defined in UEFI Specification 2.3d \r
 \r
 **/\r
 \r
@@ -74,20 +74,10 @@ typedef struct {
   @param[in]  Limit             The maximum value of Value for the current repair operation.\r
                                 For example, a driver that wants to specify progress in \r
                                 percent would use a Limit value of 100.\r
-  \r
-  @retval EFI_SUCCESS           An attempt to repair the controller specified by\r
-                                ControllerHandle and ChildHandle was performed. The\r
-                                result of the repair operation can bet determined by\r
-                                calling GetHealthStatus().\r
-  @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing the\r
-                                controller specified by ControllerHandle and\r
-                                ChildHandle.\r
-  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to perform the repair operation.\r
-\r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY)(\r
+(EFIAPI *EFI_DRIVER_HEALTH_REPAIR_NOTIFY)(\r
   IN UINTN  Value,\r
   IN UINTN  Limit\r
   );\r
@@ -131,20 +121,17 @@ EFI_STATUS
                               containing a EFI_HII_HANDLE with a value of NULL.  The \r
                               EFI_HII_STRING_PROTOCOL.GetString() function can be used to \r
                               retrieve the warning or error message as a Null-terminated \r
-                              Unicode string in a specific language.  Messages may be \r
+                              string in a specific language.  Messages may be \r
                               returned for any of the HealthStatus values except \r
                               EfiDriverHealthStatusReconnectRequired and \r
                               EfiDriverHealthStatusRebootRequired.\r
 \r
-  @param[out] FormHiiHandle   A pointer to the HII handle for an HII form associated with the \r
-                              controller specified by ControllerHandle and ChildHandle.  \r
-                              This is an optional parameter that may be NULL.  An HII form \r
-                              is specified by a combination of an EFI_HII_HANDLE and an \r
-                              EFI_GUID that identifies the Form Set GUID.  The \r
-                              EFI_FORM_BROWSER2_PROTOCOL.SendForm() function can be used \r
-                              to display and allow the user to make configuration changes \r
-                              to the HII Form.  An HII form may only be returned with a \r
-                              HealthStatus value of EfiDriverHealthStatusConfigurationRequired.\r
+  @param[out] FormHiiHandle   A pointer to the HII handle containing the HII form used when \r
+                              configuration is required. The HII handle is associated with \r
+                              the controller specified by ControllerHandle and ChildHandle.\r
+                              If this is NULL, then no HII form is available. An HII handle\r
+                              will only be returned with a HealthStatus value of \r
+                              EfiDriverHealthStatusConfigurationRequired.\r
 \r
   @retval EFI_SUCCESS           ControllerHandle is NULL, and all the controllers \r
                                 managed by this driver specified by This have a health \r
@@ -196,17 +183,17 @@ EFI_STATUS
   Performs a repair operation on a controller in the platform.  This function can \r
   optionally report repair progress information back to the platform. \r
   \r
-  @param[in] This                  A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\r
-  @param[in] ControllerHandle      The handle of the controller to repair.\r
-  @param[in] ChildHandle           The handle of the child controller to repair.  This is \r
-                                   an optional parameter that may be NULL.  It will be NULL \r
-                                   for device drivers.  It will also be NULL for bus \r
-                                   drivers when an attempt is made to repair a bus controller.\r
-                                   If will not be NULL when an attempt is made to repair a \r
-                                   child controller produced by the driver.\r
-  @param[in] ProgressNotification  A notification function that may be used by a driver to \r
-                                   report the progress of the repair operation.  This is \r
-                                   an optional parameter that may be NULL.  \r
+  @param[in] This              A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\r
+  @param[in] ControllerHandle  The handle of the controller to repair.\r
+  @param[in] ChildHandle       The handle of the child controller to repair.  This is \r
+                               an optional parameter that may be NULL.  It will be NULL \r
+                               for device drivers.  It will also be NULL for bus \r
+                               drivers when an attempt is made to repair a bus controller.\r
+                               If will not be NULL when an attempt is made to repair a \r
+                               child controller produced by the driver.\r
+  @param[in] RepairNotify      A notification function that may be used by a driver to \r
+                               report the progress of the repair operation.  This is \r
+                               an optional parameter that may be NULL.  \r
 \r
 \r
   @retval EFI_SUCCESS           An attempt to repair the controller specified by \r
@@ -225,8 +212,8 @@ EFI_STATUS
 (EFIAPI *EFI_DRIVER_HEALTH_REPAIR)(\r
   IN  EFI_DRIVER_HEALTH_PROTOCOL                *This,\r
   IN  EFI_HANDLE                                ControllerHandle,\r
-  IN  EFI_HANDLE                                ChildHandle          OPTIONAL,\r
-  IN  EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY  ProgressNotification OPTIONAL\r
+  IN  EFI_HANDLE                                ChildHandle       OPTIONAL,\r
+  IN  EFI_DRIVER_HEALTH_REPAIR_NOTIFY           RepairNotify      OPTIONAL\r
   );\r
 \r
 ///\r