1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: aclocal.h - Internal data types used across the ACPI subsystem
6 * Copyright (C) 2000 - 2020, Intel Corp.
8 *****************************************************************************/
13 /* acpisrc:struct_defs -- for acpisrc conversion */
15 #define ACPI_SERIALIZED 0xFF
17 typedef u32 acpi_mutex_handle
;
18 #define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1)
20 /* Total number of aml opcodes defined */
22 #define AML_NUM_OPCODES 0x83
24 /* Forward declarations */
26 struct acpi_walk_state
;
27 struct acpi_obj_mutex
;
28 union acpi_parse_object
;
30 /*****************************************************************************
32 * Mutex typedefs and structs
34 ****************************************************************************/
37 * Predefined handles for the mutex objects used within the subsystem
38 * All mutex objects are automatically created by acpi_ut_mutex_initialize.
40 * The acquire/release ordering protocol is implied via this list. Mutexes
41 * with a lower value must be acquired before mutexes with a higher value.
43 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
46 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
47 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */
48 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
49 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
50 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
51 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
53 #define ACPI_MAX_MUTEX 5
54 #define ACPI_NUM_MUTEX (ACPI_MAX_MUTEX+1)
56 /* Lock structure for reader/writer interfaces */
59 acpi_mutex writer_mutex
;
60 acpi_mutex reader_mutex
;
65 * Predefined handles for spinlocks used within the subsystem.
66 * These spinlocks are created by acpi_ut_mutex_initialize
68 #define ACPI_LOCK_GPES 0
69 #define ACPI_LOCK_HARDWARE 1
71 #define ACPI_MAX_LOCK 1
72 #define ACPI_NUM_LOCK (ACPI_MAX_LOCK+1)
74 /* This Thread ID means that the mutex is not in use (unlocked) */
76 #define ACPI_MUTEX_NOT_ACQUIRED ((acpi_thread_id) 0)
78 /* This Thread ID means an invalid thread ID */
80 #ifdef ACPI_OS_INVALID_THREAD_ID
81 #define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID
83 #define ACPI_INVALID_THREAD_ID ((acpi_thread_id) 0xFFFFFFFF)
86 /* Table for the global mutexes */
88 struct acpi_mutex_info
{
91 acpi_thread_id thread_id
;
94 /* Lock flag parameter for various interfaces */
96 #define ACPI_MTX_DO_NOT_LOCK 0
97 #define ACPI_MTX_LOCK 1
99 /* Field access granularities */
101 #define ACPI_FIELD_BYTE_GRANULARITY 1
102 #define ACPI_FIELD_WORD_GRANULARITY 2
103 #define ACPI_FIELD_DWORD_GRANULARITY 4
104 #define ACPI_FIELD_QWORD_GRANULARITY 8
106 #define ACPI_ENTRY_NOT_FOUND NULL
108 /*****************************************************************************
110 * Namespace typedefs and structs
112 ****************************************************************************/
114 /* Operational modes of the AML interpreter/scanner */
117 ACPI_IMODE_LOAD_PASS1
= 0x01,
118 ACPI_IMODE_LOAD_PASS2
= 0x02,
119 ACPI_IMODE_EXECUTE
= 0x03
120 } acpi_interpreter_mode
;
123 * The Namespace Node describes a named object that appears in the AML.
124 * descriptor_type is used to differentiate between internal descriptors.
126 * The node is optimized for both 32-bit and 64-bit platforms:
127 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
129 * Note: The descriptor_type and Type fields must appear in the identical
130 * position in both the struct acpi_namespace_node and union acpi_operand_object
133 struct acpi_namespace_node
{
134 union acpi_operand_object
*object
; /* Interpreter object */
135 u8 descriptor_type
; /* Differentiate object descriptor types */
136 u8 type
; /* ACPI Type associated with this name */
137 u16 flags
; /* Miscellaneous flags */
138 union acpi_name_union name
; /* ACPI Name, always 4 chars per ACPI spec */
139 struct acpi_namespace_node
*parent
; /* Parent node */
140 struct acpi_namespace_node
*child
; /* First child */
141 struct acpi_namespace_node
*peer
; /* First peer */
142 acpi_owner_id owner_id
; /* Node creator */
145 * The following fields are used by the ASL compiler and disassembler only
147 #ifdef ACPI_LARGE_NAMESPACE_NODE
148 union acpi_parse_object
*op
;
158 /* Namespace Node flags */
160 #define ANOBJ_RESERVED 0x01 /* Available for use */
161 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
162 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
163 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
164 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
165 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
166 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
167 #define ANOBJ_NODE_EARLY_INIT 0x80 /* acpi_exec only: Node was create via init file (-fi) */
169 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
170 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
171 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
172 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
174 /* Internal ACPI table management - master table list */
176 struct acpi_table_list
{
177 struct acpi_table_desc
*tables
; /* Table descriptor array */
178 u32 current_table_count
; /* Tables currently in the array */
179 u32 max_table_count
; /* Max tables array will hold */
183 /* Flags for above */
185 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
186 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
187 #define ACPI_ROOT_ALLOW_RESIZE (2)
189 /* List to manage incoming ACPI tables */
191 struct acpi_new_table_desc
{
192 struct acpi_table_header
*table
;
193 struct acpi_new_table_desc
*next
;
196 /* Predefined table indexes */
198 #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF)
200 struct acpi_find_context
{
206 struct acpi_ns_search_data
{
207 struct acpi_namespace_node
*node
;
210 /* Object types used during package copies */
212 #define ACPI_COPY_TYPE_SIMPLE 0
213 #define ACPI_COPY_TYPE_PACKAGE 1
215 /* Info structure used to convert external<->internal namestrings */
217 struct acpi_namestring_info
{
218 const char *external_name
;
219 const char *next_external_char
;
227 /* Field creation info */
229 struct acpi_create_field_info
{
230 struct acpi_namespace_node
*region_node
;
231 struct acpi_namespace_node
*field_node
;
232 struct acpi_namespace_node
*register_node
;
233 struct acpi_namespace_node
*data_register_node
;
234 struct acpi_namespace_node
*connection_node
;
237 u32 field_bit_position
;
238 u32 field_bit_length
;
240 u16 pin_number_index
;
248 acpi_status (*acpi_internal_method
) (struct acpi_walk_state
* walk_state
);
251 * Bitmapped ACPI types. Used internally only
253 #define ACPI_BTYPE_ANY 0x00000000
254 #define ACPI_BTYPE_INTEGER 0x00000001
255 #define ACPI_BTYPE_STRING 0x00000002
256 #define ACPI_BTYPE_BUFFER 0x00000004
257 #define ACPI_BTYPE_PACKAGE 0x00000008
258 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
259 #define ACPI_BTYPE_DEVICE 0x00000020
260 #define ACPI_BTYPE_EVENT 0x00000040
261 #define ACPI_BTYPE_METHOD 0x00000080
262 #define ACPI_BTYPE_MUTEX 0x00000100
263 #define ACPI_BTYPE_REGION 0x00000200
264 #define ACPI_BTYPE_POWER 0x00000400
265 #define ACPI_BTYPE_PROCESSOR 0x00000800
266 #define ACPI_BTYPE_THERMAL 0x00001000
267 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
268 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
269 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
270 #define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), ref_of(), etc (type6_opcodes) */
271 #define ACPI_BTYPE_RESOURCE 0x00020000
272 #define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */
274 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
276 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
278 /* Used by Copy, de_ref_of, Store, Printf, Fprintf */
280 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE)
281 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
282 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
283 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
288 * Information structure for ACPI predefined names.
289 * Each entry in the table contains the following items:
291 * name - The ACPI reserved name
292 * param_count - Number of arguments to the method
293 * expected_return_btypes - Allowed type(s) for the return value
295 struct acpi_name_info
{
296 char name
[ACPI_NAMESEG_SIZE
];
302 * Secondary information structures for ACPI predefined objects that return
303 * package objects. This structure appears as the next entry in the table
304 * after the NAME_INFO structure above.
306 * The reason for this is to minimize the size of the predefined name table.
310 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
311 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
312 * ACPI_PTYPE2_FIX_VAR
314 struct acpi_package_info
{
323 /* Used for ACPI_PTYPE2_FIXED */
325 struct acpi_package_info2
{
332 /* Used for ACPI_PTYPE1_OPTION */
334 struct acpi_package_info3
{
342 struct acpi_package_info4
{
351 union acpi_predefined_info
{
352 struct acpi_name_info info
;
353 struct acpi_package_info ret_info
;
354 struct acpi_package_info2 ret_info2
;
355 struct acpi_package_info3 ret_info3
;
356 struct acpi_package_info4 ret_info4
;
359 /* Reset to default packing */
363 /* Return object auto-repair info */
365 typedef acpi_status (*acpi_object_converter
) (struct acpi_namespace_node
*
367 union acpi_operand_object
*
369 union acpi_operand_object
**
372 struct acpi_simple_repair_info
{
373 char name
[ACPI_NAMESEG_SIZE
];
374 u32 unexpected_btypes
;
376 acpi_object_converter object_converter
;
380 * Bitmapped return value types
381 * Note: the actual data types must be contiguous, a loop in nspredef.c
384 #define ACPI_RTYPE_ANY 0x00
385 #define ACPI_RTYPE_NONE 0x01
386 #define ACPI_RTYPE_INTEGER 0x02
387 #define ACPI_RTYPE_STRING 0x04
388 #define ACPI_RTYPE_BUFFER 0x08
389 #define ACPI_RTYPE_PACKAGE 0x10
390 #define ACPI_RTYPE_REFERENCE 0x20
391 #define ACPI_RTYPE_ALL 0x3F
393 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
395 /* Info for running the _REG methods */
397 struct acpi_reg_walk_info
{
400 acpi_adr_space_type space_id
;
403 /*****************************************************************************
405 * Event typedefs and structs
407 ****************************************************************************/
409 /* Dispatch info for each host-installed SCI handler */
411 struct acpi_sci_handler_info
{
412 struct acpi_sci_handler_info
*next
;
413 acpi_sci_handler address
; /* Address of handler */
414 void *context
; /* Context to be passed to handler */
417 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
419 struct acpi_gpe_handler_info
{
420 acpi_gpe_handler address
; /* Address of handler, if any */
421 void *context
; /* Context to be passed to handler */
422 struct acpi_namespace_node
*method_node
; /* Method node for this GPE level (saved) */
423 u8 original_flags
; /* Original (pre-handler) GPE info */
424 u8 originally_enabled
; /* True if GPE was originally enabled */
427 /* Notify info for implicit notify, multiple device objects */
429 struct acpi_gpe_notify_info
{
430 struct acpi_namespace_node
*device_node
; /* Device to be notified */
431 struct acpi_gpe_notify_info
*next
;
435 * GPE dispatch info. At any time, the GPE can have at most one type
436 * of dispatch - Method, Handler, or Implicit Notify.
438 union acpi_gpe_dispatch_info
{
439 struct acpi_namespace_node
*method_node
; /* Method node for this GPE level */
440 struct acpi_gpe_handler_info
*handler
; /* Installed GPE handler */
441 struct acpi_gpe_notify_info
*notify_list
; /* List of _PRW devices for implicit notifies */
445 * Information about a GPE, one per each GPE in an array.
446 * NOTE: Important to keep this struct as small as possible.
448 struct acpi_gpe_event_info
{
449 union acpi_gpe_dispatch_info dispatch
; /* Either Method, Handler, or notify_list */
450 struct acpi_gpe_register_info
*register_info
; /* Backpointer to register info */
451 u8 flags
; /* Misc info about this GPE */
452 u8 gpe_number
; /* This GPE */
453 u8 runtime_count
; /* References to a run GPE */
454 u8 disable_for_dispatch
; /* Masked during dispatching */
457 /* GPE register address */
459 struct acpi_gpe_address
{
460 u8 space_id
; /* Address space where the register exists */
461 u64 address
; /* 64-bit address of the register */
464 /* Information about a GPE register pair, one per each status/enable pair in an array */
466 struct acpi_gpe_register_info
{
467 struct acpi_gpe_address status_address
; /* Address of status reg */
468 struct acpi_gpe_address enable_address
; /* Address of enable reg */
469 u16 base_gpe_number
; /* Base GPE number for this register */
470 u8 enable_for_wake
; /* GPEs to keep enabled when sleeping */
471 u8 enable_for_run
; /* GPEs to keep enabled when running */
472 u8 mask_for_run
; /* GPEs to keep masked when running */
473 u8 enable_mask
; /* Current mask of enabled GPEs */
477 * Information about a GPE register block, one per each installed block --
478 * GPE0, GPE1, and one per each installed GPE Block Device.
480 struct acpi_gpe_block_info
{
481 struct acpi_namespace_node
*node
;
482 struct acpi_gpe_block_info
*previous
;
483 struct acpi_gpe_block_info
*next
;
484 struct acpi_gpe_xrupt_info
*xrupt_block
; /* Backpointer to interrupt block */
485 struct acpi_gpe_register_info
*register_info
; /* One per GPE register pair */
486 struct acpi_gpe_event_info
*event_info
; /* One for each GPE */
487 u64 address
; /* Base address of the block */
488 u32 register_count
; /* Number of register pairs in block */
489 u16 gpe_count
; /* Number of individual GPEs in block */
490 u16 block_base_number
; /* Base GPE number for this block */
492 u8 initialized
; /* TRUE if this block is initialized */
495 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
497 struct acpi_gpe_xrupt_info
{
498 struct acpi_gpe_xrupt_info
*previous
;
499 struct acpi_gpe_xrupt_info
*next
;
500 struct acpi_gpe_block_info
*gpe_block_list_head
; /* List of GPE blocks for this xrupt */
501 u32 interrupt_number
; /* System interrupt number */
504 struct acpi_gpe_walk_info
{
505 struct acpi_namespace_node
*gpe_device
;
506 struct acpi_gpe_block_info
*gpe_block
;
508 acpi_owner_id owner_id
;
509 u8 execute_by_owner_id
;
512 struct acpi_gpe_device_info
{
514 u32 next_block_base_index
;
516 struct acpi_namespace_node
*gpe_device
;
519 typedef acpi_status (*acpi_gpe_callback
) (struct acpi_gpe_xrupt_info
*
521 struct acpi_gpe_block_info
*
522 gpe_block
, void *context
);
524 /* Information about each particular fixed event */
526 struct acpi_fixed_event_handler
{
527 acpi_event_handler handler
; /* Address of handler. */
528 void *context
; /* Context to be passed to handler */
531 struct acpi_fixed_event_info
{
532 u8 status_register_id
;
533 u8 enable_register_id
;
538 /* Information used during field processing */
540 struct acpi_field_info
{
546 /*****************************************************************************
548 * Generic "state" object for stacks
550 ****************************************************************************/
552 #define ACPI_CONTROL_NORMAL 0xC0
553 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
554 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
555 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
556 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
558 #define ACPI_STATE_COMMON \
560 u8 descriptor_type; /* To differentiate various internal objs */\
565 /* There are 2 bytes available here until the next natural alignment boundary */
567 struct acpi_common_state
{
571 * Update state - used to traverse complex objects such as packages
573 struct acpi_update_state
{
574 ACPI_STATE_COMMON
union acpi_operand_object
*object
;
578 * Pkg state - used to traverse nested package structures
580 struct acpi_pkg_state
{
581 ACPI_STATE_COMMON u32 index
;
582 union acpi_operand_object
*source_object
;
583 union acpi_operand_object
*dest_object
;
584 struct acpi_walk_state
*walk_state
;
585 void *this_target_obj
;
590 * Control state - one per if/else and while constructs.
591 * Allows nesting of these constructs
593 struct acpi_control_state
{
594 ACPI_STATE_COMMON u16 opcode
;
595 union acpi_parse_object
*predicate_op
;
596 u8
*aml_predicate_start
; /* Start of if/while predicate */
597 u8
*package_end
; /* End of if/while block */
598 u64 loop_timeout
; /* While() loop timeout */
602 * Scope state - current scope during namespace lookups
604 struct acpi_scope_state
{
605 ACPI_STATE_COMMON
struct acpi_namespace_node
*node
;
608 struct acpi_pscope_state
{
609 ACPI_STATE_COMMON u32 arg_count
; /* Number of fixed arguments */
610 union acpi_parse_object
*op
; /* Current op being parsed */
611 u8
*arg_end
; /* Current argument end */
612 u8
*pkg_end
; /* Current package end */
613 u32 arg_list
; /* Next argument to parse */
617 * Thread state - one per thread across multiple walk states. Multiple walk
618 * states are created when there are nested control methods executing.
620 struct acpi_thread_state
{
621 ACPI_STATE_COMMON u8 current_sync_level
; /* Mutex Sync (nested acquire) level */
622 struct acpi_walk_state
*walk_state_list
; /* Head of list of walk_states for this thread */
623 union acpi_operand_object
*acquired_mutex_list
; /* List of all currently acquired mutexes */
624 acpi_thread_id thread_id
; /* Running thread ID */
628 * Result values - used to accumulate the results of nested
631 struct acpi_result_values
{
633 union acpi_operand_object
*obj_desc
[ACPI_RESULTS_FRAME_OBJ_NUM
];
637 acpi_status (*acpi_parse_downwards
) (struct acpi_walk_state
* walk_state
,
638 union acpi_parse_object
** out_op
);
641 acpi_status (*acpi_parse_upwards
) (struct acpi_walk_state
* walk_state
);
643 /* Global handlers for AML Notifies */
645 struct acpi_global_notify_handler
{
646 acpi_notify_handler handler
;
651 * Notify info - used to pass info to the deferred notify
652 * handler/dispatcher.
654 struct acpi_notify_info
{
655 ACPI_STATE_COMMON u8 handler_list_id
;
656 struct acpi_namespace_node
*node
;
657 union acpi_operand_object
*handler_list_head
;
658 struct acpi_global_notify_handler
*global
;
661 /* Generic state is union of structs above */
663 union acpi_generic_state
{
664 struct acpi_common_state common
;
665 struct acpi_control_state control
;
666 struct acpi_update_state update
;
667 struct acpi_scope_state scope
;
668 struct acpi_pscope_state parse_scope
;
669 struct acpi_pkg_state pkg
;
670 struct acpi_thread_state thread
;
671 struct acpi_result_values results
;
672 struct acpi_notify_info notify
;
675 /*****************************************************************************
677 * Interpreter typedefs and structs
679 ****************************************************************************/
682 acpi_status (*acpi_execute_op
) (struct acpi_walk_state
* walk_state
);
684 /* Address Range info block */
686 struct acpi_address_range
{
687 struct acpi_address_range
*next
;
688 struct acpi_namespace_node
*region_node
;
689 acpi_physical_address start_address
;
690 acpi_physical_address end_address
;
693 /*****************************************************************************
695 * Parser typedefs and structs
697 ****************************************************************************/
700 * AML opcode, name, and argument layout
702 struct acpi_opcode_info
{
703 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
704 char *name
; /* Opcode name (disassembler/debug only) */
706 u32 parse_args
; /* Grammar/Parse time arguments */
707 u32 runtime_args
; /* Interpret time arguments */
708 u16 flags
; /* Misc flags */
709 u8 object_type
; /* Corresponding internal object type */
710 u8
class; /* Opcode class */
711 u8 type
; /* Opcode type */
714 /* Value associated with the parse object */
716 union acpi_parse_value
{
717 u64 integer
; /* Integer constant (Up to 64 bits) */
718 u32 size
; /* bytelist or field size */
719 char *string
; /* NULL terminated string */
720 u8
*buffer
; /* buffer or string */
721 char *name
; /* NULL terminated string */
722 union acpi_parse_object
*arg
; /* arguments and contained ops */
725 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
726 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
728 #define ACPI_DISASM_ONLY_MEMBERS(a)
731 #if defined(ACPI_ASL_COMPILER)
732 #define ACPI_CONVERTER_ONLY_MEMBERS(a) a;
734 #define ACPI_CONVERTER_ONLY_MEMBERS(a)
737 #define ACPI_PARSE_COMMON \
738 union acpi_parse_object *parent; /* Parent op */\
739 u8 descriptor_type; /* To differentiate various internal objs */\
740 u8 flags; /* Type of Op */\
741 u16 aml_opcode; /* AML opcode */\
742 u8 *aml; /* Address of declaration in AML */\
743 union acpi_parse_object *next; /* Next op */\
744 struct acpi_namespace_node *node; /* For use by interpreter */\
745 union acpi_parse_value value; /* Value or args associated with the opcode */\
746 u8 arg_list_length; /* Number of elements in the arg list */\
747 ACPI_DISASM_ONLY_MEMBERS (\
748 u16 disasm_flags; /* Used during AML disassembly */\
749 u8 disasm_opcode; /* Subtype used for disassembly */\
750 char *operator_symbol; /* Used for C-style operator name strings */\
751 char aml_op_name[16]) /* Op name (debug only) */\
752 ACPI_CONVERTER_ONLY_MEMBERS (\
753 char *inline_comment; /* Inline comment */\
754 char *end_node_comment; /* End of node comment */\
755 char *name_comment; /* Comment associated with the first parameter of the name node */\
756 char *close_brace_comment; /* Comments that come after } on the same as } */\
757 struct acpi_comment_node *comment_list; /* comments that appears before this node */\
758 struct acpi_comment_node *end_blk_comment; /* comments that at the end of a block but before ) or } */\
759 char *cv_filename; /* Filename associated with this node. Used for ASL/ASL+ converter */\
760 char *cv_parent_filename) /* Parent filename associated with this node. Used for ASL/ASL+ converter */
762 /* categories of comments */
765 STANDARD_COMMENT
= 1,
773 PARENTFILENAME_COMMENT
,
778 /* Internal opcodes for disasm_opcode field above */
780 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
781 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
782 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
783 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
784 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
785 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
786 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
787 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
788 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */
789 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */
790 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
791 #define ACPI_DASM_IGNORE_SINGLE 0x0B /* Ignore the opcode but not it's children */
792 #define ACPI_DASM_SWITCH 0x0C /* While is a Switch */
793 #define ACPI_DASM_SWITCH_PREDICATE 0x0D /* Object is a predicate for a Switch or Case block */
794 #define ACPI_DASM_CASE 0x0E /* If/Else is a Case in a Switch/Case block */
795 #define ACPI_DASM_DEFAULT 0x0F /* Else is a Default in a Switch/Case block */
798 * List struct used in the -ca option
800 struct acpi_comment_node
{
802 struct acpi_comment_node
*next
;
805 struct acpi_comment_addr_node
{
807 struct acpi_comment_addr_node
*next
;
811 * File node - used for "Include" operator file stack and
812 * dependency tree for the -ca option
814 struct acpi_file_node
{
817 char *file_start
; /* Points to AML and indicates when the AML for this particular file starts. */
818 char *file_end
; /* Points to AML and indicates when the AML for this particular file ends. */
819 struct acpi_file_node
*next
;
820 struct acpi_file_node
*parent
;
822 struct acpi_comment_node
*include_comment
;
826 * Generic operation (for example: If, While, Store)
828 struct acpi_parse_obj_common
{
832 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
835 struct acpi_parse_obj_named
{
836 ACPI_PARSE_COMMON
char *path
;
837 u8
*data
; /* AML body or bytelist data */
838 u32 length
; /* AML length */
839 u32 name
; /* 4-byte name or zero if no name */
842 /* This version is used by the iASL compiler only */
844 #define ACPI_MAX_PARSEOP_NAME 20
846 struct acpi_parse_obj_asl
{
847 ACPI_PARSE_COMMON
union acpi_parse_object
*child
;
848 union acpi_parse_object
*parent_method
;
851 char *parent_filename
;
858 u32 logical_line_number
;
859 u32 logical_byte_offset
;
861 u32 end_logical_line
;
864 u32 aml_subtree_length
;
865 u32 final_aml_length
;
866 u32 final_aml_offset
;
869 u8 aml_opcode_length
;
870 u8 aml_pkg_len_bytes
;
872 char parse_op_name
[ACPI_MAX_PARSEOP_NAME
];
875 union acpi_parse_object
{
876 struct acpi_parse_obj_common common
;
877 struct acpi_parse_obj_named named
;
878 struct acpi_parse_obj_asl asl
;
881 struct asl_comment_state
{
884 union acpi_parse_object
*latest_parse_op
;
885 union acpi_parse_object
*parsing_paren_brace_node
;
890 * Parse state - one state per parser invocation and each control
893 struct acpi_parse_state
{
894 u8
*aml_start
; /* First AML byte */
895 u8
*aml
; /* Next AML byte */
896 u8
*aml_end
; /* (last + 1) AML byte */
897 u8
*pkg_start
; /* Current package begin */
898 u8
*pkg_end
; /* Current package end */
899 union acpi_parse_object
*start_op
; /* Root of parse tree */
900 struct acpi_namespace_node
*start_node
;
901 union acpi_generic_state
*scope
; /* Current scope */
902 union acpi_parse_object
*start_scope
;
906 /* Parse object flags */
908 #define ACPI_PARSEOP_GENERIC 0x01
909 #define ACPI_PARSEOP_NAMED_OBJECT 0x02
910 #define ACPI_PARSEOP_DEFERRED 0x04
911 #define ACPI_PARSEOP_BYTELIST 0x08
912 #define ACPI_PARSEOP_IN_STACK 0x10
913 #define ACPI_PARSEOP_TARGET 0x20
914 #define ACPI_PARSEOP_IN_CACHE 0x80
916 /* Parse object disasm_flags */
918 #define ACPI_PARSEOP_IGNORE 0x0001
919 #define ACPI_PARSEOP_PARAMETER_LIST 0x0002
920 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x0004
921 #define ACPI_PARSEOP_PREDEFINED_CHECKED 0x0008
922 #define ACPI_PARSEOP_CLOSING_PAREN 0x0010
923 #define ACPI_PARSEOP_COMPOUND_ASSIGNMENT 0x0020
924 #define ACPI_PARSEOP_ASSIGNMENT 0x0040
925 #define ACPI_PARSEOP_ELSEIF 0x0080
926 #define ACPI_PARSEOP_LEGACY_ASL_ONLY 0x0100
928 /*****************************************************************************
930 * Hardware (ACPI registers) and PNP
932 ****************************************************************************/
934 struct acpi_bit_register_info
{
941 * Some ACPI registers have bits that must be ignored -- meaning that they
944 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
946 /* Write-only bits must be zeroed by software */
948 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
950 /* For control registers, both ignored and reserved bits must be preserved */
953 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
954 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
955 * bit position", section 4.7.3.2.1. However, on some machines the OS must
956 * write a one to this bit after resume for the machine to work properly.
957 * To enable this, we no longer attempt to preserve this bit. No machines
958 * are known to fail if the bit is not preserved. (May 2009)
960 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
961 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
962 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
963 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
965 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
969 * These are the full ACPI registers
971 #define ACPI_REGISTER_PM1_STATUS 0x01
972 #define ACPI_REGISTER_PM1_ENABLE 0x02
973 #define ACPI_REGISTER_PM1_CONTROL 0x03
974 #define ACPI_REGISTER_PM2_CONTROL 0x04
975 #define ACPI_REGISTER_PM_TIMER 0x05
976 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
977 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
979 /* Masks used to access the bit_registers */
981 #define ACPI_BITMASK_TIMER_STATUS 0x0001
982 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
983 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
984 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
985 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
986 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
987 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
988 #define ACPI_BITMASK_WAKE_STATUS 0x8000
990 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
991 ACPI_BITMASK_TIMER_STATUS | \
992 ACPI_BITMASK_BUS_MASTER_STATUS | \
993 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
994 ACPI_BITMASK_POWER_BUTTON_STATUS | \
995 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
996 ACPI_BITMASK_RT_CLOCK_STATUS | \
997 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
998 ACPI_BITMASK_WAKE_STATUS)
1000 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
1001 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
1002 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
1003 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
1004 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
1005 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
1007 #define ACPI_BITMASK_SCI_ENABLE 0x0001
1008 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
1009 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
1010 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
1011 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
1013 #define ACPI_BITMASK_ARB_DISABLE 0x0001
1015 /* Raw bit position of each bit_register */
1017 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
1018 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
1019 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
1020 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
1021 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
1022 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
1023 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
1024 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
1026 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
1027 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
1028 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
1029 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
1030 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
1031 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
1033 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
1034 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
1035 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
1036 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
1037 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
1039 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
1041 /* Structs and definitions for _OSI support and I/O port validation */
1043 #define ACPI_ALWAYS_ILLEGAL 0x00
1045 struct acpi_interface_info
{
1047 struct acpi_interface_info
*next
;
1052 #define ACPI_OSI_INVALID 0x01
1053 #define ACPI_OSI_DYNAMIC 0x02
1054 #define ACPI_OSI_FEATURE 0x04
1055 #define ACPI_OSI_DEFAULT_INVALID 0x08
1056 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1058 struct acpi_port_info
{
1065 /*****************************************************************************
1067 * Resource descriptors
1069 ****************************************************************************/
1071 /* resource_type values */
1073 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1074 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1075 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1077 /* Resource descriptor types and masks */
1079 #define ACPI_RESOURCE_NAME_LARGE 0x80
1080 #define ACPI_RESOURCE_NAME_SMALL 0x00
1082 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1083 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1084 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1087 * Small resource descriptor "names" as defined by the ACPI specification.
1088 * Note: Bits 2:0 are used for the descriptor length
1090 #define ACPI_RESOURCE_NAME_IRQ 0x20
1091 #define ACPI_RESOURCE_NAME_DMA 0x28
1092 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1093 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1094 #define ACPI_RESOURCE_NAME_IO 0x40
1095 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1096 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1097 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1098 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1099 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1100 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1101 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1104 * Large resource descriptor "names" as defined by the ACPI specification.
1105 * Note: includes the Large Descriptor bit in bit[7]
1107 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1108 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1109 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1110 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1111 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1112 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1113 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1114 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1115 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1116 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1117 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1118 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1119 #define ACPI_RESOURCE_NAME_PIN_FUNCTION 0x8D
1120 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1121 #define ACPI_RESOURCE_NAME_PIN_CONFIG 0x8F
1122 #define ACPI_RESOURCE_NAME_PIN_GROUP 0x90
1123 #define ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION 0x91
1124 #define ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG 0x92
1125 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x92
1127 /*****************************************************************************
1131 ****************************************************************************/
1133 #define ACPI_ASCII_ZERO 0x30
1135 /*****************************************************************************
1139 ****************************************************************************/
1141 struct acpi_external_list
{
1143 char *internal_path
;
1144 struct acpi_external_list
*next
;
1151 /* Values for Flags field above */
1153 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1154 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1155 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1156 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1157 #define ACPI_EXT_ORIGIN_FROM_OPCODE 0x10 /* External came from a External() opcode */
1158 #define ACPI_EXT_CONFLICTING_DECLARATION 0x20 /* External has a conflicting declaration within AML */
1160 struct acpi_external_file
{
1162 struct acpi_external_file
*next
;
1165 struct acpi_parse_object_list
{
1166 union acpi_parse_object
*op
;
1167 struct acpi_parse_object_list
*next
;
1170 /*****************************************************************************
1174 ****************************************************************************/
1176 struct acpi_db_method_info
{
1178 acpi_handle main_thread_gate
;
1179 acpi_handle thread_complete_gate
;
1180 acpi_handle info_gate
;
1181 acpi_thread_id
*threads
;
1189 char pathname
[ACPI_DB_LINE_BUFFER_SIZE
];
1191 acpi_object_type
*types
;
1194 * Arguments to be passed to method for the commands Threads and
1195 * Background. Note, ACPI specifies a maximum of 7 arguments (0 - 6).
1197 * For the Threads command, the Number of threads, ID of current
1198 * thread and Index of current thread inside all them created.
1201 #ifdef ACPI_DEBUGGER
1202 acpi_object_type arg_types
[ACPI_METHOD_NUM_ARGS
];
1204 char *arguments
[ACPI_METHOD_NUM_ARGS
];
1205 char num_threads_str
[11];
1206 char id_of_thread_str
[11];
1207 char index_of_thread_str
[11];
1210 struct acpi_integrity_info
{
1215 #define ACPI_DB_DISABLE_OUTPUT 0x00
1216 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1217 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1218 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1220 struct acpi_object_info
{
1221 u32 types
[ACPI_TOTAL_TYPES
];
1224 /*****************************************************************************
1228 ****************************************************************************/
1230 /* Entry for a memory allocation (debug only) */
1232 #define ACPI_MEM_MALLOC 0
1233 #define ACPI_MEM_CALLOC 1
1234 #define ACPI_MAX_MODULE_NAME 16
1236 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1237 struct acpi_debug_mem_block *previous; \
1238 struct acpi_debug_mem_block *next; \
1242 char module[ACPI_MAX_MODULE_NAME]; \
1245 struct acpi_debug_mem_header
{
1246 ACPI_COMMON_DEBUG_MEM_HEADER
};
1248 struct acpi_debug_mem_block
{
1249 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space
;
1252 #define ACPI_MEM_LIST_GLOBAL 0
1253 #define ACPI_MEM_LIST_NSNODE 1
1254 #define ACPI_MEM_LIST_MAX 1
1255 #define ACPI_NUM_MEM_LISTS 2
1257 /*****************************************************************************
1261 ****************************************************************************/
1263 struct ah_predefined_name
{
1266 #ifndef ACPI_ASL_COMPILER
1271 struct ah_device_id
{
1286 #endif /* __ACLOCAL_H__ */