/****************************************************************************** * * Module Name: acparser.h - AML Parser subcomponent prototypes and defines * *****************************************************************************/ /* * Copyright (C) 2000 - 2005, R. Byron Moore * 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 # arguments */ #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 /* Parser external interfaces */ acpi_statusacpi_psx_load_table (	u8                              *pcode_addr,	u32                             pcode_length); acpi_statusacpi_psx_execute (	struct acpi_parameter_info      *info);  /****************************************************************************** * * Parser interfaces * *****************************************************************************/  /* psargs - Parse AML opcode arguments */ u8 *acpi_ps_get_next_package_end (	struct acpi_parse_state         *parser_state); u32acpi_ps_get_next_package_length (	struct acpi_parse_state         *parser_state); char *acpi_ps_get_next_namestring (	struct acpi_parse_state         *parser_state); voidacpi_ps_get_next_simple_arg (	struct acpi_parse_state         *parser_state,	u32                             arg_type,	union acpi_parse_object         *arg); acpi_statusacpi_ps_get_next_namepath (	struct acpi_walk_state          *walk_state,	struct acpi_parse_state         *parser_state,	union acpi_parse_object         *arg,	u8                              method_call); union acpi_parse_object *acpi_ps_get_next_field (	struct acpi_parse_state         *parser_state); acpi_statusacpi_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);  /* psopcode - AML Opcode information */ const struct acpi_opcode_info *acpi_ps_get_opcode_info (	u16                             opcode); char *acpi_ps_get_opcode_name (	u16                             opcode);  /* psparse - top level parsing routines */ u32acpi_ps_get_opcode_size (	u32                             opcode); voidacpi_ps_complete_this_op (	struct acpi_walk_state          *walk_state,	union acpi_parse_object         *op); acpi_statusacpi_ps_next_parse_state (	struct acpi_walk_state          *walk_state,	union acpi_parse_object         *op,	acpi_status                     callback_status); acpi_statusacpi_ps_find_object (	struct acpi_walk_state          *walk_state,	union acpi_parse_object         **out_op); voidacpi_ps_delete_parse_tree (	union acpi_parse_object         *root); acpi_statusacpi_ps_parse_loop (	struct acpi_walk_state          *walk_state); acpi_statusacpi_ps_parse_aml (	struct acpi_walk_state          *walk_state); acpi_statusacpi_ps_parse_table (	u8                              *aml,	u32                             aml_size,	acpi_parse_downwards            descending_callback,	acpi_parse_upwards              ascending_callback,	union acpi_parse_object         **root_object); u16acpi_ps_peek_opcode (	struct acpi_parse_state         *state);  /* psscope - Scope stack management routines */  acpi_statusacpi_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); u8acpi_ps_has_completed_scope (	struct acpi_parse_state         *parser_state); voidacpi_ps_pop_scope (	struct acpi_parse_state         *parser_state,	union acpi_parse_object         **op,	u32                             *arg_list,	u32                             *arg_count); acpi_statusacpi_ps_push_scope (	struct acpi_parse_state         *parser_state,	union acpi_parse_object         *op,	u32                             remaining_args,	u32                             arg_count); voidacpi_ps_cleanup_scope (	struct acpi_parse_state         *state);  /* pstree - parse tree manipulation routines */ voidacpi_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); #ifdef ACPI_FUTURE_USAGEunion acpi_parse_object *acpi_ps_get_child (	union acpi_parse_object         *op); union acpi_parse_object *acpi_ps_get_depth_next (	union acpi_parse_object         *origin,	union acpi_parse_object         *op);#endif  /*  ACPI_FUTURE_USAGE  */  /* pswalk - parse tree walk routines */ acpi_statusacpi_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_statusacpi_ps_get_next_walk_op (	struct acpi_walk_state          *walk_state,	union acpi_parse_object         *op,	acpi_parse_upwards              ascending_callback); acpi_statusacpi_ps_delete_completed_op (	struct acpi_walk_state          *walk_state);  /* psutils - parser utilities */ union acpi_parse_object *acpi_ps_create_scope_op (	void); voidacpi_ps_init_op (	union acpi_parse_object         *op,	u16                             opcode); union acpi_parse_object *acpi_ps_alloc_op (	u16                             opcode); voidacpi_ps_free_op (	union acpi_parse_object         *op); #ifdef ACPI_ENABLE_OBJECT_CACHEvoidacpi_ps_delete_parse_cache (	void);#endif u8acpi_ps_is_leading_char (	u32                             c); u8acpi_ps_is_prefix_char (	u32                             c); #ifdef ACPI_FUTURE_USAGEu32acpi_ps_get_name(	union acpi_parse_object         *op);#endif voidacpi_ps_set_name(	union acpi_parse_object         *op,	u32                             name);  /* psdump - display parser tree */ u32acpi_ps_sprint_path (	char                            *buffer_start,	u32                             buffer_size,	union acpi_parse_object         *op); u32acpi_ps_sprint_op (	char                            *buffer_start,	u32                             buffer_size,	union acpi_parse_object         *op); voidacpi_ps_show (	union acpi_parse_object         *op);  #endif /* __ACPARSER_H__ */