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
Configuration manager Object Descriptor Utility.
Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef CM_OBJECT_DESC_UTILITY_H_
#define CM_OBJECT_DESC_UTILITY_H_
#include <ConfigurationManagerObject.h>
#include "FdtHwInfoParser.h"
/** Create a CM_OBJ_DESCRIPTOR.
@param [in] ObjectId CM_OBJECT_ID of the node.
@param [in] Count Number of CmObj stored in the
data field.
@param [in] Data Pointer to one or more CmObj objects.
The content of this Data buffer is copied.
@param [in] Size Size of the Data buffer.
@param [out] NewCmObjDesc The created CM_OBJ_DESCRIPTOR.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
**/
EFI_STATUS
EFIAPI
CreateCmObjDesc (
IN CM_OBJECT_ID ObjectId,
IN UINT32 Count,
IN VOID *Data,
IN UINT32 Size,
OUT CM_OBJ_DESCRIPTOR **NewCmObjDesc
);
/** Free resources allocated for the CM_OBJ_DESCRIPTOR.
@param [in] CmObjDesc Pointer to the CM_OBJ_DESCRIPTOR.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FreeCmObjDesc (
IN CM_OBJ_DESCRIPTOR *CmObjDesc
);
/** Add a single CmObj to the Configuration Manager.
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] ObjectId CmObj ObjectId.
@param [in] Data CmObj Data.
@param [in] Size CmObj Size.
@param [out] Token If provided and success,
token generated for this CmObj.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AddSingleCmObj (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN CM_OBJECT_ID ObjectId,
IN VOID *Data,
IN UINT32 Size,
OUT CM_OBJECT_TOKEN *Token OPTIONAL
);
/** Add a CmObj representing an array to the Configuration Manager.
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] ObjectId CmObj ObjectId.
@param [in] Data CmObj Data.
@param [in] Size Total size of array, in bytes.
@param [in] Count Count of objects in array.
@param [out] Token If provided and success,
token generated for this CmObj.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AddSingleCmObjArray (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN CM_OBJECT_ID ObjectId,
IN VOID *Data,
IN UINT32 Size,
IN UINT32 Count,
OUT CM_OBJECT_TOKEN *Token OPTIONAL
);
/** Add a single CmObj to the Configuration Manager.
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] ObjectId CmObj ObjectId.
@param [in] Data CmObj Data.
@param [in] Size CmObj Size.
@param [out] Token If provided and success,
token generated for this CmObj.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AddSingleCmObjWithToken (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN CM_OBJECT_ID ObjectId,
IN VOID *Data,
IN UINT32 Size,
IN CONST CM_OBJECT_TOKEN Token
);
/** Add multiple CmObj to the Configuration Manager.
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] CmObjDesc CmObjDesc containing multiple CmObj
to add.
@param [in] TokenCount If provided, count of entries in the
TokenTable.
@param [out] TokenTable If provided and success,
token generated for these CmObj.
Address of an array of CM_OBJECT_TOKEN
with the same number of elements as the
CmObjDesc.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AddMultipleCmObj (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN CONST CM_OBJ_DESCRIPTOR *CmObjDesc,
IN UINT32 TokenCount, OPTIONAL
OUT CM_OBJECT_TOKEN *TokenTable OPTIONAL
);
/** Add multiple CmObj to the Configuration Manager.
Get one token referencing a EArchCommonObjCmRef CmObj itself referencing
the input CmObj. In the table below, RefToken is returned.
Token referencing an Array of tokens Array of CmObj
array of EArchCommonObjCmRef referencing each from the input:
CmObj: CmObj from the input:
RefToken ---> CmObjToken[0] ---> CmObj[0]
CmObjToken[1] ---> CmObj[1]
CmObjToken[2] ---> CmObj[2]
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] CmObjDesc CmObjDesc containing multiple CmObj
to add.
@param [out] Token If success, token referencing an array
of EArchCommonObjCmRef CmObj, themselves
referencing the input CmObjs.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
**/
EFI_STATUS
EFIAPI
AddMultipleCmObjWithCmObjRef (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN CM_OBJ_DESCRIPTOR *CmObjDesc,
OUT CM_OBJECT_TOKEN *Token
);
#endif // CM_OBJECT_DESC_UTILITY_H_
|
