EmbeddedPkg/Include/Library/DtPlatformDtbLoaderLib.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2017, Linaro, Ltd. All rights reserved.
   4 *
   5 *  SPDX-License-Identifier: BSD-2-Clause-Patent
   6 *
   7 **/
   8
   9 #ifndef __DT_PLATFORM_DTB_LOADER_LIB_H__
  10 #define __DT_PLATFORM_DTB_LOADER_LIB_H__
  11
  12 #include <Uefi/UefiBaseType.h>
  13
  14 /**
  15   Return a pool allocated copy of the DTB image that is appropriate for
  16   booting the current platform via DT.
  17
  18   @param[out]   Dtb                   Pointer to the DTB copy
  19   @param[out]   DtbSize               Size of the DTB copy
  20
  21   @retval       EFI_SUCCESS           Operation completed successfully
  22   @retval       EFI_NOT_FOUND         No suitable DTB image could be located
  23   @retval       EFI_OUT_OF_RESOURCES  No pool memory available
  24
  25 **/
  26 EFI_STATUS
  27 EFIAPI
  28 DtPlatformLoadDtb (
  29   OUT   VOID        **Dtb,
  30   OUT   UINTN       *DtbSize
  31   );
  32
  33 #endif