ArmPlatformPkg/Bds/BdsInternal.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2011, ARM Limited. All rights reserved.
   4 *
   5 *  This program and the accompanying materials
   6 *  are licensed and made available under the terms and conditions of the BSD License
   7 *  which accompanies this distribution.  The full text of the license may be found at
   8 *  http://opensource.org/licenses/bsd-license.php
   9 *
  10 *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 *
  13 **/
  14
  15 #ifndef _BDSINTERNAL_H_
  16 #define _BDSINTERNAL_H_
  17
  18 #include <PiDxe.h>
  19 #include <Library/BaseMemoryLib.h>
  20 #include <Library/BdsLib.h>
  21 #include <Library/BdsUnixLib.h>
  22 #include <Library/DebugLib.h>
  23 #include <Library/DevicePathLib.h>
  24 #include <Library/UefiLib.h>
  25 #include <Library/PrintLib.h>
  26 #include <Library/PcdLib.h>
  27 #include <Library/MemoryAllocationLib.h>
  28 #include <Library/UefiBootServicesTableLib.h>
  29 #include <Library/UefiRuntimeServicesTableLib.h>
  30
  31 #include <Protocol/DevicePathFromText.h>
  32 #include <Protocol/DevicePathToText.h>
  33
  34 #include <Guid/GlobalVariable.h>
  35
  36 #define BOOT_DEVICE_DESCRIPTION_MAX   100
  37 #define BOOT_DEVICE_FILEPATH_MAX      100
  38 #define BOOT_DEVICE_OPTION_MAX        300
  39 #define BOOT_DEVICE_ADDRESS_MAX       20
  40
  41 #define ARM_BDS_OPTIONAL_DATA_SIGNATURE   SIGNATURE_32('a', 'b', 'o', 'd')
  42
  43 #define IS_ARM_BDS_BOOTENTRY(ptr)  (ReadUnaligned32 ((CONST UINT32*)&((ARM_BDS_LOADER_OPTIONAL_DATA*)((ptr)->OptionalData))->Header.Signature) == ARM_BDS_OPTIONAL_DATA_SIGNATURE)
  44
  45 #define UPDATE_BOOT_ENTRY L"Update entry: "
  46 #define DELETE_BOOT_ENTRY L"Delete entry: "
  47
  48 typedef enum {
  49     BDS_LOADER_EFI_APPLICATION = 0,
  50     BDS_LOADER_KERNEL_LINUX_ATAG,
  51     BDS_LOADER_KERNEL_LINUX_FDT,
  52 } ARM_BDS_LOADER_TYPE;
  53
  54 typedef struct {
  55   UINT16                     CmdLineSize;
  56   UINT16                     InitrdSize;
  57
  58   // These following fields have variable length and are packed:
  59   //CHAR8                      *CmdLine;
  60   //EFI_DEVICE_PATH_PROTOCOL   *InitrdPathList;
  61 } ARM_BDS_LINUX_ARGUMENTS;
  62
  63 typedef union {
  64   ARM_BDS_LINUX_ARGUMENTS    LinuxArguments;
  65 } ARM_BDS_LOADER_ARGUMENTS;
  66
  67 typedef struct {
  68   UINT32                     Signature;
  69   ARM_BDS_LOADER_TYPE        LoaderType;
  70 } ARM_BDS_LOADER_OPTIONAL_DATA_HEADER;
  71
  72 typedef struct {
  73   ARM_BDS_LOADER_OPTIONAL_DATA_HEADER Header;
  74   ARM_BDS_LOADER_ARGUMENTS            Arguments;
  75 } ARM_BDS_LOADER_OPTIONAL_DATA;
  76
  77 typedef struct {
  78   LIST_ENTRY                  Link;
  79   BDS_LOAD_OPTION*            BdsLoadOption;
  80 } BDS_LOAD_OPTION_ENTRY;
  81
  82 typedef enum {
  83   BDS_DEVICE_FILESYSTEM = 0,
  84   BDS_DEVICE_MEMMAP,
  85   BDS_DEVICE_PXE,
  86   BDS_DEVICE_TFTP,
  87   BDS_DEVICE_MAX
  88 } BDS_SUPPORTED_DEVICE_TYPE;
  89
  90 typedef struct {
  91   LIST_ENTRY                          Link;
  92   CHAR16                              Description[BOOT_DEVICE_DESCRIPTION_MAX];
  93   EFI_DEVICE_PATH_PROTOCOL*           DevicePathProtocol;
  94   struct _BDS_LOAD_OPTION_SUPPORT*    Support;
  95 } BDS_SUPPORTED_DEVICE;
  96
  97 #define SUPPORTED_BOOT_DEVICE_FROM_LINK(a)   BASE_CR(a, BDS_SUPPORTED_DEVICE, Link)
  98
  99 typedef struct _BDS_LOAD_OPTION_SUPPORT {
 100   BDS_SUPPORTED_DEVICE_TYPE   Type;
 101   EFI_STATUS    (*ListDevices)(IN OUT LIST_ENTRY* BdsLoadOptionList);
 102   BOOLEAN       (*IsSupported)(IN  EFI_DEVICE_PATH *DevicePath);
 103   EFI_STATUS    (*CreateDevicePathNode)(IN CHAR16* FileName, OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathNode, OUT ARM_BDS_LOADER_TYPE *BootType, OUT UINT32 *Attributes);
 104   EFI_STATUS    (*UpdateDevicePathNode)(IN EFI_DEVICE_PATH *OldDevicePath, IN CHAR16* FileName, OUT EFI_DEVICE_PATH_PROTOCOL** NewDevicePath, OUT ARM_BDS_LOADER_TYPE *BootType, OUT UINT32 *Attributes);
 105 } BDS_LOAD_OPTION_SUPPORT;
 106
 107 #define LOAD_OPTION_ENTRY_FROM_LINK(a)  BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link)
 108 #define LOAD_OPTION_FROM_LINK(a)        ((BDS_LOAD_OPTION_ENTRY*)BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link))->BdsLoadOption
 109
 110 EFI_STATUS
 111 GetEnvironmentVariable (
 112   IN     CONST CHAR16*   VariableName,
 113   IN     VOID*           DefaultValue,
 114   IN OUT UINTN*          Size,
 115   OUT    VOID**          Value
 116   );
 117
 118 EFI_STATUS
 119 BootDeviceListSupportedInit (
 120   IN OUT LIST_ENTRY *SupportedDeviceList
 121   );
 122
 123 EFI_STATUS
 124 BootDeviceListSupportedFree (
 125   IN LIST_ENTRY *SupportedDeviceList,
 126   IN BDS_SUPPORTED_DEVICE *Except
 127   );
 128
 129 EFI_STATUS
 130 BootDeviceGetDeviceSupport (
 131   IN  EFI_DEVICE_PATH           *DevicePath,
 132   OUT BDS_LOAD_OPTION_SUPPORT   **DeviceSupport
 133   );
 134
 135 EFI_STATUS
 136 GetHIInputStr (
 137   IN OUT CHAR16  *CmdLine,
 138   IN     UINTN   MaxCmdLine
 139   );
 140
 141 EFI_STATUS
 142 EditHIInputStr (
 143   IN OUT CHAR16  *CmdLine,
 144   IN     UINTN   MaxCmdLine
 145   );
 146
 147 EFI_STATUS
 148 GetHIInputAscii (
 149   IN OUT CHAR8   *CmdLine,
 150   IN     UINTN   MaxCmdLine
 151   );
 152
 153 EFI_STATUS
 154 EditHIInputAscii (
 155   IN OUT CHAR8   *CmdLine,
 156   IN     UINTN   MaxCmdLine
 157   );
 158
 159 EFI_STATUS
 160 GetHIInputInteger (
 161   IN OUT UINTN   *Integer
 162   );
 163
 164 EFI_STATUS
 165 GetHIInputIP (
 166   OUT EFI_IP_ADDRESS   *Ip
 167   );
 168
 169 EFI_STATUS
 170 GetHIInputBoolean (
 171   OUT BOOLEAN *Value
 172   );
 173
 174 BOOLEAN
 175 HasFilePathEfiExtension (
 176   IN CHAR16* FilePath
 177   );
 178
 179 EFI_DEVICE_PATH*
 180 GetLastDevicePathNode (
 181   IN EFI_DEVICE_PATH*  DevicePath
 182   );
 183
 184 EFI_STATUS
 185 BdsStartBootOption (
 186   IN CHAR16* BootOption
 187   );
 188
 189 UINTN
 190 GetUnalignedDevicePathSize (
 191   IN EFI_DEVICE_PATH* DevicePath
 192   );
 193
 194 EFI_DEVICE_PATH*
 195 GetAlignedDevicePath (
 196   IN EFI_DEVICE_PATH* DevicePath
 197   );
 198
 199 EFI_STATUS
 200 GenerateDeviceDescriptionName (
 201   IN  EFI_HANDLE  Handle,
 202   IN OUT CHAR16*  Description
 203   );
 204
 205 EFI_STATUS
 206 BootOptionList (
 207   IN OUT LIST_ENTRY *BootOptionList
 208   );
 209
 210 EFI_STATUS
 211 BootOptionParseLoadOption (
 212   IN  EFI_LOAD_OPTION EfiLoadOption,
 213   IN  UINTN           EfiLoadOptionSize,
 214   OUT BDS_LOAD_OPTION **BdsLoadOption
 215   );
 216
 217 EFI_STATUS
 218 BootOptionStart (
 219   IN BDS_LOAD_OPTION *BootOption
 220   );
 221
 222 EFI_STATUS
 223 BootOptionCreate (
 224   IN  UINT32                    Attributes,
 225   IN  CHAR16*                   BootDescription,
 226   IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,
 227   IN  ARM_BDS_LOADER_TYPE       BootType,
 228   IN  ARM_BDS_LOADER_ARGUMENTS* BootArguments,
 229   OUT BDS_LOAD_OPTION**         BdsLoadOption
 230   );
 231
 232 EFI_STATUS
 233 BootOptionUpdate (
 234   IN  BDS_LOAD_OPTION*          BdsLoadOption,
 235   IN  UINT32                    Attributes,
 236   IN  CHAR16*                   BootDescription,
 237   IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,
 238   IN  ARM_BDS_LOADER_TYPE       BootType,
 239   IN  ARM_BDS_LOADER_ARGUMENTS* BootArguments
 240   );
 241
 242 EFI_STATUS
 243 BootOptionDelete (
 244   IN  BDS_LOAD_OPTION *BootOption
 245   );
 246
 247 EFI_STATUS
 248 BootMenuMain (
 249   VOID
 250   );
 251
 252 #endif /* _BDSINTERNAL_H_ */