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, 48 insertions, 51 deletions

diff --git a/ArmPlatformPkg/Bds/Bds.c b/ArmPlatformPkg/Bds/Bds.c
index 11a76de90f..fadba6e7a5 100644
--- a/ArmPlatformPkg/Bds/Bds.c
+++ b/ArmPlatformPkg/Bds/Bds.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.

 *

 **/

 

@@ -39,7 +39,7 @@ GetConsoleDevicePathFromVariable (
   CHAR16*                   NextDevicePathStr;

   EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL  *EfiDevicePathFromTextProtocol;

 

-  Status = GetEnvironmentVariable (ConsoleVarName, NULL, NULL, (VOID**)&DevicePathInstances);

+  Status = GetGlobalEnvironmentVariable (ConsoleVarName, NULL, NULL, (VOID**)&DevicePathInstances);

   if (EFI_ERROR(Status)) {

     // In case no default console device path has been defined we assume a driver handles the console (eg: SimpleTextInOutSerial)

     if ((DefaultConsolePaths == NULL) || (DefaultConsolePaths[0] == L'\0')) {

@@ -124,7 +124,7 @@ InitializeConsolePipe (
         EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;

         CHAR16* DevicePathTxt;

         EFI_STATUS Status;

-	

+

         Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);

         if (!EFI_ERROR(Status)) {

           DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText (DevicePath, TRUE, TRUE);

@@ -313,7 +313,7 @@ StartDefaultBootOnTimeout (
   Size = sizeof(UINT16);

   Timeout = (UINT16)PcdGet16 (PcdPlatformBootTimeOut);

   TimeoutPtr = &Timeout;

-  GetEnvironmentVariable (L"Timeout", &Timeout, &Size, (VOID**)&TimeoutPtr);

+  GetGlobalEnvironmentVariable (L"Timeout", &Timeout, &Size, (VOID**)&TimeoutPtr);

 

   if (Timeout != 0xFFFF) {

     if (Timeout > 0) {

@@ -344,7 +344,7 @@ StartDefaultBootOnTimeout (
     // In case of Timeout we start the default boot selection

     if (Timeout == 0) {

       // Get the Boot Option Order from the environment variable (a default value should have been created)

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

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

 

       for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {

         UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BootOrder[Index]);

@@ -362,19 +362,19 @@ StartDefaultBootOnTimeout (
 }

 

 /**

-  This function uses policy data from the platform to determine what operating 

-  system or system utility should be loaded and invoked.  This function call 

-  also optionally make the use of user input to determine the operating system 

-  or system utility to be loaded and invoked.  When the DXE Core has dispatched 

-  all the drivers on the dispatch queue, this function is called.  This 

-  function will attempt to connect the boot devices required to load and invoke 

-  the selected operating system or system utility.  During this process, 

-  additional firmware volumes may be discovered that may contain addition DXE 

-  drivers that can be dispatched by the DXE Core.   If a boot device cannot be 

-  fully connected, this function calls the DXE Service Dispatch() to allow the 

-  DXE drivers from any newly discovered firmware volumes to be dispatched.  

-  Then the boot device connection can be attempted again.  If the same boot 

-  device connection operation fails twice in a row, then that boot device has 

+  This function uses policy data from the platform to determine what operating

+  system or system utility should be loaded and invoked.  This function call

+  also optionally make the use of user input to determine the operating system

+  or system utility to be loaded and invoked.  When the DXE Core has dispatched

+  all the drivers on the dispatch queue, this function is called.  This

+  function will attempt to connect the boot devices required to load and invoke

+  the selected operating system or system utility.  During this process,

+  additional firmware volumes may be discovered that may contain addition DXE

+  drivers that can be dispatched by the DXE Core.   If a boot device cannot be

+  fully connected, this function calls the DXE Service Dispatch() to allow the

+  DXE drivers from any newly discovered firmware volumes to be dispatched.

+  Then the boot device connection can be attempted again.  If the same boot

+  device connection operation fails twice in a row, then that boot device has

   failed, and should be skipped.  This function should never return.

 

   @param  This             The EFI_BDS_ARCH_PROTOCOL instance.

@@ -408,7 +408,7 @@ BdsEntry (
 

   // If BootNext environment variable is defined then we just load it !

   BootNextSize = sizeof(UINT16);

-  Status = GetEnvironmentVariable (L"BootNext", NULL, &BootNextSize, (VOID**)&BootNext);

+  Status = GetGlobalEnvironmentVariable (L"BootNext", NULL, &BootNextSize, (VOID**)&BootNext);

   if (!EFI_ERROR(Status)) {

     ASSERT(BootNextSize == sizeof(UINT16));

 

diff --git a/ArmPlatformPkg/Bds/BdsInternal.h b/ArmPlatformPkg/Bds/BdsInternal.h
index 1307e2ae68..426d61e3cf 100644
--- a/ArmPlatformPkg/Bds/BdsInternal.h
+++ b/ArmPlatformPkg/Bds/BdsInternal.h
@@ -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

@@ -54,7 +54,7 @@ typedef enum {
 typedef struct {

   UINT16                     CmdLineSize;

   UINT16                     InitrdSize;

-  

+

   // These following fields have variable length and are packed:

   //CHAR8                      *CmdLine;

   //EFI_DEVICE_PATH_PROTOCOL   *InitrdPathList;

@@ -108,14 +108,6 @@ typedef struct _BDS_LOAD_OPTION_SUPPORT {
 #define LOAD_OPTION_FROM_LINK(a)        ((BDS_LOAD_OPTION_ENTRY*)BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link))->BdsLoadOption

 

 EFI_STATUS

-GetEnvironmentVariable (

-  IN     CONST CHAR16*   VariableName,

-  IN     VOID*           DefaultValue,

-  IN OUT UINTN*          Size,

-  OUT    VOID**          Value

-  );

-

-EFI_STATUS

 BootDeviceListSupportedInit (

   IN OUT LIST_ENTRY *SupportedDeviceList

   );

diff --git a/ArmPlatformPkg/Bds/BootOption.c b/ArmPlatformPkg/Bds/BootOption.c
index e562add3d1..ee0301ef2c 100644
--- a/ArmPlatformPkg/Bds/BootOption.c
+++ b/ArmPlatformPkg/Bds/BootOption.c
@@ -12,6 +12,7 @@
 *

 **/

 

+#include <Guid/ArmGlobalVariableHob.h>

 #include "BdsInternal.h"

 

 extern EFI_HANDLE mImageHandle;

@@ -76,7 +77,8 @@ BootOptionStart (
 

       // Get the FDT device path

       FdtDevicePathSize = GetDevicePathSize (DefaultFdtDevicePath);

-      Status = GetEnvironmentVariable ((CHAR16 *)L"Fdt", DefaultFdtDevicePath, &FdtDevicePathSize, (VOID **)&FdtDevicePath);

+      Status = GetEnvironmentVariable ((CHAR16 *)L"Fdt", &gArmGlobalVariableGuid,

+                 DefaultFdtDevicePath, &FdtDevicePathSize, (VOID **)&FdtDevicePath);

       ASSERT_EFI_ERROR(Status);

 

       Status = BdsBootLinuxFdt (BootOption->FilePathList,

@@ -120,7 +122,7 @@ BootOptionList (
   InitializeListHead (BootOptionList);

 

   // 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)) {

     return Status;

   }

@@ -286,7 +288,7 @@ BootOptionCreate (
       );

 

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

@@ -358,7 +360,7 @@ BootOptionDelete (
   EFI_STATUS    Status;

 

   // Remove the entry from the BootOrder environment variable

-  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/ArmPlatformPkg/Include/Guid/ArmGlobalVariableHob.h b/ArmPlatformPkg/Include/Guid/ArmGlobalVariableHob.h
index f61036840d..c175cee6df 100644
--- a/ArmPlatformPkg/Include/Guid/ArmGlobalVariableHob.h
+++ b/ArmPlatformPkg/Include/Guid/ArmGlobalVariableHob.h
@@ -1,6 +1,6 @@
 /** @file

 *

-*  Copyright (c) 2011, 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

@@ -15,6 +15,9 @@
 #ifndef __ARM_GLOBAL_VARIABLE_GUID_H__

 #define __ARM_GLOBAL_VARIABLE_GUID_H__

 

+#include <Pi/PiBootMode.h>

+#include <Pi/PiHob.h>

+

 #define ARM_HOB_GLOBAL_VARIABLE_GUID  \

   { 0xc3253c90, 0xa24f, 0x4599, { 0xa6, 0x64, 0x1f, 0x88, 0x13, 0x77, 0x8f, 0xc9} };

 

diff --git a/ArmPlatformPkg/Library/EblCmdLib/EblCmdFdt.c b/ArmPlatformPkg/Library/EblCmdLib/EblCmdFdt.c
index 5da71cff2b..dcd7c41001 100644
--- a/ArmPlatformPkg/Library/EblCmdLib/EblCmdFdt.c
+++ b/ArmPlatformPkg/Library/EblCmdLib/EblCmdFdt.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.

 *

 **/

 

@@ -26,7 +26,7 @@
 

 #include <Protocol/DevicePathFromText.h>

 

-#include <Guid/GlobalVariable.h>

+#include <Guid/ArmGlobalVariableHob.h>

 

 #include <libfdt.h>

 

@@ -187,7 +187,7 @@ EblDumpFdt (
 

   // If no FDT file is passed to the argument then get the one from the platform

   if (Argc < 2) {

-    Status = GetEnvironmentVariable (L"Fdt",NULL,NULL,(VOID**)&FdtDevicePath);

+    Status = GetEnvironmentVariable (L"Fdt", &gArmGlobalVariableGuid, NULL, NULL, (VOID**)&FdtDevicePath);

     if (Status == EFI_NOT_FOUND) {

       // No set yet, get the Default Device Path

       Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL, (VOID **)&EfiDevicePathFromTextProtocol);