1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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.
47 /* acpisrc:struct_defs -- for acpisrc conversion */
49 #define ACPI_SERIALIZED 0xFF
51 typedef u32 acpi_mutex_handle
;
52 #define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1)
54 /* Total number of aml opcodes defined */
56 #define AML_NUM_OPCODES 0x82
58 /* Forward declarations */
60 struct acpi_walk_state
;
61 struct acpi_obj_mutex
;
62 union acpi_parse_object
;
64 /*****************************************************************************
66 * Mutex typedefs and structs
68 ****************************************************************************/
71 * Predefined handles for the mutex objects used within the subsystem
72 * All mutex objects are automatically created by acpi_ut_mutex_initialize.
74 * The acquire/release ordering protocol is implied via this list. Mutexes
75 * with a lower value must be acquired before mutexes with a higher value.
77 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
80 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
81 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */
82 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
83 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
84 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
85 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
87 #define ACPI_MAX_MUTEX 5
88 #define ACPI_NUM_MUTEX (ACPI_MAX_MUTEX+1)
90 /* Lock structure for reader/writer interfaces */
93 acpi_mutex writer_mutex
;
94 acpi_mutex reader_mutex
;
99 * Predefined handles for spinlocks used within the subsystem.
100 * These spinlocks are created by acpi_ut_mutex_initialize
102 #define ACPI_LOCK_GPES 0
103 #define ACPI_LOCK_HARDWARE 1
105 #define ACPI_MAX_LOCK 1
106 #define ACPI_NUM_LOCK (ACPI_MAX_LOCK+1)
108 /* This Thread ID means that the mutex is not in use (unlocked) */
110 #define ACPI_MUTEX_NOT_ACQUIRED ((acpi_thread_id) 0)
112 /* This Thread ID means an invalid thread ID */
114 #ifdef ACPI_OS_INVALID_THREAD_ID
115 #define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID
117 #define ACPI_INVALID_THREAD_ID ((acpi_thread_id) 0xFFFFFFFF)
120 /* Table for the global mutexes */
122 struct acpi_mutex_info
{
125 acpi_thread_id thread_id
;
128 /* Lock flag parameter for various interfaces */
130 #define ACPI_MTX_DO_NOT_LOCK 0
131 #define ACPI_MTX_LOCK 1
133 /* Field access granularities */
135 #define ACPI_FIELD_BYTE_GRANULARITY 1
136 #define ACPI_FIELD_WORD_GRANULARITY 2
137 #define ACPI_FIELD_DWORD_GRANULARITY 4
138 #define ACPI_FIELD_QWORD_GRANULARITY 8
140 #define ACPI_ENTRY_NOT_FOUND NULL
142 /*****************************************************************************
144 * Namespace typedefs and structs
146 ****************************************************************************/
148 /* Operational modes of the AML interpreter/scanner */
151 ACPI_IMODE_LOAD_PASS1
= 0x01,
152 ACPI_IMODE_LOAD_PASS2
= 0x02,
153 ACPI_IMODE_EXECUTE
= 0x03
154 } acpi_interpreter_mode
;
157 * The Namespace Node describes a named object that appears in the AML.
158 * descriptor_type is used to differentiate between internal descriptors.
160 * The node is optimized for both 32-bit and 64-bit platforms:
161 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
163 * Note: The descriptor_type and Type fields must appear in the identical
164 * position in both the struct acpi_namespace_node and union acpi_operand_object
167 struct acpi_namespace_node
{
168 union acpi_operand_object
*object
; /* Interpreter object */
169 u8 descriptor_type
; /* Differentiate object descriptor types */
170 u8 type
; /* ACPI Type associated with this name */
171 u8 flags
; /* Miscellaneous flags */
172 acpi_owner_id owner_id
; /* Node creator */
173 union acpi_name_union name
; /* ACPI Name, always 4 chars per ACPI spec */
174 struct acpi_namespace_node
*parent
; /* Parent node */
175 struct acpi_namespace_node
*child
; /* First child */
176 struct acpi_namespace_node
*peer
; /* First peer */
179 * The following fields are used by the ASL compiler and disassembler only
181 #ifdef ACPI_LARGE_NAMESPACE_NODE
182 union acpi_parse_object
*op
;
192 /* Namespace Node flags */
194 #define ANOBJ_RESERVED 0x01 /* Available for use */
195 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
196 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
197 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
198 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
199 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
200 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
202 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
203 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
204 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
205 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
207 /* Internal ACPI table management - master table list */
209 struct acpi_table_list
{
210 struct acpi_table_desc
*tables
; /* Table descriptor array */
211 u32 current_table_count
; /* Tables currently in the array */
212 u32 max_table_count
; /* Max tables array will hold */
216 /* Flags for above */
218 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
219 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
220 #define ACPI_ROOT_ALLOW_RESIZE (2)
222 /* List to manage incoming ACPI tables */
224 struct acpi_new_table_desc
{
225 struct acpi_table_header
*table
;
226 struct acpi_new_table_desc
*next
;
229 /* Predefined table indexes */
231 #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF)
233 struct acpi_find_context
{
239 struct acpi_ns_search_data
{
240 struct acpi_namespace_node
*node
;
243 /* Object types used during package copies */
245 #define ACPI_COPY_TYPE_SIMPLE 0
246 #define ACPI_COPY_TYPE_PACKAGE 1
248 /* Info structure used to convert external<->internal namestrings */
250 struct acpi_namestring_info
{
251 const char *external_name
;
252 const char *next_external_char
;
260 /* Field creation info */
262 struct acpi_create_field_info
{
263 struct acpi_namespace_node
*region_node
;
264 struct acpi_namespace_node
*field_node
;
265 struct acpi_namespace_node
*register_node
;
266 struct acpi_namespace_node
*data_register_node
;
267 struct acpi_namespace_node
*connection_node
;
270 u32 field_bit_position
;
271 u32 field_bit_length
;
273 u16 pin_number_index
;
281 acpi_status(*acpi_internal_method
) (struct acpi_walk_state
* walk_state
);
284 * Bitmapped ACPI types. Used internally only
286 #define ACPI_BTYPE_ANY 0x00000000
287 #define ACPI_BTYPE_INTEGER 0x00000001
288 #define ACPI_BTYPE_STRING 0x00000002
289 #define ACPI_BTYPE_BUFFER 0x00000004
290 #define ACPI_BTYPE_PACKAGE 0x00000008
291 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
292 #define ACPI_BTYPE_DEVICE 0x00000020
293 #define ACPI_BTYPE_EVENT 0x00000040
294 #define ACPI_BTYPE_METHOD 0x00000080
295 #define ACPI_BTYPE_MUTEX 0x00000100
296 #define ACPI_BTYPE_REGION 0x00000200
297 #define ACPI_BTYPE_POWER 0x00000400
298 #define ACPI_BTYPE_PROCESSOR 0x00000800
299 #define ACPI_BTYPE_THERMAL 0x00001000
300 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
301 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
302 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
303 #define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), ref_of(), etc (type6_opcodes) */
304 #define ACPI_BTYPE_RESOURCE 0x00020000
305 #define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */
307 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
309 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
311 /* Used by Copy, de_ref_of, Store, Printf, Fprintf */
313 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE)
314 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
315 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
316 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
321 * Information structure for ACPI predefined names.
322 * Each entry in the table contains the following items:
324 * name - The ACPI reserved name
325 * param_count - Number of arguments to the method
326 * expected_return_btypes - Allowed type(s) for the return value
328 struct acpi_name_info
{
329 char name
[ACPI_NAME_SIZE
];
335 * Secondary information structures for ACPI predefined objects that return
336 * package objects. This structure appears as the next entry in the table
337 * after the NAME_INFO structure above.
339 * The reason for this is to minimize the size of the predefined name table.
343 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
344 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
345 * ACPI_PTYPE2_FIX_VAR
347 struct acpi_package_info
{
356 /* Used for ACPI_PTYPE2_FIXED */
358 struct acpi_package_info2
{
365 /* Used for ACPI_PTYPE1_OPTION */
367 struct acpi_package_info3
{
375 struct acpi_package_info4
{
384 union acpi_predefined_info
{
385 struct acpi_name_info info
;
386 struct acpi_package_info ret_info
;
387 struct acpi_package_info2 ret_info2
;
388 struct acpi_package_info3 ret_info3
;
389 struct acpi_package_info4 ret_info4
;
392 /* Reset to default packing */
396 /* Return object auto-repair info */
398 typedef acpi_status(*acpi_object_converter
) (struct acpi_namespace_node
* scope
,
399 union acpi_operand_object
401 union acpi_operand_object
404 struct acpi_simple_repair_info
{
405 char name
[ACPI_NAME_SIZE
];
406 u32 unexpected_btypes
;
408 acpi_object_converter object_converter
;
412 * Bitmapped return value types
413 * Note: the actual data types must be contiguous, a loop in nspredef.c
416 #define ACPI_RTYPE_ANY 0x00
417 #define ACPI_RTYPE_NONE 0x01
418 #define ACPI_RTYPE_INTEGER 0x02
419 #define ACPI_RTYPE_STRING 0x04
420 #define ACPI_RTYPE_BUFFER 0x08
421 #define ACPI_RTYPE_PACKAGE 0x10
422 #define ACPI_RTYPE_REFERENCE 0x20
423 #define ACPI_RTYPE_ALL 0x3F
425 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
427 /* Info for running the _REG methods */
429 struct acpi_reg_walk_info
{
430 acpi_adr_space_type space_id
;
435 /*****************************************************************************
437 * Event typedefs and structs
439 ****************************************************************************/
441 /* Dispatch info for each host-installed SCI handler */
443 struct acpi_sci_handler_info
{
444 struct acpi_sci_handler_info
*next
;
445 acpi_sci_handler address
; /* Address of handler */
446 void *context
; /* Context to be passed to handler */
449 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
451 struct acpi_gpe_handler_info
{
452 acpi_gpe_handler address
; /* Address of handler, if any */
453 void *context
; /* Context to be passed to handler */
454 struct acpi_namespace_node
*method_node
; /* Method node for this GPE level (saved) */
455 u8 original_flags
; /* Original (pre-handler) GPE info */
456 u8 originally_enabled
; /* True if GPE was originally enabled */
459 /* Notify info for implicit notify, multiple device objects */
461 struct acpi_gpe_notify_info
{
462 struct acpi_namespace_node
*device_node
; /* Device to be notified */
463 struct acpi_gpe_notify_info
*next
;
467 * GPE dispatch info. At any time, the GPE can have at most one type
468 * of dispatch - Method, Handler, or Implicit Notify.
470 union acpi_gpe_dispatch_info
{
471 struct acpi_namespace_node
*method_node
; /* Method node for this GPE level */
472 struct acpi_gpe_handler_info
*handler
; /* Installed GPE handler */
473 struct acpi_gpe_notify_info
*notify_list
; /* List of _PRW devices for implicit notifies */
477 * Information about a GPE, one per each GPE in an array.
478 * NOTE: Important to keep this struct as small as possible.
480 struct acpi_gpe_event_info
{
481 union acpi_gpe_dispatch_info dispatch
; /* Either Method, Handler, or notify_list */
482 struct acpi_gpe_register_info
*register_info
; /* Backpointer to register info */
483 u8 flags
; /* Misc info about this GPE */
484 u8 gpe_number
; /* This GPE */
485 u8 runtime_count
; /* References to a run GPE */
488 /* Information about a GPE register pair, one per each status/enable pair in an array */
490 struct acpi_gpe_register_info
{
491 struct acpi_generic_address status_address
; /* Address of status reg */
492 struct acpi_generic_address enable_address
; /* Address of enable reg */
493 u16 base_gpe_number
; /* Base GPE number for this register */
494 u8 enable_for_wake
; /* GPEs to keep enabled when sleeping */
495 u8 enable_for_run
; /* GPEs to keep enabled when running */
496 u8 enable_mask
; /* Current mask of enabled GPEs */
500 * Information about a GPE register block, one per each installed block --
501 * GPE0, GPE1, and one per each installed GPE Block Device.
503 struct acpi_gpe_block_info
{
504 struct acpi_namespace_node
*node
;
505 struct acpi_gpe_block_info
*previous
;
506 struct acpi_gpe_block_info
*next
;
507 struct acpi_gpe_xrupt_info
*xrupt_block
; /* Backpointer to interrupt block */
508 struct acpi_gpe_register_info
*register_info
; /* One per GPE register pair */
509 struct acpi_gpe_event_info
*event_info
; /* One for each GPE */
510 u64 address
; /* Base address of the block */
511 u32 register_count
; /* Number of register pairs in block */
512 u16 gpe_count
; /* Number of individual GPEs in block */
513 u16 block_base_number
; /* Base GPE number for this block */
515 u8 initialized
; /* TRUE if this block is initialized */
518 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
520 struct acpi_gpe_xrupt_info
{
521 struct acpi_gpe_xrupt_info
*previous
;
522 struct acpi_gpe_xrupt_info
*next
;
523 struct acpi_gpe_block_info
*gpe_block_list_head
; /* List of GPE blocks for this xrupt */
524 u32 interrupt_number
; /* System interrupt number */
527 struct acpi_gpe_walk_info
{
528 struct acpi_namespace_node
*gpe_device
;
529 struct acpi_gpe_block_info
*gpe_block
;
531 acpi_owner_id owner_id
;
532 u8 execute_by_owner_id
;
535 struct acpi_gpe_device_info
{
537 u32 next_block_base_index
;
539 struct acpi_namespace_node
*gpe_device
;
542 typedef acpi_status(*acpi_gpe_callback
) (struct acpi_gpe_xrupt_info
*
544 struct acpi_gpe_block_info
*gpe_block
,
547 /* Information about each particular fixed event */
549 struct acpi_fixed_event_handler
{
550 acpi_event_handler handler
; /* Address of handler. */
551 void *context
; /* Context to be passed to handler */
554 struct acpi_fixed_event_info
{
555 u8 status_register_id
;
556 u8 enable_register_id
;
561 /* Information used during field processing */
563 struct acpi_field_info
{
569 /*****************************************************************************
571 * Generic "state" object for stacks
573 ****************************************************************************/
575 #define ACPI_CONTROL_NORMAL 0xC0
576 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
577 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
578 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
579 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
581 #define ACPI_STATE_COMMON \
583 u8 descriptor_type; /* To differentiate various internal objs */\
588 /* There are 2 bytes available here until the next natural alignment boundary */
590 struct acpi_common_state
{
594 * Update state - used to traverse complex objects such as packages
596 struct acpi_update_state
{
597 ACPI_STATE_COMMON
union acpi_operand_object
*object
;
601 * Pkg state - used to traverse nested package structures
603 struct acpi_pkg_state
{
604 ACPI_STATE_COMMON u16 index
;
605 union acpi_operand_object
*source_object
;
606 union acpi_operand_object
*dest_object
;
607 struct acpi_walk_state
*walk_state
;
608 void *this_target_obj
;
613 * Control state - one per if/else and while constructs.
614 * Allows nesting of these constructs
616 struct acpi_control_state
{
617 ACPI_STATE_COMMON u16 opcode
;
618 union acpi_parse_object
*predicate_op
;
619 u8
*aml_predicate_start
; /* Start of if/while predicate */
620 u8
*package_end
; /* End of if/while block */
621 u32 loop_count
; /* While() loop counter */
625 * Scope state - current scope during namespace lookups
627 struct acpi_scope_state
{
628 ACPI_STATE_COMMON
struct acpi_namespace_node
*node
;
631 struct acpi_pscope_state
{
632 ACPI_STATE_COMMON u32 arg_count
; /* Number of fixed arguments */
633 union acpi_parse_object
*op
; /* Current op being parsed */
634 u8
*arg_end
; /* Current argument end */
635 u8
*pkg_end
; /* Current package end */
636 u32 arg_list
; /* Next argument to parse */
640 * Thread state - one per thread across multiple walk states. Multiple walk
641 * states are created when there are nested control methods executing.
643 struct acpi_thread_state
{
644 ACPI_STATE_COMMON u8 current_sync_level
; /* Mutex Sync (nested acquire) level */
645 struct acpi_walk_state
*walk_state_list
; /* Head of list of walk_states for this thread */
646 union acpi_operand_object
*acquired_mutex_list
; /* List of all currently acquired mutexes */
647 acpi_thread_id thread_id
; /* Running thread ID */
651 * Result values - used to accumulate the results of nested
654 struct acpi_result_values
{
656 union acpi_operand_object
*obj_desc
[ACPI_RESULTS_FRAME_OBJ_NUM
];
660 acpi_status(*acpi_parse_downwards
) (struct acpi_walk_state
* walk_state
,
661 union acpi_parse_object
** out_op
);
663 typedef acpi_status(*acpi_parse_upwards
) (struct acpi_walk_state
* walk_state
);
665 /* Global handlers for AML Notifies */
667 struct acpi_global_notify_handler
{
668 acpi_notify_handler handler
;
673 * Notify info - used to pass info to the deferred notify
674 * handler/dispatcher.
676 struct acpi_notify_info
{
677 ACPI_STATE_COMMON u8 handler_list_id
;
678 struct acpi_namespace_node
*node
;
679 union acpi_operand_object
*handler_list_head
;
680 struct acpi_global_notify_handler
*global
;
683 /* Generic state is union of structs above */
685 union acpi_generic_state
{
686 struct acpi_common_state common
;
687 struct acpi_control_state control
;
688 struct acpi_update_state update
;
689 struct acpi_scope_state scope
;
690 struct acpi_pscope_state parse_scope
;
691 struct acpi_pkg_state pkg
;
692 struct acpi_thread_state thread
;
693 struct acpi_result_values results
;
694 struct acpi_notify_info notify
;
697 /*****************************************************************************
699 * Interpreter typedefs and structs
701 ****************************************************************************/
703 typedef acpi_status(*acpi_execute_op
) (struct acpi_walk_state
* walk_state
);
705 /* Address Range info block */
707 struct acpi_address_range
{
708 struct acpi_address_range
*next
;
709 struct acpi_namespace_node
*region_node
;
710 acpi_physical_address start_address
;
711 acpi_physical_address end_address
;
714 /*****************************************************************************
716 * Parser typedefs and structs
718 ****************************************************************************/
721 * AML opcode, name, and argument layout
723 struct acpi_opcode_info
{
724 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
725 char *name
; /* Opcode name (disassembler/debug only) */
727 u32 parse_args
; /* Grammar/Parse time arguments */
728 u32 runtime_args
; /* Interpret time arguments */
729 u16 flags
; /* Misc flags */
730 u8 object_type
; /* Corresponding internal object type */
731 u8
class; /* Opcode class */
732 u8 type
; /* Opcode type */
735 /* Value associated with the parse object */
737 union acpi_parse_value
{
738 u64 integer
; /* Integer constant (Up to 64 bits) */
739 u32 size
; /* bytelist or field size */
740 char *string
; /* NULL terminated string */
741 u8
*buffer
; /* buffer or string */
742 char *name
; /* NULL terminated string */
743 union acpi_parse_object
*arg
; /* arguments and contained ops */
746 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
747 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
749 #define ACPI_DISASM_ONLY_MEMBERS(a)
752 #define ACPI_PARSE_COMMON \
753 union acpi_parse_object *parent; /* Parent op */\
754 u8 descriptor_type; /* To differentiate various internal objs */\
755 u8 flags; /* Type of Op */\
756 u16 aml_opcode; /* AML opcode */\
757 u8 *aml; /* Address of declaration in AML */\
758 union acpi_parse_object *next; /* Next op */\
759 struct acpi_namespace_node *node; /* For use by interpreter */\
760 union acpi_parse_value value; /* Value or args associated with the opcode */\
761 u8 arg_list_length; /* Number of elements in the arg list */\
762 ACPI_DISASM_ONLY_MEMBERS (\
763 u8 disasm_flags; /* Used during AML disassembly */\
764 u8 disasm_opcode; /* Subtype used for disassembly */\
765 char *operator_symbol;/* Used for C-style operator name strings */\
766 char aml_op_name[16]) /* Op name (debug only) */
768 /* Flags for disasm_flags field above */
770 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
771 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
772 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
773 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
774 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
775 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
776 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
777 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
778 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */
779 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */
780 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
781 #define ACPI_DASM_IGNORE 0x0B /* Not used at this time */
784 * Generic operation (for example: If, While, Store)
786 struct acpi_parse_obj_common
{
790 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
793 struct acpi_parse_obj_named
{
794 ACPI_PARSE_COMMON u8
*path
;
795 u8
*data
; /* AML body or bytelist data */
796 u32 length
; /* AML length */
797 u32 name
; /* 4-byte name or zero if no name */
800 /* This version is used by the iASL compiler only */
802 #define ACPI_MAX_PARSEOP_NAME 20
804 struct acpi_parse_obj_asl
{
805 ACPI_PARSE_COMMON
union acpi_parse_object
*child
;
806 union acpi_parse_object
*parent_method
;
814 u32 logical_line_number
;
815 u32 logical_byte_offset
;
817 u32 end_logical_line
;
820 u32 aml_subtree_length
;
821 u32 final_aml_length
;
822 u32 final_aml_offset
;
825 u8 aml_opcode_length
;
826 u8 aml_pkg_len_bytes
;
828 char parse_op_name
[ACPI_MAX_PARSEOP_NAME
];
831 union acpi_parse_object
{
832 struct acpi_parse_obj_common common
;
833 struct acpi_parse_obj_named named
;
834 struct acpi_parse_obj_asl asl
;
838 * Parse state - one state per parser invocation and each control
841 struct acpi_parse_state
{
842 u8
*aml_start
; /* First AML byte */
843 u8
*aml
; /* Next AML byte */
844 u8
*aml_end
; /* (last + 1) AML byte */
845 u8
*pkg_start
; /* Current package begin */
846 u8
*pkg_end
; /* Current package end */
847 union acpi_parse_object
*start_op
; /* Root of parse tree */
848 struct acpi_namespace_node
*start_node
;
849 union acpi_generic_state
*scope
; /* Current scope */
850 union acpi_parse_object
*start_scope
;
854 /* Parse object flags */
856 #define ACPI_PARSEOP_GENERIC 0x01
857 #define ACPI_PARSEOP_NAMED 0x02
858 #define ACPI_PARSEOP_DEFERRED 0x04
859 #define ACPI_PARSEOP_BYTELIST 0x08
860 #define ACPI_PARSEOP_IN_STACK 0x10
861 #define ACPI_PARSEOP_TARGET 0x20
862 #define ACPI_PARSEOP_IN_CACHE 0x80
864 /* Parse object disasm_flags */
866 #define ACPI_PARSEOP_IGNORE 0x01
867 #define ACPI_PARSEOP_PARAMLIST 0x02
868 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
869 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
870 #define ACPI_PARSEOP_CLOSING_PAREN 0x10
871 #define ACPI_PARSEOP_COMPOUND 0x20
872 #define ACPI_PARSEOP_ASSIGNMENT 0x40
873 #define ACPI_PARSEOP_ELSEIF 0x80
875 /*****************************************************************************
877 * Hardware (ACPI registers) and PNP
879 ****************************************************************************/
881 struct acpi_bit_register_info
{
888 * Some ACPI registers have bits that must be ignored -- meaning that they
891 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
893 /* Write-only bits must be zeroed by software */
895 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
897 /* For control registers, both ignored and reserved bits must be preserved */
900 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
901 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
902 * bit position", section 4.7.3.2.1. However, on some machines the OS must
903 * write a one to this bit after resume for the machine to work properly.
904 * To enable this, we no longer attempt to preserve this bit. No machines
905 * are known to fail if the bit is not preserved. (May 2009)
907 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
908 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
909 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
910 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
912 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
916 * These are the full ACPI registers
918 #define ACPI_REGISTER_PM1_STATUS 0x01
919 #define ACPI_REGISTER_PM1_ENABLE 0x02
920 #define ACPI_REGISTER_PM1_CONTROL 0x03
921 #define ACPI_REGISTER_PM2_CONTROL 0x04
922 #define ACPI_REGISTER_PM_TIMER 0x05
923 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
924 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
926 /* Masks used to access the bit_registers */
928 #define ACPI_BITMASK_TIMER_STATUS 0x0001
929 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
930 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
931 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
932 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
933 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
934 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
935 #define ACPI_BITMASK_WAKE_STATUS 0x8000
937 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
938 ACPI_BITMASK_TIMER_STATUS | \
939 ACPI_BITMASK_BUS_MASTER_STATUS | \
940 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
941 ACPI_BITMASK_POWER_BUTTON_STATUS | \
942 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
943 ACPI_BITMASK_RT_CLOCK_STATUS | \
944 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
945 ACPI_BITMASK_WAKE_STATUS)
947 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
948 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
949 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
950 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
951 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
952 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
954 #define ACPI_BITMASK_SCI_ENABLE 0x0001
955 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
956 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
957 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
958 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
960 #define ACPI_BITMASK_ARB_DISABLE 0x0001
962 /* Raw bit position of each bit_register */
964 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
965 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
966 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
967 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
968 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
969 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
970 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
971 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
973 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
974 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
975 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
976 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
977 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
978 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
980 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
981 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
982 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
983 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
984 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
986 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
988 /* Structs and definitions for _OSI support and I/O port validation */
990 #define ACPI_ALWAYS_ILLEGAL 0x00
992 struct acpi_interface_info
{
994 struct acpi_interface_info
*next
;
999 #define ACPI_OSI_INVALID 0x01
1000 #define ACPI_OSI_DYNAMIC 0x02
1001 #define ACPI_OSI_FEATURE 0x04
1002 #define ACPI_OSI_DEFAULT_INVALID 0x08
1003 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1005 struct acpi_port_info
{
1012 /*****************************************************************************
1014 * Resource descriptors
1016 ****************************************************************************/
1018 /* resource_type values */
1020 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1021 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1022 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1024 /* Resource descriptor types and masks */
1026 #define ACPI_RESOURCE_NAME_LARGE 0x80
1027 #define ACPI_RESOURCE_NAME_SMALL 0x00
1029 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1030 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1031 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1034 * Small resource descriptor "names" as defined by the ACPI specification.
1035 * Note: Bits 2:0 are used for the descriptor length
1037 #define ACPI_RESOURCE_NAME_IRQ 0x20
1038 #define ACPI_RESOURCE_NAME_DMA 0x28
1039 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1040 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1041 #define ACPI_RESOURCE_NAME_IO 0x40
1042 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1043 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1044 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1045 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1046 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1047 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1048 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1051 * Large resource descriptor "names" as defined by the ACPI specification.
1052 * Note: includes the Large Descriptor bit in bit[7]
1054 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1055 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1056 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1057 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1058 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1059 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1060 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1061 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1062 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1063 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1064 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1065 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1066 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1067 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1069 /*****************************************************************************
1073 ****************************************************************************/
1075 #define ACPI_ASCII_ZERO 0x30
1077 /*****************************************************************************
1081 ****************************************************************************/
1083 struct acpi_external_list
{
1085 char *internal_path
;
1086 struct acpi_external_list
*next
;
1093 /* Values for Flags field above */
1095 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1096 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1097 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1098 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1100 struct acpi_external_file
{
1102 struct acpi_external_file
*next
;
1105 /*****************************************************************************
1109 ****************************************************************************/
1111 struct acpi_db_method_info
{
1113 acpi_handle main_thread_gate
;
1114 acpi_handle thread_complete_gate
;
1115 acpi_handle info_gate
;
1116 acpi_thread_id
*threads
;
1124 char pathname
[ACPI_DB_LINE_BUFFER_SIZE
];
1126 acpi_object_type
*types
;
1129 * Arguments to be passed to method for the command
1131 * the Number of threads, ID of current thread and
1132 * Index of current thread inside all them created.
1135 #ifdef ACPI_DEBUGGER
1136 acpi_object_type arg_types
[4];
1139 char num_threads_str
[11];
1140 char id_of_thread_str
[11];
1141 char index_of_thread_str
[11];
1144 struct acpi_integrity_info
{
1149 #define ACPI_DB_DISABLE_OUTPUT 0x00
1150 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1151 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1152 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1154 struct acpi_object_info
{
1155 u32 types
[ACPI_TOTAL_TYPES
];
1158 /*****************************************************************************
1162 ****************************************************************************/
1164 /* Entry for a memory allocation (debug only) */
1166 #define ACPI_MEM_MALLOC 0
1167 #define ACPI_MEM_CALLOC 1
1168 #define ACPI_MAX_MODULE_NAME 16
1170 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1171 struct acpi_debug_mem_block *previous; \
1172 struct acpi_debug_mem_block *next; \
1176 char module[ACPI_MAX_MODULE_NAME]; \
1179 struct acpi_debug_mem_header
{
1180 ACPI_COMMON_DEBUG_MEM_HEADER
};
1182 struct acpi_debug_mem_block
{
1183 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space
;
1186 #define ACPI_MEM_LIST_GLOBAL 0
1187 #define ACPI_MEM_LIST_NSNODE 1
1188 #define ACPI_MEM_LIST_MAX 1
1189 #define ACPI_NUM_MEM_LISTS 2
1191 /*****************************************************************************
1195 ****************************************************************************/
1197 struct ah_predefined_name
{
1200 #ifndef ACPI_ASL_COMPILER
1205 struct ah_device_id
{
1220 #endif /* __ACLOCAL_H__ */