1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #ifndef __ACPARSER_H__
45 #define __ACPARSER_H__
47 #define OP_HAS_RETURN_VALUE 1
49 /* Variable number of arguments. This field must be 32 bits */
51 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
53 #define ACPI_PARSE_DELETE_TREE 0x0001
54 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
55 #define ACPI_PARSE_TREE_MASK 0x0001
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
62 #define ACPI_PARSE_DEFERRED_OP 0x0100
63 #define ACPI_PARSE_DISASSEMBLE 0x0200
65 /******************************************************************************
69 *****************************************************************************/
72 * psxface - Parser external interfaces
74 acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info);
77 * psargs - Parse AML opcode arguments
79 u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);
81 char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);
84 acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
85 u32 arg_type, union acpi_parse_object *arg);
88 acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
89 struct acpi_parse_state *parser_state,
90 union acpi_parse_object *arg, u8 method_call);
93 acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
94 struct acpi_parse_state *parser_state,
95 u32 arg_type, union acpi_parse_object **return_arg);
100 union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
101 u32 name, u32 opcode);
103 union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
106 * psopcode - AML Opcode information
108 const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
110 char *acpi_ps_get_opcode_name(u16 opcode);
112 u8 acpi_ps_get_argument_count(u32 op_type);
115 * psparse - top level parsing routines
117 acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
119 u32 acpi_ps_get_opcode_size(u32 opcode);
121 u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
124 acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
125 union acpi_parse_object *op);
128 acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
129 union acpi_parse_object *op,
130 acpi_status callback_status);
133 * psloop - main parse loop
135 acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
138 * psscope - Scope stack management routines
141 acpi_ps_init_scope(struct acpi_parse_state *parser_state,
142 union acpi_parse_object *root);
144 union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
147 u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
150 acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
151 union acpi_parse_object **op,
152 u32 * arg_list, u32 * arg_count);
155 acpi_ps_push_scope(struct acpi_parse_state *parser_state,
156 union acpi_parse_object *op,
157 u32 remaining_args, u32 arg_count);
159 void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
162 * pstree - parse tree manipulation routines
165 acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
167 union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
168 char *path, u16 opcode, u32 create);
170 union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
172 #ifdef ACPI_FUTURE_USAGE
173 union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
174 union acpi_parse_object *op);
175 #endif /* ACPI_FUTURE_USAGE */
178 * pswalk - parse tree walk routines
181 acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
182 union acpi_parse_object *end_op,
183 union acpi_operand_object *mth_desc,
184 struct acpi_namespace_node *start_node,
185 union acpi_operand_object **params,
186 union acpi_operand_object **caller_return_desc,
187 acpi_owner_id owner_id,
188 acpi_parse_downwards descending_callback,
189 acpi_parse_upwards ascending_callback);
192 acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
193 union acpi_parse_object *op,
194 acpi_parse_upwards ascending_callback);
196 acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
198 void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
201 * psutils - parser utilities
203 union acpi_parse_object *acpi_ps_create_scope_op(void);
205 void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
207 union acpi_parse_object *acpi_ps_alloc_op(u16 opcode);
209 void acpi_ps_free_op(union acpi_parse_object *op);
211 u8 acpi_ps_is_leading_char(u32 c);
213 u8 acpi_ps_is_prefix_char(u32 c);
215 #ifdef ACPI_FUTURE_USAGE
216 u32 acpi_ps_get_name(union acpi_parse_object *op);
217 #endif /* ACPI_FUTURE_USAGE */
219 void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
222 * psdump - display parser tree
225 acpi_ps_sprint_path(char *buffer_start,
226 u32 buffer_size, union acpi_parse_object *op);
229 acpi_ps_sprint_op(char *buffer_start,
230 u32 buffer_size, union acpi_parse_object *op);
232 void acpi_ps_show(union acpi_parse_object *op);
234 #endif /* __ACPARSER_H__ */