ArmPkg/BdsLib: Move the Generic BDS_LOAD_OPTION structure from Armplatform/Pkg to...

[mirror_edk2.git] / ArmPlatformPkg / Bds / BdsInternal.h

/** @file\r
*\r
*  Copyright (c) 2011, ARM Limited. All rights reserved.\r
*\r
*  This program and the accompanying materials\r
*  are licensed and made available under the terms and conditions of the BSD License\r
*  which accompanies this distribution.  The full text of the license may be found at\r
*  http://opensource.org/licenses/bsd-license.php\r
*\r
*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
*\r
**/\r
\r
#ifndef _BDSINTERNAL_H_\r
#define _BDSINTERNAL_H_\r
\r
#include <PiDxe.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BdsLib.h>\r
#include <Library/BdsUnixLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
#include <Protocol/DevicePathFromText.h>\r
#include <Protocol/DevicePathToText.h>\r
\r
#include <Guid/GlobalVariable.h>\r
\r
#define BOOT_DEVICE_DESCRIPTION_MAX   100\r
#define BOOT_DEVICE_FILEPATH_MAX      100\r
#define BOOT_DEVICE_OPTION_MAX        300\r
#define BOOT_DEVICE_ADDRESS_MAX       20\r
\r
#define ARM_BDS_OPTIONAL_DATA_SIGNATURE   SIGNATURE_32('a', 'b', 'o', 'd')\r
\r
#define IS_ARM_BDS_BOOTENTRY(ptr)  (ReadUnaligned32 ((CONST UINT32*)&((ARM_BDS_LOADER_OPTIONAL_DATA*)((ptr)->OptionalData))->Header.Signature) == ARM_BDS_OPTIONAL_DATA_SIGNATURE)\r
\r
typedef enum {\r
    BDS_LOADER_EFI_APPLICATION = 0,\r
    BDS_LOADER_KERNEL_LINUX_ATAG,\r
    BDS_LOADER_KERNEL_LINUX_FDT,\r
} ARM_BDS_LOADER_TYPE;\r
\r
typedef struct {\r
  UINT16                     CmdLineSize;\r
  UINT16                     InitrdSize;\r
  \r
  // These following fields have variable length and are packed:\r
  //CHAR8                      *CmdLine;\r
  //EFI_DEVICE_PATH_PROTOCOL   *InitrdPathList;\r
} ARM_BDS_LINUX_ARGUMENTS;\r
\r
typedef union {\r
  ARM_BDS_LINUX_ARGUMENTS    LinuxArguments;\r
} ARM_BDS_LOADER_ARGUMENTS;\r
\r
typedef struct {\r
  UINT32                     Signature;\r
  ARM_BDS_LOADER_TYPE        LoaderType;\r
} ARM_BDS_LOADER_OPTIONAL_DATA_HEADER;\r
\r
typedef struct {\r
  ARM_BDS_LOADER_OPTIONAL_DATA_HEADER Header;\r
  ARM_BDS_LOADER_ARGUMENTS            Arguments;\r
} ARM_BDS_LOADER_OPTIONAL_DATA;\r
\r
typedef struct {\r
  LIST_ENTRY                  Link;\r
  BDS_LOAD_OPTION*            BdsLoadOption;\r
} BDS_LOAD_OPTION_ENTRY;\r
\r
typedef enum {\r
  BDS_DEVICE_FILESYSTEM = 0,\r
  BDS_DEVICE_MEMMAP,\r
  BDS_DEVICE_PXE,\r
  BDS_DEVICE_TFTP,\r
  BDS_DEVICE_MAX\r
} BDS_SUPPORTED_DEVICE_TYPE;\r
\r
typedef struct {\r
  LIST_ENTRY                  Link;\r
  CHAR16                      Description[BOOT_DEVICE_DESCRIPTION_MAX];\r
  EFI_DEVICE_PATH_PROTOCOL*   DevicePathProtocol;\r
  struct _BDS_LOAD_OPTION_SUPPORT*    Support;\r
} BDS_SUPPORTED_DEVICE;\r
\r
#define SUPPORTED_BOOT_DEVICE_FROM_LINK(a)   BASE_CR(a, BDS_SUPPORTED_DEVICE, Link)\r
\r
typedef struct _BDS_LOAD_OPTION_SUPPORT {\r
  BDS_SUPPORTED_DEVICE_TYPE   Type;\r
  EFI_STATUS    (*ListDevices)(IN OUT LIST_ENTRY* BdsLoadOptionList);\r
  BOOLEAN       (*IsSupported)(IN BDS_LOAD_OPTION* BdsLoadOption);\r
  EFI_STATUS    (*CreateDevicePathNode)(IN BDS_SUPPORTED_DEVICE* BdsLoadOption, OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathNode, OUT ARM_BDS_LOADER_TYPE *BootType, OUT UINT32 *Attributes);\r
  EFI_STATUS    (*UpdateDevicePathNode)(IN EFI_DEVICE_PATH *OldDevicePath, OUT EFI_DEVICE_PATH_PROTOCOL** NewDevicePath, OUT ARM_BDS_LOADER_TYPE *BootType, OUT UINT32 *Attributes);\r
} BDS_LOAD_OPTION_SUPPORT;\r
\r
#define LOAD_OPTION_ENTRY_FROM_LINK(a)  BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link)\r
#define LOAD_OPTION_FROM_LINK(a)        ((BDS_LOAD_OPTION_ENTRY*)BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link))->BdsLoadOption\r
\r
EFI_STATUS\r
GetEnvironmentVariable (\r
  IN     CONST CHAR16*   VariableName,\r
  IN     VOID*           DefaultValue,\r
  IN OUT UINTN*          Size,\r
  OUT    VOID**          Value\r
  );\r
\r
EFI_STATUS\r
BootDeviceListSupportedInit (\r
  IN OUT LIST_ENTRY *SupportedDeviceList\r
  );\r
\r
EFI_STATUS\r
BootDeviceListSupportedFree (\r
  IN LIST_ENTRY *SupportedDeviceList,\r
  IN BDS_SUPPORTED_DEVICE *Except\r
  );\r
\r
EFI_STATUS\r
BootDeviceGetDeviceSupport (\r
  IN  BDS_LOAD_OPTION *BootOption,\r
  OUT BDS_LOAD_OPTION_SUPPORT**  DeviceSupport\r
  );\r
\r
EFI_STATUS\r
GetHIInputStr (\r
  IN OUT CHAR16  *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  );\r
\r
EFI_STATUS\r
EditHIInputStr (\r
  IN OUT CHAR16  *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  );\r
\r
EFI_STATUS\r
GetHIInputAscii (\r
  IN OUT CHAR8   *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  );\r
\r
EFI_STATUS\r
EditHIInputAscii (\r
  IN OUT CHAR8   *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  );\r
\r
EFI_STATUS\r
GetHIInputInteger (\r
  IN OUT UINTN   *Integer\r
  );\r
\r
EFI_STATUS\r
GetHIInputIP (\r
  OUT EFI_IP_ADDRESS   *Ip\r
  );\r
\r
EFI_STATUS\r
GetHIInputBoolean (\r
  OUT BOOLEAN *Value\r
  );\r
\r
BOOLEAN\r
HasFilePathEfiExtension (\r
  IN CHAR16* FilePath\r
  );\r
\r
EFI_DEVICE_PATH*\r
GetLastDevicePathNode (\r
  IN EFI_DEVICE_PATH*  DevicePath\r
  );\r
\r
EFI_STATUS\r
BdsStartBootOption (\r
  IN CHAR16* BootOption\r
  );\r
\r
UINTN\r
GetUnalignedDevicePathSize (\r
  IN EFI_DEVICE_PATH* DevicePath\r
  );\r
\r
EFI_DEVICE_PATH*\r
GetAlignedDevicePath (\r
  IN EFI_DEVICE_PATH* DevicePath\r
  );\r
\r
EFI_STATUS\r
GenerateDeviceDescriptionName (\r
  IN  EFI_HANDLE  Handle,\r
  IN OUT CHAR16*  Description\r
  );\r
\r
EFI_STATUS\r
BootOptionList (\r
  IN OUT LIST_ENTRY *BootOptionList\r
  );\r
\r
EFI_STATUS\r
BootOptionParseLoadOption (\r
  IN  EFI_LOAD_OPTION EfiLoadOption,\r
  IN  UINTN           EfiLoadOptionSize,\r
  OUT BDS_LOAD_OPTION **BdsLoadOption\r
  );\r
\r
EFI_STATUS\r
BootOptionStart (\r
  IN BDS_LOAD_OPTION *BootOption\r
  );\r
\r
EFI_STATUS\r
BootOptionCreate (\r
  IN  UINT32                    Attributes,\r
  IN  CHAR16*                   BootDescription,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
  IN  ARM_BDS_LOADER_TYPE       BootType,\r
  IN  ARM_BDS_LOADER_ARGUMENTS* BootArguments,\r
  OUT BDS_LOAD_OPTION**         BdsLoadOption\r
  );\r
\r
EFI_STATUS\r
BootOptionUpdate (\r
  IN  BDS_LOAD_OPTION*          BdsLoadOption,\r
  IN  UINT32                    Attributes,\r
  IN  CHAR16*                   BootDescription,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
  IN  ARM_BDS_LOADER_TYPE       BootType,\r
  IN  ARM_BDS_LOADER_ARGUMENTS* BootArguments\r
  );\r
\r
EFI_STATUS\r
BootOptionDelete (\r
  IN  BDS_LOAD_OPTION *BootOption\r
  );\r
\r
EFI_STATUS\r
BootMenuMain (\r
  VOID\r
  );\r
\r
#endif /* _BDSINTERNAL_H_ */\r