Refine function comments for BdsDxe module.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
index 8576e41f0fe99a6a0b05978e752d159495ab9f42..55af813d6892dde83b27795a8d3ca7c441aa4ffa 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
@@ -20,7 +20,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   make sure BootOrder is in valid state.\r
 \r
   @retval EFI_SUCCESS   If all boot load option EFI Variables corresponding to  \r
-                        BM_LOAD_CONTEXT marked for deletion is deleted\r
+                        BM_LOAD_CONTEXT marked for deletion is deleted.\r
+  @retval EFI_NOT_FOUND If can not find the boot option want to be deleted.\r
   @return Others        If failed to update the "BootOrder" variable after deletion. \r
 \r
 **/\r
@@ -176,7 +177,8 @@ Var_ChangeBootOrder (
   After deleting this Driver option, call Var_ChangeDriverOrder to\r
   make sure DriverOrder is in valid state.\r
 \r
-  @retval EFI_SUCCESS Load Option is successfully updated.\r
+  @retval EFI_SUCCESS       Load Option is successfully updated.\r
+  @retval EFI_NOT_FOUND     Fail to find the driver option want to be deleted.\r
   @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI\r
           Variable.\r
 \r
@@ -476,8 +478,7 @@ Var_UpdateConsoleOption (
   console device.\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
+  @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
 **/\r
 EFI_STATUS\r
 Var_UpdateConsoleInpOption (\r
@@ -492,8 +493,7 @@ Var_UpdateConsoleInpOption (
   console device.\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
+  @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
 **/\r
 EFI_STATUS\r
 Var_UpdateConsoleOutOption (\r
@@ -508,8 +508,7 @@ Var_UpdateConsoleOutOption (
   console device.\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
+  @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.  \r
 **/\r
 EFI_STATUS\r
 Var_UpdateErrorOutOption (\r
@@ -586,6 +585,7 @@ Var_UpdateDriverOption (
 \r
   NewMenuEntry = BOpt_CreateMenuEntry (BM_LOAD_CONTEXT_SELECT);\r
   if (NULL == NewMenuEntry) {\r
+    FreePool (Buffer);\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
@@ -1007,10 +1007,9 @@ Var_UpdateBootOrder (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @retval EFI_SUCCESS    The function complete successfully.\r
-  @retval EFI_SUCCESS    Not enough memory to complete the function.\r
-  @return                The EFI variable can be saved. See gRT->SetVariable \r
-                         for detail return information.\r
+  @retval EFI_SUCCESS           The function complete successfully.\r
+  @retval EFI_OUT_OF_RESOURCES  Not enough memory to complete the function.\r
+  @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1076,9 +1075,9 @@ Var_UpdateDriverOrder (
 \r
   @param CallbackData    The context data for BMM.\r
 \r
-  @return EFI_SUCCESS    The function completed successfully.\r
-  @retval EFI_NOT_FOUND  If L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable can be found.\r
-\r
+  @return EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         If L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable can be found.\r
+  @retval EFI_OUT_OF_RESOURCES  Fail to allocate memory resource\r
 **/\r
 EFI_STATUS\r
 Var_UpdateBBSOption (\r
@@ -1169,7 +1168,7 @@ Var_UpdateBBSOption (
                         &VarSize\r
                         );\r
 \r
-  if (NULL == VarData) {\r
+  if (VarData == NULL) {\r
     return EFI_NOT_FOUND;\r
   }\r
 \r
@@ -1192,7 +1191,7 @@ Var_UpdateBBSOption (
   }\r
 \r
   NewOrder = (UINT16 *) AllocateZeroPool (DevOrder->Length - sizeof (UINT16));\r
-  if (NULL == NewOrder) {\r
+  if (NewOrder == NULL) {\r
     FreePool (VarData);\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
@@ -1243,7 +1242,7 @@ Var_UpdateBBSOption (
   //\r
   BootOptionVar = GetLegacyBootOptionVar (CallbackData->BbsType, &Index, &OptionSize);\r
 \r
-  if (NULL != BootOptionVar) {\r
+  if (BootOptionVar != NULL) {\r
     CopyMem (\r
       DescString,\r
       LegacyDeviceContext->Description,\r
@@ -1263,7 +1262,7 @@ Var_UpdateBBSOption (
 \r
     Attribute = (UINT32 *) Ptr;\r
     *Attribute |= LOAD_OPTION_ACTIVE;\r
-    if (0xFF == LegacyDev[0]) {\r
+    if (LegacyDev[0] == 0xFF) {\r
       //\r
       // Disable this legacy boot option\r
       //\r
@@ -1276,7 +1275,7 @@ Var_UpdateBBSOption (
     Ptr += StrSize ((CHAR16 *) Ptr);\r
 \r
     NewOptionPtr = AllocateZeroPool (NewOptionSize);\r
-    if (NULL == NewOptionPtr) {\r
+    if (NewOptionPtr == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
     }\r
 \r