1 /******************************************************************************
3 * Name: acstruct.h - Internal structs
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acstruct.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
118 #ifndef __ACSTRUCT_H__
119 #define __ACSTRUCT_H__
122 /*****************************************************************************
124 * Tree walking typedefs and structs
126 ****************************************************************************/
130 * Walk state - current state of a parse tree walk. Used for both a leisurely stroll through
131 * the tree (for whatever reason), and for control method execution.
134 #define ACPI_NEXT_OP_DOWNWARD 1
135 #define ACPI_NEXT_OP_UPWARD 2
137 #define ACPI_WALK_NON_METHOD 0
138 #define ACPI_WALK_METHOD 1
139 #define ACPI_WALK_METHOD_RESTART 2
140 #define ACPI_WALK_CONST_REQUIRED 3
141 #define ACPI_WALK_CONST_OPTIONAL 4
143 typedef struct acpi_walk_state
145 UINT8 DataType; /* To differentiate various internal objs MUST BE FIRST!*/\
146 ACPI_OWNER_ID OwnerId; /* Owner of objects created during the walk */
147 BOOLEAN LastPredicate; /* Result of last predicate */
148 UINT8 CurrentResult; /* */
149 UINT8 NextOpInfo; /* Info about NextOp */
150 UINT8 NumOperands; /* Stack pointer for Operands[] array */
153 UINT16 Opcode; /* Current AML opcode */
156 UINT32 ArgCount; /* push for fixed or var args */
159 UINT32 MethodBreakpoint; /* For single stepping */
160 UINT32 UserBreakpoint; /* User AML breakpoint */
165 struct acpi_namespace_node Arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */
166 union acpi_operand_object **CallerReturnDesc;
167 ACPI_GENERIC_STATE *ControlState; /* List of control states (nested IFs) */
168 struct acpi_namespace_node LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
169 struct acpi_namespace_node *MethodCallNode; /* Called method Node*/
170 ACPI_PARSE_OBJECT *MethodCallOp; /* MethodCall Op if running a method */
171 union acpi_operand_object *MethodDesc; /* Method descriptor if running a method */
172 struct acpi_namespace_node *MethodNode; /* Method Node if running a method */
173 ACPI_PARSE_OBJECT *Op; /* Current parser op */
174 union acpi_operand_object *Operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
175 const ACPI_OPCODE_INFO *OpInfo; /* Info on current opcode */
176 ACPI_PARSE_OBJECT *Origin; /* Start of walk [Obsolete] */
177 union acpi_operand_object **Params;
178 ACPI_PARSE_STATE ParserState; /* Current state of parser */
179 union acpi_operand_object *ResultObj;
180 ACPI_GENERIC_STATE *Results; /* Stack of accumulated results */
181 union acpi_operand_object *ReturnDesc; /* Return object, if any */
182 ACPI_GENERIC_STATE *ScopeInfo; /* Stack of nested scopes */
184 ACPI_PARSE_OBJECT *PrevOp; /* Last op that was processed */
185 ACPI_PARSE_OBJECT *NextOp; /* next op to be processed */
186 ACPI_PARSE_DOWNWARDS DescendingCallback;
187 ACPI_PARSE_UPWARDS AscendingCallback;
188 ACPI_THREAD_STATE *Thread;
189 struct acpi_walk_state *Next; /* Next WalkState in list */
194 /* Info used by AcpiPsInitObjects */
196 typedef struct acpi_init_walk_info
200 UINT16 OpRegionCount;
209 ACPI_TABLE_DESC *TableDesc;
211 } ACPI_INIT_WALK_INFO;
214 /* Info used by AcpiNsInitializeDevices */
216 typedef struct acpi_device_walk_info
221 ACPI_TABLE_DESC *TableDesc;
223 } ACPI_DEVICE_WALK_INFO;
226 /* TBD: [Restructure] Merge with struct above */
228 typedef struct acpi_walk_info
238 #define ACPI_DISPLAY_SUMMARY 0
239 #define ACPI_DISPLAY_OBJECTS 1
241 typedef struct acpi_get_devices_info
243 ACPI_WALK_CALLBACK UserFunction;
247 } ACPI_GET_DEVICES_INFO;
250 typedef union acpi_aml_operands
252 ACPI_OPERAND_OBJECT *Operands[7];
256 ACPI_OBJECT_INTEGER *Type;
257 ACPI_OBJECT_INTEGER *Code;
258 ACPI_OBJECT_INTEGER *Argument;
264 ACPI_OPERAND_OBJECT *Source;
265 ACPI_OBJECT_INTEGER *Index;
266 ACPI_OPERAND_OBJECT *Target;
272 ACPI_OPERAND_OBJECT *Source;
273 ACPI_OBJECT_INTEGER *Index;
274 ACPI_OBJECT_INTEGER *Length;
275 ACPI_OPERAND_OBJECT *Target;