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

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

/*
 * 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 __ACSTRUCT_H__
#define __ACSTRUCT_H__


/*****************************************************************************
 *
 * 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

#define ACPI_WALK_NON_METHOD        0
#define ACPI_WALK_METHOD            1
#define ACPI_WALK_METHOD_RESTART    2
#define ACPI_WALK_CONST_REQUIRED    3
#define ACPI_WALK_CONST_OPTIONAL    4

struct acpi_walk_state
{
	u8                                  data_type;                          /* To differentiate various internal objs MUST BE FIRST!*/\
	u8                                  walk_type;
	acpi_owner_id                       owner_id;                           /* Owner of objects created during the walk */
	u8                                  last_predicate;                     /* Result of last predicate */
	u8                                  current_result;                     /* */
	u8                                  next_op_info;                       /* Info about next_op */
	u8                                  num_operands;                       /* Stack pointer for Operands[] array */
	u8                                  return_used;
	u16                                 opcode;                             /* Current AML opcode */
	u8                                  scope_depth;
	u8                                  pass_number;                        /* Parse pass during table load */
	u32                                 arg_count;                          /* push for fixed or var args */
	u32                                 aml_offset;
	u32                                 arg_types;
	u32                                 method_breakpoint;                  /* For single stepping */
	u32                                 user_breakpoint;                    /* User AML breakpoint */
	u32                                 parse_flags;
	u32                                 prev_arg_types;

	u8                                  *aml_last_while;
	struct acpi_namespace_node          arguments[ACPI_METHOD_NUM_ARGS];    /* Control method arguments */
	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          local_variables[ACPI_METHOD_NUM_LOCALS];    /* Control method locals */
	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 */
	union acpi_operand_object           *operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
	const struct acpi_opcode_info       *op_info;                           /* Info on current opcode */
	union acpi_parse_object             *origin;                            /* Start of walk [Obsolete] */
	union acpi_operand_object           **params;
	struct acpi_parse_state             parser_state;                       /* Current state of parser */
	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 */
	acpi_parse_downwards                descending_callback;
	acpi_parse_upwards                  ascending_callback;
	struct acpi_thread_state            *thread;
	struct acpi_walk_state              *next;                              /* Next walk_state in list */
};


/* 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;
	struct acpi_table_desc          *table_desc;
};


/* 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;
};


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

struct acpi_walk_info
{
	u32                             debug_level;
	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

struct acpi_get_devices_info
{
	acpi_walk_callback              user_function;
	void                            *context;
	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;
};


/* Internal method parameter list */

struct acpi_parameter_info
{
	struct acpi_namespace_node      *node;
	union acpi_operand_object       **parameters;
	union acpi_operand_object       *return_object;
	u8                              parameter_type;
	u8                              return_object_type;
};

/* Types for parameter_type above */

#define ACPI_PARAM_ARGS                 0
#define ACPI_PARAM_GPE                  1


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