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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
|
/** @file
ACPI Sdt Protocol Driver
Copyright (c) 2010, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "AcpiTable.h"
/**
Retrieve option term according to AmlByteEncoding and Buffer.
@param[in] AmlByteEncoding AML Byte Encoding.
@param[in] Buffer AML buffer.
@param[in] MaxBufferSize AML buffer MAX size. The parser can not parse any data exceed this region.
@param[in] TermIndex Index of the data to retrieve from the object.
@param[out] DataType Points to the returned data type or EFI_ACPI_DATA_TYPE_NONE if no data exists
for the specified index.
@param[out] Data Upon return, points to the pointer to the data.
@param[out] DataSize Upon return, points to the size of Data.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Buffer does not refer to a valid ACPI object.
**/
EFI_STATUS
AmlParseOptionTerm (
IN AML_BYTE_ENCODING *AmlByteEncoding,
IN UINT8 *Buffer,
IN UINTN MaxBufferSize,
IN AML_OP_PARSE_INDEX TermIndex,
OUT EFI_ACPI_DATA_TYPE *DataType,
OUT VOID **Data,
OUT UINTN *DataSize
)
{
AML_BYTE_ENCODING *ChildAmlByteEncoding;
EFI_STATUS Status;
if (DataType != NULL) {
*DataType = AmlTypeToAcpiType (AmlByteEncoding->Format[TermIndex - 1]);
}
if (Data != NULL) {
*Data = Buffer;
}
//
// Parse term according to AML type
//
switch (AmlByteEncoding->Format[TermIndex - 1]) {
case AML_UINT8:
*DataSize = sizeof(UINT8);
break;
case AML_UINT16:
*DataSize = sizeof(UINT16);
break;
case AML_UINT32:
*DataSize = sizeof(UINT32);
break;
case AML_UINT64:
*DataSize = sizeof(UINT64);
break;
case AML_STRING:
*DataSize = AsciiStrSize((CHAR8 *)Buffer);
break;
case AML_NAME:
Status = AmlGetNameStringSize (Buffer, DataSize);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
break;
case AML_OBJECT:
ChildAmlByteEncoding = AmlSearchByOpByte (Buffer);
if (ChildAmlByteEncoding == NULL) {
return EFI_INVALID_PARAMETER;
}
//
// NOTE: We need override DataType here, if there is a case the AML_OBJECT is AML_NAME.
// We need convert type from EFI_ACPI_DATA_TYPE_CHILD to EFI_ACPI_DATA_TYPE_NAME_STRING.
// We should not return CHILD because there is NO OpCode for NameString.
//
if ((ChildAmlByteEncoding->Attribute & AML_IS_NAME_CHAR) != 0) {
if (DataType != NULL) {
*DataType = AmlTypeToAcpiType (AML_NAME);
}
Status = AmlGetNameStringSize (Buffer, DataSize);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
break;
}
//
// It is real AML_OBJECT
//
*DataSize = AmlGetObjectSize (
ChildAmlByteEncoding,
Buffer,
MaxBufferSize
);
if (*DataSize == 0) {
return EFI_INVALID_PARAMETER;
}
break;
case AML_NONE:
//
// No term
//
case AML_OPCODE:
default:
ASSERT (FALSE);
return EFI_INVALID_PARAMETER;
}
if (*DataSize > MaxBufferSize) {
return EFI_INVALID_PARAMETER;
}
return EFI_SUCCESS;
}
/**
Retrieve information according to AmlByteEncoding and Buffer.
@param[in] AmlByteEncoding AML Byte Encoding.
@param[in] Buffer AML buffer.
@param[in] MaxBufferSize AML buffer MAX size. The parser can not parse any data exceed this region.
@param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right
in the ACPI encoding, with index 0 always being the ACPI opcode.
@param[out] DataType Points to the returned data type or EFI_ACPI_DATA_TYPE_NONE if no data exists
for the specified index.
@param[out] Data Upon return, points to the pointer to the data.
@param[out] DataSize Upon return, points to the size of Data.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Buffer does not refer to a valid ACPI object.
**/
EFI_STATUS
AmlParseOptionCommon (
IN AML_BYTE_ENCODING *AmlByteEncoding,
IN UINT8 *Buffer,
IN UINTN MaxBufferSize,
IN AML_OP_PARSE_INDEX Index,
OUT EFI_ACPI_DATA_TYPE *DataType,
OUT VOID **Data,
OUT UINTN *DataSize
)
{
UINT8 *CurrentBuffer;
UINTN PkgLength;
UINTN OpLength;
UINTN PkgOffset;
AML_OP_PARSE_INDEX TermIndex;
EFI_STATUS Status;
ASSERT ((Index <= AmlByteEncoding->MaxIndex) || (Index == AML_OP_PARSE_INDEX_GET_SIZE));
//
// 0. Check if this is NAME string.
//
if ((AmlByteEncoding->Attribute & AML_IS_NAME_CHAR) != 0) {
//
// Only allow GET_SIZE
//
if (Index != AML_OP_PARSE_INDEX_GET_SIZE) {
return EFI_INVALID_PARAMETER;
}
//
// return NameString size
//
Status = AmlGetNameStringSize (Buffer, DataSize);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
if (*DataSize > MaxBufferSize) {
return EFI_INVALID_PARAMETER;
}
return EFI_SUCCESS;
}
//
// Not NAME string, start parsing
//
CurrentBuffer = Buffer;
//
// 1. Get OpCode
//
if (Index != AML_OP_PARSE_INDEX_GET_SIZE) {
*DataType = EFI_ACPI_DATA_TYPE_OPCODE;
*Data = (VOID *)CurrentBuffer;
}
if (*CurrentBuffer == AML_EXT_OP) {
OpLength = 2;
} else {
OpLength = 1;
}
*DataSize = OpLength;
if (Index == AML_OP_PARSE_INDEX_GET_OPCODE) {
return EFI_SUCCESS;
}
if (OpLength > MaxBufferSize) {
return EFI_INVALID_PARAMETER;
}
CurrentBuffer += OpLength;
//
// 2. Skip PkgLength field, if have
//
if ((AmlByteEncoding->Attribute & AML_HAS_PKG_LENGTH) != 0) {
PkgOffset = AmlGetPkgLength(CurrentBuffer, &PkgLength);
//
// Override MaxBufferSize if it is valid PkgLength
//
if (OpLength + PkgLength > MaxBufferSize) {
return EFI_INVALID_PARAMETER;
} else {
MaxBufferSize = OpLength + PkgLength;
}
} else {
PkgOffset = 0;
PkgLength = 0;
}
CurrentBuffer += PkgOffset;
//
// 3. Get Term one by one.
//
TermIndex = AML_OP_PARSE_INDEX_GET_TERM1;
while ((Index >= TermIndex) && (TermIndex <= AmlByteEncoding->MaxIndex) && ((UINTN)CurrentBuffer < (UINTN)Buffer + MaxBufferSize)) {
Status = AmlParseOptionTerm (
AmlByteEncoding,
CurrentBuffer,
(UINTN)Buffer + MaxBufferSize - (UINTN)CurrentBuffer,
TermIndex,
DataType,
Data,
DataSize
);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
if (Index == TermIndex) {
//
// Done
//
return EFI_SUCCESS;
}
//
// Parse next one
//
CurrentBuffer += *DataSize;
TermIndex ++;
}
//
// Finish all options, but no option found.
//
if ((UINTN)CurrentBuffer > (UINTN)Buffer + MaxBufferSize) {
return EFI_INVALID_PARAMETER;
}
if ((UINTN)CurrentBuffer == (UINTN)Buffer + MaxBufferSize) {
if (Index != AML_OP_PARSE_INDEX_GET_SIZE) {
return EFI_INVALID_PARAMETER;
}
}
//
// 4. Finish parsing all node, return size
//
ASSERT (Index == AML_OP_PARSE_INDEX_GET_SIZE);
if ((AmlByteEncoding->Attribute & AML_HAS_PKG_LENGTH) != 0) {
*DataSize = OpLength + PkgLength;
} else {
*DataSize = (UINTN)CurrentBuffer - (UINTN)Buffer;
}
return EFI_SUCCESS;
}
/**
Return object size.
@param[in] AmlByteEncoding AML Byte Encoding.
@param[in] Buffer AML object buffer.
@param[in] MaxBufferSize AML object buffer MAX size. The parser can not parse any data exceed this region.
@return Size of the object.
**/
UINTN
AmlGetObjectSize (
IN AML_BYTE_ENCODING *AmlByteEncoding,
IN UINT8 *Buffer,
IN UINTN MaxBufferSize
)
{
EFI_STATUS Status;
UINTN DataSize;
Status = AmlParseOptionCommon (
AmlByteEncoding,
Buffer,
MaxBufferSize,
AML_OP_PARSE_INDEX_GET_SIZE,
NULL,
NULL,
&DataSize
);
if (EFI_ERROR (Status)) {
return 0;
} else {
return DataSize;
}
}
/**
Return object name.
@param[in] AmlHandle AML handle.
@return Name of the object.
**/
CHAR8 *
AmlGetObjectName (
IN EFI_AML_HANDLE *AmlHandle
)
{
AML_BYTE_ENCODING *AmlByteEncoding;
VOID *NameString;
UINTN NameSize;
AML_OP_PARSE_INDEX TermIndex;
EFI_STATUS Status;
EFI_ACPI_DATA_TYPE DataType;
AmlByteEncoding = AmlHandle->AmlByteEncoding;
ASSERT ((AmlByteEncoding->Attribute & AML_IN_NAMESPACE) != 0);
//
// Find out Last Name index, according to OpCode table.
// The last name will be the node name by design.
//
TermIndex = AmlByteEncoding->MaxIndex;
for (TermIndex = AmlByteEncoding->MaxIndex; TermIndex > 0; TermIndex--) {
if (AmlByteEncoding->Format[TermIndex - 1] == AML_NAME) {
break;
}
}
ASSERT (TermIndex != 0);
//
// Get Name for this node.
//
Status = AmlParseOptionHandleCommon (
AmlHandle,
TermIndex,
&DataType,
&NameString,
&NameSize
);
if (EFI_ERROR (Status)) {
return NULL;
}
ASSERT (DataType == EFI_ACPI_DATA_TYPE_NAME_STRING);
return NameString;
}
/**
Return offset of last option.
@param[in] AmlHandle AML Handle.
@param[out] Buffer Upon return, points to the offset after last option.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER AmlHandle does not refer to a valid ACPI object.
**/
EFI_STATUS
AmlGetOffsetAfterLastOption (
IN EFI_AML_HANDLE *AmlHandle,
OUT UINT8 **Buffer
)
{
EFI_ACPI_DATA_TYPE DataType;
VOID *Data;
UINTN DataSize;
EFI_STATUS Status;
Status = AmlParseOptionHandleCommon (
AmlHandle,
AmlHandle->AmlByteEncoding->MaxIndex,
&DataType,
&Data,
&DataSize
);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
//
// We need to parse the rest buffer after last node.
//
*Buffer = (UINT8 *)((UINTN)Data + DataSize);
//
// We need skip PkgLength if no Option
//
if (DataType == EFI_ACPI_DATA_TYPE_OPCODE) {
*Buffer += AmlGetPkgLength (*Buffer, &DataSize);
}
return EFI_SUCCESS;
}
/**
Retrieve information according to AmlHandle
@param[in] AmlHandle AML handle.
@param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right
in the ACPI encoding, with index 0 always being the ACPI opcode.
@param[out] DataType Points to the returned data type or EFI_ACPI_DATA_TYPE_NONE if no data exists
for the specified index.
@param[out] Data Upon return, points to the pointer to the data.
@param[out] DataSize Upon return, points to the size of Data.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER AmlHandle does not refer to a valid ACPI object.
**/
EFI_STATUS
AmlParseOptionHandleCommon (
IN EFI_AML_HANDLE *AmlHandle,
IN AML_OP_PARSE_INDEX Index,
OUT EFI_ACPI_DATA_TYPE *DataType,
OUT VOID **Data,
OUT UINTN *DataSize
)
{
return AmlParseOptionCommon (
AmlHandle->AmlByteEncoding,
AmlHandle->Buffer,
AmlHandle->Size,
Index,
DataType,
Data,
DataSize
);
}
|