]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c
Code scrube for MdeModule Definitions.
[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BootMaint / Variable.c
index 4d0e3efb54e4abadf92d94ea6e8e4ab464055abb..a5e575f0bf13ecb3aabb99c929c6a11783edb122 100644 (file)
@@ -14,25 +14,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "BootMaint.h"\r
 \r
-EFI_STATUS\r
-Var_DelBootOption (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Delete Boot Option that represent a Deleted state in BootOptionMenu.\r
   After deleting this boot option, call Var_ChangeBootOrder to\r
   make sure BootOrder is in valid state.\r
 \r
-Arguments:\r
-  LoadOption -- Pointer to the boot option that to be deleted\r
 \r
-Returns:\r
-  EFI_SUCCESS\r
-  Others\r
+  @param VOID            EDES_TODO: Add parameter description\r
+\r
+           EDES_TODO: Incomplete Descriptions  EFI_SUCCESS\r
+           EDES_TODO: Incomplete Descriptions  Others\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+Var_DelBootOption (\r
+  VOID\r
+  )\r
 {\r
   BM_MENU_ENTRY   *NewMenuEntry;\r
   BM_LOAD_CONTEXT *NewLoadContext;\r
@@ -83,25 +80,23 @@ Returns:
   return Status;\r
 }\r
 \r
-EFI_STATUS\r
-Var_ChangeBootOrder (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   After any operation on Boot####, there will be a discrepancy in BootOrder.\r
   Since some are missing but in BootOrder, while some are present but are\r
   not reflected by BootOrder. Then a function rebuild BootOrder from\r
   scratch by content from BootOptionMenu is needed.\r
 \r
-Arguments:\r
 \r
-Returns:\r
-  EFI_SUCCESS\r
-  Others\r
+  @param VOID            EDES_TODO: Add parameter description\r
 \r
---*/\r
+           EDES_TODO: Incomplete Descriptions  EFI_SUCCESS\r
+           EDES_TODO: Incomplete Descriptions  Others\r
+\r
+**/\r
+EFI_STATUS\r
+Var_ChangeBootOrder (\r
+  VOID\r
+  )\r
 {\r
 \r
   EFI_STATUS    Status;\r
@@ -126,7 +121,7 @@ Returns:
   //\r
   // If exists, delete it to hold new BootOrder\r
   //\r
-  if (BootOrderList) {\r
+  if (BootOrderList != NULL) {\r
     EfiLibDeleteVariable (L"BootOrder", &gEfiGlobalVariableGuid);\r
     SafeFreePool (BootOrderList);\r
     BootOrderList = NULL;\r
@@ -177,25 +172,22 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-Var_DelDriverOption (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Delete Load Option that represent a Deleted state in BootOptionMenu.\r
   After deleting this Driver option, call Var_ChangeDriverOrder to\r
   make sure DriverOrder is in valid state.\r
 \r
-Arguments:\r
-  LoadOption -- Pointer to the Driver option that to be deleted\r
 \r
-Returns:\r
-  EFI_SUCCESS\r
-  Others\r
+  @param VOID            EDES_TODO: Add parameter description\r
 \r
---*/\r
+           EDES_TODO: Incomplete Descriptions  EFI_SUCCESS\r
+           EDES_TODO: Incomplete Descriptions  Others\r
+\r
+**/\r
+EFI_STATUS\r
+Var_DelDriverOption (\r
+  VOID\r
+  )\r
 {\r
   BM_MENU_ENTRY   *NewMenuEntry;\r
   BM_LOAD_CONTEXT *NewLoadContext;\r
@@ -238,26 +230,24 @@ Returns:
   return Status;\r
 }\r
 \r
-EFI_STATUS\r
-Var_ChangeDriverOrder (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   After any operation on Driver####, there will be a discrepancy in\r
   DriverOrder. Since some are missing but in DriverOrder, while some\r
   are present but are not reflected by DriverOrder. Then a function\r
   rebuild DriverOrder from scratch by content from DriverOptionMenu is\r
   needed.\r
 \r
-Arguments:\r
 \r
-Returns:\r
-  EFI_SUCCESS\r
-  Others\r
+  @param VOID            EDES_TODO: Add parameter description\r
+\r
+           EDES_TODO: Incomplete Descriptions  EFI_SUCCESS\r
+           EDES_TODO: Incomplete Descriptions  Others\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+Var_ChangeDriverOrder (\r
+  VOID\r
+  )\r
 {\r
   EFI_STATUS    Status;\r
   BM_MENU_ENTRY *NewMenuEntry;\r
@@ -281,7 +271,7 @@ Returns:
   //\r
   // If exists, delete it to hold new DriverOrder\r
   //\r
-  if (DriverOrderList) {\r
+  if (DriverOrderList != NULL) {\r
     EfiLibDeleteVariable (L"DriverOrder", &gEfiGlobalVariableGuid);\r
     SafeFreePool (DriverOrderList);\r
     DriverOrderList = NULL;\r
@@ -324,6 +314,14 @@ Returns:
   return EFI_SUCCESS;\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
+\r
+**/\r
 VOID\r
 Var_UpdateAllConsoleOption (\r
   VOID\r
@@ -337,7 +335,7 @@ Var_UpdateAllConsoleOption (
   OutDevicePath = EfiLibGetVariable (L"ConOut", &gEfiGlobalVariableGuid);\r
   InpDevicePath = EfiLibGetVariable (L"ConIn", &gEfiGlobalVariableGuid);\r
   ErrDevicePath = EfiLibGetVariable (L"ErrOut", &gEfiGlobalVariableGuid);\r
-  if (OutDevicePath) {\r
+  if (OutDevicePath != NULL) {\r
     ChangeVariableDevicePath (OutDevicePath);\r
     Status = gRT->SetVariable (\r
                     L"ConOut",\r
@@ -349,7 +347,7 @@ Var_UpdateAllConsoleOption (
     ASSERT (!EFI_ERROR (Status));\r
   }\r
 \r
-  if (InpDevicePath) {\r
+  if (InpDevicePath != NULL) {\r
     ChangeVariableDevicePath (InpDevicePath);\r
     Status = gRT->SetVariable (\r
                     L"ConIn",\r
@@ -361,7 +359,7 @@ Var_UpdateAllConsoleOption (
     ASSERT (!EFI_ERROR (Status));\r
   }\r
 \r
-  if (ErrDevicePath) {\r
+  if (ErrDevicePath != NULL) {\r
     ChangeVariableDevicePath (ErrDevicePath);\r
     Status = gRT->SetVariable (\r
                     L"ErrOut",\r
@@ -374,6 +372,16 @@ Var_UpdateAllConsoleOption (
   }\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param ConsoleName     EDES_TODO: Add parameter description\r
+  @param ConsoleMenu     EDES_TODO: Add parameter description\r
+  @param UpdatePageId    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateConsoleOption (\r
   IN UINT16                     *ConsoleName,\r
@@ -422,9 +430,9 @@ Var_UpdateConsoleOption (
     }\r
 \r
     NewTerminalContext = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;\r
-    if ((NewTerminalContext->IsConIn && (UpdatePageId == FORM_CON_IN_ID)) ||\r
-        (NewTerminalContext->IsConOut && (UpdatePageId == FORM_CON_OUT_ID)) ||\r
-        (NewTerminalContext->IsStdErr && (UpdatePageId == FORM_CON_ERR_ID))\r
+    if (((NewTerminalContext->IsConIn != 0) && (UpdatePageId == FORM_CON_IN_ID)) ||\r
+        ((NewTerminalContext->IsConOut != 0)  && (UpdatePageId == FORM_CON_OUT_ID)) ||\r
+        ((NewTerminalContext->IsStdErr  != 0) && (UpdatePageId == FORM_CON_ERR_ID))\r
         ) {\r
       Vendor.Header.Type    = MESSAGING_DEVICE_PATH;\r
       Vendor.Header.SubType = MSG_VENDOR_DP;\r
@@ -447,7 +455,7 @@ Var_UpdateConsoleOption (
     }\r
   }\r
 \r
-  if (ConDevicePath) {\r
+  if (ConDevicePath != NULL) {\r
     Status = gRT->SetVariable (\r
                     ConsoleName,\r
                     &gEfiGlobalVariableGuid,\r
@@ -464,6 +472,14 @@ Var_UpdateConsoleOption (
 \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
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateConsoleInpOption (\r
   VOID\r
@@ -472,6 +488,14 @@ Var_UpdateConsoleInpOption (
   return Var_UpdateConsoleOption (L"ConIn", &ConsoleInpMenu, FORM_CON_IN_ID);\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
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateConsoleOutOption (\r
   VOID\r
@@ -480,6 +504,14 @@ Var_UpdateConsoleOutOption (
   return Var_UpdateConsoleOption (L"ConOut", &ConsoleOutMenu, FORM_CON_OUT_ID);\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
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateErrorOutOption (\r
   VOID\r
@@ -488,6 +520,18 @@ Var_UpdateErrorOutOption (
   return Var_UpdateConsoleOption (L"ErrOut", &ConsoleErrMenu, FORM_CON_ERR_ID);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+  @param HiiHandle       EDES_TODO: Add parameter description\r
+  @param DescriptionData EDES_TODO: Add parameter description\r
+  @param OptionalData    EDES_TODO: Add parameter description\r
+  @param ForceReconnect  EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateDriverOption (\r
   IN  BMM_CALLBACK_DATA         *CallbackData,\r
@@ -653,6 +697,15 @@ Var_UpdateDriverOption (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+  @param NvRamMap        EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateBootOption (\r
   IN  BMM_CALLBACK_DATA                   *CallbackData,\r
@@ -811,6 +864,14 @@ Var_UpdateBootOption (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateBootNext (\r
   IN BMM_CALLBACK_DATA            *CallbackData\r
@@ -860,6 +921,14 @@ Var_UpdateBootNext (
   return Status;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateBootOrder (\r
   IN BMM_CALLBACK_DATA            *CallbackData\r
@@ -885,18 +954,18 @@ Var_UpdateBootOrder (
                     );\r
 \r
   NewBootOrderList = EfiAllocateZeroPool (BootOrderListSize);\r
-  if (!NewBootOrderList) {\r
+  if (NewBootOrderList == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
   Map = EfiAllocateZeroPool (BootOrderListSize / sizeof (UINT16));\r
-  if (!Map) {\r
+  if (Map == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
   //\r
   // If exists, delete it to hold new BootOrder\r
   //\r
-  if (BootOrderList) {\r
+  if (BootOrderList != NULL) {\r
     EfiLibDeleteVariable (L"BootOrder", &gEfiGlobalVariableGuid);\r
   }\r
 \r
@@ -925,6 +994,14 @@ Var_UpdateBootOrder (
 \r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateDriverOrder (\r
   IN BMM_CALLBACK_DATA            *CallbackData\r
@@ -950,13 +1027,13 @@ Var_UpdateDriverOrder (
 \r
   NewDriverOrderList = EfiAllocateZeroPool (DriverOrderListSize);\r
 \r
-  if (!NewDriverOrderList) {\r
+  if (NewDriverOrderList == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
   //\r
   // If exists, delete it to hold new DriverOrder\r
   //\r
-  if (DriverOrderList) {\r
+  if (DriverOrderList != NULL) {\r
     EfiLibDeleteVariable (L"DriverOrder", &gEfiGlobalVariableGuid);\r
   }\r
 \r
@@ -982,6 +1059,14 @@ Var_UpdateDriverOrder (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateBBSOption (\r
   IN BMM_CALLBACK_DATA            *CallbackData\r
@@ -1066,7 +1151,7 @@ Var_UpdateBBSOption (
   // Update the Variable "LegacyDevOrder"\r
   //\r
   VarData = (UINT8 *) BdsLibGetVariableAndSize (\r
-                        VarLegacyDevOrder,\r
+                        VAR_LEGACY_DEV_ORDER,\r
                         &EfiLegacyDevOrderGuid,\r
                         &VarSize\r
                         );\r
@@ -1117,7 +1202,7 @@ Var_UpdateBBSOption (
     Tmp &= 0xFF;\r
     Pos = Tmp / 8;\r
     Bit = 7 - (Tmp % 8);\r
-    if (DisMap[Pos] & (1 << Bit)) {\r
+    if ((DisMap[Pos] & (1 << Bit)) != 0) {\r
       NewOrder[Index] = (UINT16) (0xFF00 | Tmp);\r
       Index++;\r
     }\r
@@ -1131,7 +1216,7 @@ Var_UpdateBBSOption (
   SafeFreePool (NewOrder);\r
 \r
   Status = gRT->SetVariable (\r
-                  VarLegacyDevOrder,\r
+                  VAR_LEGACY_DEV_ORDER,\r
                   &EfiLegacyDevOrderGuid,\r
                   VAR_FLAG,\r
                   VarSize,\r
@@ -1278,6 +1363,14 @@ Var_UpdateBBSOption (
   return Status;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description.\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 Var_UpdateConMode (\r
   IN BMM_CALLBACK_DATA            *CallbackData\r