Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: acparser.h - AML Parser subcomponent prototypes and defines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
82a80941 | 8 | * Copyright (C) 2000 - 2015, 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 | ||
44f6c012 RM |
73 | /* |
74 | * psxface - Parser external interfaces | |
75 | */ | |
4119532c | 76 | acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info); |
1da177e4 | 77 | |
44f6c012 RM |
78 | /* |
79 | * psargs - Parse AML opcode arguments | |
80 | */ | |
4be44fcd | 81 | u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state); |
1da177e4 | 82 | |
4be44fcd | 83 | char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state); |
1da177e4 LT |
84 | |
85 | void | |
4be44fcd LB |
86 | acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state, |
87 | u32 arg_type, union acpi_parse_object *arg); | |
1da177e4 LT |
88 | |
89 | acpi_status | |
4be44fcd LB |
90 | acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state, |
91 | struct acpi_parse_state *parser_state, | |
92 | union acpi_parse_object *arg, u8 method_call); | |
1da177e4 | 93 | |
1da177e4 | 94 | acpi_status |
4be44fcd LB |
95 | acpi_ps_get_next_arg(struct acpi_walk_state *walk_state, |
96 | struct acpi_parse_state *parser_state, | |
97 | u32 arg_type, union acpi_parse_object **return_arg); | |
1da177e4 | 98 | |
44f6c012 RM |
99 | /* |
100 | * psfind | |
101 | */ | |
4be44fcd LB |
102 | union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope, |
103 | u32 name, u32 opcode); | |
1da177e4 | 104 | |
4be44fcd | 105 | union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op); |
1da177e4 | 106 | |
44f6c012 | 107 | /* |
42f8fb75 BM |
108 | * psobject - support for parse object processing |
109 | */ | |
110 | acpi_status | |
111 | acpi_ps_build_named_op(struct acpi_walk_state *walk_state, | |
112 | u8 *aml_op_start, | |
113 | union acpi_parse_object *unnamed_op, | |
114 | union acpi_parse_object **op); | |
115 | ||
116 | acpi_status | |
117 | acpi_ps_create_op(struct acpi_walk_state *walk_state, | |
118 | u8 *aml_op_start, union acpi_parse_object **new_op); | |
119 | ||
120 | acpi_status | |
121 | acpi_ps_complete_op(struct acpi_walk_state *walk_state, | |
122 | union acpi_parse_object **op, acpi_status status); | |
123 | ||
124 | acpi_status | |
125 | acpi_ps_complete_final_op(struct acpi_walk_state *walk_state, | |
126 | union acpi_parse_object *op, acpi_status status); | |
127 | ||
128 | /* | |
129 | * psopinfo - AML Opcode information | |
44f6c012 | 130 | */ |
4be44fcd | 131 | const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode); |
1da177e4 | 132 | |
4be44fcd | 133 | char *acpi_ps_get_opcode_name(u16 opcode); |
1da177e4 | 134 | |
4e3156b1 BM |
135 | u8 acpi_ps_get_argument_count(u32 op_type); |
136 | ||
44f6c012 RM |
137 | /* |
138 | * psparse - top level parsing routines | |
139 | */ | |
4be44fcd | 140 | acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state); |
1da177e4 | 141 | |
4be44fcd | 142 | u32 acpi_ps_get_opcode_size(u32 opcode); |
1da177e4 | 143 | |
4be44fcd | 144 | u16 acpi_ps_peek_opcode(struct acpi_parse_state *state); |
1da177e4 | 145 | |
73459f73 | 146 | acpi_status |
4be44fcd LB |
147 | acpi_ps_complete_this_op(struct acpi_walk_state *walk_state, |
148 | union acpi_parse_object *op); | |
73459f73 RM |
149 | |
150 | acpi_status | |
4be44fcd LB |
151 | acpi_ps_next_parse_state(struct acpi_walk_state *walk_state, |
152 | union acpi_parse_object *op, | |
153 | acpi_status callback_status); | |
73459f73 RM |
154 | |
155 | /* | |
156 | * psloop - main parse loop | |
157 | */ | |
4be44fcd | 158 | acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state); |
1da177e4 | 159 | |
44f6c012 RM |
160 | /* |
161 | * psscope - Scope stack management routines | |
162 | */ | |
1da177e4 | 163 | acpi_status |
4be44fcd LB |
164 | acpi_ps_init_scope(struct acpi_parse_state *parser_state, |
165 | union acpi_parse_object *root); | |
1da177e4 | 166 | |
4be44fcd LB |
167 | union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state |
168 | *state); | |
1da177e4 | 169 | |
4be44fcd | 170 | u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state); |
1da177e4 LT |
171 | |
172 | void | |
4be44fcd | 173 | acpi_ps_pop_scope(struct acpi_parse_state *parser_state, |
1f86e8c1 | 174 | union acpi_parse_object **op, u32 *arg_list, u32 *arg_count); |
1da177e4 LT |
175 | |
176 | acpi_status | |
4be44fcd LB |
177 | acpi_ps_push_scope(struct acpi_parse_state *parser_state, |
178 | union acpi_parse_object *op, | |
793c2388 | 179 | u32 remaining_args, u32 arg_count); |
1da177e4 | 180 | |
4be44fcd | 181 | void acpi_ps_cleanup_scope(struct acpi_parse_state *state); |
1da177e4 | 182 | |
44f6c012 RM |
183 | /* |
184 | * pstree - parse tree manipulation routines | |
185 | */ | |
1da177e4 | 186 | void |
4be44fcd | 187 | acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg); |
1da177e4 | 188 | |
4be44fcd LB |
189 | union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope, |
190 | char *path, u16 opcode, u32 create); | |
191 | ||
192 | union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn); | |
1da177e4 | 193 | |
4be44fcd LB |
194 | #ifdef ACPI_FUTURE_USAGE |
195 | union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin, | |
196 | union acpi_parse_object *op); | |
197 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 198 | |
44f6c012 RM |
199 | /* |
200 | * pswalk - parse tree walk routines | |
201 | */ | |
1da177e4 | 202 | acpi_status |
4be44fcd LB |
203 | acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op, |
204 | union acpi_parse_object *end_op, | |
205 | union acpi_operand_object *mth_desc, | |
206 | struct acpi_namespace_node *start_node, | |
207 | union acpi_operand_object **params, | |
208 | union acpi_operand_object **caller_return_desc, | |
209 | acpi_owner_id owner_id, | |
210 | acpi_parse_downwards descending_callback, | |
211 | acpi_parse_upwards ascending_callback); | |
1da177e4 LT |
212 | |
213 | acpi_status | |
4be44fcd LB |
214 | acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state, |
215 | union acpi_parse_object *op, | |
216 | acpi_parse_upwards ascending_callback); | |
1da177e4 | 217 | |
4be44fcd | 218 | acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state); |
1da177e4 | 219 | |
4be44fcd | 220 | void acpi_ps_delete_parse_tree(union acpi_parse_object *root); |
1da177e4 | 221 | |
44f6c012 RM |
222 | /* |
223 | * psutils - parser utilities | |
224 | */ | |
4be44fcd | 225 | union acpi_parse_object *acpi_ps_create_scope_op(void); |
1da177e4 | 226 | |
4be44fcd | 227 | void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode); |
1da177e4 | 228 | |
4be44fcd | 229 | union acpi_parse_object *acpi_ps_alloc_op(u16 opcode); |
1da177e4 | 230 | |
4be44fcd | 231 | void acpi_ps_free_op(union acpi_parse_object *op); |
1da177e4 | 232 | |
4be44fcd | 233 | u8 acpi_ps_is_leading_char(u32 c); |
1da177e4 | 234 | |
44f6c012 | 235 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd LB |
236 | u32 acpi_ps_get_name(union acpi_parse_object *op); |
237 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 238 | |
4be44fcd | 239 | void acpi_ps_set_name(union acpi_parse_object *op, u32 name); |
1da177e4 | 240 | |
44f6c012 RM |
241 | /* |
242 | * psdump - display parser tree | |
243 | */ | |
1da177e4 | 244 | u32 |
4be44fcd LB |
245 | acpi_ps_sprint_path(char *buffer_start, |
246 | u32 buffer_size, union acpi_parse_object *op); | |
1da177e4 LT |
247 | |
248 | u32 | |
4be44fcd LB |
249 | acpi_ps_sprint_op(char *buffer_start, |
250 | u32 buffer_size, union acpi_parse_object *op); | |
1da177e4 | 251 | |
4be44fcd | 252 | void acpi_ps_show(union acpi_parse_object *op); |
1da177e4 | 253 | |
4be44fcd | 254 | #endif /* __ACPARSER_H__ */ |