1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #ifndef __ACLOCAL_H__
117 #define __ACLOCAL_H__
120 /* acpisrc:StructDefs -- for acpisrc conversion */
122 #define ACPI_SERIALIZED 0xFF
124 typedef UINT32 ACPI_MUTEX_HANDLE
;
125 #define ACPI_GLOBAL_LOCK (ACPI_SEMAPHORE) (-1)
127 /* Total number of aml opcodes defined */
129 #define AML_NUM_OPCODES 0x7F
132 /* Forward declarations */
134 struct acpi_walk_state
;
135 struct acpi_obj_mutex
;
136 union acpi_parse_object
;
139 /*****************************************************************************
141 * Mutex typedefs and structs
143 ****************************************************************************/
147 * Predefined handles for the mutex objects used within the subsystem
148 * All mutex objects are automatically created by AcpiUtMutexInitialize.
150 * The acquire/release ordering protocol is implied via this list. Mutexes
151 * with a lower value must be acquired before mutexes with a higher value.
153 * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames
156 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
157 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */
158 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
159 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
160 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
161 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
162 #define ACPI_MTX_DEBUG_CMD_COMPLETE 6 /* AML debugger */
163 #define ACPI_MTX_DEBUG_CMD_READY 7 /* AML debugger */
165 #define ACPI_MAX_MUTEX 7
166 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
169 /* Lock structure for reader/writer interfaces */
171 typedef struct acpi_rw_lock
173 ACPI_MUTEX WriterMutex
;
174 ACPI_MUTEX ReaderMutex
;
181 * Predefined handles for spinlocks used within the subsystem.
182 * These spinlocks are created by AcpiUtMutexInitialize
184 #define ACPI_LOCK_GPES 0
185 #define ACPI_LOCK_HARDWARE 1
187 #define ACPI_MAX_LOCK 1
188 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
191 /* This Thread ID means that the mutex is not in use (unlocked) */
193 #define ACPI_MUTEX_NOT_ACQUIRED (ACPI_THREAD_ID) -1
195 /* Table for the global mutexes */
197 typedef struct acpi_mutex_info
201 ACPI_THREAD_ID ThreadId
;
206 /* Lock flag parameter for various interfaces */
208 #define ACPI_MTX_DO_NOT_LOCK 0
209 #define ACPI_MTX_LOCK 1
212 /* Field access granularities */
214 #define ACPI_FIELD_BYTE_GRANULARITY 1
215 #define ACPI_FIELD_WORD_GRANULARITY 2
216 #define ACPI_FIELD_DWORD_GRANULARITY 4
217 #define ACPI_FIELD_QWORD_GRANULARITY 8
220 #define ACPI_ENTRY_NOT_FOUND NULL
223 /*****************************************************************************
225 * Namespace typedefs and structs
227 ****************************************************************************/
229 /* Operational modes of the AML interpreter/scanner */
233 ACPI_IMODE_LOAD_PASS1
= 0x01,
234 ACPI_IMODE_LOAD_PASS2
= 0x02,
235 ACPI_IMODE_EXECUTE
= 0x03
237 } ACPI_INTERPRETER_MODE
;
241 * The Namespace Node describes a named object that appears in the AML.
242 * DescriptorType is used to differentiate between internal descriptors.
244 * The node is optimized for both 32-bit and 64-bit platforms:
245 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
247 * Note: The DescriptorType and Type fields must appear in the identical
248 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
251 typedef struct acpi_namespace_node
253 union acpi_operand_object
*Object
; /* Interpreter object */
254 UINT8 DescriptorType
; /* Differentiate object descriptor types */
255 UINT8 Type
; /* ACPI Type associated with this name */
256 UINT8 Flags
; /* Miscellaneous flags */
257 ACPI_OWNER_ID OwnerId
; /* Node creator */
258 ACPI_NAME_UNION Name
; /* ACPI Name, always 4 chars per ACPI spec */
259 struct acpi_namespace_node
*Parent
; /* Parent node */
260 struct acpi_namespace_node
*Child
; /* First child */
261 struct acpi_namespace_node
*Peer
; /* First peer */
264 * The following fields are used by the ASL compiler and disassembler only
266 #ifdef ACPI_LARGE_NAMESPACE_NODE
267 union acpi_parse_object
*Op
;
272 } ACPI_NAMESPACE_NODE
;
275 /* Namespace Node flags */
277 #define ANOBJ_RESERVED 0x01 /* Available for use */
278 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
279 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
280 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
281 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
282 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
283 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (InstallMethod) */
285 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
286 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
287 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
288 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
291 /* Internal ACPI table management - master table list */
293 typedef struct acpi_table_list
295 ACPI_TABLE_DESC
*Tables
; /* Table descriptor array */
296 UINT32 CurrentTableCount
; /* Tables currently in the array */
297 UINT32 MaxTableCount
; /* Max tables array will hold */
302 /* Flags for above */
304 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
305 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
306 #define ACPI_ROOT_ALLOW_RESIZE (2)
309 /* Predefined (fixed) table indexes */
311 #define ACPI_TABLE_INDEX_DSDT (0)
312 #define ACPI_TABLE_INDEX_FACS (1)
315 typedef struct acpi_find_context
324 typedef struct acpi_ns_search_data
326 ACPI_NAMESPACE_NODE
*Node
;
328 } ACPI_NS_SEARCH_DATA
;
331 /* Object types used during package copies */
333 #define ACPI_COPY_TYPE_SIMPLE 0
334 #define ACPI_COPY_TYPE_PACKAGE 1
337 /* Info structure used to convert external<->internal namestrings */
339 typedef struct acpi_namestring_info
341 const char *ExternalName
;
342 const char *NextExternalChar
;
347 BOOLEAN FullyQualified
;
349 } ACPI_NAMESTRING_INFO
;
352 /* Field creation info */
354 typedef struct acpi_create_field_info
356 ACPI_NAMESPACE_NODE
*RegionNode
;
357 ACPI_NAMESPACE_NODE
*FieldNode
;
358 ACPI_NAMESPACE_NODE
*RegisterNode
;
359 ACPI_NAMESPACE_NODE
*DataRegisterNode
;
361 UINT32 FieldBitPosition
;
362 UINT32 FieldBitLength
;
367 } ACPI_CREATE_FIELD_INFO
;
371 ACPI_STATUS (*ACPI_INTERNAL_METHOD
) (
372 struct acpi_walk_state
*WalkState
);
376 * Bitmapped ACPI types. Used internally only
378 #define ACPI_BTYPE_ANY 0x00000000
379 #define ACPI_BTYPE_INTEGER 0x00000001
380 #define ACPI_BTYPE_STRING 0x00000002
381 #define ACPI_BTYPE_BUFFER 0x00000004
382 #define ACPI_BTYPE_PACKAGE 0x00000008
383 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
384 #define ACPI_BTYPE_DEVICE 0x00000020
385 #define ACPI_BTYPE_EVENT 0x00000040
386 #define ACPI_BTYPE_METHOD 0x00000080
387 #define ACPI_BTYPE_MUTEX 0x00000100
388 #define ACPI_BTYPE_REGION 0x00000200
389 #define ACPI_BTYPE_POWER 0x00000400
390 #define ACPI_BTYPE_PROCESSOR 0x00000800
391 #define ACPI_BTYPE_THERMAL 0x00001000
392 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
393 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
394 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
395 #define ACPI_BTYPE_REFERENCE 0x00010000
396 #define ACPI_BTYPE_RESOURCE 0x00020000
398 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
400 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
401 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
402 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
403 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
404 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
408 * Information structure for ACPI predefined names.
409 * Each entry in the table contains the following items:
411 * Name - The ACPI reserved name
412 * ParamCount - Number of arguments to the method
413 * ExpectedReturnBtypes - Allowed type(s) for the return value
415 typedef struct acpi_name_info
417 char Name
[ACPI_NAME_SIZE
];
419 UINT8 ExpectedBtypes
;
424 * Secondary information structures for ACPI predefined objects that return
425 * package objects. This structure appears as the next entry in the table
426 * after the NAME_INFO structure above.
428 * The reason for this is to minimize the size of the predefined name table.
432 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
433 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
435 typedef struct acpi_package_info
446 /* Used for ACPI_PTYPE2_FIXED */
448 typedef struct acpi_package_info2
454 } ACPI_PACKAGE_INFO2
;
456 /* Used for ACPI_PTYPE1_OPTION */
458 typedef struct acpi_package_info3
463 UINT8 TailObjectType
;
466 } ACPI_PACKAGE_INFO3
;
468 typedef union acpi_predefined_info
471 ACPI_PACKAGE_INFO RetInfo
;
472 ACPI_PACKAGE_INFO2 RetInfo2
;
473 ACPI_PACKAGE_INFO3 RetInfo3
;
475 } ACPI_PREDEFINED_INFO
;
478 /* Data block used during object validation */
480 typedef struct acpi_predefined_data
483 const ACPI_PREDEFINED_INFO
*Predefined
;
484 union acpi_operand_object
*ParentPackage
;
485 ACPI_NAMESPACE_NODE
*Node
;
489 } ACPI_PREDEFINED_DATA
;
491 /* Defines for Flags field above */
493 #define ACPI_OBJECT_REPAIRED 1
497 * Bitmapped return value types
498 * Note: the actual data types must be contiguous, a loop in nspredef.c
501 #define ACPI_RTYPE_ANY 0x00
502 #define ACPI_RTYPE_NONE 0x01
503 #define ACPI_RTYPE_INTEGER 0x02
504 #define ACPI_RTYPE_STRING 0x04
505 #define ACPI_RTYPE_BUFFER 0x08
506 #define ACPI_RTYPE_PACKAGE 0x10
507 #define ACPI_RTYPE_REFERENCE 0x20
508 #define ACPI_RTYPE_ALL 0x3F
510 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
513 /*****************************************************************************
515 * Event typedefs and structs
517 ****************************************************************************/
519 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
521 typedef struct acpi_gpe_handler_info
523 ACPI_GPE_HANDLER Address
; /* Address of handler, if any */
524 void *Context
; /* Context to be passed to handler */
525 ACPI_NAMESPACE_NODE
*MethodNode
; /* Method node for this GPE level (saved) */
526 UINT8 OriginalFlags
; /* Original (pre-handler) GPE info */
527 BOOLEAN OriginallyEnabled
; /* True if GPE was originally enabled */
529 } ACPI_GPE_HANDLER_INFO
;
532 * GPE dispatch info. At any time, the GPE can have at most one type
533 * of dispatch - Method, Handler, or Implicit Notify.
535 typedef union acpi_gpe_dispatch_info
537 ACPI_NAMESPACE_NODE
*MethodNode
; /* Method node for this GPE level */
538 struct acpi_gpe_handler_info
*Handler
; /* Installed GPE handler */
539 ACPI_NAMESPACE_NODE
*DeviceNode
; /* Parent _PRW device for implicit notify */
541 } ACPI_GPE_DISPATCH_INFO
;
544 * Information about a GPE, one per each GPE in an array.
545 * NOTE: Important to keep this struct as small as possible.
547 typedef struct acpi_gpe_event_info
549 union acpi_gpe_dispatch_info Dispatch
; /* Either Method or Handler */
550 struct acpi_gpe_register_info
*RegisterInfo
; /* Backpointer to register info */
551 UINT8 Flags
; /* Misc info about this GPE */
552 UINT8 GpeNumber
; /* This GPE */
553 UINT8 RuntimeCount
; /* References to a run GPE */
555 } ACPI_GPE_EVENT_INFO
;
557 /* Information about a GPE register pair, one per each status/enable pair in an array */
559 typedef struct acpi_gpe_register_info
561 ACPI_GENERIC_ADDRESS StatusAddress
; /* Address of status reg */
562 ACPI_GENERIC_ADDRESS EnableAddress
; /* Address of enable reg */
563 UINT8 EnableForWake
; /* GPEs to keep enabled when sleeping */
564 UINT8 EnableForRun
; /* GPEs to keep enabled when running */
565 UINT8 BaseGpeNumber
; /* Base GPE number for this register */
567 } ACPI_GPE_REGISTER_INFO
;
570 * Information about a GPE register block, one per each installed block --
571 * GPE0, GPE1, and one per each installed GPE Block Device.
573 typedef struct acpi_gpe_block_info
575 ACPI_NAMESPACE_NODE
*Node
;
576 struct acpi_gpe_block_info
*Previous
;
577 struct acpi_gpe_block_info
*Next
;
578 struct acpi_gpe_xrupt_info
*XruptBlock
; /* Backpointer to interrupt block */
579 ACPI_GPE_REGISTER_INFO
*RegisterInfo
; /* One per GPE register pair */
580 ACPI_GPE_EVENT_INFO
*EventInfo
; /* One for each GPE */
581 ACPI_GENERIC_ADDRESS BlockAddress
; /* Base address of the block */
582 UINT32 RegisterCount
; /* Number of register pairs in block */
583 UINT16 GpeCount
; /* Number of individual GPEs in block */
584 UINT8 BlockBaseNumber
;/* Base GPE number for this block */
585 BOOLEAN Initialized
; /* TRUE if this block is initialized */
587 } ACPI_GPE_BLOCK_INFO
;
589 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
591 typedef struct acpi_gpe_xrupt_info
593 struct acpi_gpe_xrupt_info
*Previous
;
594 struct acpi_gpe_xrupt_info
*Next
;
595 ACPI_GPE_BLOCK_INFO
*GpeBlockListHead
; /* List of GPE blocks for this xrupt */
596 UINT32 InterruptNumber
; /* System interrupt number */
598 } ACPI_GPE_XRUPT_INFO
;
600 typedef struct acpi_gpe_walk_info
602 ACPI_NAMESPACE_NODE
*GpeDevice
;
603 ACPI_GPE_BLOCK_INFO
*GpeBlock
;
605 ACPI_OWNER_ID OwnerId
;
606 BOOLEAN ExecuteByOwnerId
;
608 } ACPI_GPE_WALK_INFO
;
610 typedef struct acpi_gpe_device_info
613 UINT32 NextBlockBaseIndex
;
615 ACPI_NAMESPACE_NODE
*GpeDevice
;
617 } ACPI_GPE_DEVICE_INFO
;
619 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK
) (
620 ACPI_GPE_XRUPT_INFO
*GpeXruptInfo
,
621 ACPI_GPE_BLOCK_INFO
*GpeBlock
,
625 /* Information about each particular fixed event */
627 typedef struct acpi_fixed_event_handler
629 ACPI_EVENT_HANDLER Handler
; /* Address of handler. */
630 void *Context
; /* Context to be passed to handler */
632 } ACPI_FIXED_EVENT_HANDLER
;
634 typedef struct acpi_fixed_event_info
636 UINT8 StatusRegisterId
;
637 UINT8 EnableRegisterId
;
638 UINT16 StatusBitMask
;
639 UINT16 EnableBitMask
;
641 } ACPI_FIXED_EVENT_INFO
;
643 /* Information used during field processing */
645 typedef struct acpi_field_info
654 /*****************************************************************************
656 * Generic "state" object for stacks
658 ****************************************************************************/
660 #define ACPI_CONTROL_NORMAL 0xC0
661 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
662 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
663 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
664 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
667 #define ACPI_STATE_COMMON \
669 UINT8 DescriptorType; /* To differentiate various internal objs */\
674 /* There are 2 bytes available here until the next natural alignment boundary */
676 typedef struct acpi_common_state
683 * Update state - used to traverse complex objects such as packages
685 typedef struct acpi_update_state
688 union acpi_operand_object
*Object
;
694 * Pkg state - used to traverse nested package structures
696 typedef struct acpi_pkg_state
700 union acpi_operand_object
*SourceObject
;
701 union acpi_operand_object
*DestObject
;
702 struct acpi_walk_state
*WalkState
;
710 * Control state - one per if/else and while constructs.
711 * Allows nesting of these constructs
713 typedef struct acpi_control_state
717 union acpi_parse_object
*PredicateOp
;
718 UINT8
*AmlPredicateStart
; /* Start of if/while predicate */
719 UINT8
*PackageEnd
; /* End of if/while block */
720 UINT32 LoopCount
; /* While() loop counter */
722 } ACPI_CONTROL_STATE
;
726 * Scope state - current scope during namespace lookups
728 typedef struct acpi_scope_state
731 ACPI_NAMESPACE_NODE
*Node
;
736 typedef struct acpi_pscope_state
739 UINT32 ArgCount
; /* Number of fixed arguments */
740 union acpi_parse_object
*Op
; /* Current op being parsed */
741 UINT8
*ArgEnd
; /* Current argument end */
742 UINT8
*PkgEnd
; /* Current package end */
743 UINT32 ArgList
; /* Next argument to parse */
749 * Thread state - one per thread across multiple walk states. Multiple walk
750 * states are created when there are nested control methods executing.
752 typedef struct acpi_thread_state
755 UINT8 CurrentSyncLevel
; /* Mutex Sync (nested acquire) level */
756 struct acpi_walk_state
*WalkStateList
; /* Head of list of WalkStates for this thread */
757 union acpi_operand_object
*AcquiredMutexList
; /* List of all currently acquired mutexes */
758 ACPI_THREAD_ID ThreadId
; /* Running thread ID */
764 * Result values - used to accumulate the results of nested
767 typedef struct acpi_result_values
770 union acpi_operand_object
*ObjDesc
[ACPI_RESULTS_FRAME_OBJ_NUM
];
772 } ACPI_RESULT_VALUES
;
776 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS
) (
777 struct acpi_walk_state
*WalkState
,
778 union acpi_parse_object
**OutOp
);
781 ACPI_STATUS (*ACPI_PARSE_UPWARDS
) (
782 struct acpi_walk_state
*WalkState
);
786 * Notify info - used to pass info to the deferred notify
787 * handler/dispatcher.
789 typedef struct acpi_notify_info
792 ACPI_NAMESPACE_NODE
*Node
;
793 union acpi_operand_object
*HandlerObj
;
798 /* Generic state is union of structs above */
800 typedef union acpi_generic_state
802 ACPI_COMMON_STATE Common
;
803 ACPI_CONTROL_STATE Control
;
804 ACPI_UPDATE_STATE Update
;
805 ACPI_SCOPE_STATE Scope
;
806 ACPI_PSCOPE_STATE ParseScope
;
808 ACPI_THREAD_STATE Thread
;
809 ACPI_RESULT_VALUES Results
;
810 ACPI_NOTIFY_INFO Notify
;
812 } ACPI_GENERIC_STATE
;
815 /*****************************************************************************
817 * Interpreter typedefs and structs
819 ****************************************************************************/
822 ACPI_STATUS (*ACPI_EXECUTE_OP
) (
823 struct acpi_walk_state
*WalkState
);
826 /*****************************************************************************
828 * Parser typedefs and structs
830 ****************************************************************************/
833 * AML opcode, name, and argument layout
835 typedef struct acpi_opcode_info
837 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
838 char *Name
; /* Opcode name (disassembler/debug only) */
840 UINT32 ParseArgs
; /* Grammar/Parse time arguments */
841 UINT32 RuntimeArgs
; /* Interpret time arguments */
842 UINT16 Flags
; /* Misc flags */
843 UINT8 ObjectType
; /* Corresponding internal object type */
844 UINT8 Class
; /* Opcode class */
845 UINT8 Type
; /* Opcode type */
849 /* Structure for Resource Tag information */
851 typedef struct acpi_tag_info
858 /* Value associated with the parse object */
860 typedef union acpi_parse_value
862 UINT64 Integer
; /* Integer constant (Up to 64 bits) */
863 UINT32 Size
; /* bytelist or field size */
864 char *String
; /* NULL terminated string */
865 UINT8
*Buffer
; /* buffer or string */
866 char *Name
; /* NULL terminated string */
867 union acpi_parse_object
*Arg
; /* arguments and contained ops */
868 ACPI_TAG_INFO Tag
; /* Resource descriptor tag info */
873 #ifdef ACPI_DISASSEMBLER
874 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
876 #define ACPI_DISASM_ONLY_MEMBERS(a)
879 #define ACPI_PARSE_COMMON \
880 union acpi_parse_object *Parent; /* Parent op */\
881 UINT8 DescriptorType; /* To differentiate various internal objs */\
882 UINT8 Flags; /* Type of Op */\
883 UINT16 AmlOpcode; /* AML opcode */\
884 UINT32 AmlOffset; /* Offset of declaration in AML */\
885 union acpi_parse_object *Next; /* Next op */\
886 ACPI_NAMESPACE_NODE *Node; /* For use by interpreter */\
887 ACPI_PARSE_VALUE Value; /* Value or args associated with the opcode */\
888 UINT8 ArgListLength; /* Number of elements in the arg list */\
889 ACPI_DISASM_ONLY_MEMBERS (\
890 UINT8 DisasmFlags; /* Used during AML disassembly */\
891 UINT8 DisasmOpcode; /* Subtype used for disassembly */\
892 char AmlOpName[16]) /* Op name (debug only) */
895 #define ACPI_DASM_BUFFER 0x00
896 #define ACPI_DASM_RESOURCE 0x01
897 #define ACPI_DASM_STRING 0x02
898 #define ACPI_DASM_UNICODE 0x03
899 #define ACPI_DASM_EISAID 0x04
900 #define ACPI_DASM_MATCHOP 0x05
901 #define ACPI_DASM_LNOT_PREFIX 0x06
902 #define ACPI_DASM_LNOT_SUFFIX 0x07
903 #define ACPI_DASM_IGNORE 0x08
906 * Generic operation (for example: If, While, Store)
908 typedef struct acpi_parse_obj_common
911 } ACPI_PARSE_OBJ_COMMON
;
915 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
918 typedef struct acpi_parse_obj_named
922 UINT8
*Data
; /* AML body or bytelist data */
923 UINT32 Length
; /* AML length */
924 UINT32 Name
; /* 4-byte name or zero if no name */
926 } ACPI_PARSE_OBJ_NAMED
;
929 /* This version is used by the iASL compiler only */
931 #define ACPI_MAX_PARSEOP_NAME 20
933 typedef struct acpi_parse_obj_asl
936 union acpi_parse_object
*Child
;
937 union acpi_parse_object
*ParentMethod
;
945 UINT32 LogicalLineNumber
;
946 UINT32 LogicalByteOffset
;
948 UINT32 EndLogicalLine
;
951 UINT32 AmlSubtreeLength
;
952 UINT32 FinalAmlLength
;
953 UINT32 FinalAmlOffset
;
956 UINT8 AmlOpcodeLength
;
957 UINT8 AmlPkgLenBytes
;
959 char ParseOpName
[ACPI_MAX_PARSEOP_NAME
];
961 } ACPI_PARSE_OBJ_ASL
;
963 typedef union acpi_parse_object
965 ACPI_PARSE_OBJ_COMMON Common
;
966 ACPI_PARSE_OBJ_NAMED Named
;
967 ACPI_PARSE_OBJ_ASL Asl
;
973 * Parse state - one state per parser invocation and each control
976 typedef struct acpi_parse_state
978 UINT8
*AmlStart
; /* First AML byte */
979 UINT8
*Aml
; /* Next AML byte */
980 UINT8
*AmlEnd
; /* (last + 1) AML byte */
981 UINT8
*PkgStart
; /* Current package begin */
982 UINT8
*PkgEnd
; /* Current package end */
983 union acpi_parse_object
*StartOp
; /* Root of parse tree */
984 struct acpi_namespace_node
*StartNode
;
985 union acpi_generic_state
*Scope
; /* Current scope */
986 union acpi_parse_object
*StartScope
;
992 /* Parse object flags */
994 #define ACPI_PARSEOP_GENERIC 0x01
995 #define ACPI_PARSEOP_NAMED 0x02
996 #define ACPI_PARSEOP_DEFERRED 0x04
997 #define ACPI_PARSEOP_BYTELIST 0x08
998 #define ACPI_PARSEOP_IN_STACK 0x10
999 #define ACPI_PARSEOP_TARGET 0x20
1000 #define ACPI_PARSEOP_IN_CACHE 0x80
1002 /* Parse object DisasmFlags */
1004 #define ACPI_PARSEOP_IGNORE 0x01
1005 #define ACPI_PARSEOP_PARAMLIST 0x02
1006 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
1007 #define ACPI_PARSEOP_SPECIAL 0x10
1010 /*****************************************************************************
1012 * Hardware (ACPI registers) and PNP
1014 ****************************************************************************/
1016 typedef struct acpi_bit_register_info
1018 UINT8 ParentRegister
;
1020 UINT16 AccessBitMask
;
1022 } ACPI_BIT_REGISTER_INFO
;
1026 * Some ACPI registers have bits that must be ignored -- meaning that they
1027 * must be preserved.
1029 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
1031 /* Write-only bits must be zeroed by software */
1033 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
1035 /* For control registers, both ignored and reserved bits must be preserved */
1038 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1039 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1040 * bit position", section 4.7.3.2.1. However, on some machines the OS must
1041 * write a one to this bit after resume for the machine to work properly.
1042 * To enable this, we no longer attempt to preserve this bit. No machines
1043 * are known to fail if the bit is not preserved. (May 2009)
1045 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
1046 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
1047 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1048 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1050 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
1054 * These are the full ACPI registers
1056 #define ACPI_REGISTER_PM1_STATUS 0x01
1057 #define ACPI_REGISTER_PM1_ENABLE 0x02
1058 #define ACPI_REGISTER_PM1_CONTROL 0x03
1059 #define ACPI_REGISTER_PM2_CONTROL 0x04
1060 #define ACPI_REGISTER_PM_TIMER 0x05
1061 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
1062 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
1065 /* Masks used to access the BitRegisters */
1067 #define ACPI_BITMASK_TIMER_STATUS 0x0001
1068 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
1069 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
1070 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
1071 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
1072 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
1073 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
1074 #define ACPI_BITMASK_WAKE_STATUS 0x8000
1076 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
1077 ACPI_BITMASK_TIMER_STATUS | \
1078 ACPI_BITMASK_BUS_MASTER_STATUS | \
1079 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
1080 ACPI_BITMASK_POWER_BUTTON_STATUS | \
1081 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
1082 ACPI_BITMASK_RT_CLOCK_STATUS | \
1083 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
1084 ACPI_BITMASK_WAKE_STATUS)
1086 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
1087 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
1088 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
1089 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
1090 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
1091 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
1093 #define ACPI_BITMASK_SCI_ENABLE 0x0001
1094 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
1095 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
1096 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
1097 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
1099 #define ACPI_BITMASK_ARB_DISABLE 0x0001
1102 /* Raw bit position of each BitRegister */
1104 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
1105 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
1106 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
1107 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
1108 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
1109 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
1110 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
1111 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
1113 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
1114 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
1115 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
1116 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
1117 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
1118 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
1120 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
1121 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
1122 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
1123 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
1124 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
1126 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
1129 /* Structs and definitions for _OSI support and I/O port validation */
1131 #define ACPI_OSI_WIN_2000 0x01
1132 #define ACPI_OSI_WIN_XP 0x02
1133 #define ACPI_OSI_WIN_XP_SP1 0x03
1134 #define ACPI_OSI_WINSRV_2003 0x04
1135 #define ACPI_OSI_WIN_XP_SP2 0x05
1136 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1137 #define ACPI_OSI_WIN_VISTA 0x07
1138 #define ACPI_OSI_WINSRV_2008 0x08
1139 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1140 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1141 #define ACPI_OSI_WIN_7 0x0B
1143 #define ACPI_ALWAYS_ILLEGAL 0x00
1145 typedef struct acpi_interface_info
1148 struct acpi_interface_info
*Next
;
1152 } ACPI_INTERFACE_INFO
;
1154 #define ACPI_OSI_INVALID 0x01
1155 #define ACPI_OSI_DYNAMIC 0x02
1157 typedef struct acpi_port_info
1162 UINT8 OsiDependency
;
1167 /*****************************************************************************
1169 * Resource descriptors
1171 ****************************************************************************/
1173 /* ResourceType values */
1175 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1176 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1177 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1179 /* Resource descriptor types and masks */
1181 #define ACPI_RESOURCE_NAME_LARGE 0x80
1182 #define ACPI_RESOURCE_NAME_SMALL 0x00
1184 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1185 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1186 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1190 * Small resource descriptor "names" as defined by the ACPI specification.
1191 * Note: Bits 2:0 are used for the descriptor length
1193 #define ACPI_RESOURCE_NAME_IRQ 0x20
1194 #define ACPI_RESOURCE_NAME_DMA 0x28
1195 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1196 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1197 #define ACPI_RESOURCE_NAME_IO 0x40
1198 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1199 #define ACPI_RESOURCE_NAME_RESERVED_S1 0x50
1200 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1201 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1202 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1203 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1204 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1207 * Large resource descriptor "names" as defined by the ACPI specification.
1208 * Note: includes the Large Descriptor bit in bit[7]
1210 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1211 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1212 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1213 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1214 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1215 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1216 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1217 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1218 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1219 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1220 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1221 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B
1224 /*****************************************************************************
1228 ****************************************************************************/
1230 #define ACPI_ASCII_ZERO 0x30
1233 /*****************************************************************************
1237 ****************************************************************************/
1239 typedef struct acpi_external_list
1243 struct acpi_external_list
*Next
;
1249 } ACPI_EXTERNAL_LIST
;
1251 /* Values for Flags field above */
1253 #define ACPI_IPATH_ALLOCATED 0x01
1256 typedef struct acpi_external_file
1259 struct acpi_external_file
*Next
;
1261 } ACPI_EXTERNAL_FILE
;
1264 /*****************************************************************************
1268 ****************************************************************************/
1270 typedef struct acpi_db_method_info
1272 ACPI_HANDLE MainThreadGate
;
1273 ACPI_HANDLE ThreadCompleteGate
;
1274 ACPI_HANDLE InfoGate
;
1275 ACPI_THREAD_ID
*Threads
;
1278 UINT32 NumCompleted
;
1285 ACPI_OBJECT_TYPE
*Types
;
1288 * Arguments to be passed to method for the command
1290 * the Number of threads, ID of current thread and
1291 * Index of current thread inside all them created.
1294 ACPI_OBJECT_TYPE ArgTypes
[4];
1296 char NumThreadsStr
[11];
1297 char IdOfThreadStr
[11];
1298 char IndexOfThreadStr
[11];
1300 } ACPI_DB_METHOD_INFO
;
1302 typedef struct acpi_integrity_info
1307 } ACPI_INTEGRITY_INFO
;
1310 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1311 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1312 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1315 /*****************************************************************************
1319 ****************************************************************************/
1321 /* Entry for a memory allocation (debug only) */
1323 #define ACPI_MEM_MALLOC 0
1324 #define ACPI_MEM_CALLOC 1
1325 #define ACPI_MAX_MODULE_NAME 16
1327 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1328 struct acpi_debug_mem_block *Previous; \
1329 struct acpi_debug_mem_block *Next; \
1333 char Module[ACPI_MAX_MODULE_NAME]; \
1336 typedef struct acpi_debug_mem_header
1338 ACPI_COMMON_DEBUG_MEM_HEADER
1340 } ACPI_DEBUG_MEM_HEADER
;
1342 typedef struct acpi_debug_mem_block
1344 ACPI_COMMON_DEBUG_MEM_HEADER
1347 } ACPI_DEBUG_MEM_BLOCK
;
1350 #define ACPI_MEM_LIST_GLOBAL 0
1351 #define ACPI_MEM_LIST_NSNODE 1
1352 #define ACPI_MEM_LIST_MAX 1
1353 #define ACPI_NUM_MEM_LISTS 2
1356 #endif /* __ACLOCAL_H__ */