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