ArmPkg/Include/Library/BdsUnixLib.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_UNIX_LIB_H_
  16 #define _BDS_UNIX_LIB_H_
  17
  18 /**
  19   Start a Linux kernel from a Device Path
  20
  21   @param  LinuxKernel           Device Path to the Linux Kernel
  22   @param  Parameters            Linux kernel agruments
  23   @param  Fdt                   Device Path to the Flat Device Tree
  24
  25   @retval EFI_SUCCESS           All drivers have been connected
  26   @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found
  27   @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.
  28
  29 **/
  30 EFI_STATUS
  31 BdsBootLinux (
  32   IN  EFI_DEVICE_PATH_PROTOCOL* LinuxKernelDevicePath,
  33   IN  EFI_DEVICE_PATH_PROTOCOL* InitrdDevicePath,
  34   IN  CONST CHAR8*              Arguments,
  35   IN  EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath
  36   );
  37
  38 #endif