Revision: 14767
          http://sourceforge.net/p/edk2/code/14767
Author:   niruiyu
Date:     2013-10-14 02:02:02 +0000 (Mon, 14 Oct 2013)
Log Message:
-----------
Correct a typo: Change the type of the 4th parameter of 
EFI_DRIVER_HEALTH_PROTOCOL::Repair() from 
EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY to EFI_DRIVER_HEALTH_REPAIR_NOTIFY to 
follow the UEFI spec.

Signed-off-by: Ruiyu Ni <[email protected]>
Reviewed-by: Liming Gao <[email protected]>

Modified Paths:
--------------
    
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
    
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
    trunk/edk2/MdePkg/Include/Protocol/DriverHealth.h

Modified: 
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
===================================================================
--- 
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c  
    2013-10-12 06:31:55 UTC (rev 14766)
+++ 
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c  
    2013-10-14 02:02:02 UTC (rev 14767)
@@ -1,7 +1,7 @@
 /** @file
   The platform device manager reference implementation
 
-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD 
License
 which accompanies this distribution.  The full text of the license may be 
found at
@@ -1943,7 +1943,7 @@
                                DriverHealth,
                                ControllerHandle,
                                ChildHandle,
-                               (EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY) 
RepairNotify
+                               RepairNotify
                                );
     }
     //
@@ -2019,24 +2019,20 @@
 
 
 /**
-  Platform specific notification function for controller repair operations.
+  Reports the progress of a repair operation.
 
-  If the driver for a controller support the Driver Health Protocol and the
-  current state of the controller is EfiDriverHealthStatusRepairRequired then
-  when the Repair() service of the Driver Health Protocol is called, this 
-  platform specific notification function can display the progress of the 
repair
-  operation.  Some platforms may choose to not display anything, other may 
choose
-  to show the percentage complete on text consoles, and other may choose to 
render
-  a progress bar on text and graphical consoles.
+  @param[in]  Value             A value between 0 and Limit that identifies 
the current 
+                                progress of the repair operation.
 
-  This function displays the percentage of the repair operation that has been
-  completed on text consoles.  The percentage is Value / Limit * 100%.
-  
-  @param  Value               Value in the range 0..Limit the the repair has 
completed..
-  @param  Limit               The maximum value of Value
+  @param[in]  Limit             The maximum value of Value for the current 
repair operation.
+                                For example, a driver that wants to specify 
progress in 
+                                percent would use a Limit value of 100.
 
+  @retval EFI_SUCCESS           The progress of a repair operation is reported 
successfully.
+
 **/
-VOID
+EFI_STATUS
+EFIAPI
 RepairNotify (
   IN  UINTN Value,
   IN  UINTN Limit
@@ -2050,6 +2046,7 @@
     Percent = Value * 100 / Limit;
     Print(L"Repair Progress = %3d%%\n\r", Percent);
   }
+  return EFI_SUCCESS;
 }
 
 /**

Modified: 
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
===================================================================
--- 
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h  
    2013-10-12 06:31:55 UTC (rev 14766)
+++ 
trunk/edk2/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h  
    2013-10-14 02:02:02 UTC (rev 14767)
@@ -1,7 +1,7 @@
 /** @file
   The platform device manager reference implement
 
-Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD 
License
 which accompanies this distribution.  The full text of the license may be 
found at
@@ -313,13 +313,20 @@
   );
 
 /**
-  Repair notification function, simply print the repair progress.
+  Reports the progress of a repair operation.
 
-  @param  Value   The value of part has been repaired.
-  @param  Limit   Total value need to be repaired.
+  @param[in]  Value             A value between 0 and Limit that identifies 
the current 
+                                progress of the repair operation.
 
+  @param[in]  Limit             The maximum value of Value for the current 
repair operation.
+                                For example, a driver that wants to specify 
progress in 
+                                percent would use a Limit value of 100.
+
+  @retval EFI_SUCCESS           The progress of a repair operation is reported 
successfully.
+
 **/
-VOID
+EFI_STATUS
+EFIAPI
 RepairNotify (
   IN  UINTN Value,
   IN  UINTN Limit

Modified: trunk/edk2/MdePkg/Include/Protocol/DriverHealth.h
===================================================================
--- trunk/edk2/MdePkg/Include/Protocol/DriverHealth.h   2013-10-12 06:31:55 UTC 
(rev 14766)
+++ trunk/edk2/MdePkg/Include/Protocol/DriverHealth.h   2013-10-14 02:02:02 UTC 
(rev 14767)
@@ -20,7 +20,7 @@
   may then need to be reconnected or the system may need to be rebooted for 
the 
   configuration changes to take affect. 
 
-  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
   This program and the accompanying materials                          
   are licensed and made available under the terms and conditions of the BSD 
License         
   which accompanies this distribution.  The full text of the license may be 
found at        
@@ -74,20 +74,10 @@
   @param[in]  Limit             The maximum value of Value for the current 
repair operation.
                                 For example, a driver that wants to specify 
progress in 
                                 percent would use a Limit value of 100.
-  
-  @retval EFI_SUCCESS           An attempt to repair the controller specified 
by
-                                ControllerHandle and ChildHandle was 
performed. The
-                                result of the repair operation can bet 
determined by
-                                calling GetHealthStatus().
-  @retval EFI_UNSUPPORTED       The driver specified by This is not currently 
managing the
-                                controller specified by ControllerHandle and
-                                ChildHandle.
-  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to perform the 
repair operation.
-
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY)(
+(EFIAPI *EFI_DRIVER_HEALTH_REPAIR_NOTIFY)(
   IN UINTN  Value,
   IN UINTN  Limit
   );
@@ -193,17 +183,17 @@
   Performs a repair operation on a controller in the platform.  This function 
can 
   optionally report repair progress information back to the platform. 
   
-  @param[in] This                  A pointer to the EFI_DRIVER_HEALTH_PROTOCOL 
instance.
-  @param[in] ControllerHandle      The handle of the controller to repair.
-  @param[in] ChildHandle           The handle of the child controller to 
repair.  This is 
-                                   an optional parameter that may be NULL.  It 
will be NULL 
-                                   for device drivers.  It will also be NULL 
for bus 
-                                   drivers when an attempt is made to repair a 
bus controller.
-                                   If will not be NULL when an attempt is made 
to repair a 
-                                   child controller produced by the driver.
-  @param[in] ProgressNotification  A notification function that may be used by 
a driver to 
-                                   report the progress of the repair 
operation.  This is 
-                                   an optional parameter that may be NULL.  
+  @param[in] This              A pointer to the EFI_DRIVER_HEALTH_PROTOCOL 
instance.
+  @param[in] ControllerHandle  The handle of the controller to repair.
+  @param[in] ChildHandle       The handle of the child controller to repair.  
This is 
+                               an optional parameter that may be NULL.  It 
will be NULL 
+                               for device drivers.  It will also be NULL for 
bus 
+                               drivers when an attempt is made to repair a bus 
controller.
+                               If will not be NULL when an attempt is made to 
repair a 
+                               child controller produced by the driver.
+  @param[in] RepairNotify      A notification function that may be used by a 
driver to 
+                               report the progress of the repair operation.  
This is 
+                               an optional parameter that may be NULL.  
 
 
   @retval EFI_SUCCESS           An attempt to repair the controller specified 
by 
@@ -222,8 +212,8 @@
 (EFIAPI *EFI_DRIVER_HEALTH_REPAIR)(
   IN  EFI_DRIVER_HEALTH_PROTOCOL                *This,
   IN  EFI_HANDLE                                ControllerHandle,
-  IN  EFI_HANDLE                                ChildHandle          OPTIONAL,
-  IN  EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY  ProgressNotification OPTIONAL
+  IN  EFI_HANDLE                                ChildHandle       OPTIONAL,
+  IN  EFI_DRIVER_HEALTH_REPAIR_NOTIFY           RepairNotify      OPTIONAL
   );
 
 ///

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from 
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60134071&iu=/4140/ostg.clktrk
_______________________________________________
edk2-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-commits

Reply via email to