ArmPkg/Include/Library/BdsLib.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 __BDS_ENTRY_H__
  16 #define __BDS_ENTRY_H__
  17
  18 typedef UINT8* EFI_LOAD_OPTION;
  19
  20 /**
  21   This is defined by the UEFI specs, don't change it
  22 **/
  23 typedef struct {
  24   UINT16                      LoadOptionIndex;
  25   EFI_LOAD_OPTION             LoadOption;
  26   UINTN                       LoadOptionSize;
  27
  28   UINT32                      Attributes;
  29   UINT16                      FilePathListLength;
  30   CHAR16                      *Description;
  31   EFI_DEVICE_PATH_PROTOCOL    *FilePathList;
  32
  33   VOID*                       OptionalData;
  34   UINTN                       OptionalDataSize;
  35 } BDS_LOAD_OPTION;
  36
  37 /**
  38   Connect a Device Path and return the handle of the driver that support this DevicePath
  39
  40   @param  DevicePath            Device Path of the File to connect
  41   @param  Handle                Handle of the driver that support this DevicePath
  42   @param  RemainingDevicePath   Remaining DevicePath nodes that do not match the driver DevicePath
  43
  44   @retval EFI_SUCCESS           A driver that matches the Device Path has been found
  45   @retval EFI_NOT_FOUND         No handles match the search.
  46   @retval EFI_INVALID_PARAMETER DevicePath or Handle is NULL
  47
  48 **/
  49 EFI_STATUS
  50 BdsConnectDevicePath (
  51   IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,
  52   OUT EFI_HANDLE                *Handle,
  53   OUT EFI_DEVICE_PATH_PROTOCOL  **RemainingDevicePath
  54   );
  55
  56 /**
  57   Connect all DXE drivers
  58
  59   @retval EFI_SUCCESS           All drivers have been connected
  60   @retval EFI_NOT_FOUND         No handles match the search.
  61   @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.
  62
  63 **/
  64 EFI_STATUS
  65 BdsConnectAllDrivers (
  66   VOID
  67   );
  68
  69 EFI_STATUS
  70 GetEnvironmentVariable (
  71   IN     CONST CHAR16*   VariableName,
  72   IN     VOID*           DefaultValue,
  73   IN OUT UINTN*          Size,
  74   OUT    VOID**          Value
  75   );
  76
  77 EFI_STATUS
  78 BootOptionFromLoadOptionIndex (
  79   IN  UINT16            LoadOptionIndex,
  80   OUT BDS_LOAD_OPTION** BdsLoadOption
  81   );
  82
  83 EFI_STATUS
  84 BootOptionFromLoadOptionVariable (
  85   IN  CHAR16*           BootVariableName,
  86   OUT BDS_LOAD_OPTION** BdsLoadOption
  87   );
  88
  89 EFI_STATUS
  90 BootOptionToLoadOptionVariable (
  91   IN BDS_LOAD_OPTION*   BdsLoadOption
  92   );
  93
  94 UINT16
  95 BootOptionAllocateBootIndex (
  96   VOID
  97   );
  98
  99 /**
 100   Start a Linux kernel from a Device Path
 101
 102   @param  LinuxKernel           Device Path to the Linux Kernel
 103   @param  Parameters            Linux kernel arguments
 104   @param  Fdt                   Device Path to the Flat Device Tree
 105
 106   @retval EFI_SUCCESS           All drivers have been connected
 107   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
 108   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
 109
 110 **/
 111 EFI_STATUS
 112 BdsBootLinux (
 113   IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,
 114   IN  EFI_DEVICE_PATH_PROTOCOL* InitrdDevicePath,
 115   IN  CONST CHAR8*              Arguments,
 116   IN  EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath
 117   );
 118
 119 /**
 120   Start an EFI Application from a Device Path
 121
 122   @param  ParentImageHandle     Handle of the calling image
 123   @param  DevicePath            Location of the EFI Application
 124
 125   @retval EFI_SUCCESS           All drivers have been connected
 126   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
 127   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
 128
 129 **/
 130 EFI_STATUS
 131 BdsStartEfiApplication (
 132   IN EFI_HANDLE                  ParentImageHandle,
 133   IN EFI_DEVICE_PATH_PROTOCOL    *DevicePath,
 134   IN UINTN                       LoadOptionsSize,
 135   IN VOID*                       LoadOptions
 136   );
 137
 138 /**
 139   Start an EFI Application from any Firmware Volume
 140
 141   @param  EfiApp                EFI Application Name
 142
 143   @retval EFI_SUCCESS           All drivers have been connected
 144   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
 145   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
 146
 147 **/
 148 EFI_STATUS
 149 BdsLoadApplication (
 150   IN EFI_HANDLE                  ParentImageHandle,
 151   IN CHAR16*                     EfiApp,
 152   IN UINTN                       LoadOptionsSize,
 153   IN VOID*                       LoadOptions
 154   );
 155
 156 EFI_STATUS
 157 BdsLoadImage (
 158   IN     EFI_DEVICE_PATH       *DevicePath,
 159   IN     EFI_ALLOCATE_TYPE     Type,
 160   IN OUT EFI_PHYSICAL_ADDRESS* Image,
 161   OUT    UINTN                 *FileSize
 162   );
 163
 164 #endif