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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/** @file
Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Glossary:
- Cm or CM - Configuration Manager
- Obj or OBJ - Object
- Std or STD - Standard
**/
#ifndef DEVICETREE_TABLE_GENERATOR_H_
#define DEVICETREE_TABLE_GENERATOR_H_
#include <TableGenerator.h>
#pragma pack(1)
/** The DT_TABLE_GENERATOR_ID type describes Device Tree table generator ID.
*/
typedef TABLE_GENERATOR_ID DT_TABLE_GENERATOR_ID;
/** The ESTD_DT_TABLE_ID enum describes the DT table IDs reserved for
the standard generators.
*/
typedef enum StdDtTableId {
EStdDtTableIdReserved = 0x0000, ///< Reserved.
EStdDtTableIdRaw, ///< RAW Generator.
EStdDtTableIdMax
} ESTD_DT_TABLE_ID;
/** This macro checks if the Table Generator ID is for an DT Table Generator.
@param [in] TableGeneratorId The table generator ID.
@return TRUE if the table generator ID is for an DT Table
Generator.
**/
#define IS_GENERATOR_TYPE_DT(TableGeneratorId) \
(GET_TABLE_TYPE(TableGeneratorId) == ETableGeneratorTypeDt)
/** This macro checks if the Table Generator ID is for a standard DT
Table Generator.
@param [in] TableGeneratorId The table generator ID.
@return TRUE if the table generator ID is for a standard DT
Table Generator.
**/
#define IS_VALID_STD_DT_GENERATOR_ID(TableGeneratorId) \
( \
IS_GENERATOR_NAMESPACE_STD(TableGeneratorId) && \
IS_GENERATOR_TYPE_DT(TableGeneratorId) && \
((GET_TABLE_ID(GeneratorId) >= EStdDtTableIdRaw) && \
(GET_TABLE_ID(GeneratorId) < EStdDtTableIdMax)) \
)
/** This macro creates a standard DT Table Generator ID.
@param [in] TableId The table generator ID.
@return a standard DT table generator ID.
**/
#define CREATE_STD_DT_TABLE_GEN_ID(TableId) \
CREATE_TABLE_GEN_ID ( \
ETableGeneratorTypeDt, \
ETableGeneratorNameSpaceStd, \
TableId \
)
/** Forward declarations.
*/
typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;
typedef struct CmAStdObjDtTableInfo CM_STD_OBJ_DT_TABLE_INFO;
typedef struct DtTableGenerator DT_TABLE_GENERATOR;
/** This function pointer describes the interface to DT table build
functions provided by the DT table generator and called by the
Table Manager to build an DT table.
@param [in] Generator Pointer to the DT table generator.
@param [in] DtTableInfo Pointer to the DT table information.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol interface.
@param [out] Table Pointer to the generated DT table.
@return EFI_SUCCESS If the table is generated successfully or other
failure codes as returned by the generator.
**/
typedef EFI_STATUS (*DT_TABLE_GENERATOR_BUILD_TABLE) (
IN CONST DT_TABLE_GENERATOR *Generator,
IN CONST CM_STD_OBJ_DT_TABLE_INFO *CONST DtTableInfo,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
OUT VOID **Table
);
/** This function pointer describes the interface to used by the
Table Manager to give the generator an opportunity to free
any resources allocated for building the DT table.
@param [in] Generator Pointer to the DT table generator.
@param [in] DtTableInfo Pointer to the DT table information.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol interface.
@param [in] Table Pointer to the generated DT table.
@return EFI_SUCCESS If freed successfully or other failure codes
as returned by the generator.
**/
typedef EFI_STATUS (*DT_TABLE_GENERATOR_FREE_TABLE) (
IN CONST DT_TABLE_GENERATOR *Generator,
IN CONST CM_STD_OBJ_DT_TABLE_INFO *CONST DtTableInfo,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
IN VOID **Table
);
/** The DT_TABLE_GENERATOR structure provides an interface that the
Table Manager can use to invoke the functions to build DT tables.
*/
typedef struct DtTableGenerator {
/// The DT table generator ID.
DT_TABLE_GENERATOR_ID GeneratorID;
/// String describing the DT table generator.
CONST CHAR16 *Description;
/// DT table build function pointer.
DT_TABLE_GENERATOR_BUILD_TABLE BuildDtTable;
/// The function to free any resources allocated for building the DT table.
DT_TABLE_GENERATOR_FREE_TABLE FreeTableResources;
} DT_TABLE_GENERATOR;
/** Register DT table factory generator.
The DT table factory maintains a list of the Standard and OEM DT
table generators.
@param [in] Generator Pointer to the DT table generator.
@retval EFI_SUCCESS The Generator was registered
successfully.
@retval EFI_INVALID_PARAMETER The Generator ID is invalid or
the Generator pointer is NULL.
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
already registered.
**/
EFI_STATUS
EFIAPI
RegisterDtTableGenerator (
IN CONST DT_TABLE_GENERATOR *CONST Generator
);
/** Deregister DT generator.
This function is called by the DT table generator to deregister itself
from the DT table factory.
@param [in] Generator Pointer to the DT table generator.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER The generator is invalid.
@retval EFI_NOT_FOUND The requested generator is not found
in the list of registered generators.
**/
EFI_STATUS
EFIAPI
DeregisterDtTableGenerator (
IN CONST DT_TABLE_GENERATOR *CONST Generator
);
#pragma pack()
#endif // DEVICETREE_TABLE_GENERATOR_H_
|
