xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/include/aclocal.h (revision e688bf23d48bfd1216a0cacbdbda5e35a1bcd779)
1 /******************************************************************************
2  *
3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights.  You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code.  No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision.  In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change.  Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee.  Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution.  In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government.  In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #ifndef __ACLOCAL_H__
117 #define __ACLOCAL_H__
118 
119 
120 /* acpisrc:StructDefs -- for acpisrc conversion */
121 
122 #define ACPI_SERIALIZED                 0xFF
123 
124 typedef UINT32                          ACPI_MUTEX_HANDLE;
125 #define ACPI_GLOBAL_LOCK                (ACPI_SEMAPHORE) (-1)
126 
127 /* Total number of aml opcodes defined */
128 
129 #define AML_NUM_OPCODES                 0x81
130 
131 
132 /* Forward declarations */
133 
134 struct acpi_walk_state;
135 struct acpi_obj_mutex;
136 union acpi_parse_object;
137 
138 
139 /*****************************************************************************
140  *
141  * Mutex typedefs and structs
142  *
143  ****************************************************************************/
144 
145 
146 /*
147  * Predefined handles for the mutex objects used within the subsystem
148  * All mutex objects are automatically created by AcpiUtMutexInitialize.
149  *
150  * The acquire/release ordering protocol is implied via this list. Mutexes
151  * with a lower value must be acquired before mutexes with a higher value.
152  *
153  * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames
154  * table below also!
155  */
156 #define ACPI_MTX_INTERPRETER            0   /* AML Interpreter, main lock */
157 #define ACPI_MTX_NAMESPACE              1   /* ACPI Namespace */
158 #define ACPI_MTX_TABLES                 2   /* Data for ACPI tables */
159 #define ACPI_MTX_EVENTS                 3   /* Data for ACPI events */
160 #define ACPI_MTX_CACHES                 4   /* Internal caches, general purposes */
161 #define ACPI_MTX_MEMORY                 5   /* Debug memory tracking lists */
162 #define ACPI_MTX_DEBUG_CMD_COMPLETE     6   /* AML debugger */
163 #define ACPI_MTX_DEBUG_CMD_READY        7   /* AML debugger */
164 
165 #define ACPI_MAX_MUTEX                  7
166 #define ACPI_NUM_MUTEX                  ACPI_MAX_MUTEX+1
167 
168 
169 /* Lock structure for reader/writer interfaces */
170 
171 typedef struct acpi_rw_lock
172 {
173     ACPI_MUTEX              WriterMutex;
174     ACPI_MUTEX              ReaderMutex;
175     UINT32                  NumReaders;
176 
177 } ACPI_RW_LOCK;
178 
179 
180 /*
181  * Predefined handles for spinlocks used within the subsystem.
182  * These spinlocks are created by AcpiUtMutexInitialize
183  */
184 #define ACPI_LOCK_GPES                  0
185 #define ACPI_LOCK_HARDWARE              1
186 
187 #define ACPI_MAX_LOCK                   1
188 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
189 
190 
191 /* This Thread ID means that the mutex is not in use (unlocked) */
192 
193 #define ACPI_MUTEX_NOT_ACQUIRED         (ACPI_THREAD_ID) -1
194 
195 /* Table for the global mutexes */
196 
197 typedef struct acpi_mutex_info
198 {
199     ACPI_MUTEX                      Mutex;
200     UINT32                          UseCount;
201     ACPI_THREAD_ID                  ThreadId;
202 
203 } ACPI_MUTEX_INFO;
204 
205 
206 /* Lock flag parameter for various interfaces */
207 
208 #define ACPI_MTX_DO_NOT_LOCK            0
209 #define ACPI_MTX_LOCK                   1
210 
211 
212 /* Field access granularities */
213 
214 #define ACPI_FIELD_BYTE_GRANULARITY     1
215 #define ACPI_FIELD_WORD_GRANULARITY     2
216 #define ACPI_FIELD_DWORD_GRANULARITY    4
217 #define ACPI_FIELD_QWORD_GRANULARITY    8
218 
219 
220 #define ACPI_ENTRY_NOT_FOUND            NULL
221 
222 
223 /*****************************************************************************
224  *
225  * Namespace typedefs and structs
226  *
227  ****************************************************************************/
228 
229 /* Operational modes of the AML interpreter/scanner */
230 
231 typedef enum
232 {
233     ACPI_IMODE_LOAD_PASS1           = 0x01,
234     ACPI_IMODE_LOAD_PASS2           = 0x02,
235     ACPI_IMODE_EXECUTE              = 0x03
236 
237 } ACPI_INTERPRETER_MODE;
238 
239 
240 /*
241  * The Namespace Node describes a named object that appears in the AML.
242  * DescriptorType is used to differentiate between internal descriptors.
243  *
244  * The node is optimized for both 32-bit and 64-bit platforms:
245  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
246  *
247  * Note: The DescriptorType and Type fields must appear in the identical
248  * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
249  * structures.
250  */
251 typedef struct acpi_namespace_node
252 {
253     union acpi_operand_object       *Object;        /* Interpreter object */
254     UINT8                           DescriptorType; /* Differentiate object descriptor types */
255     UINT8                           Type;           /* ACPI Type associated with this name */
256     UINT8                           Flags;          /* Miscellaneous flags */
257     ACPI_OWNER_ID                   OwnerId;        /* Node creator */
258     ACPI_NAME_UNION                 Name;           /* ACPI Name, always 4 chars per ACPI spec */
259     struct acpi_namespace_node      *Parent;        /* Parent node */
260     struct acpi_namespace_node      *Child;         /* First child */
261     struct acpi_namespace_node      *Peer;          /* First peer */
262 
263     /*
264      * The following fields are used by the ASL compiler and disassembler only
265      */
266 #ifdef ACPI_LARGE_NAMESPACE_NODE
267     union acpi_parse_object         *Op;
268     UINT32                          Value;
269     UINT32                          Length;
270 #endif
271 
272 } ACPI_NAMESPACE_NODE;
273 
274 
275 /* Namespace Node flags */
276 
277 #define ANOBJ_RESERVED                  0x01    /* Available for use */
278 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
279 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
280 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
281 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
282 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
283 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (InstallMethod) */
284 
285 #define ANOBJ_IS_EXTERNAL               0x08    /* iASL only: This object created via External() */
286 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* iASL only: Method has no return value */
287 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* iASL only: Method has at least one return value */
288 #define ANOBJ_IS_REFERENCED             0x80    /* iASL only: Object was referenced */
289 
290 
291 /* Internal ACPI table management - master table list */
292 
293 typedef struct acpi_table_list
294 {
295     ACPI_TABLE_DESC                 *Tables;            /* Table descriptor array */
296     UINT32                          CurrentTableCount;  /* Tables currently in the array */
297     UINT32                          MaxTableCount;      /* Max tables array will hold */
298     UINT8                           Flags;
299 
300 } ACPI_TABLE_LIST;
301 
302 /* Flags for above */
303 
304 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
305 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
306 #define ACPI_ROOT_ALLOW_RESIZE          (2)
307 
308 
309 /* Predefined (fixed) table indexes */
310 
311 #define ACPI_TABLE_INDEX_DSDT           (0)
312 #define ACPI_TABLE_INDEX_FACS           (1)
313 
314 
315 typedef struct acpi_find_context
316 {
317     char                            *SearchFor;
318     ACPI_HANDLE                     *List;
319     UINT32                          *Count;
320 
321 } ACPI_FIND_CONTEXT;
322 
323 
324 typedef struct acpi_ns_search_data
325 {
326     ACPI_NAMESPACE_NODE             *Node;
327 
328 } ACPI_NS_SEARCH_DATA;
329 
330 
331 /* Object types used during package copies */
332 
333 #define ACPI_COPY_TYPE_SIMPLE           0
334 #define ACPI_COPY_TYPE_PACKAGE          1
335 
336 
337 /* Info structure used to convert external<->internal namestrings */
338 
339 typedef struct acpi_namestring_info
340 {
341     const char                      *ExternalName;
342     const char                      *NextExternalChar;
343     char                            *InternalName;
344     UINT32                          Length;
345     UINT32                          NumSegments;
346     UINT32                          NumCarats;
347     BOOLEAN                         FullyQualified;
348 
349 } ACPI_NAMESTRING_INFO;
350 
351 
352 /* Field creation info */
353 
354 typedef struct acpi_create_field_info
355 {
356     ACPI_NAMESPACE_NODE             *RegionNode;
357     ACPI_NAMESPACE_NODE             *FieldNode;
358     ACPI_NAMESPACE_NODE             *RegisterNode;
359     ACPI_NAMESPACE_NODE             *DataRegisterNode;
360     ACPI_NAMESPACE_NODE             *ConnectionNode;
361     UINT8                           *ResourceBuffer;
362     UINT32                          BankValue;
363     UINT32                          FieldBitPosition;
364     UINT32                          FieldBitLength;
365     UINT16                          ResourceLength;
366     UINT8                           FieldFlags;
367     UINT8                           Attribute;
368     UINT8                           FieldType;
369     UINT8                           AccessLength;
370 
371 } ACPI_CREATE_FIELD_INFO;
372 
373 
374 typedef
375 ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
376     struct acpi_walk_state          *WalkState);
377 
378 
379 /*
380  * Bitmapped ACPI types.  Used internally only
381  */
382 #define ACPI_BTYPE_ANY                  0x00000000
383 #define ACPI_BTYPE_INTEGER              0x00000001
384 #define ACPI_BTYPE_STRING               0x00000002
385 #define ACPI_BTYPE_BUFFER               0x00000004
386 #define ACPI_BTYPE_PACKAGE              0x00000008
387 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
388 #define ACPI_BTYPE_DEVICE               0x00000020
389 #define ACPI_BTYPE_EVENT                0x00000040
390 #define ACPI_BTYPE_METHOD               0x00000080
391 #define ACPI_BTYPE_MUTEX                0x00000100
392 #define ACPI_BTYPE_REGION               0x00000200
393 #define ACPI_BTYPE_POWER                0x00000400
394 #define ACPI_BTYPE_PROCESSOR            0x00000800
395 #define ACPI_BTYPE_THERMAL              0x00001000
396 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
397 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
398 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
399 #define ACPI_BTYPE_REFERENCE            0x00010000
400 #define ACPI_BTYPE_RESOURCE             0x00020000
401 
402 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
403 
404 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
405 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
406 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
407 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
408 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
409 
410 
411 /*
412  * Information structure for ACPI predefined names.
413  * Each entry in the table contains the following items:
414  *
415  * Name                 - The ACPI reserved name
416  * ParamCount           - Number of arguments to the method
417  * ExpectedReturnBtypes - Allowed type(s) for the return value
418  */
419 typedef struct acpi_name_info
420 {
421     char                        Name[ACPI_NAME_SIZE];
422     UINT8                       ParamCount;
423     UINT8                       ExpectedBtypes;
424 
425 } ACPI_NAME_INFO;
426 
427 /*
428  * Secondary information structures for ACPI predefined objects that return
429  * package objects. This structure appears as the next entry in the table
430  * after the NAME_INFO structure above.
431  *
432  * The reason for this is to minimize the size of the predefined name table.
433  */
434 
435 /*
436  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
437  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
438  * ACPI_PTYPE2_FIX_VAR
439  */
440 typedef struct acpi_package_info
441 {
442     UINT8                       Type;
443     UINT8                       ObjectType1;
444     UINT8                       Count1;
445     UINT8                       ObjectType2;
446     UINT8                       Count2;
447     UINT8                       Reserved;
448 
449 } ACPI_PACKAGE_INFO;
450 
451 /* Used for ACPI_PTYPE2_FIXED */
452 
453 typedef struct acpi_package_info2
454 {
455     UINT8                       Type;
456     UINT8                       Count;
457     UINT8                       ObjectType[4];
458 
459 } ACPI_PACKAGE_INFO2;
460 
461 /* Used for ACPI_PTYPE1_OPTION */
462 
463 typedef struct acpi_package_info3
464 {
465     UINT8                       Type;
466     UINT8                       Count;
467     UINT8                       ObjectType[2];
468     UINT8                       TailObjectType;
469     UINT8                       Reserved;
470 
471 } ACPI_PACKAGE_INFO3;
472 
473 typedef union acpi_predefined_info
474 {
475     ACPI_NAME_INFO              Info;
476     ACPI_PACKAGE_INFO           RetInfo;
477     ACPI_PACKAGE_INFO2          RetInfo2;
478     ACPI_PACKAGE_INFO3          RetInfo3;
479 
480 } ACPI_PREDEFINED_INFO;
481 
482 
483 /* Data block used during object validation */
484 
485 typedef struct acpi_predefined_data
486 {
487     char                        *Pathname;
488     const ACPI_PREDEFINED_INFO  *Predefined;
489     union acpi_operand_object   *ParentPackage;
490     ACPI_NAMESPACE_NODE         *Node;
491     UINT32                      Flags;
492     UINT8                       NodeFlags;
493 
494 } ACPI_PREDEFINED_DATA;
495 
496 /* Defines for Flags field above */
497 
498 #define ACPI_OBJECT_REPAIRED    1
499 #define ACPI_OBJECT_WRAPPED     2
500 
501 
502 /*
503  * Bitmapped return value types
504  * Note: the actual data types must be contiguous, a loop in nspredef.c
505  * depends on this.
506  */
507 #define ACPI_RTYPE_ANY                  0x00
508 #define ACPI_RTYPE_NONE                 0x01
509 #define ACPI_RTYPE_INTEGER              0x02
510 #define ACPI_RTYPE_STRING               0x04
511 #define ACPI_RTYPE_BUFFER               0x08
512 #define ACPI_RTYPE_PACKAGE              0x10
513 #define ACPI_RTYPE_REFERENCE            0x20
514 #define ACPI_RTYPE_ALL                  0x3F
515 
516 #define ACPI_NUM_RTYPES                 5   /* Number of actual object types */
517 
518 
519 /*****************************************************************************
520  *
521  * Event typedefs and structs
522  *
523  ****************************************************************************/
524 
525 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
526 
527 typedef struct acpi_gpe_handler_info
528 {
529     ACPI_GPE_HANDLER                Address;        /* Address of handler, if any */
530     void                            *Context;       /* Context to be passed to handler */
531     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level (saved) */
532     UINT8                           OriginalFlags;  /* Original (pre-handler) GPE info */
533     BOOLEAN                         OriginallyEnabled; /* True if GPE was originally enabled */
534 
535 } ACPI_GPE_HANDLER_INFO;
536 
537 /* Notify info for implicit notify, multiple device objects */
538 
539 typedef struct acpi_gpe_notify_info
540 {
541     ACPI_NAMESPACE_NODE             *DeviceNode;    /* Device to be notified */
542     struct acpi_gpe_notify_info     *Next;
543 
544 } ACPI_GPE_NOTIFY_INFO;
545 
546 /*
547  * GPE dispatch info. At any time, the GPE can have at most one type
548  * of dispatch - Method, Handler, or Implicit Notify.
549  */
550 typedef union acpi_gpe_dispatch_info
551 {
552     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level */
553     ACPI_GPE_HANDLER_INFO           *Handler;       /* Installed GPE handler */
554     ACPI_GPE_NOTIFY_INFO            *NotifyList;    /* List of _PRW devices for implicit notifies */
555 
556 } ACPI_GPE_DISPATCH_INFO;
557 
558 /*
559  * Information about a GPE, one per each GPE in an array.
560  * NOTE: Important to keep this struct as small as possible.
561  */
562 typedef struct acpi_gpe_event_info
563 {
564     union acpi_gpe_dispatch_info    Dispatch;       /* Either Method, Handler, or NotifyList */
565     struct acpi_gpe_register_info   *RegisterInfo;  /* Backpointer to register info */
566     UINT8                           Flags;          /* Misc info about this GPE */
567     UINT8                           GpeNumber;      /* This GPE */
568     UINT8                           RuntimeCount;   /* References to a run GPE */
569 
570 } ACPI_GPE_EVENT_INFO;
571 
572 /* Information about a GPE register pair, one per each status/enable pair in an array */
573 
574 typedef struct acpi_gpe_register_info
575 {
576     ACPI_GENERIC_ADDRESS            StatusAddress;  /* Address of status reg */
577     ACPI_GENERIC_ADDRESS            EnableAddress;  /* Address of enable reg */
578     UINT8                           EnableForWake;  /* GPEs to keep enabled when sleeping */
579     UINT8                           EnableForRun;   /* GPEs to keep enabled when running */
580     UINT8                           BaseGpeNumber;  /* Base GPE number for this register */
581 
582 } ACPI_GPE_REGISTER_INFO;
583 
584 /*
585  * Information about a GPE register block, one per each installed block --
586  * GPE0, GPE1, and one per each installed GPE Block Device.
587  */
588 typedef struct acpi_gpe_block_info
589 {
590     ACPI_NAMESPACE_NODE             *Node;
591     struct acpi_gpe_block_info      *Previous;
592     struct acpi_gpe_block_info      *Next;
593     struct acpi_gpe_xrupt_info      *XruptBlock;    /* Backpointer to interrupt block */
594     ACPI_GPE_REGISTER_INFO          *RegisterInfo;  /* One per GPE register pair */
595     ACPI_GPE_EVENT_INFO             *EventInfo;     /* One for each GPE */
596     ACPI_GENERIC_ADDRESS            BlockAddress;   /* Base address of the block */
597     UINT32                          RegisterCount;  /* Number of register pairs in block */
598     UINT16                          GpeCount;       /* Number of individual GPEs in block */
599     UINT8                           BlockBaseNumber;/* Base GPE number for this block */
600     BOOLEAN                         Initialized;    /* TRUE if this block is initialized */
601 
602 } ACPI_GPE_BLOCK_INFO;
603 
604 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
605 
606 typedef struct acpi_gpe_xrupt_info
607 {
608     struct acpi_gpe_xrupt_info      *Previous;
609     struct acpi_gpe_xrupt_info      *Next;
610     ACPI_GPE_BLOCK_INFO             *GpeBlockListHead;  /* List of GPE blocks for this xrupt */
611     UINT32                          InterruptNumber;    /* System interrupt number */
612 
613 } ACPI_GPE_XRUPT_INFO;
614 
615 typedef struct acpi_gpe_walk_info
616 {
617     ACPI_NAMESPACE_NODE             *GpeDevice;
618     ACPI_GPE_BLOCK_INFO             *GpeBlock;
619     UINT16                          Count;
620     ACPI_OWNER_ID                   OwnerId;
621     BOOLEAN                         ExecuteByOwnerId;
622 
623 } ACPI_GPE_WALK_INFO;
624 
625 typedef struct acpi_gpe_device_info
626 {
627     UINT32                          Index;
628     UINT32                          NextBlockBaseIndex;
629     ACPI_STATUS                     Status;
630     ACPI_NAMESPACE_NODE             *GpeDevice;
631 
632 } ACPI_GPE_DEVICE_INFO;
633 
634 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
635     ACPI_GPE_XRUPT_INFO             *GpeXruptInfo,
636     ACPI_GPE_BLOCK_INFO             *GpeBlock,
637     void                            *Context);
638 
639 
640 /* Information about each particular fixed event */
641 
642 typedef struct acpi_fixed_event_handler
643 {
644     ACPI_EVENT_HANDLER              Handler;        /* Address of handler. */
645     void                            *Context;       /* Context to be passed to handler */
646 
647 } ACPI_FIXED_EVENT_HANDLER;
648 
649 typedef struct acpi_fixed_event_info
650 {
651     UINT8                           StatusRegisterId;
652     UINT8                           EnableRegisterId;
653     UINT16                          StatusBitMask;
654     UINT16                          EnableBitMask;
655 
656 } ACPI_FIXED_EVENT_INFO;
657 
658 /* Information used during field processing */
659 
660 typedef struct acpi_field_info
661 {
662     UINT8                           SkipField;
663     UINT8                           FieldFlag;
664     UINT32                          PkgLength;
665 
666 } ACPI_FIELD_INFO;
667 
668 
669 /*****************************************************************************
670  *
671  * Generic "state" object for stacks
672  *
673  ****************************************************************************/
674 
675 #define ACPI_CONTROL_NORMAL                  0xC0
676 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
677 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
678 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
679 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
680 
681 
682 #define ACPI_STATE_COMMON \
683     void                            *Next; \
684     UINT8                           DescriptorType; /* To differentiate various internal objs */\
685     UINT8                           Flags; \
686     UINT16                          Value; \
687     UINT16                          State;
688 
689     /* There are 2 bytes available here until the next natural alignment boundary */
690 
691 typedef struct acpi_common_state
692 {
693     ACPI_STATE_COMMON
694 } ACPI_COMMON_STATE;
695 
696 
697 /*
698  * Update state - used to traverse complex objects such as packages
699  */
700 typedef struct acpi_update_state
701 {
702     ACPI_STATE_COMMON
703     union acpi_operand_object       *Object;
704 
705 } ACPI_UPDATE_STATE;
706 
707 
708 /*
709  * Pkg state - used to traverse nested package structures
710  */
711 typedef struct acpi_pkg_state
712 {
713     ACPI_STATE_COMMON
714     UINT16                          Index;
715     union acpi_operand_object       *SourceObject;
716     union acpi_operand_object       *DestObject;
717     struct acpi_walk_state          *WalkState;
718     void                            *ThisTargetObj;
719     UINT32                          NumPackages;
720 
721 } ACPI_PKG_STATE;
722 
723 
724 /*
725  * Control state - one per if/else and while constructs.
726  * Allows nesting of these constructs
727  */
728 typedef struct acpi_control_state
729 {
730     ACPI_STATE_COMMON
731     UINT16                          Opcode;
732     union acpi_parse_object         *PredicateOp;
733     UINT8                           *AmlPredicateStart;     /* Start of if/while predicate */
734     UINT8                           *PackageEnd;            /* End of if/while block */
735     UINT32                          LoopCount;              /* While() loop counter */
736 
737 } ACPI_CONTROL_STATE;
738 
739 
740 /*
741  * Scope state - current scope during namespace lookups
742  */
743 typedef struct acpi_scope_state
744 {
745     ACPI_STATE_COMMON
746     ACPI_NAMESPACE_NODE             *Node;
747 
748 } ACPI_SCOPE_STATE;
749 
750 
751 typedef struct acpi_pscope_state
752 {
753     ACPI_STATE_COMMON
754     UINT32                          ArgCount;               /* Number of fixed arguments */
755     union acpi_parse_object         *Op;                    /* Current op being parsed */
756     UINT8                           *ArgEnd;                /* Current argument end */
757     UINT8                           *PkgEnd;                /* Current package end */
758     UINT32                          ArgList;                /* Next argument to parse */
759 
760 } ACPI_PSCOPE_STATE;
761 
762 
763 /*
764  * Thread state - one per thread across multiple walk states.  Multiple walk
765  * states are created when there are nested control methods executing.
766  */
767 typedef struct acpi_thread_state
768 {
769     ACPI_STATE_COMMON
770     UINT8                           CurrentSyncLevel;       /* Mutex Sync (nested acquire) level */
771     struct acpi_walk_state          *WalkStateList;         /* Head of list of WalkStates for this thread */
772     union acpi_operand_object       *AcquiredMutexList;     /* List of all currently acquired mutexes */
773     ACPI_THREAD_ID                  ThreadId;               /* Running thread ID */
774 
775 } ACPI_THREAD_STATE;
776 
777 
778 /*
779  * Result values - used to accumulate the results of nested
780  * AML arguments
781  */
782 typedef struct acpi_result_values
783 {
784     ACPI_STATE_COMMON
785     union acpi_operand_object       *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
786 
787 } ACPI_RESULT_VALUES;
788 
789 
790 typedef
791 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
792     struct acpi_walk_state          *WalkState,
793     union acpi_parse_object         **OutOp);
794 
795 typedef
796 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
797     struct acpi_walk_state          *WalkState);
798 
799 
800 /* Global handlers for AML Notifies */
801 
802 typedef struct acpi_global_notify_handler
803 {
804     ACPI_NOTIFY_HANDLER             Handler;
805     void                            *Context;
806 
807 } ACPI_GLOBAL_NOTIFY_HANDLER;
808 
809 /*
810  * Notify info - used to pass info to the deferred notify
811  * handler/dispatcher.
812  */
813 typedef struct acpi_notify_info
814 {
815     ACPI_STATE_COMMON
816     UINT8                           HandlerListId;
817     ACPI_NAMESPACE_NODE             *Node;
818     union acpi_operand_object       *HandlerListHead;
819     ACPI_GLOBAL_NOTIFY_HANDLER      *Global;
820 
821 } ACPI_NOTIFY_INFO;
822 
823 
824 /* Generic state is union of structs above */
825 
826 typedef union acpi_generic_state
827 {
828     ACPI_COMMON_STATE               Common;
829     ACPI_CONTROL_STATE              Control;
830     ACPI_UPDATE_STATE               Update;
831     ACPI_SCOPE_STATE                Scope;
832     ACPI_PSCOPE_STATE               ParseScope;
833     ACPI_PKG_STATE                  Pkg;
834     ACPI_THREAD_STATE               Thread;
835     ACPI_RESULT_VALUES              Results;
836     ACPI_NOTIFY_INFO                Notify;
837 
838 } ACPI_GENERIC_STATE;
839 
840 
841 /*****************************************************************************
842  *
843  * Interpreter typedefs and structs
844  *
845  ****************************************************************************/
846 
847 typedef
848 ACPI_STATUS (*ACPI_EXECUTE_OP) (
849     struct acpi_walk_state          *WalkState);
850 
851 /* Address Range info block */
852 
853 typedef struct acpi_address_range
854 {
855     struct acpi_address_range   *Next;
856     ACPI_NAMESPACE_NODE         *RegionNode;
857     ACPI_PHYSICAL_ADDRESS       StartAddress;
858     ACPI_PHYSICAL_ADDRESS       EndAddress;
859 
860 } ACPI_ADDRESS_RANGE;
861 
862 
863 /*****************************************************************************
864  *
865  * Parser typedefs and structs
866  *
867  ****************************************************************************/
868 
869 /*
870  * AML opcode, name, and argument layout
871  */
872 typedef struct acpi_opcode_info
873 {
874 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
875     char                            *Name;          /* Opcode name (disassembler/debug only) */
876 #endif
877     UINT32                          ParseArgs;      /* Grammar/Parse time arguments */
878     UINT32                          RuntimeArgs;    /* Interpret time arguments */
879     UINT16                          Flags;          /* Misc flags */
880     UINT8                           ObjectType;     /* Corresponding internal object type */
881     UINT8                           Class;          /* Opcode class */
882     UINT8                           Type;           /* Opcode type */
883 
884 } ACPI_OPCODE_INFO;
885 
886 /* Structure for Resource Tag information */
887 
888 typedef struct acpi_tag_info
889 {
890     UINT32                          BitOffset;
891     UINT32                          BitLength;
892 
893 } ACPI_TAG_INFO;
894 
895 /* Value associated with the parse object */
896 
897 typedef union acpi_parse_value
898 {
899     UINT64                          Integer;        /* Integer constant (Up to 64 bits) */
900     UINT32                          Size;           /* bytelist or field size */
901     char                            *String;        /* NULL terminated string */
902     UINT8                           *Buffer;        /* buffer or string */
903     char                            *Name;          /* NULL terminated string */
904     union acpi_parse_object         *Arg;           /* arguments and contained ops */
905     ACPI_TAG_INFO                   Tag;            /* Resource descriptor tag info  */
906 
907 } ACPI_PARSE_VALUE;
908 
909 
910 #ifdef ACPI_DISASSEMBLER
911 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
912 #else
913 #define ACPI_DISASM_ONLY_MEMBERS(a)
914 #endif
915 
916 #define ACPI_PARSE_COMMON \
917     union acpi_parse_object         *Parent;        /* Parent op */\
918     UINT8                           DescriptorType; /* To differentiate various internal objs */\
919     UINT8                           Flags;          /* Type of Op */\
920     UINT16                          AmlOpcode;      /* AML opcode */\
921     UINT32                          AmlOffset;      /* Offset of declaration in AML */\
922     union acpi_parse_object         *Next;          /* Next op */\
923     ACPI_NAMESPACE_NODE             *Node;          /* For use by interpreter */\
924     ACPI_PARSE_VALUE                Value;          /* Value or args associated with the opcode */\
925     UINT8                           ArgListLength;  /* Number of elements in the arg list */\
926     ACPI_DISASM_ONLY_MEMBERS (\
927     UINT8                           DisasmFlags;    /* Used during AML disassembly */\
928     UINT8                           DisasmOpcode;   /* Subtype used for disassembly */\
929     char                            AmlOpName[16])  /* Op name (debug only) */
930 
931 
932 #define ACPI_DASM_BUFFER                0x00
933 #define ACPI_DASM_RESOURCE              0x01
934 #define ACPI_DASM_STRING                0x02
935 #define ACPI_DASM_UNICODE               0x03
936 #define ACPI_DASM_EISAID                0x04
937 #define ACPI_DASM_MATCHOP               0x05
938 #define ACPI_DASM_LNOT_PREFIX           0x06
939 #define ACPI_DASM_LNOT_SUFFIX           0x07
940 #define ACPI_DASM_IGNORE                0x08
941 
942 /*
943  * Generic operation (for example:  If, While, Store)
944  */
945 typedef struct acpi_parse_obj_common
946 {
947     ACPI_PARSE_COMMON
948 } ACPI_PARSE_OBJ_COMMON;
949 
950 
951 /*
952  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
953  * and bytelists.
954  */
955 typedef struct acpi_parse_obj_named
956 {
957     ACPI_PARSE_COMMON
958     UINT8                           *Path;
959     UINT8                           *Data;          /* AML body or bytelist data */
960     UINT32                          Length;         /* AML length */
961     UINT32                          Name;           /* 4-byte name or zero if no name */
962 
963 } ACPI_PARSE_OBJ_NAMED;
964 
965 
966 /* This version is used by the iASL compiler only */
967 
968 #define ACPI_MAX_PARSEOP_NAME   20
969 
970 typedef struct acpi_parse_obj_asl
971 {
972     ACPI_PARSE_COMMON
973     union acpi_parse_object         *Child;
974     union acpi_parse_object         *ParentMethod;
975     char                            *Filename;
976     char                            *ExternalName;
977     char                            *Namepath;
978     char                            NameSeg[4];
979     UINT32                          ExtraValue;
980     UINT32                          Column;
981     UINT32                          LineNumber;
982     UINT32                          LogicalLineNumber;
983     UINT32                          LogicalByteOffset;
984     UINT32                          EndLine;
985     UINT32                          EndLogicalLine;
986     UINT32                          AcpiBtype;
987     UINT32                          AmlLength;
988     UINT32                          AmlSubtreeLength;
989     UINT32                          FinalAmlLength;
990     UINT32                          FinalAmlOffset;
991     UINT32                          CompileFlags;
992     UINT16                          ParseOpcode;
993     UINT8                           AmlOpcodeLength;
994     UINT8                           AmlPkgLenBytes;
995     UINT8                           Extra;
996     char                            ParseOpName[ACPI_MAX_PARSEOP_NAME];
997 
998 } ACPI_PARSE_OBJ_ASL;
999 
1000 typedef union acpi_parse_object
1001 {
1002     ACPI_PARSE_OBJ_COMMON           Common;
1003     ACPI_PARSE_OBJ_NAMED            Named;
1004     ACPI_PARSE_OBJ_ASL              Asl;
1005 
1006 } ACPI_PARSE_OBJECT;
1007 
1008 
1009 /*
1010  * Parse state - one state per parser invocation and each control
1011  * method.
1012  */
1013 typedef struct acpi_parse_state
1014 {
1015     UINT8                           *AmlStart;      /* First AML byte */
1016     UINT8                           *Aml;           /* Next AML byte */
1017     UINT8                           *AmlEnd;        /* (last + 1) AML byte */
1018     UINT8                           *PkgStart;      /* Current package begin */
1019     UINT8                           *PkgEnd;        /* Current package end */
1020     union acpi_parse_object         *StartOp;       /* Root of parse tree */
1021     struct acpi_namespace_node      *StartNode;
1022     union acpi_generic_state        *Scope;         /* Current scope */
1023     union acpi_parse_object         *StartScope;
1024     UINT32                          AmlSize;
1025 
1026 } ACPI_PARSE_STATE;
1027 
1028 
1029 /* Parse object flags */
1030 
1031 #define ACPI_PARSEOP_GENERIC            0x01
1032 #define ACPI_PARSEOP_NAMED              0x02
1033 #define ACPI_PARSEOP_DEFERRED           0x04
1034 #define ACPI_PARSEOP_BYTELIST           0x08
1035 #define ACPI_PARSEOP_IN_STACK           0x10
1036 #define ACPI_PARSEOP_TARGET             0x20
1037 #define ACPI_PARSEOP_IN_CACHE           0x80
1038 
1039 /* Parse object DisasmFlags */
1040 
1041 #define ACPI_PARSEOP_IGNORE             0x01
1042 #define ACPI_PARSEOP_PARAMLIST          0x02
1043 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
1044 #define ACPI_PARSEOP_PREDEF_CHECKED     0x08
1045 #define ACPI_PARSEOP_SPECIAL            0x10
1046 
1047 
1048 /*****************************************************************************
1049  *
1050  * Hardware (ACPI registers) and PNP
1051  *
1052  ****************************************************************************/
1053 
1054 typedef struct acpi_bit_register_info
1055 {
1056     UINT8                           ParentRegister;
1057     UINT8                           BitPosition;
1058     UINT16                          AccessBitMask;
1059 
1060 } ACPI_BIT_REGISTER_INFO;
1061 
1062 
1063 /*
1064  * Some ACPI registers have bits that must be ignored -- meaning that they
1065  * must be preserved.
1066  */
1067 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
1068 
1069 /* Write-only bits must be zeroed by software */
1070 
1071 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
1072 
1073 /* For control registers, both ignored and reserved bits must be preserved */
1074 
1075 /*
1076  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1077  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1078  * bit position", section 4.7.3.2.1. However, on some machines the OS must
1079  * write a one to this bit after resume for the machine to work properly.
1080  * To enable this, we no longer attempt to preserve this bit. No machines
1081  * are known to fail if the bit is not preserved. (May 2009)
1082  */
1083 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
1084 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
1085 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1086          (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1087 
1088 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE /* All except bit 0 */
1089 
1090 /*
1091  * Register IDs
1092  * These are the full ACPI registers
1093  */
1094 #define ACPI_REGISTER_PM1_STATUS                0x01
1095 #define ACPI_REGISTER_PM1_ENABLE                0x02
1096 #define ACPI_REGISTER_PM1_CONTROL               0x03
1097 #define ACPI_REGISTER_PM2_CONTROL               0x04
1098 #define ACPI_REGISTER_PM_TIMER                  0x05
1099 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
1100 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
1101 
1102 
1103 /* Masks used to access the BitRegisters */
1104 
1105 #define ACPI_BITMASK_TIMER_STATUS               0x0001
1106 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
1107 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
1108 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
1109 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
1110 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
1111 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000    /* ACPI 3.0 */
1112 #define ACPI_BITMASK_WAKE_STATUS                0x8000
1113 
1114 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
1115     ACPI_BITMASK_TIMER_STATUS          | \
1116     ACPI_BITMASK_BUS_MASTER_STATUS     | \
1117     ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
1118     ACPI_BITMASK_POWER_BUTTON_STATUS   | \
1119     ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
1120     ACPI_BITMASK_RT_CLOCK_STATUS       | \
1121     ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
1122     ACPI_BITMASK_WAKE_STATUS)
1123 
1124 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
1125 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
1126 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
1127 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
1128 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
1129 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000    /* ACPI 3.0 */
1130 
1131 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
1132 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
1133 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
1134 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
1135 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
1136 
1137 #define ACPI_BITMASK_ARB_DISABLE                0x0001
1138 
1139 
1140 /* Raw bit position of each BitRegister */
1141 
1142 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
1143 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
1144 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
1145 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
1146 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
1147 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
1148 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
1149 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
1150 
1151 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
1152 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
1153 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
1154 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
1155 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
1156 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
1157 
1158 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
1159 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
1160 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
1161 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
1162 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
1163 
1164 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
1165 
1166 
1167 /* Structs and definitions for _OSI support and I/O port validation */
1168 
1169 #define ACPI_OSI_WIN_2000               0x01
1170 #define ACPI_OSI_WIN_XP                 0x02
1171 #define ACPI_OSI_WIN_XP_SP1             0x03
1172 #define ACPI_OSI_WINSRV_2003            0x04
1173 #define ACPI_OSI_WIN_XP_SP2             0x05
1174 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1175 #define ACPI_OSI_WIN_VISTA              0x07
1176 #define ACPI_OSI_WINSRV_2008            0x08
1177 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1178 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1179 #define ACPI_OSI_WIN_7                  0x0B
1180 
1181 #define ACPI_ALWAYS_ILLEGAL             0x00
1182 
1183 typedef struct acpi_interface_info
1184 {
1185     char                        *Name;
1186     struct acpi_interface_info  *Next;
1187     UINT8                       Flags;
1188     UINT8                       Value;
1189 
1190 } ACPI_INTERFACE_INFO;
1191 
1192 #define ACPI_OSI_INVALID                0x01
1193 #define ACPI_OSI_DYNAMIC                0x02
1194 
1195 typedef struct acpi_port_info
1196 {
1197     char                    *Name;
1198     UINT16                  Start;
1199     UINT16                  End;
1200     UINT8                   OsiDependency;
1201 
1202 } ACPI_PORT_INFO;
1203 
1204 
1205 /*****************************************************************************
1206  *
1207  * Resource descriptors
1208  *
1209  ****************************************************************************/
1210 
1211 /* ResourceType values */
1212 
1213 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
1214 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
1215 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
1216 
1217 /* Resource descriptor types and masks */
1218 
1219 #define ACPI_RESOURCE_NAME_LARGE                0x80
1220 #define ACPI_RESOURCE_NAME_SMALL                0x00
1221 
1222 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78 /* Bits 6:3 contain the type */
1223 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07 /* Bits 2:0 contain the length */
1224 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F /* Bits 6:0 contain the type */
1225 
1226 
1227 /*
1228  * Small resource descriptor "names" as defined by the ACPI specification.
1229  * Note: Bits 2:0 are used for the descriptor length
1230  */
1231 #define ACPI_RESOURCE_NAME_IRQ                  0x20
1232 #define ACPI_RESOURCE_NAME_DMA                  0x28
1233 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
1234 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
1235 #define ACPI_RESOURCE_NAME_IO                   0x40
1236 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
1237 #define ACPI_RESOURCE_NAME_FIXED_DMA            0x50
1238 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
1239 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
1240 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
1241 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
1242 #define ACPI_RESOURCE_NAME_END_TAG              0x78
1243 
1244 /*
1245  * Large resource descriptor "names" as defined by the ACPI specification.
1246  * Note: includes the Large Descriptor bit in bit[7]
1247  */
1248 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
1249 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
1250 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
1251 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
1252 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1253 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1254 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1255 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1256 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1257 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1258 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1259 #define ACPI_RESOURCE_NAME_GPIO                 0x8C
1260 #define ACPI_RESOURCE_NAME_SERIAL_BUS           0x8E
1261 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8E
1262 
1263 
1264 /*****************************************************************************
1265  *
1266  * Miscellaneous
1267  *
1268  ****************************************************************************/
1269 
1270 #define ACPI_ASCII_ZERO                 0x30
1271 
1272 
1273 /*****************************************************************************
1274  *
1275  * Disassembler
1276  *
1277  ****************************************************************************/
1278 
1279 typedef struct acpi_external_list
1280 {
1281     char                        *Path;
1282     char                        *InternalPath;
1283     struct acpi_external_list   *Next;
1284     UINT32                      Value;
1285     UINT16                      Length;
1286     UINT8                       Type;
1287     UINT8                       Flags;
1288 
1289 } ACPI_EXTERNAL_LIST;
1290 
1291 /* Values for Flags field above */
1292 
1293 #define ACPI_IPATH_ALLOCATED    0x01
1294 
1295 
1296 typedef struct acpi_external_file
1297 {
1298     char                        *Path;
1299     struct acpi_external_file   *Next;
1300 
1301 } ACPI_EXTERNAL_FILE;
1302 
1303 
1304 /*****************************************************************************
1305  *
1306  * Debugger
1307  *
1308  ****************************************************************************/
1309 
1310 typedef struct acpi_db_method_info
1311 {
1312     ACPI_HANDLE                     MainThreadGate;
1313     ACPI_HANDLE                     ThreadCompleteGate;
1314     ACPI_HANDLE                     InfoGate;
1315     ACPI_THREAD_ID                  *Threads;
1316     UINT32                          NumThreads;
1317     UINT32                          NumCreated;
1318     UINT32                          NumCompleted;
1319 
1320     char                            *Name;
1321     UINT32                          Flags;
1322     UINT32                          NumLoops;
1323     char                            Pathname[128];
1324     char                            **Args;
1325     ACPI_OBJECT_TYPE                *Types;
1326 
1327     /*
1328      * Arguments to be passed to method for the command
1329      * Threads -
1330      *   the Number of threads, ID of current thread and
1331      *   Index of current thread inside all them created.
1332      */
1333     char                            InitArgs;
1334     ACPI_OBJECT_TYPE                ArgTypes[4];
1335     char                            *Arguments[4];
1336     char                            NumThreadsStr[11];
1337     char                            IdOfThreadStr[11];
1338     char                            IndexOfThreadStr[11];
1339 
1340 } ACPI_DB_METHOD_INFO;
1341 
1342 typedef struct acpi_integrity_info
1343 {
1344     UINT32                          Nodes;
1345     UINT32                          Objects;
1346 
1347 } ACPI_INTEGRITY_INFO;
1348 
1349 
1350 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1351 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1352 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1353 
1354 
1355 /*****************************************************************************
1356  *
1357  * Debug
1358  *
1359  ****************************************************************************/
1360 
1361 /* Entry for a memory allocation (debug only) */
1362 
1363 #define ACPI_MEM_MALLOC                 0
1364 #define ACPI_MEM_CALLOC                 1
1365 #define ACPI_MAX_MODULE_NAME            16
1366 
1367 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1368     struct acpi_debug_mem_block     *Previous; \
1369     struct acpi_debug_mem_block     *Next; \
1370     UINT32                          Size; \
1371     UINT32                          Component; \
1372     UINT32                          Line; \
1373     char                            Module[ACPI_MAX_MODULE_NAME]; \
1374     UINT8                           AllocType;
1375 
1376 typedef struct acpi_debug_mem_header
1377 {
1378     ACPI_COMMON_DEBUG_MEM_HEADER
1379 
1380 } ACPI_DEBUG_MEM_HEADER;
1381 
1382 typedef struct acpi_debug_mem_block
1383 {
1384     ACPI_COMMON_DEBUG_MEM_HEADER
1385     UINT64                          UserSpace;
1386 
1387 } ACPI_DEBUG_MEM_BLOCK;
1388 
1389 
1390 #define ACPI_MEM_LIST_GLOBAL            0
1391 #define ACPI_MEM_LIST_NSNODE            1
1392 #define ACPI_MEM_LIST_MAX               1
1393 #define ACPI_NUM_MEM_LISTS              2
1394 
1395 
1396 /*****************************************************************************
1397  *
1398  * Info/help support
1399  *
1400  ****************************************************************************/
1401 
1402 typedef struct ah_predefined_name
1403 {
1404     char            *Name;
1405     char            *Description;
1406 #ifndef ACPI_ASL_COMPILER
1407     char            *Action;
1408 #endif
1409 
1410 } AH_PREDEFINED_NAME;
1411 
1412 #endif /* __ACLOCAL_H__ */
1413