2 /******************************************************************************
4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
120 /* acpisrc:StructDefs -- for acpisrc conversion */
124 * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher
125 * to the interpreter, and to keep track of the various handlers such as
126 * address space handlers and notify handlers. The object is a constant
127 * size in order to allow it to be cached and reused.
129 * Note: The object is optimized to be aligned and will not work if it is
132 #if ACPI_MACHINE_WIDTH == 64
138 /*******************************************************************************
142 ******************************************************************************/
145 * Common area for all objects.
147 * DescriptorType is used to differentiate between internal descriptors, and
148 * must be in the same place across all descriptors
150 * Note: The DescriptorType and Type fields must appear in the identical
151 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
154 #define ACPI_OBJECT_COMMON_HEADER \
155 union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\
156 UINT8 DescriptorType; /* To differentiate various internal objs */\
157 UINT8 Type; /* ACPI_OBJECT_TYPE */\
158 UINT16 ReferenceCount; /* For object deletion management */\
161 * Note: There are 3 bytes available here before the
162 * next natural alignment boundary (for both 32/64 cases)
165 /* Values for Flag byte above */
167 #define AOPOBJ_AML_CONSTANT 0x01
168 #define AOPOBJ_STATIC_POINTER 0x02
169 #define AOPOBJ_DATA_VALID 0x04
170 #define AOPOBJ_OBJECT_INITIALIZED 0x08
171 #define AOPOBJ_SETUP_COMPLETE 0x10
172 #define AOPOBJ_SINGLE_DATUM 0x20
175 /******************************************************************************
179 *****************************************************************************/
181 typedef struct acpi_object_common
183 ACPI_OBJECT_COMMON_HEADER
185 } ACPI_OBJECT_COMMON;
188 typedef struct acpi_object_integer
190 ACPI_OBJECT_COMMON_HEADER
191 UINT8 Fill[3]; /* Prevent warning on some compilers */
194 } ACPI_OBJECT_INTEGER;
198 * Note: The String and Buffer object must be identical through the Pointer
199 * and length elements. There is code that depends on this.
201 * Fields common to both Strings and Buffers
203 #define ACPI_COMMON_BUFFER_INFO(_Type) \
208 typedef struct acpi_object_string /* Null terminated, ASCII characters only */
210 ACPI_OBJECT_COMMON_HEADER
211 ACPI_COMMON_BUFFER_INFO (char) /* String in AML stream or allocated string */
213 } ACPI_OBJECT_STRING;
216 typedef struct acpi_object_buffer
218 ACPI_OBJECT_COMMON_HEADER
219 ACPI_COMMON_BUFFER_INFO (UINT8) /* Buffer in AML stream or allocated buffer */
222 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
224 } ACPI_OBJECT_BUFFER;
227 typedef struct acpi_object_package
229 ACPI_OBJECT_COMMON_HEADER
230 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
231 union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */
234 UINT32 Count; /* # of elements in package */
236 } ACPI_OBJECT_PACKAGE;
239 /******************************************************************************
243 *****************************************************************************/
245 typedef struct acpi_object_event
247 ACPI_OBJECT_COMMON_HEADER
248 ACPI_SEMAPHORE OsSemaphore; /* Actual OS synchronization object */
253 typedef struct acpi_object_mutex
255 ACPI_OBJECT_COMMON_HEADER
256 UINT8 SyncLevel; /* 0-15, specified in Mutex() call */
257 UINT16 AcquisitionDepth; /* Allow multiple Acquires, same thread */
258 ACPI_MUTEX OsMutex; /* Actual OS synchronization object */
259 ACPI_THREAD_ID ThreadId; /* Current owner of the mutex */
260 struct acpi_thread_state *OwnerThread; /* Current owner of the mutex */
261 union acpi_operand_object *Prev; /* Link for list of acquired mutexes */
262 union acpi_operand_object *Next; /* Link for list of acquired mutexes */
263 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */
264 UINT8 OriginalSyncLevel; /* Owner's original sync level (0-15) */
269 typedef struct acpi_object_region
271 ACPI_OBJECT_COMMON_HEADER
273 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */
274 union acpi_operand_object *Handler; /* Handler for region access */
275 union acpi_operand_object *Next;
276 ACPI_PHYSICAL_ADDRESS Address;
279 } ACPI_OBJECT_REGION;
282 typedef struct acpi_object_method
284 ACPI_OBJECT_COMMON_HEADER
288 union acpi_operand_object *Mutex;
290 ACPI_INTERNAL_METHOD Implementation;
293 ACPI_OWNER_ID OwnerId;
295 } ACPI_OBJECT_METHOD;
298 /******************************************************************************
300 * Objects that can be notified. All share a common NotifyInfo area.
302 *****************************************************************************/
305 * Common fields for objects that support ASL notifications
307 #define ACPI_COMMON_NOTIFY_INFO \
308 union acpi_operand_object *SystemNotify; /* Handler for system notifies */\
309 union acpi_operand_object *DeviceNotify; /* Handler for driver notifies */\
310 union acpi_operand_object *Handler; /* Handler for Address space */
313 typedef struct acpi_object_notify_common /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
315 ACPI_OBJECT_COMMON_HEADER
316 ACPI_COMMON_NOTIFY_INFO
318 } ACPI_OBJECT_NOTIFY_COMMON;
321 typedef struct acpi_object_device
323 ACPI_OBJECT_COMMON_HEADER
324 ACPI_COMMON_NOTIFY_INFO
325 ACPI_GPE_BLOCK_INFO *GpeBlock;
327 } ACPI_OBJECT_DEVICE;
330 typedef struct acpi_object_power_resource
332 ACPI_OBJECT_COMMON_HEADER
333 ACPI_COMMON_NOTIFY_INFO
335 UINT32 ResourceOrder;
337 } ACPI_OBJECT_POWER_RESOURCE;
340 typedef struct acpi_object_processor
342 ACPI_OBJECT_COMMON_HEADER
344 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
348 ACPI_COMMON_NOTIFY_INFO
349 ACPI_IO_ADDRESS Address;
351 } ACPI_OBJECT_PROCESSOR;
354 typedef struct acpi_object_thermal_zone
356 ACPI_OBJECT_COMMON_HEADER
357 ACPI_COMMON_NOTIFY_INFO
359 } ACPI_OBJECT_THERMAL_ZONE;
362 /******************************************************************************
364 * Fields. All share a common header/info field.
366 *****************************************************************************/
369 * Common bitfield for the field objects
370 * "Field Datum" -- a datum from the actual field object
371 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
373 #define ACPI_COMMON_FIELD_INFO \
374 UINT8 FieldFlags; /* Access, update, and lock bits */\
375 UINT8 Attribute; /* From AccessAs keyword */\
376 UINT8 AccessByteWidth; /* Read/Write size in bytes */\
377 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */\
378 UINT32 BitLength; /* Length of field in bits */\
379 UINT32 BaseByteOffset; /* Byte offset within containing object */\
380 UINT32 Value; /* Value to store into the Bank or Index register */\
381 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
382 UINT8 AccessBitWidth; /* Read/Write size in bits (8-64) */
385 typedef struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
387 ACPI_OBJECT_COMMON_HEADER
388 ACPI_COMMON_FIELD_INFO
389 union acpi_operand_object *RegionObj; /* Parent Operation Region object (REGION/BANK fields only) */
391 } ACPI_OBJECT_FIELD_COMMON;
394 typedef struct acpi_object_region_field
396 ACPI_OBJECT_COMMON_HEADER
397 ACPI_COMMON_FIELD_INFO
398 union acpi_operand_object *RegionObj; /* Containing OpRegion object */
400 } ACPI_OBJECT_REGION_FIELD;
403 typedef struct acpi_object_bank_field
405 ACPI_OBJECT_COMMON_HEADER
406 ACPI_COMMON_FIELD_INFO
407 union acpi_operand_object *RegionObj; /* Containing OpRegion object */
408 union acpi_operand_object *BankObj; /* BankSelect Register object */
410 } ACPI_OBJECT_BANK_FIELD;
413 typedef struct acpi_object_index_field
415 ACPI_OBJECT_COMMON_HEADER
416 ACPI_COMMON_FIELD_INFO
419 * No "RegionObj" pointer needed since the Index and Data registers
420 * are each field definitions unto themselves.
422 union acpi_operand_object *IndexObj; /* Index register */
423 union acpi_operand_object *DataObj; /* Data register */
425 } ACPI_OBJECT_INDEX_FIELD;
428 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
430 typedef struct acpi_object_buffer_field
432 ACPI_OBJECT_COMMON_HEADER
433 ACPI_COMMON_FIELD_INFO
434 union acpi_operand_object *BufferObj; /* Containing Buffer object */
436 } ACPI_OBJECT_BUFFER_FIELD;
439 /******************************************************************************
441 * Objects for handlers
443 *****************************************************************************/
445 typedef struct acpi_object_notify_handler
447 ACPI_OBJECT_COMMON_HEADER
448 ACPI_NAMESPACE_NODE *Node; /* Parent device */
449 ACPI_NOTIFY_HANDLER Handler;
452 } ACPI_OBJECT_NOTIFY_HANDLER;
455 typedef struct acpi_object_addr_handler
457 ACPI_OBJECT_COMMON_HEADER
460 ACPI_ADR_SPACE_HANDLER Handler;
461 ACPI_NAMESPACE_NODE *Node; /* Parent device */
463 ACPI_ADR_SPACE_SETUP Setup;
464 union acpi_operand_object *RegionList; /* regions using this handler */
465 union acpi_operand_object *Next;
467 } ACPI_OBJECT_ADDR_HANDLER;
469 /* Flags for address handler (HandlerFlags) */
471 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
474 /******************************************************************************
476 * Special internal objects
478 *****************************************************************************/
481 * The Reference object is used for these opcodes:
482 * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp
483 * The Reference.Class differentiates these types.
485 typedef struct acpi_object_reference
487 ACPI_OBJECT_COMMON_HEADER
488 UINT8 Class; /* Reference Class */
489 UINT8 TargetType; /* Used for Index Op */
491 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
492 ACPI_NAMESPACE_NODE *Node; /* RefOf or Namepath */
493 union acpi_operand_object **Where; /* Target of Index */
494 UINT32 Value; /* Used for Local/Arg/Index/DdbHandle */
496 } ACPI_OBJECT_REFERENCE;
498 /* Values for Reference.Class above */
502 ACPI_REFCLASS_LOCAL = 0, /* Method local */
503 ACPI_REFCLASS_ARG = 1, /* Method argument */
504 ACPI_REFCLASS_REFOF = 2, /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */
505 ACPI_REFCLASS_INDEX = 3, /* Result of Index() */
506 ACPI_REFCLASS_TABLE = 4, /* DdbHandle - Load(), LoadTable() */
507 ACPI_REFCLASS_NAME = 5, /* Reference to a named object */
508 ACPI_REFCLASS_DEBUG = 6, /* Debug object */
510 ACPI_REFCLASS_MAX = 6
512 } ACPI_REFERENCE_CLASSES;
516 * Extra object is used as additional storage for types that
517 * have AML code in their declarations (TermArgs) that must be
518 * evaluated at run time.
520 * Currently: Region and FieldUnit types
522 typedef struct acpi_object_extra
524 ACPI_OBJECT_COMMON_HEADER
525 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */
526 void *RegionContext; /* Region-specific data */
533 /* Additional data that can be attached to namespace nodes */
535 typedef struct acpi_object_data
537 ACPI_OBJECT_COMMON_HEADER
538 ACPI_OBJECT_HANDLER Handler;
544 /* Structure used when objects are cached for reuse */
546 typedef struct acpi_object_cache_list
548 ACPI_OBJECT_COMMON_HEADER
549 union acpi_operand_object *Next; /* Link for object cache and internal lists*/
551 } ACPI_OBJECT_CACHE_LIST;
554 /******************************************************************************
556 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
558 *****************************************************************************/
560 typedef union acpi_operand_object
562 ACPI_OBJECT_COMMON Common;
563 ACPI_OBJECT_INTEGER Integer;
564 ACPI_OBJECT_STRING String;
565 ACPI_OBJECT_BUFFER Buffer;
566 ACPI_OBJECT_PACKAGE Package;
567 ACPI_OBJECT_EVENT Event;
568 ACPI_OBJECT_METHOD Method;
569 ACPI_OBJECT_MUTEX Mutex;
570 ACPI_OBJECT_REGION Region;
571 ACPI_OBJECT_NOTIFY_COMMON CommonNotify;
572 ACPI_OBJECT_DEVICE Device;
573 ACPI_OBJECT_POWER_RESOURCE PowerResource;
574 ACPI_OBJECT_PROCESSOR Processor;
575 ACPI_OBJECT_THERMAL_ZONE ThermalZone;
576 ACPI_OBJECT_FIELD_COMMON CommonField;
577 ACPI_OBJECT_REGION_FIELD Field;
578 ACPI_OBJECT_BUFFER_FIELD BufferField;
579 ACPI_OBJECT_BANK_FIELD BankField;
580 ACPI_OBJECT_INDEX_FIELD IndexField;
581 ACPI_OBJECT_NOTIFY_HANDLER Notify;
582 ACPI_OBJECT_ADDR_HANDLER AddressSpace;
583 ACPI_OBJECT_REFERENCE Reference;
584 ACPI_OBJECT_EXTRA Extra;
585 ACPI_OBJECT_DATA Data;
586 ACPI_OBJECT_CACHE_LIST Cache;
589 * Add namespace node to union in order to simplify code that accepts both
590 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
591 * a common DescriptorType field in order to differentiate them.
593 ACPI_NAMESPACE_NODE Node;
595 } ACPI_OPERAND_OBJECT;
598 /******************************************************************************
600 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
602 *****************************************************************************/
604 /* Object descriptor types */
606 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
607 #define ACPI_DESC_TYPE_STATE 0x02
608 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03
609 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
610 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05
611 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
612 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
613 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
614 #define ACPI_DESC_TYPE_STATE_RESULT 0x09
615 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
616 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B
617 #define ACPI_DESC_TYPE_WALK 0x0C
618 #define ACPI_DESC_TYPE_PARSER 0x0D
619 #define ACPI_DESC_TYPE_OPERAND 0x0E
620 #define ACPI_DESC_TYPE_NAMED 0x0F
621 #define ACPI_DESC_TYPE_MAX 0x0F
624 typedef struct acpi_common_descriptor
627 UINT8 DescriptorType; /* To differentiate various internal objs */
629 } ACPI_COMMON_DESCRIPTOR;
631 typedef union acpi_descriptor
633 ACPI_COMMON_DESCRIPTOR Common;
634 ACPI_OPERAND_OBJECT Object;
635 ACPI_NAMESPACE_NODE Node;
636 ACPI_PARSE_OBJECT Op;
642 #endif /* _ACOBJECT_H */