Remove SafeFreePool from MemoryAllocationLib as this API's name is misleading. Its...

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BootMaint / BootMaint.c

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
index 432be94c9f480723120cde7c52503887dc006327..ac313989874c0ee5020984eba0bebcdfe43b1d52 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
@@ -25,19 +25,17 @@ EFI_DEVICE_PATH_PROTOCOL  EndDevicePath[] = {
 };\r
 \r
 \r
 };\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
 \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
 \r
 \r
 /**\r
   Init all memu.\r
 \r

-  @param CallbackData    The \r
-\r
-  @return EDES_TODO: Add description for return value\r
+  @param CallbackData    The BMM context data.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -46,11 +44,7 @@ InitAllMenu (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  EDES_TODO: Add function description.\r
-\r
-  @param VOID            EDES_TODO: Add parameter description\r
-\r
-  @return EDES_TODO: Add description for return value\r
+  Free up all Menu Option list.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -108,14 +102,14 @@ CreateMenuStringToken (
   or more named elements from the target driver.\r
 \r
 \r
   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
                          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
                          has all values filled in for the names in the Request string.\r
                          String to be allocated by the called function.\r
 \r


@@ -546,10 +540,9 @@ BootMaintCallback (
 /**\r
   Function handling request to apply changes for BMM pages.\r
 \r
 /**\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
 \r
   @retval  EFI_SUCCESS       Change successfully applied.\r
   @retval  Other             Error occurs while trying to apply changes.\r


@@ -734,10 +727,8 @@ Error:
   Discard all changes done to the BMM pages such as Boot Order change,\r
   Driver order change.\r
 \r
   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
-  @return VOID\r
+  @param Private            The BMM context data.\r
+  @param CurrentFakeNVMap   The current Fack NV Map.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -787,11 +778,9 @@ DiscardChangeHandler (
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Initialize the Boot Maintenance Utitliy\r
+  Initialize the Boot Maintenance Utitliy.\r

 \r
 \r
 \r
 \r

-  @param VOID            EDES_TODO: Add parameter description\r
-\r

   @retval  EFI_SUCCESS      utility ended successfully\r
   @retval  others           contain some errors\r
 \r
   @retval  EFI_SUCCESS      utility ended successfully\r
   @retval  others           contain some errors\r
 \r


@@ -822,7 +811,7 @@ InitializeBM (
   //\r
   Ptr = AllocateZeroPool (sizeof (BM_LOAD_CONTEXT) + sizeof (BM_FILE_CONTEXT) + sizeof (BM_HANDLE_CONTEXT) + sizeof (BM_MENU_ENTRY));\r
   if (Ptr == NULL) {\r
   //\r
   Ptr = AllocateZeroPool (sizeof (BM_LOAD_CONTEXT) + sizeof (BM_FILE_CONTEXT) + sizeof (BM_HANDLE_CONTEXT) + sizeof (BM_MENU_ENTRY));\r
   if (Ptr == NULL) {\r

-    SafeFreePool (BmmCallbackInfo);\r
+    FreePool (BmmCallbackInfo);\r

     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r


@@ -928,8 +917,8 @@ InitializeBM (
   gUpdateData.BufferSize = UPDATE_DATA_SIZE;\r
   gUpdateData.Data = AllocateZeroPool (UPDATE_DATA_SIZE);\r
   if (gUpdateData.Data == NULL) {\r
   gUpdateData.BufferSize = UPDATE_DATA_SIZE;\r
   gUpdateData.Data = AllocateZeroPool (UPDATE_DATA_SIZE);\r
   if (gUpdateData.Data == NULL) {\r

-    SafeFreePool (BmmCallbackInfo->LoadContext);\r
-    SafeFreePool (BmmCallbackInfo);\r
+    FreePool (BmmCallbackInfo->LoadContext);\r
+    FreePool (BmmCallbackInfo);\r

     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r


@@ -1031,9 +1020,9 @@ InitializeBM (
 \r
   FreeAllMenu ();\r
 \r
 \r
   FreeAllMenu ();\r
 \r

-  SafeFreePool (BmmCallbackInfo->LoadContext);\r
-  SafeFreePool (BmmCallbackInfo);\r
-  SafeFreePool (gUpdateData.Data);\r
+  FreePool (BmmCallbackInfo->LoadContext);\r
+  FreePool (BmmCallbackInfo);\r
+  FreePool (gUpdateData.Data);\r

   gUpdateData.Data = NULL;\r
 \r
   return Status;\r
   gUpdateData.Data = NULL;\r
 \r
   return Status;\r


@@ -1044,7 +1033,7 @@ InitializeBM (
 \r
   @param CallbackData    The BMM context data.\r
 \r
 \r
   @param CallbackData    The BMM context data.\r
 \r

-  @return VOID\r
+  \r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -1071,9 +1060,9 @@ InitAllMenu (
 /**\r
   Free up all Menu Option list.\r
 \r
 /**\r
   Free up all Menu Option list.\r
 \r

-  @param VOID\r
+  \r

 \r
 \r

-  @return VOID\r
+  \r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -1094,9 +1083,9 @@ FreeAllMenu (
   Intialize all the string depositories.\r
 \r
 \r
   Intialize all the string depositories.\r
 \r
 \r

-  @param VOID\r
+  \r

 \r
 \r

-  @return VOID\r
+  \r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -1119,8 +1108,8 @@ InitializeStringDepository (
   Fetch a usable string node from the string depository and return the string token.\r
 \r
 \r
   Fetch a usable string node from the string depository and return the string token.\r
 \r
 \r

-  @param CallbackData    EDES_TODO: Add parameter description\r
-  @param StringDepository - Pointer of the string depository.\r
+  @param CallbackData    The BMM context data.\r
+  @param StringDepository  The string repository.\r

 \r
   @retval  EFI_STRING_ID           String token.\r
 \r
 \r
   @retval  EFI_STRING_ID           String token.\r
 \r


@@ -1168,9 +1157,9 @@ GetStringTokenFromDepository (
   Reclaim string depositories by moving the current node pointer to list head..\r
 \r
 \r
   Reclaim string depositories by moving the current node pointer to list head..\r
 \r
 \r

-  @param VOID \r
+   \r

 \r
 \r

-  @return VOID\r
+  \r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -1192,9 +1181,9 @@ ReclaimStringDepository (
   Release resource for all the string depositories.\r
 \r
 \r
   Release resource for all the string depositories.\r
 \r
 \r

-  @param VOID\r
+  \r

 \r
 \r

-  @return VOID\r
+  \r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r


@@ -1216,7 +1205,7 @@ CleanUpStringDepository (
     CurrentListNode = StringDepository->ListHead;\r
     for (NodeIndex = 0; NodeIndex < StringDepository->TotalNodeNumber; NodeIndex++) {\r
       NextListNode = CurrentListNode->Next;\r
     CurrentListNode = StringDepository->ListHead;\r
     for (NodeIndex = 0; NodeIndex < StringDepository->TotalNodeNumber; NodeIndex++) {\r
       NextListNode = CurrentListNode->Next;\r

-      SafeFreePool (CurrentListNode);\r
+      FreePool (CurrentListNode);\r

       CurrentListNode = NextListNode;\r
     }\r
 \r
       CurrentListNode = NextListNode;\r
     }\r
 \r


@@ -1225,14 +1214,14 @@ CleanUpStringDepository (
   //\r
   // Release string depository.\r
   //\r
   //\r
   // Release string depository.\r
   //\r

-  SafeFreePool (FileOptionStrDepository);\r
+  FreePool (FileOptionStrDepository);\r

 }\r
 \r
 /**\r
   Start boot maintenance manager\r
 \r
 \r
 }\r
 \r
 /**\r
   Start boot maintenance manager\r
 \r
 \r

-  @param VOID\r
+  \r

 \r
   @retval EFI_SUCCESS If BMM is invoked successfully.\r
   @return Other value if BMM return unsuccessfully.\r
 \r
   @retval EFI_SUCCESS If BMM is invoked successfully.\r
   @return Other value if BMM return unsuccessfully.\r


@@ -1260,21 +1249,11 @@ BdsStartBootMaint (
   //\r
   BdsLibEnumerateAllBootOption (&BdsBootOptionList);\r
 \r
   //\r
   BdsLibEnumerateAllBootOption (&BdsBootOptionList);\r
 \r

-  //\r
-  // Drop the TPL level from TPL_APPLICATION to TPL_APPLICATION\r
-  //\r
-  gBS->RestoreTPL (TPL_APPLICATION);\r
-\r

   //\r
   // Init the BMM\r
   //\r
   Status = InitializeBM ();\r
 \r
   //\r
   // Init the BMM\r
   //\r
   Status = InitializeBM ();\r
 \r

-  //\r
-  // Raise the TPL level back to TPL_APPLICATION\r
-  //\r
-  gBS->RaiseTPL (TPL_APPLICATION);\r
-\r

   return Status;\r
 }\r
 \r
   return Status;\r
 }\r
 \r


@@ -1285,7 +1264,7 @@ BdsStartBootMaint (
   @param CallbackData    The BMM context data.\r
 \r
   @retval EFI_SUCCESS If function complete successfully.\r
   @param CallbackData    The BMM context data.\r
 \r
   @retval EFI_SUCCESS If function complete successfully.\r

-  @retturn Other value if the Setup Browser process BMM's pages and\r
+  @return Other value if the Setup Browser process BMM's pages and\r

            return unsuccessfully.\r
 \r
 **/\r
            return unsuccessfully.\r
 \r
 **/\r