0,0 → 1,253 |
/****************************************************************************** |
* |
* Module Name: acparser.h - AML Parser subcomponent prototypes and defines |
* |
*****************************************************************************/ |
|
/* |
* Copyright (C) 2000 - 2015, 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 method_call); |
|
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__ */ |