1 /******************************************************************************
3 * Module Name: aslcompiler.h - common include file for iASL
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 __ASLCOMPILER_H
45 #define __ASLCOMPILER_H
52 /* Microsoft-specific */
54 #if (defined WIN32 || defined WIN64)
56 /* warn : used #pragma pack */
57 #pragma warning(disable:4103)
59 /* warn : named type definition in parentheses */
60 #pragma warning(disable:4115)
70 /* Compiler headers */
72 #include "asldefine.h"
74 #include "aslmessages.h"
75 #include "aslglobal.h"
76 #include "preprocess.h"
79 /*******************************************************************************
83 ******************************************************************************/
86 * Main ASL parser - generated from flex/bison, lex/yacc, etc.
97 AslResetCurrentLineBuffer (
101 AslInsertLineBuffer (
105 AslPopInputFileStack (
109 AslPushInputFileStack (
119 * aslstartup - entered from main()
122 AslInitializeGlobals (
126 ACPI_STATUS (*ASL_PATHNAME_CALLBACK) (
134 AslCheckForErrorExit (
139 * aslcompile - compile mainline
146 AslCompilerFileHeader (
167 * aslascii - ascii support
170 FlIsFileAsciiSource (
172 BOOLEAN DisplayErrors);
176 * aslwalks - semantic analysis and parse tree walks
179 AnOtherSemanticAnalysisWalkBegin (
180 ACPI_PARSE_OBJECT *Op,
185 AnOtherSemanticAnalysisWalkEnd (
186 ACPI_PARSE_OBJECT *Op,
191 AnOperandTypecheckWalkEnd (
192 ACPI_PARSE_OBJECT *Op,
197 AnMethodTypingWalkEnd (
198 ACPI_PARSE_OBJECT *Op,
204 * aslmethod - Control method analysis walk
207 MtMethodAnalysisWalkBegin (
208 ACPI_PARSE_OBJECT *Op,
213 MtMethodAnalysisWalkEnd (
214 ACPI_PARSE_OBJECT *Op,
220 * aslbtypes - bitfield data types
223 AnMapObjTypeToBtype (
224 ACPI_PARSE_OBJECT *Op);
227 AnMapArgTypeToBtype (
232 ACPI_PARSE_OBJECT *Op);
241 * aslanalyze - Support functions for parse tree walks
245 ACPI_PARSE_OBJECT *Op,
248 /* Values for Type argument above */
250 #define ASL_TYPE_HID 0
251 #define ASL_TYPE_CID 1
255 ACPI_PARSE_OBJECT *Op);
258 AnGetInternalMethodReturnType (
259 ACPI_PARSE_OBJECT *Op);
262 AnLastStatementIsReturn (
263 ACPI_PARSE_OBJECT *Op);
266 AnCheckMethodReturnValue (
267 ACPI_PARSE_OBJECT *Op,
268 const ACPI_OPCODE_INFO *OpInfo,
269 ACPI_PARSE_OBJECT *ArgOp,
270 UINT32 RequiredBtypes,
271 UINT32 ThisNodeBtype);
275 ACPI_PARSE_OBJECT *Op);
278 ApCheckForGpeNameConflict (
279 ACPI_PARSE_OBJECT *Op);
283 ACPI_PARSE_OBJECT *Op);
288 ACPI_PARSE_OBJECT *Op);
292 * aslerror - error handling/reporting
302 ACPI_PARSE_OBJECT *Op,
306 AslDisableException (
307 char *MessageIdString);
310 AslIsExceptionDisabled (
315 AslCoreSubsystemError (
316 ACPI_PARSE_OBJECT *Op,
329 UINT32 CurrentLineNumber,
330 UINT32 LogicalLineNumber,
331 UINT32 LogicalByteOffset,
349 ASL_ERROR_MSG *Enode,
362 * asllisting - generate all "listing" type files
369 LsWriteNodeToAsmListing (
370 ACPI_PARSE_OBJECT *Op);
374 ACPI_PARSE_OBJECT *Op,
383 * asllistsup - Listing file support utilities
392 LsDumpAsciiInComment (
403 LsFlushListingBuffer (
407 LsWriteListingHexBytes (
415 UINT32 ToLogicalLineNumber,
419 LsWriteOneSourceLine (
432 * aslhex - generate all "hex" output files (C, ASM, ASL)
440 * aslfold - constant folding
444 ACPI_PARSE_OBJECT *Op,
450 * aslmessages - exception strings
457 AeDecodeExceptionLevel (
461 AeBuildFullExceptionCode (
466 * asloffset - generate C offset file for BIOS support
470 ACPI_PARSE_OBJECT *Op,
475 LsDoOffsetTableHeader (
479 LsDoOffsetTableFooter (
484 * aslopcodes - generate AML opcodes
488 ACPI_PARSE_OBJECT *Op,
493 OpcAmlOpcodeUpdateWalk (
494 ACPI_PARSE_OBJECT *Op,
499 OpcGenerateAmlOpcode (
500 ACPI_PARSE_OBJECT *Op);
503 OpcSetOptimalIntegerSize (
504 ACPI_PARSE_OBJECT *Op);
508 ACPI_PARSE_OBJECT *Op);
512 * asloperands - generate AML operands for the AML opcodes
516 ACPI_PARSE_OBJECT *Op,
520 OpnGenerateAmlOperands (
521 ACPI_PARSE_OBJECT *Op);
525 ACPI_PARSE_OBJECT *Op);
529 * aslopt - optmization
532 OptOptimizeNamePath (
533 ACPI_PARSE_OBJECT *Op,
535 ACPI_WALK_STATE *WalkState,
537 ACPI_NAMESPACE_NODE *TargetNode);
541 * aslprintf - Printf/Fprintf macros
545 ACPI_PARSE_OBJECT *Op);
549 ACPI_PARSE_OBJECT *Op);
553 * aslprune - parse tree pruner
562 * aslcodegen - code generation
565 CgGenerateAmlOutput (
580 * asllength - calculate/adjust AML package lengths
583 LnPackageLengthWalk (
584 ACPI_PARSE_OBJECT *Op,
590 ACPI_PARSE_OBJECT *Op,
595 CgGenerateAmlLengths (
596 ACPI_PARSE_OBJECT *Op);
600 * aslmap - opcode mappings and reserved method names
603 AslMapNamedOpcodeToDataType (
608 * aslpredef - ACPI predefined names support
611 ApCheckForPredefinedMethod (
612 ACPI_PARSE_OBJECT *Op,
613 ASL_METHOD_INFO *MethodInfo);
616 ApCheckPredefinedReturnValue (
617 ACPI_PARSE_OBJECT *Op,
618 ASL_METHOD_INFO *MethodInfo);
621 ApCheckForPredefinedName (
622 ACPI_PARSE_OBJECT *Op,
626 ApCheckForPredefinedObject (
627 ACPI_PARSE_OBJECT *Op,
632 const char *PredefinedName,
633 ACPI_PARSE_OBJECT *Op,
634 UINT32 ExpectedBtypes,
635 UINT32 PackageIndex);
638 ApDisplayReservedNames (
643 * aslprepkg - ACPI predefined names support for packages
647 ACPI_PARSE_OBJECT *ParentOp,
648 const ACPI_PREDEFINED_INFO *Predefined);
652 * asltransform - parse tree transformations
655 TrAmlTransformWalkBegin (
656 ACPI_PARSE_OBJECT *Op,
661 TrAmlTransformWalkEnd (
662 ACPI_PARSE_OBJECT *Op,
668 * asltree - parse tree support
672 ACPI_PARSE_OBJECT *Op,
674 ASL_WALK_CALLBACK DescendingCallback,
675 ASL_WALK_CALLBACK AscendingCallback,
679 * aslexternal - External opcode support
682 ExAmlExternalWalkBegin (
683 ACPI_PARSE_OBJECT *Op,
688 ExAmlExternalWalkEnd (
689 ACPI_PARSE_OBJECT *Op,
695 ACPI_PARSE_OBJECT *Op);
697 /* Values for "Visitation" parameter above */
699 #define ASL_WALK_VISIT_DOWNWARD 0x01
700 #define ASL_WALK_VISIT_UPWARD 0x02
701 #define ASL_WALK_VISIT_TWICE (ASL_WALK_VISIT_DOWNWARD | ASL_WALK_VISIT_UPWARD)
709 TrPrintNodeCompileFlags (
714 ACPI_PARSE_OBJECT *Op);
719 ACPI_PARSE_OBJECT *Op);
736 TrCreateAssignmentNode (
737 ACPI_PARSE_OBJECT *Target,
738 ACPI_PARSE_OBJECT *Source);
741 TrCreateTargetOperand (
742 ACPI_PARSE_OBJECT *OriginalOp,
743 ACPI_PARSE_OBJECT *ParentOp);
746 TrCreateValuedLeafNode (
751 TrCreateConstantLeafNode (
756 ACPI_PARSE_OBJECT *Op,
762 ACPI_PARSE_OBJECT *Op);
765 TrSetCurrentFilename (
766 ACPI_PARSE_OBJECT *Op);
774 ACPI_PARSE_OBJECT *Op1,
775 ACPI_PARSE_OBJECT *Op2);
779 ACPI_PARSE_OBJECT *Op1,
780 ACPI_PARSE_OBJECT *Op2);
784 ACPI_PARSE_OBJECT *Op,
789 ACPI_PARSE_OBJECT *Op,
799 * aslfiles - File I/O support
802 FlAddIncludeDirectory (
812 ACPI_PARSE_OBJECT *Op);
864 char *InputFilename);
867 FlOpenAmlOutputFile (
868 char *InputFilename);
871 FlOpenMiscOutputFiles (
872 char *InputFilename);
875 * aslhwmap - hardware map summary
883 * asload - load namespace in prep for cross reference
887 ACPI_PARSE_OBJECT *RootOp);
891 * asllookup - namespace lookup functions
894 LkFindUnreferencedObjects (
910 * aslnamesp - namespace output file generation
917 NsSetupNamespaceListing (
921 * asloptions - command line processing
929 * aslxref - namespace cross reference
932 XfCrossReferenceNamespace (
949 ACPI_PARSE_OBJECT *Op,
951 ASL_METHOD_INFO *MethodInfo);
955 * aslutils - common compiler utilites
963 /* Type values for above */
965 #define ASL_DEBUG_OUTPUT 0
966 #define ASL_PARSE_OUTPUT 1
967 #define ASL_TREE_OUTPUT 2
970 UtIsBigEndianMachine (
974 UtQueryForOverwrite (
979 ACPI_PARSE_OBJECT *Op,
984 ACPI_PARSE_OBJECT *Op,
986 UINT32 IntegerLength);
990 ACPI_PARSE_OBJECT *Op,
994 UtDisplaySupportedTables (
998 UtDisplayConstantOpcodes (
1018 UtConvertByteToHex (
1023 UtConvertByteToAsmHex (
1029 UINT32 ParseOpcode);
1033 ACPI_PARSE_OBJECT *Op);
1036 UtStringCacheCalloc (
1040 UtExpandLineBuffers (
1050 char **ConvertedName);
1053 UtAttachNamepathToOwner (
1054 ACPI_PARSE_OBJECT *Op,
1055 ACPI_PARSE_OBJECT *NameNode);
1058 UtCheckIntegerRange (
1059 ACPI_PARSE_OBJECT *Op,
1069 * asluuid - UUID support
1076 AuConvertUuidToString (
1081 * aslresource - Resource template generation utilities
1084 RsSmallAddressCheck (
1090 ACPI_PARSE_OBJECT *MinOp,
1091 ACPI_PARSE_OBJECT *MaxOp,
1092 ACPI_PARSE_OBJECT *LengthOp,
1093 ACPI_PARSE_OBJECT *AlignOp,
1094 ACPI_PARSE_OBJECT *Op);
1097 RsLargeAddressCheck (
1103 ACPI_PARSE_OBJECT *MinOp,
1104 ACPI_PARSE_OBJECT *MaxOp,
1105 ACPI_PARSE_OBJECT *LengthOp,
1106 ACPI_PARSE_OBJECT *GranOp,
1107 ACPI_PARSE_OBJECT *Op);
1110 RsGetStringDataLength (
1111 ACPI_PARSE_OBJECT *InitializerOp);
1114 RsAllocateResourceNode (
1118 RsCreateResourceField (
1119 ACPI_PARSE_OBJECT *Op,
1128 ACPI_PARSE_OBJECT *Op,
1135 ACPI_PARSE_OBJECT *Op,
1140 RsCompleteNodeAndGetNext (
1141 ACPI_PARSE_OBJECT *Op);
1144 RsCheckListForDuplicates (
1145 ACPI_PARSE_OBJECT *Op);
1148 RsDoOneResourceDescriptor (
1149 ASL_RESOURCE_INFO *Info,
1152 /* Values for State above */
1154 #define ACPI_RSTATE_NORMAL 0
1155 #define ACPI_RSTATE_START_DEPENDENT 1
1156 #define ACPI_RSTATE_DEPENDENT_LIST 2
1159 RsLinkDescriptorChain (
1160 ASL_RESOURCE_NODE **PreviousRnode,
1161 ASL_RESOURCE_NODE *Rnode);
1164 RsDoResourceTemplate (
1165 ACPI_PARSE_OBJECT *Op);
1169 * aslrestype1 - Miscellaneous Small descriptors
1172 RsDoEndTagDescriptor (
1173 ASL_RESOURCE_INFO *Info);
1176 RsDoEndDependentDescriptor (
1177 ASL_RESOURCE_INFO *Info);
1180 RsDoMemory24Descriptor (
1181 ASL_RESOURCE_INFO *Info);
1184 RsDoMemory32Descriptor (
1185 ASL_RESOURCE_INFO *Info);
1188 RsDoMemory32FixedDescriptor (
1189 ASL_RESOURCE_INFO *Info);
1192 RsDoStartDependentDescriptor (
1193 ASL_RESOURCE_INFO *Info);
1196 RsDoStartDependentNoPriDescriptor (
1197 ASL_RESOURCE_INFO *Info);
1200 RsDoVendorSmallDescriptor (
1201 ASL_RESOURCE_INFO *Info);
1205 * aslrestype1i - I/O-related Small descriptors
1209 ASL_RESOURCE_INFO *Info);
1212 RsDoFixedDmaDescriptor (
1213 ASL_RESOURCE_INFO *Info);
1216 RsDoFixedIoDescriptor (
1217 ASL_RESOURCE_INFO *Info);
1221 ASL_RESOURCE_INFO *Info);
1225 ASL_RESOURCE_INFO *Info);
1228 RsDoIrqNoFlagsDescriptor (
1229 ASL_RESOURCE_INFO *Info);
1233 * aslrestype2 - Large resource descriptors
1236 RsDoInterruptDescriptor (
1237 ASL_RESOURCE_INFO *Info);
1240 RsDoVendorLargeDescriptor (
1241 ASL_RESOURCE_INFO *Info);
1244 RsDoGeneralRegisterDescriptor (
1245 ASL_RESOURCE_INFO *Info);
1248 RsDoGpioIntDescriptor (
1249 ASL_RESOURCE_INFO *Info);
1252 RsDoGpioIoDescriptor (
1253 ASL_RESOURCE_INFO *Info);
1256 RsDoI2cSerialBusDescriptor (
1257 ASL_RESOURCE_INFO *Info);
1260 RsDoSpiSerialBusDescriptor (
1261 ASL_RESOURCE_INFO *Info);
1264 RsDoUartSerialBusDescriptor (
1265 ASL_RESOURCE_INFO *Info);
1268 * aslrestype2d - DWord address descriptors
1271 RsDoDwordIoDescriptor (
1272 ASL_RESOURCE_INFO *Info);
1275 RsDoDwordMemoryDescriptor (
1276 ASL_RESOURCE_INFO *Info);
1279 RsDoDwordSpaceDescriptor (
1280 ASL_RESOURCE_INFO *Info);
1284 * aslrestype2e - Extended address descriptors
1287 RsDoExtendedIoDescriptor (
1288 ASL_RESOURCE_INFO *Info);
1291 RsDoExtendedMemoryDescriptor (
1292 ASL_RESOURCE_INFO *Info);
1295 RsDoExtendedSpaceDescriptor (
1296 ASL_RESOURCE_INFO *Info);
1300 * aslrestype2q - QWord address descriptors
1303 RsDoQwordIoDescriptor (
1304 ASL_RESOURCE_INFO *Info);
1307 RsDoQwordMemoryDescriptor (
1308 ASL_RESOURCE_INFO *Info);
1311 RsDoQwordSpaceDescriptor (
1312 ASL_RESOURCE_INFO *Info);
1316 * aslrestype2w - Word address descriptors
1319 RsDoWordIoDescriptor (
1320 ASL_RESOURCE_INFO *Info);
1323 RsDoWordSpaceDescriptor (
1324 ASL_RESOURCE_INFO *Info);
1327 RsDoWordBusNumberDescriptor (
1328 ASL_RESOURCE_INFO *Info);
1332 * Entry to data table compiler subsystem
1342 #endif /* __ASLCOMPILER_H */