MdePkg: Update GetHealthStatus function description

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>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
This commit is contained in:
Junfeng Guan 2023-12-28 14:57:55 +08:00 committed by mergify[bot]
parent e7cfdc5f14
commit 889535caf8
1 changed files with 8 additions and 24 deletions

View File

@ -137,35 +137,19 @@ EFI_STATUS
will only be returned with a HealthStatus value of will only be returned with a HealthStatus value of
EfiDriverHealthStatusConfigurationRequired. EfiDriverHealthStatusConfigurationRequired.
@retval EFI_SUCCESS ControllerHandle is NULL, and all the controllers @retval EFI_SUCCESS The health status of the controller specified by
managed by this driver specified by This have a health ControllerHandle and ChildHandle was returned in HealthStatus.
status of EfiDriverHealthStatusHealthy with no warning A list of warning and error messages may be optionally
messages to be returned. The ChildHandle, HealthStatus, returned in MessageList, and an HII Form may be optionally
MessageList, and FormList parameters are ignored. specified by FormHiiHandle.
@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_UNSUPPORTED ControllerHandle is not NULL, and the controller @retval EFI_UNSUPPORTED ControllerHandle is not NULL, and the controller
specified by ControllerHandle and ChildHandle is not specified by ControllerHandle and ChildHandle is not
currently being managed by the driver specified by This. 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_INVALID_PARAMETER HealthStatus is NULL.
@retval EFI_OUT_OF_RESOURCES MessageList is not NULL, and there are not enough @retval EFI_OUT_OF_RESOURCES MessageList is not NULL, and there are not enough