blob: c97843f6bcbc2302485985478d863173ff8907e8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acstruct.h - Internal structs
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#ifndef __ACSTRUCT_H__
45#define __ACSTRUCT_H__
46
47
48/*****************************************************************************
49 *
50 * Tree walking typedefs and structs
51 *
52 ****************************************************************************/
53
54
55/*
56 * Walk state - current state of a parse tree walk. Used for both a leisurely stroll through
57 * the tree (for whatever reason), and for control method execution.
58 */
59
60#define ACPI_NEXT_OP_DOWNWARD 1
61#define ACPI_NEXT_OP_UPWARD 2
62
63#define ACPI_WALK_NON_METHOD 0
64#define ACPI_WALK_METHOD 1
65#define ACPI_WALK_METHOD_RESTART 2
66#define ACPI_WALK_CONST_REQUIRED 3
67#define ACPI_WALK_CONST_OPTIONAL 4
68
69struct acpi_walk_state
70{
71 u8 data_type; /* To differentiate various internal objs MUST BE FIRST!*/\
72 u8 walk_type;
73 acpi_owner_id owner_id; /* Owner of objects created during the walk */
74 u8 last_predicate; /* Result of last predicate */
75 u8 reserved; /* For alignment */
76 u8 current_result; /* */
77 u8 next_op_info; /* Info about next_op */
78 u8 num_operands; /* Stack pointer for Operands[] array */
79 u8 return_used;
80 u16 opcode; /* Current AML opcode */
81 u8 scope_depth;
82 u8 reserved1;
83 u32 arg_count; /* push for fixed or var args */
84 u32 aml_offset;
85 u32 arg_types;
86 u32 method_breakpoint; /* For single stepping */
87 u32 user_breakpoint; /* User AML breakpoint */
88 u32 parse_flags;
89 u32 prev_arg_types;
90
91 u8 *aml_last_while;
92 struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */
93 union acpi_operand_object **caller_return_desc;
94 union acpi_generic_state *control_state; /* List of control states (nested IFs) */
95 struct acpi_namespace_node *deferred_node; /* Used when executing deferred opcodes */
96 struct acpi_gpe_event_info *gpe_event_info; /* Info for GPE (_Lxx/_Exx methods only */
97 union acpi_operand_object *implicit_return_obj;
98 struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
99 struct acpi_namespace_node *method_call_node; /* Called method Node*/
100 union acpi_parse_object *method_call_op; /* method_call Op if running a method */
101 union acpi_operand_object *method_desc; /* Method descriptor if running a method */
102 struct acpi_namespace_node *method_node; /* Method node if running a method. */
103 union acpi_parse_object *op; /* Current parser op */
104 union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
105 const struct acpi_opcode_info *op_info; /* Info on current opcode */
106 union acpi_parse_object *origin; /* Start of walk [Obsolete] */
107 union acpi_operand_object **params;
108 struct acpi_parse_state parser_state; /* Current state of parser */
109 union acpi_operand_object *result_obj;
110 union acpi_generic_state *results; /* Stack of accumulated results */
111 union acpi_operand_object *return_desc; /* Return object, if any */
112 union acpi_generic_state *scope_info; /* Stack of nested scopes */
113
114 union acpi_parse_object *prev_op; /* Last op that was processed */
115 union acpi_parse_object *next_op; /* next op to be processed */
116 acpi_parse_downwards descending_callback;
117 acpi_parse_upwards ascending_callback;
118 struct acpi_thread_state *thread;
119 struct acpi_walk_state *next; /* Next walk_state in list */
120};
121
122
123/* Info used by acpi_ps_init_objects */
124
125struct acpi_init_walk_info
126{
127 u16 method_count;
128 u16 device_count;
129 u16 op_region_count;
130 u16 field_count;
131 u16 buffer_count;
132 u16 package_count;
133 u16 op_region_init;
134 u16 field_init;
135 u16 buffer_init;
136 u16 package_init;
137 u16 object_count;
138 struct acpi_table_desc *table_desc;
139};
140
141
142/* Info used by acpi_ns_initialize_devices */
143
144struct acpi_device_walk_info
145{
146 u16 device_count;
147 u16 num_STA;
148 u16 num_INI;
149 struct acpi_table_desc *table_desc;
150};
151
152
153/* TBD: [Restructure] Merge with struct above */
154
155struct acpi_walk_info
156{
157 u32 debug_level;
158 u32 owner_id;
159 u8 display_type;
160};
161
162/* Display Types */
163
164#define ACPI_DISPLAY_SUMMARY 0
165#define ACPI_DISPLAY_OBJECTS 1
166
167struct acpi_get_devices_info
168{
169 acpi_walk_callback user_function;
170 void *context;
171 char *hid;
172};
173
174
175union acpi_aml_operands
176{
177 union acpi_operand_object *operands[7];
178
179 struct
180 {
181 struct acpi_object_integer *type;
182 struct acpi_object_integer *code;
183 struct acpi_object_integer *argument;
184
185 } fatal;
186
187 struct
188 {
189 union acpi_operand_object *source;
190 struct acpi_object_integer *index;
191 union acpi_operand_object *target;
192
193 } index;
194
195 struct
196 {
197 union acpi_operand_object *source;
198 struct acpi_object_integer *index;
199 struct acpi_object_integer *length;
200 union acpi_operand_object *target;
201
202 } mid;
203};
204
205
206/* Internal method parameter list */
207
208struct acpi_parameter_info
209{
210 struct acpi_namespace_node *node;
211 union acpi_operand_object **parameters;
212 union acpi_operand_object *return_object;
213 u8 parameter_type;
214 u8 return_object_type;
215};
216
217/* Types for parameter_type above */
218
219#define ACPI_PARAM_ARGS 0
220#define ACPI_PARAM_GPE 1
221
222
223#endif