blob: aed319318835f3c9b47a53acbb9618da37629c83 [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 Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, 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/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100108 * psobject - support for parse object processing
109 */
110acpi_status
111acpi_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
116acpi_status
117acpi_ps_create_op(struct acpi_walk_state *walk_state,
118 u8 *aml_op_start, union acpi_parse_object **new_op);
119
120acpi_status
121acpi_ps_complete_op(struct acpi_walk_state *walk_state,
122 union acpi_parse_object **op, acpi_status status);
123
124acpi_status
125acpi_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
Robert Moore44f6c012005-04-18 22:49:35 -0400130 */
Len Brown4be44fc2005-08-05 00:44:28 -0400131const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Len Brown4be44fc2005-08-05 00:44:28 -0400133char *acpi_ps_get_opcode_name(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Bob Moore4e3156b2008-04-10 19:06:37 +0400135u8 acpi_ps_get_argument_count(u32 op_type);
136
Robert Moore44f6c012005-04-18 22:49:35 -0400137/*
138 * psparse - top level parsing routines
139 */
Len Brown4be44fc2005-08-05 00:44:28 -0400140acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Len Brown4be44fc2005-08-05 00:44:28 -0400142u32 acpi_ps_get_opcode_size(u32 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Len Brown4be44fc2005-08-05 00:44:28 -0400144u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Robert Moore73459f72005-06-24 00:00:00 -0400146acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400147acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
148 union acpi_parse_object *op);
Robert Moore73459f72005-06-24 00:00:00 -0400149
150acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400151acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
152 union acpi_parse_object *op,
153 acpi_status callback_status);
Robert Moore73459f72005-06-24 00:00:00 -0400154
155/*
156 * psloop - main parse loop
157 */
Len Brown4be44fc2005-08-05 00:44:28 -0400158acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Robert Moore44f6c012005-04-18 22:49:35 -0400160/*
161 * psscope - Scope stack management routines
162 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400164acpi_ps_init_scope(struct acpi_parse_state *parser_state,
165 union acpi_parse_object *root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Len Brown4be44fc2005-08-05 00:44:28 -0400167union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
168 *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Len Brown4be44fc2005-08-05 00:44:28 -0400170u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172void
Len Brown4be44fc2005-08-05 00:44:28 -0400173acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000174 union acpi_parse_object **op, u32 *arg_list, u32 *arg_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400177acpi_ps_push_scope(struct acpi_parse_state *parser_state,
178 union acpi_parse_object *op,
Bob Moore793c2382006-03-31 00:00:00 -0500179 u32 remaining_args, u32 arg_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Len Brown4be44fc2005-08-05 00:44:28 -0400181void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Robert Moore44f6c012005-04-18 22:49:35 -0400183/*
184 * pstree - parse tree manipulation routines
185 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186void
Len Brown4be44fc2005-08-05 00:44:28 -0400187acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Len Brown4be44fc2005-08-05 00:44:28 -0400189union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
190 char *path, u16 opcode, u32 create);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Len Brown4be44fc2005-08-05 00:44:28 -0400192union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Robert Moore44f6c012005-04-18 22:49:35 -0400194#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400195union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
196 union acpi_parse_object *op);
197#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Robert Moore44f6c012005-04-18 22:49:35 -0400199/*
200 * pswalk - parse tree walk routines
201 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400203acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400214acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
215 union acpi_parse_object *op,
216 acpi_parse_upwards ascending_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Len Brown4be44fc2005-08-05 00:44:28 -0400218acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Len Brown4be44fc2005-08-05 00:44:28 -0400220void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Robert Moore44f6c012005-04-18 22:49:35 -0400222/*
223 * psutils - parser utilities
224 */
Len Brown4be44fc2005-08-05 00:44:28 -0400225union acpi_parse_object *acpi_ps_create_scope_op(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Len Brown4be44fc2005-08-05 00:44:28 -0400227void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Len Brown4be44fc2005-08-05 00:44:28 -0400229union acpi_parse_object *acpi_ps_alloc_op(u16 opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Len Brown4be44fc2005-08-05 00:44:28 -0400231void acpi_ps_free_op(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Len Brown4be44fc2005-08-05 00:44:28 -0400233u8 acpi_ps_is_leading_char(u32 c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Robert Moore44f6c012005-04-18 22:49:35 -0400235#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400236u32 acpi_ps_get_name(union acpi_parse_object *op);
237#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Len Brown4be44fc2005-08-05 00:44:28 -0400239void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Robert Moore44f6c012005-04-18 22:49:35 -0400241/*
242 * psdump - display parser tree
243 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244u32
Len Brown4be44fc2005-08-05 00:44:28 -0400245acpi_ps_sprint_path(char *buffer_start,
246 u32 buffer_size, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248u32
Len Brown4be44fc2005-08-05 00:44:28 -0400249acpi_ps_sprint_op(char *buffer_start,
250 u32 buffer_size, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Len Brown4be44fc2005-08-05 00:44:28 -0400252void acpi_ps_show(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Len Brown4be44fc2005-08-05 00:44:28 -0400254#endif /* __ACPARSER_H__ */