ArmPlatformPkg/Bds: Upgrade the BDS to be more conformed to the UEFI Specification

The UEFI Specification defines some requirement related to the Boot Manager.
This new version of the BDS support most of the features:
- TimeOut, BootNext, BootOrder, Boot### environment variable for boot device selection
- ConOut. ConIn, ConErr environment variables for console intialization
- Boot EFI application defined by a Device Path
- Support removable devices
- Support FileSystem, MemMap, PXE and TFTP boot devices



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

1 files changed, 214 insertions, 0 deletions

diff --git a/ArmPlatformPkg/Bds/BdsInternal.h b/ArmPlatformPkg/Bds/BdsInternal.h
new file mode 100644
index 0000000000..9ef36a1ff6
--- /dev/null
+++ b/ArmPlatformPkg/Bds/BdsInternal.h
@@ -0,0 +1,214 @@
+/** @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

+*

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

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

+*

+**/

+

+#ifndef _BDSINTERNAL_H_

+#define _BDSINTERNAL_H_

+

+#include <PiDxe.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/BdsLib.h>

+#include <Library/BdsUnixLib.h>

+#include <Library/DebugLib.h>

+#include <Library/DevicePathLib.h>

+#include <Library/UefiLib.h>

+#include <Library/PrintLib.h>

+#include <Library/PcdLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/UefiRuntimeServicesTableLib.h>

+

+#include <Protocol/DevicePathFromText.h>

+#include <Protocol/DevicePathToText.h>

+

+#include <Guid/GlobalVariable.h>

+

+#define BOOT_DEVICE_DESCRIPTION_MAX   100

+#define BOOT_DEVICE_FILEPATH_MAX      100

+#define BOOT_DEVICE_OPTION_MAX        100

+#define BOOT_DEVICE_ADDRESS_MAX       20

+

+typedef enum {

+    BDS_LOADER_EFI_APPLICATION = 0,

+    BDS_LOADER_KERNEL_LINUX_ATAG,

+    BDS_LOADER_KERNEL_LINUX_FDT,

+} BDS_LOADER_TYPE;

+

+typedef struct {

+  BDS_LOADER_TYPE   LoaderType;

+  CHAR8             Arguments[];

+} BDS_LOADER_OPTIONAL_DATA;

+

+typedef enum {

+  BDS_DEVICE_FILESYSTEM = 0,

+  BDS_DEVICE_MEMMAP,

+  BDS_DEVICE_PXE,

+  BDS_DEVICE_TFTP,

+  BDS_DEVICE_MAX

+} BDS_SUPPORTED_DEVICE_TYPE;

+

+typedef struct {

+  LIST_ENTRY                  Link;

+  CHAR16                      Description[BOOT_DEVICE_DESCRIPTION_MAX];

+  EFI_DEVICE_PATH_PROTOCOL*   DevicePathProtocol;

+  struct _BDS_LOAD_OPTION_SUPPORT*    Support;

+} BDS_SUPPORTED_DEVICE;

+

+#define SUPPORTED_BOOT_DEVICE_FROM_LINK(a)   BASE_CR(a, BDS_SUPPORTED_DEVICE, Link)

+

+typedef UINT8* EFI_LOAD_OPTION;

+

+typedef struct {

+  LIST_ENTRY                  Link;

+

+  UINT16                      LoadOptionIndex;

+  EFI_LOAD_OPTION             LoadOption;

+  UINTN                       LoadOptionSize;

+

+  UINT32                      Attributes;

+  UINT16                      FilePathListLength;

+  CHAR16                      *Description;

+  EFI_DEVICE_PATH_PROTOCOL    *FilePathList;

+  BDS_LOADER_OPTIONAL_DATA    *OptionalData;

+} BDS_LOAD_OPTION;

+

+typedef struct _BDS_LOAD_OPTION_SUPPORT {

+  BDS_SUPPORTED_DEVICE_TYPE   Type;

+  EFI_STATUS    (*ListDevices)(IN OUT LIST_ENTRY* BdsLoadOptionList);

+  BOOLEAN       (*IsSupported)(IN BDS_LOAD_OPTION* BdsLoadOption);

+  EFI_STATUS    (*CreateDevicePathNode)(IN  BDS_SUPPORTED_DEVICE* BdsLoadOption, OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathNode, OUT BDS_LOADER_TYPE *BootType, OUT UINT32 *Attributes);

+  EFI_STATUS    (*UpdateDevicePathNode)(IN BDS_LOAD_OPTION *BootOption, OUT EFI_DEVICE_PATH_PROTOCOL** NewDevicePath, OUT BDS_LOADER_TYPE *BootType, OUT UINT32 *Attributes);

+} BDS_LOAD_OPTION_SUPPORT;

+

+#define LOAD_OPTION_FROM_LINK(a)   BASE_CR(a, BDS_LOAD_OPTION, Link)

+

+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

+  );

+

+EFI_STATUS

+BootDeviceListSupportedFree (

+  IN LIST_ENTRY *SupportedDeviceList

+  );

+

+EFI_STATUS

+BootDeviceGetDeviceSupport (

+  IN  BDS_LOAD_OPTION *BootOption,

+  OUT BDS_LOAD_OPTION_SUPPORT**  DeviceSupport

+  );

+

+EFI_STATUS

+GetHIInputAscii (

+  IN OUT CHAR8   *CmdLine,

+  IN     UINTN   MaxCmdLine

+  );

+

+EFI_STATUS

+EditHIInputAscii (

+  IN OUT CHAR8   *CmdLine,

+  IN     UINTN   MaxCmdLine

+  );

+

+EFI_STATUS

+GetHIInputInteger (

+  IN OUT UINTN   *Integer

+  );

+

+EFI_STATUS

+GetHIInputIP (

+  OUT EFI_IP_ADDRESS   *Ip

+  );

+

+EFI_STATUS

+GetHIInputBoolean (

+  OUT BOOLEAN *Value

+  );

+

+BOOLEAN

+HasFilePathEfiExtension (

+  IN CHAR16* FilePath

+  );

+

+EFI_DEVICE_PATH*

+GetLastDevicePathNode (

+  IN EFI_DEVICE_PATH*  DevicePath

+  );

+

+EFI_STATUS

+BdsStartBootOption (

+  IN CHAR16* BootOption

+  );

+

+EFI_STATUS

+GenerateDeviceDescriptionName (

+  IN  EFI_HANDLE  Handle,

+  IN OUT CHAR16*  Description

+  );

+

+EFI_STATUS

+BootOptionList (

+  IN OUT LIST_ENTRY *BootOptionList

+  );

+

+EFI_STATUS

+BootOptionParseLoadOption (

+  IN  EFI_LOAD_OPTION EfiLoadOption,

+  IN  UINTN           EfiLoadOptionSize,

+  OUT BDS_LOAD_OPTION **BdsLoadOption

+  );

+

+EFI_STATUS

+BootOptionStart (

+  IN BDS_LOAD_OPTION *BootOption

+  );

+

+EFI_STATUS

+BootOptionCreate (

+  IN  UINT32 Attributes,

+  IN  CHAR16* BootDescription,

+  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,

+  IN  BDS_LOADER_TYPE   BootType,

+  IN  CHAR8*            BootArguments,

+  OUT BDS_LOAD_OPTION **BdsLoadOption

+  );

+

+EFI_STATUS

+BootOptionUpdate (

+  IN  BDS_LOAD_OPTION *BdsLoadOption,

+  IN  UINT32 Attributes,

+  IN  CHAR16* BootDescription,

+  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,

+  IN  BDS_LOADER_TYPE   BootType,

+  IN  CHAR8*            BootArguments

+  );

+

+EFI_STATUS

+BootOptionDelete (

+  IN  BDS_LOAD_OPTION *BootOption

+  );

+

+EFI_STATUS

+BootMenuMain (

+  VOID

+  );

+

+#endif /* _BDSINTERNAL_H_ */