[deliverable/linux.git] / drivers / acpi / acpica / acparser.h

/******************************************************************************
 *
 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2016, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACPARSER_H__
#define __ACPARSER_H__

#define OP_HAS_RETURN_VALUE             1

/* Variable number of arguments. This field must be 32 bits */

#define ACPI_VAR_ARGS                   ACPI_UINT32_MAX

#define ACPI_PARSE_DELETE_TREE          0x0001
#define ACPI_PARSE_NO_TREE_DELETE       0x0000
#define ACPI_PARSE_TREE_MASK            0x0001

#define ACPI_PARSE_LOAD_PASS1           0x0010
#define ACPI_PARSE_LOAD_PASS2           0x0020
#define ACPI_PARSE_EXECUTE              0x0030
#define ACPI_PARSE_MODE_MASK            0x0030

#define ACPI_PARSE_DEFERRED_OP          0x0100
#define ACPI_PARSE_DISASSEMBLE          0x0200

#define ACPI_PARSE_MODULE_LEVEL         0x0400

/******************************************************************************
 *
 * Parser interfaces
 *
 *****************************************************************************/

extern const u8 acpi_gbl_short_op_index[];
extern const u8 acpi_gbl_long_op_index[];

/*
 * psxface - Parser external interfaces
 */
acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info);

/*
 * psargs - Parse AML opcode arguments
 */
u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);

char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);

void
acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
			    u32 arg_type, union acpi_parse_object *arg);

acpi_status
acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
			  struct acpi_parse_state *parser_state,
			  union acpi_parse_object *arg,
			  u8 possible_method_call);

/* Values for u8 above */

#define ACPI_NOT_METHOD_CALL            FALSE
#define ACPI_POSSIBLE_METHOD_CALL       TRUE

acpi_status
acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
		     struct acpi_parse_state *parser_state,
		     u32 arg_type, union acpi_parse_object **return_arg);

/*
 * psfind
 */
union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
					   u32 name, u32 opcode);

union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);

/*
 * psobject - support for parse object processing
 */
acpi_status
acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
		       u8 *aml_op_start,
		       union acpi_parse_object *unnamed_op,
		       union acpi_parse_object **op);

acpi_status
acpi_ps_create_op(struct acpi_walk_state *walk_state,
		  u8 *aml_op_start, union acpi_parse_object **new_op);

acpi_status
acpi_ps_complete_op(struct acpi_walk_state *walk_state,
		    union acpi_parse_object **op, acpi_status status);

acpi_status
acpi_ps_complete_final_op(struct acpi_walk_state *walk_state,
			  union acpi_parse_object *op, acpi_status status);

/*
 * psopinfo - AML Opcode information
 */
const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);

char *acpi_ps_get_opcode_name(u16 opcode);

u8 acpi_ps_get_argument_count(u32 op_type);

/*
 * psparse - top level parsing routines
 */
acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);

u32 acpi_ps_get_opcode_size(u32 opcode);

u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);

acpi_status
acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
			 union acpi_parse_object *op);

acpi_status
acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
			 union acpi_parse_object *op,
			 acpi_status callback_status);

/*
 * psloop - main parse loop
 */
acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);

/*
 * psscope - Scope stack management routines
 */
acpi_status
acpi_ps_init_scope(struct acpi_parse_state *parser_state,
		   union acpi_parse_object *root);

union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
						  *state);

u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);

void
acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
		  union acpi_parse_object **op, u32 *arg_list, u32 *arg_count);

acpi_status
acpi_ps_push_scope(struct acpi_parse_state *parser_state,
		   union acpi_parse_object *op,
		   u32 remaining_args, u32 arg_count);

void acpi_ps_cleanup_scope(struct acpi_parse_state *state);

/*
 * pstree - parse tree manipulation routines
 */
void
acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);

union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
				      char *path, u16 opcode, u32 create);

union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);

union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
						union acpi_parse_object *op);

/*
 * pswalk - parse tree walk routines
 */
acpi_status
acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
			union acpi_parse_object *end_op,
			union acpi_operand_object *mth_desc,
			struct acpi_namespace_node *start_node,
			union acpi_operand_object **params,
			union acpi_operand_object **caller_return_desc,
			acpi_owner_id owner_id,
			acpi_parse_downwards descending_callback,
			acpi_parse_upwards ascending_callback);

acpi_status
acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
			 union acpi_parse_object *op,
			 acpi_parse_upwards ascending_callback);

acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);

void acpi_ps_delete_parse_tree(union acpi_parse_object *root);

/*
 * psutils - parser utilities
 */
union acpi_parse_object *acpi_ps_create_scope_op(u8 *aml);

void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);

union acpi_parse_object *acpi_ps_alloc_op(u16 opcode, u8 *aml);

void acpi_ps_free_op(union acpi_parse_object *op);

u8 acpi_ps_is_leading_char(u32 c);

u32 acpi_ps_get_name(union acpi_parse_object *op);

void acpi_ps_set_name(union acpi_parse_object *op, u32 name);

/*
 * psdump - display parser tree
 */
u32
acpi_ps_sprint_path(char *buffer_start,
		    u32 buffer_size, union acpi_parse_object *op);

u32
acpi_ps_sprint_op(char *buffer_start,
		  u32 buffer_size, union acpi_parse_object *op);

void acpi_ps_show(union acpi_parse_object *op);

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