Minor code enhancement.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9686 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index eeae07f014e59967a881c92ab51d09e62fd73c89..a9b89316bf30b0e83b7864f4367d751cce943847 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -4,7 +4,7 @@
     2) BDS boot device connect interface\r
     3) BDS Misc interfaces for mainting boot variable, ouput string.\r
 \r
     2) BDS boot device connect interface\r
     3) BDS Misc interfaces for mainting boot variable, ouput string.\r
 \r

-Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2010, Intel Corporation. <BR>\r

 All rights reserved. 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
 All rights reserved. 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


@@ -566,10 +566,17 @@ typedef struct {
   UINTN   Maxlen;\r
 } POOL_PRINT;\r
 \r
   UINTN   Maxlen;\r
 } POOL_PRINT;\r
 \r

+typedef\r
+VOID\r
+(*DEV_PATH_FUNCTION) (\r
+  IN OUT POOL_PRINT       *Str,\r
+  IN VOID                 *DevPath\r
+  );\r
+\r

 typedef struct {\r
 typedef struct {\r

-  UINT8 Type;\r
-  UINT8 SubType;\r
-  VOID (*Function) (POOL_PRINT *, VOID *);\r
+  UINT8             Type;\r
+  UINT8             SubType;\r
+  DEV_PATH_FUNCTION Function;\r

 } DEVICE_PATH_STRING_TABLE;\r
 \r
 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid;\r
 } DEVICE_PATH_STRING_TABLE;\r
 \r
 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid;\r

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/Ipf/ShadowRom.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/Ipf/ShadowRom.c
index 10e8f55c55b2a87ac46efccf4a1070bc6dfc4c00..28af4fd7ead6ad048a6d151db0a2add94def98e8 100644 (file)
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/Ipf/ShadowRom.c
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/Ipf/ShadowRom.c
@@ -1,7 +1,7 @@
 /** @file\r
   Shadow all option rom\r
 \r
 /** @file\r
   Shadow all option rom\r
 \r

-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2010, Intel Corporation. <BR>\r

 All rights reserved. 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
 All rights reserved. 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


@@ -20,6 +20,7 @@ UINT8 mShadowRomFlag = 0;
   Shadow all opton ROM if the it is not done.\r
 **/\r
 VOID\r
   Shadow all opton ROM if the it is not done.\r
 **/\r
 VOID\r

+EFIAPI\r

 ShadowAllOptionRom(\r
   VOID\r
   )\r
 ShadowAllOptionRom(\r
   VOID\r
   )\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
index 15435056f8d4c8c2a5a602c687a387866e45b0a6..8170f1136321b0ecc53fd5d266df82aaab795a2a 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
@@ -1,7 +1,7 @@
 /** @file\r
   The platform device manager reference implementation\r
 \r
 /** @file\r
   The platform device manager reference implementation\r
 \r

-Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2010, Intel Corporation. <BR>\r

 All rights reserved. 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
 All rights reserved. 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


@@ -978,22 +978,19 @@ CallDriverHealth (
 }\r
 \r
 \r
 }\r
 \r
 \r

-/*\r
+/**\r

   Check the Driver Health status of a single controller and try to process it if not healthy.\r
 \r
   This function called by CheckAllControllersHealthStatus () function in order to process a specify\r
   contoller's health state.\r
 \r
   Check the Driver Health status of a single controller and try to process it if not healthy.\r
 \r
   This function called by CheckAllControllersHealthStatus () function in order to process a specify\r
   contoller's health state.\r
 \r

-  @param DriverHealth       A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\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
   @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
+                            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
   @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
-                           ChildHandle.  This is an optional parameter that may be NULL.\r
-  @param FormHiiHandle      The HII handle for an HII form associated with the \r
-                           controller specified by ControllerHandle and ChildHandle.\r

 \r
   @retval EFI_INVALID_PARAMETER   HealthStatus or DriverHealth is NULL.\r
   @retval HealthStatus            The Health status of specify controller.\r
 \r
   @retval EFI_INVALID_PARAMETER   HealthStatus or DriverHealth is NULL.\r
   @retval HealthStatus            The Health status of specify controller.\r


@@ -1001,7 +998,7 @@ CallDriverHealth (
   @retval EFI_NOT_FOUND           No controller in the platform install Driver Health Protocol.\r
   @retval EFI_SUCCESS             The Health related operation has been taken successfully.\r
 \r
   @retval EFI_NOT_FOUND           No controller in the platform install Driver Health Protocol.\r
   @retval EFI_SUCCESS             The Health related operation has been taken successfully.\r
 \r

-*/\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 GetSingleControllerHealthStatus (\r
 EFI_STATUS\r
 EFIAPI\r
 GetSingleControllerHealthStatus (\r


@@ -1306,14 +1303,14 @@ Done:
 }\r
 \r
 \r
 }\r
 \r
 \r

-/*\r
+/**\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
   @retval TRUE       No controller install Driver Health Protocol,\r
                      or all controllers in the platform are in healthy status.\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
   @retval TRUE       No controller install Driver Health Protocol,\r
                      or all controllers in the platform are in healthy status.\r

-*/\r
+**/\r

 BOOLEAN\r
 PlaformHealthStatusCheck (\r
   VOID\r
 BOOLEAN\r
 PlaformHealthStatusCheck (\r
   VOID\r


@@ -1570,7 +1567,7 @@ ProcessMessages (
 \r
 }\r
 \r
 \r
 }\r
 \r

-/*\r
+/**\r

   Repair the whole platform.\r
 \r
   This function is the main entry for user choose "Repair All" in the front page.\r
   Repair the whole platform.\r
 \r
   This function is the main entry for user choose "Repair All" in the front page.\r


@@ -1580,7 +1577,7 @@ ProcessMessages (
   @param DriverHealthList   A Pointer to the list contain all of the platform driver health\r
                             information.\r
 \r
   @param DriverHealthList   A Pointer to the list contain all of the platform driver health\r
                             information.\r
 \r

-*/\r
+**/\r

 VOID\r
 PlatformRepairAll (\r
   IN LIST_ENTRY  *DriverHealthList\r
 VOID\r
 PlatformRepairAll (\r
   IN LIST_ENTRY  *DriverHealthList\r


@@ -1671,10 +1668,10 @@ DriverHealthSelectBestLanguage (
   @param  SupportedLanguage    The best suitable language that matches the SupportedLangues interface for the \r
                                located Component Name (2) instance.\r
 \r
   @param  SupportedLanguage    The best suitable language that matches the SupportedLangues interface for the \r
                                located Component Name (2) instance.\r
 \r

-  @param  EFI_SUCCESS          The Component Name (2) protocol instance is successfully located and we find\r
+  @retval EFI_SUCCESS          The Component Name (2) protocol instance is successfully located and we find\r

                                the best matching language it support.\r
                                the best matching language it support.\r

-  @param  EFI_UNSUPPORTED      The input Language is not supported by the Component Name (2) protocol.\r
-  @param  Other                Some error occurs when locating Component Name (2) protocol instance or finding\r
+  @retval EFI_UNSUPPORTED      The input Language is not supported by the Component Name (2) protocol.\r
+  @retval Other                Some error occurs when locating Component Name (2) protocol instance or finding\r

                                the supported language.\r
 \r
 **/\r
                                the supported language.\r
 \r
 **/\r


@@ -1893,7 +1890,6 @@ GetControllerNameWorker (
                                It will also be NULL for bus drivers that attempt to retrieve the name\r
                                of the bus controller. It will not be NULL for a bus driver that attempts\r
                                to retrieve the name of a child controller.\r
                                It will also be NULL for bus drivers that attempt to retrieve the name\r
                                of the bus controller. It will not be NULL for a bus driver that attempts\r
                                to retrieve the name of a child controller.\r

-  @param  Language             An ASCII string that represents the language command line option.\r

   @param  ControllerName       A pointer to the Unicode string to return. This Unicode string\r
                                is the name of the controller specified by ControllerHandle and ChildHandle.\r
 \r
   @param  ControllerName       A pointer to the Unicode string to return. This Unicode string\r
                                is the name of the controller specified by ControllerHandle and ChildHandle.\r
 \r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
index d04027ae4c49a97828fad1b7f6882f3cb557a475..c706f55d92e56b61e5c5a17f5d4891b77149cd9e 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
@@ -1,7 +1,7 @@
 /** @file\r
   The platform device manager reference implement\r
 \r
 /** @file\r
   The platform device manager reference implement\r
 \r

-Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2010, Intel Corporation. <BR>\r

 All rights reserved. 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
 All rights reserved. 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


@@ -232,22 +232,19 @@ CallDeviceManager (
   );\r
 \r
 \r
   );\r
 \r
 \r

-/*\r
+/**\r

   Check the Driver Health status of a single controller and try to process it if not healthy.\r
 \r
   This function called by CheckAllControllersHealthStatus () function in order to process a specify\r
   contoller's health state.\r
 \r
   Check the Driver Health status of a single controller and try to process it if not healthy.\r
 \r
   This function called by CheckAllControllersHealthStatus () function in order to process a specify\r
   contoller's health state.\r
 \r

-  @param DriverHealth       A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.\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
   @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
+                            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
   @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
-                           ChildHandle.  This is an optional parameter that may be NULL.\r
-  @param FormHiiHandle      The HII handle for an HII form associated with the \r
-                           controller specified by ControllerHandle and ChildHandle.\r

 \r
   @retval EFI_INVALID_PARAMETER   HealthStatus or DriverHealth is NULL.\r
   @retval HealthStatus            The Health status of specify controller.\r
 \r
   @retval EFI_INVALID_PARAMETER   HealthStatus or DriverHealth is NULL.\r
   @retval HealthStatus            The Health status of specify controller.\r


@@ -255,7 +252,7 @@ CallDeviceManager (
   @retval EFI_NOT_FOUND           No controller in the platform install Driver Health Protocol.\r
   @retval EFI_SUCCESS             The Health related operation has been taken successfully.\r
 \r
   @retval EFI_NOT_FOUND           No controller in the platform install Driver Health Protocol.\r
   @retval EFI_SUCCESS             The Health related operation has been taken successfully.\r
 \r

-*/\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 GetSingleControllerHealthStatus (\r
 EFI_STATUS\r
 EFIAPI\r
 GetSingleControllerHealthStatus (\r


@@ -285,20 +282,20 @@ GetAllControllersHealthStatus (
   IN OUT LIST_ENTRY  *DriverHealthList\r
   );\r
 \r
   IN OUT LIST_ENTRY  *DriverHealthList\r
   );\r
 \r

-/*\r
+/**\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
   @retval TRUE       No controller install Driver Health Protocol,\r
                      or all controllers in the platform are in healthy status.\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
   @retval TRUE       No controller install Driver Health Protocol,\r
                      or all controllers in the platform are in healthy status.\r

-*/\r
+**/\r

 BOOLEAN\r
 PlaformHealthStatusCheck (\r
   VOID\r
   );\r
 \r
 BOOLEAN\r
 PlaformHealthStatusCheck (\r
   VOID\r
   );\r
 \r

-/*\r
+/**\r

   Repair the whole platform.\r
 \r
   This function is the main entry for user choose "Repair All" in the front page.\r
   Repair the whole platform.\r
 \r
   This function is the main entry for user choose "Repair All" in the front page.\r


@@ -308,7 +305,7 @@ PlaformHealthStatusCheck (
   @param DriverHealthList   A Pointer to the list contain all of the platform driver health\r
                             information.\r
 \r
   @param DriverHealthList   A Pointer to the list contain all of the platform driver health\r
                             information.\r
 \r

-*/\r
+**/\r

 VOID\r
 PlatformRepairAll (\r
   IN LIST_ENTRY  *DriverHealthList\r
 VOID\r
 PlatformRepairAll (\r
   IN LIST_ENTRY  *DriverHealthList\r


@@ -420,10 +417,10 @@ DriverHealthSelectBestLanguage (
   @param  SupportedLanguage    The best suitable language that matches the SupportedLangues interface for the \r
                                located Component Name (2) instance.\r
 \r
   @param  SupportedLanguage    The best suitable language that matches the SupportedLangues interface for the \r
                                located Component Name (2) instance.\r
 \r

-  @param  EFI_SUCCESS          The Component Name (2) protocol instance is successfully located and we find\r
+  @retval EFI_SUCCESS          The Component Name (2) protocol instance is successfully located and we find\r

                                the best matching language it support.\r
                                the best matching language it support.\r

-  @param  EFI_UNSUPPORTED      The input Language is not supported by the Component Name (2) protocol.\r
-  @param  Other                Some error occurs when locating Component Name (2) protocol instance or finding\r
+  @retval EFI_UNSUPPORTED      The input Language is not supported by the Component Name (2) protocol.\r
+  @retval Other                Some error occurs when locating Component Name (2) protocol instance or finding\r

                                the supported language.\r
 \r
 **/\r
                                the supported language.\r
 \r
 **/\r


@@ -504,7 +501,6 @@ DriverHealthGetDriverName (
   @retval  Other               The controller name cannot be retrieved from Component Name (2) protocol.\r
 \r
 **/\r
   @retval  Other               The controller name cannot be retrieved from Component Name (2) protocol.\r
 \r
 **/\r

-\r

 EFI_STATUS\r
 GetControllerNameWorker (\r
   IN  EFI_GUID    *ProtocolGuid,\r
 EFI_STATUS\r
 GetControllerNameWorker (\r
   IN  EFI_GUID    *ProtocolGuid,\r