1 /******************************************************************************
2  *
3  * Name: acstruct.h - Internal structs
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2004, 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 
69 struct acpi_walk_state
70 {
71 	u8                                  data_type;                          /* To differentiate various internal objs MUST BE FIRST!*/\
72 	acpi_owner_id                       owner_id;                           /* Owner of objects created during the walk */
73 	u8                                  last_predicate;                     /* Result of last predicate */
74 	u8                                  current_result;                     /* */
75 	u8                                  next_op_info;                       /* Info about next_op */
76 	u8                                  num_operands;                       /* Stack pointer for Operands[] array */
77 	u8                                  return_used;
78 	u8                                  walk_type;
79 	u16                                 opcode;                             /* Current AML opcode */
80 	u8                                  scope_depth;
81 	u8                                  reserved1;
82 	u32                                 arg_count;                          /* push for fixed or var args */
83 	u32                                 aml_offset;
84 	u32                                 arg_types;
85 	u32                                 method_breakpoint;                  /* For single stepping */
86 	u32                                 user_breakpoint;                    /* User AML breakpoint */
87 	u32                                 parse_flags;
88 	u32                                 prev_arg_types;
89 
90 	u8                                  *aml_last_while;
91 	struct acpi_namespace_node          arguments[ACPI_METHOD_NUM_ARGS];    /* Control method arguments */
92 	union acpi_operand_object           **caller_return_desc;
93 	union acpi_generic_state            *control_state;                     /* List of control states (nested IFs) */
94 	struct acpi_namespace_node          *deferred_node;                      /* Used when executing deferred opcodes */
95 	struct acpi_namespace_node          local_variables[ACPI_METHOD_NUM_LOCALS];    /* Control method locals */
96 	struct acpi_namespace_node          *method_call_node;                  /* Called method Node*/
97 	union acpi_parse_object             *method_call_op;                    /* method_call Op if running a method */
98 	union acpi_operand_object           *method_desc;                       /* Method descriptor if running a method */
99 	struct acpi_namespace_node          *method_node;                       /* Method node if running a method. */
100 	union acpi_parse_object             *op;                                /* Current parser op */
101 	union acpi_operand_object           *operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
102 	const struct acpi_opcode_info       *op_info;                           /* Info on current opcode */
103 	union acpi_parse_object             *origin;                            /* Start of walk [Obsolete] */
104 	union acpi_operand_object           **params;
105 	struct acpi_parse_state             parser_state;                       /* Current state of parser */
106 	union acpi_operand_object           *result_obj;
107 	union acpi_generic_state            *results;                           /* Stack of accumulated results */
108 	union acpi_operand_object           *return_desc;                       /* Return object, if any */
109 	union acpi_generic_state            *scope_info;                        /* Stack of nested scopes */
110 
111 	union acpi_parse_object             *prev_op;                           /* Last op that was processed */
112 	union acpi_parse_object             *next_op;                           /* next op to be processed */
113 	acpi_parse_downwards                descending_callback;
114 	acpi_parse_upwards                  ascending_callback;
115 	struct acpi_thread_state            *thread;
116 	struct acpi_walk_state              *next;                              /* Next walk_state in list */
117 };
118 
119 
120 /* Info used by acpi_ps_init_objects */
121 
122 struct acpi_init_walk_info
123 {
124 	u16                             method_count;
125 	u16                             device_count;
126 	u16                             op_region_count;
127 	u16                             field_count;
128 	u16                             buffer_count;
129 	u16                             package_count;
130 	u16                             op_region_init;
131 	u16                             field_init;
132 	u16                             buffer_init;
133 	u16                             package_init;
134 	u16                             object_count;
135 	struct acpi_table_desc          *table_desc;
136 };
137 
138 
139 /* Info used by acpi_ns_initialize_devices */
140 
141 struct acpi_device_walk_info
142 {
143 	u16                             device_count;
144 	u16                             num_STA;
145 	u16                             num_INI;
146 	struct acpi_table_desc          *table_desc;
147 };
148 
149 
150 /* TBD: [Restructure] Merge with struct above */
151 
152 struct acpi_walk_info
153 {
154 	u32                             debug_level;
155 	u32                             owner_id;
156 	u8                              display_type;
157 };
158 
159 /* Display Types */
160 
161 #define ACPI_DISPLAY_SUMMARY    0
162 #define ACPI_DISPLAY_OBJECTS    1
163 
164 struct acpi_get_devices_info
165 {
166 	acpi_walk_callback              user_function;
167 	void                            *context;
168 	char                            *hid;
169 };
170 
171 
172 union acpi_aml_operands
173 {
174 	union acpi_operand_object           *operands[7];
175 
176 	struct
177 	{
178 		struct acpi_object_integer      *type;
179 		struct acpi_object_integer      *code;
180 		struct acpi_object_integer      *argument;
181 
182 	} fatal;
183 
184 	struct
185 	{
186 		union acpi_operand_object       *source;
187 		struct acpi_object_integer      *index;
188 		union acpi_operand_object       *target;
189 
190 	} index;
191 
192 	struct
193 	{
194 		union acpi_operand_object       *source;
195 		struct acpi_object_integer      *index;
196 		struct acpi_object_integer      *length;
197 		union acpi_operand_object       *target;
198 
199 	} mid;
200 };
201 
202 
203 #endif
204