ArmPkg: Introduce GetGlobalEnvironmentVariable() function.

Rename GetEnvironmentVariable() function into GetGlobalEnvironmentVariable().
GetEnvironmentVariable() function sill exists but caller must now pass a Guid.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Olivier Martin <olivier.martin@arm.com>



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

5 files changed, 56 insertions, 33 deletions

diff --git a/ArmPkg/Application/LinuxLoader/LinuxConfig.c b/ArmPkg/Application/LinuxLoader/LinuxConfig.c
index 273fecd2d..10aadb733 100644
--- a/ArmPkg/Application/LinuxLoader/LinuxConfig.c
+++ b/ArmPkg/Application/LinuxLoader/LinuxConfig.c
@@ -1,14 +1,14 @@
 /** @file

 *

-*  Copyright (c) 2011-2012, ARM Limited. All rights reserved.

-*  

-*  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        

-*  http://opensource.org/licenses/bsd-license.php                                            

+*  Copyright (c) 2011-2013, ARM Limited. All rights reserved.

 *

-*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+*  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

+*  http://opensource.org/licenses/bsd-license.php

+*

+*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 *

 **/

 

@@ -204,7 +204,7 @@ LinuxLoaderConfig (
     Choice = LINUX_LOADER_NEW;

 

     // Scan the OptionalData of every entry for the correct signature

-    Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);

+    Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);

     if (!EFI_ERROR(Status)) {

       BootOrderCount = BootOrderSize / sizeof(UINT16);

 

diff --git a/ArmPkg/Include/Library/BdsLib.h b/ArmPkg/Include/Library/BdsLib.h
index c8e02c934..d16748da4 100644
--- a/ArmPkg/Include/Library/BdsLib.h
+++ b/ArmPkg/Include/Library/BdsLib.h
@@ -1,14 +1,14 @@
 /** @file

 *

-*  Copyright (c) 2011, ARM Limited. All rights reserved.

-*  

-*  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        

-*  http://opensource.org/licenses/bsd-license.php                                            

+*  Copyright (c) 2013, ARM Limited. All rights reserved.

 *

-*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+*  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

+*  http://opensource.org/licenses/bsd-license.php

+*

+*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 *

 **/

 

@@ -67,8 +67,17 @@ BdsConnectAllDrivers (
   );

 

 EFI_STATUS

+GetGlobalEnvironmentVariable (

+  IN     CONST CHAR16*   VariableName,

+  IN     VOID*           DefaultValue,

+  IN OUT UINTN*          Size,

+  OUT    VOID**          Value

+  );

+

+EFI_STATUS

 GetEnvironmentVariable (

   IN     CONST CHAR16*   VariableName,

+  IN     EFI_GUID*       VendorGuid,

   IN     VOID*           DefaultValue,

   IN OUT UINTN*          Size,

   OUT    VOID**          Value

diff --git a/ArmPkg/Library/BdsLib/BdsHelper.c b/ArmPkg/Library/BdsLib/BdsHelper.c
index 5016bedcd..fb2ac9b80 100644
--- a/ArmPkg/Library/BdsLib/BdsHelper.c
+++ b/ArmPkg/Library/BdsLib/BdsHelper.c
@@ -1,14 +1,14 @@
 /** @file

 *

-*  Copyright (c) 2011-2012, ARM Limited. All rights reserved.

-*  

-*  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        

-*  http://opensource.org/licenses/bsd-license.php                                            

+*  Copyright (c) 2011-2013, ARM Limited. All rights reserved.

 *

-*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+*  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

+*  http://opensource.org/licenses/bsd-license.php

+*

+*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 *

 **/

 

@@ -294,8 +294,21 @@ PrintPerformance (
 }

 

 EFI_STATUS

+GetGlobalEnvironmentVariable (

+  IN     CONST CHAR16*   VariableName,

+  IN     VOID*           DefaultValue,

+  IN OUT UINTN*          Size,

+  OUT    VOID**          Value

+  )

+{

+  return GetEnvironmentVariable (VariableName, &gEfiGlobalVariableGuid,

+           DefaultValue, Size, Value);

+}

+

+EFI_STATUS

 GetEnvironmentVariable (

   IN     CONST CHAR16*   VariableName,

+  IN     EFI_GUID*       VendorGuid,

   IN     VOID*           DefaultValue,

   IN OUT UINTN*          Size,

   OUT    VOID**          Value

@@ -307,13 +320,13 @@ GetEnvironmentVariable (
   // Try to get the variable size.

   *Value = NULL;

   VariableSize = 0;

-  Status = gRT->GetVariable ((CHAR16 *) VariableName, &gEfiGlobalVariableGuid, NULL, &VariableSize, *Value);

+  Status = gRT->GetVariable ((CHAR16 *) VariableName, VendorGuid, NULL, &VariableSize, *Value);

   if (Status == EFI_NOT_FOUND) {

     if ((DefaultValue != NULL) && (Size != NULL) && (*Size != 0)) {

       // If the environment variable does not exist yet then set it with the default value

       Status = gRT->SetVariable (

                     (CHAR16*)VariableName,

-                    &gEfiGlobalVariableGuid,

+                    VendorGuid,

                     EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,

                     *Size,

                     DefaultValue

@@ -329,7 +342,7 @@ GetEnvironmentVariable (
       return EFI_OUT_OF_RESOURCES;

     }

 

-    Status = gRT->GetVariable ((CHAR16 *)VariableName, &gEfiGlobalVariableGuid, NULL, &VariableSize, *Value);

+    Status = gRT->GetVariable ((CHAR16 *)VariableName, VendorGuid, NULL, &VariableSize, *Value);

     if (EFI_ERROR (Status)) {

       FreePool(*Value);

       return EFI_INVALID_PARAMETER;

diff --git a/ArmPkg/Library/BdsLib/BdsLib.inf b/ArmPkg/Library/BdsLib/BdsLib.inf
index 541bce88b..d9439d983 100644
--- a/ArmPkg/Library/BdsLib/BdsLib.inf
+++ b/ArmPkg/Library/BdsLib/BdsLib.inf
@@ -49,6 +49,7 @@
 [Guids]

   gEfiFileInfoGuid

   gArmMpCoreInfoGuid

+  gArmGlobalVariableGuid

 

 [Protocols]

   gEfiBdsArchProtocolGuid                       

diff --git a/ArmPkg/Library/BdsLib/BdsLoadOption.c b/ArmPkg/Library/BdsLib/BdsLoadOption.c
index 3f4566ffa..be5ed4198 100644
--- a/ArmPkg/Library/BdsLib/BdsLoadOption.c
+++ b/ArmPkg/Library/BdsLib/BdsLoadOption.c
@@ -1,6 +1,6 @@
 /** @file

 *

-*  Copyright (c) 2011-2012, ARM Limited. All rights reserved.

+*  Copyright (c) 2011-2013, ARM Limited. All rights reserved.

 *

 *  This program and the accompanying materials

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

@@ -76,7 +76,7 @@ BootOptionFromLoadOptionVariable (
   EFI_LOAD_OPTION       EfiLoadOption;

   UINTN                 EfiLoadOptionSize;

 

-  Status = GetEnvironmentVariable (BootVariableName, NULL, &EfiLoadOptionSize, (VOID**)&EfiLoadOption);

+  Status = GetGlobalEnvironmentVariable (BootVariableName, NULL, &EfiLoadOptionSize, (VOID**)&EfiLoadOption);

   if (!EFI_ERROR(Status)) {

     *BdsLoadOption = NULL;

     Status = BootOptionParseLoadOption (EfiLoadOption, EfiLoadOptionSize, BdsLoadOption);

@@ -203,7 +203,7 @@ BootOptionToLoadOptionVariable (
   // When it is a new entry we must add the entry to the BootOrder

   if (OldLoadOption == NULL) {

     // Add the new Boot Index to the list

-    Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);

+    Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);

     if (!EFI_ERROR(Status)) {

       BootOrder = ReallocatePool (BootOrderSize, BootOrderSize + sizeof(UINT16), BootOrder);

       // Add the new index at the end

@@ -225,7 +225,7 @@ BootOptionToLoadOptionVariable (
         );

     DEBUG((EFI_D_ERROR,"Create %s\n",BootVariableName));

 

-    // Free memory allocated by GetEnvironmentVariable

+    // Free memory allocated by GetGlobalEnvironmentVariable

     if (!EFI_ERROR(Status)) {

       FreePool (BootOrder);

     }

@@ -249,7 +249,7 @@ BootOptionAllocateBootIndex (
   BOOLEAN           Found;

 

   // Get the Boot Option Order from the environment variable

-  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);

+  Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);

   if (!EFI_ERROR(Status)) {

     for (BootIndex = 0; BootIndex <= 0xFFFF; BootIndex++) {

       Found = FALSE;