1 /******************************************************************************
3 * Name: acdisasm.h - AML disassembler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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__
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 /* Values for Flags field above */
74 #define DT_LENGTH 0x01 /* Field is a subtable length */
75 #define DT_FLAG 0x02 /* Field is a flag value */
76 #define DT_NON_ZERO 0x04 /* Field must be non-zero */
77 #define DT_OPTIONAL 0x08 /* Field is optional */
78 #define DT_DESCRIBES_OPTIONAL 0x10 /* Field describes an optional field (length, etc.) */
79 #define DT_COUNT 0x20 /* Currently not used */
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 */
120 /* Types that are decoded to strings and miscellaneous */
129 /* Types used only for the Data Table Compiler */
132 ACPI_DMT_DEVICE_PATH,
136 /* Types that are specific to particular ACPI tables */
155 /* Special opcodes */
163 void (*ACPI_DMTABLE_HANDLER) (
164 ACPI_TABLE_HEADER *Table);
167 ACPI_STATUS (*ACPI_CMTABLE_HANDLER) (
170 typedef struct acpi_dmtable_data
173 ACPI_DMTABLE_INFO *TableInfo;
174 ACPI_DMTABLE_HANDLER TableHandler;
175 ACPI_CMTABLE_HANDLER CmTableHandler;
176 const unsigned char *Template;
182 typedef struct acpi_op_walk_info
189 ACPI_WALK_STATE *WalkState;
194 * TBD - another copy of this is in asltypes.h, fix
196 #ifndef ASL_WALK_CALLBACK_DEFINED
198 ACPI_STATUS (*ASL_WALK_CALLBACK) (
199 ACPI_PARSE_OBJECT *Op,
202 #define ASL_WALK_CALLBACK_DEFINED
206 void (*ACPI_RESOURCE_HANDLER) (
207 AML_RESOURCE *Resource,
211 typedef struct acpi_resource_tag
218 /* Strings used for decoding flags to ASL keywords */
220 extern const char *AcpiGbl_WordDecode[];
221 extern const char *AcpiGbl_IrqDecode[];
222 extern const char *AcpiGbl_LockRule[];
223 extern const char *AcpiGbl_AccessTypes[];
224 extern const char *AcpiGbl_UpdateRules[];
225 extern const char *AcpiGbl_MatchOps[];
227 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf0[];
228 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1[];
229 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1a[];
230 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2[];
231 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2a[];
232 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf3[];
233 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf4[];
234 extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsfHdr[];
235 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBoot[];
236 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBert[];
237 extern ACPI_DMTABLE_INFO AcpiDmTableInfoBgrt[];
238 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep[];
239 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep0[];
240 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCsrt0[];
241 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCsrt1[];
242 extern ACPI_DMTABLE_INFO AcpiDmTableInfoCsrt2[];
243 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbg2[];
244 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbg2Device[];
245 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbg2Addr[];
246 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbg2Size[];
247 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbg2Name[];
248 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbg2OemData[];
249 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbgp[];
250 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar[];
251 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarHdr[];
252 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarScope[];
253 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar0[];
254 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar1[];
255 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar2[];
256 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar3[];
257 extern ACPI_DMTABLE_INFO AcpiDmTableInfoDrtm[];
258 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEcdt[];
259 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj[];
260 extern ACPI_DMTABLE_INFO AcpiDmTableInfoEinj0[];
261 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst[];
262 extern ACPI_DMTABLE_INFO AcpiDmTableInfoErst0[];
263 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFacs[];
264 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt1[];
265 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt2[];
266 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt3[];
267 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt5[];
268 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdt[];
269 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdtHdr[];
270 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdt0[];
271 extern ACPI_DMTABLE_INFO AcpiDmTableInfoFpdt1[];
272 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGas[];
273 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGtdt[];
274 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHeader[];
275 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest[];
276 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest0[];
277 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest1[];
278 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest2[];
279 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest6[];
280 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest7[];
281 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest8[];
282 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHest9[];
283 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestNotify[];
284 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHestBank[];
285 extern ACPI_DMTABLE_INFO AcpiDmTableInfoHpet[];
286 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs[];
287 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs0[];
288 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs1[];
289 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs4[];
290 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8a[];
291 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8b[];
292 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrs8c[];
293 extern ACPI_DMTABLE_INFO AcpiDmTableInfoIvrsHdr[];
294 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt[];
295 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt0[];
296 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt1[];
297 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt2[];
298 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt3[];
299 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt4[];
300 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt5[];
301 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt6[];
302 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt7[];
303 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt8[];
304 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt9[];
305 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt10[];
306 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt11[];
307 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt12[];
308 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadtHdr[];
309 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg[];
310 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg0[];
311 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMchi[];
312 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst[];
313 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst0[];
314 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst0A[];
315 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst0B[];
316 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst1[];
317 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMpst2[];
318 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct[];
319 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMsct0[];
320 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMtmr[];
321 extern ACPI_DMTABLE_INFO AcpiDmTableInfoMtmr0[];
322 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt[];
323 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt0[];
324 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt1[];
325 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt1a[];
326 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmtt2[];
327 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPmttHdr[];
328 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPcct[];
329 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPcctHdr[];
330 extern ACPI_DMTABLE_INFO AcpiDmTableInfoPcct0[];
331 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp1[];
332 extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp2[];
333 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3pt[];
334 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3ptHdr[];
335 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3pt0[];
336 extern ACPI_DMTABLE_INFO AcpiDmTableInfoS3pt1[];
337 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSbst[];
338 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlicHdr[];
339 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic0[];
340 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlic1[];
341 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlit[];
342 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpcr[];
343 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpmi[];
344 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat[];
345 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSratHdr[];
346 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat0[];
347 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat1[];
348 extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat2[];
349 extern ACPI_DMTABLE_INFO AcpiDmTableInfoTcpa[];
350 extern ACPI_DMTABLE_INFO AcpiDmTableInfoTpm2[];
351 extern ACPI_DMTABLE_INFO AcpiDmTableInfoUefi[];
352 extern ACPI_DMTABLE_INFO AcpiDmTableInfoVrtc[];
353 extern ACPI_DMTABLE_INFO AcpiDmTableInfoVrtc0[];
354 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWaet[];
355 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat[];
356 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdat0[];
357 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWddt[];
358 extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdrt[];
360 extern ACPI_DMTABLE_INFO AcpiDmTableInfoGeneric[][2];
366 extern ACPI_DMTABLE_DATA AcpiDmTableData[];
369 AcpiDmGenerateChecksum (
372 UINT8 OriginalChecksum);
379 AcpiDmDumpDataTable (
380 ACPI_TABLE_HEADER *Table);
387 UINT32 SubTableLength,
388 ACPI_DMTABLE_INFO *Info);
409 ACPI_TABLE_HEADER *Table);
413 ACPI_TABLE_HEADER *Table);
417 ACPI_TABLE_HEADER *Table);
421 ACPI_TABLE_HEADER *Table);
425 ACPI_TABLE_HEADER *Table);
429 ACPI_TABLE_HEADER *Table);
433 ACPI_TABLE_HEADER *Table);
437 ACPI_TABLE_HEADER *Table);
441 ACPI_TABLE_HEADER *Table);
445 ACPI_TABLE_HEADER *Table);
449 ACPI_TABLE_HEADER *Table);
453 ACPI_TABLE_HEADER *Table);
457 ACPI_TABLE_HEADER *Table);
461 ACPI_TABLE_HEADER *Table);
465 ACPI_TABLE_HEADER *Table);
469 ACPI_TABLE_HEADER *Table);
473 ACPI_TABLE_HEADER *Table);
477 ACPI_TABLE_HEADER *Table);
481 ACPI_TABLE_HEADER *Table);
485 ACPI_TABLE_HEADER *Table);
489 ACPI_TABLE_HEADER *Table);
493 ACPI_TABLE_HEADER *Table);
497 ACPI_TABLE_HEADER *Table);
501 ACPI_TABLE_HEADER *Table);
505 ACPI_TABLE_HEADER *Table);
509 ACPI_TABLE_HEADER *Table);
513 ACPI_TABLE_HEADER *Table);
521 ACPI_WALK_STATE *WalkState,
522 ACPI_PARSE_OBJECT *Origin,
526 AcpiDmWalkParseTree (
527 ACPI_PARSE_OBJECT *Op,
528 ASL_WALK_CALLBACK DescendingCallback,
529 ASL_WALK_CALLBACK AscendingCallback,
537 AcpiDmDisassembleOneOp (
538 ACPI_WALK_STATE *WalkState,
539 ACPI_OP_WALK_INFO *Info,
540 ACPI_PARSE_OBJECT *Op);
543 AcpiDmDecodeInternalObject (
544 ACPI_OPERAND_OBJECT *ObjDesc);
548 ACPI_PARSE_OBJECT *Op);
552 ACPI_PARSE_OBJECT *Op);
555 AcpiDmPredefinedDescription (
556 ACPI_PARSE_OBJECT *Op);
559 AcpiDmFieldPredefinedDescription (
560 ACPI_PARSE_OBJECT *Op);
564 ACPI_PARSE_OBJECT *Op);
572 ACPI_PARSE_OBJECT *Op);
576 ACPI_PARSE_OBJECT *Op);
587 AcpiPsDisplayObjectPathname (
588 ACPI_WALK_STATE *WalkState,
589 ACPI_PARSE_OBJECT *Op);
600 AcpiDmDisplayInternalObject (
601 ACPI_OPERAND_OBJECT *ObjDesc,
602 ACPI_WALK_STATE *WalkState);
605 AcpiDmDisplayArguments (
606 ACPI_WALK_STATE *WalkState);
609 AcpiDmDisplayLocals (
610 ACPI_WALK_STATE *WalkState);
613 AcpiDmDumpMethodInfo (
615 ACPI_WALK_STATE *WalkState,
616 ACPI_PARSE_OBJECT *Op);
623 AcpiDmDisasmByteList (
630 ACPI_OP_WALK_INFO *Info,
631 ACPI_PARSE_OBJECT *Op);
635 ACPI_PARSE_OBJECT *Op);
642 AcpiDmIsUnicodeBuffer (
643 ACPI_PARSE_OBJECT *Op);
646 AcpiDmIsStringBuffer (
647 ACPI_PARSE_OBJECT *Op);
651 ACPI_PARSE_OBJECT *Op);
658 AcpiDmParseDeferredOps (
659 ACPI_PARSE_OBJECT *Root);
666 AcpiDmAddToExternalFileList (
670 AcpiDmClearExternalFileList (
674 AcpiDmAddOpToExternalList (
675 ACPI_PARSE_OBJECT *Op,
682 AcpiDmAddNodeToExternalList (
683 ACPI_NAMESPACE_NODE *Node,
689 AcpiDmAddExternalsToNamespace (
693 AcpiDmGetExternalMethodCount (
697 AcpiDmClearExternalList (
701 AcpiDmEmitExternals (
705 AcpiDmUnresolvedWarning (
709 AcpiDmGetExternalsFromFile (
721 AcpiDmDumpInteger16 (
726 AcpiDmDumpInteger32 (
731 AcpiDmDumpInteger64 (
736 AcpiDmResourceTemplate (
737 ACPI_OP_WALK_INFO *Info,
738 ACPI_PARSE_OBJECT *Op,
743 AcpiDmIsResourceTemplate (
744 ACPI_WALK_STATE *WalkState,
745 ACPI_PARSE_OBJECT *Op);
752 AcpiDmDescriptorName (
760 AcpiDmWordDescriptor (
761 AML_RESOURCE *Resource,
766 AcpiDmDwordDescriptor (
767 AML_RESOURCE *Resource,
772 AcpiDmExtendedDescriptor (
773 AML_RESOURCE *Resource,
778 AcpiDmQwordDescriptor (
779 AML_RESOURCE *Resource,
784 AcpiDmMemory24Descriptor (
785 AML_RESOURCE *Resource,
790 AcpiDmMemory32Descriptor (
791 AML_RESOURCE *Resource,
796 AcpiDmFixedMemory32Descriptor (
797 AML_RESOURCE *Resource,
802 AcpiDmGenericRegisterDescriptor (
803 AML_RESOURCE *Resource,
808 AcpiDmInterruptDescriptor (
809 AML_RESOURCE *Resource,
814 AcpiDmVendorLargeDescriptor (
815 AML_RESOURCE *Resource,
820 AcpiDmGpioDescriptor (
821 AML_RESOURCE *Resource,
826 AcpiDmSerialBusDescriptor (
827 AML_RESOURCE *Resource,
843 AcpiDmIrqDescriptor (
844 AML_RESOURCE *Resource,
849 AcpiDmDmaDescriptor (
850 AML_RESOURCE *Resource,
855 AcpiDmFixedDmaDescriptor (
856 AML_RESOURCE *Resource,
862 AML_RESOURCE *Resource,
867 AcpiDmFixedIoDescriptor (
868 AML_RESOURCE *Resource,
873 AcpiDmStartDependentDescriptor (
874 AML_RESOURCE *Resource,
879 AcpiDmEndDependentDescriptor (
880 AML_RESOURCE *Resource,
885 AcpiDmVendorSmallDescriptor (
886 AML_RESOURCE *Resource,
895 AcpiDmDecodeAttribute (
903 AcpiDmCommaIfListMember (
904 ACPI_PARSE_OBJECT *Op);
907 AcpiDmCommaIfFieldMember (
908 ACPI_PARSE_OBJECT *Op);
915 AcpiDmFindResources (
916 ACPI_PARSE_OBJECT *Root);
919 AcpiDmCheckResourceReference (
920 ACPI_PARSE_OBJECT *Op,
921 ACPI_WALK_STATE *WalkState);
928 AdDisassemblerHeader (
932 #endif /* __ACDISASM_H__ */