[edk2-devel] [PATCH 1/1] MdePkg: Update GetHealthStatus function description

["Junfeng Guan" <junfengx.guan@intel.com>]

Refer to Uefi spec 2.10 section 11.10.2, update the return value
for EFI_DRIVER_HEALTH_PROTOCOL.GetHealthStatus.

Signed-off-by: Junfeng Guan <junfengx.guan@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Yi Li <yi1.li@intel.com>
---
 MdePkg/Include/Protocol/DriverHealth.h | 32 +++++++-------------------
 1 file changed, 8 insertions(+), 24 deletions(-)

diff --git a/MdePkg/Include/Protocol/DriverHealth.h b/MdePkg/Include/Protocol/DriverHealth.h
index 9de025434ef3..9e1bd903f4be 100644
--- a/MdePkg/Include/Protocol/DriverHealth.h
+++ b/MdePkg/Include/Protocol/DriverHealth.h
@@ -137,35 +137,19 @@ EFI_STATUS
                               will only be returned with a HealthStatus value of
                               EfiDriverHealthStatusConfigurationRequired.
 
-  @retval EFI_SUCCESS           ControllerHandle is NULL, and all the controllers
-                                managed by this driver specified by This have a health
-                                status of EfiDriverHealthStatusHealthy with no warning
-                                messages to be returned.  The ChildHandle, HealthStatus,
-                                MessageList, and FormList parameters are ignored.
-
-  @retval EFI_DEVICE_ERROR      ControllerHandle is NULL, and one or more of the
-                                controllers managed by this driver specified by This
-                                do not have a health status of EfiDriverHealthStatusHealthy.
-                                The ChildHandle, HealthStatus, MessageList, and
-                                FormList parameters are ignored.
-
-  @retval EFI_DEVICE_ERROR      ControllerHandle is NULL, and one or more of the
-                                controllers managed by this driver specified by This
-                                have one or more warning and/or error messages.
-                                The ChildHandle, HealthStatus, MessageList, and
-                                FormList parameters are ignored.
-
-  @retval EFI_SUCCESS           ControllerHandle is not NULL and the health status
-                                of the controller specified by ControllerHandle and
-                                ChildHandle was returned in HealthStatus.  A list
-                                of warning and error messages may be optionally
-                                returned in MessageList, and a list of HII Forms
-                                may be optionally returned in FormList.
+  @retval EFI_SUCCESS           The health status of the controller specified by
+                                ControllerHandle and ChildHandle was returned in HealthStatus.
+                                A list of warning and error messages may be optionally
+                                returned in MessageList, and an HII Form may be optionally
+                                specified by FormHiiHandle.
 
   @retval EFI_UNSUPPORTED       ControllerHandle is not NULL, and the controller
                                 specified by ControllerHandle and ChildHandle is not
                                 currently being managed by the driver specified by This.
 
+  @retval EFI_UNSUPPORTED       ControllerHandle is NULL and there are no devices being
+                                managed by the driver.
+
   @retval EFI_INVALID_PARAMETER HealthStatus is NULL.
 
   @retval EFI_OUT_OF_RESOURCES  MessageList is not NULL, and there are not enough
-- 
2.26.2.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#112943): https://edk2.groups.io/g/devel/message/112943
Mute This Topic: https://groups.io/mt/103397828/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-