1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
48 /* acpisrc:StructDefs -- for acpisrc conversion */
50 #define ACPI_SERIALIZED 0xFF
52 typedef UINT32 ACPI_MUTEX_HANDLE;
53 #define ACPI_GLOBAL_LOCK (ACPI_SEMAPHORE) (-1)
55 /* Total number of aml opcodes defined */
57 #define AML_NUM_OPCODES 0x81
60 /* Forward declarations */
62 struct acpi_walk_state;
63 struct acpi_obj_mutex;
64 union acpi_parse_object;
67 /*****************************************************************************
69 * Mutex typedefs and structs
71 ****************************************************************************/
75 * Predefined handles for the mutex objects used within the subsystem
76 * All mutex objects are automatically created by AcpiUtMutexInitialize.
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.
81 * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames
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 */
93 #define ACPI_MAX_MUTEX 7
94 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
97 /* Lock structure for reader/writer interfaces */
99 typedef struct acpi_rw_lock
101 ACPI_MUTEX WriterMutex;
102 ACPI_MUTEX ReaderMutex;
109 * Predefined handles for spinlocks used within the subsystem.
110 * These spinlocks are created by AcpiUtMutexInitialize
112 #define ACPI_LOCK_GPES 0
113 #define ACPI_LOCK_HARDWARE 1
115 #define ACPI_MAX_LOCK 1
116 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
119 /* This Thread ID means that the mutex is not in use (unlocked) */
121 #define ACPI_MUTEX_NOT_ACQUIRED (ACPI_THREAD_ID) -1
123 /* Table for the global mutexes */
125 typedef struct acpi_mutex_info
129 ACPI_THREAD_ID ThreadId;
134 /* Lock flag parameter for various interfaces */
136 #define ACPI_MTX_DO_NOT_LOCK 0
137 #define ACPI_MTX_LOCK 1
140 /* Field access granularities */
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
148 #define ACPI_ENTRY_NOT_FOUND NULL
151 /*****************************************************************************
153 * Namespace typedefs and structs
155 ****************************************************************************/
157 /* Operational modes of the AML interpreter/scanner */
161 ACPI_IMODE_LOAD_PASS1 = 0x01,
162 ACPI_IMODE_LOAD_PASS2 = 0x02,
163 ACPI_IMODE_EXECUTE = 0x03
165 } ACPI_INTERPRETER_MODE;
169 * The Namespace Node describes a named object that appears in the AML.
170 * DescriptorType is used to differentiate between internal descriptors.
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.
175 * Note: The DescriptorType and Type fields must appear in the identical
176 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
179 typedef struct acpi_namespace_node
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 */
192 * The following fields are used by the ASL compiler and disassembler only
194 #ifdef ACPI_LARGE_NAMESPACE_NODE
195 union acpi_parse_object *Op;
200 } ACPI_NAMESPACE_NODE;
203 /* Namespace Node flags */
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) */
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 */
219 /* Internal ACPI table management - master table list */
221 typedef struct acpi_table_list
223 ACPI_TABLE_DESC *Tables; /* Table descriptor array */
224 UINT32 CurrentTableCount; /* Tables currently in the array */
225 UINT32 MaxTableCount; /* Max tables array will hold */
230 /* Flags for above */
232 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
233 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
234 #define ACPI_ROOT_ALLOW_RESIZE (2)
237 /* Predefined (fixed) table indexes */
239 #define ACPI_TABLE_INDEX_DSDT (0)
240 #define ACPI_TABLE_INDEX_FACS (1)
243 typedef struct acpi_find_context
252 typedef struct acpi_ns_search_data
254 ACPI_NAMESPACE_NODE *Node;
256 } ACPI_NS_SEARCH_DATA;
259 /* Object types used during package copies */
261 #define ACPI_COPY_TYPE_SIMPLE 0
262 #define ACPI_COPY_TYPE_PACKAGE 1
265 /* Info structure used to convert external<->internal namestrings */
267 typedef struct acpi_namestring_info
269 const char *ExternalName;
270 const char *NextExternalChar;
275 BOOLEAN FullyQualified;
277 } ACPI_NAMESTRING_INFO;
280 /* Field creation info */
282 typedef struct acpi_create_field_info
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;
291 UINT32 FieldBitPosition;
292 UINT32 FieldBitLength;
293 UINT16 ResourceLength;
299 } ACPI_CREATE_FIELD_INFO;
303 ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
304 struct acpi_walk_state *WalkState);
308 * Bitmapped ACPI types. Used internally only
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
330 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
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
341 * Information structure for ACPI predefined names.
342 * Each entry in the table contains the following items:
344 * Name - The ACPI reserved name
345 * ParamCount - Number of arguments to the method
346 * ExpectedReturnBtypes - Allowed type(s) for the return value
348 typedef struct acpi_name_info
350 char Name[ACPI_NAME_SIZE];
352 UINT8 ExpectedBtypes;
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.
361 * The reason for this is to minimize the size of the predefined name table.
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
369 typedef struct acpi_package_info
380 /* Used for ACPI_PTYPE2_FIXED */
382 typedef struct acpi_package_info2
389 } ACPI_PACKAGE_INFO2;
391 /* Used for ACPI_PTYPE1_OPTION */
393 typedef struct acpi_package_info3
398 UINT8 TailObjectType;
401 } ACPI_PACKAGE_INFO3;
403 typedef union acpi_predefined_info
406 ACPI_PACKAGE_INFO RetInfo;
407 ACPI_PACKAGE_INFO2 RetInfo2;
408 ACPI_PACKAGE_INFO3 RetInfo3;
410 } ACPI_PREDEFINED_INFO;
412 /* Reset to default packing */
417 /* Return object auto-repair info */
419 typedef ACPI_STATUS (*ACPI_OBJECT_CONVERTER) (
420 union acpi_operand_object *OriginalObject,
421 union acpi_operand_object **ConvertedObject);
423 typedef struct acpi_simple_repair_info
425 char Name[ACPI_NAME_SIZE];
426 UINT32 UnexpectedBtypes;
428 ACPI_OBJECT_CONVERTER ObjectConverter;
430 } ACPI_SIMPLE_REPAIR_INFO;
434 * Bitmapped return value types
435 * Note: the actual data types must be contiguous, a loop in nspredef.c
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
447 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
450 /*****************************************************************************
452 * Event typedefs and structs
454 ****************************************************************************/
456 /* Dispatch info for each host-installed SCI handler */
458 typedef struct acpi_sci_handler_info
460 struct acpi_sci_handler_info *Next;
461 ACPI_SCI_HANDLER Address; /* Address of handler */
462 void *Context; /* Context to be passed to handler */
464 } ACPI_SCI_HANDLER_INFO;
466 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
468 typedef struct acpi_gpe_handler_info
470 ACPI_GPE_HANDLER Address; /* Address of handler, if any */
471 void *Context; /* Context to be passed to handler */
472 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level (saved) */
473 UINT8 OriginalFlags; /* Original (pre-handler) GPE info */
474 BOOLEAN OriginallyEnabled; /* True if GPE was originally enabled */
476 } ACPI_GPE_HANDLER_INFO;
478 /* Notify info for implicit notify, multiple device objects */
480 typedef struct acpi_gpe_notify_info
482 ACPI_NAMESPACE_NODE *DeviceNode; /* Device to be notified */
483 struct acpi_gpe_notify_info *Next;
485 } ACPI_GPE_NOTIFY_INFO;
488 * GPE dispatch info. At any time, the GPE can have at most one type
489 * of dispatch - Method, Handler, or Implicit Notify.
491 typedef union acpi_gpe_dispatch_info
493 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level */
494 ACPI_GPE_HANDLER_INFO *Handler; /* Installed GPE handler */
495 ACPI_GPE_NOTIFY_INFO *NotifyList; /* List of _PRW devices for implicit notifies */
497 } ACPI_GPE_DISPATCH_INFO;
500 * Information about a GPE, one per each GPE in an array.
501 * NOTE: Important to keep this struct as small as possible.
503 typedef struct acpi_gpe_event_info
505 union acpi_gpe_dispatch_info Dispatch; /* Either Method, Handler, or NotifyList */
506 struct acpi_gpe_register_info *RegisterInfo; /* Backpointer to register info */
507 UINT8 Flags; /* Misc info about this GPE */
508 UINT8 GpeNumber; /* This GPE */
509 UINT8 RuntimeCount; /* References to a run GPE */
511 } ACPI_GPE_EVENT_INFO;
513 /* Information about a GPE register pair, one per each status/enable pair in an array */
515 typedef struct acpi_gpe_register_info
517 ACPI_GENERIC_ADDRESS StatusAddress; /* Address of status reg */
518 ACPI_GENERIC_ADDRESS EnableAddress; /* Address of enable reg */
519 UINT16 BaseGpeNumber; /* Base GPE number for this register */
520 UINT8 EnableForWake; /* GPEs to keep enabled when sleeping */
521 UINT8 EnableForRun; /* GPEs to keep enabled when running */
523 } ACPI_GPE_REGISTER_INFO;
526 * Information about a GPE register block, one per each installed block --
527 * GPE0, GPE1, and one per each installed GPE Block Device.
529 typedef struct acpi_gpe_block_info
531 ACPI_NAMESPACE_NODE *Node;
532 struct acpi_gpe_block_info *Previous;
533 struct acpi_gpe_block_info *Next;
534 struct acpi_gpe_xrupt_info *XruptBlock; /* Backpointer to interrupt block */
535 ACPI_GPE_REGISTER_INFO *RegisterInfo; /* One per GPE register pair */
536 ACPI_GPE_EVENT_INFO *EventInfo; /* One for each GPE */
537 UINT64 Address; /* Base address of the block */
538 UINT32 RegisterCount; /* Number of register pairs in block */
539 UINT16 GpeCount; /* Number of individual GPEs in block */
540 UINT16 BlockBaseNumber;/* Base GPE number for this block */
542 BOOLEAN Initialized; /* TRUE if this block is initialized */
544 } ACPI_GPE_BLOCK_INFO;
546 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
548 typedef struct acpi_gpe_xrupt_info
550 struct acpi_gpe_xrupt_info *Previous;
551 struct acpi_gpe_xrupt_info *Next;
552 ACPI_GPE_BLOCK_INFO *GpeBlockListHead; /* List of GPE blocks for this xrupt */
553 UINT32 InterruptNumber; /* System interrupt number */
555 } ACPI_GPE_XRUPT_INFO;
557 typedef struct acpi_gpe_walk_info
559 ACPI_NAMESPACE_NODE *GpeDevice;
560 ACPI_GPE_BLOCK_INFO *GpeBlock;
562 ACPI_OWNER_ID OwnerId;
563 BOOLEAN ExecuteByOwnerId;
565 } ACPI_GPE_WALK_INFO;
567 typedef struct acpi_gpe_device_info
570 UINT32 NextBlockBaseIndex;
572 ACPI_NAMESPACE_NODE *GpeDevice;
574 } ACPI_GPE_DEVICE_INFO;
576 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
577 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
578 ACPI_GPE_BLOCK_INFO *GpeBlock,
582 /* Information about each particular fixed event */
584 typedef struct acpi_fixed_event_handler
586 ACPI_EVENT_HANDLER Handler; /* Address of handler. */
587 void *Context; /* Context to be passed to handler */
589 } ACPI_FIXED_EVENT_HANDLER;
591 typedef struct acpi_fixed_event_info
593 UINT8 StatusRegisterId;
594 UINT8 EnableRegisterId;
595 UINT16 StatusBitMask;
596 UINT16 EnableBitMask;
598 } ACPI_FIXED_EVENT_INFO;
600 /* Information used during field processing */
602 typedef struct acpi_field_info
611 /*****************************************************************************
613 * Generic "state" object for stacks
615 ****************************************************************************/
617 #define ACPI_CONTROL_NORMAL 0xC0
618 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
619 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
620 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
621 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
624 #define ACPI_STATE_COMMON \
626 UINT8 DescriptorType; /* To differentiate various internal objs */\
631 /* There are 2 bytes available here until the next natural alignment boundary */
633 typedef struct acpi_common_state
640 * Update state - used to traverse complex objects such as packages
642 typedef struct acpi_update_state
645 union acpi_operand_object *Object;
651 * Pkg state - used to traverse nested package structures
653 typedef struct acpi_pkg_state
657 union acpi_operand_object *SourceObject;
658 union acpi_operand_object *DestObject;
659 struct acpi_walk_state *WalkState;
667 * Control state - one per if/else and while constructs.
668 * Allows nesting of these constructs
670 typedef struct acpi_control_state
674 union acpi_parse_object *PredicateOp;
675 UINT8 *AmlPredicateStart; /* Start of if/while predicate */
676 UINT8 *PackageEnd; /* End of if/while block */
677 UINT32 LoopCount; /* While() loop counter */
679 } ACPI_CONTROL_STATE;
683 * Scope state - current scope during namespace lookups
685 typedef struct acpi_scope_state
688 ACPI_NAMESPACE_NODE *Node;
693 typedef struct acpi_pscope_state
696 UINT32 ArgCount; /* Number of fixed arguments */
697 union acpi_parse_object *Op; /* Current op being parsed */
698 UINT8 *ArgEnd; /* Current argument end */
699 UINT8 *PkgEnd; /* Current package end */
700 UINT32 ArgList; /* Next argument to parse */
706 * Thread state - one per thread across multiple walk states. Multiple walk
707 * states are created when there are nested control methods executing.
709 typedef struct acpi_thread_state
712 UINT8 CurrentSyncLevel; /* Mutex Sync (nested acquire) level */
713 struct acpi_walk_state *WalkStateList; /* Head of list of WalkStates for this thread */
714 union acpi_operand_object *AcquiredMutexList; /* List of all currently acquired mutexes */
715 ACPI_THREAD_ID ThreadId; /* Running thread ID */
721 * Result values - used to accumulate the results of nested
724 typedef struct acpi_result_values
727 union acpi_operand_object *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
729 } ACPI_RESULT_VALUES;
733 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
734 struct acpi_walk_state *WalkState,
735 union acpi_parse_object **OutOp);
738 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
739 struct acpi_walk_state *WalkState);
742 /* Global handlers for AML Notifies */
744 typedef struct acpi_global_notify_handler
746 ACPI_NOTIFY_HANDLER Handler;
749 } ACPI_GLOBAL_NOTIFY_HANDLER;
752 * Notify info - used to pass info to the deferred notify
753 * handler/dispatcher.
755 typedef struct acpi_notify_info
759 ACPI_NAMESPACE_NODE *Node;
760 union acpi_operand_object *HandlerListHead;
761 ACPI_GLOBAL_NOTIFY_HANDLER *Global;
766 /* Generic state is union of structs above */
768 typedef union acpi_generic_state
770 ACPI_COMMON_STATE Common;
771 ACPI_CONTROL_STATE Control;
772 ACPI_UPDATE_STATE Update;
773 ACPI_SCOPE_STATE Scope;
774 ACPI_PSCOPE_STATE ParseScope;
776 ACPI_THREAD_STATE Thread;
777 ACPI_RESULT_VALUES Results;
778 ACPI_NOTIFY_INFO Notify;
780 } ACPI_GENERIC_STATE;
783 /*****************************************************************************
785 * Interpreter typedefs and structs
787 ****************************************************************************/
790 ACPI_STATUS (*ACPI_EXECUTE_OP) (
791 struct acpi_walk_state *WalkState);
793 /* Address Range info block */
795 typedef struct acpi_address_range
797 struct acpi_address_range *Next;
798 ACPI_NAMESPACE_NODE *RegionNode;
799 ACPI_PHYSICAL_ADDRESS StartAddress;
800 ACPI_PHYSICAL_ADDRESS EndAddress;
802 } ACPI_ADDRESS_RANGE;
805 /*****************************************************************************
807 * Parser typedefs and structs
809 ****************************************************************************/
812 * AML opcode, name, and argument layout
814 typedef struct acpi_opcode_info
816 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
817 char *Name; /* Opcode name (disassembler/debug only) */
819 UINT32 ParseArgs; /* Grammar/Parse time arguments */
820 UINT32 RuntimeArgs; /* Interpret time arguments */
821 UINT16 Flags; /* Misc flags */
822 UINT8 ObjectType; /* Corresponding internal object type */
823 UINT8 Class; /* Opcode class */
824 UINT8 Type; /* Opcode type */
828 /* Structure for Resource Tag information */
830 typedef struct acpi_tag_info
837 /* Value associated with the parse object */
839 typedef union acpi_parse_value
841 UINT64 Integer; /* Integer constant (Up to 64 bits) */
842 UINT32 Size; /* bytelist or field size */
843 char *String; /* NULL terminated string */
844 UINT8 *Buffer; /* buffer or string */
845 char *Name; /* NULL terminated string */
846 union acpi_parse_object *Arg; /* arguments and contained ops */
847 ACPI_TAG_INFO Tag; /* Resource descriptor tag info */
852 #ifdef ACPI_DISASSEMBLER
853 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
855 #define ACPI_DISASM_ONLY_MEMBERS(a)
858 #define ACPI_PARSE_COMMON \
859 union acpi_parse_object *Parent; /* Parent op */\
860 UINT8 DescriptorType; /* To differentiate various internal objs */\
861 UINT8 Flags; /* Type of Op */\
862 UINT16 AmlOpcode; /* AML opcode */\
863 UINT32 AmlOffset; /* Offset of declaration in AML */\
864 union acpi_parse_object *Next; /* Next op */\
865 ACPI_NAMESPACE_NODE *Node; /* For use by interpreter */\
866 ACPI_PARSE_VALUE Value; /* Value or args associated with the opcode */\
867 UINT8 ArgListLength; /* Number of elements in the arg list */\
868 ACPI_DISASM_ONLY_MEMBERS (\
869 UINT8 DisasmFlags; /* Used during AML disassembly */\
870 UINT8 DisasmOpcode; /* Subtype used for disassembly */\
871 char AmlOpName[16]) /* Op name (debug only) */
874 /* Flags for DisasmFlags field above */
876 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
877 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
878 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
879 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
880 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
881 #define ACPI_DASM_EISAID 0x05 /* Integer is an EISAID */
882 #define ACPI_DASM_MATCHOP 0x06 /* Parent opcode is a Match() operator */
883 #define ACPI_DASM_LNOT_PREFIX 0x07 /* Start of a LNotEqual (etc.) pair of opcodes */
884 #define ACPI_DASM_LNOT_SUFFIX 0x08 /* End of a LNotEqual (etc.) pair of opcodes */
885 #define ACPI_DASM_HID_STRING 0x09 /* String is a _HID or _CID */
886 #define ACPI_DASM_IGNORE 0x0A /* Not used at this time */
889 * Generic operation (for example: If, While, Store)
891 typedef struct acpi_parse_obj_common
894 } ACPI_PARSE_OBJ_COMMON;
898 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
901 typedef struct acpi_parse_obj_named
905 UINT8 *Data; /* AML body or bytelist data */
906 UINT32 Length; /* AML length */
907 UINT32 Name; /* 4-byte name or zero if no name */
909 } ACPI_PARSE_OBJ_NAMED;
912 /* This version is used by the iASL compiler only */
914 #define ACPI_MAX_PARSEOP_NAME 20
916 typedef struct acpi_parse_obj_asl
919 union acpi_parse_object *Child;
920 union acpi_parse_object *ParentMethod;
928 UINT32 LogicalLineNumber;
929 UINT32 LogicalByteOffset;
931 UINT32 EndLogicalLine;
934 UINT32 AmlSubtreeLength;
935 UINT32 FinalAmlLength;
936 UINT32 FinalAmlOffset;
939 UINT8 AmlOpcodeLength;
940 UINT8 AmlPkgLenBytes;
942 char ParseOpName[ACPI_MAX_PARSEOP_NAME];
944 } ACPI_PARSE_OBJ_ASL;
946 typedef union acpi_parse_object
948 ACPI_PARSE_OBJ_COMMON Common;
949 ACPI_PARSE_OBJ_NAMED Named;
950 ACPI_PARSE_OBJ_ASL Asl;
956 * Parse state - one state per parser invocation and each control
959 typedef struct acpi_parse_state
961 UINT8 *AmlStart; /* First AML byte */
962 UINT8 *Aml; /* Next AML byte */
963 UINT8 *AmlEnd; /* (last + 1) AML byte */
964 UINT8 *PkgStart; /* Current package begin */
965 UINT8 *PkgEnd; /* Current package end */
966 union acpi_parse_object *StartOp; /* Root of parse tree */
967 struct acpi_namespace_node *StartNode;
968 union acpi_generic_state *Scope; /* Current scope */
969 union acpi_parse_object *StartScope;
975 /* Parse object flags */
977 #define ACPI_PARSEOP_GENERIC 0x01
978 #define ACPI_PARSEOP_NAMED 0x02
979 #define ACPI_PARSEOP_DEFERRED 0x04
980 #define ACPI_PARSEOP_BYTELIST 0x08
981 #define ACPI_PARSEOP_IN_STACK 0x10
982 #define ACPI_PARSEOP_TARGET 0x20
983 #define ACPI_PARSEOP_IN_CACHE 0x80
985 /* Parse object DisasmFlags */
987 #define ACPI_PARSEOP_IGNORE 0x01
988 #define ACPI_PARSEOP_PARAMLIST 0x02
989 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
990 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
991 #define ACPI_PARSEOP_SPECIAL 0x10
994 /*****************************************************************************
996 * Hardware (ACPI registers) and PNP
998 ****************************************************************************/
1000 typedef struct acpi_bit_register_info
1002 UINT8 ParentRegister;
1004 UINT16 AccessBitMask;
1006 } ACPI_BIT_REGISTER_INFO;
1010 * Some ACPI registers have bits that must be ignored -- meaning that they
1011 * must be preserved.
1013 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
1015 /* Write-only bits must be zeroed by software */
1017 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
1019 /* For control registers, both ignored and reserved bits must be preserved */
1022 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1023 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1024 * bit position", section 4.7.3.2.1. However, on some machines the OS must
1025 * write a one to this bit after resume for the machine to work properly.
1026 * To enable this, we no longer attempt to preserve this bit. No machines
1027 * are known to fail if the bit is not preserved. (May 2009)
1029 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
1030 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
1031 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1032 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1034 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
1038 * These are the full ACPI registers
1040 #define ACPI_REGISTER_PM1_STATUS 0x01
1041 #define ACPI_REGISTER_PM1_ENABLE 0x02
1042 #define ACPI_REGISTER_PM1_CONTROL 0x03
1043 #define ACPI_REGISTER_PM2_CONTROL 0x04
1044 #define ACPI_REGISTER_PM_TIMER 0x05
1045 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
1046 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
1049 /* Masks used to access the BitRegisters */
1051 #define ACPI_BITMASK_TIMER_STATUS 0x0001
1052 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
1053 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
1054 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
1055 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
1056 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
1057 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
1058 #define ACPI_BITMASK_WAKE_STATUS 0x8000
1060 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
1061 ACPI_BITMASK_TIMER_STATUS | \
1062 ACPI_BITMASK_BUS_MASTER_STATUS | \
1063 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
1064 ACPI_BITMASK_POWER_BUTTON_STATUS | \
1065 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
1066 ACPI_BITMASK_RT_CLOCK_STATUS | \
1067 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
1068 ACPI_BITMASK_WAKE_STATUS)
1070 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
1071 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
1072 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
1073 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
1074 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
1075 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
1077 #define ACPI_BITMASK_SCI_ENABLE 0x0001
1078 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
1079 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
1080 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
1081 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
1083 #define ACPI_BITMASK_ARB_DISABLE 0x0001
1086 /* Raw bit position of each BitRegister */
1088 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
1089 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
1090 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
1091 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
1092 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
1093 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
1094 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
1095 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
1097 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
1098 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
1099 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
1100 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
1101 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
1102 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
1104 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
1105 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
1106 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
1107 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
1108 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
1110 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
1113 /* Structs and definitions for _OSI support and I/O port validation */
1115 #define ACPI_ALWAYS_ILLEGAL 0x00
1117 typedef struct acpi_interface_info
1120 struct acpi_interface_info *Next;
1124 } ACPI_INTERFACE_INFO;
1126 #define ACPI_OSI_INVALID 0x01
1127 #define ACPI_OSI_DYNAMIC 0x02
1128 #define ACPI_OSI_FEATURE 0x04
1129 #define ACPI_OSI_DEFAULT_INVALID 0x08
1130 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1132 typedef struct acpi_port_info
1137 UINT8 OsiDependency;
1142 /*****************************************************************************
1144 * Resource descriptors
1146 ****************************************************************************/
1148 /* ResourceType values */
1150 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1151 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1152 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1154 /* Resource descriptor types and masks */
1156 #define ACPI_RESOURCE_NAME_LARGE 0x80
1157 #define ACPI_RESOURCE_NAME_SMALL 0x00
1159 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1160 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1161 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1165 * Small resource descriptor "names" as defined by the ACPI specification.
1166 * Note: Bits 2:0 are used for the descriptor length
1168 #define ACPI_RESOURCE_NAME_IRQ 0x20
1169 #define ACPI_RESOURCE_NAME_DMA 0x28
1170 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1171 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1172 #define ACPI_RESOURCE_NAME_IO 0x40
1173 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1174 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1175 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1176 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1177 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1178 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1179 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1182 * Large resource descriptor "names" as defined by the ACPI specification.
1183 * Note: includes the Large Descriptor bit in bit[7]
1185 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1186 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1187 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1188 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1189 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1190 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1191 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1192 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1193 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1194 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1195 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1196 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1197 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1198 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1201 /*****************************************************************************
1205 ****************************************************************************/
1207 #define ACPI_ASCII_ZERO 0x30
1210 /*****************************************************************************
1214 ****************************************************************************/
1216 typedef struct acpi_external_list
1220 struct acpi_external_list *Next;
1226 } ACPI_EXTERNAL_LIST;
1228 /* Values for Flags field above */
1230 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1231 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1232 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1233 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1236 typedef struct acpi_external_file
1239 struct acpi_external_file *Next;
1241 } ACPI_EXTERNAL_FILE;
1244 /*****************************************************************************
1248 ****************************************************************************/
1250 typedef struct acpi_db_method_info
1253 ACPI_HANDLE MainThreadGate;
1254 ACPI_HANDLE ThreadCompleteGate;
1255 ACPI_HANDLE InfoGate;
1256 ACPI_THREAD_ID *Threads;
1259 UINT32 NumCompleted;
1264 char Pathname[ACPI_DB_LINE_BUFFER_SIZE];
1266 ACPI_OBJECT_TYPE *Types;
1269 * Arguments to be passed to method for the command
1271 * the Number of threads, ID of current thread and
1272 * Index of current thread inside all them created.
1275 ACPI_OBJECT_TYPE ArgTypes[4];
1277 char NumThreadsStr[11];
1278 char IdOfThreadStr[11];
1279 char IndexOfThreadStr[11];
1281 } ACPI_DB_METHOD_INFO;
1283 typedef struct acpi_integrity_info
1288 } ACPI_INTEGRITY_INFO;
1291 #define ACPI_DB_DISABLE_OUTPUT 0x00
1292 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1293 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1294 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1297 /*****************************************************************************
1301 ****************************************************************************/
1303 /* Entry for a memory allocation (debug only) */
1305 #define ACPI_MEM_MALLOC 0
1306 #define ACPI_MEM_CALLOC 1
1307 #define ACPI_MAX_MODULE_NAME 16
1309 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1310 struct acpi_debug_mem_block *Previous; \
1311 struct acpi_debug_mem_block *Next; \
1315 char Module[ACPI_MAX_MODULE_NAME]; \
1318 typedef struct acpi_debug_mem_header
1320 ACPI_COMMON_DEBUG_MEM_HEADER
1322 } ACPI_DEBUG_MEM_HEADER;
1324 typedef struct acpi_debug_mem_block
1326 ACPI_COMMON_DEBUG_MEM_HEADER
1329 } ACPI_DEBUG_MEM_BLOCK;
1332 #define ACPI_MEM_LIST_GLOBAL 0
1333 #define ACPI_MEM_LIST_NSNODE 1
1334 #define ACPI_MEM_LIST_MAX 1
1335 #define ACPI_NUM_MEM_LISTS 2
1338 /*****************************************************************************
1342 ****************************************************************************/
1344 typedef struct ah_predefined_name
1348 #ifndef ACPI_ASL_COMPILER
1352 } AH_PREDEFINED_NAME;
1354 typedef struct ah_device_id
1361 #endif /* __ACLOCAL_H__ */