/** @file\r
The platform device manager reference implement\r
\r
-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth;\r
///\r
- /// Driver health messages of the specify Driver \r
+ /// Driver health messages of the specify Driver\r
///\r
EFI_DRIVER_HEALTH_HII_MESSAGE *MessageList;\r
\r
\r
This function create the dynamic content for device manager. It includes\r
section header for all class of devices, one-of opcode to set VBIOS.\r
- \r
+\r
@retval EFI_SUCCESS Operation is successful.\r
@retval Other values if failed to clean up the dynamic content from HII\r
database.\r
This function called by CheckAllControllersHealthStatus () function in order to process a specify\r
contoller's health state.\r
\r
- @param DriverHealthList A Pointer to the list contain all of the platform driver health information. \r
+ @param DriverHealthList A Pointer to the list contain all of the platform driver health information.\r
@param DriverHandle The handle of driver.\r
@param ControllerHandle The class guid specifies which form set will be displayed.\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
+ @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
@param DriverHealth A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\r
@param HealthStatus The health status of the controller.\r
\r
);\r
\r
/**\r
- Collects all the EFI Driver Health Protocols currently present in the EFI Handle Database, \r
- and queries each EFI Driver Health Protocol to determine if one or more of the controllers \r
- managed by each EFI Driver Health Protocol instance are not healthy. \r
+ Collects all the EFI Driver Health Protocols currently present in the EFI Handle Database,\r
+ and queries each EFI Driver Health Protocol to determine if one or more of the controllers\r
+ managed by each EFI Driver Health Protocol instance are not healthy.\r
\r
@param DriverHealthList A Pointer to the list contain all of the platform driver health\r
information.\r
);\r
\r
/**\r
- Check the healthy status of the platform, this function will return immediately while found one driver \r
+ Check the healthy status of the platform, this function will return immediately while found one driver\r
in the platform are not healthy.\r
\r
@retval FALSE at least one driver in the platform are not healthy.\r
Repair the whole platform.\r
\r
This function is the main entry for user choose "Repair All" in the front page.\r
- It will try to do recovery job till all the driver health protocol installed modules \r
+ It will try to do recovery job till all the driver health protocol installed modules\r
reach a terminal state.\r
\r
@param DriverHealthList A Pointer to the list contain all of the platform driver health\r
);\r
\r
/**\r
- Processes a single controller using the EFI Driver Health Protocol associated with \r
+ Processes a single controller using the EFI Driver Health Protocol associated with\r
that controller. This algorithm continues to query the GetHealthStatus() service until\r
- one of the legal terminal states of the EFI Driver Health Protocol is reached. This may \r
+ one of the legal terminal states of the EFI Driver Health Protocol is reached. This may\r
require the processing of HII Messages, HII Form, and invocation of repair operations.\r
\r
@param DriverHealth A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\r
@param ControllerHandle The class guid specifies which form set will be displayed.\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
+ @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
@param HealthStatus The health status of the controller.\r
- @param MessageList An array of warning or error messages associated \r
- with the controller specified by ControllerHandle and \r
+ @param MessageList 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
- @param FormHiiHandle The HII handle for an HII form associated with the \r
+ @param FormHiiHandle The HII handle for an HII form associated with the\r
controller specified by ControllerHandle and ChildHandle.\r
@param RebootRequired Indicate whether a reboot is required to repair the controller.\r
**/\r
/**\r
Reports the progress of a repair operation.\r
\r
- @param[in] Value A value between 0 and Limit that identifies the current \r
+ @param[in] Value A value between 0 and Limit that identifies the current\r
progress of the repair operation.\r
\r
@param[in] Limit The maximum value of Value for the current repair operation.\r
- For example, a driver that wants to specify progress in \r
+ For example, a driver that wants to specify progress in\r
percent would use a Limit value of 100.\r
\r
@retval EFI_SUCCESS The progress of a repair operation is reported successfully.\r
Processes a set of messages returned by the GetHealthStatus ()\r
service of the EFI Driver Health Protocol\r
\r
- @param MessageList The MessageList point to messages need to processed. \r
+ @param MessageList The MessageList point to messages need to processed.\r
\r
**/\r
VOID\r
\r
\r
/**\r
- Collect and display the platform's driver health relative information, allow user to do interactive \r
+ Collect and display the platform's driver health relative information, allow user to do interactive\r
operation while the platform is unhealthy.\r
\r
- This function display a form which divided into two parts. The one list all modules which has installed \r
+ This function display a form which divided into two parts. The one list all modules which has installed\r
driver health protocol. The list usually contain driver name, controller name, and it's health info.\r
While the driver name can't be retrieved, will use device path as backup. The other part of the form provide\r
a choice to the user to repair all platform.\r
\r
/**\r
\r
- Select the best matching language according to front page policy for best user experience. \r
- \r
- This function supports both ISO 639-2 and RFC 4646 language codes, but language \r
- code types may not be mixed in a single call to this function. \r
+ Select the best matching language according to front page policy for best user experience.\r
+\r
+ This function supports both ISO 639-2 and RFC 4646 language codes, but language\r
+ code types may not be mixed in a single call to this function.\r
\r
@param SupportedLanguages A pointer to a Null-terminated ASCII string that\r
- contains a set of language codes in the format \r
+ contains a set of language codes in the format\r
specified by Iso639Language.\r
@param Iso639Language If TRUE, then all language codes are assumed to be\r
in ISO 639-2 format. If FALSE, then all language\r
codes are assumed to be in RFC 4646 language format.\r
\r
@retval NULL The best matching language could not be found in SupportedLanguages.\r
- @retval NULL There are not enough resources available to return the best matching \r
+ @retval NULL There are not enough resources available to return the best matching\r
language.\r
- @retval Other A pointer to a Null-terminated ASCII string that is the best matching \r
+ @retval Other A pointer to a Null-terminated ASCII string that is the best matching\r
language in SupportedLanguages.\r
**/\r
CHAR8 *\r
@param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.\r
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.\r
@param ComponentName A pointer to the Component Name (2) protocol interface.\r
- @param SupportedLanguage The best suitable language that matches the SupportedLangues interface for the \r
+ @param SupportedLanguage The best suitable language that matches the SupportedLangues interface for the\r
located Component Name (2) instance.\r
\r
@retval EFI_SUCCESS The Component Name (2) protocol instance is successfully located and we find\r
This function gets driver name from Component Name 2 protocol interface and Component Name protocol interface\r
in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the driver name.\r
If the attempt fails, it then gets the driver name from EFI 1.1 Component Name protocol for backward\r
- compatibility support. \r
+ compatibility support.\r
\r
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.\r
@param DriverName A pointer to the Unicode string to return. This Unicode string is the name\r
This function gets controller name from Component Name 2 protocol interface and Component Name protocol interface\r
in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name.\r
If the attempt fails, it then gets the controller name from EFI 1.1 Component Name protocol for backward\r
- compatibility support. \r
+ compatibility support.\r
\r
@param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.\r
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.\r
\r
/**\r
This function gets controller name from Component Name 2 protocol interface and Component Name protocol interface\r
- in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name. \r
+ in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name.\r
If the attempt fails, it then gets the controller name from EFI 1.1 Component Name protocol for backward\r
- compatibility support. \r
+ compatibility support.\r
\r
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.\r
@param ControllerHandle The handle of a controller that the driver specified by This is managing.\r
projects / mirror_edk2.git / blobdiff