2 /******************************************************************************
4 * Module Name: aslcompiler.h - common include file for iASL
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #ifndef __ASLCOMPILER_H
119 #define __ASLCOMPILER_H
122 /* Microsoft-specific */
124 #if (defined WIN32 || defined WIN64)
126 /* warn : used #pragma pack */
127 #pragma warning(disable:4103)
129 /* warn : named type definition in parentheses */
130 #pragma warning(disable:4115)
142 #include "accommon.h"
143 #include "amlresrc.h"
146 /* Compiler headers */
148 #include "asldefine.h"
149 #include "asltypes.h"
150 #include "aslglobal.h"
153 /*******************************************************************************
155 * Compiler prototypes
157 ******************************************************************************/
160 * parser - generated from flex/bison, lex/yacc, etc.
175 ResetCurrentLineBuffer (
183 AslPopInputFileStack (
187 AslPushInputFileStack (
192 * aslstartup - called from main
203 * aslcompile - compile mainline
210 AslCompilerFileHeader (
227 * aslanalyze - semantic analysis
230 AnOtherSemanticAnalysisWalkBegin (
231 ACPI_PARSE_OBJECT *Op,
236 AnOtherSemanticAnalysisWalkEnd (
237 ACPI_PARSE_OBJECT *Op,
242 AnOperandTypecheckWalkBegin (
243 ACPI_PARSE_OBJECT *Op,
248 AnOperandTypecheckWalkEnd (
249 ACPI_PARSE_OBJECT *Op,
254 AnMethodAnalysisWalkBegin (
255 ACPI_PARSE_OBJECT *Op,
260 AnMethodAnalysisWalkEnd (
261 ACPI_PARSE_OBJECT *Op,
266 AnMethodTypingWalkBegin (
267 ACPI_PARSE_OBJECT *Op,
272 AnMethodTypingWalkEnd (
273 ACPI_PARSE_OBJECT *Op,
279 * aslerror - error handling/reporting
285 ACPI_PARSE_OBJECT *Op,
289 AslCoreSubsystemError (
290 ACPI_PARSE_OBJECT *Op,
303 UINT32 CurrentLineNumber,
304 UINT32 LogicalLineNumber,
305 UINT32 LogicalByteOffset,
313 ASL_ERROR_MSG *Enode,
324 ACPI_PHYSICAL_ADDRESS
325 AeLocalGetRootPointer (
330 * asllisting - generate all "listing" type files
337 LsWriteNodeToAsmListing (
338 ACPI_PARSE_OBJECT *Op);
342 ACPI_PARSE_OBJECT *Op,
354 * aslfold - constant folding
358 ACPI_PARSE_OBJECT *Op,
364 * aslopcodes - generate AML opcodes
368 ACPI_PARSE_OBJECT *Op,
373 OpcAmlOpcodeUpdateWalk (
374 ACPI_PARSE_OBJECT *Op,
379 OpcGenerateAmlOpcode (
380 ACPI_PARSE_OBJECT *Op);
383 OpcSetOptimalIntegerSize (
384 ACPI_PARSE_OBJECT *Op);
388 ACPI_PARSE_OBJECT *Op);
392 * asloperands - generate AML operands for the AML opcodes
396 ACPI_PARSE_OBJECT *Op,
400 OpnGenerateAmlOperands (
401 ACPI_PARSE_OBJECT *Op);
405 ACPI_PARSE_OBJECT *Op);
409 * aslopt - optmization
412 OptOptimizeNamePath (
413 ACPI_PARSE_OBJECT *Op,
415 ACPI_WALK_STATE *WalkState,
417 ACPI_NAMESPACE_NODE *TargetNode);
421 * aslcodegen - code generation
424 CgGenerateAmlOutput (
429 * asllength - calculate/adjust AML package lengths
432 LnPackageLengthWalk (
433 ACPI_PARSE_OBJECT *Op,
439 ACPI_PARSE_OBJECT *Op,
444 CgGenerateAmlLengths (
445 ACPI_PARSE_OBJECT *Op);
449 * aslmap - opcode mappings and reserved method names
452 AslMapNamedOpcodeToDataType (
457 * aslpredef - ACPI predefined names support
460 ApCheckForPredefinedMethod (
461 ACPI_PARSE_OBJECT *Op,
462 ASL_METHOD_INFO *MethodInfo);
465 ApCheckPredefinedReturnValue (
466 ACPI_PARSE_OBJECT *Op,
467 ASL_METHOD_INFO *MethodInfo);
470 ApCheckForPredefinedName (
471 ACPI_PARSE_OBJECT *Op,
475 ApCheckForPredefinedObject (
476 ACPI_PARSE_OBJECT *Op,
480 ApDisplayReservedNames (
485 * asltransform - parse tree transformations
489 ACPI_PARSE_OBJECT *Op,
495 * asltree - parse tree support
499 ACPI_PARSE_OBJECT *Op,
501 ASL_WALK_CALLBACK DescendingCallback,
502 ASL_WALK_CALLBACK AscendingCallback,
505 /* Values for "Visitation" parameter above */
507 #define ASL_WALK_VISIT_DOWNWARD 0x01
508 #define ASL_WALK_VISIT_UPWARD 0x02
509 #define ASL_WALK_VISIT_TWICE (ASL_WALK_VISIT_DOWNWARD | ASL_WALK_VISIT_UPWARD)
518 ACPI_PARSE_OBJECT *Op);
523 ACPI_PARSE_OBJECT *Op);
536 TrCreateValuedLeafNode (
542 ACPI_PARSE_OBJECT *Op,
548 ACPI_PARSE_OBJECT *Op);
556 ACPI_PARSE_OBJECT *Op1,
557 ACPI_PARSE_OBJECT *Op2);
561 ACPI_PARSE_OBJECT *Op1,
562 ACPI_PARSE_OBJECT *Op2);
566 ACPI_PARSE_OBJECT *Op,
576 * aslfiles - File I/O support
583 FlAddIncludeDirectory (
588 ACPI_PARSE_OBJECT *Op);
624 ACPI_PARSE_OBJECT *Op);
628 char *InputFilename);
631 FlOpenAmlOutputFile (
632 char *InputFilename);
635 FlOpenMiscOutputFiles (
636 char *InputFilename);
640 * asload - load namespace in prep for cross reference
644 ACPI_PARSE_OBJECT *RootOp);
648 * asllookup - namespace cross reference
651 LkCrossReferenceNamespace (
655 LkFindUnreferencedObjects (
664 * aslutils - common compiler utilites
672 /* Type values for above */
674 #define ASL_DEBUG_OUTPUT 0
675 #define ASL_PARSE_OUTPUT 1
676 #define ASL_TREE_OUTPUT 2
679 UtDisplayConstantOpcodes (
695 UtPrintFormattedName (
713 UtConvertByteToAsmHex (
723 ACPI_PARSE_OBJECT *Op);
732 char **ConvertedName);
735 UtAttachNamepathToOwner (
736 ACPI_PARSE_OBJECT *Op,
737 ACPI_PARSE_OBJECT *NameNode);
740 UtCheckIntegerRange (
741 ACPI_PARSE_OBJECT *Op,
751 * aslresource - Resource template generation utilities
754 RsAllocateResourceNode (
759 ACPI_PARSE_OBJECT *Op,
766 ACPI_PARSE_OBJECT *Op,
773 ACPI_PARSE_OBJECT *Op,
778 RsCompleteNodeAndGetNext (
779 ACPI_PARSE_OBJECT *Op);
782 RsCheckListForDuplicates (
783 ACPI_PARSE_OBJECT *Op);
786 RsDoOneResourceDescriptor (
787 ACPI_PARSE_OBJECT *DescriptorTypeOp,
788 UINT32 CurrentByteOffset,
791 /* Values for State above */
793 #define ACPI_RSTATE_NORMAL 0
794 #define ACPI_RSTATE_START_DEPENDENT 1
795 #define ACPI_RSTATE_DEPENDENT_LIST 2
798 RsLinkDescriptorChain (
799 ASL_RESOURCE_NODE **PreviousRnode,
800 ASL_RESOURCE_NODE *Rnode);
803 RsDoResourceTemplate (
804 ACPI_PARSE_OBJECT *Op);
808 * aslrestype1 - generate Small descriptors
811 RsDoEndTagDescriptor (
812 ACPI_PARSE_OBJECT *Op,
813 UINT32 CurrentByteOffset);
817 ACPI_PARSE_OBJECT *Op,
818 UINT32 CurrentByteOffset);
821 RsDoEndDependentDescriptor (
822 ACPI_PARSE_OBJECT *Op,
823 UINT32 CurrentByteOffset);
826 RsDoFixedIoDescriptor (
827 ACPI_PARSE_OBJECT *Op,
828 UINT32 CurrentByteOffset);
832 ACPI_PARSE_OBJECT *Op,
833 UINT32 CurrentByteOffset);
837 ACPI_PARSE_OBJECT *Op,
838 UINT32 CurrentByteOffset);
841 RsDoIrqNoFlagsDescriptor (
842 ACPI_PARSE_OBJECT *Op,
843 UINT32 CurrentByteOffset);
846 RsDoMemory24Descriptor (
847 ACPI_PARSE_OBJECT *Op,
848 UINT32 CurrentByteOffset);
851 RsDoMemory32Descriptor (
852 ACPI_PARSE_OBJECT *Op,
853 UINT32 CurrentByteOffset);
856 RsDoMemory32FixedDescriptor (
857 ACPI_PARSE_OBJECT *Op,
858 UINT32 CurrentByteOffset);
861 RsDoStartDependentDescriptor (
862 ACPI_PARSE_OBJECT *Op,
863 UINT32 CurrentByteOffset);
866 RsDoStartDependentNoPriDescriptor (
867 ACPI_PARSE_OBJECT *Op,
868 UINT32 CurrentByteOffset);
871 RsDoVendorSmallDescriptor (
872 ACPI_PARSE_OBJECT *Op,
873 UINT32 CurrentByteOffset);
877 * aslrestype2 - generate Large descriptors
880 RsDoInterruptDescriptor (
881 ACPI_PARSE_OBJECT *Op,
882 UINT32 CurrentByteOffset);
885 RsDoDwordIoDescriptor (
886 ACPI_PARSE_OBJECT *Op,
887 UINT32 CurrentByteOffset);
890 RsDoDwordMemoryDescriptor (
891 ACPI_PARSE_OBJECT *Op,
892 UINT32 CurrentByteOffset);
895 RsDoDwordSpaceDescriptor (
896 ACPI_PARSE_OBJECT *Op,
897 UINT32 CurrentByteOffset);
900 RsDoExtendedIoDescriptor (
901 ACPI_PARSE_OBJECT *Op,
902 UINT32 CurrentByteOffset);
905 RsDoExtendedMemoryDescriptor (
906 ACPI_PARSE_OBJECT *Op,
907 UINT32 CurrentByteOffset);
910 RsDoExtendedSpaceDescriptor (
911 ACPI_PARSE_OBJECT *Op,
912 UINT32 CurrentByteOffset);
915 RsDoQwordIoDescriptor (
916 ACPI_PARSE_OBJECT *Op,
917 UINT32 CurrentByteOffset);
920 RsDoQwordMemoryDescriptor (
921 ACPI_PARSE_OBJECT *Op,
922 UINT32 CurrentByteOffset);
925 RsDoQwordSpaceDescriptor (
926 ACPI_PARSE_OBJECT *Op,
927 UINT32 CurrentByteOffset);
930 RsDoWordIoDescriptor (
931 ACPI_PARSE_OBJECT *Op,
932 UINT32 CurrentByteOffset);
935 RsDoWordSpaceDescriptor (
936 ACPI_PARSE_OBJECT *Op,
937 UINT32 CurrentByteOffset);
940 RsDoWordBusNumberDescriptor (
941 ACPI_PARSE_OBJECT *Op,
942 UINT32 CurrentByteOffset);
945 RsDoVendorLargeDescriptor (
946 ACPI_PARSE_OBJECT *Op,
947 UINT32 CurrentByteOffset);
950 RsDoGeneralRegisterDescriptor (
951 ACPI_PARSE_OBJECT *Op,
952 UINT32 CurrentByteOffset);
954 #endif /* __ASLCOMPILER_H */