Code scrub for BdsDxe module.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
index 30da602f868949bf02b97043ae8b9af61a76d7c9..3c8b1c443b6cc88b0fa4644f06cc1aae15d0210c 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
+++ b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
@@ -18,14 +18,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "Hotkey.h"\r
 #include "HwErrRecSupport.h"\r
 \r
-//\r
-// BDS arch protocol instance initial value.\r
-//\r
-// Note: Current BDS not directly get the BootMode, DefaultBoot,\r
-// TimeoutDefault, MemoryTestLevel value from the BDS arch protocol.\r
-// Please refer to the library useage of BdsLibGetBootMode, BdsLibGetTimeout \r
-// and PlatformBdsDiagnostics in BdsPlatform.c\r
-//\r
+///\r
+/// BDS arch protocol instance initial value.\r
+///\r
+/// Note: Current BDS not directly get the BootMode, DefaultBoot,\r
+/// TimeoutDefault, MemoryTestLevel value from the BDS arch protocol.\r
+/// Please refer to the library useage of BdsLibGetBootMode, BdsLibGetTimeout \r
+/// and PlatformBdsDiagnostics in BdsPlatform.c\r
+///\r
 EFI_BDS_ARCH_PROTOCOL_INSTANCE  gBdsInstanceTemplate = {\r
   EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE,\r
   NULL,\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
index 4d5a4580c68448beba770fad4dc19dfd34d6ff20..e11e279247315b0f3b90734a0c67b6b3d5ecea2d 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
@@ -25,11 +25,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 \r
   @param AStr               Pointer to input Ascii string.\r
-  @param Size            The number of characters to translate.\r
+  @param Size               The number of characters to translate.\r
   @param UStr               Pointer to output Unicode string buffer.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 AsciiToUnicodeSize (\r
@@ -52,38 +50,6 @@ AsciiToUnicodeSize (
   UStr[Idx] = 0;\r
 }\r
 \r
-/**\r
-\r
-  change a Unicode string t ASCII string\r
-\r
-\r
-  @param UStr            Unicode string\r
-                         Lenght - most possible length of AStr\r
-  @param Length          The length of UStr.\r
-  @param AStr            ASCII string to pass out\r
-\r
-  @return Actual length\r
-\r
-**/\r
-UINTN\r
-UnicodeToAscii (\r
-  IN  CHAR16  *UStr,\r
-  IN  UINTN   Length,\r
-  OUT CHAR8   *AStr\r
-  )\r
-{\r
-  UINTN Index;\r
-\r
-  //\r
-  // just buffer copy, not character copy\r
-  //\r
-  for (Index = 0; Index < Length; Index++) {\r
-    *AStr++ = (CHAR8) *UStr++;\r
-  }\r
-\r
-  return Index;\r
-}\r
-\r
 /**\r
   Build Legacy Device Name String according.\r
 \r
@@ -92,15 +58,13 @@ UnicodeToAscii (
   @param BufSize         The buffer size.\r
   @param BootString      The output string.\r
 \r
-  @return VOID           No output.\r
-\r
 **/\r
 VOID\r
 BdsBuildLegacyDevNameString (\r
-  IN BBS_TABLE                 *CurBBSEntry,\r
-  IN UINTN                     Index,\r
-  IN UINTN                     BufSize,\r
-  OUT CHAR16                   *BootString\r
+  IN  BBS_TABLE                 *CurBBSEntry,\r
+  IN  UINTN                     Index,\r
+  IN  UINTN                     BufSize,\r
+  OUT CHAR16                    *BootString\r
   )\r
 {\r
   CHAR16  *Fmt;\r
@@ -248,7 +212,7 @@ BdsCreateLegacyBootOption (
   BOOLEAN              IndexNotFound;\r
   BBS_BBS_DEVICE_PATH  *NewBbsDevPathNode;\r
 \r
-  if (NULL == (*BootOrderList)) {\r
+  if ((*BootOrderList) == NULL) {\r
     CurrentBootOptionNo = 0;\r
   } else {\r
     for (ArrayIndex = 0; ArrayIndex < (UINTN) (*BootOrderListSize / sizeof (UINT16)); ArrayIndex++) {\r
@@ -282,7 +246,8 @@ BdsCreateLegacyBootOption (
   //\r
   // Create new BBS device path node with description string\r
   //\r
-  UnicodeToAscii (BootDesc, StrSize (BootDesc), HelpString);\r
+  UnicodeStrToAsciiStr ((CONST CHAR16*)&BootDesc, (CHAR8*)&HelpString);\r
+\r
   StringLen = AsciiStrLen (HelpString);\r
   NewBbsDevPathNode = AllocateZeroPool (sizeof (BBS_BBS_DEVICE_PATH) + StringLen);\r
   if (NewBbsDevPathNode == NULL) {\r
@@ -431,8 +396,6 @@ BdsIsLegacyBootOption (
 /**\r
   Delete all the invalid legacy boot options.\r
 \r
-  \r
-\r
   @retval EFI_SUCCESS             All invalide legacy boot options are deleted.\r
   @retval EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.\r
   @retval EFI_NOT_FOUND           Fail to retrive variable of boot order.\r
@@ -502,7 +465,10 @@ BdsDeleteAllInvalidLegacyBootOptions (
       SafeFreePool (BootOrder);\r
       return EFI_OUT_OF_RESOURCES;\r
     }\r
-\r
+  \r
+    //\r
+    // Skip Non-Legacy boot options\r
+    // \r
     if (!BdsIsLegacyBootOption (BootOptionVar, &BbsEntry, &BbsIndex)) {\r
       SafeFreePool (BootOptionVar);\r
       Index++;\r
@@ -544,6 +510,9 @@ BdsDeleteAllInvalidLegacyBootOptions (
       );\r
   }\r
 \r
+  //\r
+  // Adjust the number of boot options.\r
+  //\r
   if (BootOrderSize != 0) {\r
     Status = gRT->SetVariable (\r
                     L"BootOrder",\r
@@ -600,6 +569,9 @@ BdsFindLegacyBootOptionByDevType (
     return Found;\r
   }\r
 \r
+  //\r
+  // Loop all boot option from variable\r
+  //\r
   for (BootOrderIndex = 0; BootOrderIndex < BootOptionNum; BootOrderIndex++) {\r
     Index = (UINTN) BootOrder[BootOrderIndex];\r
     UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", Index);\r
@@ -612,6 +584,9 @@ BdsFindLegacyBootOptionByDevType (
       continue;\r
     }\r
 \r
+    //\r
+    // Skip Non-legacy boot option\r
+    //\r
     if (!BdsIsLegacyBootOption (BootOptionVar, &BbsEntry, BbsIndex)) {\r
       SafeFreePool (BootOptionVar);\r
       continue;\r
@@ -659,6 +634,9 @@ BdsCreateOneLegacyBootOption (
 \r
   DevPath                       = NULL;\r
 \r
+  //\r
+  // Create device path node.\r
+  //\r
   BbsDevPathNode.Header.Type    = BBS_DEVICE_PATH;\r
   BbsDevPathNode.Header.SubType = BBS_BBS_DP;\r
   SetDevicePathNodeLength (&BbsDevPathNode.Header, sizeof (BBS_BBS_DEVICE_PATH));\r
@@ -691,8 +669,6 @@ BdsCreateOneLegacyBootOption (
 \r
   Add the legacy boot options from BBS table if they do not exist.\r
 \r
-  \r
-\r
   @retval EFI_SUCCESS       The boot options are added successfully \r
                             or they are already in boot options.\r
 \r
@@ -876,6 +852,9 @@ BdsCreateDevOrder (
   Ptr         = NULL;\r
   Status      = EFI_SUCCESS;\r
 \r
+  //\r
+  // Count all boot devices\r
+  //\r
   for (Index = 0; Index < BbsCount; Index++) {\r
     if (BbsTable[Index].BootPriority == BBS_IGNORE_ENTRY) {\r
       continue;\r
@@ -913,6 +892,9 @@ BdsCreateDevOrder (
   TotalSize += (HeaderSize + sizeof (UINT16) * NETCount);\r
   TotalSize += (HeaderSize + sizeof (UINT16) * BEVCount);\r
 \r
+  //\r
+  // Create buffer to hold all boot device order\r
+  //\r
   DevOrder = AllocateZeroPool (TotalSize);\r
   if (NULL == DevOrder) {\r
     return EFI_OUT_OF_RESOURCES;\r
@@ -960,6 +942,9 @@ BdsCreateDevOrder (
     Ptr = (UINT8 *) BdsFillDevOrderBuf (BbsTable, BBS_BEV_DEVICE, BbsCount, (UINT16 *) Ptr);\r
   }\r
 \r
+  //\r
+  // Save device order for legacy boot device to variable.\r
+  //\r
   Status = gRT->SetVariable (\r
                   VAR_LEGACY_DEV_ORDER,\r
                   &EfiLegacyDevOrderGuid,\r
@@ -1535,7 +1520,7 @@ PrintBbsTable (
   @param  Entry             The boot option is to be checked for refresh BBS table.\r
   \r
   @retval EFI_SUCCESS       The boot priority for BBS entries is refreshed successfully.\r
-\r
+  @return status of BdsSetBootPriority4SameTypeDev()\r
 **/\r
 EFI_STATUS\r
 BdsRefreshBbsTableForBoot (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h
index 542c9d9c462c9e1a3cdbd32553981e97e9774862..95326b8d582d0a70088e32e6ed2b02fd1b171083 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h
@@ -56,9 +56,6 @@ BdsDeleteAllInvalidLegacyBootOptions (
 \r
   Add the legacy boot options from BBS table if they do not exist.\r
 \r
-\r
-  \r
-\r
   @retval  EFI_SUCCESS        The boot options are added successfully or they are already in boot options.\r
   @retval  others             An error occurred when creating legacy boot options.\r
 \r
@@ -83,13 +80,12 @@ BdsUpdateLegacyDevOrder (
   );\r
 \r
 /**\r
-\r
   Set the boot priority for BBS entries based on boot option entry and boot order.\r
 \r
   @param  Entry             The boot option is to be checked for refresh BBS table.\r
   \r
   @retval EFI_SUCCESS       The boot priority for BBS entries is refreshed successfully.\r
-\r
+  @return status of BdsSetBootPriority4SameTypeDev()\r
 **/\r
 EFI_STATUS\r
 BdsRefreshBbsTableForBoot (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c
index c6b44d61d79e5a42d2d872d3a238d6de29386e11..2e4b1c6fb271e5d1e5ed6c2f464221c0fe9e7867 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c
@@ -48,8 +48,7 @@ EfiLibLocateProtocol (
 \r
   Function opens and returns a file handle to the root directory of a volume.\r
 \r
-\r
-  @param DeviceHandle    - A handle for a device\r
+  @param DeviceHandle    A handle for a device\r
 \r
   @return A valid file handle or NULL is returned\r
 \r
@@ -96,9 +95,9 @@ EfiLibOpenRoot (
   EFI interfaces.\r
 \r
 \r
-  @param Status          - Current status\r
-  @param Buffer          - Current allocated buffer, or NULL\r
-  @param BufferSize      - Current buffer size needed\r
+  @param Status          Current status\r
+  @param Buffer          Current allocated buffer, or NULL\r
+  @param BufferSize      Current buffer size needed\r
 \r
   @retval  TRUE  if the buffer was reallocated and the caller\r
                  should try the API again.\r
@@ -173,9 +172,8 @@ EfiLibGetVariable (
 /**\r
   Function deletes the variable specified by VarName and VarGuid.\r
 \r
-\r
   @param VarName           A Null-terminated Unicode string that is\r
-                         the name of the vendor's variable.\r
+                           the name of the vendor's variable.\r
                          \r
   @param VarGuid           A unique identifier for the vendor.\r
 \r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
index 44b30d841e3a067b324dcb4f28dd0d2e3f41810f..03b3818167edde1e695129b06861468a90f10566 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
@@ -25,12 +25,12 @@ EFI_DEVICE_PATH_PROTOCOL  EndDevicePath[] = {
 };\r
 \r
 \r
-EFI_GUID EfiLegacyDevOrderGuid = EFI_LEGACY_DEV_ORDER_VARIABLE_GUID;\r
-EFI_GUID mBootMaintGuid = BOOT_MAINT_FORMSET_GUID;\r
-EFI_GUID mFileExplorerGuid = FILE_EXPLORE_FORMSET_GUID;\r
+EFI_GUID EfiLegacyDevOrderGuid  = EFI_LEGACY_DEV_ORDER_VARIABLE_GUID;\r
+EFI_GUID mBootMaintGuid         = BOOT_MAINT_FORMSET_GUID;\r
+EFI_GUID mFileExplorerGuid      = FILE_EXPLORE_FORMSET_GUID;\r
 \r
-CHAR16  mBootMaintStorageName[] = L"BmData";\r
-CHAR16  mFileExplorerStorageName[] = L"FeData";\r
+CHAR16  mBootMaintStorageName[]     = L"BmData";\r
+CHAR16  mFileExplorerStorageName[]  = L"FeData";\r
 \r
 /**\r
   Init all memu.\r
@@ -102,14 +102,14 @@ CreateMenuStringToken (
   or more named elements from the target driver.\r
 \r
 \r
-  @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
-  @param Request         - A null-terminated Unicode string in <ConfigRequest> format.\r
-  @param Progress        - On return, points to a character in the Request string.\r
+  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+  @param Request         A null-terminated Unicode string in <ConfigRequest> format.\r
+  @param Progress        On return, points to a character in the Request string.\r
                          Points to the string's null terminator if request was successful.\r
                          Points to the most recent '&' before the first failing name/value\r
                          pair (or the beginning of the string if the failure is in the\r
                          first name/value pair) if the request was not successful.\r
-  @param Results         - A null-terminated Unicode string in <ConfigAltResp> format which\r
+  @param Results         A null-terminated Unicode string in <ConfigAltResp> format which\r
                          has all values filled in for the names in the Request string.\r
                          String to be allocated by the called function.\r
 \r
@@ -540,10 +540,9 @@ BootMaintCallback (
 /**\r
   Function handling request to apply changes for BMM pages.\r
 \r
-\r
-  @param Private         - Pointer to callback data buffer.\r
-  @param CurrentFakeNVMap - Pointer to buffer holding data of various values used by BMM\r
-  @param FormId          - ID of the form which has sent the request to apply change.\r
+  @param Private            Pointer to callback data buffer.\r
+  @param CurrentFakeNVMap   Pointer to buffer holding data of various values used by BMM\r
+  @param FormId             ID of the form which has sent the request to apply change.\r
 \r
   @retval  EFI_SUCCESS       Change successfully applied.\r
   @retval  Other             Error occurs while trying to apply changes.\r
@@ -728,10 +727,8 @@ Error:
   Discard all changes done to the BMM pages such as Boot Order change,\r
   Driver order change.\r
 \r
-  @param Private         The BMM context data.\r
-  @param CurrentFakeNVMap The current Fack NV Map.\r
-\r
-  \r
+  @param Private            The BMM context data.\r
+  @param CurrentFakeNVMap   The current Fack NV Map.\r
 \r
 **/\r
 VOID\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
index d15bbe04c826b8c50619f9fc9c97ce479ab35e13..b899bc86d7e15afb0cf3f0a00b672410bc858a1a 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
@@ -278,13 +278,11 @@ typedef enum {
 \r
 #define STRING_DEPOSITORY_NUMBER        8\r
 \r
-//\r
-// #pragma pack(1)\r
-//\r
-// Serial Ports attributes, first one is the value for\r
-// return from callback function, stringtoken is used to\r
-// display the value properly\r
-//\r
+///\r
+/// Serial Ports attributes, first one is the value for\r
+/// return from callback function, stringtoken is used to\r
+/// display the value properly\r
+///\r
 typedef struct {\r
   UINTN   Value;\r
   UINT16  StringToken;\r
@@ -498,8 +496,6 @@ BOpt_FindFiles (
   All valid handles in the system except those consume SimpleFs, LoadFile\r
   are stored in DriverMenu for future use.\r
 \r
-   \r
-\r
   @retval EFI_SUCCESS The function complets successfully.\r
   @return Other value if failed to build the DriverMenu.\r
 \r
@@ -637,8 +633,6 @@ BOpt_IsEfiApp (
 \r
   Get the Option Number that has not been allocated for use.\r
 \r
-  \r
-\r
   @return The available Option Number.\r
 \r
 **/\r
@@ -651,8 +645,6 @@ BOpt_GetBootOptionNumber (
 \r
   Get the Option Number that is not in use.\r
 \r
-  \r
-\r
   @return The unused Option Number.\r
 \r
 **/\r
@@ -1315,26 +1307,6 @@ EfiLibFileInfo (
   IN EFI_FILE_HANDLE      FHand\r
   );\r
 \r
-/**\r
-\r
-  change a Unicode string t ASCII string\r
-\r
-\r
-  @param UStr            Unicode string\r
-                         Lenght - most possible length of AStr\r
-  @param Length          The length of UStr.\r
-  @param AStr            ASCII string to pass out\r
-\r
-  @return Actual length\r
-\r
-**/\r
-UINTN\r
-UnicodeToAscii (\r
-  IN  CHAR16  *UStr,\r
-  IN  UINTN   Length,\r
-  OUT CHAR8   *AStr\r
-  );\r
-\r
 /**\r
   This function converts an input device structure to a Unicode string.\r
 \r
@@ -1542,11 +1514,6 @@ BdsStartBootMaint (
 /**\r
   Intialize all the string depositories.\r
 \r
-\r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 InitializeStringDepository (\r
@@ -1571,12 +1538,6 @@ GetStringTokenFromDepository (
 \r
 /**\r
   Reclaim string depositories by moving the current node pointer to list head..\r
-\r
-\r
-   \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 ReclaimStringDepository (\r
@@ -1586,11 +1547,6 @@ ReclaimStringDepository (
 /**\r
   Release resource for all the string depositories.\r
 \r
-\r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 CleanUpStringDepository (\r
@@ -1623,8 +1579,6 @@ ApplyChangeHandler (
   @param Private         The BMM context data.\r
   @param CurrentFakeNVMap The current Fack NV Map.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 DiscardChangeHandler (\r
@@ -1638,8 +1592,6 @@ DiscardChangeHandler (
   @param Private         The BMM context data.\r
   @param NewPageId       The original page ID.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdatePageId (\r
@@ -1736,7 +1688,6 @@ FormSetDispatcher (
 /**\r
   Function returns the value of the specified variable.\r
 \r
-\r
   @param Name            A Null-terminated Unicode string that is\r
                          the name of the vendor's variable.\r
   @param VendorGuid      A unique identifier for the vendor.\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c
index 0d39ae8f8e33095e63b588c283691d520b1a4650..903ecfcdd322f947e79399cf0c10422618fa335e 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c
@@ -24,7 +24,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param MenuType        The Menu type to be created.\r
 \r
-\r
   @retval NULL           If failed to create the menu.\r
   @return                The menu.\r
 \r
@@ -37,6 +36,9 @@ BOpt_CreateMenuEntry (
   BM_MENU_ENTRY *MenuEntry;\r
   UINTN         ContextSize;\r
 \r
+  //\r
+  // Get context size according to menu type\r
+  //\r
   switch (MenuType) {\r
   case BM_LOAD_CONTEXT_SELECT:\r
     ContextSize = sizeof (BM_LOAD_CONTEXT);\r
@@ -65,13 +67,15 @@ BOpt_CreateMenuEntry (
   default:\r
     ContextSize = 0;\r
     break;\r
-\r
   }\r
 \r
-  if (0 == ContextSize) {\r
+  if (ContextSize == 0) {\r
     return NULL;\r
   }\r
 \r
+  //\r
+  // Create new menu entry\r
+  //\r
   MenuEntry = AllocateZeroPool (sizeof (BM_MENU_ENTRY));\r
   if (NULL == MenuEntry) {\r
     return MenuEntry;\r
@@ -80,8 +84,7 @@ BOpt_CreateMenuEntry (
   MenuEntry->VariableContext = AllocateZeroPool (ContextSize);\r
   if (NULL == MenuEntry->VariableContext) {\r
     SafeFreePool (MenuEntry);\r
-    MenuEntry = NULL;\r
-    return MenuEntry;\r
+    return NULL;\r
   }\r
 \r
   MenuEntry->Signature        = BM_MENU_ENTRY_SIGNATURE;\r
@@ -94,8 +97,6 @@ BOpt_CreateMenuEntry (
 \r
   @param MenuEntry   A pointer to BM_MENU_ENTRY.\r
 \r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 BOpt_DestroyMenuEntry (\r
@@ -504,9 +505,6 @@ BOpt_FindFileSystem (
   Free resources allocated in Allocate Rountine.\r
 \r
   @param FreeMenu        Menu to be freed\r
-\r
-  \r
-\r
 **/\r
 VOID\r
 BOpt_FreeMenu (\r
@@ -685,8 +683,6 @@ BOpt_FindFiles (
 /**\r
   Build the LegacyFDMenu LegacyHDMenu LegacyCDMenu according to LegacyBios.GetBbsInfo().\r
 \r
-  \r
-\r
   @retval EFI_SUCCESS The function complete successfully.\r
   @retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.\r
 \r
@@ -825,10 +821,6 @@ BOpt_GetLegacyOptions (
 /**\r
   Free out resouce allocated from Legacy Boot Options.\r
 \r
-  \r
-\r
-  .\r
-\r
 **/\r
 VOID\r
 BOpt_FreeLegacyOptions (\r
@@ -1243,8 +1235,6 @@ BOpt_IsEfiApp (
   All valid handles in the system except those consume SimpleFs, LoadFile\r
   are stored in DriverMenu for future use.\r
 \r
-   \r
-\r
   @retval EFI_SUCCESS The function complets successfully.\r
   @return Other value if failed to build the DriverMenu.\r
 \r
@@ -1334,8 +1324,6 @@ BOpt_FindDrivers (
 \r
   Get the Option Number that has not been allocated for use.\r
 \r
-  \r
-\r
   @return The available Option Number.\r
 \r
 **/\r
@@ -1410,8 +1398,6 @@ BOpt_GetBootOptionNumber (
 \r
   Get the Option Number that is not in use.\r
 \r
-  \r
-\r
   @return The unused Option Number.\r
 \r
 **/\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
index 39be20bdbca596952d707a5d3075cd579c075e9e..635dc34173c04033108293865ce0971c98478bbc 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
@@ -170,9 +170,7 @@ ChangeTerminalDevicePath (
   based on the new BaudRate, Data Bits, parity and Stop Bits\r
   set.\r
 \r
-  @param DevicePath\r
-\r
-  \r
+  @param DevicePath terminal device's path\r
 \r
 **/\r
 VOID\r
@@ -235,14 +233,11 @@ ChangeVariableDevicePath (
 \r
     Node = NextDevicePathNode (Node);\r
   }\r
-\r
-  return ;\r
 }\r
 \r
 /**\r
   Retrieve ACPI UID of UART from device path\r
 \r
-\r
   @param Handle          The handle for the UART device.\r
   @param AcpiUid         The ACPI UID on output.\r
 \r
@@ -289,12 +284,8 @@ RetrieveUartUid (
 /**\r
   Sort Uart handles array with Acpi->UID from low to high.\r
 \r
-\r
   @param Handles         EFI_SERIAL_IO_PROTOCOL handle buffer\r
   @param NoHandles       EFI_SERIAL_IO_PROTOCOL handle count\r
-\r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 SortedUartHandle (\r
@@ -558,7 +549,7 @@ LocateSerialIo (
   @param DevicePath      DevicePath that contains Com ports\r
 \r
   @retval EFI_SUCCESS   The update is successful.\r
-\r
+  @retval EFI_NOT_FOUND Can not find specific menu entry\r
 **/\r
 EFI_STATUS\r
 UpdateComAttributeFromVariable (\r
@@ -857,9 +848,6 @@ GetConsoleMenu (
 /**\r
   Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
 \r
-\r
-  \r
-\r
   @retval EFI_SUCCESS    The function always complete successfully.\r
 \r
 **/\r
@@ -877,9 +865,6 @@ GetAllConsoles (
 /**\r
   Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
 \r
-\r
-              EDES_TODO: Add parameter description\r
-\r
   @retval EFI_SUCCESS    The function always complete successfully.\r
 **/\r
 EFI_STATUS\r
@@ -981,11 +966,7 @@ IsTerminalDevicePath (
 /**\r
   Get mode number according to column and row\r
 \r
-\r
   @param CallbackData    The BMM context data.\r
-\r
-  \r
-\r
 **/\r
 VOID\r
 GetConsoleOutMode (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/Data.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/Data.c
index f1c57469ae633279bf778416f857e98fc1ec0b93..00ef4102292883515ccacb67993600bcee1170a9 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/Data.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/Data.c
@@ -23,9 +23,9 @@ STRING_DEPOSITORY   *DriverOptionStrDepository;
 STRING_DEPOSITORY   *DriverOptionHelpStrDepository;\r
 STRING_DEPOSITORY   *TerminalStrDepository;\r
 \r
-//\r
-// Terminal type string token storage\r
-//\r
+///\r
+/// Terminal type string token storage\r
+///\r
 UINT16              TerminalType[] = {\r
   STRING_TOKEN(STR_COM_TYPE_0),\r
   STRING_TOKEN(STR_COM_TYPE_1),\r
@@ -33,117 +33,117 @@ UINT16              TerminalType[] = {
   STRING_TOKEN(STR_COM_TYPE_3),\r
 };\r
 \r
-//\r
-// File system selection menu\r
-//\r
+///\r
+/// File system selection menu\r
+///\r
 BM_MENU_OPTION      FsOptionMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Console Input Device Selection Menu\r
-//\r
+///\r
+/// Console Input Device Selection Menu\r
+///\r
 BM_MENU_OPTION      ConsoleInpMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Console Output Device Selection Menu\r
-//\r
+///\r
+/// Console Output Device Selection Menu\r
+///\r
 BM_MENU_OPTION      ConsoleOutMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Error Output Device Selection Menu\r
-//\r
+///\r
+/// Error Output Device Selection Menu\r
+///\r
 BM_MENU_OPTION      ConsoleErrMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Boot Option from variable Menu\r
-//\r
+///\r
+/// Boot Option from variable Menu\r
+///\r
 BM_MENU_OPTION      BootOptionMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Driver Option from variable menu\r
-//\r
+///\r
+/// Driver Option from variable menu\r
+///\r
 BM_MENU_OPTION      DriverOptionMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Legacy FD Info from LegacyBios.GetBbsInfo()\r
-//\r
+///\r
+/// Legacy FD Info from LegacyBios.GetBbsInfo()\r
+///\r
 BM_MENU_OPTION      LegacyFDMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Legacy HD Info from LegacyBios.GetBbsInfo()\r
-//\r
+///\r
+/// Legacy HD Info from LegacyBios.GetBbsInfo()\r
+///\r
 BM_MENU_OPTION      LegacyHDMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Legacy CD Info from LegacyBios.GetBbsInfo()\r
-//\r
+///\r
+/// Legacy CD Info from LegacyBios.GetBbsInfo()\r
+///\r
 BM_MENU_OPTION      LegacyCDMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Legacy NET Info from LegacyBios.GetBbsInfo()\r
-//\r
+///\r
+/// Legacy NET Info from LegacyBios.GetBbsInfo()\r
+///\r
 BM_MENU_OPTION      LegacyNETMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Legacy NET Info from LegacyBios.GetBbsInfo()\r
-//\r
+///\r
+/// Legacy NET Info from LegacyBios.GetBbsInfo()\r
+///\r
 BM_MENU_OPTION      LegacyBEVMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Files and sub-directories in current directory menu\r
-//\r
+///\r
+/// Files and sub-directories in current directory menu\r
+///\r
 BM_MENU_OPTION      DirectoryMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
   0\r
 };\r
 \r
-//\r
-// Handles in current system selection menu\r
-//\r
+///\r
+/// Handles in current system selection menu\r
+///\r
 BM_MENU_OPTION      DriverMenu = {\r
   BM_MENU_OPTION_SIGNATURE,\r
   NULL,\r
@@ -156,9 +156,9 @@ BM_MENU_OPTION      TerminalMenu = {
   0\r
 };\r
 \r
-//\r
-// Value and string token correspondency for BaudRate\r
-//\r
+///\r
+/// Value and string token correspondency for BaudRate\r
+///\r
 COM_ATTR            BaudRateList[19] = {\r
   {\r
     115200,\r
@@ -238,9 +238,9 @@ COM_ATTR            BaudRateList[19] = {
   }\r
 };\r
 \r
-//\r
-// Value and string token correspondency for DataBits\r
-//\r
+///\r
+/// Value and string token correspondency for DataBits\r
+///\r
 COM_ATTR            DataBitsList[4] = {\r
   {\r
     5,\r
@@ -260,9 +260,9 @@ COM_ATTR            DataBitsList[4] = {
   }\r
 };\r
 \r
-//\r
-// Value and string token correspondency for Parity\r
-//\r
+///\r
+/// Value and string token correspondency for Parity\r
+///\r
 COM_ATTR            ParityList[5] = {\r
   {\r
     NoParity,\r
@@ -286,9 +286,9 @@ COM_ATTR            ParityList[5] = {
   }\r
 };\r
 \r
-//\r
-// Value and string token correspondency for Baudreate\r
-//\r
+///\r
+/// Value and string token correspondency for Baudreate\r
+///\r
 COM_ATTR            StopBitsList[3] = {\r
   {\r
     OneStopBit,\r
@@ -304,9 +304,9 @@ COM_ATTR            StopBitsList[3] = {
   }\r
 };\r
 \r
-//\r
-// Guid for messaging path, used in Serial port setting.\r
-//\r
+///\r
+/// Guid for messaging path, used in Serial port setting.\r
+///\r
 EFI_GUID            TerminalTypeGuid[4] = {\r
   DEVICE_PATH_MESSAGING_PC_ANSI,\r
   DEVICE_PATH_MESSAGING_VT_100,\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c
index fb49a6452d28e7061adfcb3bb282d8ff0b11f7f2..8a946d3e42256bd02757e6b7a6405d602210f743 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c
@@ -17,12 +17,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Update the File Explore page.\r
 \r
-\r
   @param CallbackData    The BMM context data.\r
   @param MenuOption      Pointer to menu options to display.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateFileExplorePage (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h
index d0346d809594af3703a4fbbd2ac03cf5cc92715c..2523d64c665dc5eaa514d082e191f8649d45ed49 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h
@@ -82,14 +82,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define VARSTORE_ID_BOOT_MAINT               0x1000\r
 #define VARSTORE_ID_FILE_EXPLORER            0x1001\r
 \r
-//\r
-// This is the structure that will be used to store the\r
-// question's current value. Use it at initialize time to\r
-// set default value for each question. When using at run\r
-// time, this map is returned by the callback function,\r
-// so dynamically changing the question's value will be\r
-// possible through this mechanism\r
-//\r
+///\r
+/// This is the structure that will be used to store the\r
+/// question's current value. Use it at initialize time to\r
+/// set default value for each question. When using at run\r
+/// time, this map is returned by the callback function,\r
+/// so dynamically changing the question's value will be\r
+/// possible through this mechanism\r
+///\r
 typedef struct {\r
   //\r
   // Three questions displayed at the main page\r
@@ -195,9 +195,9 @@ typedef struct {
 #define KEY_VALUE_SAVE_AND_EXIT_DRIVER         0x1002\r
 #define KEY_VALUE_NO_SAVE_AND_EXIT_DRIVER      0x1003\r
 \r
-//\r
-// This is the data structure used by File Explorer formset\r
-//\r
+///\r
+/// This is the data structure used by File Explorer formset\r
+///\r
 typedef struct {\r
   UINT16  DescriptionData[75];\r
   UINT16  OptionalData[127];\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c
index 5f8b1779df265af9676a5dd8021f9214086255d1..ff3d42f00dfe24af789be5e55fd5110a0a860d30 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c
@@ -17,10 +17,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Refresh the global UpdateData structure.\r
 \r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 RefreshUpdateData (\r
@@ -33,12 +29,9 @@ RefreshUpdateData (
 /**\r
   Add a "Go back to main page" tag in front of the form when there are no\r
   "Apply changes" and "Discard changes" tags in the end of the form.\r
-  \r
-\r
+ \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdatePageStart (\r
@@ -70,8 +63,6 @@ UpdatePageStart (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdatePageEnd (\r
@@ -130,8 +121,6 @@ UpdatePageEnd (
                          opcode deletion.\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 CleanUpPage (\r
@@ -202,9 +191,6 @@ BootThisFile (
   by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.\r
 \r
   @param CallbackData    The BMM context data.\r
-\r
-  \r
-\r
 **/\r
 VOID\r
 UpdateConCOMPage (\r
@@ -241,8 +227,6 @@ UpdateConCOMPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateBootDelPage (\r
@@ -288,8 +272,6 @@ UpdateBootDelPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateDrvAddHandlePage (\r
@@ -323,11 +305,8 @@ UpdateDrvAddHandlePage (
   Create a lit of driver option from global DriverOptionMenu. It\r
   allow user to delete the driver option.\r
 \r
-\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateDrvDelPage (\r
@@ -372,8 +351,6 @@ UpdateDrvDelPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateDriverAddHandleDescPage (\r
@@ -444,8 +421,6 @@ UpdateDriverAddHandleDescPage (
   @param ConsoleMenu     The console menu list.\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateConsolePage (\r
@@ -528,8 +503,6 @@ UpdateConsolePage (
   @param OptionMenu      The new list.\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateOrderPage (\r
@@ -597,8 +570,6 @@ UpdateOrderPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateBootNextPage (\r
@@ -671,8 +642,6 @@ UpdateBootNextPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateTimeOutPage (\r
@@ -710,11 +679,8 @@ UpdateTimeOutPage (
 /**\r
   Refresh the text mode page\r
 \r
-\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateConModePage (\r
@@ -822,8 +788,6 @@ UpdateConModePage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdateTerminalPage (\r
@@ -998,8 +962,6 @@ UpdateTerminalPage (
   @param UpdatePageId    The form ID.\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdatePageBody (\r
@@ -1043,8 +1005,6 @@ UpdatePageBody (
   @param OptionIndex     Returns the index number (#### in Boot####).\r
   @param OptionSize      Return the size of the Boot### variable.\r
 \r
-  \r
-\r
 **/\r
 VOID *\r
 GetLegacyBootOptionVar (\r
@@ -1125,7 +1085,6 @@ GetLegacyBootOptionVar (
   @param UpdatePageId    The form ID. It also spefies the legacy device type.\r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
 \r
 **/\r
 VOID\r
@@ -1329,8 +1288,6 @@ UpdateSetLegacyDeviceOrderPage (
   @param Private         The BMM context data.\r
   @param NewPageId       The original page ID.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 UpdatePageId (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
index 35faf1ae278f481a3eb762be21562f3b38b38af5..b97af5cd296b99b50a9ba90f8888240fb34b319f 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
@@ -176,9 +176,6 @@ Var_ChangeBootOrder (
   After deleting this Driver option, call Var_ChangeDriverOrder to\r
   make sure DriverOrder is in valid state.\r
 \r
-\r
-  \r
-\r
   @retval EFI_SUCCESS Load Option is successfully updated.\r
   @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI\r
           Variable.\r
@@ -237,9 +234,6 @@ Var_DelDriverOption (
   rebuild DriverOrder from scratch by content from DriverOptionMenu is\r
   needed.\r
 \r
-\r
-  \r
-\r
   @retval  EFI_SUCCESS  The driver order is updated successfully.\r
   @return               EFI_STATUS other than EFI_SUCCESS if failed to\r
                                  Set the "DriverOrder" EFI Variable.\r
@@ -320,10 +314,6 @@ Var_ChangeDriverOrder (
   based on the new BaudRate, Data Bits, parity and Stop Bits\r
   set.\r
 \r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 Var_UpdateAllConsoleOption (\r
@@ -486,9 +476,6 @@ Var_UpdateConsoleOption (
   This function delete and build multi-instance device path ConIn\r
   console device.\r
 \r
-\r
-  \r
-\r
   @retval EFI_SUCCESS    The function complete successfully.\r
   @return                The EFI variable can be saved. See gRT->SetVariable \r
                          for detail return information.\r
@@ -505,9 +492,6 @@ Var_UpdateConsoleInpOption (
   This function delete and build multi-instance device path ConOut\r
   console device.\r
 \r
-\r
-  \r
-\r
   @retval EFI_SUCCESS    The function complete successfully.\r
   @return                The EFI variable can be saved. See gRT->SetVariable \r
                          for detail return information.\r
@@ -524,9 +508,6 @@ Var_UpdateConsoleOutOption (
   This function delete and build multi-instance device path ErrOut\r
   console device.\r
 \r
-\r
-  \r
-\r
   @retval EFI_SUCCESS    The function complete successfully.\r
   @return                The EFI variable can be saved. See gRT->SetVariable \r
                          for detail return information.\r
@@ -1272,7 +1253,7 @@ Var_UpdateBBSOption (
       StrSize (LegacyDeviceContext->Description)\r
       );\r
 \r
-    UnicodeToAscii (DescString, StrSize (DescString), DescAsciiString);\r
+       UnicodeStrToAsciiStr((CONST CHAR16*)&DescString, (CHAR8 *)&DescAsciiString);\r
 \r
     NewOptionSize = sizeof (UINT32) + sizeof (UINT16) + StrSize (DescString) +\r
                     sizeof (BBS_BBS_DEVICE_PATH);\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
index 5dd1e31eb94d66df9f6a8fba7b2e00e5f3c4ba96..c3ef654bf1cae58fa4364cd68c26912a15dc1c51 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
@@ -104,8 +104,7 @@ BootManagerCallback (
   Registers HII packages for the Boot Manger to HII Database.\r
   It also registers the browser call back function.\r
 \r
-\r
-  @return EDES_TODO: Add description for return value\r
+  @return Status of HiiLibCreateHiiDriverHandle() and gHiiDatabase->NewPackageList()\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h
index 68ddf49da924e5b681eed0c80ba92fe14f66ea34..f7876843e4722743a4d780db8ebf3930168fa9f8 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h
+++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h
@@ -87,9 +87,7 @@ BootManagerCallback (
   Registers HII packages for the Boot Manger to HII Database.\r
   It also registers the browser call back function.\r
 \r
-\r
-  @return EDES_TODO: Add description for return value\r
-\r
+  @return Status of HiiLibCreateHiiDriverHandle() and gHiiDatabase->NewPackageList()\r
 **/\r
 EFI_STATUS\r
 InitializeBootManager (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Capsules.c b/MdeModulePkg/Universal/BdsDxe/Capsules.c
index 4aeb65de33c2a2130320ea226f9cdec23a6ab672..0ecf3a6f037ec1409d791143062e78361d1654bb 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Capsules.c
+++ b/MdeModulePkg/Universal/BdsDxe/Capsules.c
@@ -19,8 +19,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param CpuIo           A instance of EFI_CPU_IO_PROTOCOL. \r
   @param Base            The base address flash region to be locked.\r
 \r
-  @return VOID           No return.\r
-\r
 **/\r
 VOID\r
 BdsLockFv (\r
@@ -82,6 +80,7 @@ BdsLockFv (
                                   need to do this if an earlier update went awry and we need to\r
                                   clear the capsule variable so on the next reset PEI does not see it and\r
                                   think there is a capsule available.\r
+  @retval EFI_SUCCESS There is no error when processing capsule\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
index 49c3e7da70a008c4c7e98a3933d9a5c123169a66..c030d1319ee02ea46ebe9ef4d6bd09aeef955519 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
@@ -114,7 +114,6 @@ DeviceManagerCallback (
 \r
   This function registers HII packages to HII database.\r
 \r
-\r
   @retval EFI_SUCCESS This function complete successfully.\r
   @return Other value if failed to register HII packages.\r
 \r
@@ -171,8 +170,6 @@ InitializeDeviceManager (
   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
-\r
   @retval  EFI_SUCCESS             Operation is successful.\r
   @retval  Other values if failed to clean up the dynamic content from HII\r
            database.\r

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
index a3b5dfeb9fca667534ddf6e60bcdc22db7c28ad3..449676251d0b240b00c7e7027f5e85ce7f6873dd 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
@@ -43,20 +43,20 @@ extern UINT8  DeviceManagerVfrBin[];
 typedef struct {\r
   UINTN                           Signature;\r
 \r
-  //\r
-  // HII relative handles\r
-  //\r
+  ///\r
+  /// HII relative handles\r
+  ///\r
   EFI_HII_HANDLE                  HiiHandle;\r
   EFI_HANDLE                      DriverHandle;\r
 \r
-  //\r
-  // Produced protocols\r
-  //\r
+  ///\r
+  /// Produced protocols\r
+  ///\r
   EFI_HII_CONFIG_ACCESS_PROTOCOL  ConfigAccess;\r
 \r
-  //\r
-  // Configuration data\r
-  //\r
+  ///\r
+  /// Configuration data\r
+  ///\r
   UINT8                           VideoBios;\r
 } DEVICE_MANAGER_CALLBACK_DATA;\r
 \r
@@ -72,16 +72,21 @@ typedef struct {
 } DEVICE_MANAGER_MENU_ITEM;\r
 \r
 /**\r
-  EDES_TODO: Add function description.\r
+  This function is invoked if user selected a iteractive opcode from Device Manager's\r
+  Formset. The decision by user is saved to gCallbackKey for later processing. If\r
+  user set VBIOS, the new value is saved to EFI variable.\r
 \r
-  @param This            EDES_TODO: Add parameter description\r
-  @param Action          EDES_TODO: Add parameter description\r
-  @param QuestionId      EDES_TODO: Add parameter description\r
-  @param Type            EDES_TODO: Add parameter description\r
-  @param Value           EDES_TODO: Add parameter description\r
-  @param ActionRequest   EDES_TODO: Add parameter description\r
 \r
-  @return EDES_TODO: Add description for return value\r
+  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+  @param Action          Specifies the type of action taken by the browser.\r
+  @param QuestionId      A unique value which is sent to the original exporting driver\r
+                         so that it can identify the type of data to expect.\r
+  @param Type            The type of value for the question.\r
+  @param Value           A pointer to the data being sent to the original exporting driver.\r
+  @param ActionRequest   On return, points to the action requested by the callback function.\r
+\r
+  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
+  @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -97,11 +102,11 @@ DeviceManagerCallback (
 ;\r
 \r
 /**\r
-  EDES_TODO: Add function description.\r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
+  This function registers HII packages to HII database.\r
 \r
-  @return EDES_TODO: Add description for return value\r
+  @retval EFI_SUCCESS This function complete successfully.\r
+  @return Other value if failed to register HII packages.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -111,11 +116,16 @@ InitializeDeviceManager (
 ;\r
 \r
 /**\r
-  EDES_TODO: Add function description.\r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
+  Call the browser and display the device manager to allow user\r
+  to configure the platform.\r
 \r
-  @return EDES_TODO: Add description for return value\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
+  @retval  EFI_SUCCESS             Operation is successful.\r
+  @retval  Other values if failed to clean up the dynamic content from HII\r
+           database.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Universal/BdsDxe/FrontPage.c b/MdeModulePkg/Universal/BdsDxe/FrontPage.c
index 54d4a5fbd767ce6d247d02e92074ee42fd890418..508d4ab53285973b552adffa679757bc9a7ad88d 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/FrontPage.c
+++ b/MdeModulePkg/Universal/BdsDxe/FrontPage.c
@@ -447,9 +447,6 @@ InitializeFrontPage (
 /**\r
   Call the browser and display the front page\r
 \r
-\r
-  @param VOID            No input.\r
-\r
   @return   Status code that will be returned by\r
             EFI_FORM_BROWSER2_PROTOCOL.SendForm ().\r
 \r
@@ -573,8 +570,6 @@ ConvertProcessorToString (
   @param MemorySize      - The size of the memory to process\r
   @param String          - The string that is created\r
 \r
-  @return VOID.\r
-\r
 **/\r
 VOID\r
 ConvertMemorySizeToString (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/FrontPage.h b/MdeModulePkg/Universal/BdsDxe/FrontPage.h
index fb8ba6c3f24cb8f63a79a80a062e84bf9b01c990..f774351d4c03dcf73f695d300af48688e4dbbebc 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/FrontPage.h
+++ b/MdeModulePkg/Universal/BdsDxe/FrontPage.h
@@ -229,8 +229,6 @@ TimeCompare (
   @param ConnectAllHappened - The indicater to check if the connect all have\r
                          already happended.\r
 \r
-  @return VOID.\r
-\r
 **/\r
 VOID\r
 PlatformBdsEnterFrontPage (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.c b/MdeModulePkg/Universal/BdsDxe/Hotkey.c
index adcc3afbebf33bf10f0a22b87830883d96d4e727..9ad5009537a79058b8460f2333e5dfb306215f8a 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Hotkey.c
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.c
@@ -228,7 +228,6 @@ RegisterHotkey (
 \r
   Delete Key#### for the given Key Option number.\r
 \r
-\r
   @param KeyOptionNumber Key option number for Key####\r
 \r
   @retval  EFI_SUCCESS            Unregister hotkey successfully.\r
@@ -634,11 +633,8 @@ HotkeyInsertList (
 \r
   Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.\r
 \r
-\r
-  @param VOID\r
-\r
   @retval  EFI_SUCCESS    Hotkey services successfully initialized.\r
-\r
+  @retval  EFI_NOT_FOUND  Can not find the "KeyOrder" variable\r
 **/\r
 EFI_STATUS\r
 InitializeHotkeyService (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
index aad06afa2c08030476ba891e0dd6f6261b1eeb30..9ea6dbc554012e241c53e3d8d02ba07ef46d5b1c 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
+++ b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
@@ -27,8 +27,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                          non-zero value  - Indicates that the platform implements Hardware Error\r
                          Record Persistence.\r
 \r
-  @return VOID\r
-\r
 **/\r
 VOID\r
 InitializeHwErrRecSupport (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
index a33e1149a644fd7e2117c27072330bd0bd0b0e94..1063c86fc2e8b12eb02c3b89cc4d5395c9720db1 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
+++ b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
@@ -30,8 +30,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                          non-zero value  - Indicates that the platform implements Hardware Error\r
                          Record Persistence.\r
 \r
-  @return  VOID\r
-\r
 **/\r
 VOID\r
 InitializeHwErrRecSupport (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Language.c b/MdeModulePkg/Universal/BdsDxe/Language.c
index 162d9f8358cc86bb948627572d2a3ace5a73c92d..ec6ec9b601ef5e50649c2355bc6ce9bed92fd823 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Language.c
+++ b/MdeModulePkg/Universal/BdsDxe/Language.c
@@ -23,9 +23,9 @@ EFI_GUID  mFontPackageGuid = {
 };\r
 \r
 typedef struct {\r
-  //\r
-  // This 4-bytes total array length is required by HiiLibPreparePackageList()\r
-  //\r
+  ///\r
+  /// This 4-bytes total array length is required by HiiLibPreparePackageList()\r
+  ///\r
   UINT32                 Length;\r
 \r
   //\r
@@ -283,7 +283,6 @@ ExportFonts (
   Determine the current language that will be used\r
   based on language related EFI Variables.\r
 \r
-\r
   @param LangCodesSettingRequired - If required to set LangCode variable\r
 \r
 **/\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Language.h b/MdeModulePkg/Universal/BdsDxe/Language.h
index 2612e862bb33597b8ccbcf40629dfd9da5e3888d..1d10f7178be3be7c1356f0484004da2a7d42a3b9 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Language.h
+++ b/MdeModulePkg/Universal/BdsDxe/Language.h
@@ -21,7 +21,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   Determine the current language that will be used\r
   based on language related EFI Variables.\r
 \r
-\r
   @param LangCodesSettingRequired If required to set LangCode variable\r
 \r
 **/\r

diff --git a/MdeModulePkg/Universal/BdsDxe/String.c b/MdeModulePkg/Universal/BdsDxe/String.c
index 34873a05a11b5e593d96574274f5fa33d46e000d..b78b22f97e1273242fb4fa73c73f97784d174af4 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/String.c
+++ b/MdeModulePkg/Universal/BdsDxe/String.c
@@ -25,9 +25,6 @@ EFI_GUID mBdsStringPackGuid = {
 /**\r
   Initialize HII global accessor for string support\r
 \r
-\r
-  @param VOID\r
-\r
   @retval  EFI_SUCCESS  String support initialize success.\r
 \r
 **/\r

diff --git a/MdeModulePkg/Universal/BdsDxe/String.h b/MdeModulePkg/Universal/BdsDxe/String.h
index 43b680166ef21369df17c7cbebaee79274df4ddd..81a7a6035acea3459c695e007c971d82a96b8c71 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/String.h
+++ b/MdeModulePkg/Universal/BdsDxe/String.h
@@ -52,9 +52,6 @@ GetStringById (
 /**\r
   Initialize HII global accessor for string support\r
 \r
-\r
-  @param VOID\r
-\r
   @retval  EFI_SUCCESS  String support initialize success.\r
 \r
 **/\r
@@ -66,9 +63,6 @@ InitializeStringSupport (
 /**\r
   Call the browser and display the front page\r
 \r
-\r
-  @param VOID            No input.\r
-\r
   @return   Status code that will be returned by\r
             EFI_FORM_BROWSER2_PROTOCOL.SendForm ().\r
 \r