acobject.h revision 138287 
1
2/******************************************************************************
3 *
4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT  (Internal object only)
5 *       $Revision: 126 $
6 *
7 *****************************************************************************/
8
9/******************************************************************************
10 *
11 * 1. Copyright Notice
12 *
13 * Some or all of this work - Copyright (c) 1999 - 2004, 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
199typedef struct acpi_object_common
200{
201    ACPI_OBJECT_COMMON_HEADER
202
203} ACPI_OBJECT_COMMON;
204
205
206typedef struct acpi_object_integer
207{
208    ACPI_OBJECT_COMMON_HEADER
209    ACPI_INTEGER                    Value;
210
211} ACPI_OBJECT_INTEGER;
212
213/*
214 * Note: The String and Buffer object must be identical through the Pointer
215 * element.  There is code that depends on this.
216 */
217typedef struct acpi_object_string   /* Null terminated, ASCII characters only */
218{
219    ACPI_OBJECT_COMMON_HEADER
220    ACPI_COMMON_BUFFER_INFO
221    char                            *Pointer;           /* String in AML stream or allocated string */
222
223} ACPI_OBJECT_STRING;
224
225
226typedef struct acpi_object_buffer
227{
228    ACPI_OBJECT_COMMON_HEADER
229    ACPI_COMMON_BUFFER_INFO
230    UINT8                           *Pointer;           /* Buffer in AML stream or allocated buffer */
231    ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
232    UINT8                           *AmlStart;
233    UINT32                          AmlLength;
234
235} ACPI_OBJECT_BUFFER;
236
237
238typedef struct acpi_object_package
239{
240    ACPI_OBJECT_COMMON_HEADER
241
242    UINT32                          Count;              /* # of elements in package */
243    UINT32                          AmlLength;
244    UINT8                           *AmlStart;
245    ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
246    union acpi_operand_object       **Elements;         /* Array of pointers to AcpiObjects */
247
248} ACPI_OBJECT_PACKAGE;
249
250
251/******************************************************************************
252 *
253 * Complex data types
254 *
255 *****************************************************************************/
256
257typedef struct acpi_object_event
258{
259    ACPI_OBJECT_COMMON_HEADER
260    void                            *Semaphore;
261
262} ACPI_OBJECT_EVENT;
263
264
265#define ACPI_INFINITE_CONCURRENCY   0xFF
266
267typedef
268ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
269    struct acpi_walk_state  *WalkState);
270
271typedef struct acpi_object_method
272{
273    ACPI_OBJECT_COMMON_HEADER
274    UINT8                           MethodFlags;
275    UINT8                           ParamCount;
276    UINT32                          AmlLength;
277    void                            *Semaphore;
278    UINT8                           *AmlStart;
279    ACPI_INTERNAL_METHOD            Implementation;
280    UINT8                           Concurrency;
281    UINT8                           ThreadCount;
282    ACPI_OWNER_ID                   OwningId;
283
284} ACPI_OBJECT_METHOD;
285
286
287typedef struct acpi_object_mutex
288{
289    ACPI_OBJECT_COMMON_HEADER
290    UINT8                           SyncLevel;          /* 0-15, specified in Mutex() call */
291    UINT16                          AcquisitionDepth;   /* Allow multiple Acquires, same thread */
292    struct acpi_thread_state        *OwnerThread;       /* Current owner of the mutex */
293    void                            *Semaphore;         /* Actual OS synchronization object */
294    union acpi_operand_object       *Prev;              /* Link for list of acquired mutexes */
295    union acpi_operand_object       *Next;              /* Link for list of acquired mutexes */
296    ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
297    UINT8                           OriginalSyncLevel;  /* Owner's original sync level (0-15) */
298
299} ACPI_OBJECT_MUTEX;
300
301
302typedef struct acpi_object_region
303{
304    ACPI_OBJECT_COMMON_HEADER
305
306    UINT8                           SpaceId;
307    union acpi_operand_object       *Handler;           /* Handler for region access */
308    ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
309    union acpi_operand_object       *Next;
310    UINT32                          Length;
311    ACPI_PHYSICAL_ADDRESS           Address;
312
313} ACPI_OBJECT_REGION;
314
315
316/******************************************************************************
317 *
318 * Objects that can be notified.  All share a common NotifyInfo area.
319 *
320 *****************************************************************************/
321
322typedef struct acpi_object_notify_common    /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
323{
324    ACPI_OBJECT_COMMON_HEADER
325    ACPI_COMMON_NOTIFY_INFO
326
327} ACPI_OBJECT_NOTIFY_COMMON;
328
329
330typedef struct acpi_object_device
331{
332    ACPI_OBJECT_COMMON_HEADER
333    ACPI_COMMON_NOTIFY_INFO
334    ACPI_GPE_BLOCK_INFO             *GpeBlock;
335
336} ACPI_OBJECT_DEVICE;
337
338
339typedef struct acpi_object_power_resource
340{
341    ACPI_OBJECT_COMMON_HEADER
342    ACPI_COMMON_NOTIFY_INFO
343    UINT32                          SystemLevel;
344    UINT32                          ResourceOrder;
345
346} ACPI_OBJECT_POWER_RESOURCE;
347
348
349typedef struct acpi_object_processor
350{
351    ACPI_OBJECT_COMMON_HEADER
352    ACPI_COMMON_NOTIFY_INFO
353    UINT32                          ProcId;
354    UINT32                          Length;
355    ACPI_IO_ADDRESS                 Address;
356
357} ACPI_OBJECT_PROCESSOR;
358
359
360typedef struct acpi_object_thermal_zone
361{
362    ACPI_OBJECT_COMMON_HEADER
363    ACPI_COMMON_NOTIFY_INFO
364
365} ACPI_OBJECT_THERMAL_ZONE;
366
367
368/******************************************************************************
369 *
370 * Fields.  All share a common header/info field.
371 *
372 *****************************************************************************/
373
374typedef struct acpi_object_field_common                 /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
375{
376    ACPI_OBJECT_COMMON_HEADER
377    ACPI_COMMON_FIELD_INFO
378    union acpi_operand_object       *RegionObj;         /* Containing Operation Region object */
379                                                        /* (REGION/BANK fields only) */
380} ACPI_OBJECT_FIELD_COMMON;
381
382
383typedef struct acpi_object_region_field
384{
385    ACPI_OBJECT_COMMON_HEADER
386    ACPI_COMMON_FIELD_INFO
387    union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
388
389} ACPI_OBJECT_REGION_FIELD;
390
391
392typedef struct acpi_object_bank_field
393{
394    ACPI_OBJECT_COMMON_HEADER
395    ACPI_COMMON_FIELD_INFO
396    union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
397    union acpi_operand_object       *BankObj;           /* BankSelect Register object */
398
399} ACPI_OBJECT_BANK_FIELD;
400
401
402typedef struct acpi_object_index_field
403{
404    ACPI_OBJECT_COMMON_HEADER
405    ACPI_COMMON_FIELD_INFO
406
407    /*
408     * No "RegionObj" pointer needed since the Index and Data registers
409     * are each field definitions unto themselves.
410     */
411    union acpi_operand_object       *IndexObj;          /* Index register */
412    union acpi_operand_object       *DataObj;           /* Data register */
413
414} ACPI_OBJECT_INDEX_FIELD;
415
416
417/* The BufferField is different in that it is part of a Buffer, not an OpRegion */
418
419typedef struct acpi_object_buffer_field
420{
421    ACPI_OBJECT_COMMON_HEADER
422    ACPI_COMMON_FIELD_INFO
423    union acpi_operand_object       *BufferObj;         /* Containing Buffer object */
424
425} ACPI_OBJECT_BUFFER_FIELD;
426
427
428/******************************************************************************
429 *
430 * Objects for handlers
431 *
432 *****************************************************************************/
433
434typedef struct acpi_object_notify_handler
435{
436    ACPI_OBJECT_COMMON_HEADER
437    ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
438    ACPI_NOTIFY_HANDLER             Handler;
439    void                            *Context;
440
441} ACPI_OBJECT_NOTIFY_HANDLER;
442
443
444/* Flags for address handler */
445
446#define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x1
447
448
449typedef struct acpi_object_addr_handler
450{
451    ACPI_OBJECT_COMMON_HEADER
452    UINT8                           SpaceId;
453    UINT16                          Hflags;
454    ACPI_ADR_SPACE_HANDLER          Handler;
455    ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
456    void                            *Context;
457    ACPI_ADR_SPACE_SETUP            Setup;
458    union acpi_operand_object       *RegionList;        /* regions using this handler */
459    union acpi_operand_object       *Next;
460
461} ACPI_OBJECT_ADDR_HANDLER;
462
463
464/******************************************************************************
465 *
466 * Special internal objects
467 *
468 *****************************************************************************/
469
470/*
471 * The Reference object type is used for these opcodes:
472 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp
473 */
474typedef struct acpi_object_reference
475{
476    ACPI_OBJECT_COMMON_HEADER
477    UINT8                           TargetType;         /* Used for IndexOp */
478    UINT16                          Opcode;
479    UINT32                          Offset;             /* Used for ArgOp, LocalOp, and IndexOp */
480    void                            *Object;            /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT  */
481    ACPI_NAMESPACE_NODE             *Node;
482    union acpi_operand_object       **Where;
483
484} ACPI_OBJECT_REFERENCE;
485
486
487/*
488 * Extra object is used as additional storage for types that
489 * have AML code in their declarations (TermArgs) that must be
490 * evaluated at run time.
491 *
492 * Currently: Region and FieldUnit types
493 */
494typedef struct acpi_object_extra
495{
496    ACPI_OBJECT_COMMON_HEADER
497    UINT8                           ByteFill1;
498    UINT16                          WordFill1;
499    UINT32                          AmlLength;
500    UINT8                           *AmlStart;
501    ACPI_NAMESPACE_NODE             *Method_REG;        /* _REG method for this region (if any) */
502    void                            *RegionContext;     /* Region-specific data */
503
504} ACPI_OBJECT_EXTRA;
505
506
507/* Additional data that can be attached to namespace nodes */
508
509typedef struct acpi_object_data
510{
511    ACPI_OBJECT_COMMON_HEADER
512    ACPI_OBJECT_HANDLER             Handler;
513    void                            *Pointer;
514
515} ACPI_OBJECT_DATA;
516
517
518/* Structure used when objects are cached for reuse */
519
520typedef struct acpi_object_cache_list
521{
522    ACPI_OBJECT_COMMON_HEADER
523    union acpi_operand_object       *Next;              /* Link for object cache and internal lists*/
524
525} ACPI_OBJECT_CACHE_LIST;
526
527
528/******************************************************************************
529 *
530 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
531 *
532 *****************************************************************************/
533
534typedef union acpi_operand_object
535{
536    ACPI_OBJECT_COMMON              Common;
537    ACPI_OBJECT_INTEGER             Integer;
538    ACPI_OBJECT_STRING              String;
539    ACPI_OBJECT_BUFFER              Buffer;
540    ACPI_OBJECT_PACKAGE             Package;
541    ACPI_OBJECT_EVENT               Event;
542    ACPI_OBJECT_METHOD              Method;
543    ACPI_OBJECT_MUTEX               Mutex;
544    ACPI_OBJECT_REGION              Region;
545    ACPI_OBJECT_NOTIFY_COMMON       CommonNotify;
546    ACPI_OBJECT_DEVICE              Device;
547    ACPI_OBJECT_POWER_RESOURCE      PowerResource;
548    ACPI_OBJECT_PROCESSOR           Processor;
549    ACPI_OBJECT_THERMAL_ZONE        ThermalZone;
550    ACPI_OBJECT_FIELD_COMMON        CommonField;
551    ACPI_OBJECT_REGION_FIELD        Field;
552    ACPI_OBJECT_BUFFER_FIELD        BufferField;
553    ACPI_OBJECT_BANK_FIELD          BankField;
554    ACPI_OBJECT_INDEX_FIELD         IndexField;
555    ACPI_OBJECT_NOTIFY_HANDLER      Notify;
556    ACPI_OBJECT_ADDR_HANDLER        AddressSpace;
557    ACPI_OBJECT_REFERENCE           Reference;
558    ACPI_OBJECT_EXTRA               Extra;
559    ACPI_OBJECT_DATA                Data;
560    ACPI_OBJECT_CACHE_LIST          Cache;
561
562} ACPI_OPERAND_OBJECT;
563
564
565/******************************************************************************
566 *
567 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
568 *
569 *****************************************************************************/
570
571
572/* Object descriptor types */
573
574#define ACPI_DESC_TYPE_CACHED           0x01        /* Used only when object is cached */
575#define ACPI_DESC_TYPE_STATE            0x02
576#define ACPI_DESC_TYPE_STATE_UPDATE     0x03
577#define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
578#define ACPI_DESC_TYPE_STATE_CONTROL    0x05
579#define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
580#define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
581#define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
582#define ACPI_DESC_TYPE_STATE_RESULT     0x09
583#define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
584#define ACPI_DESC_TYPE_STATE_THREAD     0x0B
585#define ACPI_DESC_TYPE_WALK             0x0C
586#define ACPI_DESC_TYPE_PARSER           0x0D
587#define ACPI_DESC_TYPE_OPERAND          0x0E
588#define ACPI_DESC_TYPE_NAMED            0x0F
589#define ACPI_DESC_TYPE_MAX              0x0F
590
591
592typedef union acpi_descriptor
593{
594    UINT8                           DescriptorId;   /* To differentiate various internal objs */\
595    ACPI_OPERAND_OBJECT             Object;
596    ACPI_NAMESPACE_NODE             Node;
597    ACPI_PARSE_OBJECT               Op;
598
599} ACPI_DESCRIPTOR;
600
601
602#endif /* _ACOBJECT_H */
603