Report the setting variable failure to platform through the status code when core cannot handle the error.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15385 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 128 insertions, 90 deletions

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
index db0fed5834..adf84f42f7 100644
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
@@ -3,7 +3,7 @@
   and manage the legacy boot option, all legacy boot option is getting from

   the legacy BBS table.

 

-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -143,6 +143,9 @@ OrderLegacyBootOption4SameType (
                   BootOrderSize,

                   BootOrder

                   );

+  //

+  // Changing content without increasing its size with current variable implementation shouldn't fail.

+  //

   ASSERT_EFI_ERROR (Status);

 

   FreePool (NewBootOption);

@@ -171,6 +174,7 @@ GroupMultipleLegacyBootOption4SameType (
   VOID

   )

 {

+  EFI_STATUS                   Status;

   UINTN                        Index;

   UINTN                        DeviceIndex;

   UINTN                        DeviceTypeIndex[7];

@@ -233,13 +237,17 @@ GroupMultipleLegacyBootOption4SameType (
     FreePool (BootOption);

   }

 

-  gRT->SetVariable (

-         L"BootOrder",

-         &gEfiGlobalVariableGuid,

-         EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

-         BootOrderSize,

-         BootOrder

-         );

+  Status = gRT->SetVariable (

+                  L"BootOrder",

+                  &gEfiGlobalVariableGuid,

+                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

+                  BootOrderSize,

+                  BootOrder

+                  );

+  //

+  // Changing content without increasing its size with current variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

   FreePool (BootOrder);

 }

 

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BmLib.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BmLib.c
index c83b7ddede..5fe5388f9e 100644
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BmLib.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BmLib.c
@@ -1,7 +1,7 @@
 /** @file

   Utility routines used by boot maintenance modules.

 

-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -178,7 +178,10 @@ EfiLibDeleteVariable (
                     0,

                     NULL

                     );

-    ASSERT (!EFI_ERROR (Status));

+    //

+    // Deleting variable with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

     FreePool (VarBuf);

   }

 

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
index 5f200e2e16..b974a67ea5 100644
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
@@ -1,7 +1,7 @@
 /** @file

   The functions for Boot Maintainence Main menu.

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -672,14 +672,13 @@ ApplyChangeHandler (
     break;

 

   case FORM_TIME_OUT_ID:

-    Status = gRT->SetVariable (

-                    L"Timeout",

-                    &gEfiGlobalVariableGuid,

-                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

-                    sizeof (UINT16),

-                    &(CurrentFakeNVMap->BootTimeOut)

-                    );

-    ASSERT_EFI_ERROR(Status);

+    BdsDxeSetVariableAndReportStatusCodeOnError (

+      L"Timeout",

+      &gEfiGlobalVariableGuid,

+      EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

+      sizeof (UINT16),

+      &(CurrentFakeNVMap->BootTimeOut)

+      );

 

     Private->BmmOldFakeNVData.BootTimeOut = CurrentFakeNVMap->BootTimeOut;

     break;

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/Variable.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/Variable.c
index ef36ae2dc8..f374e5b256 100644
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/Variable.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/Variable.c
@@ -1,7 +1,7 @@
 /** @file

   Variable operation that will be used by bootmaint

 

-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -165,9 +165,10 @@ Var_ChangeBootOrder (
                     BootOrderListSize * sizeof (UINT16),

                     BootOrderList

                     );

-    if (EFI_ERROR (Status)) {

-      return Status;

-    }

+    //

+    // Changing variable without increasing its size with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

   }

   return EFI_SUCCESS;

 }

@@ -303,9 +304,10 @@ Var_ChangeDriverOrder (
                     DriverOrderListSize * sizeof (UINT16),

                     DriverOrderList

                     );

-    if (EFI_ERROR (Status)) {

-      return Status;

-    }

+    //

+    // Changing variable without increasing its size with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

   }

   return EFI_SUCCESS;

 }

@@ -338,7 +340,10 @@ Var_UpdateAllConsoleOption (
                     GetDevicePathSize (OutDevicePath),

                     OutDevicePath

                     );

-    ASSERT (!EFI_ERROR (Status));

+    //

+    // Changing variable without increasing its size with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

   }

 

   if (InpDevicePath != NULL) {

@@ -350,7 +355,10 @@ Var_UpdateAllConsoleOption (
                     GetDevicePathSize (InpDevicePath),

                     InpDevicePath

                     );

-    ASSERT (!EFI_ERROR (Status));

+    //

+    // Changing variable without increasing its size with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

   }

 

   if (ErrDevicePath != NULL) {

@@ -362,7 +370,10 @@ Var_UpdateAllConsoleOption (
                     GetDevicePathSize (ErrDevicePath),

                     ErrDevicePath

                     );

-    ASSERT (!EFI_ERROR (Status));

+    //

+    // Changing variable without increasing its size with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

   }

 }

 

@@ -667,38 +678,40 @@ Var_UpdateDriverOption (
                   BufferSize,

                   Buffer

                   );

-  ASSERT_EFI_ERROR (Status);

-  DriverOrderList = BdsLibGetVariableAndSize (

-                      L"DriverOrder",

-                      &gEfiGlobalVariableGuid,

-                      &DriverOrderListSize

-                      );

-  NewDriverOrderList = AllocateZeroPool (DriverOrderListSize + sizeof (UINT16));

-  ASSERT (NewDriverOrderList != NULL);

-  if (DriverOrderList != NULL) {

-    CopyMem (NewDriverOrderList, DriverOrderList, DriverOrderListSize);

-    EfiLibDeleteVariable (L"DriverOrder", &gEfiGlobalVariableGuid);

-  }

-  NewDriverOrderList[DriverOrderListSize / sizeof (UINT16)] = Index;

+  if (!EFI_ERROR (Status)) {

+    DriverOrderList = BdsLibGetVariableAndSize (

+                        L"DriverOrder",

+                        &gEfiGlobalVariableGuid,

+                        &DriverOrderListSize

+                        );

+    NewDriverOrderList = AllocateZeroPool (DriverOrderListSize + sizeof (UINT16));

+    ASSERT (NewDriverOrderList != NULL);

+    if (DriverOrderList != NULL) {

+      CopyMem (NewDriverOrderList, DriverOrderList, DriverOrderListSize);

+      EfiLibDeleteVariable (L"DriverOrder", &gEfiGlobalVariableGuid);

+    }

+    NewDriverOrderList[DriverOrderListSize / sizeof (UINT16)] = Index;

 

-  Status = gRT->SetVariable (

-                  L"DriverOrder",

-                  &gEfiGlobalVariableGuid,

-                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

-                  DriverOrderListSize + sizeof (UINT16),

-                  NewDriverOrderList

-                  );

-  ASSERT_EFI_ERROR (Status);

-  if (DriverOrderList != NULL) {

-    FreePool (DriverOrderList);

-  }

-  DriverOrderList = NULL;

-  FreePool (NewDriverOrderList);

-  InsertTailList (&DriverOptionMenu.Head, &NewMenuEntry->Link);

-  DriverOptionMenu.MenuNumber++;

+    Status = gRT->SetVariable (

+                    L"DriverOrder",

+                    &gEfiGlobalVariableGuid,

+                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

+                    DriverOrderListSize + sizeof (UINT16),

+                    NewDriverOrderList

+                    );

+    if (DriverOrderList != NULL) {

+      FreePool (DriverOrderList);

+    }

+    DriverOrderList = NULL;

+    FreePool (NewDriverOrderList);

+    if (!EFI_ERROR (Status)) {

+      InsertTailList (&DriverOptionMenu.Head, &NewMenuEntry->Link);

+      DriverOptionMenu.MenuNumber++;

 

-  *DescriptionData  = 0x0000;

-  *OptionalData     = 0x0000;

+      *DescriptionData  = 0x0000;

+      *OptionalData     = 0x0000;

+    }

+  }

   return EFI_SUCCESS;

 }

 

@@ -835,39 +848,41 @@ Var_UpdateBootOption (
                   BufferSize,

                   Buffer

                   );

-  ASSERT_EFI_ERROR (Status);

+  if (!EFI_ERROR (Status)) {

 

-  BootOrderList = BdsLibGetVariableAndSize (

+    BootOrderList = BdsLibGetVariableAndSize (

+                      L"BootOrder",

+                      &gEfiGlobalVariableGuid,

+                      &BootOrderListSize

+                      );

+    ASSERT (BootOrderList != NULL);

+    NewBootOrderList = AllocateZeroPool (BootOrderListSize + sizeof (UINT16));

+    ASSERT (NewBootOrderList != NULL);

+    CopyMem (NewBootOrderList, BootOrderList, BootOrderListSize);

+    NewBootOrderList[BootOrderListSize / sizeof (UINT16)] = Index;

+

+    if (BootOrderList != NULL) {

+      FreePool (BootOrderList);

+    }

+

+    Status = gRT->SetVariable (

                     L"BootOrder",

                     &gEfiGlobalVariableGuid,

-                    &BootOrderListSize

+                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

+                    BootOrderListSize + sizeof (UINT16),

+                    NewBootOrderList

                     );

-  ASSERT (BootOrderList != NULL);

-  NewBootOrderList = AllocateZeroPool (BootOrderListSize + sizeof (UINT16));

-  ASSERT (NewBootOrderList != NULL);

-  CopyMem (NewBootOrderList, BootOrderList, BootOrderListSize);

-  NewBootOrderList[BootOrderListSize / sizeof (UINT16)] = Index;

+    if (!EFI_ERROR (Status)) {

 

-  if (BootOrderList != NULL) {

-    FreePool (BootOrderList);

-  }

+      FreePool (NewBootOrderList);

+      NewBootOrderList = NULL;

+      InsertTailList (&BootOptionMenu.Head, &NewMenuEntry->Link);

+      BootOptionMenu.MenuNumber++;

 

-  Status = gRT->SetVariable (

-                  L"BootOrder",

-                  &gEfiGlobalVariableGuid,

-                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

-                  BootOrderListSize + sizeof (UINT16),

-                  NewBootOrderList

-                  );

-  ASSERT_EFI_ERROR (Status);

-

-  FreePool (NewBootOrderList);

-  NewBootOrderList = NULL;

-  InsertTailList (&BootOptionMenu.Head, &NewMenuEntry->Link);

-  BootOptionMenu.MenuNumber++;

-

-  NvRamMap->DescriptionData[0]  = 0x0000;

-  NvRamMap->OptionalData[0]     = 0x0000;

+      NvRamMap->DescriptionData[0]  = 0x0000;

+      NvRamMap->OptionalData[0]     = 0x0000;

+    }

+  }

   return EFI_SUCCESS;

 }

 

@@ -987,6 +1002,10 @@ Var_UpdateBootOrder (
                   BootOrderListSize,

                   BootOrderList

                   );

+  //

+  // Changing the content without increasing its size with current variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

   FreePool (BootOrderList);

 

   GroupMultipleLegacyBootOption4SameType ();

@@ -1058,10 +1077,11 @@ Var_UpdateDriverOrder (
                   DriverOrderListSize,

                   NewDriverOrderList

                   );

-  if (EFI_ERROR (Status)) {

-    return Status;

-  }

-

+  //

+  // Changing the content without increasing its size with current variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

+  

   BOpt_FreeMenu (&DriverOptionMenu);

   BOpt_GetDriverOptions (CallbackData);

   return EFI_SUCCESS;

@@ -1258,6 +1278,10 @@ Var_UpdateBBSOption (
                       OptionSize,

                       BootOptionVar

                       );

+      //

+      // Changing the content without increasing its size with current variable implementation shouldn't fail.

+      //

+      ASSERT_EFI_ERROR (Status);

 

       FreePool (BootOptionVar);

     }

@@ -1281,6 +1305,10 @@ Var_UpdateBBSOption (
                       OptionSize,

                       BootOptionVar

                       );

+      //

+      // Changing the content without increasing its size with current variable implementation shouldn't fail.

+      //

+      ASSERT_EFI_ERROR (Status);

 

       FreePool (BootOptionVar);

     }