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


/******************************************************************************
 *
 * Name: acobject.h - Definition of union acpi_operand_object  (Internal object only)
 *
 *****************************************************************************/

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

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

/*
 * The union acpi_operand_object is used to pass AML operands from the dispatcher
 * to the interpreter, and to keep track of the various handlers such as
 * address space handlers and notify handlers. The object is a constant
 * size in order to allow it to be cached and reused.
 */

/*******************************************************************************
 *
 * Common Descriptors
 *
 ******************************************************************************/

/*
 * Common area for all objects.
 *
 * descriptor_type is used to differentiate between internal descriptors, and
 * must be in the same place across all descriptors
 */
#define ACPI_OBJECT_COMMON_HEADER \
	union acpi_operand_object       *next_object;       /* Objects linked to parent NS node */\
	u8                              descriptor_type;    /* To differentiate various internal objs */\
	u8                              type;               /* acpi_object_type */\
	u16                             reference_count;    /* For object deletion management */\
	u8                              flags;
	/*
	 * Note: There are 3 bytes available here before the
	 * next natural alignment boundary (for both 32/64 cases)
	 */

/* Values for Flag byte above */

#define AOPOBJ_AML_CONSTANT         0x01
#define AOPOBJ_STATIC_POINTER       0x02
#define AOPOBJ_DATA_VALID           0x04
#define AOPOBJ_OBJECT_INITIALIZED   0x08
#define AOPOBJ_SETUP_COMPLETE       0x10
#define AOPOBJ_SINGLE_DATUM         0x20

/******************************************************************************
 *
 * Basic data types
 *
 *****************************************************************************/

struct acpi_object_common {
ACPI_OBJECT_COMMON_HEADER};

struct acpi_object_integer {
	ACPI_OBJECT_COMMON_HEADER acpi_integer value;
};

/*
 * Note: The String and Buffer object must be identical through the Pointer
 * and length elements.  There is code that depends on this.
 *
 * Fields common to both Strings and Buffers
 */
#define ACPI_COMMON_BUFFER_INFO(_type) \
	_type                           *pointer; \
	u32                             length;

struct acpi_object_string {	/* Null terminated, ASCII characters only */
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char)	/* String in AML stream or allocated string */
};

struct acpi_object_buffer {
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8)	/* Buffer in AML stream or allocated buffer */
	u32 aml_length;
	u8 *aml_start;
	struct acpi_namespace_node *node;	/* Link back to parent node */
};

struct acpi_object_package {
	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node;	/* Link back to parent node */
	union acpi_operand_object **elements;	/* Array of pointers to acpi_objects */
	u8 *aml_start;
	u32 aml_length;
	u32 count;		/* # of elements in package */
};

/******************************************************************************
 *
 * Complex data types
 *
 *****************************************************************************/

struct acpi_object_event {
	ACPI_OBJECT_COMMON_HEADER void *semaphore;
};

struct acpi_object_mutex {
	ACPI_OBJECT_COMMON_HEADER u8 sync_level;	/* 0-15, specified in Mutex() call */
	u16 acquisition_depth;	/* Allow multiple Acquires, same thread */
	struct acpi_thread_state *owner_thread;	/* Current owner of the mutex */
	void *semaphore;	/* Actual OS synchronization object */
	union acpi_operand_object *prev;	/* Link for list of acquired mutexes */
	union acpi_operand_object *next;	/* Link for list of acquired mutexes */
	struct acpi_namespace_node *node;	/* Containing namespace node */
	u8 original_sync_level;	/* Owner's original sync level (0-15) */
};

struct acpi_object_region {
	ACPI_OBJECT_COMMON_HEADER u8 space_id;
	struct acpi_namespace_node *node;	/* Containing namespace node */
	union acpi_operand_object *handler;	/* Handler for region access */
	union acpi_operand_object *next;
	acpi_physical_address address;
	u32 length;
};

struct acpi_object_method {
	ACPI_OBJECT_COMMON_HEADER u8 method_flags;
	u8 param_count;
	u8 concurrency;
	void *semaphore;
	u8 *aml_start;
	ACPI_INTERNAL_METHOD implementation;
	u32 aml_length;
	u8 thread_count;
	acpi_owner_id owner_id;
};

/******************************************************************************
 *
 * Objects that can be notified.  All share a common notify_info area.
 *
 *****************************************************************************/

/*
 * Common fields for objects that support ASL notifications
 */
#define ACPI_COMMON_NOTIFY_INFO \
	union acpi_operand_object       *system_notify;     /* Handler for system notifies */\
	union acpi_operand_object       *device_notify;     /* Handler for driver notifies */\
	union acpi_operand_object       *handler;	/* Handler for Address space */

struct acpi_object_notify_common {	/* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};

struct acpi_object_device {
	ACPI_OBJECT_COMMON_HEADER
	    ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
};

struct acpi_object_power_resource {
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
	u32 resource_order;
};

struct acpi_object_processor {
	ACPI_OBJECT_COMMON_HEADER u8 proc_id;
	u8 length;
	 ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
};

struct acpi_object_thermal_zone {
ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};

/******************************************************************************
 *
 * Fields.  All share a common header/info field.
 *
 *****************************************************************************/

/*
 * Common bitfield for the field objects
 * "Field Datum"  -- a datum from the actual field object
 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
 */
#define ACPI_COMMON_FIELD_INFO \
	u8                              field_flags;        /* Access, update, and lock bits */\
	u8                              attribute;          /* From access_as keyword */\
	u8                              access_byte_width;  /* Read/Write size in bytes */\
	struct acpi_namespace_node      *node;              /* Link back to parent node */\
	u32                             bit_length;         /* Length of field in bits */\
	u32                             base_byte_offset;   /* Byte offset within containing object */\
	u32                             value;              /* Value to store into the Bank or Index register */\
	u8                              start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
	u8                              access_bit_width;	/* Read/Write size in bits (8-64) */

struct acpi_object_field_common {	/* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj;	/* Parent Operation Region object (REGION/BANK fields only) */
};

struct acpi_object_region_field {
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj;	/* Containing op_region object */
};

struct acpi_object_bank_field {
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj;	/* Containing op_region object */
	union acpi_operand_object *bank_obj;	/* bank_select Register object */
};

struct acpi_object_index_field {
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
	    /*
	     * No "region_obj" pointer needed since the Index and Data registers
	     * are each field definitions unto themselves.
	     */
	union acpi_operand_object *index_obj;	/* Index register */
	union acpi_operand_object *data_obj;	/* Data register */
};

/* The buffer_field is different in that it is part of a Buffer, not an op_region */

struct acpi_object_buffer_field {
	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *buffer_obj;	/* Containing Buffer object */
};

/******************************************************************************
 *
 * Objects for handlers
 *
 *****************************************************************************/

struct acpi_object_notify_handler {
	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node;	/* Parent device */
	acpi_notify_handler handler;
	void *context;
};

struct acpi_object_addr_handler {
	ACPI_OBJECT_COMMON_HEADER u8 space_id;
	u8 handler_flags;
	acpi_adr_space_handler handler;
	struct acpi_namespace_node *node;	/* Parent device */
	void *context;
	acpi_adr_space_setup setup;
	union acpi_operand_object *region_list;	/* regions using this handler */
	union acpi_operand_object *next;
};

/* Flags for address handler (handler_flags) */

#define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x01

/******************************************************************************
 *
 * Special internal objects
 *
 *****************************************************************************/

/*
 * The Reference object type is used for these opcodes:
 * Arg[0-6], Local[0-7], index_op, name_op, zero_op, one_op, ones_op, debug_op
 */
struct acpi_object_reference {
	ACPI_OBJECT_COMMON_HEADER u8 target_type;	/* Used for index_op */
	u16 opcode;
	void *object;		/* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
	struct acpi_namespace_node *node;
	union acpi_operand_object **where;
	u32 offset;		/* Used for arg_op, local_op, and index_op */
};

/*
 * Extra object is used as additional storage for types that
 * have AML code in their declarations (term_args) that must be
 * evaluated at run time.
 *
 * Currently: Region and field_unit types
 */
struct acpi_object_extra {
	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG;	/* _REG method for this region (if any) */
	void *region_context;	/* Region-specific data */
	u8 *aml_start;
	u32 aml_length;
};

/* Additional data that can be attached to namespace nodes */

struct acpi_object_data {
	ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
	void *pointer;
};

/* Structure used when objects are cached for reuse */

struct acpi_object_cache_list {
	ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next;	/* Link for object cache and internal lists */
};

/******************************************************************************
 *
 * union acpi_operand_object Descriptor - a giant union of all of the above
 *
 *****************************************************************************/

union acpi_operand_object {
	struct acpi_object_common common;
	struct acpi_object_integer integer;
	struct acpi_object_string string;
	struct acpi_object_buffer buffer;
	struct acpi_object_package package;
	struct acpi_object_event event;
	struct acpi_object_method method;
	struct acpi_object_mutex mutex;
	struct acpi_object_region region;
	struct acpi_object_notify_common common_notify;
	struct acpi_object_device device;
	struct acpi_object_power_resource power_resource;
	struct acpi_object_processor processor;
	struct acpi_object_thermal_zone thermal_zone;
	struct acpi_object_field_common common_field;
	struct acpi_object_region_field field;
	struct acpi_object_buffer_field buffer_field;
	struct acpi_object_bank_field bank_field;
	struct acpi_object_index_field index_field;
	struct acpi_object_notify_handler notify;
	struct acpi_object_addr_handler address_space;
	struct acpi_object_reference reference;
	struct acpi_object_extra extra;
	struct acpi_object_data data;
	struct acpi_object_cache_list cache;
};

/******************************************************************************
 *
 * union acpi_descriptor - objects that share a common descriptor identifier
 *
 *****************************************************************************/

/* Object descriptor types */

#define ACPI_DESC_TYPE_CACHED           0x01	/* Used only when object is cached */
#define ACPI_DESC_TYPE_STATE            0x02
#define ACPI_DESC_TYPE_STATE_UPDATE     0x03
#define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
#define ACPI_DESC_TYPE_STATE_CONTROL    0x05
#define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
#define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
#define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
#define ACPI_DESC_TYPE_STATE_RESULT     0x09
#define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
#define ACPI_DESC_TYPE_STATE_THREAD     0x0B
#define ACPI_DESC_TYPE_WALK             0x0C
#define ACPI_DESC_TYPE_PARSER           0x0D
#define ACPI_DESC_TYPE_OPERAND          0x0E
#define ACPI_DESC_TYPE_NAMED            0x0F
#define ACPI_DESC_TYPE_MAX              0x0F

struct acpi_common_descriptor {
	void *common_pointer;
	u8 descriptor_type;	/* To differentiate various internal objs */
};

union acpi_descriptor {
	struct acpi_common_descriptor common;
	union acpi_operand_object object;
	struct acpi_namespace_node node;
	union acpi_parse_object op;
};

#endif				/* _ACOBJECT_H */
Commit	Line	Data
1da177e4 LT	1
	2	/******************************************************************************
	3	*
61686124	4	* Name: acobject.h - Definition of union acpi_operand_object (Internal object only)
1da177e4 LT	5	*
	6	*****************************************************************************/
	7
	8	/*
4a90c7e8	9	* Copyright (C) 2000 - 2006, R. Byron Moore
1da177e4 LT	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
	45	#ifndef _ACOBJECT_H
	46	#define _ACOBJECT_H
	47
61686124 BM	48	/* acpisrc:struct_defs -- for acpisrc conversion */
61686124 BM	49
1da177e4	50	/*
61686124	51	* The union acpi_operand_object is used to pass AML operands from the dispatcher
1da177e4	52	* to the interpreter, and to keep track of the various handlers such as
61686124	53	* address space handlers and notify handlers. The object is a constant
1da177e4 LT	54	* size in order to allow it to be cached and reused.
	55	*/
	56
	57	/*******************************************************************************
	58	*
	59	* Common Descriptors
	60	*
	61	******************************************************************************/
	62
	63	/*
	64	* Common area for all objects.
	65	*
61686124 BM	66	* descriptor_type is used to differentiate between internal descriptors, and
61686124 BM	67	* must be in the same place across all descriptors
1da177e4	68	*/
61686124 BM	69	#define ACPI_OBJECT_COMMON_HEADER \
	70	union acpi_operand_object next_object; / Objects linked to parent NS node */\
	71	u8 descriptor_type; /* To differentiate various internal objs */\
	72	u8 type; /* acpi_object_type */\
	73	u16 reference_count; /* For object deletion management */\
	74	u8 flags;
	75	/*
	76	* Note: There are 3 bytes available here before the
	77	* next natural alignment boundary (for both 32/64 cases)
	78	*/
	79
	80	/* Values for Flag byte above */
1da177e4 LT	81
	82	#define AOPOBJ_AML_CONSTANT 0x01
	83	#define AOPOBJ_STATIC_POINTER 0x02
	84	#define AOPOBJ_DATA_VALID 0x04
	85	#define AOPOBJ_OBJECT_INITIALIZED 0x08
	86	#define AOPOBJ_SETUP_COMPLETE 0x10
	87	#define AOPOBJ_SINGLE_DATUM 0x20
	88
1da177e4 LT	89	/******************************************************************************
	90	*
	91	* Basic data types
	92	*
	93	*****************************************************************************/
	94
4be44fcd LB	95	struct acpi_object_common {
4be44fcd LB	96	ACPI_OBJECT_COMMON_HEADER};
1da177e4	97
4be44fcd LB	98	struct acpi_object_integer {
4be44fcd LB	99	ACPI_OBJECT_COMMON_HEADER acpi_integer value;
1da177e4 LT	100	};
	101
	102	/*
	103	* Note: The String and Buffer object must be identical through the Pointer
61686124 BM	104	* and length elements. There is code that depends on this.
	105	*
	106	* Fields common to both Strings and Buffers
1da177e4	107	*/
61686124 BM	108	#define ACPI_COMMON_BUFFER_INFO(_type) \
	109	_type *pointer; \
	110	u32 length;
	111
4be44fcd	112	struct acpi_object_string { /* Null terminated, ASCII characters only */
61686124	113	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */
1da177e4 LT	114	};
1da177e4 LT	115
4be44fcd	116	struct acpi_object_buffer {
61686124	117	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8) /* Buffer in AML stream or allocated buffer */
4be44fcd	118	u32 aml_length;
61686124 BM	119	u8 *aml_start;
61686124 BM	120	struct acpi_namespace_node node; / Link back to parent node */
1da177e4 LT	121	};
1da177e4 LT	122
4be44fcd	123	struct acpi_object_package {
61686124	124	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node node; / Link back to parent node */
4be44fcd	125	union acpi_operand_object *elements; / Array of pointers to acpi_objects */
61686124 BM	126	u8 *aml_start;
	127	u32 aml_length;
	128	u32 count; /* # of elements in package */
1da177e4 LT	129	};
1da177e4 LT	130
1da177e4 LT	131	/******************************************************************************
	132	*
	133	* Complex data types
	134	*
	135	*****************************************************************************/
	136
4be44fcd LB	137	struct acpi_object_event {
4be44fcd LB	138	ACPI_OBJECT_COMMON_HEADER void *semaphore;
1da177e4 LT	139	};
1da177e4 LT	140
4be44fcd LB	141	struct acpi_object_mutex {
	142	ACPI_OBJECT_COMMON_HEADER u8 sync_level; /* 0-15, specified in Mutex() call */
	143	u16 acquisition_depth; /* Allow multiple Acquires, same thread */
	144	struct acpi_thread_state owner_thread; / Current owner of the mutex */
	145	void semaphore; / Actual OS synchronization object */
	146	union acpi_operand_object prev; / Link for list of acquired mutexes */
	147	union acpi_operand_object next; / Link for list of acquired mutexes */
	148	struct acpi_namespace_node node; / Containing namespace node */
	149	u8 original_sync_level; /* Owner's original sync level (0-15) */
1da177e4 LT	150	};
1da177e4 LT	151
4be44fcd LB	152	struct acpi_object_region {
4be44fcd LB	153	ACPI_OBJECT_COMMON_HEADER u8 space_id;
4be44fcd	154	struct acpi_namespace_node node; / Containing namespace node */
61686124	155	union acpi_operand_object handler; / Handler for region access */
4be44fcd	156	union acpi_operand_object *next;
4be44fcd	157	acpi_physical_address address;
61686124 BM	158	u32 length;
	159	};
	160
	161	struct acpi_object_method {
	162	ACPI_OBJECT_COMMON_HEADER u8 method_flags;
	163	u8 param_count;
	164	u8 concurrency;
	165	void *semaphore;
	166	u8 *aml_start;
	167	ACPI_INTERNAL_METHOD implementation;
	168	u32 aml_length;
	169	u8 thread_count;
	170	acpi_owner_id owner_id;
1da177e4 LT	171	};
1da177e4 LT	172
1da177e4 LT	173	/******************************************************************************
	174	*
	175	* Objects that can be notified. All share a common notify_info area.
	176	*
	177	*****************************************************************************/
	178
61686124 BM	179	/*
	180	* Common fields for objects that support ASL notifications
	181	*/
	182	#define ACPI_COMMON_NOTIFY_INFO \
	183	union acpi_operand_object system_notify; / Handler for system notifies */\
	184	union acpi_operand_object device_notify; / Handler for driver notifies */\
	185	union acpi_operand_object handler; / Handler for Address space */
	186
4be44fcd LB	187	struct acpi_object_notify_common { /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
4be44fcd LB	188	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
1da177e4	189
4be44fcd	190	struct acpi_object_device {
1da177e4	191	ACPI_OBJECT_COMMON_HEADER
4be44fcd	192	ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
1da177e4 LT	193	};
1da177e4 LT	194
4be44fcd LB	195	struct acpi_object_power_resource {
	196	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
	197	u32 resource_order;
1da177e4 LT	198	};
1da177e4 LT	199
4be44fcd	200	struct acpi_object_processor {
61686124 BM	201	ACPI_OBJECT_COMMON_HEADER u8 proc_id;
	202	u8 length;
	203	ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
1da177e4 LT	204	};
1da177e4 LT	205
4be44fcd LB	206	struct acpi_object_thermal_zone {
4be44fcd LB	207	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
1da177e4 LT	208
	209	/******************************************************************************
	210	*
	211	* Fields. All share a common header/info field.
	212	*
	213	*****************************************************************************/
	214
61686124 BM	215	/*
	216	* Common bitfield for the field objects
	217	* "Field Datum" -- a datum from the actual field object
	218	* "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
	219	*/
	220	#define ACPI_COMMON_FIELD_INFO \
	221	u8 field_flags; /* Access, update, and lock bits */\
	222	u8 attribute; /* From access_as keyword */\
	223	u8 access_byte_width; /* Read/Write size in bytes */\
	224	struct acpi_namespace_node node; / Link back to parent node */\
	225	u32 bit_length; /* Length of field in bits */\
	226	u32 base_byte_offset; /* Byte offset within containing object */\
	227	u32 value; /* Value to store into the Bank or Index register */\
	228	u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
	229	u8 access_bit_width; /* Read/Write size in bits (8-64) */
	230
4be44fcd	231	struct acpi_object_field_common { /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
61686124	232	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object region_obj; / Parent Operation Region object (REGION/BANK fields only) */
1da177e4 LT	233	};
1da177e4 LT	234
4be44fcd LB	235	struct acpi_object_region_field {
4be44fcd LB	236	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object region_obj; / Containing op_region object */
1da177e4 LT	237	};
1da177e4 LT	238
4be44fcd LB	239	struct acpi_object_bank_field {
	240	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object region_obj; / Containing op_region object */
	241	union acpi_operand_object bank_obj; / bank_select Register object */
1da177e4 LT	242	};
1da177e4 LT	243
4be44fcd LB	244	struct acpi_object_index_field {
	245	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
	246	/*
	247	* No "region_obj" pointer needed since the Index and Data registers
	248	* are each field definitions unto themselves.
	249	*/
	250	union acpi_operand_object index_obj; / Index register */
	251	union acpi_operand_object data_obj; / Data register */
1da177e4 LT	252	};
1da177e4 LT	253
1da177e4 LT	254	/* The buffer_field is different in that it is part of a Buffer, not an op_region */
1da177e4 LT	255
4be44fcd LB	256	struct acpi_object_buffer_field {
4be44fcd LB	257	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object buffer_obj; / Containing Buffer object */
1da177e4 LT	258	};
1da177e4 LT	259
1da177e4 LT	260	/******************************************************************************
	261	*
	262	* Objects for handlers
	263	*
	264	*****************************************************************************/
	265
4be44fcd LB	266	struct acpi_object_notify_handler {
	267	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node node; / Parent device */
	268	acpi_notify_handler handler;
	269	void *context;
1da177e4 LT	270	};
1da177e4 LT	271
4be44fcd LB	272	struct acpi_object_addr_handler {
4be44fcd LB	273	ACPI_OBJECT_COMMON_HEADER u8 space_id;
61686124	274	u8 handler_flags;
4be44fcd LB	275	acpi_adr_space_handler handler;
	276	struct acpi_namespace_node node; / Parent device */
	277	void *context;
	278	acpi_adr_space_setup setup;
	279	union acpi_operand_object region_list; / regions using this handler */
	280	union acpi_operand_object *next;
1da177e4 LT	281	};
1da177e4 LT	282
61686124 BM	283	/* Flags for address handler (handler_flags) */
	284
	285	#define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
	286
1da177e4 LT	287	/******************************************************************************
	288	*
	289	* Special internal objects
	290	*
	291	*****************************************************************************/
	292
	293	/*
	294	* The Reference object type is used for these opcodes:
	295	* Arg[0-6], Local[0-7], index_op, name_op, zero_op, one_op, ones_op, debug_op
	296	*/
4be44fcd LB	297	struct acpi_object_reference {
	298	ACPI_OBJECT_COMMON_HEADER u8 target_type; /* Used for index_op */
	299	u16 opcode;
61686124	300	void object; / name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
4be44fcd LB	301	struct acpi_namespace_node *node;
4be44fcd LB	302	union acpi_operand_object **where;
61686124	303	u32 offset; /* Used for arg_op, local_op, and index_op */
1da177e4 LT	304	};
1da177e4 LT	305
1da177e4 LT	306	/*
	307	* Extra object is used as additional storage for types that
	308	* have AML code in their declarations (term_args) that must be
	309	* evaluated at run time.
	310	*
	311	* Currently: Region and field_unit types
	312	*/
4be44fcd	313	struct acpi_object_extra {
61686124	314	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node method_REG; / _REG method for this region (if any) */
4be44fcd	315	void region_context; / Region-specific data */
61686124 BM	316	u8 *aml_start;
61686124 BM	317	u32 aml_length;
1da177e4 LT	318	};
1da177e4 LT	319
1da177e4 LT	320	/* Additional data that can be attached to namespace nodes */
1da177e4 LT	321
4be44fcd LB	322	struct acpi_object_data {
	323	ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
	324	void *pointer;
1da177e4 LT	325	};
1da177e4 LT	326
1da177e4 LT	327	/* Structure used when objects are cached for reuse */
1da177e4 LT	328
4be44fcd LB	329	struct acpi_object_cache_list {
4be44fcd LB	330	ACPI_OBJECT_COMMON_HEADER union acpi_operand_object next; / Link for object cache and internal lists */
1da177e4 LT	331	};
1da177e4 LT	332
1da177e4 LT	333	/******************************************************************************
	334	*
	335	* union acpi_operand_object Descriptor - a giant union of all of the above
	336	*
	337	*****************************************************************************/
	338
4be44fcd LB	339	union acpi_operand_object {
	340	struct acpi_object_common common;
	341	struct acpi_object_integer integer;
	342	struct acpi_object_string string;
	343	struct acpi_object_buffer buffer;
	344	struct acpi_object_package package;
	345	struct acpi_object_event event;
	346	struct acpi_object_method method;
	347	struct acpi_object_mutex mutex;
	348	struct acpi_object_region region;
	349	struct acpi_object_notify_common common_notify;
	350	struct acpi_object_device device;
	351	struct acpi_object_power_resource power_resource;
	352	struct acpi_object_processor processor;
	353	struct acpi_object_thermal_zone thermal_zone;
	354	struct acpi_object_field_common common_field;
	355	struct acpi_object_region_field field;
	356	struct acpi_object_buffer_field buffer_field;
	357	struct acpi_object_bank_field bank_field;
	358	struct acpi_object_index_field index_field;
	359	struct acpi_object_notify_handler notify;
	360	struct acpi_object_addr_handler address_space;
	361	struct acpi_object_reference reference;
	362	struct acpi_object_extra extra;
	363	struct acpi_object_data data;
	364	struct acpi_object_cache_list cache;
1da177e4 LT	365	};
1da177e4 LT	366
1da177e4 LT	367	/******************************************************************************
	368	*
	369	* union acpi_descriptor - objects that share a common descriptor identifier
	370	*
	371	*****************************************************************************/
	372
1da177e4 LT	373	/* Object descriptor types */
1da177e4 LT	374
4be44fcd	375	#define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
1da177e4 LT	376	#define ACPI_DESC_TYPE_STATE 0x02
	377	#define ACPI_DESC_TYPE_STATE_UPDATE 0x03
	378	#define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
	379	#define ACPI_DESC_TYPE_STATE_CONTROL 0x05
	380	#define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
	381	#define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
	382	#define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
	383	#define ACPI_DESC_TYPE_STATE_RESULT 0x09
	384	#define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
	385	#define ACPI_DESC_TYPE_STATE_THREAD 0x0B
	386	#define ACPI_DESC_TYPE_WALK 0x0C
	387	#define ACPI_DESC_TYPE_PARSER 0x0D
	388	#define ACPI_DESC_TYPE_OPERAND 0x0E
	389	#define ACPI_DESC_TYPE_NAMED 0x0F
	390	#define ACPI_DESC_TYPE_MAX 0x0F
	391
61686124 BM	392	struct acpi_common_descriptor {
	393	void *common_pointer;
	394	u8 descriptor_type; /* To differentiate various internal objs */
	395	};
	396
4be44fcd	397	union acpi_descriptor {
61686124	398	struct acpi_common_descriptor common;
4be44fcd LB	399	union acpi_operand_object object;
	400	struct acpi_namespace_node node;
	401	union acpi_parse_object op;
1da177e4 LT	402	};
1da177e4 LT	403
4be44fcd	404	#endif /* _ACOBJECT_H */