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 - 2003, 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 *****************************************************************************/
117 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acobject.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
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.
130 /*******************************************************************************
134 ******************************************************************************/
137 * Common area for all objects.
139 * DataType is used to differentiate between internal descriptors, and MUST
140 * be the first byte in this structure.
142 #define ACPI_OBJECT_COMMON_HEADER /* SIZE/ALIGNMENT: 32 bits, one ptr plus trailing 8-bit flag */\
143 UINT8 Descriptor; /* To differentiate various internal objs */\
144 UINT8 Type; /* ACPI_OBJECT_TYPE */\
145 UINT16 ReferenceCount; /* For object deletion management */\
146 union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\
149 /* Values for flag byte above */
151 #define AOPOBJ_AML_CONSTANT 0x01
152 #define AOPOBJ_STATIC_POINTER 0x02
153 #define AOPOBJ_DATA_VALID 0x04
154 #define AOPOBJ_OBJECT_INITIALIZED 0x08
155 #define AOPOBJ_SETUP_COMPLETE 0x10
156 #define AOPOBJ_SINGLE_DATUM 0x20
160 * Common bitfield for the field objects
161 * "Field Datum" -- a datum from the actual field object
162 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
164 #define ACPI_COMMON_FIELD_INFO /* SIZE/ALIGNMENT: 24 bits + three 32-bit values */\
165 UINT8 FieldFlags; /* Access, update, and lock bits */\
166 UINT8 Attribute; /* From AccessAs keyword */\
167 UINT8 AccessByteWidth; /* Read/Write size in bytes */\
168 UINT32 BitLength; /* Length of field in bits */\
169 UINT32 BaseByteOffset; /* Byte offset within containing object */\
170 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
171 UINT8 DatumValidBits; /* Valid bit in first "Field datum" */\
172 UINT8 EndFieldValidBits; /* Valid bits in the last "field datum" */\
173 UINT8 EndBufferValidBits; /* Valid bits in the last "buffer datum" */\
174 UINT32 Value; /* Value to store into the Bank or Index register */\
175 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
179 * Fields common to both Strings and Buffers
181 #define ACPI_COMMON_BUFFER_INFO \
186 * Common fields for objects that support ASL notifications
188 #define ACPI_COMMON_NOTIFY_INFO \
189 union acpi_operand_object *SysHandler; /* Handler for system notifies */\
190 union acpi_operand_object *DrvHandler; /* Handler for driver notifies */\
191 union acpi_operand_object *AddrHandler; /* Handler for Address space */
194 /******************************************************************************
198 *****************************************************************************/
200 typedef struct acpi_object_common
202 ACPI_OBJECT_COMMON_HEADER
204 } ACPI_OBJECT_COMMON;
207 typedef struct acpi_object_integer
209 ACPI_OBJECT_COMMON_HEADER
212 } ACPI_OBJECT_INTEGER;
215 typedef struct acpi_object_string /* Null terminated, ASCII characters only */
217 ACPI_OBJECT_COMMON_HEADER
218 ACPI_COMMON_BUFFER_INFO
219 char *Pointer; /* String in AML stream or allocated string */
221 } ACPI_OBJECT_STRING;
224 typedef struct acpi_object_buffer
226 ACPI_OBJECT_COMMON_HEADER
227 ACPI_COMMON_BUFFER_INFO
228 UINT8 *Pointer; /* Buffer in AML stream or allocated buffer */
229 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
233 } ACPI_OBJECT_BUFFER;
236 typedef struct acpi_object_package
238 ACPI_OBJECT_COMMON_HEADER
240 UINT32 Count; /* # of elements in package */
243 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
244 union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */
246 } ACPI_OBJECT_PACKAGE;
249 /******************************************************************************
253 *****************************************************************************/
255 typedef struct acpi_object_event
257 ACPI_OBJECT_COMMON_HEADER
263 #define INFINITE_CONCURRENCY 0xFF
265 typedef struct acpi_object_method
267 ACPI_OBJECT_COMMON_HEADER
275 ACPI_OWNER_ID OwningId;
277 } ACPI_OBJECT_METHOD;
280 typedef struct acpi_object_mutex
282 ACPI_OBJECT_COMMON_HEADER
284 UINT16 AcquisitionDepth;
285 struct acpi_thread_state *OwnerThread;
287 union acpi_operand_object *Prev; /* Link for list of acquired mutexes */
288 union acpi_operand_object *Next; /* Link for list of acquired mutexes */
289 ACPI_NAMESPACE_NODE *Node; /* containing object */
294 typedef struct acpi_object_region
296 ACPI_OBJECT_COMMON_HEADER
299 union acpi_operand_object *AddrHandler; /* Handler for system notifies */
300 ACPI_NAMESPACE_NODE *Node; /* containing object */
301 union acpi_operand_object *Next;
303 ACPI_PHYSICAL_ADDRESS Address;
305 } ACPI_OBJECT_REGION;
308 /******************************************************************************
310 * Objects that can be notified. All share a common NotifyInfo area.
312 *****************************************************************************/
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
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
343 ACPI_COMMON_NOTIFY_INFO
346 ACPI_IO_ADDRESS Address;
348 } ACPI_OBJECT_PROCESSOR;
351 typedef struct acpi_object_thermal_zone
353 ACPI_OBJECT_COMMON_HEADER
354 ACPI_COMMON_NOTIFY_INFO
356 } ACPI_OBJECT_THERMAL_ZONE;
359 /******************************************************************************
361 * Fields. All share a common header/info field.
363 *****************************************************************************/
365 typedef struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
367 ACPI_OBJECT_COMMON_HEADER
368 ACPI_COMMON_FIELD_INFO
369 union acpi_operand_object *RegionObj; /* Containing Operation Region object */
370 /* (REGION/BANK fields only) */
371 } ACPI_OBJECT_FIELD_COMMON;
374 typedef struct acpi_object_region_field
376 ACPI_OBJECT_COMMON_HEADER
377 ACPI_COMMON_FIELD_INFO
378 union acpi_operand_object *RegionObj; /* Containing OpRegion object */
380 } ACPI_OBJECT_REGION_FIELD;
383 typedef struct acpi_object_bank_field
385 ACPI_OBJECT_COMMON_HEADER
386 ACPI_COMMON_FIELD_INFO
387 union acpi_operand_object *RegionObj; /* Containing OpRegion object */
388 union acpi_operand_object *BankObj; /* BankSelect Register object */
390 } ACPI_OBJECT_BANK_FIELD;
393 typedef struct acpi_object_index_field
395 ACPI_OBJECT_COMMON_HEADER
396 ACPI_COMMON_FIELD_INFO
399 * No "RegionObj" pointer needed since the Index and Data registers
400 * are each field definitions unto themselves.
402 union acpi_operand_object *IndexObj; /* Index register */
403 union acpi_operand_object *DataObj; /* Data register */
405 } ACPI_OBJECT_INDEX_FIELD;
408 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
410 typedef struct acpi_object_buffer_field
412 ACPI_OBJECT_COMMON_HEADER
413 ACPI_COMMON_FIELD_INFO
414 union acpi_operand_object *BufferObj; /* Containing Buffer object */
416 } ACPI_OBJECT_BUFFER_FIELD;
419 /******************************************************************************
421 * Objects for handlers
423 *****************************************************************************/
425 typedef struct acpi_object_notify_handler
427 ACPI_OBJECT_COMMON_HEADER
428 ACPI_NAMESPACE_NODE *Node; /* Parent device */
429 ACPI_NOTIFY_HANDLER Handler;
432 } ACPI_OBJECT_NOTIFY_HANDLER;
435 /* Flags for address handler */
437 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x1
440 typedef struct acpi_object_addr_handler
442 ACPI_OBJECT_COMMON_HEADER
445 ACPI_ADR_SPACE_HANDLER Handler;
446 ACPI_NAMESPACE_NODE *Node; /* Parent device */
448 ACPI_ADR_SPACE_SETUP Setup;
449 union acpi_operand_object *RegionList; /* regions using this handler */
450 union acpi_operand_object *Next;
452 } ACPI_OBJECT_ADDR_HANDLER;
455 /******************************************************************************
457 * Special internal objects
459 *****************************************************************************/
462 * The Reference object type is used for these opcodes:
463 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp
465 typedef struct acpi_object_reference
467 ACPI_OBJECT_COMMON_HEADER
468 UINT8 TargetType; /* Used for IndexOp */
470 UINT32 Offset; /* Used for ArgOp, LocalOp, and IndexOp */
471 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
472 ACPI_NAMESPACE_NODE *Node;
473 union acpi_operand_object **Where;
475 } ACPI_OBJECT_REFERENCE;
479 * Extra object is used as additional storage for types that
480 * have AML code in their declarations (TermArgs) that must be
481 * evaluated at run time.
483 * Currently: Region and FieldUnit types
485 typedef struct acpi_object_extra
487 ACPI_OBJECT_COMMON_HEADER
492 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */
493 void *RegionContext; /* Region-specific data */
498 /* Additional data that can be attached to namespace nodes */
500 typedef struct acpi_object_data
502 ACPI_OBJECT_COMMON_HEADER
503 ACPI_OBJECT_HANDLER Handler;
509 /* Structure used when objects are cached for reuse */
511 typedef struct acpi_object_cache_list
513 ACPI_OBJECT_COMMON_HEADER
514 union acpi_operand_object *Next; /* Link for object cache and internal lists*/
516 } ACPI_OBJECT_CACHE_LIST;
519 /******************************************************************************
521 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
523 *****************************************************************************/
525 typedef union acpi_operand_object
527 ACPI_OBJECT_COMMON Common;
528 ACPI_OBJECT_INTEGER Integer;
529 ACPI_OBJECT_STRING String;
530 ACPI_OBJECT_BUFFER Buffer;
531 ACPI_OBJECT_PACKAGE Package;
532 ACPI_OBJECT_EVENT Event;
533 ACPI_OBJECT_METHOD Method;
534 ACPI_OBJECT_MUTEX Mutex;
535 ACPI_OBJECT_REGION Region;
536 ACPI_OBJECT_NOTIFY_COMMON CommonNotify;
537 ACPI_OBJECT_DEVICE Device;
538 ACPI_OBJECT_POWER_RESOURCE PowerResource;
539 ACPI_OBJECT_PROCESSOR Processor;
540 ACPI_OBJECT_THERMAL_ZONE ThermalZone;
541 ACPI_OBJECT_FIELD_COMMON CommonField;
542 ACPI_OBJECT_REGION_FIELD Field;
543 ACPI_OBJECT_BUFFER_FIELD BufferField;
544 ACPI_OBJECT_BANK_FIELD BankField;
545 ACPI_OBJECT_INDEX_FIELD IndexField;
546 ACPI_OBJECT_NOTIFY_HANDLER NotifyHandler;
547 ACPI_OBJECT_ADDR_HANDLER AddrHandler;
548 ACPI_OBJECT_REFERENCE Reference;
549 ACPI_OBJECT_EXTRA Extra;
550 ACPI_OBJECT_DATA Data;
551 ACPI_OBJECT_CACHE_LIST Cache;
553 } ACPI_OPERAND_OBJECT;
556 /******************************************************************************
558 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
560 *****************************************************************************/
563 /* Object descriptor types */
565 #define ACPI_DESC_TYPE_CACHED 0x11 /* Used only when object is cached */
566 #define ACPI_DESC_TYPE_STATE 0x20
567 #define ACPI_DESC_TYPE_STATE_UPDATE 0x21
568 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x22
569 #define ACPI_DESC_TYPE_STATE_CONTROL 0x23
570 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x24
571 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x25
572 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x26
573 #define ACPI_DESC_TYPE_STATE_RESULT 0x27
574 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x28
575 #define ACPI_DESC_TYPE_STATE_THREAD 0x29
576 #define ACPI_DESC_TYPE_WALK 0x44
577 #define ACPI_DESC_TYPE_PARSER 0x66
578 #define ACPI_DESC_TYPE_OPERAND 0x88
579 #define ACPI_DESC_TYPE_NAMED 0xAA
582 typedef union acpi_descriptor
584 UINT8 DescriptorId; /* To differentiate various internal objs */\
585 ACPI_OPERAND_OBJECT Object;
586 ACPI_NAMESPACE_NODE Node;
587 ACPI_PARSE_OBJECT Op;
592 #endif /* _ACOBJECT_H */