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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/** @file
Token Mapper
Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Glossary:
- Cm or CM - Configuration Manager
- Obj or OBJ - Object
**/
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Protocol/ConfigurationManagerProtocol.h>
#include "TokenMapper.h"
/** Add a CmObjDesc to the TokenMapper.
@param [in] TokenMapper The TokenMapper instance.
@param [in] Token CmObj token.
@param [in] ObjectId CmObj ObjectId.
@param [in] Size CmObj Size.
@param [in] Data CmObj Data.
This memory is referenced, not copied.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_BUFFER_TOO_SMALL Buffer too small.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
**/
EFI_STATUS
EFIAPI
TokenMapperAddObject (
IN TOKEN_MAPPER *TokenMapper,
IN CM_OBJECT_TOKEN Token,
IN CM_OBJECT_ID ObjectId,
IN UINT32 Size,
IN VOID *Data
)
{
TOKEN_MAP_DESCRIPTOR *TokenMapDesc;
CM_OBJ_DESCRIPTOR *CmObjDesc;
if ((TokenMapper == NULL) ||
(TokenMapper->TokenDescArray == NULL) ||
(Size == 0) ||
(Data == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
if (TokenMapper->ItemCount >= TokenMapper->MaxTokenDescCount) {
ASSERT (0);
return EFI_BUFFER_TOO_SMALL;
}
TokenMapDesc = &TokenMapper->TokenDescArray[TokenMapper->ItemCount++];
TokenMapDesc->Token = Token;
CmObjDesc = &TokenMapDesc->CmObjDesc;
CmObjDesc->ObjectId = ObjectId;
CmObjDesc->Size = Size;
// Point inside the finalized array.
CmObjDesc->Data = Data;
// Only EArchCommonObjCmRef CmObj can be added as
// arrays (more than 1 elements).
if ((GET_CM_NAMESPACE_ID (ObjectId) == EObjNameSpaceArchCommon) &&
(GET_CM_OBJECT_ID (ObjectId) == EArchCommonObjCmRef))
{
CmObjDesc->Count = Size / sizeof (CM_ARCH_COMMON_OBJ_REF);
} else {
CmObjDesc->Count = 1;
}
return EFI_SUCCESS;
}
/** Get a CmObjDesc from a ObjectId/Token couple.
The Token parameter is not optional. An existing token must be provided.
@param [in] TokenMapper The TokenMapper instance.
@param [in] Token Token of the CmObj to search.
@param [in] ObjectId Object Id of the CmObj to search.
@param [out] CmObjDesc CM_OBJ_DESCRIPTOR containing the CmObj searched.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND Not found.
**/
EFI_STATUS
EFIAPI
TokenMapperGetObject (
IN TOKEN_MAPPER *TokenMapper,
IN CM_OBJECT_TOKEN Token,
IN CM_OBJECT_ID ObjectId,
OUT CM_OBJ_DESCRIPTOR *CmObjDesc
)
{
UINTN Index;
UINTN MaxCount;
TOKEN_MAP_DESCRIPTOR *TokenMapDesc;
// Nothing to do.
if ((TokenMapper != NULL) && (TokenMapper->MaxTokenDescCount == 0)) {
goto exit_handler;
}
if ((Token == CM_NULL_TOKEN) ||
(CmObjDesc == NULL) ||
(TokenMapper == NULL) ||
(TokenMapper->TokenDescArray == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
TokenMapDesc = TokenMapper->TokenDescArray;
MaxCount = TokenMapper->MaxTokenDescCount;
for (Index = 0; Index < MaxCount; Index++) {
if ((TokenMapDesc->CmObjDesc.ObjectId == ObjectId) &&
(TokenMapDesc->Token == Token))
{
CopyMem (
CmObjDesc,
&TokenMapDesc->CmObjDesc,
sizeof (CM_OBJ_DESCRIPTOR)
);
return EFI_SUCCESS;
}
TokenMapDesc++;
} // for
exit_handler:
DEBUG ((
DEBUG_INFO,
"INFO: Requested CmObj of type 0x%x with token 0x%x"
" not found in the dynamic repository\n.",
ObjectId,
Token
));
return EFI_NOT_FOUND;
}
/** Initialise a TokenMapper.
@param [in] TokenMapper The TokenMapper to initialise.
@param [in] DescriptorCount Number of entries to allocate.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ALREADY_STARTED Instance already initialised.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
**/
EFI_STATUS
EFIAPI
TokenMapperInitialise (
IN TOKEN_MAPPER *TokenMapper,
IN UINTN DescriptorCount
)
{
if (TokenMapper == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Nothing to do.
if (DescriptorCount == 0) {
return EFI_SUCCESS;
}
if (TokenMapper->TokenDescArray != NULL) {
DEBUG ((DEBUG_ERROR, "ERROR: Token mapper already initialised\n."));
ASSERT (0);
return EFI_ALREADY_STARTED;
}
TokenMapper->TokenDescArray =
AllocateZeroPool (sizeof (TOKEN_MAP_DESCRIPTOR) * DescriptorCount);
if (TokenMapper->TokenDescArray == NULL) {
ASSERT (0);
return EFI_OUT_OF_RESOURCES;
}
TokenMapper->MaxTokenDescCount = DescriptorCount;
TokenMapper->ItemCount = 0;
return EFI_SUCCESS;
}
/** Shutdown a TokenMapper.
@param [in] TokenMapper The TokenMapper to shutdown.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
**/
EFI_STATUS
EFIAPI
TokenMapperShutdown (
IN TOKEN_MAPPER *TokenMapper
)
{
// Nothing to do.
if ((TokenMapper != NULL) && (TokenMapper->MaxTokenDescCount == 0)) {
return EFI_SUCCESS;
}
if ((TokenMapper == NULL) ||
(TokenMapper->TokenDescArray == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
FreePool (TokenMapper->TokenDescArray);
TokenMapper->TokenDescArray = NULL;
TokenMapper->MaxTokenDescCount = 0;
return EFI_SUCCESS;
}
|
