xref: /freebsd/sys/contrib/dev/acpica/include/aclocal.h (revision 70e0bbedef95258a4dadc996d641a9bebd3f107d)
1 /******************************************************************************
2  *
3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2011, 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 
339 /*
340  * Information structure for ACPI predefined names.
341  * Each entry in the table contains the following items:
342  *
343  * Name                 - The ACPI reserved name
344  * ParamCount           - Number of arguments to the method
345  * ExpectedReturnBtypes - Allowed type(s) for the return value
346  */
347 typedef struct acpi_name_info
348 {
349     char                        Name[ACPI_NAME_SIZE];
350     UINT8                       ParamCount;
351     UINT8                       ExpectedBtypes;
352 
353 } ACPI_NAME_INFO;
354 
355 /*
356  * Secondary information structures for ACPI predefined objects that return
357  * package objects. This structure appears as the next entry in the table
358  * after the NAME_INFO structure above.
359  *
360  * The reason for this is to minimize the size of the predefined name table.
361  */
362 
363 /*
364  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
365  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
366  * ACPI_PTYPE2_FIX_VAR
367  */
368 typedef struct acpi_package_info
369 {
370     UINT8                       Type;
371     UINT8                       ObjectType1;
372     UINT8                       Count1;
373     UINT8                       ObjectType2;
374     UINT8                       Count2;
375     UINT8                       Reserved;
376 
377 } ACPI_PACKAGE_INFO;
378 
379 /* Used for ACPI_PTYPE2_FIXED */
380 
381 typedef struct acpi_package_info2
382 {
383     UINT8                       Type;
384     UINT8                       Count;
385     UINT8                       ObjectType[4];
386 
387 } ACPI_PACKAGE_INFO2;
388 
389 /* Used for ACPI_PTYPE1_OPTION */
390 
391 typedef struct acpi_package_info3
392 {
393     UINT8                       Type;
394     UINT8                       Count;
395     UINT8                       ObjectType[2];
396     UINT8                       TailObjectType;
397     UINT8                       Reserved;
398 
399 } ACPI_PACKAGE_INFO3;
400 
401 typedef union acpi_predefined_info
402 {
403     ACPI_NAME_INFO              Info;
404     ACPI_PACKAGE_INFO           RetInfo;
405     ACPI_PACKAGE_INFO2          RetInfo2;
406     ACPI_PACKAGE_INFO3          RetInfo3;
407 
408 } ACPI_PREDEFINED_INFO;
409 
410 
411 /* Data block used during object validation */
412 
413 typedef struct acpi_predefined_data
414 {
415     char                        *Pathname;
416     const ACPI_PREDEFINED_INFO  *Predefined;
417     union acpi_operand_object   *ParentPackage;
418     ACPI_NAMESPACE_NODE         *Node;
419     UINT32                      Flags;
420     UINT8                       NodeFlags;
421 
422 } ACPI_PREDEFINED_DATA;
423 
424 /* Defines for Flags field above */
425 
426 #define ACPI_OBJECT_REPAIRED    1
427 
428 
429 /*
430  * Bitmapped return value types
431  * Note: the actual data types must be contiguous, a loop in nspredef.c
432  * depends on this.
433  */
434 #define ACPI_RTYPE_ANY                  0x00
435 #define ACPI_RTYPE_NONE                 0x01
436 #define ACPI_RTYPE_INTEGER              0x02
437 #define ACPI_RTYPE_STRING               0x04
438 #define ACPI_RTYPE_BUFFER               0x08
439 #define ACPI_RTYPE_PACKAGE              0x10
440 #define ACPI_RTYPE_REFERENCE            0x20
441 #define ACPI_RTYPE_ALL                  0x3F
442 
443 #define ACPI_NUM_RTYPES                 5   /* Number of actual object types */
444 
445 
446 /*****************************************************************************
447  *
448  * Event typedefs and structs
449  *
450  ****************************************************************************/
451 
452 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
453 
454 typedef struct acpi_gpe_handler_info
455 {
456     ACPI_GPE_HANDLER                Address;        /* Address of handler, if any */
457     void                            *Context;       /* Context to be passed to handler */
458     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level (saved) */
459     UINT8                           OriginalFlags;  /* Original (pre-handler) GPE info */
460     BOOLEAN                         OriginallyEnabled; /* True if GPE was originally enabled */
461 
462 } ACPI_GPE_HANDLER_INFO;
463 
464 /*
465  * GPE dispatch info. At any time, the GPE can have at most one type
466  * of dispatch - Method, Handler, or Implicit Notify.
467  */
468 typedef union acpi_gpe_dispatch_info
469 {
470     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level */
471     struct acpi_gpe_handler_info    *Handler;       /* Installed GPE handler */
472     ACPI_NAMESPACE_NODE             *DeviceNode;    /* Parent _PRW device for implicit notify */
473 
474 } ACPI_GPE_DISPATCH_INFO;
475 
476 /*
477  * Information about a GPE, one per each GPE in an array.
478  * NOTE: Important to keep this struct as small as possible.
479  */
480 typedef struct acpi_gpe_event_info
481 {
482     union acpi_gpe_dispatch_info    Dispatch;       /* Either Method or Handler */
483     struct acpi_gpe_register_info   *RegisterInfo;  /* Backpointer to register info */
484     UINT8                           Flags;          /* Misc info about this GPE */
485     UINT8                           GpeNumber;      /* This GPE */
486     UINT8                           RuntimeCount;   /* References to a run GPE */
487 
488 } ACPI_GPE_EVENT_INFO;
489 
490 /* Information about a GPE register pair, one per each status/enable pair in an array */
491 
492 typedef struct acpi_gpe_register_info
493 {
494     ACPI_GENERIC_ADDRESS            StatusAddress;  /* Address of status reg */
495     ACPI_GENERIC_ADDRESS            EnableAddress;  /* Address of enable reg */
496     UINT8                           EnableForWake;  /* GPEs to keep enabled when sleeping */
497     UINT8                           EnableForRun;   /* GPEs to keep enabled when running */
498     UINT8                           BaseGpeNumber;  /* Base GPE number for this register */
499 
500 } ACPI_GPE_REGISTER_INFO;
501 
502 /*
503  * Information about a GPE register block, one per each installed block --
504  * GPE0, GPE1, and one per each installed GPE Block Device.
505  */
506 typedef struct acpi_gpe_block_info
507 {
508     ACPI_NAMESPACE_NODE             *Node;
509     struct acpi_gpe_block_info      *Previous;
510     struct acpi_gpe_block_info      *Next;
511     struct acpi_gpe_xrupt_info      *XruptBlock;    /* Backpointer to interrupt block */
512     ACPI_GPE_REGISTER_INFO          *RegisterInfo;  /* One per GPE register pair */
513     ACPI_GPE_EVENT_INFO             *EventInfo;     /* One for each GPE */
514     ACPI_GENERIC_ADDRESS            BlockAddress;   /* Base address of the block */
515     UINT32                          RegisterCount;  /* Number of register pairs in block */
516     UINT16                          GpeCount;       /* Number of individual GPEs in block */
517     UINT8                           BlockBaseNumber;/* Base GPE number for this block */
518     BOOLEAN                         Initialized;    /* TRUE if this block is initialized */
519 
520 } ACPI_GPE_BLOCK_INFO;
521 
522 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
523 
524 typedef struct acpi_gpe_xrupt_info
525 {
526     struct acpi_gpe_xrupt_info      *Previous;
527     struct acpi_gpe_xrupt_info      *Next;
528     ACPI_GPE_BLOCK_INFO             *GpeBlockListHead;  /* List of GPE blocks for this xrupt */
529     UINT32                          InterruptNumber;    /* System interrupt number */
530 
531 } ACPI_GPE_XRUPT_INFO;
532 
533 typedef struct acpi_gpe_walk_info
534 {
535     ACPI_NAMESPACE_NODE             *GpeDevice;
536     ACPI_GPE_BLOCK_INFO             *GpeBlock;
537     UINT16                          Count;
538     ACPI_OWNER_ID                   OwnerId;
539     BOOLEAN                         ExecuteByOwnerId;
540 
541 } ACPI_GPE_WALK_INFO;
542 
543 typedef struct acpi_gpe_device_info
544 {
545     UINT32                          Index;
546     UINT32                          NextBlockBaseIndex;
547     ACPI_STATUS                     Status;
548     ACPI_NAMESPACE_NODE             *GpeDevice;
549 
550 } ACPI_GPE_DEVICE_INFO;
551 
552 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
553     ACPI_GPE_XRUPT_INFO             *GpeXruptInfo,
554     ACPI_GPE_BLOCK_INFO             *GpeBlock,
555     void                            *Context);
556 
557 
558 /* Information about each particular fixed event */
559 
560 typedef struct acpi_fixed_event_handler
561 {
562     ACPI_EVENT_HANDLER              Handler;        /* Address of handler. */
563     void                            *Context;       /* Context to be passed to handler */
564 
565 } ACPI_FIXED_EVENT_HANDLER;
566 
567 typedef struct acpi_fixed_event_info
568 {
569     UINT8                           StatusRegisterId;
570     UINT8                           EnableRegisterId;
571     UINT16                          StatusBitMask;
572     UINT16                          EnableBitMask;
573 
574 } ACPI_FIXED_EVENT_INFO;
575 
576 /* Information used during field processing */
577 
578 typedef struct acpi_field_info
579 {
580     UINT8                           SkipField;
581     UINT8                           FieldFlag;
582     UINT32                          PkgLength;
583 
584 } ACPI_FIELD_INFO;
585 
586 
587 /*****************************************************************************
588  *
589  * Generic "state" object for stacks
590  *
591  ****************************************************************************/
592 
593 #define ACPI_CONTROL_NORMAL                  0xC0
594 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
595 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
596 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
597 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
598 
599 
600 #define ACPI_STATE_COMMON \
601     void                            *Next; \
602     UINT8                           DescriptorType; /* To differentiate various internal objs */\
603     UINT8                           Flags; \
604     UINT16                          Value; \
605     UINT16                          State;
606 
607     /* There are 2 bytes available here until the next natural alignment boundary */
608 
609 typedef struct acpi_common_state
610 {
611     ACPI_STATE_COMMON
612 } ACPI_COMMON_STATE;
613 
614 
615 /*
616  * Update state - used to traverse complex objects such as packages
617  */
618 typedef struct acpi_update_state
619 {
620     ACPI_STATE_COMMON
621     union acpi_operand_object       *Object;
622 
623 } ACPI_UPDATE_STATE;
624 
625 
626 /*
627  * Pkg state - used to traverse nested package structures
628  */
629 typedef struct acpi_pkg_state
630 {
631     ACPI_STATE_COMMON
632     UINT16                          Index;
633     union acpi_operand_object       *SourceObject;
634     union acpi_operand_object       *DestObject;
635     struct acpi_walk_state          *WalkState;
636     void                            *ThisTargetObj;
637     UINT32                          NumPackages;
638 
639 } ACPI_PKG_STATE;
640 
641 
642 /*
643  * Control state - one per if/else and while constructs.
644  * Allows nesting of these constructs
645  */
646 typedef struct acpi_control_state
647 {
648     ACPI_STATE_COMMON
649     UINT16                          Opcode;
650     union acpi_parse_object         *PredicateOp;
651     UINT8                           *AmlPredicateStart;     /* Start of if/while predicate */
652     UINT8                           *PackageEnd;            /* End of if/while block */
653     UINT32                          LoopCount;              /* While() loop counter */
654 
655 } ACPI_CONTROL_STATE;
656 
657 
658 /*
659  * Scope state - current scope during namespace lookups
660  */
661 typedef struct acpi_scope_state
662 {
663     ACPI_STATE_COMMON
664     ACPI_NAMESPACE_NODE             *Node;
665 
666 } ACPI_SCOPE_STATE;
667 
668 
669 typedef struct acpi_pscope_state
670 {
671     ACPI_STATE_COMMON
672     UINT32                          ArgCount;               /* Number of fixed arguments */
673     union acpi_parse_object         *Op;                    /* Current op being parsed */
674     UINT8                           *ArgEnd;                /* Current argument end */
675     UINT8                           *PkgEnd;                /* Current package end */
676     UINT32                          ArgList;                /* Next argument to parse */
677 
678 } ACPI_PSCOPE_STATE;
679 
680 
681 /*
682  * Thread state - one per thread across multiple walk states.  Multiple walk
683  * states are created when there are nested control methods executing.
684  */
685 typedef struct acpi_thread_state
686 {
687     ACPI_STATE_COMMON
688     UINT8                           CurrentSyncLevel;       /* Mutex Sync (nested acquire) level */
689     struct acpi_walk_state          *WalkStateList;         /* Head of list of WalkStates for this thread */
690     union acpi_operand_object       *AcquiredMutexList;     /* List of all currently acquired mutexes */
691     ACPI_THREAD_ID                  ThreadId;               /* Running thread ID */
692 
693 } ACPI_THREAD_STATE;
694 
695 
696 /*
697  * Result values - used to accumulate the results of nested
698  * AML arguments
699  */
700 typedef struct acpi_result_values
701 {
702     ACPI_STATE_COMMON
703     union acpi_operand_object       *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
704 
705 } ACPI_RESULT_VALUES;
706 
707 
708 typedef
709 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
710     struct acpi_walk_state          *WalkState,
711     union acpi_parse_object         **OutOp);
712 
713 typedef
714 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
715     struct acpi_walk_state          *WalkState);
716 
717 
718 /*
719  * Notify info - used to pass info to the deferred notify
720  * handler/dispatcher.
721  */
722 typedef struct acpi_notify_info
723 {
724     ACPI_STATE_COMMON
725     ACPI_NAMESPACE_NODE             *Node;
726     union acpi_operand_object       *HandlerObj;
727 
728 } ACPI_NOTIFY_INFO;
729 
730 
731 /* Generic state is union of structs above */
732 
733 typedef union acpi_generic_state
734 {
735     ACPI_COMMON_STATE               Common;
736     ACPI_CONTROL_STATE              Control;
737     ACPI_UPDATE_STATE               Update;
738     ACPI_SCOPE_STATE                Scope;
739     ACPI_PSCOPE_STATE               ParseScope;
740     ACPI_PKG_STATE                  Pkg;
741     ACPI_THREAD_STATE               Thread;
742     ACPI_RESULT_VALUES              Results;
743     ACPI_NOTIFY_INFO                Notify;
744 
745 } ACPI_GENERIC_STATE;
746 
747 
748 /*****************************************************************************
749  *
750  * Interpreter typedefs and structs
751  *
752  ****************************************************************************/
753 
754 typedef
755 ACPI_STATUS (*ACPI_EXECUTE_OP) (
756     struct acpi_walk_state          *WalkState);
757 
758 
759 /*****************************************************************************
760  *
761  * Parser typedefs and structs
762  *
763  ****************************************************************************/
764 
765 /*
766  * AML opcode, name, and argument layout
767  */
768 typedef struct acpi_opcode_info
769 {
770 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
771     char                            *Name;          /* Opcode name (disassembler/debug only) */
772 #endif
773     UINT32                          ParseArgs;      /* Grammar/Parse time arguments */
774     UINT32                          RuntimeArgs;    /* Interpret time arguments */
775     UINT16                          Flags;          /* Misc flags */
776     UINT8                           ObjectType;     /* Corresponding internal object type */
777     UINT8                           Class;          /* Opcode class */
778     UINT8                           Type;           /* Opcode type */
779 
780 } ACPI_OPCODE_INFO;
781 
782 /* Structure for Resource Tag information */
783 
784 typedef struct acpi_tag_info
785 {
786     UINT32                          BitOffset;
787     UINT32                          BitLength;
788 
789 } ACPI_TAG_INFO;
790 
791 /* Value associated with the parse object */
792 
793 typedef union acpi_parse_value
794 {
795     UINT64                          Integer;        /* Integer constant (Up to 64 bits) */
796     UINT32                          Size;           /* bytelist or field size */
797     char                            *String;        /* NULL terminated string */
798     UINT8                           *Buffer;        /* buffer or string */
799     char                            *Name;          /* NULL terminated string */
800     union acpi_parse_object         *Arg;           /* arguments and contained ops */
801     ACPI_TAG_INFO                   Tag;            /* Resource descriptor tag info  */
802 
803 } ACPI_PARSE_VALUE;
804 
805 
806 #ifdef ACPI_DISASSEMBLER
807 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
808 #else
809 #define ACPI_DISASM_ONLY_MEMBERS(a)
810 #endif
811 
812 #define ACPI_PARSE_COMMON \
813     union acpi_parse_object         *Parent;        /* Parent op */\
814     UINT8                           DescriptorType; /* To differentiate various internal objs */\
815     UINT8                           Flags;          /* Type of Op */\
816     UINT16                          AmlOpcode;      /* AML opcode */\
817     UINT32                          AmlOffset;      /* Offset of declaration in AML */\
818     union acpi_parse_object         *Next;          /* Next op */\
819     ACPI_NAMESPACE_NODE             *Node;          /* For use by interpreter */\
820     ACPI_PARSE_VALUE                Value;          /* Value or args associated with the opcode */\
821     UINT8                           ArgListLength;  /* Number of elements in the arg list */\
822     ACPI_DISASM_ONLY_MEMBERS (\
823     UINT8                           DisasmFlags;    /* Used during AML disassembly */\
824     UINT8                           DisasmOpcode;   /* Subtype used for disassembly */\
825     char                            AmlOpName[16])  /* Op name (debug only) */
826 
827 
828 #define ACPI_DASM_BUFFER                0x00
829 #define ACPI_DASM_RESOURCE              0x01
830 #define ACPI_DASM_STRING                0x02
831 #define ACPI_DASM_UNICODE               0x03
832 #define ACPI_DASM_EISAID                0x04
833 #define ACPI_DASM_MATCHOP               0x05
834 #define ACPI_DASM_LNOT_PREFIX           0x06
835 #define ACPI_DASM_LNOT_SUFFIX           0x07
836 #define ACPI_DASM_IGNORE                0x08
837 
838 /*
839  * Generic operation (for example:  If, While, Store)
840  */
841 typedef struct acpi_parse_obj_common
842 {
843     ACPI_PARSE_COMMON
844 } ACPI_PARSE_OBJ_COMMON;
845 
846 
847 /*
848  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
849  * and bytelists.
850  */
851 typedef struct acpi_parse_obj_named
852 {
853     ACPI_PARSE_COMMON
854     UINT8                           *Path;
855     UINT8                           *Data;          /* AML body or bytelist data */
856     UINT32                          Length;         /* AML length */
857     UINT32                          Name;           /* 4-byte name or zero if no name */
858 
859 } ACPI_PARSE_OBJ_NAMED;
860 
861 
862 /* This version is used by the iASL compiler only */
863 
864 #define ACPI_MAX_PARSEOP_NAME   20
865 
866 typedef struct acpi_parse_obj_asl
867 {
868     ACPI_PARSE_COMMON
869     union acpi_parse_object         *Child;
870     union acpi_parse_object         *ParentMethod;
871     char                            *Filename;
872     char                            *ExternalName;
873     char                            *Namepath;
874     char                            NameSeg[4];
875     UINT32                          ExtraValue;
876     UINT32                          Column;
877     UINT32                          LineNumber;
878     UINT32                          LogicalLineNumber;
879     UINT32                          LogicalByteOffset;
880     UINT32                          EndLine;
881     UINT32                          EndLogicalLine;
882     UINT32                          AcpiBtype;
883     UINT32                          AmlLength;
884     UINT32                          AmlSubtreeLength;
885     UINT32                          FinalAmlLength;
886     UINT32                          FinalAmlOffset;
887     UINT32                          CompileFlags;
888     UINT16                          ParseOpcode;
889     UINT8                           AmlOpcodeLength;
890     UINT8                           AmlPkgLenBytes;
891     UINT8                           Extra;
892     char                            ParseOpName[ACPI_MAX_PARSEOP_NAME];
893 
894 } ACPI_PARSE_OBJ_ASL;
895 
896 typedef union acpi_parse_object
897 {
898     ACPI_PARSE_OBJ_COMMON           Common;
899     ACPI_PARSE_OBJ_NAMED            Named;
900     ACPI_PARSE_OBJ_ASL              Asl;
901 
902 } ACPI_PARSE_OBJECT;
903 
904 
905 /*
906  * Parse state - one state per parser invocation and each control
907  * method.
908  */
909 typedef struct acpi_parse_state
910 {
911     UINT8                           *AmlStart;      /* First AML byte */
912     UINT8                           *Aml;           /* Next AML byte */
913     UINT8                           *AmlEnd;        /* (last + 1) AML byte */
914     UINT8                           *PkgStart;      /* Current package begin */
915     UINT8                           *PkgEnd;        /* Current package end */
916     union acpi_parse_object         *StartOp;       /* Root of parse tree */
917     struct acpi_namespace_node      *StartNode;
918     union acpi_generic_state        *Scope;         /* Current scope */
919     union acpi_parse_object         *StartScope;
920     UINT32                          AmlSize;
921 
922 } ACPI_PARSE_STATE;
923 
924 
925 /* Parse object flags */
926 
927 #define ACPI_PARSEOP_GENERIC            0x01
928 #define ACPI_PARSEOP_NAMED              0x02
929 #define ACPI_PARSEOP_DEFERRED           0x04
930 #define ACPI_PARSEOP_BYTELIST           0x08
931 #define ACPI_PARSEOP_IN_STACK           0x10
932 #define ACPI_PARSEOP_TARGET             0x20
933 #define ACPI_PARSEOP_IN_CACHE           0x80
934 
935 /* Parse object DisasmFlags */
936 
937 #define ACPI_PARSEOP_IGNORE             0x01
938 #define ACPI_PARSEOP_PARAMLIST          0x02
939 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
940 #define ACPI_PARSEOP_SPECIAL            0x10
941 
942 
943 /*****************************************************************************
944  *
945  * Hardware (ACPI registers) and PNP
946  *
947  ****************************************************************************/
948 
949 typedef struct acpi_bit_register_info
950 {
951     UINT8                           ParentRegister;
952     UINT8                           BitPosition;
953     UINT16                          AccessBitMask;
954 
955 } ACPI_BIT_REGISTER_INFO;
956 
957 
958 /*
959  * Some ACPI registers have bits that must be ignored -- meaning that they
960  * must be preserved.
961  */
962 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
963 
964 /* Write-only bits must be zeroed by software */
965 
966 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
967 
968 /* For control registers, both ignored and reserved bits must be preserved */
969 
970 /*
971  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
972  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
973  * bit position", section 4.7.3.2.1. However, on some machines the OS must
974  * write a one to this bit after resume for the machine to work properly.
975  * To enable this, we no longer attempt to preserve this bit. No machines
976  * are known to fail if the bit is not preserved. (May 2009)
977  */
978 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
979 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
980 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
981          (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
982 
983 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE /* All except bit 0 */
984 
985 /*
986  * Register IDs
987  * These are the full ACPI registers
988  */
989 #define ACPI_REGISTER_PM1_STATUS                0x01
990 #define ACPI_REGISTER_PM1_ENABLE                0x02
991 #define ACPI_REGISTER_PM1_CONTROL               0x03
992 #define ACPI_REGISTER_PM2_CONTROL               0x04
993 #define ACPI_REGISTER_PM_TIMER                  0x05
994 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
995 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
996 
997 
998 /* Masks used to access the BitRegisters */
999 
1000 #define ACPI_BITMASK_TIMER_STATUS               0x0001
1001 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
1002 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
1003 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
1004 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
1005 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
1006 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000    /* ACPI 3.0 */
1007 #define ACPI_BITMASK_WAKE_STATUS                0x8000
1008 
1009 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
1010     ACPI_BITMASK_TIMER_STATUS          | \
1011     ACPI_BITMASK_BUS_MASTER_STATUS     | \
1012     ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
1013     ACPI_BITMASK_POWER_BUTTON_STATUS   | \
1014     ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
1015     ACPI_BITMASK_RT_CLOCK_STATUS       | \
1016     ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
1017     ACPI_BITMASK_WAKE_STATUS)
1018 
1019 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
1020 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
1021 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
1022 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
1023 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
1024 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000    /* ACPI 3.0 */
1025 
1026 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
1027 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
1028 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
1029 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
1030 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
1031 
1032 #define ACPI_BITMASK_ARB_DISABLE                0x0001
1033 
1034 
1035 /* Raw bit position of each BitRegister */
1036 
1037 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
1038 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
1039 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
1040 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
1041 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
1042 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
1043 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
1044 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
1045 
1046 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
1047 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
1048 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
1049 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
1050 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
1051 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
1052 
1053 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
1054 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
1055 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
1056 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
1057 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
1058 
1059 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
1060 
1061 
1062 /* Structs and definitions for _OSI support and I/O port validation */
1063 
1064 #define ACPI_OSI_WIN_2000               0x01
1065 #define ACPI_OSI_WIN_XP                 0x02
1066 #define ACPI_OSI_WIN_XP_SP1             0x03
1067 #define ACPI_OSI_WINSRV_2003            0x04
1068 #define ACPI_OSI_WIN_XP_SP2             0x05
1069 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1070 #define ACPI_OSI_WIN_VISTA              0x07
1071 #define ACPI_OSI_WINSRV_2008            0x08
1072 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1073 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1074 #define ACPI_OSI_WIN_7                  0x0B
1075 
1076 #define ACPI_ALWAYS_ILLEGAL             0x00
1077 
1078 typedef struct acpi_interface_info
1079 {
1080     char                        *Name;
1081     struct acpi_interface_info  *Next;
1082     UINT8                       Flags;
1083     UINT8                       Value;
1084 
1085 } ACPI_INTERFACE_INFO;
1086 
1087 #define ACPI_OSI_INVALID                0x01
1088 #define ACPI_OSI_DYNAMIC                0x02
1089 
1090 typedef struct acpi_port_info
1091 {
1092     char                    *Name;
1093     UINT16                  Start;
1094     UINT16                  End;
1095     UINT8                   OsiDependency;
1096 
1097 } ACPI_PORT_INFO;
1098 
1099 
1100 /*****************************************************************************
1101  *
1102  * Resource descriptors
1103  *
1104  ****************************************************************************/
1105 
1106 /* ResourceType values */
1107 
1108 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
1109 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
1110 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
1111 
1112 /* Resource descriptor types and masks */
1113 
1114 #define ACPI_RESOURCE_NAME_LARGE                0x80
1115 #define ACPI_RESOURCE_NAME_SMALL                0x00
1116 
1117 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78 /* Bits 6:3 contain the type */
1118 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07 /* Bits 2:0 contain the length */
1119 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F /* Bits 6:0 contain the type */
1120 
1121 
1122 /*
1123  * Small resource descriptor "names" as defined by the ACPI specification.
1124  * Note: Bits 2:0 are used for the descriptor length
1125  */
1126 #define ACPI_RESOURCE_NAME_IRQ                  0x20
1127 #define ACPI_RESOURCE_NAME_DMA                  0x28
1128 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
1129 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
1130 #define ACPI_RESOURCE_NAME_IO                   0x40
1131 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
1132 #define ACPI_RESOURCE_NAME_FIXED_DMA            0x50
1133 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
1134 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
1135 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
1136 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
1137 #define ACPI_RESOURCE_NAME_END_TAG              0x78
1138 
1139 /*
1140  * Large resource descriptor "names" as defined by the ACPI specification.
1141  * Note: includes the Large Descriptor bit in bit[7]
1142  */
1143 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
1144 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
1145 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
1146 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
1147 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1148 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1149 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1150 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1151 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1152 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1153 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1154 #define ACPI_RESOURCE_NAME_GPIO                 0x8C
1155 #define ACPI_RESOURCE_NAME_SERIAL_BUS           0x8E
1156 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8E
1157 
1158 
1159 /*****************************************************************************
1160  *
1161  * Miscellaneous
1162  *
1163  ****************************************************************************/
1164 
1165 #define ACPI_ASCII_ZERO                 0x30
1166 
1167 
1168 /*****************************************************************************
1169  *
1170  * Disassembler
1171  *
1172  ****************************************************************************/
1173 
1174 typedef struct acpi_external_list
1175 {
1176     char                        *Path;
1177     char                        *InternalPath;
1178     struct acpi_external_list   *Next;
1179     UINT32                      Value;
1180     UINT16                      Length;
1181     UINT8                       Type;
1182     UINT8                       Flags;
1183 
1184 } ACPI_EXTERNAL_LIST;
1185 
1186 /* Values for Flags field above */
1187 
1188 #define ACPI_IPATH_ALLOCATED    0x01
1189 
1190 
1191 typedef struct acpi_external_file
1192 {
1193     char                        *Path;
1194     struct acpi_external_file   *Next;
1195 
1196 } ACPI_EXTERNAL_FILE;
1197 
1198 
1199 /*****************************************************************************
1200  *
1201  * Debugger
1202  *
1203  ****************************************************************************/
1204 
1205 typedef struct acpi_db_method_info
1206 {
1207     ACPI_HANDLE                     MainThreadGate;
1208     ACPI_HANDLE                     ThreadCompleteGate;
1209     ACPI_HANDLE                     InfoGate;
1210     ACPI_THREAD_ID                  *Threads;
1211     UINT32                          NumThreads;
1212     UINT32                          NumCreated;
1213     UINT32                          NumCompleted;
1214 
1215     char                            *Name;
1216     UINT32                          Flags;
1217     UINT32                          NumLoops;
1218     char                            Pathname[128];
1219     char                            **Args;
1220     ACPI_OBJECT_TYPE                *Types;
1221 
1222     /*
1223      * Arguments to be passed to method for the command
1224      * Threads -
1225      *   the Number of threads, ID of current thread and
1226      *   Index of current thread inside all them created.
1227      */
1228     char                            InitArgs;
1229     ACPI_OBJECT_TYPE                ArgTypes[4];
1230     char                            *Arguments[4];
1231     char                            NumThreadsStr[11];
1232     char                            IdOfThreadStr[11];
1233     char                            IndexOfThreadStr[11];
1234 
1235 } ACPI_DB_METHOD_INFO;
1236 
1237 typedef struct acpi_integrity_info
1238 {
1239     UINT32                          Nodes;
1240     UINT32                          Objects;
1241 
1242 } ACPI_INTEGRITY_INFO;
1243 
1244 
1245 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1246 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1247 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1248 
1249 
1250 /*****************************************************************************
1251  *
1252  * Debug
1253  *
1254  ****************************************************************************/
1255 
1256 /* Entry for a memory allocation (debug only) */
1257 
1258 #define ACPI_MEM_MALLOC                 0
1259 #define ACPI_MEM_CALLOC                 1
1260 #define ACPI_MAX_MODULE_NAME            16
1261 
1262 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1263     struct acpi_debug_mem_block     *Previous; \
1264     struct acpi_debug_mem_block     *Next; \
1265     UINT32                          Size; \
1266     UINT32                          Component; \
1267     UINT32                          Line; \
1268     char                            Module[ACPI_MAX_MODULE_NAME]; \
1269     UINT8                           AllocType;
1270 
1271 typedef struct acpi_debug_mem_header
1272 {
1273     ACPI_COMMON_DEBUG_MEM_HEADER
1274 
1275 } ACPI_DEBUG_MEM_HEADER;
1276 
1277 typedef struct acpi_debug_mem_block
1278 {
1279     ACPI_COMMON_DEBUG_MEM_HEADER
1280     UINT64                          UserSpace;
1281 
1282 } ACPI_DEBUG_MEM_BLOCK;
1283 
1284 
1285 #define ACPI_MEM_LIST_GLOBAL            0
1286 #define ACPI_MEM_LIST_NSNODE            1
1287 #define ACPI_MEM_LIST_MAX               1
1288 #define ACPI_NUM_MEM_LISTS              2
1289 
1290 
1291 #endif /* __ACLOCAL_H__ */
1292