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