2 /******************************************************************************
4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only)
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
121 /* acpisrc:StructDefs -- for acpisrc conversion */
125 * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher
126 * to the interpreter, and to keep track of the various handlers such as
127 * address space handlers and notify handlers. The object is a constant
128 * size in order to allow it to be cached and reused.
130 * Note: The object is optimized to be aligned and will not work if it is
133 #if ACPI_MACHINE_WIDTH == 64
139 /*******************************************************************************
143 ******************************************************************************/
146 * Common area for all objects.
148 * DescriptorType is used to differentiate between internal descriptors, and
149 * must be in the same place across all descriptors
151 * Note: The DescriptorType and Type fields must appear in the identical
152 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
155 #define ACPI_OBJECT_COMMON_HEADER \
156 union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\
157 UINT8 DescriptorType; /* To differentiate various internal objs */\
158 UINT8 Type; /* ACPI_OBJECT_TYPE */\
159 UINT16 ReferenceCount; /* For object deletion management */\
162 * Note: There are 3 bytes available here before the
163 * next natural alignment boundary (for both 32/64 cases)
166 /* Values for Flag byte above */
168 #define AOPOBJ_AML_CONSTANT 0x01
169 #define AOPOBJ_STATIC_POINTER 0x02
170 #define AOPOBJ_DATA_VALID 0x04
171 #define AOPOBJ_OBJECT_INITIALIZED 0x08
172 #define AOPOBJ_SETUP_COMPLETE 0x10
173 #define AOPOBJ_SINGLE_DATUM 0x20
174 #define AOPOBJ_INVALID 0x40 /* Used if host OS won't allow an OpRegion address */
177 /******************************************************************************
181 *****************************************************************************/
183 typedef struct acpi_object_common
185 ACPI_OBJECT_COMMON_HEADER
187 } ACPI_OBJECT_COMMON;
190 typedef struct acpi_object_integer
192 ACPI_OBJECT_COMMON_HEADER
193 UINT8 Fill[3]; /* Prevent warning on some compilers */
196 } ACPI_OBJECT_INTEGER;
200 * Note: The String and Buffer object must be identical through the Pointer
201 * and length elements. There is code that depends on this.
203 * Fields common to both Strings and Buffers
205 #define ACPI_COMMON_BUFFER_INFO(_Type) \
210 typedef struct acpi_object_string /* Null terminated, ASCII characters only */
212 ACPI_OBJECT_COMMON_HEADER
213 ACPI_COMMON_BUFFER_INFO (char) /* String in AML stream or allocated string */
215 } ACPI_OBJECT_STRING;
218 typedef struct acpi_object_buffer
220 ACPI_OBJECT_COMMON_HEADER
221 ACPI_COMMON_BUFFER_INFO (UINT8) /* Buffer in AML stream or allocated buffer */
224 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
226 } ACPI_OBJECT_BUFFER;
229 typedef struct acpi_object_package
231 ACPI_OBJECT_COMMON_HEADER
232 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
233 union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */
236 UINT32 Count; /* # of elements in package */
238 } ACPI_OBJECT_PACKAGE;
241 /******************************************************************************
245 *****************************************************************************/
247 typedef struct acpi_object_event
249 ACPI_OBJECT_COMMON_HEADER
250 ACPI_SEMAPHORE OsSemaphore; /* Actual OS synchronization object */
255 typedef struct acpi_object_mutex
257 ACPI_OBJECT_COMMON_HEADER
258 UINT8 SyncLevel; /* 0-15, specified in Mutex() call */
259 UINT16 AcquisitionDepth; /* Allow multiple Acquires, same thread */
260 struct acpi_thread_state *OwnerThread; /* Current owner of the mutex */
261 ACPI_MUTEX OsMutex; /* Actual OS synchronization object */
262 union acpi_operand_object *Prev; /* Link for list of acquired mutexes */
263 union acpi_operand_object *Next; /* Link for list of acquired mutexes */
264 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */
265 UINT8 OriginalSyncLevel; /* Owner's original sync level (0-15) */
270 typedef struct acpi_object_region
272 ACPI_OBJECT_COMMON_HEADER
274 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */
275 union acpi_operand_object *Handler; /* Handler for region access */
276 union acpi_operand_object *Next;
277 ACPI_PHYSICAL_ADDRESS Address;
280 } ACPI_OBJECT_REGION;
283 typedef struct acpi_object_method
285 ACPI_OBJECT_COMMON_HEADER
289 union acpi_operand_object *Mutex;
291 ACPI_INTERNAL_METHOD Implementation;
294 ACPI_OWNER_ID OwnerId;
296 } ACPI_OBJECT_METHOD;
299 /******************************************************************************
301 * Objects that can be notified. All share a common NotifyInfo area.
303 *****************************************************************************/
306 * Common fields for objects that support ASL notifications
308 #define ACPI_COMMON_NOTIFY_INFO \
309 union acpi_operand_object *SystemNotify; /* Handler for system notifies */\
310 union acpi_operand_object *DeviceNotify; /* Handler for driver notifies */\
311 union acpi_operand_object *Handler; /* Handler for Address space */
314 typedef struct acpi_object_notify_common /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
316 ACPI_OBJECT_COMMON_HEADER
317 ACPI_COMMON_NOTIFY_INFO
319 } ACPI_OBJECT_NOTIFY_COMMON;
322 typedef struct acpi_object_device
324 ACPI_OBJECT_COMMON_HEADER
325 ACPI_COMMON_NOTIFY_INFO
326 ACPI_GPE_BLOCK_INFO *GpeBlock;
328 } ACPI_OBJECT_DEVICE;
331 typedef struct acpi_object_power_resource
333 ACPI_OBJECT_COMMON_HEADER
334 ACPI_COMMON_NOTIFY_INFO
336 UINT32 ResourceOrder;
338 } ACPI_OBJECT_POWER_RESOURCE;
341 typedef struct acpi_object_processor
343 ACPI_OBJECT_COMMON_HEADER
345 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
349 ACPI_COMMON_NOTIFY_INFO
350 ACPI_IO_ADDRESS Address;
352 } ACPI_OBJECT_PROCESSOR;
355 typedef struct acpi_object_thermal_zone
357 ACPI_OBJECT_COMMON_HEADER
358 ACPI_COMMON_NOTIFY_INFO
360 } ACPI_OBJECT_THERMAL_ZONE;
363 /******************************************************************************
365 * Fields. All share a common header/info field.
367 *****************************************************************************/
370 * Common bitfield for the field objects
371 * "Field Datum" -- a datum from the actual field object
372 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
374 #define ACPI_COMMON_FIELD_INFO \
375 UINT8 FieldFlags; /* Access, update, and lock bits */\
376 UINT8 Attribute; /* From AccessAs keyword */\
377 UINT8 AccessByteWidth; /* Read/Write size in bytes */\
378 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */\
379 UINT32 BitLength; /* Length of field in bits */\
380 UINT32 BaseByteOffset; /* Byte offset within containing object */\
381 UINT32 Value; /* Value to store into the Bank or Index register */\
382 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
383 UINT8 AccessBitWidth; /* Read/Write size in bits (8-64) */
386 typedef struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
388 ACPI_OBJECT_COMMON_HEADER
389 ACPI_COMMON_FIELD_INFO
390 union acpi_operand_object *RegionObj; /* Parent Operation Region object (REGION/BANK fields only) */
392 } ACPI_OBJECT_FIELD_COMMON;
395 typedef struct acpi_object_region_field
397 ACPI_OBJECT_COMMON_HEADER
398 ACPI_COMMON_FIELD_INFO
399 union acpi_operand_object *RegionObj; /* Containing OpRegion object */
401 } ACPI_OBJECT_REGION_FIELD;
404 typedef struct acpi_object_bank_field
406 ACPI_OBJECT_COMMON_HEADER
407 ACPI_COMMON_FIELD_INFO
408 union acpi_operand_object *RegionObj; /* Containing OpRegion object */
409 union acpi_operand_object *BankObj; /* BankSelect Register object */
411 } ACPI_OBJECT_BANK_FIELD;
414 typedef struct acpi_object_index_field
416 ACPI_OBJECT_COMMON_HEADER
417 ACPI_COMMON_FIELD_INFO
420 * No "RegionObj" pointer needed since the Index and Data registers
421 * are each field definitions unto themselves.
423 union acpi_operand_object *IndexObj; /* Index register */
424 union acpi_operand_object *DataObj; /* Data register */
426 } ACPI_OBJECT_INDEX_FIELD;
429 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
431 typedef struct acpi_object_buffer_field
433 ACPI_OBJECT_COMMON_HEADER
434 ACPI_COMMON_FIELD_INFO
435 union acpi_operand_object *BufferObj; /* Containing Buffer object */
437 } ACPI_OBJECT_BUFFER_FIELD;
440 /******************************************************************************
442 * Objects for handlers
444 *****************************************************************************/
446 typedef struct acpi_object_notify_handler
448 ACPI_OBJECT_COMMON_HEADER
449 ACPI_NAMESPACE_NODE *Node; /* Parent device */
450 ACPI_NOTIFY_HANDLER Handler;
453 } ACPI_OBJECT_NOTIFY_HANDLER;
456 typedef struct acpi_object_addr_handler
458 ACPI_OBJECT_COMMON_HEADER
461 ACPI_ADR_SPACE_HANDLER Handler;
462 ACPI_NAMESPACE_NODE *Node; /* Parent device */
464 ACPI_ADR_SPACE_SETUP Setup;
465 union acpi_operand_object *RegionList; /* regions using this handler */
466 union acpi_operand_object *Next;
468 } ACPI_OBJECT_ADDR_HANDLER;
470 /* Flags for address handler (HandlerFlags) */
472 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
475 /******************************************************************************
477 * Special internal objects
479 *****************************************************************************/
482 * The Reference object type is used for these opcodes:
483 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp
485 typedef struct acpi_object_reference
487 ACPI_OBJECT_COMMON_HEADER
488 UINT8 TargetType; /* Used for IndexOp */
490 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
491 ACPI_NAMESPACE_NODE *Node;
492 union acpi_operand_object **Where;
493 UINT32 Offset; /* Used for ArgOp, LocalOp, and IndexOp */
495 } ACPI_OBJECT_REFERENCE;
499 * Extra object is used as additional storage for types that
500 * have AML code in their declarations (TermArgs) that must be
501 * evaluated at run time.
503 * Currently: Region and FieldUnit types
505 typedef struct acpi_object_extra
507 ACPI_OBJECT_COMMON_HEADER
508 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */
509 void *RegionContext; /* Region-specific data */
516 /* Additional data that can be attached to namespace nodes */
518 typedef struct acpi_object_data
520 ACPI_OBJECT_COMMON_HEADER
521 ACPI_OBJECT_HANDLER Handler;
527 /* Structure used when objects are cached for reuse */
529 typedef struct acpi_object_cache_list
531 ACPI_OBJECT_COMMON_HEADER
532 union acpi_operand_object *Next; /* Link for object cache and internal lists*/
534 } ACPI_OBJECT_CACHE_LIST;
537 /******************************************************************************
539 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
541 *****************************************************************************/
543 typedef union acpi_operand_object
545 ACPI_OBJECT_COMMON Common;
546 ACPI_OBJECT_INTEGER Integer;
547 ACPI_OBJECT_STRING String;
548 ACPI_OBJECT_BUFFER Buffer;
549 ACPI_OBJECT_PACKAGE Package;
550 ACPI_OBJECT_EVENT Event;
551 ACPI_OBJECT_METHOD Method;
552 ACPI_OBJECT_MUTEX Mutex;
553 ACPI_OBJECT_REGION Region;
554 ACPI_OBJECT_NOTIFY_COMMON CommonNotify;
555 ACPI_OBJECT_DEVICE Device;
556 ACPI_OBJECT_POWER_RESOURCE PowerResource;
557 ACPI_OBJECT_PROCESSOR Processor;
558 ACPI_OBJECT_THERMAL_ZONE ThermalZone;
559 ACPI_OBJECT_FIELD_COMMON CommonField;
560 ACPI_OBJECT_REGION_FIELD Field;
561 ACPI_OBJECT_BUFFER_FIELD BufferField;
562 ACPI_OBJECT_BANK_FIELD BankField;
563 ACPI_OBJECT_INDEX_FIELD IndexField;
564 ACPI_OBJECT_NOTIFY_HANDLER Notify;
565 ACPI_OBJECT_ADDR_HANDLER AddressSpace;
566 ACPI_OBJECT_REFERENCE Reference;
567 ACPI_OBJECT_EXTRA Extra;
568 ACPI_OBJECT_DATA Data;
569 ACPI_OBJECT_CACHE_LIST Cache;
571 } ACPI_OPERAND_OBJECT;
574 /******************************************************************************
576 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
578 *****************************************************************************/
580 /* Object descriptor types */
582 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
583 #define ACPI_DESC_TYPE_STATE 0x02
584 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03
585 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
586 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05
587 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
588 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
589 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
590 #define ACPI_DESC_TYPE_STATE_RESULT 0x09
591 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
592 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B
593 #define ACPI_DESC_TYPE_WALK 0x0C
594 #define ACPI_DESC_TYPE_PARSER 0x0D
595 #define ACPI_DESC_TYPE_OPERAND 0x0E
596 #define ACPI_DESC_TYPE_NAMED 0x0F
597 #define ACPI_DESC_TYPE_MAX 0x0F
600 typedef struct acpi_common_descriptor
603 UINT8 DescriptorType; /* To differentiate various internal objs */
605 } ACPI_COMMON_DESCRIPTOR;
607 typedef union acpi_descriptor
609 ACPI_COMMON_DESCRIPTOR Common;
610 ACPI_OPERAND_OBJECT Object;
611 ACPI_NAMESPACE_NODE Node;
612 ACPI_PARSE_OBJECT Op;
618 #endif /* _ACOBJECT_H */