1 /******************************************************************************
3 * Name: acdisasm.h - AML disassembler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, 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 "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 * Raw table data header. Used by disassembler and data table compiler.
132 #define ACPI_RAW_TABLE_DATA_HEADER "Raw Table Data"
135 typedef const struct acpi_dmtable_info
144 #define DT_LENGTH 0x01 /* Field is a subtable length */
145 #define DT_FLAG 0x02 /* Field is a flag value */
146 #define DT_NON_ZERO 0x04 /* Field must be non-zero */
148 /* TBD: Not used at this time */
150 #define DT_OPTIONAL 0x08
151 #define DT_COUNT 0x10
154 * Values for Opcode above.
155 * Note: 0-7 must not change, used as a flag shift value
157 #define ACPI_DMT_FLAG0 0
158 #define ACPI_DMT_FLAG1 1
159 #define ACPI_DMT_FLAG2 2
160 #define ACPI_DMT_FLAG3 3
161 #define ACPI_DMT_FLAG4 4
162 #define ACPI_DMT_FLAG5 5
163 #define ACPI_DMT_FLAG6 6
164 #define ACPI_DMT_FLAG7 7
165 #define ACPI_DMT_FLAGS0 8
166 #define ACPI_DMT_FLAGS2 9
167 #define ACPI_DMT_UINT8 10
168 #define ACPI_DMT_UINT16 11
169 #define ACPI_DMT_UINT24 12
170 #define ACPI_DMT_UINT32 13
171 #define ACPI_DMT_UINT56 14
172 #define ACPI_DMT_UINT64 15
173 #define ACPI_DMT_STRING 16
174 #define ACPI_DMT_NAME4 17
175 #define ACPI_DMT_NAME6 18
176 #define ACPI_DMT_NAME8 19
177 #define ACPI_DMT_CHKSUM 20
178 #define ACPI_DMT_SPACEID 21
179 #define ACPI_DMT_GAS 22
180 #define ACPI_DMT_ASF 23
181 #define ACPI_DMT_DMAR 24
182 #define ACPI_DMT_HEST 25
183 #define ACPI_DMT_HESTNTFY 26
184 #define ACPI_DMT_HESTNTYP 27
185 #define ACPI_DMT_MADT 28
186 #define ACPI_DMT_SRAT 29
187 #define ACPI_DMT_EXIT 30
188 #define ACPI_DMT_SIG 31
189 #define ACPI_DMT_FADTPM 32
190 #define ACPI_DMT_BUF16 33
191 #define ACPI_DMT_IVRS 34
192 #define ACPI_DMT_BUFFER 35
193 #define ACPI_DMT_PCI_PATH 36
194 #define ACPI_DMT_EINJACT 37
195 #define ACPI_DMT_EINJINST 38
196 #define ACPI_DMT_ERSTACT 39
197 #define ACPI_DMT_ERSTINST 40
198 #define ACPI_DMT_ACCWIDTH 41
199 #define ACPI_DMT_UNICODE 42
200 #define ACPI_DMT_UUID 43
201 #define ACPI_DMT_DEVICE_PATH 44
202 #define ACPI_DMT_LABEL 45
203 #define ACPI_DMT_BUF7 46
207 void (*ACPI_DMTABLE_HANDLER) (
208 ACPI_TABLE_HEADER *Table);
211 ACPI_STATUS (*ACPI_CMTABLE_HANDLER) (
214 typedef struct acpi_dmtable_data
217 ACPI_DMTABLE_INFO *TableInfo;
218 ACPI_DMTABLE_HANDLER TableHandler;
219 ACPI_CMTABLE_HANDLER CmTableHandler;
220 const unsigned char *Template;
226 typedef struct acpi_op_walk_info
233 ACPI_WALK_STATE *WalkState;
238 * TBD - another copy of this is in asltypes.h, fix
240 #ifndef ASL_WALK_CALLBACK_DEFINED
242 ACPI_STATUS (*ASL_WALK_CALLBACK) (
243 ACPI_PARSE_OBJECT *Op,
246 #define ASL_WALK_CALLBACK_DEFINED
250 typedef struct acpi_resource_tag
257 /* Strings used for decoding flags to ASL keywords */
259 extern const char *AcpiGbl_WordDecode[];
260 extern const char *AcpiGbl_IrqDecode[];
261 extern const char *AcpiGbl_LockRule[];
262 extern const char *AcpiGbl_AccessTypes[];
263 extern const char *AcpiGbl_UpdateRules[];
264 extern const char *AcpiGbl_MatchOps[];
266 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf0[];
267 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1[];
268 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1a[];
269 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2[];
270 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2a[];
271 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf3[];
272 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf4[];
273 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsfHdr[];
274 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBoot[];
275 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBert[];
276 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep[];
277 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep0[];
278 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbgp[];
279 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar[];
280 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarHdr[];
281 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarScope[];
282 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar0[];
283 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar1[];
284 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar2[];
285 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar3[];
286 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEcdt[];
287 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj[];
288 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj0[];
289 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst[];
290 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst0[];
291 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFacs[];
292 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt1[];
293 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt2[];
294 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt3[];
295 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGas[];
296 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHeader[];
297 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest[];
298 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest0[];
299 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest1[];
300 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest2[];
301 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest6[];
302 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest7[];
303 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest8[];
304 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest9[];
305 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestNotify[];
306 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestBank[];
307 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHpet[];
308 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs[];
309 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs0[];
310 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs1[];
311 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs4[];
312 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8a[];
313 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8b[];
314 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8c[];
315 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrsHdr[];
316 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt[];
317 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt0[];
318 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt1[];
319 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt2[];
320 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt3[];
321 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt4[];
322 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt5[];
323 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt6[];
324 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt7[];
325 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt8[];
326 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt9[];
327 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt10[];
328 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadtHdr[];
329 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg[];
330 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg0[];
331 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMchi[];
332 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct[];
333 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct0[];
334 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp1[];
335 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp2[];
336 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSbst[];
337 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic[];
338 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlit[];
339 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpcr[];
340 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpmi[];
341 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat[];
342 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSratHdr[];
343 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat0[];
344 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat1[];
345 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat2[];
346 extern ACPI_DMTABLE_INFO AcpiDmTableInfoTcpa[];
347 extern ACPI_DMTABLE_INFO AcpiDmTableInfoUefi[];
348 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWaet[];
349 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat[];
350 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat0[];
351 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWddt[];
352 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdrt[];
354 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGeneric[][2];
360 extern ACPI_DMTABLE_DATA AcpiDmTableData[];
363 AcpiDmGenerateChecksum (
366 UINT8 OriginalChecksum);
373 AcpiDmDumpDataTable (
374 ACPI_TABLE_HEADER *Table);
381 UINT32 SubTableLength,
382 ACPI_DMTABLE_INFO *Info);
403 ACPI_TABLE_HEADER *Table);
407 ACPI_TABLE_HEADER *Table);
411 ACPI_TABLE_HEADER *Table);
415 ACPI_TABLE_HEADER *Table);
419 ACPI_TABLE_HEADER *Table);
423 ACPI_TABLE_HEADER *Table);
427 ACPI_TABLE_HEADER *Table);
431 ACPI_TABLE_HEADER *Table);
435 ACPI_TABLE_HEADER *Table);
439 ACPI_TABLE_HEADER *Table);
443 ACPI_TABLE_HEADER *Table);
447 ACPI_TABLE_HEADER *Table);
451 ACPI_TABLE_HEADER *Table);
455 ACPI_TABLE_HEADER *Table);
459 ACPI_TABLE_HEADER *Table);
463 ACPI_TABLE_HEADER *Table);
467 ACPI_TABLE_HEADER *Table);
475 ACPI_WALK_STATE *WalkState,
476 ACPI_PARSE_OBJECT *Origin,
480 AcpiDmWalkParseTree (
481 ACPI_PARSE_OBJECT *Op,
482 ASL_WALK_CALLBACK DescendingCallback,
483 ASL_WALK_CALLBACK AscendingCallback,
491 AcpiDmDisassembleOneOp (
492 ACPI_WALK_STATE *WalkState,
493 ACPI_OP_WALK_INFO *Info,
494 ACPI_PARSE_OBJECT *Op);
497 AcpiDmDecodeInternalObject (
498 ACPI_OPERAND_OBJECT *ObjDesc);
502 ACPI_PARSE_OBJECT *Op);
506 ACPI_PARSE_OBJECT *Op);
510 ACPI_PARSE_OBJECT *Op);
518 ACPI_PARSE_OBJECT *Op);
522 ACPI_PARSE_OBJECT *Op);
533 AcpiPsDisplayObjectPathname (
534 ACPI_WALK_STATE *WalkState,
535 ACPI_PARSE_OBJECT *Op);
546 AcpiDmDisplayInternalObject (
547 ACPI_OPERAND_OBJECT *ObjDesc,
548 ACPI_WALK_STATE *WalkState);
551 AcpiDmDisplayArguments (
552 ACPI_WALK_STATE *WalkState);
555 AcpiDmDisplayLocals (
556 ACPI_WALK_STATE *WalkState);
559 AcpiDmDumpMethodInfo (
561 ACPI_WALK_STATE *WalkState,
562 ACPI_PARSE_OBJECT *Op);
569 AcpiDmDisasmByteList (
576 ACPI_OP_WALK_INFO *Info,
577 ACPI_PARSE_OBJECT *Op);
581 ACPI_PARSE_OBJECT *Op);
588 AcpiDmIsUnicodeBuffer (
589 ACPI_PARSE_OBJECT *Op);
592 AcpiDmIsStringBuffer (
593 ACPI_PARSE_OBJECT *Op);
601 AcpiDmAddToExternalFileList (
605 AcpiDmClearExternalFileList (
609 AcpiDmAddToExternalList (
610 ACPI_PARSE_OBJECT *Op,
616 AcpiDmAddExternalsToNamespace (
620 AcpiDmGetExternalMethodCount (
624 AcpiDmClearExternalList (
628 AcpiDmEmitExternals (
641 AcpiDmDumpInteger16 (
646 AcpiDmDumpInteger32 (
651 AcpiDmDumpInteger64 (
656 AcpiDmResourceTemplate (
657 ACPI_OP_WALK_INFO *Info,
658 ACPI_PARSE_OBJECT *Op,
663 AcpiDmIsResourceTemplate (
664 ACPI_PARSE_OBJECT *Op);
671 AcpiDmDescriptorName (
679 AcpiDmWordDescriptor (
680 AML_RESOURCE *Resource,
685 AcpiDmDwordDescriptor (
686 AML_RESOURCE *Resource,
691 AcpiDmExtendedDescriptor (
692 AML_RESOURCE *Resource,
697 AcpiDmQwordDescriptor (
698 AML_RESOURCE *Resource,
703 AcpiDmMemory24Descriptor (
704 AML_RESOURCE *Resource,
709 AcpiDmMemory32Descriptor (
710 AML_RESOURCE *Resource,
715 AcpiDmFixedMemory32Descriptor (
716 AML_RESOURCE *Resource,
721 AcpiDmGenericRegisterDescriptor (
722 AML_RESOURCE *Resource,
727 AcpiDmInterruptDescriptor (
728 AML_RESOURCE *Resource,
733 AcpiDmVendorLargeDescriptor (
734 AML_RESOURCE *Resource,
750 AcpiDmIrqDescriptor (
751 AML_RESOURCE *Resource,
756 AcpiDmDmaDescriptor (
757 AML_RESOURCE *Resource,
763 AML_RESOURCE *Resource,
768 AcpiDmFixedIoDescriptor (
769 AML_RESOURCE *Resource,
774 AcpiDmStartDependentDescriptor (
775 AML_RESOURCE *Resource,
780 AcpiDmEndDependentDescriptor (
781 AML_RESOURCE *Resource,
786 AcpiDmVendorSmallDescriptor (
787 AML_RESOURCE *Resource,
796 AcpiDmDecodeAttribute (
804 AcpiDmCommaIfListMember (
805 ACPI_PARSE_OBJECT *Op);
808 AcpiDmCommaIfFieldMember (
809 ACPI_PARSE_OBJECT *Op);
816 AcpiDmFindResources (
817 ACPI_PARSE_OBJECT *Root);
820 AcpiDmCheckResourceReference (
821 ACPI_PARSE_OBJECT *Op,
822 ACPI_WALK_STATE *WalkState);
829 AdDisassemblerHeader (
833 #endif /* __ACDISASM_H__ */