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 /**
  19   Connect all DXE drivers
  20
  21   @retval EFI_SUCCESS           All drivers have been connected
  22   @retval EFI_NOT_FOUND         No handles match the search.
  23   @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.
  24
  25 **/
  26 EFI_STATUS
  27 BdsConnectAllDrivers (
  28   VOID
  29   );
  30
  31 /**
  32   Start a Linux kernel from a Device Path
  33
  34   @param  LinuxKernel           Device Path to the Linux Kernel
  35   @param  Parameters            Linux kernel agruments
  36   @param  Fdt                   Device Path to the Flat Device Tree
  37
  38   @retval EFI_SUCCESS           All drivers have been connected
  39   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
  40   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
  41
  42 **/
  43 EFI_STATUS
  44 BdsBootLinux (
  45   IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,
  46   IN  CONST CHAR8*  Arguments,
  47   IN  EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath
  48   );
  49
  50 /**
  51   Start an EFI Application from any Firmware Volume
  52
  53   @param  EfiApp                EFI Application Name
  54
  55   @retval EFI_SUCCESS           All drivers have been connected
  56   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
  57   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
  58
  59 **/
  60 EFI_STATUS
  61 BdsLoadApplication (
  62   IN EFI_HANDLE                  ParentImageHandle,
  63   IN CHAR16*                     EfiApp
  64   );
  65
  66 #endif