2005-04-17 00:20:36 +02:00
|
|
|
/******************************************************************************
|
|
|
|
*
|
|
|
|
* 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
|
ACPICA 20050617-0624 from Bob Moore <robert.moore@intel.com>
ACPICA 20050617:
Moved the object cache operations into the OS interface
layer (OSL) to allow the host OS to handle these operations
if desired (for example, the Linux OSL will invoke the
slab allocator). This support is optional; the compile
time define ACPI_USE_LOCAL_CACHE may be used to utilize
the original cache code in the ACPI CA core. The new OSL
interfaces are shown below. See utalloc.c for an example
implementation, and acpiosxf.h for the exact interface
definitions. Thanks to Alexey Starikovskiy.
acpi_os_create_cache
acpi_os_delete_cache
acpi_os_purge_cache
acpi_os_acquire_object
acpi_os_release_object
Modified the interfaces to acpi_os_acquire_lock and
acpi_os_release_lock to return and restore a flags
parameter. This fits better with many OS lock models.
Note: the current execution state (interrupt handler
or not) is no longer passed to these interfaces. If
necessary, the OSL must determine this state by itself, a
simple and fast operation. Thanks to Alexey Starikovskiy.
Fixed a problem in the ACPI table handling where a valid
XSDT was assumed present if the revision of the RSDP
was 2 or greater. According to the ACPI specification,
the XSDT is optional in all cases, and the table manager
therefore now checks for both an RSDP >=2 and a valid
XSDT pointer. Otherwise, the RSDT pointer is used.
Some ACPI 2.0 compliant BIOSs contain only the RSDT.
Fixed an interpreter problem with the Mid() operator in the
case of an input string where the resulting output string
is of zero length. It now correctly returns a valid,
null terminated string object instead of a string object
with a null pointer.
Fixed a problem with the control method argument handling
to allow a store to an Arg object that already contains an
object of type Device. The Device object is now correctly
overwritten. Previously, an error was returned.
ACPICA 20050624:
Modified the new OSL cache interfaces to use ACPI_CACHE_T
as the type for the host-defined cache object. This allows
the OSL implementation to define and type this object in
any manner desired, simplifying the OSL implementation.
For example, ACPI_CACHE_T is defined as kmem_cache_t for
Linux, and should be defined in the OS-specific header
file for other operating systems as required.
Changed the interface to AcpiOsAcquireObject to directly
return the requested object as the function return (instead
of ACPI_STATUS.) This change was made for performance
reasons, since this is the purpose of the interface in the
first place. acpi_os_acquire_object is now similar to the
acpi_os_allocate interface. Thanks to Alexey Starikovskiy.
Modified the initialization sequence in
acpi_initialize_subsystem to call the OSL interface
acpi_osl_initialize first, before any local initialization.
This change was required because the global initialization
now calls OSL interfaces.
Restructured the code base to split some files because
of size and/or because the code logically belonged in a
separate file. New files are listed below.
utilities/utcache.c /* Local cache interfaces */
utilities/utmutex.c /* Local mutex support */
utilities/utstate.c /* State object support */
parser/psloop.c /* Main AML parse loop */
Signed-off-by: Len Brown <len.brown@intel.com>
2005-06-24 06:00:00 +02:00
|
|
|
#define ACPI_PARSE_DISASSEMBLE 0x0200
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/******************************************************************************
|
|
|
|
*
|
|
|
|
* Parser interfaces
|
|
|
|
*
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* psxface - Parser external interfaces
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
acpi_status
|
2005-07-30 00:15:00 +02:00
|
|
|
acpi_ps_execute_method (
|
2005-04-17 00:20:36 +02:00
|
|
|
struct acpi_parameter_info *info);
|
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psargs - Parse AML opcode arguments
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
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);
|
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psfind
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
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);
|
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psopcode - AML Opcode information
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
const struct acpi_opcode_info *
|
|
|
|
acpi_ps_get_opcode_info (
|
|
|
|
u16 opcode);
|
|
|
|
|
|
|
|
char *
|
|
|
|
acpi_ps_get_opcode_name (
|
|
|
|
u16 opcode);
|
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psparse - top level parsing routines
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
acpi_status
|
|
|
|
acpi_ps_parse_aml (
|
|
|
|
struct acpi_walk_state *walk_state);
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
u32
|
|
|
|
acpi_ps_get_opcode_size (
|
|
|
|
u32 opcode);
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
u16
|
|
|
|
acpi_ps_peek_opcode (
|
|
|
|
struct acpi_parse_state *state);
|
|
|
|
|
ACPICA 20050617-0624 from Bob Moore <robert.moore@intel.com>
ACPICA 20050617:
Moved the object cache operations into the OS interface
layer (OSL) to allow the host OS to handle these operations
if desired (for example, the Linux OSL will invoke the
slab allocator). This support is optional; the compile
time define ACPI_USE_LOCAL_CACHE may be used to utilize
the original cache code in the ACPI CA core. The new OSL
interfaces are shown below. See utalloc.c for an example
implementation, and acpiosxf.h for the exact interface
definitions. Thanks to Alexey Starikovskiy.
acpi_os_create_cache
acpi_os_delete_cache
acpi_os_purge_cache
acpi_os_acquire_object
acpi_os_release_object
Modified the interfaces to acpi_os_acquire_lock and
acpi_os_release_lock to return and restore a flags
parameter. This fits better with many OS lock models.
Note: the current execution state (interrupt handler
or not) is no longer passed to these interfaces. If
necessary, the OSL must determine this state by itself, a
simple and fast operation. Thanks to Alexey Starikovskiy.
Fixed a problem in the ACPI table handling where a valid
XSDT was assumed present if the revision of the RSDP
was 2 or greater. According to the ACPI specification,
the XSDT is optional in all cases, and the table manager
therefore now checks for both an RSDP >=2 and a valid
XSDT pointer. Otherwise, the RSDT pointer is used.
Some ACPI 2.0 compliant BIOSs contain only the RSDT.
Fixed an interpreter problem with the Mid() operator in the
case of an input string where the resulting output string
is of zero length. It now correctly returns a valid,
null terminated string object instead of a string object
with a null pointer.
Fixed a problem with the control method argument handling
to allow a store to an Arg object that already contains an
object of type Device. The Device object is now correctly
overwritten. Previously, an error was returned.
ACPICA 20050624:
Modified the new OSL cache interfaces to use ACPI_CACHE_T
as the type for the host-defined cache object. This allows
the OSL implementation to define and type this object in
any manner desired, simplifying the OSL implementation.
For example, ACPI_CACHE_T is defined as kmem_cache_t for
Linux, and should be defined in the OS-specific header
file for other operating systems as required.
Changed the interface to AcpiOsAcquireObject to directly
return the requested object as the function return (instead
of ACPI_STATUS.) This change was made for performance
reasons, since this is the purpose of the interface in the
first place. acpi_os_acquire_object is now similar to the
acpi_os_allocate interface. Thanks to Alexey Starikovskiy.
Modified the initialization sequence in
acpi_initialize_subsystem to call the OSL interface
acpi_osl_initialize first, before any local initialization.
This change was required because the global initialization
now calls OSL interfaces.
Restructured the code base to split some files because
of size and/or because the code logically belonged in a
separate file. New files are listed below.
utilities/utcache.c /* Local cache interfaces */
utilities/utmutex.c /* Local mutex support */
utilities/utstate.c /* State object support */
parser/psloop.c /* Main AML parse loop */
Signed-off-by: Len Brown <len.brown@intel.com>
2005-06-24 06:00:00 +02:00
|
|
|
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);
|
|
|
|
|
2005-04-17 00:20:36 +02:00
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psscope - Scope stack management routines
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
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);
|
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* pstree - parse tree manipulation routines
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
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);
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
#ifdef ACPI_FUTURE_USAGE
|
2005-04-17 00:20:36 +02:00
|
|
|
union acpi_parse_object *
|
|
|
|
acpi_ps_get_depth_next (
|
|
|
|
union acpi_parse_object *origin,
|
|
|
|
union acpi_parse_object *op);
|
2005-04-19 04:49:35 +02:00
|
|
|
#endif /* ACPI_FUTURE_USAGE */
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* pswalk - parse tree walk routines
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
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);
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
void
|
|
|
|
acpi_ps_delete_parse_tree (
|
|
|
|
union acpi_parse_object *root);
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psutils - parser utilities
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
union acpi_parse_object *
|
|
|
|
acpi_ps_create_scope_op (
|
|
|
|
void);
|
|
|
|
|
|
|
|
void
|
|
|
|
acpi_ps_init_op (
|
|
|
|
union acpi_parse_object *op,
|
|
|
|
u16 opcode);
|
|
|
|
|
|
|
|
union acpi_parse_object *
|
|
|
|
acpi_ps_alloc_op (
|
|
|
|
u16 opcode);
|
|
|
|
|
|
|
|
void
|
|
|
|
acpi_ps_free_op (
|
|
|
|
union acpi_parse_object *op);
|
|
|
|
|
|
|
|
u8
|
|
|
|
acpi_ps_is_leading_char (
|
|
|
|
u32 c);
|
|
|
|
|
|
|
|
u8
|
|
|
|
acpi_ps_is_prefix_char (
|
|
|
|
u32 c);
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
#ifdef ACPI_FUTURE_USAGE
|
2005-04-17 00:20:36 +02:00
|
|
|
u32
|
|
|
|
acpi_ps_get_name(
|
|
|
|
union acpi_parse_object *op);
|
2005-04-19 04:49:35 +02:00
|
|
|
#endif /* ACPI_FUTURE_USAGE */
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
void
|
|
|
|
acpi_ps_set_name(
|
|
|
|
union acpi_parse_object *op,
|
|
|
|
u32 name);
|
|
|
|
|
|
|
|
|
2005-04-19 04:49:35 +02:00
|
|
|
/*
|
|
|
|
* psdump - display parser tree
|
|
|
|
*/
|
2005-04-17 00:20:36 +02:00
|
|
|
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__ */
|