xref: /openbmc/linux/drivers/acpi/acpica/acobject.h (revision 612c2932)
195857638SErik Schmauss /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2e2f7a777SLen Brown /******************************************************************************
3e2f7a777SLen Brown  *
4e2f7a777SLen Brown  * Name: acobject.h - Definition of union acpi_operand_object  (Internal object only)
5e2f7a777SLen Brown  *
6*612c2932SBob Moore  * Copyright (C) 2000 - 2023, Intel Corp.
7e2f7a777SLen Brown  *
895857638SErik Schmauss  *****************************************************************************/
9e2f7a777SLen Brown 
10e2f7a777SLen Brown #ifndef _ACOBJECT_H
11e2f7a777SLen Brown #define _ACOBJECT_H
12e2f7a777SLen Brown 
13e2f7a777SLen Brown /* acpisrc:struct_defs -- for acpisrc conversion */
14e2f7a777SLen Brown 
15e2f7a777SLen Brown /*
16e2f7a777SLen Brown  * The union acpi_operand_object is used to pass AML operands from the dispatcher
17e2f7a777SLen Brown  * to the interpreter, and to keep track of the various handlers such as
18e2f7a777SLen Brown  * address space handlers and notify handlers. The object is a constant
19e2f7a777SLen Brown  * size in order to allow it to be cached and reused.
20e2f7a777SLen Brown  *
21e2f7a777SLen Brown  * Note: The object is optimized to be aligned and will not work if it is
22e2f7a777SLen Brown  * byte-packed.
23e2f7a777SLen Brown  */
24e2f7a777SLen Brown #if ACPI_MACHINE_WIDTH == 64
25e2f7a777SLen Brown #pragma pack(8)
26e2f7a777SLen Brown #else
27e2f7a777SLen Brown #pragma pack(4)
28e2f7a777SLen Brown #endif
29e2f7a777SLen Brown 
30e2f7a777SLen Brown /*******************************************************************************
31e2f7a777SLen Brown  *
32e2f7a777SLen Brown  * Common Descriptors
33e2f7a777SLen Brown  *
34e2f7a777SLen Brown  ******************************************************************************/
35e2f7a777SLen Brown 
36e2f7a777SLen Brown /*
37e2f7a777SLen Brown  * Common area for all objects.
38e2f7a777SLen Brown  *
39e2f7a777SLen Brown  * descriptor_type is used to differentiate between internal descriptors, and
40e2f7a777SLen Brown  * must be in the same place across all descriptors
41e2f7a777SLen Brown  *
42e2f7a777SLen Brown  * Note: The descriptor_type and Type fields must appear in the identical
43e2f7a777SLen Brown  * position in both the struct acpi_namespace_node and union acpi_operand_object
44e2f7a777SLen Brown  * structures.
45e2f7a777SLen Brown  */
46e2f7a777SLen Brown #define ACPI_OBJECT_COMMON_HEADER \
47e2f7a777SLen Brown 	union acpi_operand_object       *next_object;       /* Objects linked to parent NS node */\
48e2f7a777SLen Brown 	u8                              descriptor_type;    /* To differentiate various internal objs */\
49e2f7a777SLen Brown 	u8                              type;               /* acpi_object_type */\
50e2f7a777SLen Brown 	u16                             reference_count;    /* For object deletion management */\
51e2f7a777SLen Brown 	u8                              flags;
52e2f7a777SLen Brown 	/*
53e2f7a777SLen Brown 	 * Note: There are 3 bytes available here before the
54e2f7a777SLen Brown 	 * next natural alignment boundary (for both 32/64 cases)
55e2f7a777SLen Brown 	 */
56e2f7a777SLen Brown 
57e2f7a777SLen Brown /* Values for Flag byte above */
58e2f7a777SLen Brown 
5920d33aeaSBob Moore #define AOPOBJ_AML_CONSTANT         0x01	/* Integer is an AML constant */
6020d33aeaSBob Moore #define AOPOBJ_STATIC_POINTER       0x02	/* Data is part of an ACPI table, don't delete */
61b595076aSUwe Kleine-König #define AOPOBJ_DATA_VALID           0x04	/* Object is initialized and data is valid */
62efaed9beSLv Zheng #define AOPOBJ_OBJECT_INITIALIZED   0x08	/* Region is initialized */
63efaed9beSLv Zheng #define AOPOBJ_REG_CONNECTED        0x10	/* _REG was run */
64efaed9beSLv Zheng #define AOPOBJ_SETUP_COMPLETE       0x20	/* Region setup is complete */
65efaed9beSLv Zheng #define AOPOBJ_INVALID              0x40	/* Host OS won't allow a Region address */
66e2f7a777SLen Brown 
67e2f7a777SLen Brown /******************************************************************************
68e2f7a777SLen Brown  *
69e2f7a777SLen Brown  * Basic data types
70e2f7a777SLen Brown  *
71e2f7a777SLen Brown  *****************************************************************************/
72e2f7a777SLen Brown 
73e2f7a777SLen Brown struct acpi_object_common {
74e2f7a777SLen Brown ACPI_OBJECT_COMMON_HEADER};
75e2f7a777SLen Brown 
76e2f7a777SLen Brown struct acpi_object_integer {
77e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER u8 fill[3];	/* Prevent warning on some compilers */
785df7e6cbSBob Moore 	u64 value;
79e2f7a777SLen Brown };
80e2f7a777SLen Brown 
81e2f7a777SLen Brown /*
82cf48958eSBob Moore  * Note: The String and Buffer object must be identical through the
83cf48958eSBob Moore  * pointer and length elements. There is code that depends on this.
84e2f7a777SLen Brown  *
85e2f7a777SLen Brown  * Fields common to both Strings and Buffers
86e2f7a777SLen Brown  */
87e2f7a777SLen Brown #define ACPI_COMMON_BUFFER_INFO(_type) \
88e2f7a777SLen Brown 	_type                           *pointer; \
89e2f7a777SLen Brown 	u32                             length;
90e2f7a777SLen Brown 
917679c35dSLv Zheng /* Null terminated, ASCII characters only */
927679c35dSLv Zheng 
937679c35dSLv Zheng struct acpi_object_string {
94e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char)	/* String in AML stream or allocated string */
95e2f7a777SLen Brown };
96e2f7a777SLen Brown 
97e2f7a777SLen Brown struct acpi_object_buffer {
98e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8)	/* Buffer in AML stream or allocated buffer */
99e2f7a777SLen Brown 	u32 aml_length;
100e2f7a777SLen Brown 	u8 *aml_start;
101e2f7a777SLen Brown 	struct acpi_namespace_node *node;	/* Link back to parent node */
102e2f7a777SLen Brown };
103e2f7a777SLen Brown 
104e2f7a777SLen Brown struct acpi_object_package {
105e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node;	/* Link back to parent node */
106e2f7a777SLen Brown 	union acpi_operand_object **elements;	/* Array of pointers to acpi_objects */
107e2f7a777SLen Brown 	u8 *aml_start;
108e2f7a777SLen Brown 	u32 aml_length;
109e2f7a777SLen Brown 	u32 count;		/* # of elements in package */
110e2f7a777SLen Brown };
111e2f7a777SLen Brown 
112e2f7a777SLen Brown /******************************************************************************
113e2f7a777SLen Brown  *
114e2f7a777SLen Brown  * Complex data types
115e2f7a777SLen Brown  *
116e2f7a777SLen Brown  *****************************************************************************/
117e2f7a777SLen Brown 
118e2f7a777SLen Brown struct acpi_object_event {
119e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore;	/* Actual OS synchronization object */
120e2f7a777SLen Brown };
121e2f7a777SLen Brown 
122e2f7a777SLen Brown struct acpi_object_mutex {
123e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER u8 sync_level;	/* 0-15, specified in Mutex() call */
124e2f7a777SLen Brown 	u16 acquisition_depth;	/* Allow multiple Acquires, same thread */
125e2f7a777SLen Brown 	acpi_mutex os_mutex;	/* Actual OS synchronization object */
126e2f7a777SLen Brown 	acpi_thread_id thread_id;	/* Current owner of the mutex */
127e2f7a777SLen Brown 	struct acpi_thread_state *owner_thread;	/* Current owner of the mutex */
128e2f7a777SLen Brown 	union acpi_operand_object *prev;	/* Link for list of acquired mutexes */
129e2f7a777SLen Brown 	union acpi_operand_object *next;	/* Link for list of acquired mutexes */
130e2f7a777SLen Brown 	struct acpi_namespace_node *node;	/* Containing namespace node */
131e2f7a777SLen Brown 	u8 original_sync_level;	/* Owner's original sync level (0-15) */
132e2f7a777SLen Brown };
133e2f7a777SLen Brown 
134e2f7a777SLen Brown struct acpi_object_region {
135e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER u8 space_id;
136e2f7a777SLen Brown 	struct acpi_namespace_node *node;	/* Containing namespace node */
137e2f7a777SLen Brown 	union acpi_operand_object *handler;	/* Handler for region access */
138e2f7a777SLen Brown 	union acpi_operand_object *next;
139e2f7a777SLen Brown 	acpi_physical_address address;
140e2f7a777SLen Brown 	u32 length;
141ca25f92bSJessica Clarke 	void *pointer;		/* Only for data table regions */
142e2f7a777SLen Brown };
143e2f7a777SLen Brown 
144e2f7a777SLen Brown struct acpi_object_method {
14526294842SLin Ming 	ACPI_OBJECT_COMMON_HEADER u8 info_flags;
146e2f7a777SLen Brown 	u8 param_count;
147e2f7a777SLen Brown 	u8 sync_level;
148e2f7a777SLen Brown 	union acpi_operand_object *mutex;
14907b9c912SLv Zheng 	union acpi_operand_object *node;
150e2f7a777SLen Brown 	u8 *aml_start;
151e31c32cfSLin Ming 	union {
152644ef74eSLv Zheng 		acpi_internal_method implementation;
153e31c32cfSLin Ming 		union acpi_operand_object *handler;
15426294842SLin Ming 	} dispatch;
155e31c32cfSLin Ming 
156e2f7a777SLen Brown 	u32 aml_length;
157e2f7a777SLen Brown 	acpi_owner_id owner_id;
15867a72420SBob Moore 	u8 thread_count;
159e2f7a777SLen Brown };
160e2f7a777SLen Brown 
16126294842SLin Ming /* Flags for info_flags field above */
16226294842SLin Ming 
16326294842SLin Ming #define ACPI_METHOD_MODULE_LEVEL        0x01	/* Method is actually module-level code */
16426294842SLin Ming #define ACPI_METHOD_INTERNAL_ONLY       0x02	/* Method is implemented internally (_OSI) */
16526294842SLin Ming #define ACPI_METHOD_SERIALIZED          0x04	/* Method is serialized */
16626294842SLin Ming #define ACPI_METHOD_SERIALIZED_PENDING  0x08	/* Method is to be marked serialized */
167d1825579SBob Moore #define ACPI_METHOD_IGNORE_SYNC_LEVEL   0x10	/* Method was auto-serialized at table load time */
168d1825579SBob Moore #define ACPI_METHOD_MODIFIED_NAMESPACE  0x20	/* Method modified the namespace */
16926294842SLin Ming 
170e2f7a777SLen Brown /******************************************************************************
171e2f7a777SLen Brown  *
172e2f7a777SLen Brown  * Objects that can be notified. All share a common notify_info area.
173e2f7a777SLen Brown  *
174e2f7a777SLen Brown  *****************************************************************************/
175e2f7a777SLen Brown 
176e2f7a777SLen Brown /*
177e2f7a777SLen Brown  * Common fields for objects that support ASL notifications
178e2f7a777SLen Brown  */
179e2f7a777SLen Brown #define ACPI_COMMON_NOTIFY_INFO \
18086ed4bc8SBob Moore 	union acpi_operand_object       *notify_list[2];    /* Handlers for system/device notifies */\
181e2f7a777SLen Brown 	union acpi_operand_object       *handler;	/* Handler for Address space */
182e2f7a777SLen Brown 
1837679c35dSLv Zheng /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
1847679c35dSLv Zheng 
1857679c35dSLv Zheng struct acpi_object_notify_common {
186e2f7a777SLen Brown ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
187e2f7a777SLen Brown 
188e2f7a777SLen Brown struct acpi_object_device {
189e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER
190e2f7a777SLen Brown 	    ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
191e2f7a777SLen Brown };
192e2f7a777SLen Brown 
193e2f7a777SLen Brown struct acpi_object_power_resource {
194e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
195e2f7a777SLen Brown 	u32 resource_order;
196e2f7a777SLen Brown };
197e2f7a777SLen Brown 
198e2f7a777SLen Brown struct acpi_object_processor {
199e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER
200e2f7a777SLen Brown 	    /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
201e2f7a777SLen Brown 	u8 proc_id;
202e2f7a777SLen Brown 	u8 length;
203e2f7a777SLen Brown 	ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
204e2f7a777SLen Brown };
205e2f7a777SLen Brown 
206e2f7a777SLen Brown struct acpi_object_thermal_zone {
207e2f7a777SLen Brown ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
208e2f7a777SLen Brown 
209e2f7a777SLen Brown /******************************************************************************
210e2f7a777SLen Brown  *
211e2f7a777SLen Brown  * Fields. All share a common header/info field.
212e2f7a777SLen Brown  *
213e2f7a777SLen Brown  *****************************************************************************/
214e2f7a777SLen Brown 
215e2f7a777SLen Brown /*
216e2f7a777SLen Brown  * Common bitfield for the field objects
217e2f7a777SLen Brown  * "Field Datum"  -- a datum from the actual field object
218e2f7a777SLen Brown  * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
219e2f7a777SLen Brown  */
220e2f7a777SLen Brown #define ACPI_COMMON_FIELD_INFO \
221e2f7a777SLen Brown 	u8                              field_flags;        /* Access, update, and lock bits */\
222e2f7a777SLen Brown 	u8                              attribute;          /* From access_as keyword */\
223e2f7a777SLen Brown 	u8                              access_byte_width;  /* Read/Write size in bytes */\
224e2f7a777SLen Brown 	struct acpi_namespace_node      *node;              /* Link back to parent node */\
225e2f7a777SLen Brown 	u32                             bit_length;         /* Length of field in bits */\
226e2f7a777SLen Brown 	u32                             base_byte_offset;   /* Byte offset within containing object */\
227e2f7a777SLen Brown 	u32                             value;              /* Value to store into the Bank or Index register */\
228e2f7a777SLen Brown 	u8                              start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
2299ce81784SBob Moore 	u8                              access_length;	/* For serial regions/fields */
23009387b43SBob Moore 
231e2f7a777SLen Brown 
2327679c35dSLv Zheng /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
2337679c35dSLv Zheng 
2347679c35dSLv Zheng struct acpi_object_field_common {
235e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj;	/* Parent Operation Region object (REGION/BANK fields only) */
236e2f7a777SLen Brown };
237e2f7a777SLen Brown 
238e2f7a777SLen Brown struct acpi_object_region_field {
2399ce81784SBob Moore 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u16 resource_length;
2409ce81784SBob Moore 	union acpi_operand_object *region_obj;	/* Containing op_region object */
2419ce81784SBob Moore 	u8 *resource_buffer;	/* resource_template for serial regions/fields */
24275ec6e55SBob Moore 	u16 pin_number_index;	/* Index relative to previous Connection/Template */
243aa6ec56bSErik Schmauss 	u8 *internal_pcc_buffer;	/* Internal buffer for fields associated with PCC */
244e2f7a777SLen Brown };
245e2f7a777SLen Brown 
246e2f7a777SLen Brown struct acpi_object_bank_field {
247e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj;	/* Containing op_region object */
248e2f7a777SLen Brown 	union acpi_operand_object *bank_obj;	/* bank_select Register object */
249e2f7a777SLen Brown };
250e2f7a777SLen Brown 
251e2f7a777SLen Brown struct acpi_object_index_field {
252e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
253e2f7a777SLen Brown 	    /*
254e2f7a777SLen Brown 	     * No "RegionObj" pointer needed since the Index and Data registers
255e2f7a777SLen Brown 	     * are each field definitions unto themselves.
256e2f7a777SLen Brown 	     */
257e2f7a777SLen Brown 	union acpi_operand_object *index_obj;	/* Index register */
258e2f7a777SLen Brown 	union acpi_operand_object *data_obj;	/* Data register */
259e2f7a777SLen Brown };
260e2f7a777SLen Brown 
261e2f7a777SLen Brown /* The buffer_field is different in that it is part of a Buffer, not an op_region */
262e2f7a777SLen Brown 
263e2f7a777SLen Brown struct acpi_object_buffer_field {
2646d232b29SMaximilian Luz 	ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u8 is_create_field;	/* Special case for objects created by create_field() */
2656d232b29SMaximilian Luz 	union acpi_operand_object *buffer_obj;	/* Containing Buffer object */
266e2f7a777SLen Brown };
267e2f7a777SLen Brown 
268e2f7a777SLen Brown /******************************************************************************
269e2f7a777SLen Brown  *
270e2f7a777SLen Brown  * Objects for handlers
271e2f7a777SLen Brown  *
272e2f7a777SLen Brown  *****************************************************************************/
273e2f7a777SLen Brown 
274e2f7a777SLen Brown struct acpi_object_notify_handler {
275e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node;	/* Parent device */
27686ed4bc8SBob Moore 	u32 handler_type;	/* Type: Device/System/Both */
27786ed4bc8SBob Moore 	acpi_notify_handler handler;	/* Handler address */
278e2f7a777SLen Brown 	void *context;
27986ed4bc8SBob Moore 	union acpi_operand_object *next[2];	/* Device and System handler lists */
280e2f7a777SLen Brown };
281e2f7a777SLen Brown 
282e2f7a777SLen Brown struct acpi_object_addr_handler {
283e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER u8 space_id;
284e2f7a777SLen Brown 	u8 handler_flags;
285e2f7a777SLen Brown 	acpi_adr_space_handler handler;
286e2f7a777SLen Brown 	struct acpi_namespace_node *node;	/* Parent device */
287e2f7a777SLen Brown 	void *context;
288c27f3d01SHans de Goede 	acpi_mutex context_mutex;
289e2f7a777SLen Brown 	acpi_adr_space_setup setup;
29075c8044fSLv Zheng 	union acpi_operand_object *region_list;	/* Regions using this handler */
291e2f7a777SLen Brown 	union acpi_operand_object *next;
292e2f7a777SLen Brown };
293e2f7a777SLen Brown 
294e2f7a777SLen Brown /* Flags for address handler (handler_flags) */
295e2f7a777SLen Brown 
296e2f7a777SLen Brown #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x01
297e2f7a777SLen Brown 
298e2f7a777SLen Brown /******************************************************************************
299e2f7a777SLen Brown  *
300e2f7a777SLen Brown  * Special internal objects
301e2f7a777SLen Brown  *
302e2f7a777SLen Brown  *****************************************************************************/
303e2f7a777SLen Brown 
304e2f7a777SLen Brown /*
305e2f7a777SLen Brown  * The Reference object is used for these opcodes:
306e2f7a777SLen Brown  * Arg[0-6], Local[0-7], index_op, name_op, ref_of_op, load_op, load_table_op, debug_op
307e2f7a777SLen Brown  * The Reference.Class differentiates these types.
308e2f7a777SLen Brown  */
309e2f7a777SLen Brown struct acpi_object_reference {
310e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER u8 class;	/* Reference Class */
311e2f7a777SLen Brown 	u8 target_type;		/* Used for Index Op */
312a62a7117SBob Moore 	u8 resolved;		/* Reference has been resolved to a value */
313e2f7a777SLen Brown 	void *object;		/* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
314e2f7a777SLen Brown 	struct acpi_namespace_node *node;	/* ref_of or Namepath */
315e2f7a777SLen Brown 	union acpi_operand_object **where;	/* Target of Index */
316fde175e3SBob Moore 	u8 *index_pointer;	/* Used for Buffers and Strings */
317a62a7117SBob Moore 	u8 *aml;		/* Used for deferred resolution of the ref */
318e2f7a777SLen Brown 	u32 value;		/* Used for Local/Arg/Index/ddb_handle */
319e2f7a777SLen Brown };
320e2f7a777SLen Brown 
321e2f7a777SLen Brown /* Values for Reference.Class above */
322e2f7a777SLen Brown 
323e2f7a777SLen Brown typedef enum {
324e2f7a777SLen Brown 	ACPI_REFCLASS_LOCAL = 0,	/* Method local */
325e2f7a777SLen Brown 	ACPI_REFCLASS_ARG = 1,	/* Method argument */
326e2f7a777SLen Brown 	ACPI_REFCLASS_REFOF = 2,	/* Result of ref_of() TBD: Split to Ref/Node and Ref/operand_obj? */
327e2f7a777SLen Brown 	ACPI_REFCLASS_INDEX = 3,	/* Result of Index() */
328e2f7a777SLen Brown 	ACPI_REFCLASS_TABLE = 4,	/* ddb_handle - Load(), load_table() */
329e2f7a777SLen Brown 	ACPI_REFCLASS_NAME = 5,	/* Reference to a named object */
330e2f7a777SLen Brown 	ACPI_REFCLASS_DEBUG = 6,	/* Debug object */
331e2f7a777SLen Brown 
332e2f7a777SLen Brown 	ACPI_REFCLASS_MAX = 6
333e2f7a777SLen Brown } ACPI_REFERENCE_CLASSES;
334e2f7a777SLen Brown 
335e2f7a777SLen Brown /*
336e2f7a777SLen Brown  * Extra object is used as additional storage for types that
337e2f7a777SLen Brown  * have AML code in their declarations (term_args) that must be
338e2f7a777SLen Brown  * evaluated at run time.
339e2f7a777SLen Brown  *
340e2f7a777SLen Brown  * Currently: Region and field_unit types
341e2f7a777SLen Brown  */
342e2f7a777SLen Brown struct acpi_object_extra {
343e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG;	/* _REG method for this region (if any) */
3448931d9eaSLin Ming 	struct acpi_namespace_node *scope_node;
345e2f7a777SLen Brown 	void *region_context;	/* Region-specific data */
346e2f7a777SLen Brown 	u8 *aml_start;
347e2f7a777SLen Brown 	u32 aml_length;
348e2f7a777SLen Brown };
349e2f7a777SLen Brown 
350e2f7a777SLen Brown /* Additional data that can be attached to namespace nodes */
351e2f7a777SLen Brown 
352e2f7a777SLen Brown struct acpi_object_data {
353e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
354e2f7a777SLen Brown 	void *pointer;
355e2f7a777SLen Brown };
356e2f7a777SLen Brown 
357e2f7a777SLen Brown /* Structure used when objects are cached for reuse */
358e2f7a777SLen Brown 
359e2f7a777SLen Brown struct acpi_object_cache_list {
360e2f7a777SLen Brown 	ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next;	/* Link for object cache and internal lists */
361e2f7a777SLen Brown };
362e2f7a777SLen Brown 
363e2f7a777SLen Brown /******************************************************************************
364e2f7a777SLen Brown  *
365ba494beeSBob Moore  * union acpi_operand_object descriptor - a giant union of all of the above
366e2f7a777SLen Brown  *
367e2f7a777SLen Brown  *****************************************************************************/
368e2f7a777SLen Brown 
369e2f7a777SLen Brown union acpi_operand_object {
370e2f7a777SLen Brown 	struct acpi_object_common common;
371e2f7a777SLen Brown 	struct acpi_object_integer integer;
372e2f7a777SLen Brown 	struct acpi_object_string string;
373e2f7a777SLen Brown 	struct acpi_object_buffer buffer;
374e2f7a777SLen Brown 	struct acpi_object_package package;
375e2f7a777SLen Brown 	struct acpi_object_event event;
376e2f7a777SLen Brown 	struct acpi_object_method method;
377e2f7a777SLen Brown 	struct acpi_object_mutex mutex;
378e2f7a777SLen Brown 	struct acpi_object_region region;
379e2f7a777SLen Brown 	struct acpi_object_notify_common common_notify;
380e2f7a777SLen Brown 	struct acpi_object_device device;
381e2f7a777SLen Brown 	struct acpi_object_power_resource power_resource;
382e2f7a777SLen Brown 	struct acpi_object_processor processor;
383e2f7a777SLen Brown 	struct acpi_object_thermal_zone thermal_zone;
384e2f7a777SLen Brown 	struct acpi_object_field_common common_field;
385e2f7a777SLen Brown 	struct acpi_object_region_field field;
386e2f7a777SLen Brown 	struct acpi_object_buffer_field buffer_field;
387e2f7a777SLen Brown 	struct acpi_object_bank_field bank_field;
388e2f7a777SLen Brown 	struct acpi_object_index_field index_field;
389e2f7a777SLen Brown 	struct acpi_object_notify_handler notify;
390e2f7a777SLen Brown 	struct acpi_object_addr_handler address_space;
391e2f7a777SLen Brown 	struct acpi_object_reference reference;
392e2f7a777SLen Brown 	struct acpi_object_extra extra;
393e2f7a777SLen Brown 	struct acpi_object_data data;
394e2f7a777SLen Brown 	struct acpi_object_cache_list cache;
395e2f7a777SLen Brown 
396e2f7a777SLen Brown 	/*
397e2f7a777SLen Brown 	 * Add namespace node to union in order to simplify code that accepts both
398e2f7a777SLen Brown 	 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
399e2f7a777SLen Brown 	 * a common descriptor_type field in order to differentiate them.
400e2f7a777SLen Brown 	 */
401e2f7a777SLen Brown 	struct acpi_namespace_node node;
402e2f7a777SLen Brown };
403e2f7a777SLen Brown 
404e2f7a777SLen Brown /******************************************************************************
405e2f7a777SLen Brown  *
406e2f7a777SLen Brown  * union acpi_descriptor - objects that share a common descriptor identifier
407e2f7a777SLen Brown  *
408e2f7a777SLen Brown  *****************************************************************************/
409e2f7a777SLen Brown 
410e2f7a777SLen Brown /* Object descriptor types */
411e2f7a777SLen Brown 
412e2f7a777SLen Brown #define ACPI_DESC_TYPE_CACHED           0x01	/* Used only when object is cached */
413e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE            0x02
414e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_UPDATE     0x03
415e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
416e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_CONTROL    0x05
417e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
418e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
419e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
420e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_RESULT     0x09
421e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
422e2f7a777SLen Brown #define ACPI_DESC_TYPE_STATE_THREAD     0x0B
423e2f7a777SLen Brown #define ACPI_DESC_TYPE_WALK             0x0C
424e2f7a777SLen Brown #define ACPI_DESC_TYPE_PARSER           0x0D
425e2f7a777SLen Brown #define ACPI_DESC_TYPE_OPERAND          0x0E
426e2f7a777SLen Brown #define ACPI_DESC_TYPE_NAMED            0x0F
427e2f7a777SLen Brown #define ACPI_DESC_TYPE_MAX              0x0F
428e2f7a777SLen Brown 
429e2f7a777SLen Brown struct acpi_common_descriptor {
430e2f7a777SLen Brown 	void *common_pointer;
431e2f7a777SLen Brown 	u8 descriptor_type;	/* To differentiate various internal objs */
432e2f7a777SLen Brown };
433e2f7a777SLen Brown 
434e2f7a777SLen Brown union acpi_descriptor {
435e2f7a777SLen Brown 	struct acpi_common_descriptor common;
436e2f7a777SLen Brown 	union acpi_operand_object object;
437e2f7a777SLen Brown 	struct acpi_namespace_node node;
438e2f7a777SLen Brown 	union acpi_parse_object op;
439e2f7a777SLen Brown };
440e2f7a777SLen Brown 
4416e596084SRobert Moore #pragma pack()
442e2f7a777SLen Brown 
443e2f7a777SLen Brown #endif				/* _ACOBJECT_H */
444