Correct a typo: Change the type of the 4th parameter of EFI_DRIVER_HEALTH_PROTOCOL...

Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14767 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
index d9ec1f2f1b9c846427ac351585a21c7c06bc2f5a..14e71e3e52b803fb6913a7c992aa2457c27c0783 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
@@ -1,7 +1,7 @@
 /** @file\r
   The platform device manager reference implementation\r
 \r
 /** @file\r
   The platform device manager reference implementation\r
 \r

-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 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
 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


@@ -1943,7 +1943,7 @@ ProcessSingleControllerHealth (
                                DriverHealth,\r
                                ControllerHandle,\r
                                ChildHandle,\r
                                DriverHealth,\r
                                ControllerHandle,\r
                                ChildHandle,\r

-                               (EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY) RepairNotify\r
+                               RepairNotify\r

                                );\r
     }\r
     //\r
                                );\r
     }\r
     //\r


@@ -2019,24 +2019,20 @@ ProcessSingleControllerHealth (
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-  Platform specific notification function for controller repair operations.\r
-\r
-  If the driver for a controller support the Driver Health Protocol and the\r
-  current state of the controller is EfiDriverHealthStatusRepairRequired then\r
-  when the Repair() service of the Driver Health Protocol is called, this \r
-  platform specific notification function can display the progress of the repair\r
-  operation.  Some platforms may choose to not display anything, other may choose\r
-  to show the percentage complete on text consoles, and other may choose to render\r
-  a progress bar on text and graphical consoles.\r
-\r
-  This function displays the percentage of the repair operation that has been\r
-  completed on text consoles.  The percentage is Value / Limit * 100%.\r
-  \r
-  @param  Value               Value in the range 0..Limit the the repair has completed..\r
-  @param  Limit               The maximum value of Value\r
+  Reports the progress of a repair operation.\r
+\r
+  @param[in]  Value             A value between 0 and Limit that identifies the current \r
+                                progress of the repair operation.\r
+\r
+  @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           The progress of a repair operation is reported successfully.\r

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

-VOID\r
+EFI_STATUS\r
+EFIAPI\r

 RepairNotify (\r
   IN  UINTN Value,\r
   IN  UINTN Limit\r
 RepairNotify (\r
   IN  UINTN Value,\r
   IN  UINTN Limit\r


@@ -2050,6 +2046,7 @@ RepairNotify (
     Percent = Value * 100 / Limit;\r
     Print(L"Repair Progress = %3d%%\n\r", Percent);\r
   }\r
     Percent = Value * 100 / Limit;\r
     Print(L"Repair Progress = %3d%%\n\r", Percent);\r
   }\r

+  return EFI_SUCCESS;\r

 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
index ae01b3f602e7ea9579f1482a5e2ff9bb9eae85db..95bde8de5a14be68e477b0ad98f042322e3820d8 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
@@ -1,7 +1,7 @@
 /** @file\r
   The platform device manager reference implement\r
 \r
 /** @file\r
   The platform device manager reference implement\r
 \r

-Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 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
 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


@@ -313,13 +313,20 @@ ProcessSingleControllerHealth (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Repair notification function, simply print the repair progress.\r
+  Reports the progress of a repair operation.\r

 \r
 \r

-  @param  Value   The value of part has been repaired.\r
-  @param  Limit   Total value need to be repaired.\r
+  @param[in]  Value             A value between 0 and Limit that identifies the current \r
+                                progress of the repair operation.\r
+\r
+  @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           The progress of a repair operation is reported successfully.\r

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

-VOID\r
+EFI_STATUS\r
+EFIAPI\r

 RepairNotify (\r
   IN  UINTN Value,\r
   IN  UINTN Limit\r
 RepairNotify (\r
   IN  UINTN Value,\r
   IN  UINTN Limit\r

diff --git a/MdePkg/Include/Protocol/DriverHealth.h b/MdePkg/Include/Protocol/DriverHealth.h
index a4c92fbd907a7fadb5c40b6e1beb03ea339f2699..5116162cd274b5efe10f7e1d670825bb9f2b2446 100644 (file)
--- a/MdePkg/Include/Protocol/DriverHealth.h
+++ b/MdePkg/Include/Protocol/DriverHealth.h
@@ -20,7 +20,7 @@
   may then need to be reconnected or the system may need to be rebooted for the \r
   configuration changes to take affect. \r
 \r
   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 - 2011, Intel Corporation. All rights reserved.<BR>\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
   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


@@ -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
   @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
 **/\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
   IN UINTN  Value,\r
   IN UINTN  Limit\r
   );\r


@@ -193,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
   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
 \r
 \r
   @retval EFI_SUCCESS           An attempt to repair the controller specified by \r


@@ -222,8 +212,8 @@ EFI_STATUS
 (EFIAPI *EFI_DRIVER_HEALTH_REPAIR)(\r
   IN  EFI_DRIVER_HEALTH_PROTOCOL                *This,\r
   IN  EFI_HANDLE                                ControllerHandle,\r
 (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
   );\r
 \r
 ///\r