Merge from vendor branch GCC:
[dragonfly.git] / sys / contrib / dev / acpica-unix-20031203 / include / acobject.h
1
2 /******************************************************************************
3  *
4  * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT  (Internal object only)
5  *       $Revision: 122 $
6  *
7  *****************************************************************************/
8
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
14  * All rights reserved.
15  *
16  * 2. License
17  *
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
21  * property rights.
22  *
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
29  *
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;
38  *
39  * The above copyright and patent license is granted only if the following
40  * conditions are met:
41  *
42  * 3. Conditions
43  *
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.
55  *
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
66  * make.
67  *
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
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
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.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
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
90  * PARTICULAR PURPOSE.
91  *
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
99  * LIMITED REMEDY.
100  *
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.
115  *
116  *****************************************************************************/
117
118 #ifndef _ACOBJECT_H
119 #define _ACOBJECT_H
120
121
122 /*
123  * The ACPI_OPERAND_OBJECT  is used to pass AML operands from the dispatcher
124  * to the interpreter, and to keep track of the various handlers such as
125  * address space handlers and notify handlers.  The object is a constant
126  * size in order to allow it to be cached and reused.
127  */
128
129 /*******************************************************************************
130  *
131  * Common Descriptors
132  *
133  ******************************************************************************/
134
135 /*
136  * Common area for all objects.
137  *
138  * DataType is used to differentiate between internal descriptors, and MUST
139  * be the first byte in this structure.
140  */
141 #define ACPI_OBJECT_COMMON_HEADER   /* SIZE/ALIGNMENT: 32 bits, one ptr plus trailing 8-bit flag */\
142     UINT8                           Descriptor;         /* To differentiate various internal objs */\
143     UINT8                           Type;               /* ACPI_OBJECT_TYPE */\
144     UINT16                          ReferenceCount;     /* For object deletion management */\
145     union acpi_operand_object       *NextObject;        /* Objects linked to parent NS node */\
146     UINT8                           Flags; \
147
148 /* Values for flag byte above */
149
150 #define AOPOBJ_AML_CONSTANT         0x01
151 #define AOPOBJ_STATIC_POINTER       0x02
152 #define AOPOBJ_DATA_VALID           0x04
153 #define AOPOBJ_OBJECT_INITIALIZED   0x08
154 #define AOPOBJ_SETUP_COMPLETE       0x10
155 #define AOPOBJ_SINGLE_DATUM         0x20
156
157
158 /*
159  * Common bitfield for the field objects
160  * "Field Datum"  -- a datum from the actual field object
161  * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
162  */
163 #define ACPI_COMMON_FIELD_INFO      /* SIZE/ALIGNMENT: 24 bits + three 32-bit values */\
164     UINT8                           FieldFlags;         /* Access, update, and lock bits */\
165     UINT8                           Attribute;          /* From AccessAs keyword */\
166     UINT8                           AccessByteWidth;    /* Read/Write size in bytes */\
167     UINT32                          BitLength;          /* Length of field in bits */\
168     UINT32                          BaseByteOffset;     /* Byte offset within containing object */\
169     UINT8                           StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
170     UINT8                           DatumValidBits;     /* Valid bit in first "Field datum" */\
171     UINT8                           EndFieldValidBits;  /* Valid bits in the last "field datum" */\
172     UINT8                           EndBufferValidBits; /* Valid bits in the last "buffer datum" */\
173     UINT32                          Value;              /* Value to store into the Bank or Index register */\
174     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
175
176
177 /*
178  * Fields common to both Strings and Buffers
179  */
180 #define ACPI_COMMON_BUFFER_INFO \
181     UINT32                          Length;
182
183
184 /*
185  * Common fields for objects that support ASL notifications
186  */
187 #define ACPI_COMMON_NOTIFY_INFO \
188     union acpi_operand_object       *SystemNotify;      /* Handler for system notifies */\
189     union acpi_operand_object       *DeviceNotify;      /* Handler for driver notifies */\
190     union acpi_operand_object       *Handler;           /* Handler for Address space */
191
192
193 /******************************************************************************
194  *
195  * Basic data types
196  *
197  *****************************************************************************/
198
199 typedef struct acpi_object_common
200 {
201     ACPI_OBJECT_COMMON_HEADER
202
203 } ACPI_OBJECT_COMMON;
204
205
206 typedef struct acpi_object_integer
207 {
208     ACPI_OBJECT_COMMON_HEADER
209     ACPI_INTEGER                    Value;
210
211 } ACPI_OBJECT_INTEGER;
212
213
214 typedef struct acpi_object_string   /* Null terminated, ASCII characters only */
215 {
216     ACPI_OBJECT_COMMON_HEADER
217     ACPI_COMMON_BUFFER_INFO
218     char                            *Pointer;           /* String in AML stream or allocated string */
219
220 } ACPI_OBJECT_STRING;
221
222
223 typedef struct acpi_object_buffer
224 {
225     ACPI_OBJECT_COMMON_HEADER
226     ACPI_COMMON_BUFFER_INFO
227     UINT8                           *Pointer;           /* Buffer in AML stream or allocated buffer */
228     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
229     UINT8                           *AmlStart;
230     UINT32                          AmlLength;
231
232 } ACPI_OBJECT_BUFFER;
233
234
235 typedef struct acpi_object_package
236 {
237     ACPI_OBJECT_COMMON_HEADER
238
239     UINT32                          Count;              /* # of elements in package */
240     UINT32                          AmlLength;
241     UINT8                           *AmlStart;
242     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
243     union acpi_operand_object       **Elements;         /* Array of pointers to AcpiObjects */
244
245 } ACPI_OBJECT_PACKAGE;
246
247
248 /******************************************************************************
249  *
250  * Complex data types
251  *
252  *****************************************************************************/
253
254 typedef struct acpi_object_event
255 {
256     ACPI_OBJECT_COMMON_HEADER
257     void                            *Semaphore;
258
259 } ACPI_OBJECT_EVENT;
260
261
262 #define INFINITE_CONCURRENCY        0xFF
263
264 typedef struct acpi_object_method
265 {
266     ACPI_OBJECT_COMMON_HEADER
267     UINT8                           MethodFlags;
268     UINT8                           ParamCount;
269     UINT32                          AmlLength;
270     void                            *Semaphore;
271     UINT8                           *AmlStart;
272     UINT8                           Concurrency;
273     UINT8                           ThreadCount;
274     ACPI_OWNER_ID                   OwningId;
275
276 } ACPI_OBJECT_METHOD;
277
278
279 typedef struct acpi_object_mutex
280 {
281     ACPI_OBJECT_COMMON_HEADER
282     UINT16                          SyncLevel;
283     UINT16                          AcquisitionDepth;
284     struct acpi_thread_state        *OwnerThread;
285     void                            *Semaphore;
286     union acpi_operand_object       *Prev;              /* Link for list of acquired mutexes */
287     union acpi_operand_object       *Next;              /* Link for list of acquired mutexes */
288     ACPI_NAMESPACE_NODE             *Node;              /* containing object */
289
290 } ACPI_OBJECT_MUTEX;
291
292
293 typedef struct acpi_object_region
294 {
295     ACPI_OBJECT_COMMON_HEADER
296
297     UINT8                           SpaceId;
298     union acpi_operand_object       *Handler;           /* Handler for region access */
299     ACPI_NAMESPACE_NODE             *Node;              /* containing object */
300     union acpi_operand_object       *Next;
301     UINT32                          Length;
302     ACPI_PHYSICAL_ADDRESS           Address;
303
304 } ACPI_OBJECT_REGION;
305
306
307 /******************************************************************************
308  *
309  * Objects that can be notified.  All share a common NotifyInfo area.
310  *
311  *****************************************************************************/
312
313 typedef struct acpi_object_notify_common    /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
314 {
315     ACPI_OBJECT_COMMON_HEADER
316     ACPI_COMMON_NOTIFY_INFO
317
318 } ACPI_OBJECT_NOTIFY_COMMON;
319
320
321 typedef struct acpi_object_device
322 {
323     ACPI_OBJECT_COMMON_HEADER
324     ACPI_COMMON_NOTIFY_INFO
325     ACPI_GPE_BLOCK_INFO             *GpeBlock;
326
327 } ACPI_OBJECT_DEVICE;
328
329
330 typedef struct acpi_object_power_resource
331 {
332     ACPI_OBJECT_COMMON_HEADER
333     ACPI_COMMON_NOTIFY_INFO
334     UINT32                          SystemLevel;
335     UINT32                          ResourceOrder;
336
337 } ACPI_OBJECT_POWER_RESOURCE;
338
339
340 typedef struct acpi_object_processor
341 {
342     ACPI_OBJECT_COMMON_HEADER
343     ACPI_COMMON_NOTIFY_INFO
344     UINT32                          ProcId;
345     UINT32                          Length;
346     ACPI_IO_ADDRESS                 Address;
347
348 } ACPI_OBJECT_PROCESSOR;
349
350
351 typedef struct acpi_object_thermal_zone
352 {
353     ACPI_OBJECT_COMMON_HEADER
354     ACPI_COMMON_NOTIFY_INFO
355
356 } ACPI_OBJECT_THERMAL_ZONE;
357
358
359 /******************************************************************************
360  *
361  * Fields.  All share a common header/info field.
362  *
363  *****************************************************************************/
364
365 typedef struct acpi_object_field_common                 /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
366 {
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;
372
373
374 typedef struct acpi_object_region_field
375 {
376     ACPI_OBJECT_COMMON_HEADER
377     ACPI_COMMON_FIELD_INFO
378     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
379
380 } ACPI_OBJECT_REGION_FIELD;
381
382
383 typedef struct acpi_object_bank_field
384 {
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 */
389
390 } ACPI_OBJECT_BANK_FIELD;
391
392
393 typedef struct acpi_object_index_field
394 {
395     ACPI_OBJECT_COMMON_HEADER
396     ACPI_COMMON_FIELD_INFO
397
398     /*
399      * No "RegionObj" pointer needed since the Index and Data registers
400      * are each field definitions unto themselves.
401      */
402     union acpi_operand_object       *IndexObj;          /* Index register */
403     union acpi_operand_object       *DataObj;           /* Data register */
404
405 } ACPI_OBJECT_INDEX_FIELD;
406
407
408 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
409
410 typedef struct acpi_object_buffer_field
411 {
412     ACPI_OBJECT_COMMON_HEADER
413     ACPI_COMMON_FIELD_INFO
414     union acpi_operand_object       *BufferObj;         /* Containing Buffer object */
415
416 } ACPI_OBJECT_BUFFER_FIELD;
417
418
419 /******************************************************************************
420  *
421  * Objects for handlers
422  *
423  *****************************************************************************/
424
425 typedef struct acpi_object_notify_handler
426 {
427     ACPI_OBJECT_COMMON_HEADER
428     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
429     ACPI_NOTIFY_HANDLER             Handler;
430     void                            *Context;
431
432 } ACPI_OBJECT_NOTIFY_HANDLER;
433
434
435 /* Flags for address handler */
436
437 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x1
438
439
440 typedef struct acpi_object_addr_handler
441 {
442     ACPI_OBJECT_COMMON_HEADER
443     UINT8                           SpaceId;
444     UINT16                          Hflags;
445     ACPI_ADR_SPACE_HANDLER          Handler;
446     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
447     void                            *Context;
448     ACPI_ADR_SPACE_SETUP            Setup;
449     union acpi_operand_object       *RegionList;        /* regions using this handler */
450     union acpi_operand_object       *Next;
451
452 } ACPI_OBJECT_ADDR_HANDLER;
453
454
455 /******************************************************************************
456  *
457  * Special internal objects
458  *
459  *****************************************************************************/
460
461 /*
462  * The Reference object type is used for these opcodes:
463  * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp
464  */
465 typedef struct acpi_object_reference
466 {
467     ACPI_OBJECT_COMMON_HEADER
468     UINT8                           TargetType;         /* Used for IndexOp */
469     UINT16                          Opcode;
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;
474
475 } ACPI_OBJECT_REFERENCE;
476
477
478 /*
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.
482  *
483  * Currently: Region and FieldUnit types
484  */
485 typedef struct acpi_object_extra
486 {
487     ACPI_OBJECT_COMMON_HEADER
488     UINT8                           ByteFill1;
489     UINT16                          WordFill1;
490     UINT32                          AmlLength;
491     UINT8                           *AmlStart;
492     ACPI_NAMESPACE_NODE             *Method_REG;        /* _REG method for this region (if any) */
493     void                            *RegionContext;     /* Region-specific data */
494
495 } ACPI_OBJECT_EXTRA;
496
497
498 /* Additional data that can be attached to namespace nodes */
499
500 typedef struct acpi_object_data
501 {
502     ACPI_OBJECT_COMMON_HEADER
503     ACPI_OBJECT_HANDLER             Handler;
504     void                            *Pointer;
505
506 } ACPI_OBJECT_DATA;
507
508
509 /* Structure used when objects are cached for reuse */
510
511 typedef struct acpi_object_cache_list
512 {
513     ACPI_OBJECT_COMMON_HEADER
514     union acpi_operand_object       *Next;              /* Link for object cache and internal lists*/
515
516 } ACPI_OBJECT_CACHE_LIST;
517
518
519 /******************************************************************************
520  *
521  * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
522  *
523  *****************************************************************************/
524
525 typedef union acpi_operand_object
526 {
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      Notify;
547     ACPI_OBJECT_ADDR_HANDLER        AddressSpace;
548     ACPI_OBJECT_REFERENCE           Reference;
549     ACPI_OBJECT_EXTRA               Extra;
550     ACPI_OBJECT_DATA                Data;
551     ACPI_OBJECT_CACHE_LIST          Cache;
552
553 } ACPI_OPERAND_OBJECT;
554
555
556 /******************************************************************************
557  *
558  * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
559  *
560  *****************************************************************************/
561
562
563 /* Object descriptor types */
564
565 #define ACPI_DESC_TYPE_CACHED           0x01        /* Used only when object is cached */
566 #define ACPI_DESC_TYPE_STATE            0x02
567 #define ACPI_DESC_TYPE_STATE_UPDATE     0x03
568 #define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
569 #define ACPI_DESC_TYPE_STATE_CONTROL    0x05
570 #define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
571 #define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
572 #define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
573 #define ACPI_DESC_TYPE_STATE_RESULT     0x09
574 #define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
575 #define ACPI_DESC_TYPE_STATE_THREAD     0x0B
576 #define ACPI_DESC_TYPE_WALK             0x0C
577 #define ACPI_DESC_TYPE_PARSER           0x0D
578 #define ACPI_DESC_TYPE_OPERAND          0x0E
579 #define ACPI_DESC_TYPE_NAMED            0x0F
580 #define ACPI_DESC_TYPE_MAX              0x0F
581
582
583 typedef union acpi_descriptor
584 {
585     UINT8                           DescriptorId;   /* To differentiate various internal objs */\
586     ACPI_OPERAND_OBJECT             Object;
587     ACPI_NAMESPACE_NODE             Node;
588     ACPI_PARSE_OBJECT               Op;
589
590 } ACPI_DESCRIPTOR;
591
592
593 #endif /* _ACOBJECT_H */