- Retrieves the health status of a controller in the platform. This function can also \r
- optionally return warning messages, error messages, and a set of HII Forms that may \r
- be repair a controller that is not proper configured. \r
- \r
- @param This A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\r
-\r
- @param ControllerHandle The handle of the controller to retrieve the health status \r
- on. This is an optional parameter that may be NULL. If \r
- this parameter is NULL, then the value of ChildHandle is \r
- ignored, and the combined health status of all the devices \r
- that the driver is managing is returned.\r
-\r
- @param ChildHandle The handle of the child controller to retrieve the health \r
- status on. This is an optional parameter that may be NULL. \r
- This parameter is ignored of ControllerHandle is NULL. It \r
- will be NULL for device drivers. It will also be NULL for \r
- bus drivers when an attempt is made to collect the health \r
- status of the bus controller. If will not be NULL when an \r
- attempt is made to collect the health status for a child \r
- controller produced by the driver.\r
-\r
- @param HealthStatus A pointer to the health status that is returned by this \r
- function. This is an optional parameter that may be NULL. \r
- This parameter is ignored of ControllerHandle is NULL. \r
- The health status for the controller specified by \r
- ControllerHandle and ChildHandle is returned. \r
-\r
- @param MessageList A pointer to an array of warning or error messages associated \r
- with the controller specified by ControllerHandle and \r
- ChildHandle. This is an optional parameter that may be NULL. \r
- MessageList is allocated by this function with the EFI Boot \r
- Service AllocatePool(), and it is the caller's responsibility \r
- to free MessageList with the EFI Boot Service FreePool(). \r
- Each message is specified by tuple of an EFI_HII_HANDLE and \r
- an EFI_STRING_ID. The array of messages is terminated by tuple \r
- containing a EFI_HII_HANDLE with a value of NULL. The \r
- EFI_HII_STRING_PROTOCOL.GetString() function can be used to \r
- retrieve the warning or error message as a Null-terminated \r
- Unicode string in a specific language. Messages may be \r
- returned for any of the HealthStatus values except \r
- EfiDriverHealthStatusReconnectRequired and \r
- EfiDriverHealthStatusRebootRequired.\r
-\r
- @param FormHiiHandle A pointer to the HII handle for an HII form associated with the \r
- controller specified by ControllerHandle and ChildHandle. \r
- This is an optional parameter that may be NULL. An HII form \r
- is specified by a combination of an EFI_HII_HANDLE and an \r
- EFI_GUID that identifies the Form Set GUID. The \r
- EFI_FORM_BROWSER2_PROTOCOL.SendForm() function can be used \r
- to display and allow the user to make configuration changes \r
- to the HII Form. An HII form may only be returned with a \r
- HealthStatus value of EfiDriverHealthStatusConfigurationRequired.\r
-\r
- @param FormSetGuid A pointer to the GUID for an HII form associated with the \r
- controller specified by ControllerHandle and ChildHandle. \r
- This is an optional parameter that may be NULL. An HII form \r
- is specified by a combination of an EFI_HII_HANDLE and an \r
- EFI_GUID that identifies the Form Set GUID. The \r
- EFI_FORM_BROWSER2_PROTOCOL.SendForm() function can be used \r
- to display and allow the user to make configuration changes \r
- to the HII Form. An HII form may only be returned with a \r
- HealthStatus value of EfiDriverHealthStatusConfigurationRequired.\r
-\r
- @retval EFI_SUCCESS ControllerHandle is NULL, and all the controllers \r
- managed by this driver specified by This have a health \r
- status of EfiDriverHealthStatusHealthy with no warning \r
- messages to be returned. The ChildHandle, HealthStatus, \r
+ Retrieves the health status of a controller in the platform. This function can also\r
+ optionally return warning messages, error messages, and a set of HII Forms that may\r
+ be repair a controller that is not proper configured.\r
+\r
+ @param[in] This A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\r
+\r
+ @param[in] ControllerHandle The handle of the controller to retrieve the health status\r
+ on. This is an optional parameter that may be NULL. If\r
+ this parameter is NULL, then the value of ChildHandle is\r
+ ignored, and the combined health status of all the devices\r
+ that the driver is managing is returned.\r
+\r
+ @param[in] ChildHandle The handle of the child controller to retrieve the health\r
+ status on. This is an optional parameter that may be NULL.\r
+ This parameter is ignored of ControllerHandle is NULL. It\r
+ will be NULL for device drivers. It will also be NULL for\r
+ bus drivers when an attempt is made to collect the health\r
+ status of the bus controller. If will not be NULL when an\r
+ attempt is made to collect the health status for a child\r
+ controller produced by the driver.\r
+\r
+ @param[out] HealthStatus A pointer to the health status that is returned by this\r
+ function. This is an optional parameter that may be NULL.\r
+ This parameter is ignored of ControllerHandle is NULL.\r
+ The health status for the controller specified by\r
+ ControllerHandle and ChildHandle is returned.\r
+\r
+ @param[out] MessageList A pointer to an array of warning or error messages associated\r
+ with the controller specified by ControllerHandle and\r
+ ChildHandle. This is an optional parameter that may be NULL.\r
+ MessageList is allocated by this function with the EFI Boot\r
+ Service AllocatePool(), and it is the caller's responsibility\r
+ to free MessageList with the EFI Boot Service FreePool().\r
+ Each message is specified by tuple of an EFI_HII_HANDLE and\r
+ an EFI_STRING_ID. The array of messages is terminated by tuple\r
+ containing a EFI_HII_HANDLE with a value of NULL. The\r
+ EFI_HII_STRING_PROTOCOL.GetString() function can be used to\r
+ retrieve the warning or error message as a Null-terminated\r
+ string in a specific language. Messages may be\r
+ returned for any of the HealthStatus values except\r
+ EfiDriverHealthStatusReconnectRequired and\r
+ EfiDriverHealthStatusRebootRequired.\r
+\r
+ @param[out] FormHiiHandle A pointer to the HII handle containing the HII form used when\r
+ configuration is required. The HII handle is associated with\r
+ the controller specified by ControllerHandle and ChildHandle.\r
+ If this is NULL, then no HII form is available. An HII handle\r
+ will only be returned with a HealthStatus value of\r
+ EfiDriverHealthStatusConfigurationRequired.\r
+\r
+ @retval EFI_SUCCESS ControllerHandle is NULL, and all the controllers\r
+ managed by this driver specified by This have a health\r
+ status of EfiDriverHealthStatusHealthy with no warning\r
+ messages to be returned. The ChildHandle, HealthStatus,\r