blob: 8a8cf38581e024c4f208a2b6cb72d9d5a4a76fad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
/** @file
Flattened Device Tree parser definitions.
Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef FDT_HW_INFO_PARSER_H_
#define FDT_HW_INFO_PARSER_H_
#include <FdtHwInfoParserInclude.h>
#include <ConfigurationManagerObject.h>
#include <Library/HwInfoParserLib.h>
#include "FdtUtility.h"
/** A structure describing the instance of the FdtHwInfoParser.
*/
typedef struct FdtHwInfoParser {
/// Pointer to the HwDataSource i.e. the
/// Flattened Device Tree (Fdt).
VOID *Fdt;
/// Pointer to the caller's context.
VOID *Context;
/// Function pointer called by the
/// parser when adding information.
HW_INFO_ADD_OBJECT HwInfoAdd;
} FDT_HW_INFO_PARSER;
/** A pointer type for FDT_HW_INFO_PARSER.
*/
typedef FDT_HW_INFO_PARSER *FDT_HW_INFO_PARSER_HANDLE;
/** Function pointer to a parser function.
A parser parses a Device Tree to populate a specific CmObj type. None,
one or many CmObj can be created by the parser.
The created CmObj are then handed to the parser's caller through the
HW_INFO_ADD_OBJECT interface.
This can also be a dispatcher. I.e. a function that not parsing a
Device Tree but calling other parsers.
@param [in] ParserHandle Handle to the parser instance.
@param [in] FdtBranch When searching for DT node name, restrict
the search to this Device Tree branch.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND Not found.
@retval EFI_UNSUPPORTED Unsupported.
**/
typedef
EFI_STATUS
(EFIAPI *FDT_HW_INFO_PARSER_FUNC)(
IN CONST FDT_HW_INFO_PARSER_HANDLE ParserHandle,
IN INT32 FdtBranch
);
#endif // FDT_HW_INFO_PARSER_H_
|
