2 /******************************************************************************
4 * Name: acobject.h - Definition of union acpi_operand_object (Internal object only)
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2012, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
48 /* acpisrc:struct_defs -- for acpisrc conversion */
51 * The union acpi_operand_object is used to pass AML operands from the dispatcher
52 * to the interpreter, and to keep track of the various handlers such as
53 * address space handlers and notify handlers. The object is a constant
54 * size in order to allow it to be cached and reused.
56 * Note: The object is optimized to be aligned and will not work if it is
59 #if ACPI_MACHINE_WIDTH == 64
65 /*******************************************************************************
69 ******************************************************************************/
72 * Common area for all objects.
74 * descriptor_type is used to differentiate between internal descriptors, and
75 * must be in the same place across all descriptors
77 * Note: The descriptor_type and Type fields must appear in the identical
78 * position in both the struct acpi_namespace_node and union acpi_operand_object
81 #define ACPI_OBJECT_COMMON_HEADER \
82 union acpi_operand_object *next_object; /* Objects linked to parent NS node */\
83 u8 descriptor_type; /* To differentiate various internal objs */\
84 u8 type; /* acpi_object_type */\
85 u16 reference_count; /* For object deletion management */\
88 * Note: There are 3 bytes available here before the
89 * next natural alignment boundary (for both 32/64 cases)
92 /* Values for Flag byte above */
94 #define AOPOBJ_AML_CONSTANT 0x01 /* Integer is an AML constant */
95 #define AOPOBJ_STATIC_POINTER 0x02 /* Data is part of an ACPI table, don't delete */
96 #define AOPOBJ_DATA_VALID 0x04 /* Object is initialized and data is valid */
97 #define AOPOBJ_OBJECT_INITIALIZED 0x08 /* Region is initialized, _REG was run */
98 #define AOPOBJ_SETUP_COMPLETE 0x10 /* Region setup is complete */
99 #define AOPOBJ_INVALID 0x20 /* Host OS won't allow a Region address */
101 /******************************************************************************
105 *****************************************************************************/
107 struct acpi_object_common
{
108 ACPI_OBJECT_COMMON_HEADER
};
110 struct acpi_object_integer
{
111 ACPI_OBJECT_COMMON_HEADER u8 fill
[3]; /* Prevent warning on some compilers */
116 * Note: The String and Buffer object must be identical through the Pointer
117 * and length elements. There is code that depends on this.
119 * Fields common to both Strings and Buffers
121 #define ACPI_COMMON_BUFFER_INFO(_type) \
125 struct acpi_object_string
{ /* Null terminated, ASCII characters only */
126 ACPI_OBJECT_COMMON_HEADER
ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */
129 struct acpi_object_buffer
{
130 ACPI_OBJECT_COMMON_HEADER
ACPI_COMMON_BUFFER_INFO(u8
) /* Buffer in AML stream or allocated buffer */
133 struct acpi_namespace_node
*node
; /* Link back to parent node */
136 struct acpi_object_package
{
137 ACPI_OBJECT_COMMON_HEADER
struct acpi_namespace_node
*node
; /* Link back to parent node */
138 union acpi_operand_object
**elements
; /* Array of pointers to acpi_objects */
141 u32 count
; /* # of elements in package */
144 /******************************************************************************
148 *****************************************************************************/
150 struct acpi_object_event
{
151 ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore
; /* Actual OS synchronization object */
154 struct acpi_object_mutex
{
155 ACPI_OBJECT_COMMON_HEADER u8 sync_level
; /* 0-15, specified in Mutex() call */
156 u16 acquisition_depth
; /* Allow multiple Acquires, same thread */
157 acpi_mutex os_mutex
; /* Actual OS synchronization object */
158 acpi_thread_id thread_id
; /* Current owner of the mutex */
159 struct acpi_thread_state
*owner_thread
; /* Current owner of the mutex */
160 union acpi_operand_object
*prev
; /* Link for list of acquired mutexes */
161 union acpi_operand_object
*next
; /* Link for list of acquired mutexes */
162 struct acpi_namespace_node
*node
; /* Containing namespace node */
163 u8 original_sync_level
; /* Owner's original sync level (0-15) */
166 struct acpi_object_region
{
167 ACPI_OBJECT_COMMON_HEADER u8 space_id
;
168 struct acpi_namespace_node
*node
; /* Containing namespace node */
169 union acpi_operand_object
*handler
; /* Handler for region access */
170 union acpi_operand_object
*next
;
171 acpi_physical_address address
;
175 struct acpi_object_method
{
176 ACPI_OBJECT_COMMON_HEADER u8 info_flags
;
179 union acpi_operand_object
*mutex
;
182 ACPI_INTERNAL_METHOD implementation
;
183 union acpi_operand_object
*handler
;
188 acpi_owner_id owner_id
;
191 /* Flags for info_flags field above */
193 #define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */
194 #define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */
195 #define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */
196 #define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */
197 #define ACPI_METHOD_MODIFIED_NAMESPACE 0x10 /* Method modified the namespace */
199 /******************************************************************************
201 * Objects that can be notified. All share a common notify_info area.
203 *****************************************************************************/
206 * Common fields for objects that support ASL notifications
208 #define ACPI_COMMON_NOTIFY_INFO \
209 union acpi_operand_object *system_notify; /* Handler for system notifies */\
210 union acpi_operand_object *device_notify; /* Handler for driver notifies */\
211 union acpi_operand_object *handler; /* Handler for Address space */
213 struct acpi_object_notify_common
{ /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
214 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO
};
216 struct acpi_object_device
{
217 ACPI_OBJECT_COMMON_HEADER
218 ACPI_COMMON_NOTIFY_INFO
struct acpi_gpe_block_info
*gpe_block
;
221 struct acpi_object_power_resource
{
222 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level
;
226 struct acpi_object_processor
{
227 ACPI_OBJECT_COMMON_HEADER
228 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
231 ACPI_COMMON_NOTIFY_INFO acpi_io_address address
;
234 struct acpi_object_thermal_zone
{
235 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO
};
237 /******************************************************************************
239 * Fields. All share a common header/info field.
241 *****************************************************************************/
244 * Common bitfield for the field objects
245 * "Field Datum" -- a datum from the actual field object
246 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
248 #define ACPI_COMMON_FIELD_INFO \
249 u8 field_flags; /* Access, update, and lock bits */\
250 u8 attribute; /* From access_as keyword */\
251 u8 access_byte_width; /* Read/Write size in bytes */\
252 struct acpi_namespace_node *node; /* Link back to parent node */\
253 u32 bit_length; /* Length of field in bits */\
254 u32 base_byte_offset; /* Byte offset within containing object */\
255 u32 value; /* Value to store into the Bank or Index register */\
256 u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
257 u8 access_length; /* For serial regions/fields */
260 struct acpi_object_field_common
{ /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
261 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
union acpi_operand_object
*region_obj
; /* Parent Operation Region object (REGION/BANK fields only) */
264 struct acpi_object_region_field
{
265 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u16 resource_length
;
266 union acpi_operand_object
*region_obj
; /* Containing op_region object */
267 u8
*resource_buffer
; /* resource_template for serial regions/fields */
270 struct acpi_object_bank_field
{
271 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
union acpi_operand_object
*region_obj
; /* Containing op_region object */
272 union acpi_operand_object
*bank_obj
; /* bank_select Register object */
275 struct acpi_object_index_field
{
276 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
278 * No "RegionObj" pointer needed since the Index and Data registers
279 * are each field definitions unto themselves.
281 union acpi_operand_object
*index_obj
; /* Index register */
282 union acpi_operand_object
*data_obj
; /* Data register */
285 /* The buffer_field is different in that it is part of a Buffer, not an op_region */
287 struct acpi_object_buffer_field
{
288 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
union acpi_operand_object
*buffer_obj
; /* Containing Buffer object */
291 /******************************************************************************
293 * Objects for handlers
295 *****************************************************************************/
297 struct acpi_object_notify_handler
{
298 ACPI_OBJECT_COMMON_HEADER
struct acpi_namespace_node
*node
; /* Parent device */
300 acpi_notify_handler handler
;
302 struct acpi_object_notify_handler
*next
;
305 struct acpi_object_addr_handler
{
306 ACPI_OBJECT_COMMON_HEADER u8 space_id
;
308 acpi_adr_space_handler handler
;
309 struct acpi_namespace_node
*node
; /* Parent device */
311 acpi_adr_space_setup setup
;
312 union acpi_operand_object
*region_list
; /* regions using this handler */
313 union acpi_operand_object
*next
;
316 /* Flags for address handler (handler_flags) */
318 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
320 /******************************************************************************
322 * Special internal objects
324 *****************************************************************************/
327 * The Reference object is used for these opcodes:
328 * Arg[0-6], Local[0-7], index_op, name_op, ref_of_op, load_op, load_table_op, debug_op
329 * The Reference.Class differentiates these types.
331 struct acpi_object_reference
{
332 ACPI_OBJECT_COMMON_HEADER u8
class; /* Reference Class */
333 u8 target_type
; /* Used for Index Op */
335 void *object
; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
336 struct acpi_namespace_node
*node
; /* ref_of or Namepath */
337 union acpi_operand_object
**where
; /* Target of Index */
338 u32 value
; /* Used for Local/Arg/Index/ddb_handle */
341 /* Values for Reference.Class above */
344 ACPI_REFCLASS_LOCAL
= 0, /* Method local */
345 ACPI_REFCLASS_ARG
= 1, /* Method argument */
346 ACPI_REFCLASS_REFOF
= 2, /* Result of ref_of() TBD: Split to Ref/Node and Ref/operand_obj? */
347 ACPI_REFCLASS_INDEX
= 3, /* Result of Index() */
348 ACPI_REFCLASS_TABLE
= 4, /* ddb_handle - Load(), load_table() */
349 ACPI_REFCLASS_NAME
= 5, /* Reference to a named object */
350 ACPI_REFCLASS_DEBUG
= 6, /* Debug object */
352 ACPI_REFCLASS_MAX
= 6
353 } ACPI_REFERENCE_CLASSES
;
356 * Extra object is used as additional storage for types that
357 * have AML code in their declarations (term_args) that must be
358 * evaluated at run time.
360 * Currently: Region and field_unit types
362 struct acpi_object_extra
{
363 ACPI_OBJECT_COMMON_HEADER
struct acpi_namespace_node
*method_REG
; /* _REG method for this region (if any) */
364 struct acpi_namespace_node
*scope_node
;
365 void *region_context
; /* Region-specific data */
370 /* Additional data that can be attached to namespace nodes */
372 struct acpi_object_data
{
373 ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler
;
377 /* Structure used when objects are cached for reuse */
379 struct acpi_object_cache_list
{
380 ACPI_OBJECT_COMMON_HEADER
union acpi_operand_object
*next
; /* Link for object cache and internal lists */
383 /******************************************************************************
385 * union acpi_operand_object Descriptor - a giant union of all of the above
387 *****************************************************************************/
389 union acpi_operand_object
{
390 struct acpi_object_common common
;
391 struct acpi_object_integer integer
;
392 struct acpi_object_string string
;
393 struct acpi_object_buffer buffer
;
394 struct acpi_object_package package
;
395 struct acpi_object_event event
;
396 struct acpi_object_method method
;
397 struct acpi_object_mutex mutex
;
398 struct acpi_object_region region
;
399 struct acpi_object_notify_common common_notify
;
400 struct acpi_object_device device
;
401 struct acpi_object_power_resource power_resource
;
402 struct acpi_object_processor processor
;
403 struct acpi_object_thermal_zone thermal_zone
;
404 struct acpi_object_field_common common_field
;
405 struct acpi_object_region_field field
;
406 struct acpi_object_buffer_field buffer_field
;
407 struct acpi_object_bank_field bank_field
;
408 struct acpi_object_index_field index_field
;
409 struct acpi_object_notify_handler notify
;
410 struct acpi_object_addr_handler address_space
;
411 struct acpi_object_reference reference
;
412 struct acpi_object_extra extra
;
413 struct acpi_object_data data
;
414 struct acpi_object_cache_list cache
;
417 * Add namespace node to union in order to simplify code that accepts both
418 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
419 * a common descriptor_type field in order to differentiate them.
421 struct acpi_namespace_node node
;
424 /******************************************************************************
426 * union acpi_descriptor - objects that share a common descriptor identifier
428 *****************************************************************************/
430 /* Object descriptor types */
432 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
433 #define ACPI_DESC_TYPE_STATE 0x02
434 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03
435 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
436 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05
437 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
438 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
439 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
440 #define ACPI_DESC_TYPE_STATE_RESULT 0x09
441 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
442 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B
443 #define ACPI_DESC_TYPE_WALK 0x0C
444 #define ACPI_DESC_TYPE_PARSER 0x0D
445 #define ACPI_DESC_TYPE_OPERAND 0x0E
446 #define ACPI_DESC_TYPE_NAMED 0x0F
447 #define ACPI_DESC_TYPE_MAX 0x0F
449 struct acpi_common_descriptor
{
450 void *common_pointer
;
451 u8 descriptor_type
; /* To differentiate various internal objs */
454 union acpi_descriptor
{
455 struct acpi_common_descriptor common
;
456 union acpi_operand_object object
;
457 struct acpi_namespace_node node
;
458 union acpi_parse_object op
;
463 #endif /* _ACOBJECT_H */