1 /******************************************************************************
3 * Name: acdisasm.h - AML disassembler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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, they are used as a flag shift value. Other
84 * than those, new values can be added wherever appropriate.
88 /* Simple Data Types */
119 /* Types that are decoded to strings and miscellaneous */
128 /* Types used only for the Data Table Compiler */
131 ACPI_DMT_DEVICE_PATH,
135 /* Types that are specific to particular ACPI tables */
153 /* Special opcodes */
161 void (*ACPI_DMTABLE_HANDLER) (
162 ACPI_TABLE_HEADER *Table);
165 ACPI_STATUS (*ACPI_CMTABLE_HANDLER) (
168 typedef struct acpi_dmtable_data
171 ACPI_DMTABLE_INFO *TableInfo;
172 ACPI_DMTABLE_HANDLER TableHandler;
173 ACPI_CMTABLE_HANDLER CmTableHandler;
174 const unsigned char *Template;
180 typedef struct acpi_op_walk_info
187 ACPI_WALK_STATE *WalkState;
192 * TBD - another copy of this is in asltypes.h, fix
194 #ifndef ASL_WALK_CALLBACK_DEFINED
196 ACPI_STATUS (*ASL_WALK_CALLBACK) (
197 ACPI_PARSE_OBJECT *Op,
200 #define ASL_WALK_CALLBACK_DEFINED
204 void (*ACPI_RESOURCE_HANDLER) (
205 AML_RESOURCE *Resource,
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 AcpiDmTableInfoBgrt[];
236 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep[];
237 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep0[];
238 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbgp[];
239 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar[];
240 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarHdr[];
241 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarScope[];
242 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar0[];
243 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar1[];
244 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar2[];
245 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar3[];
246 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDrtm[];
247 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEcdt[];
248 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj[];
249 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj0[];
250 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst[];
251 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst0[];
252 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFacs[];
253 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt1[];
254 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt2[];
255 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt3[];
256 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt5[];
257 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdt[];
258 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdtHdr[];
259 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdt0[];
260 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdt1[];
261 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGas[];
262 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGtdt[];
263 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHeader[];
264 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest[];
265 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest0[];
266 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest1[];
267 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest2[];
268 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest6[];
269 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest7[];
270 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest8[];
271 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest9[];
272 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestNotify[];
273 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestBank[];
274 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHpet[];
275 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs[];
276 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs0[];
277 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs1[];
278 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs4[];
279 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8a[];
280 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8b[];
281 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8c[];
282 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrsHdr[];
283 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt[];
284 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt0[];
285 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt1[];
286 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt2[];
287 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt3[];
288 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt4[];
289 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt5[];
290 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt6[];
291 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt7[];
292 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt8[];
293 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt9[];
294 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt10[];
295 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt11[];
296 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt12[];
297 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadtHdr[];
298 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg[];
299 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg0[];
300 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMchi[];
301 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst[];
302 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst0[];
303 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst0A[];
304 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst0B[];
305 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst1[];
306 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst2[];
307 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct[];
308 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct0[];
309 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt[];
310 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt0[];
311 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt1[];
312 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt1a[];
313 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt2[];
314 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmttHdr[];
315 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPcct[];
316 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPcct0[];
317 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp1[];
318 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp2[];
319 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3pt[];
320 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3ptHdr[];
321 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3pt0[];
322 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3pt1[];
323 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSbst[];
324 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlicHdr[];
325 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic0[];
326 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic1[];
327 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlit[];
328 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpcr[];
329 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpmi[];
330 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat[];
331 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSratHdr[];
332 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat0[];
333 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat1[];
334 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat2[];
335 extern ACPI_DMTABLE_INFO AcpiDmTableInfoTcpa[];
336 extern ACPI_DMTABLE_INFO AcpiDmTableInfoUefi[];
337 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWaet[];
338 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat[];
339 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat0[];
340 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWddt[];
341 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdrt[];
343 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGeneric[][2];
349 extern ACPI_DMTABLE_DATA AcpiDmTableData[];
352 AcpiDmGenerateChecksum (
355 UINT8 OriginalChecksum);
362 AcpiDmDumpDataTable (
363 ACPI_TABLE_HEADER *Table);
370 UINT32 SubTableLength,
371 ACPI_DMTABLE_INFO *Info);
392 ACPI_TABLE_HEADER *Table);
396 ACPI_TABLE_HEADER *Table);
400 ACPI_TABLE_HEADER *Table);
404 ACPI_TABLE_HEADER *Table);
408 ACPI_TABLE_HEADER *Table);
412 ACPI_TABLE_HEADER *Table);
416 ACPI_TABLE_HEADER *Table);
420 ACPI_TABLE_HEADER *Table);
424 ACPI_TABLE_HEADER *Table);
428 ACPI_TABLE_HEADER *Table);
432 ACPI_TABLE_HEADER *Table);
436 ACPI_TABLE_HEADER *Table);
440 ACPI_TABLE_HEADER *Table);
444 ACPI_TABLE_HEADER *Table);
448 ACPI_TABLE_HEADER *Table);
452 ACPI_TABLE_HEADER *Table);
456 ACPI_TABLE_HEADER *Table);
460 ACPI_TABLE_HEADER *Table);
464 ACPI_TABLE_HEADER *Table);
468 ACPI_TABLE_HEADER *Table);
472 ACPI_TABLE_HEADER *Table);
476 ACPI_TABLE_HEADER *Table);
480 ACPI_TABLE_HEADER *Table);
488 ACPI_WALK_STATE *WalkState,
489 ACPI_PARSE_OBJECT *Origin,
493 AcpiDmWalkParseTree (
494 ACPI_PARSE_OBJECT *Op,
495 ASL_WALK_CALLBACK DescendingCallback,
496 ASL_WALK_CALLBACK AscendingCallback,
504 AcpiDmDisassembleOneOp (
505 ACPI_WALK_STATE *WalkState,
506 ACPI_OP_WALK_INFO *Info,
507 ACPI_PARSE_OBJECT *Op);
510 AcpiDmDecodeInternalObject (
511 ACPI_OPERAND_OBJECT *ObjDesc);
515 ACPI_PARSE_OBJECT *Op);
519 ACPI_PARSE_OBJECT *Op);
522 AcpiDmPredefinedDescription (
523 ACPI_PARSE_OBJECT *Op);
526 AcpiDmFieldPredefinedDescription (
527 ACPI_PARSE_OBJECT *Op);
531 ACPI_PARSE_OBJECT *Op);
539 ACPI_PARSE_OBJECT *Op);
543 ACPI_PARSE_OBJECT *Op);
554 AcpiPsDisplayObjectPathname (
555 ACPI_WALK_STATE *WalkState,
556 ACPI_PARSE_OBJECT *Op);
567 AcpiDmDisplayInternalObject (
568 ACPI_OPERAND_OBJECT *ObjDesc,
569 ACPI_WALK_STATE *WalkState);
572 AcpiDmDisplayArguments (
573 ACPI_WALK_STATE *WalkState);
576 AcpiDmDisplayLocals (
577 ACPI_WALK_STATE *WalkState);
580 AcpiDmDumpMethodInfo (
582 ACPI_WALK_STATE *WalkState,
583 ACPI_PARSE_OBJECT *Op);
590 AcpiDmDisasmByteList (
597 ACPI_OP_WALK_INFO *Info,
598 ACPI_PARSE_OBJECT *Op);
602 ACPI_PARSE_OBJECT *Op);
609 AcpiDmIsUnicodeBuffer (
610 ACPI_PARSE_OBJECT *Op);
613 AcpiDmIsStringBuffer (
614 ACPI_PARSE_OBJECT *Op);
622 AcpiDmAddToExternalFileList (
626 AcpiDmClearExternalFileList (
630 AcpiDmAddToExternalList (
631 ACPI_PARSE_OBJECT *Op,
637 AcpiDmAddExternalsToNamespace (
641 AcpiDmGetExternalMethodCount (
645 AcpiDmClearExternalList (
649 AcpiDmEmitExternals (
662 AcpiDmDumpInteger16 (
667 AcpiDmDumpInteger32 (
672 AcpiDmDumpInteger64 (
677 AcpiDmResourceTemplate (
678 ACPI_OP_WALK_INFO *Info,
679 ACPI_PARSE_OBJECT *Op,
684 AcpiDmIsResourceTemplate (
685 ACPI_PARSE_OBJECT *Op);
692 AcpiDmDescriptorName (
700 AcpiDmWordDescriptor (
701 AML_RESOURCE *Resource,
706 AcpiDmDwordDescriptor (
707 AML_RESOURCE *Resource,
712 AcpiDmExtendedDescriptor (
713 AML_RESOURCE *Resource,
718 AcpiDmQwordDescriptor (
719 AML_RESOURCE *Resource,
724 AcpiDmMemory24Descriptor (
725 AML_RESOURCE *Resource,
730 AcpiDmMemory32Descriptor (
731 AML_RESOURCE *Resource,
736 AcpiDmFixedMemory32Descriptor (
737 AML_RESOURCE *Resource,
742 AcpiDmGenericRegisterDescriptor (
743 AML_RESOURCE *Resource,
748 AcpiDmInterruptDescriptor (
749 AML_RESOURCE *Resource,
754 AcpiDmVendorLargeDescriptor (
755 AML_RESOURCE *Resource,
760 AcpiDmGpioDescriptor (
761 AML_RESOURCE *Resource,
766 AcpiDmSerialBusDescriptor (
767 AML_RESOURCE *Resource,
783 AcpiDmIrqDescriptor (
784 AML_RESOURCE *Resource,
789 AcpiDmDmaDescriptor (
790 AML_RESOURCE *Resource,
795 AcpiDmFixedDmaDescriptor (
796 AML_RESOURCE *Resource,
802 AML_RESOURCE *Resource,
807 AcpiDmFixedIoDescriptor (
808 AML_RESOURCE *Resource,
813 AcpiDmStartDependentDescriptor (
814 AML_RESOURCE *Resource,
819 AcpiDmEndDependentDescriptor (
820 AML_RESOURCE *Resource,
825 AcpiDmVendorSmallDescriptor (
826 AML_RESOURCE *Resource,
835 AcpiDmDecodeAttribute (
843 AcpiDmCommaIfListMember (
844 ACPI_PARSE_OBJECT *Op);
847 AcpiDmCommaIfFieldMember (
848 ACPI_PARSE_OBJECT *Op);
855 AcpiDmFindResources (
856 ACPI_PARSE_OBJECT *Root);
859 AcpiDmCheckResourceReference (
860 ACPI_PARSE_OBJECT *Op,
861 ACPI_WALK_STATE *WalkState);
868 AdDisassemblerHeader (
872 #endif /* __ACDISASM_H__ */