Linux 4.1.16
[linux/fpc-iii.git] / drivers / acpi / acpica / acobject.h
blob3e9720e1f34f79464abbeb0fe7cb6ca7977a7fe0
1 /******************************************************************************
3 * Name: acobject.h - Definition of union acpi_operand_object (Internal object only)
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2015, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #ifndef _ACOBJECT_H
45 #define _ACOBJECT_H
47 /* acpisrc:struct_defs -- for acpisrc conversion */
50 * The union acpi_operand_object is used to pass AML operands from the dispatcher
51 * to the interpreter, and to keep track of the various handlers such as
52 * address space handlers and notify handlers. The object is a constant
53 * size in order to allow it to be cached and reused.
55 * Note: The object is optimized to be aligned and will not work if it is
56 * byte-packed.
58 #if ACPI_MACHINE_WIDTH == 64
59 #pragma pack(8)
60 #else
61 #pragma pack(4)
62 #endif
64 /*******************************************************************************
66 * Common Descriptors
68 ******************************************************************************/
71 * Common area for all objects.
73 * descriptor_type is used to differentiate between internal descriptors, and
74 * must be in the same place across all descriptors
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.
80 #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;
87 * Note: There are 3 bytes available here before the
88 * next natural alignment boundary (for both 32/64 cases)
91 /* Values for Flag byte above */
93 #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 */
95 #define AOPOBJ_DATA_VALID 0x04 /* Object is initialized and data is valid */
96 #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 */
100 /******************************************************************************
102 * Basic data types
104 *****************************************************************************/
106 struct acpi_object_common {
107 ACPI_OBJECT_COMMON_HEADER};
109 struct acpi_object_integer {
110 ACPI_OBJECT_COMMON_HEADER u8 fill[3]; /* Prevent warning on some compilers */
111 u64 value;
115 * Note: The String and Buffer object must be identical through the
116 * pointer and length elements. There is code that depends on this.
118 * Fields common to both Strings and Buffers
120 #define ACPI_COMMON_BUFFER_INFO(_type) \
121 _type *pointer; \
122 u32 length;
124 struct acpi_object_string { /* Null terminated, ASCII characters only */
125 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */
128 struct acpi_object_buffer {
129 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8) /* Buffer in AML stream or allocated buffer */
130 u32 aml_length;
131 u8 *aml_start;
132 struct acpi_namespace_node *node; /* Link back to parent node */
135 struct acpi_object_package {
136 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Link back to parent node */
137 union acpi_operand_object **elements; /* Array of pointers to acpi_objects */
138 u8 *aml_start;
139 u32 aml_length;
140 u32 count; /* # of elements in package */
143 /******************************************************************************
145 * Complex data types
147 *****************************************************************************/
149 struct acpi_object_event {
150 ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore; /* Actual OS synchronization object */
153 struct 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 */
156 acpi_mutex os_mutex; /* Actual OS synchronization object */
157 acpi_thread_id thread_id; /* Current owner of the mutex */
158 struct acpi_thread_state *owner_thread; /* Current owner of the mutex */
159 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) */
165 struct acpi_object_region {
166 ACPI_OBJECT_COMMON_HEADER u8 space_id;
167 struct acpi_namespace_node *node; /* Containing namespace node */
168 union acpi_operand_object *handler; /* Handler for region access */
169 union acpi_operand_object *next;
170 acpi_physical_address address;
171 u32 length;
174 struct acpi_object_method {
175 ACPI_OBJECT_COMMON_HEADER u8 info_flags;
176 u8 param_count;
177 u8 sync_level;
178 union acpi_operand_object *mutex;
179 u8 *aml_start;
180 union {
181 acpi_internal_method implementation;
182 union acpi_operand_object *handler;
183 } dispatch;
185 u32 aml_length;
186 u8 thread_count;
187 acpi_owner_id owner_id;
190 /* Flags for info_flags field above */
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_IGNORE_SYNC_LEVEL 0x10 /* Method was auto-serialized at table load time */
197 #define ACPI_METHOD_MODIFIED_NAMESPACE 0x20 /* 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 *notify_list[2]; /* Handlers for system/device notifies */\
210 union acpi_operand_object *handler; /* Handler for Address space */
212 struct acpi_object_notify_common { /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
213 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
215 struct acpi_object_device {
216 ACPI_OBJECT_COMMON_HEADER
217 ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
220 struct acpi_object_power_resource {
221 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
222 u32 resource_order;
225 struct acpi_object_processor {
226 ACPI_OBJECT_COMMON_HEADER
227 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
228 u8 proc_id;
229 u8 length;
230 ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
233 struct acpi_object_thermal_zone {
234 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
236 /******************************************************************************
238 * Fields. All share a common header/info field.
240 *****************************************************************************/
243 * Common bitfield for the field objects
244 * "Field Datum" -- a datum from the actual field object
245 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
247 #define ACPI_COMMON_FIELD_INFO \
248 u8 field_flags; /* Access, update, and lock bits */\
249 u8 attribute; /* From access_as keyword */\
250 u8 access_byte_width; /* Read/Write size in bytes */\
251 struct acpi_namespace_node *node; /* Link back to parent node */\
252 u32 bit_length; /* Length of field in bits */\
253 u32 base_byte_offset; /* Byte offset within containing object */\
254 u32 value; /* Value to store into the Bank or Index register */\
255 u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
256 u8 access_length; /* For serial regions/fields */
259 struct 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) */
263 struct acpi_object_region_field {
264 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u16 resource_length;
265 union acpi_operand_object *region_obj; /* Containing op_region object */
266 u8 *resource_buffer; /* resource_template for serial regions/fields */
267 u16 pin_number_index; /* Index relative to previous Connection/Template */
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 */
299 u32 handler_type; /* Type: Device/System/Both */
300 acpi_notify_handler handler; /* Handler address */
301 void *context;
302 union acpi_operand_object *next[2]; /* Device and System handler lists */
305 struct acpi_object_addr_handler {
306 ACPI_OBJECT_COMMON_HEADER u8 space_id;
307 u8 handler_flags;
308 acpi_adr_space_handler handler;
309 struct acpi_namespace_node *node; /* Parent device */
310 void *context;
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 */
334 u8 reserved;
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 */
343 typedef enum {
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 */
366 u8 *aml_start;
367 u32 aml_length;
370 /* Additional data that can be attached to namespace nodes */
372 struct acpi_object_data {
373 ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
374 void *pointer;
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;
461 #pragma pack()
463 #endif /* _ACOBJECT_H */