]>
Commit | Line | Data |
---|---|---|
3dc8585e JY |
1 | /** @file\r |
2 | ACPI Sdt Protocol Driver\r | |
3 | \r | |
f0071740 | 4 | Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved. <BR>\r |
3dc8585e JY |
5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _ACPI_SDT_H_\r | |
16 | #define _ACPI_SDT_H_\r | |
17 | \r | |
3dc8585e JY |
18 | //\r |
19 | // Privacy data structure\r | |
20 | //\r | |
21 | \r | |
22 | //\r | |
23 | // ACPI Notify Linked List Signature.\r | |
24 | //\r | |
25 | #define EFI_ACPI_NOTIFY_LIST_SIGNATURE SIGNATURE_32 ('E', 'A', 'N', 'L')\r | |
26 | \r | |
27 | //\r | |
28 | // ACPI Notify List Entry definition.\r | |
29 | //\r | |
30 | // Signature must be set to EFI_ACPI_NOTIFY_LIST_SIGNATURE\r | |
31 | // Link is the linked list data.\r | |
32 | // Notification is the callback function.\r | |
33 | //\r | |
34 | typedef struct {\r | |
35 | UINT32 Signature;\r | |
36 | LIST_ENTRY Link;\r | |
37 | EFI_ACPI_NOTIFICATION_FN Notification;\r | |
38 | } EFI_ACPI_NOTIFY_LIST;\r | |
39 | \r | |
40 | //\r | |
41 | // Containment record for ACPI Notify linked list.\r | |
42 | //\r | |
43 | #define EFI_ACPI_NOTIFY_LIST_FROM_LINK(_link) CR (_link, EFI_ACPI_NOTIFY_LIST, Link, EFI_ACPI_NOTIFY_LIST_SIGNATURE)\r | |
44 | \r | |
45 | typedef struct _AML_BYTE_ENCODING AML_BYTE_ENCODING;\r | |
46 | typedef struct _EFI_AML_NODE_LIST EFI_AML_NODE_LIST;\r | |
47 | \r | |
48 | //\r | |
49 | // AML Node Linked List Signature.\r | |
50 | //\r | |
51 | #define EFI_AML_NODE_LIST_SIGNATURE SIGNATURE_32 ('E', 'A', 'M', 'L')\r | |
52 | \r | |
53 | //\r | |
54 | // AML Node Linked List Entry definition.\r | |
55 | //\r | |
56 | // Signature must be set to EFI_AML_NODE_LIST_SIGNATURE\r | |
57 | // Link is the linked list data.\r | |
58 | // Name is the ACPI node name.\r | |
59 | // This is listed for PATH finding.\r | |
60 | // Buffer is the ACPI node buffer pointer, the first/second bytes are opcode.\r | |
61 | // This buffer should not be freed.\r | |
62 | // Size is the total size of this ACPI node buffer.\r | |
63 | // Children is the children linked list of this node.\r | |
64 | //\r | |
65 | #define AML_NAME_SEG_SIZE 4\r | |
66 | \r | |
67 | struct _EFI_AML_NODE_LIST {\r | |
68 | UINT32 Signature;\r | |
69 | UINT8 Name[AML_NAME_SEG_SIZE];\r | |
70 | UINT8 *Buffer;\r | |
71 | UINTN Size;\r | |
72 | LIST_ENTRY Link;\r | |
73 | LIST_ENTRY Children;\r | |
74 | EFI_AML_NODE_LIST *Parent;\r | |
75 | AML_BYTE_ENCODING *AmlByteEncoding;\r | |
76 | };\r | |
77 | \r | |
78 | //\r | |
79 | // Containment record for AML Node linked list.\r | |
80 | //\r | |
81 | #define EFI_AML_NODE_LIST_FROM_LINK(_link) CR (_link, EFI_AML_NODE_LIST, Link, EFI_AML_NODE_LIST_SIGNATURE)\r | |
82 | \r | |
83 | //\r | |
84 | // AML Handle Signature.\r | |
85 | //\r | |
86 | #define EFI_AML_HANDLE_SIGNATURE SIGNATURE_32 ('E', 'A', 'H', 'S')\r | |
87 | #define EFI_AML_ROOT_HANDLE_SIGNATURE SIGNATURE_32 ('E', 'A', 'R', 'H')\r | |
88 | \r | |
89 | //\r | |
90 | // AML Handle Entry definition.\r | |
91 | //\r | |
92 | // Signature must be set to EFI_AML_HANDLE_SIGNATURE or EFI_AML_ROOT_HANDLE_SIGNATURE\r | |
93 | // Buffer is the ACPI node buffer pointer, the first/second bytes are opcode.\r | |
94 | // This buffer should not be freed.\r | |
95 | // Size is the total size of this ACPI node buffer.\r | |
96 | //\r | |
97 | typedef struct {\r | |
98 | UINT32 Signature;\r | |
99 | UINT8 *Buffer;\r | |
100 | UINTN Size;\r | |
101 | AML_BYTE_ENCODING *AmlByteEncoding;\r | |
102 | BOOLEAN Modified;\r | |
103 | } EFI_AML_HANDLE;\r | |
104 | \r | |
105 | typedef UINT32 AML_OP_PARSE_INDEX;\r | |
106 | \r | |
107 | #define AML_OP_PARSE_INDEX_GET_OPCODE 0\r | |
108 | #define AML_OP_PARSE_INDEX_GET_TERM1 1\r | |
109 | #define AML_OP_PARSE_INDEX_GET_TERM2 2\r | |
110 | #define AML_OP_PARSE_INDEX_GET_TERM3 3\r | |
111 | #define AML_OP_PARSE_INDEX_GET_TERM4 4\r | |
112 | #define AML_OP_PARSE_INDEX_GET_TERM5 5\r | |
113 | #define AML_OP_PARSE_INDEX_GET_TERM6 6\r | |
114 | #define AML_OP_PARSE_INDEX_GET_SIZE (AML_OP_PARSE_INDEX)-1\r | |
115 | \r | |
116 | typedef UINT32 AML_OP_PARSE_FORMAT;\r | |
117 | #define AML_NONE 0\r | |
118 | #define AML_OPCODE 1\r | |
119 | #define AML_UINT8 2\r | |
120 | #define AML_UINT16 3\r | |
121 | #define AML_UINT32 4\r | |
122 | #define AML_UINT64 5\r | |
123 | #define AML_NAME 6\r | |
124 | #define AML_STRING 7\r | |
125 | #define AML_OBJECT 8\r | |
126 | \r | |
127 | typedef UINT32 AML_OP_ATTRIBUTE;\r | |
128 | #define AML_HAS_PKG_LENGTH 0x1 // It is ACPI attribute - if OpCode has PkgLength\r | |
129 | #define AML_IS_NAME_CHAR 0x2 // It is ACPI attribute - if this is NameChar\r | |
130 | #define AML_HAS_CHILD_OBJ 0x4 // it is ACPI attribute - if OpCode has Child Object.\r | |
131 | #define AML_IN_NAMESPACE 0x10000 // It is UEFI SDT attribute - if OpCode will be in NameSpace\r | |
132 | // NOTE; Not all OBJECT will be in NameSpace\r | |
133 | // For example, BankField | CreateBitField | CreateByteField | CreateDWordField | \r | |
134 | // CreateField | CreateQWordField | CreateWordField | Field | IndexField.\r | |
135 | \r | |
136 | struct _AML_BYTE_ENCODING {\r | |
137 | UINT8 OpCode;\r | |
138 | UINT8 SubOpCode;\r | |
139 | AML_OP_PARSE_INDEX MaxIndex;\r | |
140 | AML_OP_PARSE_FORMAT Format[6];\r | |
141 | AML_OP_ATTRIBUTE Attribute;\r | |
142 | };\r | |
143 | \r | |
144 | //\r | |
145 | // AcpiSdt protocol declaration\r | |
146 | //\r | |
147 | \r | |
148 | /**\r | |
149 | Returns a requested ACPI table.\r | |
150 | \r | |
151 | The GetAcpiTable() function returns a pointer to a buffer containing the ACPI table associated\r | |
152 | with the Index that was input. The following structures are not considered elements in the list of\r | |
153 | ACPI tables:\r | |
154 | - Root System Description Pointer (RSD_PTR)\r | |
155 | - Root System Description Table (RSDT)\r | |
156 | - Extended System Description Table (XSDT)\r | |
157 | Version is updated with a bit map containing all the versions of ACPI of which the table is a\r | |
f0071740 SZ |
158 | member. For tables installed via the EFI_ACPI_TABLE_PROTOCOL.InstallAcpiTable() interface,\r |
159 | the function returns the value of EFI_ACPI_STD_PROTOCOL.AcpiVersion.\r | |
3dc8585e JY |
160 | \r |
161 | @param[in] Index The zero-based index of the table to retrieve.\r | |
162 | @param[out] Table Pointer for returning the table buffer.\r | |
163 | @param[out] Version On return, updated with the ACPI versions to which this table belongs. Type\r | |
164 | EFI_ACPI_TABLE_VERSION is defined in "Related Definitions" in the\r | |
165 | EFI_ACPI_SDT_PROTOCOL. \r | |
f0071740 SZ |
166 | @param[out] TableKey On return, points to the table key for the specified ACPI system definition table.\r |
167 | This is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL.\r | |
168 | The TableKey can be passed to EFI_ACPI_TABLE_PROTOCOL.UninstallAcpiTable()\r | |
169 | to uninstall the table.\r | |
3dc8585e JY |
170 | \r |
171 | @retval EFI_SUCCESS The function completed successfully.\r | |
172 | @retval EFI_NOT_FOUND The requested index is too large and a table was not found. \r | |
173 | **/ \r | |
174 | EFI_STATUS\r | |
175 | EFIAPI\r | |
176 | GetAcpiTable2 (\r | |
177 | IN UINTN Index,\r | |
178 | OUT EFI_ACPI_SDT_HEADER **Table,\r | |
179 | OUT EFI_ACPI_TABLE_VERSION *Version,\r | |
180 | OUT UINTN *TableKey\r | |
181 | );\r | |
182 | \r | |
183 | /**\r | |
184 | Register or unregister a callback when an ACPI table is installed.\r | |
185 | \r | |
186 | This function registers or unregisters a function which will be called whenever a new ACPI table is\r | |
187 | installed.\r | |
188 | \r | |
189 | @param[in] Register If TRUE, then the specified function will be registered. If FALSE, then the specified\r | |
190 | function will be unregistered.\r | |
191 | @param[in] Notification Points to the callback function to be registered or unregistered.\r | |
192 | \r | |
193 | @retval EFI_SUCCESS Callback successfully registered or unregistered.\r | |
194 | @retval EFI_INVALID_PARAMETER Notification is NULL\r | |
195 | @retval EFI_INVALID_PARAMETER Register is FALSE and Notification does not match a known registration function. \r | |
196 | **/\r | |
197 | EFI_STATUS\r | |
198 | EFIAPI\r | |
199 | RegisterNotify (\r | |
200 | IN BOOLEAN Register,\r | |
201 | IN EFI_ACPI_NOTIFICATION_FN Notification\r | |
202 | );\r | |
203 | \r | |
204 | /**\r | |
205 | Create a handle for the first ACPI opcode in an ACPI system description table.\r | |
206 | \r | |
207 | @param[in] TableKey The table key for the ACPI table, as returned by GetTable().\r | |
208 | @param[out] Handle On return, points to the newly created ACPI handle.\r | |
209 | \r | |
210 | @retval EFI_SUCCESS Handle created successfully.\r | |
211 | @retval EFI_NOT_FOUND TableKey does not refer to a valid ACPI table. \r | |
212 | **/\r | |
213 | EFI_STATUS\r | |
214 | EFIAPI\r | |
215 | OpenSdt (\r | |
216 | IN UINTN TableKey,\r | |
217 | OUT EFI_ACPI_HANDLE *Handle\r | |
218 | );\r | |
219 | \r | |
220 | /**\r | |
221 | Create a handle from an ACPI opcode\r | |
222 | \r | |
223 | @param[in] Buffer Points to the ACPI opcode.\r | |
224 | @param[out] Handle Upon return, holds the handle.\r | |
225 | \r | |
226 | @retval EFI_SUCCESS Success\r | |
227 | @retval EFI_INVALID_PARAMETER Buffer is NULL or Handle is NULL or Buffer points to an\r | |
228 | invalid opcode.\r | |
229 | \r | |
230 | **/\r | |
231 | EFI_STATUS\r | |
232 | EFIAPI\r | |
233 | Open (\r | |
234 | IN VOID *Buffer,\r | |
235 | OUT EFI_ACPI_HANDLE *Handle \r | |
236 | );\r | |
237 | \r | |
238 | /**\r | |
239 | Close an ACPI handle.\r | |
240 | \r | |
241 | @param[in] Handle Returns the handle.\r | |
242 | \r | |
243 | @retval EFI_SUCCESS Success\r | |
244 | @retval EFI_INVALID_PARAMETER Handle is NULL or does not refer to a valid ACPI object. \r | |
245 | **/\r | |
246 | EFI_STATUS\r | |
247 | EFIAPI\r | |
248 | Close (\r | |
249 | IN EFI_ACPI_HANDLE Handle\r | |
250 | );\r | |
251 | \r | |
252 | /**\r | |
253 | Retrieve information about an ACPI object.\r | |
254 | \r | |
255 | @param[in] Handle ACPI object handle.\r | |
256 | @param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right\r | |
257 | in the ACPI encoding, with index 0 always being the ACPI opcode.\r | |
258 | @param[out] DataType Points to the returned data type or EFI_ACPI_DATA_TYPE_NONE if no data exists\r | |
259 | for the specified index.\r | |
260 | @param[out] Data Upon return, points to the pointer to the data.\r | |
261 | @param[out] DataSize Upon return, points to the size of Data.\r | |
262 | \r | |
263 | @retval EFI_SUCCESS Success.\r | |
264 | @retval EFI_INVALID_PARAMETER Handle is NULL or does not refer to a valid ACPI object.\r | |
265 | **/\r | |
266 | EFI_STATUS\r | |
267 | EFIAPI\r | |
268 | GetOption (\r | |
269 | IN EFI_ACPI_HANDLE Handle,\r | |
270 | IN UINTN Index,\r | |
271 | OUT EFI_ACPI_DATA_TYPE *DataType,\r | |
272 | OUT CONST VOID **Data,\r | |
273 | OUT UINTN *DataSize\r | |
274 | );\r | |
275 | \r | |
276 | /**\r | |
277 | Change information about an ACPI object.\r | |
278 | \r | |
279 | @param[in] Handle ACPI object handle.\r | |
280 | @param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right\r | |
281 | in the ACPI encoding, with index 0 always being the ACPI opcode.\r | |
282 | @param[in] Data Points to the data.\r | |
283 | @param[in] DataSize The size of the Data.\r | |
284 | \r | |
285 | @retval EFI_SUCCESS Success\r | |
286 | @retval EFI_INVALID_PARAMETER Handle is NULL or does not refer to a valid ACPI object.\r | |
287 | @retval EFI_BAD_BUFFER_SIZE Data cannot be accommodated in the space occupied by\r | |
288 | the option.\r | |
289 | \r | |
290 | **/\r | |
291 | EFI_STATUS\r | |
292 | EFIAPI\r | |
293 | SetOption (\r | |
294 | IN EFI_ACPI_HANDLE Handle,\r | |
295 | IN UINTN Index,\r | |
296 | IN CONST VOID *Data,\r | |
297 | IN UINTN DataSize\r | |
298 | );\r | |
299 | \r | |
300 | /**\r | |
301 | Return the child ACPI objects.\r | |
302 | \r | |
303 | @param[in] ParentHandle Parent handle.\r | |
304 | @param[in, out] Handle On entry, points to the previously returned handle or NULL to start with the first\r | |
305 | handle. On return, points to the next returned ACPI handle or NULL if there are no\r | |
306 | child objects.\r | |
307 | \r | |
308 | @retval EFI_SUCCESS Success\r | |
309 | @retval EFI_INVALID_PARAMETER ParentHandle is NULL or does not refer to a valid ACPI object. \r | |
310 | **/\r | |
311 | EFI_STATUS\r | |
312 | EFIAPI\r | |
313 | GetChild (\r | |
314 | IN EFI_ACPI_HANDLE ParentHandle,\r | |
315 | IN OUT EFI_ACPI_HANDLE *Handle\r | |
316 | );\r | |
317 | \r | |
318 | /**\r | |
319 | Returns the handle of the ACPI object representing the specified ACPI path\r | |
320 | \r | |
321 | @param[in] HandleIn Points to the handle of the object representing the starting point for the path search.\r | |
322 | @param[in] AcpiPath Points to the ACPI path, which conforms to the ACPI encoded path format.\r | |
323 | @param[out] HandleOut On return, points to the ACPI object which represents AcpiPath, relative to\r | |
324 | HandleIn.\r | |
325 | \r | |
326 | @retval EFI_SUCCESS Success\r | |
327 | @retval EFI_INVALID_PARAMETER HandleIn is NULL or does not refer to a valid ACPI object. \r | |
328 | **/\r | |
329 | EFI_STATUS\r | |
330 | EFIAPI\r | |
331 | FindPath (\r | |
332 | IN EFI_ACPI_HANDLE HandleIn,\r | |
333 | IN VOID *AcpiPath,\r | |
334 | OUT EFI_ACPI_HANDLE *HandleOut\r | |
335 | );\r | |
336 | \r | |
337 | //\r | |
338 | // ACPI SDT function\r | |
339 | //\r | |
340 | \r | |
341 | /**\r | |
342 | Create a handle from an ACPI opcode\r | |
343 | \r | |
344 | @param[in] Buffer Points to the ACPI opcode.\r | |
345 | @param[in] BufferSize Max buffer size.\r | |
346 | @param[out] Handle Upon return, holds the handle.\r | |
347 | \r | |
348 | @retval EFI_SUCCESS Success\r | |
349 | @retval EFI_INVALID_PARAMETER Buffer is NULL or Handle is NULL or Buffer points to an\r | |
350 | invalid opcode.\r | |
351 | \r | |
352 | **/\r | |
353 | EFI_STATUS\r | |
354 | SdtOpenEx (\r | |
355 | IN VOID *Buffer,\r | |
356 | IN UINTN BufferSize,\r | |
357 | OUT EFI_ACPI_HANDLE *Handle \r | |
358 | );\r | |
359 | \r | |
360 | //\r | |
361 | // AML support function\r | |
362 | //\r | |
363 | \r | |
364 | /**\r | |
365 | Get AML NameString size.\r | |
366 | \r | |
367 | @param[in] Buffer AML NameString.\r | |
368 | @param[out] BufferSize AML NameString size \r | |
369 | \r | |
370 | @retval EFI_SUCCESS Success.\r | |
371 | @retval EFI_INVALID_PARAMETER Buffer does not refer to a valid AML NameString.\r | |
372 | **/\r | |
373 | EFI_STATUS\r | |
374 | AmlGetNameStringSize (\r | |
375 | IN UINT8 *Buffer,\r | |
376 | OUT UINTN *BufferSize\r | |
377 | );\r | |
378 | \r | |
379 | /**\r | |
380 | This function retuns package length from the buffer.\r | |
381 | \r | |
382 | @param[in] Buffer AML buffer\r | |
383 | @param[out] PkgLength The total length of package.\r | |
384 | \r | |
385 | @return The byte data count to present the package length.\r | |
386 | **/\r | |
387 | UINTN\r | |
388 | AmlGetPkgLength (\r | |
389 | IN UINT8 *Buffer,\r | |
390 | OUT UINTN *PkgLength\r | |
391 | );\r | |
392 | \r | |
393 | /**\r | |
394 | This function returns AcpiDataType according to AmlType.\r | |
395 | \r | |
396 | @param[in] AmlType AML Type.\r | |
397 | \r | |
398 | @return AcpiDataType\r | |
399 | **/\r | |
400 | EFI_ACPI_DATA_TYPE\r | |
401 | AmlTypeToAcpiType (\r | |
402 | IN AML_OP_PARSE_FORMAT AmlType\r | |
403 | );\r | |
404 | \r | |
405 | /**\r | |
406 | This function returns AmlByteEncoding according to OpCode Byte.\r | |
407 | \r | |
408 | @param[in] OpByteBuffer OpCode byte buffer.\r | |
409 | \r | |
410 | @return AmlByteEncoding\r | |
411 | **/\r | |
412 | AML_BYTE_ENCODING *\r | |
413 | AmlSearchByOpByte (\r | |
414 | IN UINT8 *OpByteBuffer\r | |
415 | );\r | |
416 | \r | |
417 | /**\r | |
418 | Return object size.\r | |
419 | \r | |
420 | @param[in] AmlByteEncoding AML Byte Encoding.\r | |
421 | @param[in] Buffer AML object buffer.\r | |
422 | @param[in] MaxBufferSize AML object buffer MAX size. The parser can not parse any data exceed this region.\r | |
423 | \r | |
424 | @return Size of the object.\r | |
425 | **/\r | |
426 | UINTN\r | |
427 | AmlGetObjectSize (\r | |
428 | IN AML_BYTE_ENCODING *AmlByteEncoding,\r | |
429 | IN UINT8 *Buffer,\r | |
430 | IN UINTN MaxBufferSize\r | |
431 | );\r | |
432 | \r | |
433 | /**\r | |
434 | Return object name.\r | |
435 | \r | |
436 | @param[in] AmlHandle AML handle.\r | |
437 | \r | |
438 | @return Name of the object.\r | |
439 | **/\r | |
440 | CHAR8 *\r | |
441 | AmlGetObjectName (\r | |
442 | IN EFI_AML_HANDLE *AmlHandle\r | |
443 | );\r | |
444 | \r | |
445 | /**\r | |
446 | Retrieve information according to AmlHandle\r | |
447 | \r | |
448 | @param[in] AmlHandle AML handle.\r | |
449 | @param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right\r | |
450 | in the ACPI encoding, with index 0 always being the ACPI opcode.\r | |
451 | @param[out] DataType Points to the returned data type or EFI_ACPI_DATA_TYPE_NONE if no data exists\r | |
452 | for the specified index.\r | |
453 | @param[out] Data Upon return, points to the pointer to the data.\r | |
454 | @param[out] DataSize Upon return, points to the size of Data.\r | |
455 | \r | |
456 | @retval EFI_SUCCESS Success.\r | |
457 | @retval EFI_INVALID_PARAMETER AmlHandle does not refer to a valid ACPI object.\r | |
458 | **/\r | |
459 | EFI_STATUS\r | |
460 | AmlParseOptionHandleCommon (\r | |
461 | IN EFI_AML_HANDLE *AmlHandle,\r | |
462 | IN AML_OP_PARSE_INDEX Index,\r | |
463 | OUT EFI_ACPI_DATA_TYPE *DataType,\r | |
464 | OUT VOID **Data,\r | |
465 | OUT UINTN *DataSize\r | |
466 | );\r | |
467 | \r | |
468 | /**\r | |
469 | Return offset of last option.\r | |
470 | \r | |
471 | @param[in] AmlHandle AML Handle.\r | |
472 | @param[out] Buffer Upon return, points to the offset after last option.\r | |
473 | \r | |
474 | @retval EFI_SUCCESS Success.\r | |
475 | @retval EFI_INVALID_PARAMETER AmlHandle does not refer to a valid ACPI object.\r | |
476 | **/\r | |
477 | EFI_STATUS\r | |
478 | AmlGetOffsetAfterLastOption (\r | |
479 | IN EFI_AML_HANDLE *AmlHandle,\r | |
480 | OUT UINT8 **Buffer\r | |
481 | );\r | |
482 | \r | |
483 | /**\r | |
484 | Return the child ACPI objects from Root Handle.\r | |
485 | \r | |
486 | @param[in] AmlParentHandle Parent handle. It is Root Handle.\r | |
487 | @param[in] AmlHandle The previously returned handle or NULL to start with the first handle.\r | |
488 | @param[out] Buffer On return, points to the next returned ACPI handle or NULL if there are no\r | |
489 | child objects.\r | |
490 | \r | |
491 | @retval EFI_SUCCESS Success\r | |
492 | @retval EFI_INVALID_PARAMETER ParentHandle is NULL or does not refer to a valid ACPI object. \r | |
493 | **/\r | |
494 | EFI_STATUS\r | |
495 | AmlGetChildFromRoot (\r | |
496 | IN EFI_AML_HANDLE *AmlParentHandle,\r | |
497 | IN EFI_AML_HANDLE *AmlHandle,\r | |
498 | OUT VOID **Buffer\r | |
499 | );\r | |
500 | \r | |
501 | /**\r | |
502 | Return the child ACPI objects from Non-Root Handle.\r | |
503 | \r | |
504 | @param[in] AmlParentHandle Parent handle. It is Non-Root Handle.\r | |
505 | @param[in] AmlHandle The previously returned handle or NULL to start with the first handle.\r | |
506 | @param[out] Buffer On return, points to the next returned ACPI handle or NULL if there are no\r | |
507 | child objects.\r | |
508 | \r | |
509 | @retval EFI_SUCCESS Success\r | |
510 | @retval EFI_INVALID_PARAMETER ParentHandle is NULL or does not refer to a valid ACPI object. \r | |
511 | **/\r | |
512 | EFI_STATUS\r | |
513 | AmlGetChildFromNonRoot (\r | |
514 | IN EFI_AML_HANDLE *AmlParentHandle,\r | |
515 | IN EFI_AML_HANDLE *AmlHandle,\r | |
516 | OUT VOID **Buffer\r | |
517 | );\r | |
518 | \r | |
519 | /**\r | |
520 | Return AML name according to ASL name.\r | |
521 | The caller need free the AmlName returned.\r | |
522 | \r | |
523 | @param[in] AslPath ASL name.\r | |
524 | \r | |
525 | @return AmlName\r | |
526 | **/\r | |
527 | UINT8 *\r | |
528 | AmlNameFromAslName (\r | |
529 | IN UINT8 *AslPath\r | |
530 | );\r | |
531 | \r | |
532 | /**\r | |
533 | Returns the handle of the ACPI object representing the specified ACPI AML path\r | |
534 | \r | |
535 | @param[in] AmlHandle Points to the handle of the object representing the starting point for the path search.\r | |
536 | @param[in] AmlPath Points to the ACPI AML path.\r | |
537 | @param[out] Buffer On return, points to the ACPI object which represents AcpiPath, relative to\r | |
538 | HandleIn.\r | |
539 | @param[in] FromRoot TRUE means to find AML path from \ (Root) Node.\r | |
540 | FALSE means to find AML path from this Node (The HandleIn).\r | |
541 | \r | |
542 | @retval EFI_SUCCESS Success\r | |
543 | @retval EFI_INVALID_PARAMETER HandleIn does not refer to a valid ACPI object. \r | |
544 | **/\r | |
545 | EFI_STATUS\r | |
546 | AmlFindPath (\r | |
547 | IN EFI_AML_HANDLE *AmlHandle,\r | |
548 | IN UINT8 *AmlPath,\r | |
549 | OUT VOID **Buffer,\r | |
550 | IN BOOLEAN FromRoot\r | |
551 | );\r | |
552 | \r | |
553 | /**\r | |
554 | Print AML NameString.\r | |
555 | \r | |
556 | @param[in] Buffer AML NameString.\r | |
557 | **/\r | |
558 | VOID\r | |
559 | AmlPrintNameString (\r | |
560 | IN UINT8 *Buffer\r | |
561 | );\r | |
562 | \r | |
563 | /**\r | |
564 | Print AML NameSeg.\r | |
565 | \r | |
566 | @param[in] Buffer AML NameSeg.\r | |
567 | **/\r | |
568 | VOID\r | |
569 | AmlPrintNameSeg (\r | |
570 | IN UINT8 *Buffer\r | |
571 | );\r | |
572 | \r | |
573 | /**\r | |
574 | Check if it is AML Root name\r | |
575 | \r | |
576 | @param[in] Buffer AML path.\r | |
577 | \r | |
578 | @retval TRUE AML path is root.\r | |
579 | @retval FALSE AML path is not root.\r | |
580 | **/\r | |
581 | BOOLEAN\r | |
582 | AmlIsRootPath (\r | |
583 | IN UINT8 *Buffer\r | |
584 | );\r | |
585 | \r | |
586 | #endif\r |