1 /******************************************************************************
3 * Name: acdisasm.h - AML disassembler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #ifndef __ACDISASM_H__
117 #define __ACDISASM_H__
119 #include <contrib/dev/acpica/include/amlresrc.h>
123 #define BLOCK_PAREN 1
124 #define BLOCK_BRACE 2
125 #define BLOCK_COMMA_LIST 4
126 #define ACPI_DEFAULT_RESNAME *(UINT32 *) "__RD"
129 typedef const struct acpi_dmtable_info
138 * Values for Opcode above.
139 * Note: 0-7 must not change, used as a flag shift value
141 #define ACPI_DMT_FLAG0 0
142 #define ACPI_DMT_FLAG1 1
143 #define ACPI_DMT_FLAG2 2
144 #define ACPI_DMT_FLAG3 3
145 #define ACPI_DMT_FLAG4 4
146 #define ACPI_DMT_FLAG5 5
147 #define ACPI_DMT_FLAG6 6
148 #define ACPI_DMT_FLAG7 7
149 #define ACPI_DMT_FLAGS0 8
150 #define ACPI_DMT_FLAGS2 9
151 #define ACPI_DMT_UINT8 10
152 #define ACPI_DMT_UINT16 11
153 #define ACPI_DMT_UINT24 12
154 #define ACPI_DMT_UINT32 13
155 #define ACPI_DMT_UINT56 14
156 #define ACPI_DMT_UINT64 15
157 #define ACPI_DMT_STRING 16
158 #define ACPI_DMT_NAME4 17
159 #define ACPI_DMT_NAME6 18
160 #define ACPI_DMT_NAME8 19
161 #define ACPI_DMT_CHKSUM 20
162 #define ACPI_DMT_SPACEID 21
163 #define ACPI_DMT_GAS 22
164 #define ACPI_DMT_ASF 23
165 #define ACPI_DMT_DMAR 24
166 #define ACPI_DMT_HEST 25
167 #define ACPI_DMT_HESTNTFY 26
168 #define ACPI_DMT_HESTNTYP 27
169 #define ACPI_DMT_MADT 28
170 #define ACPI_DMT_SRAT 29
171 #define ACPI_DMT_EXIT 30
172 #define ACPI_DMT_SIG 31
173 #define ACPI_DMT_FADTPM 32
174 #define ACPI_DMT_BUF16 33
175 #define ACPI_DMT_IVRS 34
179 void (*ACPI_DMTABLE_HANDLER) (
180 ACPI_TABLE_HEADER *Table);
182 typedef struct acpi_dmtable_data
185 ACPI_DMTABLE_INFO *TableInfo;
186 ACPI_DMTABLE_HANDLER TableHandler;
192 typedef struct acpi_op_walk_info
199 ACPI_WALK_STATE *WalkState;
204 ACPI_STATUS (*ASL_WALK_CALLBACK) (
205 ACPI_PARSE_OBJECT *Op,
209 typedef struct acpi_resource_tag
216 /* Strings used for decoding flags to ASL keywords */
218 extern const char *AcpiGbl_WordDecode[];
219 extern const char *AcpiGbl_IrqDecode[];
220 extern const char *AcpiGbl_LockRule[];
221 extern const char *AcpiGbl_AccessTypes[];
222 extern const char *AcpiGbl_UpdateRules[];
223 extern const char *AcpiGbl_MatchOps[];
225 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf0[];
226 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1[];
227 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1a[];
228 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2[];
229 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2a[];
230 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf3[];
231 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf4[];
232 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsfHdr[];
233 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBoot[];
234 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBert[];
235 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep[];
236 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep0[];
237 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbgp[];
238 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar[];
239 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarHdr[];
240 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarScope[];
241 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar0[];
242 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar1[];
243 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar2[];
244 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar3[];
245 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEcdt[];
246 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj[];
247 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj0[];
248 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst[];
249 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFacs[];
250 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt1[];
251 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt2[];
252 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt3[];
253 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGas[];
254 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHeader[];
255 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest[];
256 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest0[];
257 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest1[];
258 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest2[];
259 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest6[];
260 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest7[];
261 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest8[];
262 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest9[];
263 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestNotify[];
264 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestBank[];
265 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHpet[];
266 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs[];
267 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs0[];
268 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs1[];
269 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs4[];
270 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8a[];
271 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8b[];
272 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8c[];
273 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrsHdr[];
274 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt[];
275 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt0[];
276 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt1[];
277 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt2[];
278 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt3[];
279 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt4[];
280 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt5[];
281 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt6[];
282 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt7[];
283 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt8[];
284 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt9[];
285 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt10[];
286 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadtHdr[];
287 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg[];
288 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg0[];
289 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMchi[];
290 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct[];
291 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct0[];
292 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp1[];
293 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp2[];
294 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSbst[];
295 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic[];
296 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlit[];
297 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpcr[];
298 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpmi[];
299 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat[];
300 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSratHdr[];
301 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat0[];
302 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat1[];
303 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat2[];
304 extern ACPI_DMTABLE_INFO AcpiDmTableInfoTcpa[];
305 extern ACPI_DMTABLE_INFO AcpiDmTableInfoUefi[];
306 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWaet[];
307 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat[];
308 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat0[];
309 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdrt[];
316 AcpiDmDumpDataTable (
317 ACPI_TABLE_HEADER *Table);
324 UINT32 SubTableLength,
325 ACPI_DMTABLE_INFO *Info);
346 ACPI_TABLE_HEADER *Table);
350 ACPI_TABLE_HEADER *Table);
354 ACPI_TABLE_HEADER *Table);
358 ACPI_TABLE_HEADER *Table);
362 ACPI_TABLE_HEADER *Table);
366 ACPI_TABLE_HEADER *Table);
370 ACPI_TABLE_HEADER *Table);
374 ACPI_TABLE_HEADER *Table);
378 ACPI_TABLE_HEADER *Table);
382 ACPI_TABLE_HEADER *Table);
386 ACPI_TABLE_HEADER *Table);
390 ACPI_TABLE_HEADER *Table);
394 ACPI_TABLE_HEADER *Table);
398 ACPI_TABLE_HEADER *Table);
402 ACPI_TABLE_HEADER *Table);
406 ACPI_TABLE_HEADER *Table);
410 ACPI_TABLE_HEADER *Table);
418 ACPI_WALK_STATE *WalkState,
419 ACPI_PARSE_OBJECT *Origin,
423 AcpiDmWalkParseTree (
424 ACPI_PARSE_OBJECT *Op,
425 ASL_WALK_CALLBACK DescendingCallback,
426 ASL_WALK_CALLBACK AscendingCallback,
434 AcpiDmDisassembleOneOp (
435 ACPI_WALK_STATE *WalkState,
436 ACPI_OP_WALK_INFO *Info,
437 ACPI_PARSE_OBJECT *Op);
440 AcpiDmDecodeInternalObject (
441 ACPI_OPERAND_OBJECT *ObjDesc);
445 ACPI_PARSE_OBJECT *Op);
449 ACPI_PARSE_OBJECT *Op);
453 ACPI_PARSE_OBJECT *Op);
461 ACPI_PARSE_OBJECT *Op);
465 ACPI_PARSE_OBJECT *Op);
476 AcpiPsDisplayObjectPathname (
477 ACPI_WALK_STATE *WalkState,
478 ACPI_PARSE_OBJECT *Op);
489 AcpiDmDisplayInternalObject (
490 ACPI_OPERAND_OBJECT *ObjDesc,
491 ACPI_WALK_STATE *WalkState);
494 AcpiDmDisplayArguments (
495 ACPI_WALK_STATE *WalkState);
498 AcpiDmDisplayLocals (
499 ACPI_WALK_STATE *WalkState);
502 AcpiDmDumpMethodInfo (
504 ACPI_WALK_STATE *WalkState,
505 ACPI_PARSE_OBJECT *Op);
512 AcpiDmDisasmByteList (
519 ACPI_OP_WALK_INFO *Info,
520 ACPI_PARSE_OBJECT *Op);
524 ACPI_PARSE_OBJECT *Op);
531 AcpiDmIsUnicodeBuffer (
532 ACPI_PARSE_OBJECT *Op);
535 AcpiDmIsStringBuffer (
536 ACPI_PARSE_OBJECT *Op);
543 AcpiDmAddToExternalList (
544 ACPI_PARSE_OBJECT *Op,
550 AcpiDmAddExternalsToNamespace (
554 AcpiDmGetExternalMethodCount (
558 AcpiDmClearExternalList (
562 AcpiDmEmitExternals (
575 AcpiDmDumpInteger16 (
580 AcpiDmDumpInteger32 (
585 AcpiDmDumpInteger64 (
590 AcpiDmResourceTemplate (
591 ACPI_OP_WALK_INFO *Info,
592 ACPI_PARSE_OBJECT *Op,
597 AcpiDmIsResourceTemplate (
598 ACPI_PARSE_OBJECT *Op);
605 AcpiDmDescriptorName (
613 AcpiDmWordDescriptor (
614 AML_RESOURCE *Resource,
619 AcpiDmDwordDescriptor (
620 AML_RESOURCE *Resource,
625 AcpiDmExtendedDescriptor (
626 AML_RESOURCE *Resource,
631 AcpiDmQwordDescriptor (
632 AML_RESOURCE *Resource,
637 AcpiDmMemory24Descriptor (
638 AML_RESOURCE *Resource,
643 AcpiDmMemory32Descriptor (
644 AML_RESOURCE *Resource,
649 AcpiDmFixedMemory32Descriptor (
650 AML_RESOURCE *Resource,
655 AcpiDmGenericRegisterDescriptor (
656 AML_RESOURCE *Resource,
661 AcpiDmInterruptDescriptor (
662 AML_RESOURCE *Resource,
667 AcpiDmVendorLargeDescriptor (
668 AML_RESOURCE *Resource,
684 AcpiDmIrqDescriptor (
685 AML_RESOURCE *Resource,
690 AcpiDmDmaDescriptor (
691 AML_RESOURCE *Resource,
697 AML_RESOURCE *Resource,
702 AcpiDmFixedIoDescriptor (
703 AML_RESOURCE *Resource,
708 AcpiDmStartDependentDescriptor (
709 AML_RESOURCE *Resource,
714 AcpiDmEndDependentDescriptor (
715 AML_RESOURCE *Resource,
720 AcpiDmVendorSmallDescriptor (
721 AML_RESOURCE *Resource,
730 AcpiDmDecodeAttribute (
738 AcpiDmCommaIfListMember (
739 ACPI_PARSE_OBJECT *Op);
742 AcpiDmCommaIfFieldMember (
743 ACPI_PARSE_OBJECT *Op);
750 AcpiDmFindResources (
751 ACPI_PARSE_OBJECT *Root);
754 AcpiDmCheckResourceReference (
755 ACPI_PARSE_OBJECT *Op,
756 ACPI_WALK_STATE *WalkState);
758 #endif /* __ACDISASM_H__ */