EmbeddedPkg: add DtPlatformDtbLoaderLib library class
[mirror_edk2.git] / EmbeddedPkg / Include / Library / DtPlatformDtbLoaderLib.h
CommitLineData
449a5df4
AB
1/** @file\r
2*\r
3* Copyright (c) 2017, Linaro, Ltd. All rights reserved.\r
4*\r
5* This program and the accompanying materials\r
6* are licensed and made available under the terms and conditions of the BSD License\r
7* which accompanies this distribution. The full text of the license may be found at\r
8* http://opensource.org/licenses/bsd-license.php\r
9*\r
10* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12*\r
13**/\r
14\r
15#ifndef __DT_PLATFORM_DTB_LOADER_LIB_H__\r
16#define __DT_PLATFORM_DTB_LOADER_LIB_H__\r
17\r
18#include <Uefi/UefiBaseType.h>\r
19\r
20/**\r
21 Return a pool allocated copy of the DTB image that is appropriate for\r
22 booting the current platform via DT.\r
23\r
24 @param[out] Dtb Pointer to the DTB copy\r
25 @param[out] DtbSize Size of the DTB copy\r
26\r
27 @retval EFI_SUCCESS Operation completed successfully\r
28 @retval EFI_NOT_FOUND No suitable DTB image could be located\r
29 @retval EFI_OUT_OF_RESOURCES No pool memory available\r
30\r
31**/\r
32EFI_STATUS\r
33EFIAPI\r
34DtPlatformLoadDtb (\r
35 OUT VOID **Dtb,\r
36 OUT UINTN *DtbSize\r
37 );\r
38\r
39#endif\r