From: Ruiyu Ni Date: Mon, 14 Oct 2013 02:02:02 +0000 (+0000) Subject: Correct a typo: Change the type of the 4th parameter of EFI_DRIVER_HEALTH_PROTOCOL... X-Git-Tag: edk2-stable201903~12187 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=59ec2b00f98ffdd2f92306d23ec22ab05e1b199b 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 Reviewed-by: Liming Gao 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 d9ec1f2f1b..14e71e3e52 100644 --- a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c +++ b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c @@ -1,7 +1,7 @@ /** @file The platform device manager reference implementation -Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.
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 @@ ProcessSingleControllerHealth ( DriverHealth, ControllerHandle, ChildHandle, - (EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY) RepairNotify + RepairNotify ); } // @@ -2019,24 +2019,20 @@ ProcessSingleControllerHealth ( /** - Platform specific notification function for controller repair operations. - - 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. - - 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 + Reports the progress of a repair operation. + + @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 @@ -2050,6 +2046,7 @@ RepairNotify ( Percent = Value * 100 / Limit; Print(L"Repair Progress = %3d%%\n\r", Percent); } + return EFI_SUCCESS; } /** diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h index ae01b3f602..95bde8de5a 100644 --- a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h +++ b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h @@ -1,7 +1,7 @@ /** @file The platform device manager reference implement -Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.
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 @@ ProcessSingleControllerHealth ( ); /** - 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 diff --git a/MdePkg/Include/Protocol/DriverHealth.h b/MdePkg/Include/Protocol/DriverHealth.h index a4c92fbd90..5116162cd2 100644 --- 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 configuration changes to take affect. - Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
+ Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.
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 @@ typedef struct { @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 @@ EFI_STATUS 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 @@ EFI_STATUS (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 ); ///