1 /******************************************************************************
3 * Name: acdisasm.h - AML disassembler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACDISASM_H__
45 #define __ACDISASM_H__
47 #include <contrib/dev/acpica/include/amlresrc.h>
53 #define BLOCK_COMMA_LIST 4
54 #define ACPI_DEFAULT_RESNAME *(UINT32 *) "__RD"
57 * Raw table data header. Used by disassembler and data table compiler.
60 #define ACPI_RAW_TABLE_DATA_HEADER "Raw Table Data"
63 typedef const struct acpi_dmtable_info
72 #define DT_LENGTH 0x01 /* Field is a subtable length */
73 #define DT_FLAG 0x02 /* Field is a flag value */
74 #define DT_NON_ZERO 0x04 /* Field must be non-zero */
76 /* TBD: Not used at this time */
78 #define DT_OPTIONAL 0x08
82 * Values for Opcode above.
83 * Note: 0-7 must not change, used as a flag shift value
85 #define ACPI_DMT_FLAG0 0
86 #define ACPI_DMT_FLAG1 1
87 #define ACPI_DMT_FLAG2 2
88 #define ACPI_DMT_FLAG3 3
89 #define ACPI_DMT_FLAG4 4
90 #define ACPI_DMT_FLAG5 5
91 #define ACPI_DMT_FLAG6 6
92 #define ACPI_DMT_FLAG7 7
93 #define ACPI_DMT_FLAGS0 8
94 #define ACPI_DMT_FLAGS2 9
95 #define ACPI_DMT_UINT8 10
96 #define ACPI_DMT_UINT16 11
97 #define ACPI_DMT_UINT24 12
98 #define ACPI_DMT_UINT32 13
99 #define ACPI_DMT_UINT56 14
100 #define ACPI_DMT_UINT64 15
101 #define ACPI_DMT_STRING 16
102 #define ACPI_DMT_NAME4 17
103 #define ACPI_DMT_NAME6 18
104 #define ACPI_DMT_NAME8 19
105 #define ACPI_DMT_CHKSUM 20
106 #define ACPI_DMT_SPACEID 21
107 #define ACPI_DMT_GAS 22
108 #define ACPI_DMT_ASF 23
109 #define ACPI_DMT_DMAR 24
110 #define ACPI_DMT_HEST 25
111 #define ACPI_DMT_HESTNTFY 26
112 #define ACPI_DMT_HESTNTYP 27
113 #define ACPI_DMT_MADT 28
114 #define ACPI_DMT_SRAT 29
115 #define ACPI_DMT_EXIT 30
116 #define ACPI_DMT_SIG 31
117 #define ACPI_DMT_FADTPM 32
118 #define ACPI_DMT_BUF16 33
119 #define ACPI_DMT_IVRS 34
120 #define ACPI_DMT_BUFFER 35
121 #define ACPI_DMT_PCI_PATH 36
122 #define ACPI_DMT_EINJACT 37
123 #define ACPI_DMT_EINJINST 38
124 #define ACPI_DMT_ERSTACT 39
125 #define ACPI_DMT_ERSTINST 40
126 #define ACPI_DMT_ACCWIDTH 41
127 #define ACPI_DMT_UNICODE 42
128 #define ACPI_DMT_UUID 43
129 #define ACPI_DMT_DEVICE_PATH 44
130 #define ACPI_DMT_LABEL 45
131 #define ACPI_DMT_BUF7 46
132 #define ACPI_DMT_BUF128 47
133 #define ACPI_DMT_SLIC 48
136 void (*ACPI_DMTABLE_HANDLER) (
137 ACPI_TABLE_HEADER *Table);
140 ACPI_STATUS (*ACPI_CMTABLE_HANDLER) (
143 typedef struct acpi_dmtable_data
146 ACPI_DMTABLE_INFO *TableInfo;
147 ACPI_DMTABLE_HANDLER TableHandler;
148 ACPI_CMTABLE_HANDLER CmTableHandler;
149 const unsigned char *Template;
155 typedef struct acpi_op_walk_info
162 ACPI_WALK_STATE *WalkState;
167 * TBD - another copy of this is in asltypes.h, fix
169 #ifndef ASL_WALK_CALLBACK_DEFINED
171 ACPI_STATUS (*ASL_WALK_CALLBACK) (
172 ACPI_PARSE_OBJECT *Op,
175 #define ASL_WALK_CALLBACK_DEFINED
179 typedef struct acpi_resource_tag
186 /* Strings used for decoding flags to ASL keywords */
188 extern const char *AcpiGbl_WordDecode[];
189 extern const char *AcpiGbl_IrqDecode[];
190 extern const char *AcpiGbl_LockRule[];
191 extern const char *AcpiGbl_AccessTypes[];
192 extern const char *AcpiGbl_UpdateRules[];
193 extern const char *AcpiGbl_MatchOps[];
195 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf0[];
196 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1[];
197 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1a[];
198 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2[];
199 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2a[];
200 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf3[];
201 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf4[];
202 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsfHdr[];
203 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBoot[];
204 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBert[];
205 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep[];
206 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep0[];
207 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbgp[];
208 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar[];
209 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarHdr[];
210 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarScope[];
211 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar0[];
212 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar1[];
213 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar2[];
214 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar3[];
215 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEcdt[];
216 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj[];
217 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj0[];
218 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst[];
219 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst0[];
220 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFacs[];
221 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt1[];
222 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt2[];
223 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt3[];
224 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGas[];
225 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHeader[];
226 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest[];
227 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest0[];
228 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest1[];
229 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest2[];
230 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest6[];
231 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest7[];
232 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest8[];
233 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest9[];
234 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestNotify[];
235 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestBank[];
236 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHpet[];
237 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs[];
238 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs0[];
239 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs1[];
240 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs4[];
241 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8a[];
242 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8b[];
243 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8c[];
244 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrsHdr[];
245 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt[];
246 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt0[];
247 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt1[];
248 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt2[];
249 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt3[];
250 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt4[];
251 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt5[];
252 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt6[];
253 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt7[];
254 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt8[];
255 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt9[];
256 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt10[];
257 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadtHdr[];
258 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg[];
259 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg0[];
260 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMchi[];
261 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct[];
262 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct0[];
263 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp1[];
264 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp2[];
265 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSbst[];
266 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlicHdr[];
267 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic0[];
268 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic1[];
269 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlit[];
270 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpcr[];
271 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpmi[];
272 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat[];
273 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSratHdr[];
274 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat0[];
275 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat1[];
276 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat2[];
277 extern ACPI_DMTABLE_INFO AcpiDmTableInfoTcpa[];
278 extern ACPI_DMTABLE_INFO AcpiDmTableInfoUefi[];
279 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWaet[];
280 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat[];
281 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat0[];
282 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWddt[];
283 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdrt[];
285 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGeneric[][2];
291 extern ACPI_DMTABLE_DATA AcpiDmTableData[];
294 AcpiDmGenerateChecksum (
297 UINT8 OriginalChecksum);
304 AcpiDmDumpDataTable (
305 ACPI_TABLE_HEADER *Table);
312 UINT32 SubTableLength,
313 ACPI_DMTABLE_INFO *Info);
334 ACPI_TABLE_HEADER *Table);
338 ACPI_TABLE_HEADER *Table);
342 ACPI_TABLE_HEADER *Table);
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);
410 ACPI_WALK_STATE *WalkState,
411 ACPI_PARSE_OBJECT *Origin,
415 AcpiDmWalkParseTree (
416 ACPI_PARSE_OBJECT *Op,
417 ASL_WALK_CALLBACK DescendingCallback,
418 ASL_WALK_CALLBACK AscendingCallback,
426 AcpiDmDisassembleOneOp (
427 ACPI_WALK_STATE *WalkState,
428 ACPI_OP_WALK_INFO *Info,
429 ACPI_PARSE_OBJECT *Op);
432 AcpiDmDecodeInternalObject (
433 ACPI_OPERAND_OBJECT *ObjDesc);
437 ACPI_PARSE_OBJECT *Op);
441 ACPI_PARSE_OBJECT *Op);
445 ACPI_PARSE_OBJECT *Op);
453 ACPI_PARSE_OBJECT *Op);
457 ACPI_PARSE_OBJECT *Op);
468 AcpiPsDisplayObjectPathname (
469 ACPI_WALK_STATE *WalkState,
470 ACPI_PARSE_OBJECT *Op);
481 AcpiDmDisplayInternalObject (
482 ACPI_OPERAND_OBJECT *ObjDesc,
483 ACPI_WALK_STATE *WalkState);
486 AcpiDmDisplayArguments (
487 ACPI_WALK_STATE *WalkState);
490 AcpiDmDisplayLocals (
491 ACPI_WALK_STATE *WalkState);
494 AcpiDmDumpMethodInfo (
496 ACPI_WALK_STATE *WalkState,
497 ACPI_PARSE_OBJECT *Op);
504 AcpiDmDisasmByteList (
511 ACPI_OP_WALK_INFO *Info,
512 ACPI_PARSE_OBJECT *Op);
516 ACPI_PARSE_OBJECT *Op);
523 AcpiDmIsUnicodeBuffer (
524 ACPI_PARSE_OBJECT *Op);
527 AcpiDmIsStringBuffer (
528 ACPI_PARSE_OBJECT *Op);
536 AcpiDmAddToExternalFileList (
540 AcpiDmClearExternalFileList (
544 AcpiDmAddToExternalList (
545 ACPI_PARSE_OBJECT *Op,
551 AcpiDmAddExternalsToNamespace (
555 AcpiDmGetExternalMethodCount (
559 AcpiDmClearExternalList (
563 AcpiDmEmitExternals (
576 AcpiDmDumpInteger16 (
581 AcpiDmDumpInteger32 (
586 AcpiDmDumpInteger64 (
591 AcpiDmResourceTemplate (
592 ACPI_OP_WALK_INFO *Info,
593 ACPI_PARSE_OBJECT *Op,
598 AcpiDmIsResourceTemplate (
599 ACPI_PARSE_OBJECT *Op);
606 AcpiDmDescriptorName (
614 AcpiDmWordDescriptor (
615 AML_RESOURCE *Resource,
620 AcpiDmDwordDescriptor (
621 AML_RESOURCE *Resource,
626 AcpiDmExtendedDescriptor (
627 AML_RESOURCE *Resource,
632 AcpiDmQwordDescriptor (
633 AML_RESOURCE *Resource,
638 AcpiDmMemory24Descriptor (
639 AML_RESOURCE *Resource,
644 AcpiDmMemory32Descriptor (
645 AML_RESOURCE *Resource,
650 AcpiDmFixedMemory32Descriptor (
651 AML_RESOURCE *Resource,
656 AcpiDmGenericRegisterDescriptor (
657 AML_RESOURCE *Resource,
662 AcpiDmInterruptDescriptor (
663 AML_RESOURCE *Resource,
668 AcpiDmVendorLargeDescriptor (
669 AML_RESOURCE *Resource,
685 AcpiDmIrqDescriptor (
686 AML_RESOURCE *Resource,
691 AcpiDmDmaDescriptor (
692 AML_RESOURCE *Resource,
698 AML_RESOURCE *Resource,
703 AcpiDmFixedIoDescriptor (
704 AML_RESOURCE *Resource,
709 AcpiDmStartDependentDescriptor (
710 AML_RESOURCE *Resource,
715 AcpiDmEndDependentDescriptor (
716 AML_RESOURCE *Resource,
721 AcpiDmVendorSmallDescriptor (
722 AML_RESOURCE *Resource,
731 AcpiDmDecodeAttribute (
739 AcpiDmCommaIfListMember (
740 ACPI_PARSE_OBJECT *Op);
743 AcpiDmCommaIfFieldMember (
744 ACPI_PARSE_OBJECT *Op);
751 AcpiDmFindResources (
752 ACPI_PARSE_OBJECT *Root);
755 AcpiDmCheckResourceReference (
756 ACPI_PARSE_OBJECT *Op,
757 ACPI_WALK_STATE *WalkState);
764 AdDisassemblerHeader (
768 #endif /* __ACDISASM_H__ */