EmbeddedPkg: add DtPlatformDtbLoaderLib library class
[mirror_edk2.git] / EmbeddedPkg / Include / Library / DtPlatformDtbLoaderLib.h
1 /** @file
2 *
3 * Copyright (c) 2017, Linaro, Ltd. 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 __DT_PLATFORM_DTB_LOADER_LIB_H__
16 #define __DT_PLATFORM_DTB_LOADER_LIB_H__
17
18 #include <Uefi/UefiBaseType.h>
19
20 /**
21 Return a pool allocated copy of the DTB image that is appropriate for
22 booting the current platform via DT.
23
24 @param[out] Dtb Pointer to the DTB copy
25 @param[out] DtbSize Size of the DTB copy
26
27 @retval EFI_SUCCESS Operation completed successfully
28 @retval EFI_NOT_FOUND No suitable DTB image could be located
29 @retval EFI_OUT_OF_RESOURCES No pool memory available
30
31 **/
32 EFI_STATUS
33 EFIAPI
34 DtPlatformLoadDtb (
35 OUT VOID **Dtb,
36 OUT UINTN *DtbSize
37 );
38
39 #endif