blob: cc7ab6dd724e6234a835d0321c8cb4b6106796f4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
Bob Moore616861242006-03-17 16:44:00 -05003 * Name: acobject.h - Definition of union acpi_operand_object (Internal object only)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 *****************************************************************************/
6
7/*
Bob Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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 _ACOBJECT_H
45#define _ACOBJECT_H
46
Bob Moore616861242006-03-17 16:44:00 -050047/* acpisrc:struct_defs -- for acpisrc conversion */
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
Bob Moore616861242006-03-17 16:44:00 -050050 * The union acpi_operand_object is used to pass AML operands from the dispatcher
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * to the interpreter, and to keep track of the various handlers such as
Bob Moore616861242006-03-17 16:44:00 -050052 * address space handlers and notify handlers. The object is a constant
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * size in order to allow it to be cached and reused.
Bob Moore7c9626b2007-02-02 19:48:23 +030054 *
55 * Note: The object is optimized to be aligned and will not work if it is
56 * byte-packed.
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 */
Bob Moore7c9626b2007-02-02 19:48:23 +030058#if ACPI_MACHINE_WIDTH == 64
59#pragma pack(8)
60#else
61#pragma pack(4)
62#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64/*******************************************************************************
65 *
66 * Common Descriptors
67 *
68 ******************************************************************************/
69
70/*
71 * Common area for all objects.
72 *
Bob Moore616861242006-03-17 16:44:00 -050073 * descriptor_type is used to differentiate between internal descriptors, and
74 * must be in the same place across all descriptors
Bob Moore793c2382006-03-31 00:00:00 -050075 *
76 * Note: The descriptor_type and Type fields must appear in the identical
77 * position in both the struct acpi_namespace_node and union acpi_operand_object
78 * structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 */
Bob Moore616861242006-03-17 16:44:00 -050080#define ACPI_OBJECT_COMMON_HEADER \
81 union acpi_operand_object *next_object; /* Objects linked to parent NS node */\
82 u8 descriptor_type; /* To differentiate various internal objs */\
83 u8 type; /* acpi_object_type */\
84 u16 reference_count; /* For object deletion management */\
85 u8 flags;
86 /*
87 * Note: There are 3 bytes available here before the
88 * next natural alignment boundary (for both 32/64 cases)
89 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Bob Moore616861242006-03-17 16:44:00 -050091/* Values for Flag byte above */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Bob Moore20d33ae2010-05-27 09:27:34 +080093#define AOPOBJ_AML_CONSTANT 0x01 /* Integer is an AML constant */
94#define AOPOBJ_STATIC_POINTER 0x02 /* Data is part of an ACPI table, don't delete */
Uwe Kleine-Königb5950762010-11-01 15:38:34 -040095#define AOPOBJ_DATA_VALID 0x04 /* Object is initialized and data is valid */
Bob Moore20d33ae2010-05-27 09:27:34 +080096#define AOPOBJ_OBJECT_INITIALIZED 0x08 /* Region is initialized, _REG was run */
97#define AOPOBJ_SETUP_COMPLETE 0x10 /* Region setup is complete */
98#define AOPOBJ_INVALID 0x20 /* Host OS won't allow a Region address */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100/******************************************************************************
101 *
102 * Basic data types
103 *
104 *****************************************************************************/
105
Len Brown4be44fc2005-08-05 00:44:28 -0400106struct acpi_object_common {
107ACPI_OBJECT_COMMON_HEADER};
108
109struct acpi_object_integer {
Bob Moore7c9626b2007-02-02 19:48:23 +0300110 ACPI_OBJECT_COMMON_HEADER u8 fill[3]; /* Prevent warning on some compilers */
Bob Moore5df7e6c2010-01-21 10:06:32 +0800111 u64 value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112};
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/*
Bob Moorecf489582012-07-16 09:52:27 +0800115 * Note: The String and Buffer object must be identical through the
116 * pointer and length elements. There is code that depends on this.
Bob Moore616861242006-03-17 16:44:00 -0500117 *
118 * Fields common to both Strings and Buffers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
Bob Moore616861242006-03-17 16:44:00 -0500120#define ACPI_COMMON_BUFFER_INFO(_type) \
121 _type *pointer; \
122 u32 length;
123
Len Brown4be44fc2005-08-05 00:44:28 -0400124struct acpi_object_string { /* Null terminated, ASCII characters only */
Bob Moore616861242006-03-17 16:44:00 -0500125 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126};
127
Len Brown4be44fc2005-08-05 00:44:28 -0400128struct acpi_object_buffer {
Bob Moore616861242006-03-17 16:44:00 -0500129 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8) /* Buffer in AML stream or allocated buffer */
Len Brown4be44fc2005-08-05 00:44:28 -0400130 u32 aml_length;
Bob Moore616861242006-03-17 16:44:00 -0500131 u8 *aml_start;
132 struct acpi_namespace_node *node; /* Link back to parent node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133};
134
Len Brown4be44fc2005-08-05 00:44:28 -0400135struct acpi_object_package {
Bob Moore616861242006-03-17 16:44:00 -0500136 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Link back to parent node */
Len Brown4be44fc2005-08-05 00:44:28 -0400137 union acpi_operand_object **elements; /* Array of pointers to acpi_objects */
Bob Moore616861242006-03-17 16:44:00 -0500138 u8 *aml_start;
139 u32 aml_length;
140 u32 count; /* # of elements in package */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141};
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143/******************************************************************************
144 *
145 * Complex data types
146 *
147 *****************************************************************************/
148
Len Brown4be44fc2005-08-05 00:44:28 -0400149struct acpi_object_event {
Bob Moore967440e32006-06-23 17:04:00 -0400150 ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore; /* Actual OS synchronization object */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151};
152
Len Brown4be44fc2005-08-05 00:44:28 -0400153struct acpi_object_mutex {
154 ACPI_OBJECT_COMMON_HEADER u8 sync_level; /* 0-15, specified in Mutex() call */
155 u16 acquisition_depth; /* Allow multiple Acquires, same thread */
Bob Moore967440e32006-06-23 17:04:00 -0400156 acpi_mutex os_mutex; /* Actual OS synchronization object */
Bob Mooreba886cd2008-04-10 19:06:37 +0400157 acpi_thread_id thread_id; /* Current owner of the mutex */
158 struct acpi_thread_state *owner_thread; /* Current owner of the mutex */
Len Brown4be44fc2005-08-05 00:44:28 -0400159 union acpi_operand_object *prev; /* Link for list of acquired mutexes */
160 union acpi_operand_object *next; /* Link for list of acquired mutexes */
161 struct acpi_namespace_node *node; /* Containing namespace node */
162 u8 original_sync_level; /* Owner's original sync level (0-15) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163};
164
Len Brown4be44fc2005-08-05 00:44:28 -0400165struct acpi_object_region {
166 ACPI_OBJECT_COMMON_HEADER u8 space_id;
Len Brown4be44fc2005-08-05 00:44:28 -0400167 struct acpi_namespace_node *node; /* Containing namespace node */
Bob Moore616861242006-03-17 16:44:00 -0500168 union acpi_operand_object *handler; /* Handler for region access */
Len Brown4be44fc2005-08-05 00:44:28 -0400169 union acpi_operand_object *next;
Len Brown4be44fc2005-08-05 00:44:28 -0400170 acpi_physical_address address;
Bob Moore616861242006-03-17 16:44:00 -0500171 u32 length;
172};
173
174struct acpi_object_method {
Lin Ming26294842011-01-12 09:19:43 +0800175 ACPI_OBJECT_COMMON_HEADER u8 info_flags;
Bob Moore616861242006-03-17 16:44:00 -0500176 u8 param_count;
Bob Moore967440e32006-06-23 17:04:00 -0400177 u8 sync_level;
178 union acpi_operand_object *mutex;
Bob Moore616861242006-03-17 16:44:00 -0500179 u8 *aml_start;
Lin Minge31c32c2009-12-11 15:28:27 +0800180 union {
Lv Zheng644ef742012-10-31 02:25:36 +0000181 acpi_internal_method implementation;
Lin Minge31c32c2009-12-11 15:28:27 +0800182 union acpi_operand_object *handler;
Lin Ming26294842011-01-12 09:19:43 +0800183 } dispatch;
Lin Minge31c32c2009-12-11 15:28:27 +0800184
Bob Moore616861242006-03-17 16:44:00 -0500185 u32 aml_length;
186 u8 thread_count;
187 acpi_owner_id owner_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188};
189
Lin Ming26294842011-01-12 09:19:43 +0800190/* Flags for info_flags field above */
191
192#define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */
193#define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */
194#define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */
195#define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */
196#define ACPI_METHOD_MODIFIED_NAMESPACE 0x10 /* Method modified the namespace */
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198/******************************************************************************
199 *
Bob Moore73a30902012-10-31 02:26:55 +0000200 * Objects that can be notified. All share a common notify_info area.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 *
202 *****************************************************************************/
203
Bob Moore616861242006-03-17 16:44:00 -0500204/*
205 * Common fields for objects that support ASL notifications
206 */
207#define ACPI_COMMON_NOTIFY_INFO \
Bob Moore86ed4bc2012-05-03 11:08:19 +0800208 union acpi_operand_object *notify_list[2]; /* Handlers for system/device notifies */\
Bob Moore616861242006-03-17 16:44:00 -0500209 union acpi_operand_object *handler; /* Handler for Address space */
210
Len Brown4be44fc2005-08-05 00:44:28 -0400211struct acpi_object_notify_common { /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
212ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
213
214struct acpi_object_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 ACPI_OBJECT_COMMON_HEADER
Len Brown4be44fc2005-08-05 00:44:28 -0400216 ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217};
218
Len Brown4be44fc2005-08-05 00:44:28 -0400219struct acpi_object_power_resource {
220 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
221 u32 resource_order;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222};
223
Len Brown4be44fc2005-08-05 00:44:28 -0400224struct acpi_object_processor {
Bob Moore7c9626b2007-02-02 19:48:23 +0300225 ACPI_OBJECT_COMMON_HEADER
226 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
227 u8 proc_id;
Bob Moore616861242006-03-17 16:44:00 -0500228 u8 length;
Len Brownfd350942007-05-09 23:34:35 -0400229 ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230};
231
Len Brown4be44fc2005-08-05 00:44:28 -0400232struct acpi_object_thermal_zone {
233ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235/******************************************************************************
236 *
Bob Moore73a30902012-10-31 02:26:55 +0000237 * Fields. All share a common header/info field.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 *
239 *****************************************************************************/
240
Bob Moore616861242006-03-17 16:44:00 -0500241/*
242 * Common bitfield for the field objects
243 * "Field Datum" -- a datum from the actual field object
244 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
245 */
246#define ACPI_COMMON_FIELD_INFO \
247 u8 field_flags; /* Access, update, and lock bits */\
248 u8 attribute; /* From access_as keyword */\
249 u8 access_byte_width; /* Read/Write size in bytes */\
250 struct acpi_namespace_node *node; /* Link back to parent node */\
251 u32 bit_length; /* Length of field in bits */\
252 u32 base_byte_offset; /* Byte offset within containing object */\
253 u32 value; /* Value to store into the Bank or Index register */\
254 u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
Bob Moore9ce81782011-11-16 13:39:07 +0800255 u8 access_length; /* For serial regions/fields */
Bob Moore09387b42010-08-06 09:09:33 +0800256
Bob Moore616861242006-03-17 16:44:00 -0500257
Len Brown4be44fc2005-08-05 00:44:28 -0400258struct acpi_object_field_common { /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
Bob Moore616861242006-03-17 16:44:00 -0500259 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Parent Operation Region object (REGION/BANK fields only) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260};
261
Len Brown4be44fc2005-08-05 00:44:28 -0400262struct acpi_object_region_field {
Bob Moore9ce81782011-11-16 13:39:07 +0800263 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u16 resource_length;
264 union acpi_operand_object *region_obj; /* Containing op_region object */
265 u8 *resource_buffer; /* resource_template for serial regions/fields */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266};
267
Len Brown4be44fc2005-08-05 00:44:28 -0400268struct acpi_object_bank_field {
269 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */
270 union acpi_operand_object *bank_obj; /* bank_select Register object */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271};
272
Len Brown4be44fc2005-08-05 00:44:28 -0400273struct acpi_object_index_field {
274 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
275 /*
Bob Mooreb229cf92006-04-21 17:15:00 -0400276 * No "RegionObj" pointer needed since the Index and Data registers
Len Brown4be44fc2005-08-05 00:44:28 -0400277 * are each field definitions unto themselves.
278 */
279 union acpi_operand_object *index_obj; /* Index register */
280 union acpi_operand_object *data_obj; /* Data register */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283/* The buffer_field is different in that it is part of a Buffer, not an op_region */
284
Len Brown4be44fc2005-08-05 00:44:28 -0400285struct acpi_object_buffer_field {
286 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *buffer_obj; /* Containing Buffer object */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287};
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289/******************************************************************************
290 *
291 * Objects for handlers
292 *
293 *****************************************************************************/
294
Len Brown4be44fc2005-08-05 00:44:28 -0400295struct acpi_object_notify_handler {
296 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Parent device */
Bob Moore86ed4bc2012-05-03 11:08:19 +0800297 u32 handler_type; /* Type: Device/System/Both */
298 acpi_notify_handler handler; /* Handler address */
Len Brown4be44fc2005-08-05 00:44:28 -0400299 void *context;
Bob Moore86ed4bc2012-05-03 11:08:19 +0800300 union acpi_operand_object *next[2]; /* Device and System handler lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301};
302
Len Brown4be44fc2005-08-05 00:44:28 -0400303struct acpi_object_addr_handler {
304 ACPI_OBJECT_COMMON_HEADER u8 space_id;
Bob Moore616861242006-03-17 16:44:00 -0500305 u8 handler_flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400306 acpi_adr_space_handler handler;
307 struct acpi_namespace_node *node; /* Parent device */
308 void *context;
309 acpi_adr_space_setup setup;
Lv Zheng75c80442012-12-19 05:36:49 +0000310 union acpi_operand_object *region_list; /* Regions using this handler */
Len Brown4be44fc2005-08-05 00:44:28 -0400311 union acpi_operand_object *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312};
313
Bob Moore616861242006-03-17 16:44:00 -0500314/* Flags for address handler (handler_flags) */
315
316#define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318/******************************************************************************
319 *
320 * Special internal objects
321 *
322 *****************************************************************************/
323
324/*
Bob Moore1044f1f2008-09-27 11:08:41 +0800325 * The Reference object is used for these opcodes:
326 * Arg[0-6], Local[0-7], index_op, name_op, ref_of_op, load_op, load_table_op, debug_op
327 * The Reference.Class differentiates these types.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
Len Brown4be44fc2005-08-05 00:44:28 -0400329struct acpi_object_reference {
Bob Moore1044f1f2008-09-27 11:08:41 +0800330 ACPI_OBJECT_COMMON_HEADER u8 class; /* Reference Class */
331 u8 target_type; /* Used for Index Op */
332 u8 reserved;
Bob Moore616861242006-03-17 16:44:00 -0500333 void *object; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
Bob Moore1044f1f2008-09-27 11:08:41 +0800334 struct acpi_namespace_node *node; /* ref_of or Namepath */
335 union acpi_operand_object **where; /* Target of Index */
336 u32 value; /* Used for Local/Arg/Index/ddb_handle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337};
338
Bob Moore1044f1f2008-09-27 11:08:41 +0800339/* Values for Reference.Class above */
340
341typedef enum {
342 ACPI_REFCLASS_LOCAL = 0, /* Method local */
343 ACPI_REFCLASS_ARG = 1, /* Method argument */
344 ACPI_REFCLASS_REFOF = 2, /* Result of ref_of() TBD: Split to Ref/Node and Ref/operand_obj? */
345 ACPI_REFCLASS_INDEX = 3, /* Result of Index() */
346 ACPI_REFCLASS_TABLE = 4, /* ddb_handle - Load(), load_table() */
347 ACPI_REFCLASS_NAME = 5, /* Reference to a named object */
348 ACPI_REFCLASS_DEBUG = 6, /* Debug object */
349
350 ACPI_REFCLASS_MAX = 6
351} ACPI_REFERENCE_CLASSES;
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353/*
354 * Extra object is used as additional storage for types that
355 * have AML code in their declarations (term_args) that must be
356 * evaluated at run time.
357 *
358 * Currently: Region and field_unit types
359 */
Len Brown4be44fc2005-08-05 00:44:28 -0400360struct acpi_object_extra {
Bob Moore616861242006-03-17 16:44:00 -0500361 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG; /* _REG method for this region (if any) */
Lin Ming8931d9e2011-11-28 09:46:02 +0800362 struct acpi_namespace_node *scope_node;
Len Brown4be44fc2005-08-05 00:44:28 -0400363 void *region_context; /* Region-specific data */
Bob Moore616861242006-03-17 16:44:00 -0500364 u8 *aml_start;
365 u32 aml_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366};
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/* Additional data that can be attached to namespace nodes */
369
Len Brown4be44fc2005-08-05 00:44:28 -0400370struct acpi_object_data {
371 ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
372 void *pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373};
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375/* Structure used when objects are cached for reuse */
376
Len Brown4be44fc2005-08-05 00:44:28 -0400377struct acpi_object_cache_list {
378 ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next; /* Link for object cache and internal lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379};
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381/******************************************************************************
382 *
Bob Mooreba494be2012-07-12 09:40:10 +0800383 * union acpi_operand_object descriptor - a giant union of all of the above
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 *
385 *****************************************************************************/
386
Len Brown4be44fc2005-08-05 00:44:28 -0400387union acpi_operand_object {
388 struct acpi_object_common common;
389 struct acpi_object_integer integer;
390 struct acpi_object_string string;
391 struct acpi_object_buffer buffer;
392 struct acpi_object_package package;
393 struct acpi_object_event event;
394 struct acpi_object_method method;
395 struct acpi_object_mutex mutex;
396 struct acpi_object_region region;
397 struct acpi_object_notify_common common_notify;
398 struct acpi_object_device device;
399 struct acpi_object_power_resource power_resource;
400 struct acpi_object_processor processor;
401 struct acpi_object_thermal_zone thermal_zone;
402 struct acpi_object_field_common common_field;
403 struct acpi_object_region_field field;
404 struct acpi_object_buffer_field buffer_field;
405 struct acpi_object_bank_field bank_field;
406 struct acpi_object_index_field index_field;
407 struct acpi_object_notify_handler notify;
408 struct acpi_object_addr_handler address_space;
409 struct acpi_object_reference reference;
410 struct acpi_object_extra extra;
411 struct acpi_object_data data;
412 struct acpi_object_cache_list cache;
Bob Moore8d5c54b2008-09-27 10:22:09 +0800413
414 /*
415 * Add namespace node to union in order to simplify code that accepts both
416 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
417 * a common descriptor_type field in order to differentiate them.
418 */
419 struct acpi_namespace_node node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420};
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/******************************************************************************
423 *
424 * union acpi_descriptor - objects that share a common descriptor identifier
425 *
426 *****************************************************************************/
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428/* Object descriptor types */
429
Len Brown4be44fc2005-08-05 00:44:28 -0400430#define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431#define ACPI_DESC_TYPE_STATE 0x02
432#define ACPI_DESC_TYPE_STATE_UPDATE 0x03
433#define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
434#define ACPI_DESC_TYPE_STATE_CONTROL 0x05
435#define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
436#define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
437#define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
438#define ACPI_DESC_TYPE_STATE_RESULT 0x09
439#define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
440#define ACPI_DESC_TYPE_STATE_THREAD 0x0B
441#define ACPI_DESC_TYPE_WALK 0x0C
442#define ACPI_DESC_TYPE_PARSER 0x0D
443#define ACPI_DESC_TYPE_OPERAND 0x0E
444#define ACPI_DESC_TYPE_NAMED 0x0F
445#define ACPI_DESC_TYPE_MAX 0x0F
446
Bob Moore616861242006-03-17 16:44:00 -0500447struct acpi_common_descriptor {
448 void *common_pointer;
449 u8 descriptor_type; /* To differentiate various internal objs */
450};
451
Len Brown4be44fc2005-08-05 00:44:28 -0400452union acpi_descriptor {
Bob Moore616861242006-03-17 16:44:00 -0500453 struct acpi_common_descriptor common;
Len Brown4be44fc2005-08-05 00:44:28 -0400454 union acpi_operand_object object;
455 struct acpi_namespace_node node;
456 union acpi_parse_object op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457};
458
Bob Moore7c9626b2007-02-02 19:48:23 +0300459#pragma pack()
460
Len Brown4be44fc2005-08-05 00:44:28 -0400461#endif /* _ACOBJECT_H */