blob: b725d780d34dafec0ecd1d2166a30dd8c078d1f0 [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/*
Bob Moore77848132012-01-12 13:27:23 +08008 * Copyright (C) 2000 - 2012, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Bob Moore793c2382006-03-31 00:00:00 -050049/* Variable number of arguments. This field must be 32 bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Bob Moore793c2382006-03-31 00:00:00 -050051#define ACPI_VAR_ARGS ACPI_UINT32_MAX
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
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
Lin Ming7f0c8262009-08-13 14:03:15 +080065#define ACPI_PARSE_MODULE_LEVEL 0x0400
66
Robert Moore44f6c012005-04-18 22:49:35 -040067/******************************************************************************
68 *
69 * Parser interfaces
70 *
71 *****************************************************************************/
72
Robert Moore44f6c012005-04-18 22:49:35 -040073/*
74 * psxface - Parser external interfaces
75 */
Bob Moore41195322006-05-26 16:36:00 -040076acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Robert Moore44f6c012005-04-18 22:49:35 -040078/*
79 * psargs - Parse AML opcode arguments
80 */
Len Brown4be44fc2005-08-05 00:44:28 -040081u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Len Brown4be44fc2005-08-05 00:44:28 -040083char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85void
Len Brown4be44fc2005-08-05 00:44:28 -040086acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
87 u32 arg_type, union acpi_parse_object *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040090acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040095acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Robert Moore44f6c012005-04-18 22:49:35 -040099/*
100 * psfind
101 */
Len Brown4be44fc2005-08-05 00:44:28 -0400102union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
103 u32 name, u32 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Len Brown4be44fc2005-08-05 00:44:28 -0400105union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Robert Moore44f6c012005-04-18 22:49:35 -0400107/*
108 * psopcode - AML Opcode information
109 */
Len Brown4be44fc2005-08-05 00:44:28 -0400110const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Len Brown4be44fc2005-08-05 00:44:28 -0400112char *acpi_ps_get_opcode_name(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Bob Moore4e3156b2008-04-10 19:06:37 +0400114u8 acpi_ps_get_argument_count(u32 op_type);
115
Robert Moore44f6c012005-04-18 22:49:35 -0400116/*
117 * psparse - top level parsing routines
118 */
Len Brown4be44fc2005-08-05 00:44:28 -0400119acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Len Brown4be44fc2005-08-05 00:44:28 -0400121u32 acpi_ps_get_opcode_size(u32 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Len Brown4be44fc2005-08-05 00:44:28 -0400123u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Robert Moore73459f72005-06-24 00:00:00 -0400125acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400126acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
127 union acpi_parse_object *op);
Robert Moore73459f72005-06-24 00:00:00 -0400128
129acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400130acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
131 union acpi_parse_object *op,
132 acpi_status callback_status);
Robert Moore73459f72005-06-24 00:00:00 -0400133
134/*
135 * psloop - main parse loop
136 */
Len Brown4be44fc2005-08-05 00:44:28 -0400137acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Robert Moore44f6c012005-04-18 22:49:35 -0400139/*
140 * psscope - Scope stack management routines
141 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400143acpi_ps_init_scope(struct acpi_parse_state *parser_state,
144 union acpi_parse_object *root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Len Brown4be44fc2005-08-05 00:44:28 -0400146union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
147 *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Len Brown4be44fc2005-08-05 00:44:28 -0400149u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151void
Len Brown4be44fc2005-08-05 00:44:28 -0400152acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
Bob Moore793c2382006-03-31 00:00:00 -0500153 union acpi_parse_object **op,
154 u32 * arg_list, u32 * arg_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400157acpi_ps_push_scope(struct acpi_parse_state *parser_state,
158 union acpi_parse_object *op,
Bob Moore793c2382006-03-31 00:00:00 -0500159 u32 remaining_args, u32 arg_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Len Brown4be44fc2005-08-05 00:44:28 -0400161void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Robert Moore44f6c012005-04-18 22:49:35 -0400163/*
164 * pstree - parse tree manipulation routines
165 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166void
Len Brown4be44fc2005-08-05 00:44:28 -0400167acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Len Brown4be44fc2005-08-05 00:44:28 -0400169union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
170 char *path, u16 opcode, u32 create);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Len Brown4be44fc2005-08-05 00:44:28 -0400172union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Robert Moore44f6c012005-04-18 22:49:35 -0400174#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400175union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
176 union acpi_parse_object *op);
177#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Robert Moore44f6c012005-04-18 22:49:35 -0400179/*
180 * pswalk - parse tree walk routines
181 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400183acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
184 union acpi_parse_object *end_op,
185 union acpi_operand_object *mth_desc,
186 struct acpi_namespace_node *start_node,
187 union acpi_operand_object **params,
188 union acpi_operand_object **caller_return_desc,
189 acpi_owner_id owner_id,
190 acpi_parse_downwards descending_callback,
191 acpi_parse_upwards ascending_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400194acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
195 union acpi_parse_object *op,
196 acpi_parse_upwards ascending_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Len Brown4be44fc2005-08-05 00:44:28 -0400198acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Len Brown4be44fc2005-08-05 00:44:28 -0400200void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Robert Moore44f6c012005-04-18 22:49:35 -0400202/*
203 * psutils - parser utilities
204 */
Len Brown4be44fc2005-08-05 00:44:28 -0400205union acpi_parse_object *acpi_ps_create_scope_op(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Len Brown4be44fc2005-08-05 00:44:28 -0400207void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Len Brown4be44fc2005-08-05 00:44:28 -0400209union acpi_parse_object *acpi_ps_alloc_op(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Len Brown4be44fc2005-08-05 00:44:28 -0400211void acpi_ps_free_op(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Len Brown4be44fc2005-08-05 00:44:28 -0400213u8 acpi_ps_is_leading_char(u32 c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Len Brown4be44fc2005-08-05 00:44:28 -0400215u8 acpi_ps_is_prefix_char(u32 c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Robert Moore44f6c012005-04-18 22:49:35 -0400217#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400218u32 acpi_ps_get_name(union acpi_parse_object *op);
219#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Len Brown4be44fc2005-08-05 00:44:28 -0400221void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Robert Moore44f6c012005-04-18 22:49:35 -0400223/*
224 * psdump - display parser tree
225 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226u32
Len Brown4be44fc2005-08-05 00:44:28 -0400227acpi_ps_sprint_path(char *buffer_start,
228 u32 buffer_size, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230u32
Len Brown4be44fc2005-08-05 00:44:28 -0400231acpi_ps_sprint_op(char *buffer_start,
232 u32 buffer_size, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Len Brown4be44fc2005-08-05 00:44:28 -0400234void acpi_ps_show(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Len Brown4be44fc2005-08-05 00:44:28 -0400236#endif /* __ACPARSER_H__ */