kernel: Sync ACPICA with Intel's version 20140214.
[dragonfly.git] / sys / contrib / dev / acpica / source / include / acobject.h
1 /******************************************************************************
2  *
3  * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT  (Internal object only)
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2014, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43
44 #ifndef _ACOBJECT_H
45 #define _ACOBJECT_H
46
47 #pragma pack(push) /* Set default struct packing */
48
49 /* acpisrc:StructDefs -- for acpisrc conversion */
50
51
52 /*
53  * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher
54  * to the interpreter, and to keep track of the various handlers such as
55  * address space handlers and notify handlers. The object is a constant
56  * size in order to allow it to be cached and reused.
57  *
58  * Note: The object is optimized to be aligned and will not work if it is
59  * byte-packed.
60  */
61 #if ACPI_MACHINE_WIDTH == 64
62 #pragma pack(8)
63 #else
64 #pragma pack(4)
65 #endif
66
67 /*******************************************************************************
68  *
69  * Common Descriptors
70  *
71  ******************************************************************************/
72
73 /*
74  * Common area for all objects.
75  *
76  * DescriptorType is used to differentiate between internal descriptors, and
77  * must be in the same place across all descriptors
78  *
79  * Note: The DescriptorType and Type fields must appear in the identical
80  * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
81  * structures.
82  */
83 #define ACPI_OBJECT_COMMON_HEADER \
84     union acpi_operand_object       *NextObject;        /* Objects linked to parent NS node */\
85     UINT8                           DescriptorType;     /* To differentiate various internal objs */\
86     UINT8                           Type;               /* ACPI_OBJECT_TYPE */\
87     UINT16                          ReferenceCount;     /* For object deletion management */\
88     UINT8                           Flags;
89     /*
90      * Note: There are 3 bytes available here before the
91      * next natural alignment boundary (for both 32/64 cases)
92      */
93
94 /* Values for Flag byte above */
95
96 #define AOPOBJ_AML_CONSTANT         0x01    /* Integer is an AML constant */
97 #define AOPOBJ_STATIC_POINTER       0x02    /* Data is part of an ACPI table, don't delete */
98 #define AOPOBJ_DATA_VALID           0x04    /* Object is initialized and data is valid */
99 #define AOPOBJ_OBJECT_INITIALIZED   0x08    /* Region is initialized, _REG was run */
100 #define AOPOBJ_SETUP_COMPLETE       0x10    /* Region setup is complete */
101 #define AOPOBJ_INVALID              0x20    /* Host OS won't allow a Region address */
102
103
104 /******************************************************************************
105  *
106  * Basic data types
107  *
108  *****************************************************************************/
109
110 typedef struct acpi_object_common
111 {
112     ACPI_OBJECT_COMMON_HEADER
113
114 } ACPI_OBJECT_COMMON;
115
116
117 typedef struct acpi_object_integer
118 {
119     ACPI_OBJECT_COMMON_HEADER
120     UINT8                           Fill[3];            /* Prevent warning on some compilers */
121     UINT64                          Value;
122
123 } ACPI_OBJECT_INTEGER;
124
125
126 /*
127  * Note: The String and Buffer object must be identical through the
128  * pointer and length elements. There is code that depends on this.
129  *
130  * Fields common to both Strings and Buffers
131  */
132 #define ACPI_COMMON_BUFFER_INFO(_Type) \
133     _Type                           *Pointer; \
134     UINT32                          Length;
135
136
137 typedef struct acpi_object_string   /* Null terminated, ASCII characters only */
138 {
139     ACPI_OBJECT_COMMON_HEADER
140     ACPI_COMMON_BUFFER_INFO         (char)              /* String in AML stream or allocated string */
141
142 } ACPI_OBJECT_STRING;
143
144
145 typedef struct acpi_object_buffer
146 {
147     ACPI_OBJECT_COMMON_HEADER
148     ACPI_COMMON_BUFFER_INFO         (UINT8)             /* Buffer in AML stream or allocated buffer */
149     UINT32                          AmlLength;
150     UINT8                           *AmlStart;
151     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
152
153 } ACPI_OBJECT_BUFFER;
154
155
156 typedef struct acpi_object_package
157 {
158     ACPI_OBJECT_COMMON_HEADER
159     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
160     union acpi_operand_object       **Elements;         /* Array of pointers to AcpiObjects */
161     UINT8                           *AmlStart;
162     UINT32                          AmlLength;
163     UINT32                          Count;              /* # of elements in package */
164
165 } ACPI_OBJECT_PACKAGE;
166
167
168 /******************************************************************************
169  *
170  * Complex data types
171  *
172  *****************************************************************************/
173
174 typedef struct acpi_object_event
175 {
176     ACPI_OBJECT_COMMON_HEADER
177     ACPI_SEMAPHORE                  OsSemaphore;        /* Actual OS synchronization object */
178
179 } ACPI_OBJECT_EVENT;
180
181
182 typedef struct acpi_object_mutex
183 {
184     ACPI_OBJECT_COMMON_HEADER
185     UINT8                           SyncLevel;          /* 0-15, specified in Mutex() call */
186     UINT16                          AcquisitionDepth;   /* Allow multiple Acquires, same thread */
187     ACPI_MUTEX                      OsMutex;            /* Actual OS synchronization object */
188     ACPI_THREAD_ID                  ThreadId;           /* Current owner of the mutex */
189     struct acpi_thread_state        *OwnerThread;       /* Current owner of the mutex */
190     union acpi_operand_object       *Prev;              /* Link for list of acquired mutexes */
191     union acpi_operand_object       *Next;              /* Link for list of acquired mutexes */
192     ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
193     UINT8                           OriginalSyncLevel;  /* Owner's original sync level (0-15) */
194
195 } ACPI_OBJECT_MUTEX;
196
197
198 typedef struct acpi_object_region
199 {
200     ACPI_OBJECT_COMMON_HEADER
201     UINT8                           SpaceId;
202     ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
203     union acpi_operand_object       *Handler;           /* Handler for region access */
204     union acpi_operand_object       *Next;
205     ACPI_PHYSICAL_ADDRESS           Address;
206     UINT32                          Length;
207
208 } ACPI_OBJECT_REGION;
209
210
211 typedef struct acpi_object_method
212 {
213     ACPI_OBJECT_COMMON_HEADER
214     UINT8                           InfoFlags;
215     UINT8                           ParamCount;
216     UINT8                           SyncLevel;
217     union acpi_operand_object       *Mutex;
218     UINT8                           *AmlStart;
219     union
220     {
221         ACPI_INTERNAL_METHOD            Implementation;
222         union acpi_operand_object       *Handler;
223     } Dispatch;
224
225     UINT32                          AmlLength;
226     UINT8                           ThreadCount;
227     ACPI_OWNER_ID                   OwnerId;
228
229 } ACPI_OBJECT_METHOD;
230
231 /* Flags for InfoFlags field above */
232
233 #define ACPI_METHOD_MODULE_LEVEL        0x01    /* Method is actually module-level code */
234 #define ACPI_METHOD_INTERNAL_ONLY       0x02    /* Method is implemented internally (_OSI) */
235 #define ACPI_METHOD_SERIALIZED          0x04    /* Method is serialized */
236 #define ACPI_METHOD_SERIALIZED_PENDING  0x08    /* Method is to be marked serialized */
237 #define ACPI_METHOD_MODIFIED_NAMESPACE  0x10    /* Method modified the namespace */
238
239
240 /******************************************************************************
241  *
242  * Objects that can be notified. All share a common NotifyInfo area.
243  *
244  *****************************************************************************/
245
246 /*
247  * Common fields for objects that support ASL notifications
248  */
249 #define ACPI_COMMON_NOTIFY_INFO \
250     union acpi_operand_object       *NotifyList[2];     /* Handlers for system/device notifies */\
251     union acpi_operand_object       *Handler;           /* Handler for Address space */
252
253
254 typedef struct acpi_object_notify_common    /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
255 {
256     ACPI_OBJECT_COMMON_HEADER
257     ACPI_COMMON_NOTIFY_INFO
258
259 } ACPI_OBJECT_NOTIFY_COMMON;
260
261
262 typedef struct acpi_object_device
263 {
264     ACPI_OBJECT_COMMON_HEADER
265     ACPI_COMMON_NOTIFY_INFO
266     ACPI_GPE_BLOCK_INFO             *GpeBlock;
267
268 } ACPI_OBJECT_DEVICE;
269
270
271 typedef struct acpi_object_power_resource
272 {
273     ACPI_OBJECT_COMMON_HEADER
274     ACPI_COMMON_NOTIFY_INFO
275     UINT32                          SystemLevel;
276     UINT32                          ResourceOrder;
277
278 } ACPI_OBJECT_POWER_RESOURCE;
279
280
281 typedef struct acpi_object_processor
282 {
283     ACPI_OBJECT_COMMON_HEADER
284
285     /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
286
287     UINT8                           ProcId;
288     UINT8                           Length;
289     ACPI_COMMON_NOTIFY_INFO
290     ACPI_IO_ADDRESS                 Address;
291
292 } ACPI_OBJECT_PROCESSOR;
293
294
295 typedef struct acpi_object_thermal_zone
296 {
297     ACPI_OBJECT_COMMON_HEADER
298     ACPI_COMMON_NOTIFY_INFO
299
300 } ACPI_OBJECT_THERMAL_ZONE;
301
302
303 /******************************************************************************
304  *
305  * Fields. All share a common header/info field.
306  *
307  *****************************************************************************/
308
309 /*
310  * Common bitfield for the field objects
311  * "Field Datum"  -- a datum from the actual field object
312  * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
313  */
314 #define ACPI_COMMON_FIELD_INFO \
315     UINT8                           FieldFlags;         /* Access, update, and lock bits */\
316     UINT8                           Attribute;          /* From AccessAs keyword */\
317     UINT8                           AccessByteWidth;    /* Read/Write size in bytes */\
318     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */\
319     UINT32                          BitLength;          /* Length of field in bits */\
320     UINT32                          BaseByteOffset;     /* Byte offset within containing object */\
321     UINT32                          Value;              /* Value to store into the Bank or Index register */\
322     UINT8                           StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
323     UINT8                           AccessLength;       /* For serial regions/fields */
324
325
326 typedef struct acpi_object_field_common                 /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
327 {
328     ACPI_OBJECT_COMMON_HEADER
329     ACPI_COMMON_FIELD_INFO
330     union acpi_operand_object       *RegionObj;         /* Parent Operation Region object (REGION/BANK fields only) */
331
332 } ACPI_OBJECT_FIELD_COMMON;
333
334
335 typedef struct acpi_object_region_field
336 {
337     ACPI_OBJECT_COMMON_HEADER
338     ACPI_COMMON_FIELD_INFO
339     UINT16                          ResourceLength;
340     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
341     UINT8                           *ResourceBuffer;    /* ResourceTemplate for serial regions/fields */
342
343 } ACPI_OBJECT_REGION_FIELD;
344
345
346 typedef struct acpi_object_bank_field
347 {
348     ACPI_OBJECT_COMMON_HEADER
349     ACPI_COMMON_FIELD_INFO
350     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
351     union acpi_operand_object       *BankObj;           /* BankSelect Register object */
352
353 } ACPI_OBJECT_BANK_FIELD;
354
355
356 typedef struct acpi_object_index_field
357 {
358     ACPI_OBJECT_COMMON_HEADER
359     ACPI_COMMON_FIELD_INFO
360
361     /*
362      * No "RegionObj" pointer needed since the Index and Data registers
363      * are each field definitions unto themselves.
364      */
365     union acpi_operand_object       *IndexObj;          /* Index register */
366     union acpi_operand_object       *DataObj;           /* Data register */
367
368 } ACPI_OBJECT_INDEX_FIELD;
369
370
371 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
372
373 typedef struct acpi_object_buffer_field
374 {
375     ACPI_OBJECT_COMMON_HEADER
376     ACPI_COMMON_FIELD_INFO
377     union acpi_operand_object       *BufferObj;         /* Containing Buffer object */
378
379 } ACPI_OBJECT_BUFFER_FIELD;
380
381
382 /******************************************************************************
383  *
384  * Objects for handlers
385  *
386  *****************************************************************************/
387
388 typedef struct acpi_object_notify_handler
389 {
390     ACPI_OBJECT_COMMON_HEADER
391     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
392     UINT32                          HandlerType;        /* Type: Device/System/Both */
393     ACPI_NOTIFY_HANDLER             Handler;            /* Handler address */
394     void                            *Context;
395     union acpi_operand_object       *Next[2];           /* Device and System handler lists */
396
397 } ACPI_OBJECT_NOTIFY_HANDLER;
398
399
400 typedef struct acpi_object_addr_handler
401 {
402     ACPI_OBJECT_COMMON_HEADER
403     UINT8                           SpaceId;
404     UINT8                           HandlerFlags;
405     ACPI_ADR_SPACE_HANDLER          Handler;
406     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
407     void                            *Context;
408     ACPI_ADR_SPACE_SETUP            Setup;
409     union acpi_operand_object       *RegionList;        /* Regions using this handler */
410     union acpi_operand_object       *Next;
411
412 } ACPI_OBJECT_ADDR_HANDLER;
413
414 /* Flags for address handler (HandlerFlags) */
415
416 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x01
417
418
419 /******************************************************************************
420  *
421  * Special internal objects
422  *
423  *****************************************************************************/
424
425 /*
426  * The Reference object is used for these opcodes:
427  * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp
428  * The Reference.Class differentiates these types.
429  */
430 typedef struct acpi_object_reference
431 {
432     ACPI_OBJECT_COMMON_HEADER
433      UINT8                           Class;              /* Reference Class */
434      UINT8                           TargetType;         /* Used for Index Op */
435      UINT8                           Reserved;
436      void                            *Object;            /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
437      ACPI_NAMESPACE_NODE             *Node;              /* RefOf or Namepath */
438      union acpi_operand_object       **Where;            /* Target of Index */
439      UINT32                          Value;              /* Used for Local/Arg/Index/DdbHandle */
440
441 } ACPI_OBJECT_REFERENCE;
442
443 /* Values for Reference.Class above */
444
445 typedef enum
446 {
447     ACPI_REFCLASS_LOCAL             = 0,        /* Method local */
448     ACPI_REFCLASS_ARG               = 1,        /* Method argument */
449     ACPI_REFCLASS_REFOF             = 2,        /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */
450     ACPI_REFCLASS_INDEX             = 3,        /* Result of Index() */
451     ACPI_REFCLASS_TABLE             = 4,        /* DdbHandle - Load(), LoadTable() */
452     ACPI_REFCLASS_NAME              = 5,        /* Reference to a named object */
453     ACPI_REFCLASS_DEBUG             = 6,        /* Debug object */
454
455     ACPI_REFCLASS_MAX               = 6
456
457 } ACPI_REFERENCE_CLASSES;
458
459
460 /*
461  * Extra object is used as additional storage for types that
462  * have AML code in their declarations (TermArgs) that must be
463  * evaluated at run time.
464  *
465  * Currently: Region and FieldUnit types
466  */
467 typedef struct acpi_object_extra
468 {
469     ACPI_OBJECT_COMMON_HEADER
470     ACPI_NAMESPACE_NODE             *Method_REG;        /* _REG method for this region (if any) */
471     ACPI_NAMESPACE_NODE             *ScopeNode;
472     void                            *RegionContext;     /* Region-specific data */
473     UINT8                           *AmlStart;
474     UINT32                          AmlLength;
475
476 } ACPI_OBJECT_EXTRA;
477
478
479 /* Additional data that can be attached to namespace nodes */
480
481 typedef struct acpi_object_data
482 {
483     ACPI_OBJECT_COMMON_HEADER
484     ACPI_OBJECT_HANDLER             Handler;
485     void                            *Pointer;
486
487 } ACPI_OBJECT_DATA;
488
489
490 /* Structure used when objects are cached for reuse */
491
492 typedef struct acpi_object_cache_list
493 {
494     ACPI_OBJECT_COMMON_HEADER
495     union acpi_operand_object       *Next;              /* Link for object cache and internal lists*/
496
497 } ACPI_OBJECT_CACHE_LIST;
498
499
500 /******************************************************************************
501  *
502  * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
503  *
504  *****************************************************************************/
505
506 typedef union acpi_operand_object
507 {
508     ACPI_OBJECT_COMMON                  Common;
509     ACPI_OBJECT_INTEGER                 Integer;
510     ACPI_OBJECT_STRING                  String;
511     ACPI_OBJECT_BUFFER                  Buffer;
512     ACPI_OBJECT_PACKAGE                 Package;
513     ACPI_OBJECT_EVENT                   Event;
514     ACPI_OBJECT_METHOD                  Method;
515     ACPI_OBJECT_MUTEX                   Mutex;
516     ACPI_OBJECT_REGION                  Region;
517     ACPI_OBJECT_NOTIFY_COMMON           CommonNotify;
518     ACPI_OBJECT_DEVICE                  Device;
519     ACPI_OBJECT_POWER_RESOURCE          PowerResource;
520     ACPI_OBJECT_PROCESSOR               Processor;
521     ACPI_OBJECT_THERMAL_ZONE            ThermalZone;
522     ACPI_OBJECT_FIELD_COMMON            CommonField;
523     ACPI_OBJECT_REGION_FIELD            Field;
524     ACPI_OBJECT_BUFFER_FIELD            BufferField;
525     ACPI_OBJECT_BANK_FIELD              BankField;
526     ACPI_OBJECT_INDEX_FIELD             IndexField;
527     ACPI_OBJECT_NOTIFY_HANDLER          Notify;
528     ACPI_OBJECT_ADDR_HANDLER            AddressSpace;
529     ACPI_OBJECT_REFERENCE               Reference;
530     ACPI_OBJECT_EXTRA                   Extra;
531     ACPI_OBJECT_DATA                    Data;
532     ACPI_OBJECT_CACHE_LIST              Cache;
533
534     /*
535      * Add namespace node to union in order to simplify code that accepts both
536      * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
537      * a common DescriptorType field in order to differentiate them.
538      */
539     ACPI_NAMESPACE_NODE                 Node;
540
541 } ACPI_OPERAND_OBJECT;
542
543
544 /******************************************************************************
545  *
546  * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
547  *
548  *****************************************************************************/
549
550 /* Object descriptor types */
551
552 #define ACPI_DESC_TYPE_CACHED           0x01        /* Used only when object is cached */
553 #define ACPI_DESC_TYPE_STATE            0x02
554 #define ACPI_DESC_TYPE_STATE_UPDATE     0x03
555 #define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
556 #define ACPI_DESC_TYPE_STATE_CONTROL    0x05
557 #define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
558 #define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
559 #define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
560 #define ACPI_DESC_TYPE_STATE_RESULT     0x09
561 #define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
562 #define ACPI_DESC_TYPE_STATE_THREAD     0x0B
563 #define ACPI_DESC_TYPE_WALK             0x0C
564 #define ACPI_DESC_TYPE_PARSER           0x0D
565 #define ACPI_DESC_TYPE_OPERAND          0x0E
566 #define ACPI_DESC_TYPE_NAMED            0x0F
567 #define ACPI_DESC_TYPE_MAX              0x0F
568
569
570 typedef struct acpi_common_descriptor
571 {
572     void                            *CommonPointer;
573     UINT8                           DescriptorType; /* To differentiate various internal objs */
574
575 } ACPI_COMMON_DESCRIPTOR;
576
577 typedef union acpi_descriptor
578 {
579     ACPI_COMMON_DESCRIPTOR          Common;
580     ACPI_OPERAND_OBJECT             Object;
581     ACPI_NAMESPACE_NODE             Node;
582     ACPI_PARSE_OBJECT               Op;
583
584 } ACPI_DESCRIPTOR;
585
586 #pragma pack(pop) /* Restore original struct packing */
587
588 #endif /* _ACOBJECT_H */