blob: d352d40de1f3210ae66a1571ec73dd5afa857ed2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifndef __ACPARSER_H__
45#define __ACPARSER_H__
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define OP_HAS_RETURN_VALUE 1
48
49/* variable # arguments */
50
51#define ACPI_VAR_ARGS ACPI_UINT32_MAX
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#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
Robert Moore73459f72005-06-24 00:00:00 -040063#define ACPI_PARSE_DISASSEMBLE 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Robert Moore44f6c012005-04-18 22:49:35 -040065/******************************************************************************
66 *
67 * Parser interfaces
68 *
69 *****************************************************************************/
70
Robert Moore44f6c012005-04-18 22:49:35 -040071/*
72 * psxface - Parser external interfaces
73 */
Len Brown4be44fc2005-08-05 00:44:28 -040074acpi_status acpi_ps_execute_method(struct acpi_parameter_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Robert Moore44f6c012005-04-18 22:49:35 -040076/*
77 * psargs - Parse AML opcode arguments
78 */
Len Brown4be44fc2005-08-05 00:44:28 -040079u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Len Brown4be44fc2005-08-05 00:44:28 -040081char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83void
Len Brown4be44fc2005-08-05 00:44:28 -040084acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
85 u32 arg_type, union acpi_parse_object *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040088acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Linus Torvalds1da177e2005-04-16 15:20:36 -070092acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040093acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Robert Moore44f6c012005-04-18 22:49:35 -040097/*
98 * psfind
99 */
Len Brown4be44fc2005-08-05 00:44:28 -0400100union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
101 u32 name, u32 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Len Brown4be44fc2005-08-05 00:44:28 -0400103union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Robert Moore44f6c012005-04-18 22:49:35 -0400105/*
106 * psopcode - AML Opcode information
107 */
Len Brown4be44fc2005-08-05 00:44:28 -0400108const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Len Brown4be44fc2005-08-05 00:44:28 -0400110char *acpi_ps_get_opcode_name(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Robert Moore44f6c012005-04-18 22:49:35 -0400112/*
113 * psparse - top level parsing routines
114 */
Len Brown4be44fc2005-08-05 00:44:28 -0400115acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Len Brown4be44fc2005-08-05 00:44:28 -0400117u32 acpi_ps_get_opcode_size(u32 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Len Brown4be44fc2005-08-05 00:44:28 -0400119u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Robert Moore73459f72005-06-24 00:00:00 -0400121acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400122acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
123 union acpi_parse_object *op);
Robert Moore73459f72005-06-24 00:00:00 -0400124
125acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400126acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
127 union acpi_parse_object *op,
128 acpi_status callback_status);
Robert Moore73459f72005-06-24 00:00:00 -0400129
130/*
131 * psloop - main parse loop
132 */
Len Brown4be44fc2005-08-05 00:44:28 -0400133acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Robert Moore44f6c012005-04-18 22:49:35 -0400135/*
136 * psscope - Scope stack management routines
137 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400139acpi_ps_init_scope(struct acpi_parse_state *parser_state,
140 union acpi_parse_object *root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Len Brown4be44fc2005-08-05 00:44:28 -0400142union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
143 *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
Len Brown4be44fc2005-08-05 00:44:28 -0400145u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147void
Len Brown4be44fc2005-08-05 00:44:28 -0400148acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
149 union acpi_parse_object **op,
150 u32 * arg_list, u32 * arg_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400153acpi_ps_push_scope(struct acpi_parse_state *parser_state,
154 union acpi_parse_object *op,
155 u32 remaining_args, u32 arg_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Len Brown4be44fc2005-08-05 00:44:28 -0400157void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Robert Moore44f6c012005-04-18 22:49:35 -0400159/*
160 * pstree - parse tree manipulation routines
161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162void
Len Brown4be44fc2005-08-05 00:44:28 -0400163acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Len Brown4be44fc2005-08-05 00:44:28 -0400165union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
166 char *path, u16 opcode, u32 create);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Len Brown4be44fc2005-08-05 00:44:28 -0400168union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Robert Moore44f6c012005-04-18 22:49:35 -0400170#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400171union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
172 union acpi_parse_object *op);
173#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Robert Moore44f6c012005-04-18 22:49:35 -0400175/*
176 * pswalk - parse tree walk routines
177 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400179acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
180 union acpi_parse_object *end_op,
181 union acpi_operand_object *mth_desc,
182 struct acpi_namespace_node *start_node,
183 union acpi_operand_object **params,
184 union acpi_operand_object **caller_return_desc,
185 acpi_owner_id owner_id,
186 acpi_parse_downwards descending_callback,
187 acpi_parse_upwards ascending_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400190acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
191 union acpi_parse_object *op,
192 acpi_parse_upwards ascending_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Len Brown4be44fc2005-08-05 00:44:28 -0400194acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Len Brown4be44fc2005-08-05 00:44:28 -0400196void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Robert Moore44f6c012005-04-18 22:49:35 -0400198/*
199 * psutils - parser utilities
200 */
Len Brown4be44fc2005-08-05 00:44:28 -0400201union acpi_parse_object *acpi_ps_create_scope_op(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Len Brown4be44fc2005-08-05 00:44:28 -0400203void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Len Brown4be44fc2005-08-05 00:44:28 -0400205union acpi_parse_object *acpi_ps_alloc_op(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Len Brown4be44fc2005-08-05 00:44:28 -0400207void acpi_ps_free_op(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Len Brown4be44fc2005-08-05 00:44:28 -0400209u8 acpi_ps_is_leading_char(u32 c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Len Brown4be44fc2005-08-05 00:44:28 -0400211u8 acpi_ps_is_prefix_char(u32 c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Robert Moore44f6c012005-04-18 22:49:35 -0400213#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400214u32 acpi_ps_get_name(union acpi_parse_object *op);
215#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Len Brown4be44fc2005-08-05 00:44:28 -0400217void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Robert Moore44f6c012005-04-18 22:49:35 -0400219/*
220 * psdump - display parser tree
221 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222u32
Len Brown4be44fc2005-08-05 00:44:28 -0400223acpi_ps_sprint_path(char *buffer_start,
224 u32 buffer_size, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226u32
Len Brown4be44fc2005-08-05 00:44:28 -0400227acpi_ps_sprint_op(char *buffer_start,
228 u32 buffer_size, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Len Brown4be44fc2005-08-05 00:44:28 -0400230void acpi_ps_show(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Len Brown4be44fc2005-08-05 00:44:28 -0400232#endif /* __ACPARSER_H__ */