[deliverable/linux.git] / include / acpi / acstruct.h

/******************************************************************************
 *
 * Name: acstruct.h - Internal structs
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2007, 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 __ACSTRUCT_H__
#define __ACSTRUCT_H__

/* acpisrc:struct_defs -- for acpisrc conversion */

/*****************************************************************************
 *
 * Tree walking typedefs and structs
 *
 ****************************************************************************/

/*
 * Walk state - current state of a parse tree walk.  Used for both a leisurely
 * stroll through the tree (for whatever reason), and for control method
 * execution.
 */
#define ACPI_NEXT_OP_DOWNWARD       1
#define ACPI_NEXT_OP_UPWARD         2

/*
 * Groups of definitions for walk_type used for different implementations of
 * walkers (never simultaneously) - flags for interpreter:
 */
#define ACPI_WALK_NON_METHOD        0
#define ACPI_WALK_METHOD            0x01
#define ACPI_WALK_METHOD_RESTART    0x02

/* Flags for i_aSL compiler only */

#define ACPI_WALK_CONST_REQUIRED    0x10
#define ACPI_WALK_CONST_OPTIONAL    0x20

struct acpi_walk_state {
	struct acpi_walk_state *next;	/* Next walk_state in list */
	u8 descriptor_type;	/* To differentiate various internal objs */
	u8 walk_type;
	u16 opcode;		/* Current AML opcode */
	u8 next_op_info;	/* Info about next_op */
	u8 num_operands;	/* Stack pointer for Operands[] array */
	u8 operand_index;	/* Index into operand stack, to be used by acpi_ds_obj_stack_push */
	acpi_owner_id owner_id;	/* Owner of objects created during the walk */
	u8 last_predicate;	/* Result of last predicate */
	u8 current_result;
	u8 return_used;
	u8 scope_depth;
	u8 pass_number;		/* Parse pass during table load */
	u8 result_size;		/* Total elements for the result stack */
	u8 result_count;	/* Current number of occupied elements of result stack */
	u32 aml_offset;
	u32 arg_types;
	u32 method_breakpoint;	/* For single stepping */
	u32 user_breakpoint;	/* User AML breakpoint */
	u32 parse_flags;

	struct acpi_parse_state parser_state;	/* Current state of parser */
	u32 prev_arg_types;
	u32 arg_count;		/* push for fixed or var args */

	struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS];	/* Control method arguments */
	struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS];	/* Control method locals */
	union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1];	/* Operands passed to the interpreter (+1 for NULL terminator) */
	union acpi_operand_object **params;

	u8 *aml_last_while;
	union acpi_operand_object **caller_return_desc;
	union acpi_generic_state *control_state;	/* List of control states (nested IFs) */
	struct acpi_namespace_node *deferred_node;	/* Used when executing deferred opcodes */
	struct acpi_gpe_event_info *gpe_event_info;	/* Info for GPE (_Lxx/_Exx methods only */
	union acpi_operand_object *implicit_return_obj;
	struct acpi_namespace_node *method_call_node;	/* Called method Node */
	union acpi_parse_object *method_call_op;	/* method_call Op if running a method */
	union acpi_operand_object *method_desc;	/* Method descriptor if running a method */
	struct acpi_namespace_node *method_node;	/* Method node if running a method. */
	union acpi_parse_object *op;	/* Current parser op */
	const struct acpi_opcode_info *op_info;	/* Info on current opcode */
	union acpi_parse_object *origin;	/* Start of walk [Obsolete] */
	union acpi_operand_object *result_obj;
	union acpi_generic_state *results;	/* Stack of accumulated results */
	union acpi_operand_object *return_desc;	/* Return object, if any */
	union acpi_generic_state *scope_info;	/* Stack of nested scopes */
	union acpi_parse_object *prev_op;	/* Last op that was processed */
	union acpi_parse_object *next_op;	/* next op to be processed */
	struct acpi_thread_state *thread;
	acpi_parse_downwards descending_callback;
	acpi_parse_upwards ascending_callback;
};

/* Info used by acpi_ps_init_objects */

struct acpi_init_walk_info {
	u16 method_count;
	u16 device_count;
	u16 op_region_count;
	u16 field_count;
	u16 buffer_count;
	u16 package_count;
	u16 op_region_init;
	u16 field_init;
	u16 buffer_init;
	u16 package_init;
	u16 object_count;
	acpi_owner_id owner_id;
	acpi_native_uint table_index;
};

struct acpi_get_devices_info {
	acpi_walk_callback user_function;
	void *context;
	const char *hid;
};

union acpi_aml_operands {
	union acpi_operand_object *operands[7];

	struct {
		struct acpi_object_integer *type;
		struct acpi_object_integer *code;
		struct acpi_object_integer *argument;

	} fatal;

	struct {
		union acpi_operand_object *source;
		struct acpi_object_integer *index;
		union acpi_operand_object *target;

	} index;

	struct {
		union acpi_operand_object *source;
		struct acpi_object_integer *index;
		struct acpi_object_integer *length;
		union acpi_operand_object *target;

	} mid;
};

/*
 * Structure used to pass object evaluation parameters.
 * Purpose is to reduce CPU stack use.
 */
struct acpi_evaluate_info {
	struct acpi_namespace_node *prefix_node;
	char *pathname;
	union acpi_operand_object *obj_desc;
	union acpi_operand_object **parameters;
	struct acpi_namespace_node *resolved_node;
	union acpi_operand_object *return_object;
	u8 pass_number;
	u8 parameter_type;
	u8 return_object_type;
	u8 flags;
};

/* Types for parameter_type above */

#define ACPI_PARAM_ARGS                 0
#define ACPI_PARAM_GPE                  1

/* Values for Flags above */

#define ACPI_IGNORE_RETURN_VALUE        1

/* Info used by acpi_ns_initialize_devices */

struct acpi_device_walk_info {
	u16 device_count;
	u16 num_STA;
	u16 num_INI;
	struct acpi_table_desc *table_desc;
	struct acpi_evaluate_info *evaluate_info;
};

/* TBD: [Restructure] Merge with struct above */

struct acpi_walk_info {
	u32 debug_level;
	u32 count;
	acpi_owner_id owner_id;
	u8 display_type;
};

/* Display Types */

#define ACPI_DISPLAY_SUMMARY        (u8) 0
#define ACPI_DISPLAY_OBJECTS        (u8) 1
#define ACPI_DISPLAY_MASK           (u8) 1

#define ACPI_DISPLAY_SHORT          (u8) 2

#endif
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acstruct.h - Internal structs
	4	*
	5	*****************************************************************************/
	6
	7	/*
6c9deb72	8	* Copyright (C) 2000 - 2007, R. Byron Moore
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
	44	#ifndef __ACSTRUCT_H__
	45	#define __ACSTRUCT_H__
	46
61686124 BM	47	/* acpisrc:struct_defs -- for acpisrc conversion */
61686124 BM	48
1da177e4 LT	49	/*****************************************************************************
	50	*
	51	* Tree walking typedefs and structs
	52	*
	53	****************************************************************************/
	54
1da177e4	55	/*
4119532c BM	56	* Walk state - current state of a parse tree walk. Used for both a leisurely
	57	* stroll through the tree (for whatever reason), and for control method
	58	* execution.
1da177e4	59	*/
1da177e4 LT	60	#define ACPI_NEXT_OP_DOWNWARD 1
	61	#define ACPI_NEXT_OP_UPWARD 2
	62
4119532c BM	63	/*
	64	* Groups of definitions for walk_type used for different implementations of
	65	* walkers (never simultaneously) - flags for interpreter:
	66	*/
1da177e4	67	#define ACPI_WALK_NON_METHOD 0
4119532c BM	68	#define ACPI_WALK_METHOD 0x01
	69	#define ACPI_WALK_METHOD_RESTART 0x02
	70
	71	/* Flags for i_aSL compiler only */
	72
	73	#define ACPI_WALK_CONST_REQUIRED 0x10
	74	#define ACPI_WALK_CONST_OPTIONAL 0x20
1da177e4	75
4be44fcd	76	struct acpi_walk_state {
61686124 BM	77	struct acpi_walk_state next; / Next walk_state in list */
61686124 BM	78	u8 descriptor_type; /* To differentiate various internal objs */
4be44fcd	79	u8 walk_type;
61686124	80	u16 opcode; /* Current AML opcode */
4be44fcd LB	81	u8 next_op_info; /* Info about next_op */
4be44fcd LB	82	u8 num_operands; /* Stack pointer for Operands[] array */
773069d4	83	u8 operand_index; /* Index into operand stack, to be used by acpi_ds_obj_stack_push */
61686124 BM	84	acpi_owner_id owner_id; /* Owner of objects created during the walk */
	85	u8 last_predicate; /* Result of last predicate */
	86	u8 current_result;
4be44fcd	87	u8 return_used;
4be44fcd LB	88	u8 scope_depth;
4be44fcd LB	89	u8 pass_number; /* Parse pass during table load */
773069d4 BM	90	u8 result_size; /* Total elements for the result stack */
773069d4 BM	91	u8 result_count; /* Current number of occupied elements of result stack */
4be44fcd LB	92	u32 aml_offset;
	93	u32 arg_types;
	94	u32 method_breakpoint; /* For single stepping */
	95	u32 user_breakpoint; /* User AML breakpoint */
	96	u32 parse_flags;
61686124 BM	97
61686124 BM	98	struct acpi_parse_state parser_state; /* Current state of parser */
4be44fcd	99	u32 prev_arg_types;
793c2388	100	u32 arg_count; /* push for fixed or var args */
4be44fcd	101
4be44fcd	102	struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */
61686124 BM	103	struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
	104	union acpi_operand_object operands[ACPI_OBJ_NUM_OPERANDS + 1]; / Operands passed to the interpreter (+1 for NULL terminator) */
	105	union acpi_operand_object **params;
	106
	107	u8 *aml_last_while;
4be44fcd LB	108	union acpi_operand_object **caller_return_desc;
	109	union acpi_generic_state control_state; / List of control states (nested IFs) */
	110	struct acpi_namespace_node deferred_node; / Used when executing deferred opcodes */
	111	struct acpi_gpe_event_info gpe_event_info; / Info for GPE (_Lxx/_Exx methods only */
	112	union acpi_operand_object *implicit_return_obj;
4be44fcd LB	113	struct acpi_namespace_node method_call_node; / Called method Node */
	114	union acpi_parse_object method_call_op; / method_call Op if running a method */
	115	union acpi_operand_object method_desc; / Method descriptor if running a method */
	116	struct acpi_namespace_node method_node; / Method node if running a method. */
	117	union acpi_parse_object op; / Current parser op */
4be44fcd LB	118	const struct acpi_opcode_info op_info; / Info on current opcode */
4be44fcd LB	119	union acpi_parse_object origin; / Start of walk [Obsolete] */
4be44fcd LB	120	union acpi_operand_object *result_obj;
	121	union acpi_generic_state results; / Stack of accumulated results */
	122	union acpi_operand_object return_desc; / Return object, if any */
	123	union acpi_generic_state scope_info; / Stack of nested scopes */
4be44fcd LB	124	union acpi_parse_object prev_op; / Last op that was processed */
4be44fcd LB	125	union acpi_parse_object next_op; / next op to be processed */
61686124	126	struct acpi_thread_state *thread;
4be44fcd LB	127	acpi_parse_downwards descending_callback;
4be44fcd LB	128	acpi_parse_upwards ascending_callback;
1da177e4 LT	129	};
1da177e4 LT	130
1da177e4 LT	131	/* Info used by acpi_ps_init_objects */
1da177e4 LT	132
4be44fcd LB	133	struct acpi_init_walk_info {
	134	u16 method_count;
	135	u16 device_count;
	136	u16 op_region_count;
	137	u16 field_count;
	138	u16 buffer_count;
	139	u16 package_count;
	140	u16 op_region_init;
	141	u16 field_init;
	142	u16 buffer_init;
	143	u16 package_init;
	144	u16 object_count;
f3d2e786 BM	145	acpi_owner_id owner_id;
f3d2e786 BM	146	acpi_native_uint table_index;
1da177e4 LT	147	};
1da177e4 LT	148
4be44fcd LB	149	struct acpi_get_devices_info {
	150	acpi_walk_callback user_function;
	151	void *context;
70b30fb1	152	const char *hid;
1da177e4 LT	153	};
1da177e4 LT	154
4be44fcd LB	155	union acpi_aml_operands {
4be44fcd LB	156	union acpi_operand_object *operands[7];
1da177e4	157
4be44fcd LB	158	struct {
	159	struct acpi_object_integer *type;
	160	struct acpi_object_integer *code;
	161	struct acpi_object_integer *argument;
1da177e4 LT	162
	163	} fatal;
	164
4be44fcd LB	165	struct {
	166	union acpi_operand_object *source;
	167	struct acpi_object_integer *index;
	168	union acpi_operand_object *target;
1da177e4 LT	169
	170	} index;
	171
4be44fcd LB	172	struct {
	173	union acpi_operand_object *source;
	174	struct acpi_object_integer *index;
	175	struct acpi_object_integer *length;
	176	union acpi_operand_object *target;
1da177e4 LT	177
	178	} mid;
	179	};
	180
4119532c BM	181	/*
	182	* Structure used to pass object evaluation parameters.
	183	* Purpose is to reduce CPU stack use.
	184	*/
	185	struct acpi_evaluate_info {
	186	struct acpi_namespace_node *prefix_node;
	187	char *pathname;
4be44fcd LB	188	union acpi_operand_object *obj_desc;
4be44fcd LB	189	union acpi_operand_object **parameters;
4119532c	190	struct acpi_namespace_node *resolved_node;
4be44fcd LB	191	union acpi_operand_object *return_object;
	192	u8 pass_number;
	193	u8 parameter_type;
	194	u8 return_object_type;
4119532c	195	u8 flags;
1da177e4 LT	196	};
	197
	198	/* Types for parameter_type above */
	199
	200	#define ACPI_PARAM_ARGS 0
	201	#define ACPI_PARAM_GPE 1
	202
4119532c BM	203	/* Values for Flags above */
	204
	205	#define ACPI_IGNORE_RETURN_VALUE 1
	206
	207	/* Info used by acpi_ns_initialize_devices */
	208
	209	struct acpi_device_walk_info {
	210	u16 device_count;
	211	u16 num_STA;
	212	u16 num_INI;
	213	struct acpi_table_desc *table_desc;
	214	struct acpi_evaluate_info *evaluate_info;
	215	};
	216
	217	/* TBD: [Restructure] Merge with struct above */
	218
	219	struct acpi_walk_info {
	220	u32 debug_level;
	221	u32 count;
	222	acpi_owner_id owner_id;
	223	u8 display_type;
	224	};
	225
	226	/* Display Types */
	227
	228	#define ACPI_DISPLAY_SUMMARY (u8) 0
	229	#define ACPI_DISPLAY_OBJECTS (u8) 1
	230	#define ACPI_DISPLAY_MASK (u8) 1
	231
	232	#define ACPI_DISPLAY_SHORT (u8) 2
	233
1da177e4	234	#endif