Code scrub for GenericBdsLib library instance.

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

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c b/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
index efaf82addc4c671d710f2d7260216295901d5825..f5960aa6e7df1585bb267aa3704f963c0c0f568d 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
@@ -1,6 +1,5 @@
 /** @file\r
-  BDS Lib functions which relate with create or process the boot\r
-  option.\r
+  BDS Lib functions which relate with create or process the boot option.\r
 \r
 Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsConnect.c b/MdeModulePkg/Library/GenericBdsLib/BdsConnect.c
index 66b09ee46522c1d413b55f44132ef4e6e686260e..4c721e07db5e9c26fb01f0d24033b69af7145398 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/BdsConnect.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsConnect.c
@@ -317,9 +317,11 @@ BdsLibConnectAllDriversToAllControllers (
                                 element  being a USB WWID or a USB Class device\r
                                 path\r
 \r
-  @return EFI_INVALID_PARAMETER\r
-  @return EFI_SUCCESS\r
-  @return EFI_NOT_FOUND\r
+  @return EFI_INVALID_PARAMETER  RemainingDevicePath is NULL pointer.\r
+                                 RemainingDevicePath is not a USB device path.\r
+                                 Invalid HostControllerPI type.\r
+  @return EFI_SUCCESS            Sucess to connect USB device\r
+  @return EFI_NOT_FOUND          Fail to find hanlde for USB controller to connect.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c b/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
index af3572ff7de2ce5a6db844ee39d52056d92fb593..ff72aa0f08be04abb260cd01fe77cebe6f4fd3fa 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
@@ -47,7 +47,6 @@ IsNvNeed (
   }\r
 }\r
 \r
-\r
 /**\r
   This function update console variable based on ConVarName, it can\r
   add or remove one specific console device path from the variable\r
@@ -185,6 +184,7 @@ BdsLibUpdateConsoleVariable (
   @param  ConVarName               Console related variable name, ConIn, ConOut,\r
                                    ErrOut.\r
 \r
+  @retval EFI_UNSUPPORTED          Request console variable does not exist.\r
   @retval EFI_NOT_FOUND            There is not any console devices connected\r
                                    success\r
   @retval EFI_SUCCESS              Success connect any one instance of the console\r
@@ -627,6 +627,9 @@ LockKeyboards (
 \r
   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
   @retval EFI_UNSUPPORTED Logo not found.\r
+                          Fail to locate ConsoleControl protocol.\r
+                          Fail to get UgaDraw or Gop handle.\r
+                          Fail to switch grahic mode.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -875,7 +878,7 @@ EnableQuietBoot (
   Simple Text Out screens will now be synced up with all non UGA output devices\r
 \r
   @retval EFI_SUCCESS          UGA devices are back in text mode and synced up.\r
-  @retval EFI_UNSUPPORTED      Logo not found\r
+  @retval EFI_UNSUPPORTED      Fail to locate ConsoleControl Protocol.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Library/GenericBdsLib/DevicePath.c b/MdeModulePkg/Library/GenericBdsLib/DevicePath.c
index 421bba00cb37119e2961d6e50b2aab1fa1693f5b..478dfd81fa0f9c96ba244b8f7d454cbe236105c8 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/DevicePath.c
+++ b/MdeModulePkg/Library/GenericBdsLib/DevicePath.c
@@ -1492,45 +1492,3 @@ Done:
   Str.str[Str.len] = 0;\r
   return Str.str;\r
 }\r
-\r
-/**\r
-  Function creates a device path data structure that identically matches the\r
-  device path passed in.\r
-\r
-  @param  DevPath  A pointer to a device path data structure.\r
-\r
-  @return The new copy of DevPath is created to identically match the input.\r
-  @return Otherwise, NULL is returned.\r
-\r
-**/\r
-EFI_DEVICE_PATH_PROTOCOL *\r
-LibDuplicateDevicePathInstance (\r
-  IN EFI_DEVICE_PATH_PROTOCOL  *DevPath\r
-  )\r
-{\r
-  EFI_DEVICE_PATH_PROTOCOL  *NewDevPath;\r
-  EFI_DEVICE_PATH_PROTOCOL  *DevicePathInst;\r
-  EFI_DEVICE_PATH_PROTOCOL  *Temp;\r
-  UINTN                     Size;\r
-\r
-  //\r
-  // get the size of an instance from the input\r
-  //\r
-  Temp            = DevPath;\r
-  DevicePathInst  = GetNextDevicePathInstance (&Temp, &Size);\r
-\r
-  //\r
-  // Make a copy\r
-  //\r
-  NewDevPath = NULL;\r
-  if (Size != 0) {\r
-    NewDevPath = AllocateZeroPool (Size);\r
-    ASSERT (NewDevPath != NULL);\r
-  }\r
-\r
-  if (NewDevPath != NULL) {\r
-    CopyMem (NewDevPath, DevicePathInst, Size);\r
-  }\r
-\r
-  return NewDevPath;\r
-}\r

diff --git a/MdeModulePkg/Library/GenericBdsLib/GenericBdsLib.inf b/MdeModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
index 34100d2668513cdabaa975d650b87c076d77db32..e9280c9175d87299ecd157db4a16909a7e07c5d0 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
+++ b/MdeModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
@@ -1,6 +1,9 @@
 #/** @file\r
 #  \r
-#    Component name for module GenericBdsLib\r
+#  General BDS defines and produce general interfaces for platform BDS driver including:\r
+#  1) BDS boot policy interface;\r
+#  2) BDS boot device connect interface;\r
+#  3) BDS Misc interfaces for mainting boot variable, ouput string, etc.\r
 #  \r
 #  Copyright (c) 2007 - 2008, Intel Corporation. <BR>\r
 #  All rights reserved. This program and the accompanying materials\r