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