]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: acparser.h - AML Parser subcomponent prototypes and defines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 LT |
44 | #ifndef __ACPARSER_H__ |
45 | #define __ACPARSER_H__ | |
46 | ||
1da177e4 LT |
47 | #define OP_HAS_RETURN_VALUE 1 |
48 | ||
793c2388 | 49 | /* Variable number of arguments. This field must be 32 bits */ |
1da177e4 | 50 | |
793c2388 | 51 | #define ACPI_VAR_ARGS ACPI_UINT32_MAX |
1da177e4 | 52 | |
1da177e4 LT |
53 | #define ACPI_PARSE_DELETE_TREE 0x0001 |
54 | #define ACPI_PARSE_NO_TREE_DELETE 0x0000 | |
55 | #define ACPI_PARSE_TREE_MASK 0x0001 | |
56 | ||
57 | #define ACPI_PARSE_LOAD_PASS1 0x0010 | |
58 | #define ACPI_PARSE_LOAD_PASS2 0x0020 | |
59 | #define ACPI_PARSE_EXECUTE 0x0030 | |
60 | #define ACPI_PARSE_MODE_MASK 0x0030 | |
61 | ||
62 | #define ACPI_PARSE_DEFERRED_OP 0x0100 | |
73459f73 | 63 | #define ACPI_PARSE_DISASSEMBLE 0x0200 |
1da177e4 | 64 | |
7f0c826a LM |
65 | #define ACPI_PARSE_MODULE_LEVEL 0x0400 |
66 | ||
44f6c012 RM |
67 | /****************************************************************************** |
68 | * | |
69 | * Parser interfaces | |
70 | * | |
71 | *****************************************************************************/ | |
72 | ||
b0e01c72 BM |
73 | extern const u8 acpi_gbl_short_op_index[]; |
74 | extern const u8 acpi_gbl_long_op_index[]; | |
75 | ||
44f6c012 RM |
76 | /* |
77 | * psxface - Parser external interfaces | |
78 | */ | |
4119532c | 79 | acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info); |
1da177e4 | 80 | |
de56ba95 LZ |
81 | acpi_status acpi_ps_execute_table(struct acpi_evaluate_info *info); |
82 | ||
44f6c012 RM |
83 | /* |
84 | * psargs - Parse AML opcode arguments | |
85 | */ | |
4be44fcd | 86 | u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state); |
1da177e4 | 87 | |
4be44fcd | 88 | char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state); |
1da177e4 LT |
89 | |
90 | void | |
4be44fcd LB |
91 | acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state, |
92 | u32 arg_type, union acpi_parse_object *arg); | |
1da177e4 LT |
93 | |
94 | acpi_status | |
4be44fcd LB |
95 | acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state, |
96 | struct acpi_parse_state *parser_state, | |
89438f96 BM |
97 | union acpi_parse_object *arg, |
98 | u8 possible_method_call); | |
99 | ||
100 | /* Values for u8 above */ | |
101 | ||
102 | #define ACPI_NOT_METHOD_CALL FALSE | |
103 | #define ACPI_POSSIBLE_METHOD_CALL TRUE | |
1da177e4 | 104 | |
1da177e4 | 105 | acpi_status |
4be44fcd LB |
106 | acpi_ps_get_next_arg(struct acpi_walk_state *walk_state, |
107 | struct acpi_parse_state *parser_state, | |
108 | u32 arg_type, union acpi_parse_object **return_arg); | |
1da177e4 | 109 | |
44f6c012 RM |
110 | /* |
111 | * psfind | |
112 | */ | |
4be44fcd LB |
113 | union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope, |
114 | u32 name, u32 opcode); | |
1da177e4 | 115 | |
4be44fcd | 116 | union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op); |
1da177e4 | 117 | |
44f6c012 | 118 | /* |
42f8fb75 BM |
119 | * psobject - support for parse object processing |
120 | */ | |
121 | acpi_status | |
122 | acpi_ps_build_named_op(struct acpi_walk_state *walk_state, | |
123 | u8 *aml_op_start, | |
124 | union acpi_parse_object *unnamed_op, | |
125 | union acpi_parse_object **op); | |
126 | ||
127 | acpi_status | |
128 | acpi_ps_create_op(struct acpi_walk_state *walk_state, | |
129 | u8 *aml_op_start, union acpi_parse_object **new_op); | |
130 | ||
131 | acpi_status | |
132 | acpi_ps_complete_op(struct acpi_walk_state *walk_state, | |
133 | union acpi_parse_object **op, acpi_status status); | |
134 | ||
135 | acpi_status | |
136 | acpi_ps_complete_final_op(struct acpi_walk_state *walk_state, | |
137 | union acpi_parse_object *op, acpi_status status); | |
138 | ||
139 | /* | |
140 | * psopinfo - AML Opcode information | |
44f6c012 | 141 | */ |
4be44fcd | 142 | const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode); |
1da177e4 | 143 | |
0dfaaa3d | 144 | const char *acpi_ps_get_opcode_name(u16 opcode); |
1da177e4 | 145 | |
4e3156b1 BM |
146 | u8 acpi_ps_get_argument_count(u32 op_type); |
147 | ||
44f6c012 RM |
148 | /* |
149 | * psparse - top level parsing routines | |
150 | */ | |
4be44fcd | 151 | acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state); |
1da177e4 | 152 | |
4be44fcd | 153 | u32 acpi_ps_get_opcode_size(u32 opcode); |
1da177e4 | 154 | |
4be44fcd | 155 | u16 acpi_ps_peek_opcode(struct acpi_parse_state *state); |
1da177e4 | 156 | |
73459f73 | 157 | acpi_status |
4be44fcd LB |
158 | acpi_ps_complete_this_op(struct acpi_walk_state *walk_state, |
159 | union acpi_parse_object *op); | |
73459f73 RM |
160 | |
161 | acpi_status | |
4be44fcd LB |
162 | acpi_ps_next_parse_state(struct acpi_walk_state *walk_state, |
163 | union acpi_parse_object *op, | |
164 | acpi_status callback_status); | |
73459f73 RM |
165 | |
166 | /* | |
167 | * psloop - main parse loop | |
168 | */ | |
4be44fcd | 169 | acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state); |
1da177e4 | 170 | |
44f6c012 RM |
171 | /* |
172 | * psscope - Scope stack management routines | |
173 | */ | |
1da177e4 | 174 | acpi_status |
4be44fcd LB |
175 | acpi_ps_init_scope(struct acpi_parse_state *parser_state, |
176 | union acpi_parse_object *root); | |
1da177e4 | 177 | |
4be44fcd LB |
178 | union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state |
179 | *state); | |
1da177e4 | 180 | |
4be44fcd | 181 | u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state); |
1da177e4 LT |
182 | |
183 | void | |
4be44fcd | 184 | acpi_ps_pop_scope(struct acpi_parse_state *parser_state, |
1f86e8c1 | 185 | union acpi_parse_object **op, u32 *arg_list, u32 *arg_count); |
1da177e4 LT |
186 | |
187 | acpi_status | |
4be44fcd LB |
188 | acpi_ps_push_scope(struct acpi_parse_state *parser_state, |
189 | union acpi_parse_object *op, | |
793c2388 | 190 | u32 remaining_args, u32 arg_count); |
1da177e4 | 191 | |
4be44fcd | 192 | void acpi_ps_cleanup_scope(struct acpi_parse_state *state); |
1da177e4 | 193 | |
44f6c012 RM |
194 | /* |
195 | * pstree - parse tree manipulation routines | |
196 | */ | |
1da177e4 | 197 | void |
4be44fcd | 198 | acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg); |
1da177e4 | 199 | |
4be44fcd LB |
200 | union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope, |
201 | char *path, u16 opcode, u32 create); | |
202 | ||
203 | union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn); | |
1da177e4 | 204 | |
4be44fcd LB |
205 | union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin, |
206 | union acpi_parse_object *op); | |
1da177e4 | 207 | |
44f6c012 RM |
208 | /* |
209 | * pswalk - parse tree walk routines | |
210 | */ | |
1da177e4 | 211 | acpi_status |
4be44fcd LB |
212 | acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op, |
213 | union acpi_parse_object *end_op, | |
214 | union acpi_operand_object *mth_desc, | |
215 | struct acpi_namespace_node *start_node, | |
216 | union acpi_operand_object **params, | |
217 | union acpi_operand_object **caller_return_desc, | |
218 | acpi_owner_id owner_id, | |
219 | acpi_parse_downwards descending_callback, | |
220 | acpi_parse_upwards ascending_callback); | |
1da177e4 LT |
221 | |
222 | acpi_status | |
4be44fcd LB |
223 | acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state, |
224 | union acpi_parse_object *op, | |
225 | acpi_parse_upwards ascending_callback); | |
1da177e4 | 226 | |
4be44fcd | 227 | acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state); |
1da177e4 | 228 | |
4be44fcd | 229 | void acpi_ps_delete_parse_tree(union acpi_parse_object *root); |
1da177e4 | 230 | |
44f6c012 RM |
231 | /* |
232 | * psutils - parser utilities | |
233 | */ | |
62eb935b | 234 | union acpi_parse_object *acpi_ps_create_scope_op(u8 *aml); |
1da177e4 | 235 | |
4be44fcd | 236 | void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode); |
1da177e4 | 237 | |
62eb935b | 238 | union acpi_parse_object *acpi_ps_alloc_op(u16 opcode, u8 *aml); |
1da177e4 | 239 | |
4be44fcd | 240 | void acpi_ps_free_op(union acpi_parse_object *op); |
1da177e4 | 241 | |
4be44fcd | 242 | u8 acpi_ps_is_leading_char(u32 c); |
1da177e4 | 243 | |
4be44fcd | 244 | u32 acpi_ps_get_name(union acpi_parse_object *op); |
1da177e4 | 245 | |
4be44fcd | 246 | void acpi_ps_set_name(union acpi_parse_object *op, u32 name); |
1da177e4 | 247 | |
44f6c012 RM |
248 | /* |
249 | * psdump - display parser tree | |
250 | */ | |
1da177e4 | 251 | u32 |
4be44fcd LB |
252 | acpi_ps_sprint_path(char *buffer_start, |
253 | u32 buffer_size, union acpi_parse_object *op); | |
1da177e4 LT |
254 | |
255 | u32 | |
4be44fcd LB |
256 | acpi_ps_sprint_op(char *buffer_start, |
257 | u32 buffer_size, union acpi_parse_object *op); | |
1da177e4 | 258 | |
4be44fcd | 259 | void acpi_ps_show(union acpi_parse_object *op); |
1da177e4 | 260 | |
4be44fcd | 261 | #endif /* __ACPARSER_H__ */ |