1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, 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 */
86 #define ACPI_MTX_DEBUG_CMD_COMPLETE 6 /* AML debugger */
87 #define ACPI_MTX_DEBUG_CMD_READY 7 /* AML debugger */
89 #define ACPI_MAX_MUTEX 7
90 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
92 /* Lock structure for reader/writer interfaces */
95 acpi_mutex writer_mutex;
96 acpi_mutex reader_mutex;
101 * Predefined handles for spinlocks used within the subsystem.
102 * These spinlocks are created by acpi_ut_mutex_initialize
104 #define ACPI_LOCK_GPES 0
105 #define ACPI_LOCK_HARDWARE 1
107 #define ACPI_MAX_LOCK 1
108 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
110 /* This Thread ID means that the mutex is not in use (unlocked) */
112 #define ACPI_MUTEX_NOT_ACQUIRED (acpi_thread_id) 0
114 /* Table for the global mutexes */
116 struct acpi_mutex_info {
119 acpi_thread_id thread_id;
122 /* Lock flag parameter for various interfaces */
124 #define ACPI_MTX_DO_NOT_LOCK 0
125 #define ACPI_MTX_LOCK 1
127 /* Field access granularities */
129 #define ACPI_FIELD_BYTE_GRANULARITY 1
130 #define ACPI_FIELD_WORD_GRANULARITY 2
131 #define ACPI_FIELD_DWORD_GRANULARITY 4
132 #define ACPI_FIELD_QWORD_GRANULARITY 8
134 #define ACPI_ENTRY_NOT_FOUND NULL
136 /*****************************************************************************
138 * Namespace typedefs and structs
140 ****************************************************************************/
142 /* Operational modes of the AML interpreter/scanner */
145 ACPI_IMODE_LOAD_PASS1 = 0x01,
146 ACPI_IMODE_LOAD_PASS2 = 0x02,
147 ACPI_IMODE_EXECUTE = 0x03
148 } acpi_interpreter_mode;
151 * The Namespace Node describes a named object that appears in the AML.
152 * descriptor_type is used to differentiate between internal descriptors.
154 * The node is optimized for both 32-bit and 64-bit platforms:
155 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
157 * Note: The descriptor_type and Type fields must appear in the identical
158 * position in both the struct acpi_namespace_node and union acpi_operand_object
161 struct acpi_namespace_node {
162 union acpi_operand_object *object; /* Interpreter object */
163 u8 descriptor_type; /* Differentiate object descriptor types */
164 u8 type; /* ACPI Type associated with this name */
165 u8 flags; /* Miscellaneous flags */
166 acpi_owner_id owner_id; /* Node creator */
167 union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */
168 struct acpi_namespace_node *parent; /* Parent node */
169 struct acpi_namespace_node *child; /* First child */
170 struct acpi_namespace_node *peer; /* First peer */
173 * The following fields are used by the ASL compiler and disassembler only
175 #ifdef ACPI_LARGE_NAMESPACE_NODE
176 union acpi_parse_object *op;
186 /* Namespace Node flags */
188 #define ANOBJ_RESERVED 0x01 /* Available for use */
189 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
190 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
191 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
192 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
193 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
194 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
196 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
197 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
198 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
199 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
201 /* Internal ACPI table management - master table list */
203 struct acpi_table_list {
204 struct acpi_table_desc *tables; /* Table descriptor array */
205 u32 current_table_count; /* Tables currently in the array */
206 u32 max_table_count; /* Max tables array will hold */
210 /* Flags for above */
212 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
213 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
214 #define ACPI_ROOT_ALLOW_RESIZE (2)
216 /* Predefined table indexes */
218 #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF)
220 struct acpi_find_context {
226 struct acpi_ns_search_data {
227 struct acpi_namespace_node *node;
230 /* Object types used during package copies */
232 #define ACPI_COPY_TYPE_SIMPLE 0
233 #define ACPI_COPY_TYPE_PACKAGE 1
235 /* Info structure used to convert external<->internal namestrings */
237 struct acpi_namestring_info {
238 const char *external_name;
239 const char *next_external_char;
247 /* Field creation info */
249 struct acpi_create_field_info {
250 struct acpi_namespace_node *region_node;
251 struct acpi_namespace_node *field_node;
252 struct acpi_namespace_node *register_node;
253 struct acpi_namespace_node *data_register_node;
254 struct acpi_namespace_node *connection_node;
257 u32 field_bit_position;
258 u32 field_bit_length;
260 u16 pin_number_index;
268 acpi_status(*acpi_internal_method) (struct acpi_walk_state * walk_state);
271 * Bitmapped ACPI types. Used internally only
273 #define ACPI_BTYPE_ANY 0x00000000
274 #define ACPI_BTYPE_INTEGER 0x00000001
275 #define ACPI_BTYPE_STRING 0x00000002
276 #define ACPI_BTYPE_BUFFER 0x00000004
277 #define ACPI_BTYPE_PACKAGE 0x00000008
278 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
279 #define ACPI_BTYPE_DEVICE 0x00000020
280 #define ACPI_BTYPE_EVENT 0x00000040
281 #define ACPI_BTYPE_METHOD 0x00000080
282 #define ACPI_BTYPE_MUTEX 0x00000100
283 #define ACPI_BTYPE_REGION 0x00000200
284 #define ACPI_BTYPE_POWER 0x00000400
285 #define ACPI_BTYPE_PROCESSOR 0x00000800
286 #define ACPI_BTYPE_THERMAL 0x00001000
287 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
288 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
289 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
290 #define ACPI_BTYPE_REFERENCE 0x00010000
291 #define ACPI_BTYPE_RESOURCE 0x00020000
293 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
295 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
296 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
297 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
298 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
299 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
304 * Information structure for ACPI predefined names.
305 * Each entry in the table contains the following items:
307 * name - The ACPI reserved name
308 * param_count - Number of arguments to the method
309 * expected_return_btypes - Allowed type(s) for the return value
311 struct acpi_name_info {
312 char name[ACPI_NAME_SIZE];
318 * Secondary information structures for ACPI predefined objects that return
319 * package objects. This structure appears as the next entry in the table
320 * after the NAME_INFO structure above.
322 * The reason for this is to minimize the size of the predefined name table.
326 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
327 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
328 * ACPI_PTYPE2_FIX_VAR
330 struct acpi_package_info {
339 /* Used for ACPI_PTYPE2_FIXED */
341 struct acpi_package_info2 {
348 /* Used for ACPI_PTYPE1_OPTION */
350 struct acpi_package_info3 {
358 struct acpi_package_info4 {
367 union acpi_predefined_info {
368 struct acpi_name_info info;
369 struct acpi_package_info ret_info;
370 struct acpi_package_info2 ret_info2;
371 struct acpi_package_info3 ret_info3;
372 struct acpi_package_info4 ret_info4;
375 /* Reset to default packing */
379 /* Return object auto-repair info */
381 typedef acpi_status(*acpi_object_converter) (union acpi_operand_object
383 union acpi_operand_object
386 struct acpi_simple_repair_info {
387 char name[ACPI_NAME_SIZE];
388 u32 unexpected_btypes;
390 acpi_object_converter object_converter;
394 * Bitmapped return value types
395 * Note: the actual data types must be contiguous, a loop in nspredef.c
398 #define ACPI_RTYPE_ANY 0x00
399 #define ACPI_RTYPE_NONE 0x01
400 #define ACPI_RTYPE_INTEGER 0x02
401 #define ACPI_RTYPE_STRING 0x04
402 #define ACPI_RTYPE_BUFFER 0x08
403 #define ACPI_RTYPE_PACKAGE 0x10
404 #define ACPI_RTYPE_REFERENCE 0x20
405 #define ACPI_RTYPE_ALL 0x3F
407 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
409 /* Info for running the _REG methods */
411 struct acpi_reg_walk_info {
412 acpi_adr_space_type space_id;
416 /*****************************************************************************
418 * Event typedefs and structs
420 ****************************************************************************/
422 /* Dispatch info for each host-installed SCI handler */
424 struct acpi_sci_handler_info {
425 struct acpi_sci_handler_info *next;
426 acpi_sci_handler address; /* Address of handler */
427 void *context; /* Context to be passed to handler */
430 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
432 struct acpi_gpe_handler_info {
433 acpi_gpe_handler address; /* Address of handler, if any */
434 void *context; /* Context to be passed to handler */
435 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
436 u8 original_flags; /* Original (pre-handler) GPE info */
437 u8 originally_enabled; /* True if GPE was originally enabled */
440 /* Notify info for implicit notify, multiple device objects */
442 struct acpi_gpe_notify_info {
443 struct acpi_namespace_node *device_node; /* Device to be notified */
444 struct acpi_gpe_notify_info *next;
448 * GPE dispatch info. At any time, the GPE can have at most one type
449 * of dispatch - Method, Handler, or Implicit Notify.
451 union acpi_gpe_dispatch_info {
452 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
453 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */
454 struct acpi_gpe_notify_info *notify_list; /* List of _PRW devices for implicit notifies */
458 * Information about a GPE, one per each GPE in an array.
459 * NOTE: Important to keep this struct as small as possible.
461 struct acpi_gpe_event_info {
462 union acpi_gpe_dispatch_info dispatch; /* Either Method, Handler, or notify_list */
463 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
464 u8 flags; /* Misc info about this GPE */
465 u8 gpe_number; /* This GPE */
466 u8 runtime_count; /* References to a run GPE */
469 /* Information about a GPE register pair, one per each status/enable pair in an array */
471 struct acpi_gpe_register_info {
472 struct acpi_generic_address status_address; /* Address of status reg */
473 struct acpi_generic_address enable_address; /* Address of enable reg */
474 u16 base_gpe_number; /* Base GPE number for this register */
475 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
476 u8 enable_for_run; /* GPEs to keep enabled when running */
477 u8 enable_mask; /* Current mask of enabled GPEs */
481 * Information about a GPE register block, one per each installed block --
482 * GPE0, GPE1, and one per each installed GPE Block Device.
484 struct acpi_gpe_block_info {
485 struct acpi_namespace_node *node;
486 struct acpi_gpe_block_info *previous;
487 struct acpi_gpe_block_info *next;
488 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
489 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
490 struct acpi_gpe_event_info *event_info; /* One for each GPE */
491 u64 address; /* Base address of the block */
492 u32 register_count; /* Number of register pairs in block */
493 u16 gpe_count; /* Number of individual GPEs in block */
494 u16 block_base_number; /* Base GPE number for this block */
496 u8 initialized; /* TRUE if this block is initialized */
499 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
501 struct acpi_gpe_xrupt_info {
502 struct acpi_gpe_xrupt_info *previous;
503 struct acpi_gpe_xrupt_info *next;
504 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
505 u32 interrupt_number; /* System interrupt number */
508 struct acpi_gpe_walk_info {
509 struct acpi_namespace_node *gpe_device;
510 struct acpi_gpe_block_info *gpe_block;
512 acpi_owner_id owner_id;
513 u8 execute_by_owner_id;
516 struct acpi_gpe_device_info {
518 u32 next_block_base_index;
520 struct acpi_namespace_node *gpe_device;
523 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
525 struct acpi_gpe_block_info *gpe_block,
528 /* Information about each particular fixed event */
530 struct acpi_fixed_event_handler {
531 acpi_event_handler handler; /* Address of handler. */
532 void *context; /* Context to be passed to handler */
535 struct acpi_fixed_event_info {
536 u8 status_register_id;
537 u8 enable_register_id;
542 /* Information used during field processing */
544 struct acpi_field_info {
550 /*****************************************************************************
552 * Generic "state" object for stacks
554 ****************************************************************************/
556 #define ACPI_CONTROL_NORMAL 0xC0
557 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
558 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
559 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
560 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
562 #define ACPI_STATE_COMMON \
564 u8 descriptor_type; /* To differentiate various internal objs */\
569 /* There are 2 bytes available here until the next natural alignment boundary */
571 struct acpi_common_state {
575 * Update state - used to traverse complex objects such as packages
577 struct acpi_update_state {
578 ACPI_STATE_COMMON union acpi_operand_object *object;
582 * Pkg state - used to traverse nested package structures
584 struct acpi_pkg_state {
585 ACPI_STATE_COMMON u16 index;
586 union acpi_operand_object *source_object;
587 union acpi_operand_object *dest_object;
588 struct acpi_walk_state *walk_state;
589 void *this_target_obj;
594 * Control state - one per if/else and while constructs.
595 * Allows nesting of these constructs
597 struct acpi_control_state {
598 ACPI_STATE_COMMON u16 opcode;
599 union acpi_parse_object *predicate_op;
600 u8 *aml_predicate_start; /* Start of if/while predicate */
601 u8 *package_end; /* End of if/while block */
602 u32 loop_count; /* While() loop counter */
606 * Scope state - current scope during namespace lookups
608 struct acpi_scope_state {
609 ACPI_STATE_COMMON struct acpi_namespace_node *node;
612 struct acpi_pscope_state {
613 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
614 union acpi_parse_object *op; /* Current op being parsed */
615 u8 *arg_end; /* Current argument end */
616 u8 *pkg_end; /* Current package end */
617 u32 arg_list; /* Next argument to parse */
621 * Thread state - one per thread across multiple walk states. Multiple walk
622 * states are created when there are nested control methods executing.
624 struct acpi_thread_state {
625 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
626 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
627 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
628 acpi_thread_id thread_id; /* Running thread ID */
632 * Result values - used to accumulate the results of nested
635 struct acpi_result_values {
637 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
641 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
642 union acpi_parse_object ** out_op);
644 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
646 /* Global handlers for AML Notifies */
648 struct acpi_global_notify_handler {
649 acpi_notify_handler handler;
654 * Notify info - used to pass info to the deferred notify
655 * handler/dispatcher.
657 struct acpi_notify_info {
658 ACPI_STATE_COMMON u8 handler_list_id;
659 struct acpi_namespace_node *node;
660 union acpi_operand_object *handler_list_head;
661 struct acpi_global_notify_handler *global;
664 /* Generic state is union of structs above */
666 union acpi_generic_state {
667 struct acpi_common_state common;
668 struct acpi_control_state control;
669 struct acpi_update_state update;
670 struct acpi_scope_state scope;
671 struct acpi_pscope_state parse_scope;
672 struct acpi_pkg_state pkg;
673 struct acpi_thread_state thread;
674 struct acpi_result_values results;
675 struct acpi_notify_info notify;
678 /*****************************************************************************
680 * Interpreter typedefs and structs
682 ****************************************************************************/
684 typedef acpi_status(*acpi_execute_op) (struct acpi_walk_state * walk_state);
686 /* Address Range info block */
688 struct acpi_address_range {
689 struct acpi_address_range *next;
690 struct acpi_namespace_node *region_node;
691 acpi_physical_address start_address;
692 acpi_physical_address end_address;
695 /*****************************************************************************
697 * Parser typedefs and structs
699 ****************************************************************************/
702 * AML opcode, name, and argument layout
704 struct acpi_opcode_info {
705 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
706 char *name; /* Opcode name (disassembler/debug only) */
708 u32 parse_args; /* Grammar/Parse time arguments */
709 u32 runtime_args; /* Interpret time arguments */
710 u16 flags; /* Misc flags */
711 u8 object_type; /* Corresponding internal object type */
712 u8 class; /* Opcode class */
713 u8 type; /* Opcode type */
716 /* Value associated with the parse object */
718 union acpi_parse_value {
719 u64 integer; /* Integer constant (Up to 64 bits) */
720 u32 size; /* bytelist or field size */
721 char *string; /* NULL terminated string */
722 u8 *buffer; /* buffer or string */
723 char *name; /* NULL terminated string */
724 union acpi_parse_object *arg; /* arguments and contained ops */
727 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
728 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
730 #define ACPI_DISASM_ONLY_MEMBERS(a)
733 #define ACPI_PARSE_COMMON \
734 union acpi_parse_object *parent; /* Parent op */\
735 u8 descriptor_type; /* To differentiate various internal objs */\
736 u8 flags; /* Type of Op */\
737 u16 aml_opcode; /* AML opcode */\
738 u8 *aml; /* Address of declaration in AML */\
739 union acpi_parse_object *next; /* Next op */\
740 struct acpi_namespace_node *node; /* For use by interpreter */\
741 union acpi_parse_value value; /* Value or args associated with the opcode */\
742 u8 arg_list_length; /* Number of elements in the arg list */\
743 ACPI_DISASM_ONLY_MEMBERS (\
744 u8 disasm_flags; /* Used during AML disassembly */\
745 u8 disasm_opcode; /* Subtype used for disassembly */\
746 char *operator_symbol;/* Used for C-style operator name strings */\
747 char aml_op_name[16]) /* Op name (debug only) */
749 /* Flags for disasm_flags field above */
751 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
752 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
753 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
754 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
755 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
756 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
757 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
758 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
759 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */
760 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */
761 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
762 #define ACPI_DASM_IGNORE 0x0B /* Not used at this time */
765 * Generic operation (for example: If, While, Store)
767 struct acpi_parse_obj_common {
771 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
774 struct acpi_parse_obj_named {
775 ACPI_PARSE_COMMON u8 *path;
776 u8 *data; /* AML body or bytelist data */
777 u32 length; /* AML length */
778 u32 name; /* 4-byte name or zero if no name */
781 /* This version is used by the iASL compiler only */
783 #define ACPI_MAX_PARSEOP_NAME 20
785 struct acpi_parse_obj_asl {
786 ACPI_PARSE_COMMON union acpi_parse_object *child;
787 union acpi_parse_object *parent_method;
795 u32 logical_line_number;
796 u32 logical_byte_offset;
798 u32 end_logical_line;
801 u32 aml_subtree_length;
802 u32 final_aml_length;
803 u32 final_aml_offset;
806 u8 aml_opcode_length;
807 u8 aml_pkg_len_bytes;
809 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
812 union acpi_parse_object {
813 struct acpi_parse_obj_common common;
814 struct acpi_parse_obj_named named;
815 struct acpi_parse_obj_asl asl;
819 * Parse state - one state per parser invocation and each control
822 struct acpi_parse_state {
823 u8 *aml_start; /* First AML byte */
824 u8 *aml; /* Next AML byte */
825 u8 *aml_end; /* (last + 1) AML byte */
826 u8 *pkg_start; /* Current package begin */
827 u8 *pkg_end; /* Current package end */
828 union acpi_parse_object *start_op; /* Root of parse tree */
829 struct acpi_namespace_node *start_node;
830 union acpi_generic_state *scope; /* Current scope */
831 union acpi_parse_object *start_scope;
835 /* Parse object flags */
837 #define ACPI_PARSEOP_GENERIC 0x01
838 #define ACPI_PARSEOP_NAMED 0x02
839 #define ACPI_PARSEOP_DEFERRED 0x04
840 #define ACPI_PARSEOP_BYTELIST 0x08
841 #define ACPI_PARSEOP_IN_STACK 0x10
842 #define ACPI_PARSEOP_TARGET 0x20
843 #define ACPI_PARSEOP_IN_CACHE 0x80
845 /* Parse object disasm_flags */
847 #define ACPI_PARSEOP_IGNORE 0x01
848 #define ACPI_PARSEOP_PARAMLIST 0x02
849 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
850 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
851 #define ACPI_PARSEOP_SPECIAL 0x10
852 #define ACPI_PARSEOP_COMPOUND 0x20
853 #define ACPI_PARSEOP_ASSIGNMENT 0x40
855 /*****************************************************************************
857 * Hardware (ACPI registers) and PNP
859 ****************************************************************************/
861 struct acpi_bit_register_info {
868 * Some ACPI registers have bits that must be ignored -- meaning that they
871 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
873 /* Write-only bits must be zeroed by software */
875 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
877 /* For control registers, both ignored and reserved bits must be preserved */
880 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
881 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
882 * bit position", section 4.7.3.2.1. However, on some machines the OS must
883 * write a one to this bit after resume for the machine to work properly.
884 * To enable this, we no longer attempt to preserve this bit. No machines
885 * are known to fail if the bit is not preserved. (May 2009)
887 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
888 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
889 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
890 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
892 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
896 * These are the full ACPI registers
898 #define ACPI_REGISTER_PM1_STATUS 0x01
899 #define ACPI_REGISTER_PM1_ENABLE 0x02
900 #define ACPI_REGISTER_PM1_CONTROL 0x03
901 #define ACPI_REGISTER_PM2_CONTROL 0x04
902 #define ACPI_REGISTER_PM_TIMER 0x05
903 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
904 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
906 /* Masks used to access the bit_registers */
908 #define ACPI_BITMASK_TIMER_STATUS 0x0001
909 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
910 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
911 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
912 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
913 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
914 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
915 #define ACPI_BITMASK_WAKE_STATUS 0x8000
917 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
918 ACPI_BITMASK_TIMER_STATUS | \
919 ACPI_BITMASK_BUS_MASTER_STATUS | \
920 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
921 ACPI_BITMASK_POWER_BUTTON_STATUS | \
922 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
923 ACPI_BITMASK_RT_CLOCK_STATUS | \
924 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
925 ACPI_BITMASK_WAKE_STATUS)
927 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
928 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
929 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
930 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
931 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
932 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
934 #define ACPI_BITMASK_SCI_ENABLE 0x0001
935 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
936 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
937 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
938 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
940 #define ACPI_BITMASK_ARB_DISABLE 0x0001
942 /* Raw bit position of each bit_register */
944 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
945 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
946 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
947 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
948 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
949 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
950 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
951 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
953 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
954 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
955 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
956 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
957 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
958 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
960 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
961 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
962 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
963 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
964 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
966 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
968 /* Structs and definitions for _OSI support and I/O port validation */
970 #define ACPI_ALWAYS_ILLEGAL 0x00
972 struct acpi_interface_info {
974 struct acpi_interface_info *next;
979 #define ACPI_OSI_INVALID 0x01
980 #define ACPI_OSI_DYNAMIC 0x02
981 #define ACPI_OSI_FEATURE 0x04
982 #define ACPI_OSI_DEFAULT_INVALID 0x08
983 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
985 struct acpi_port_info {
992 /*****************************************************************************
994 * Resource descriptors
996 ****************************************************************************/
998 /* resource_type values */
1000 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1001 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1002 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1004 /* Resource descriptor types and masks */
1006 #define ACPI_RESOURCE_NAME_LARGE 0x80
1007 #define ACPI_RESOURCE_NAME_SMALL 0x00
1009 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1010 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1011 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1014 * Small resource descriptor "names" as defined by the ACPI specification.
1015 * Note: Bits 2:0 are used for the descriptor length
1017 #define ACPI_RESOURCE_NAME_IRQ 0x20
1018 #define ACPI_RESOURCE_NAME_DMA 0x28
1019 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1020 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1021 #define ACPI_RESOURCE_NAME_IO 0x40
1022 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1023 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1024 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1025 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1026 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1027 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1028 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1031 * Large resource descriptor "names" as defined by the ACPI specification.
1032 * Note: includes the Large Descriptor bit in bit[7]
1034 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1035 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1036 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1037 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1038 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1039 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1040 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1041 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1042 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1043 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1044 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1045 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1046 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1047 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1049 /*****************************************************************************
1053 ****************************************************************************/
1055 #define ACPI_ASCII_ZERO 0x30
1057 /*****************************************************************************
1061 ****************************************************************************/
1063 struct acpi_external_list {
1065 char *internal_path;
1066 struct acpi_external_list *next;
1073 /* Values for Flags field above */
1075 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1076 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1077 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1078 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1080 struct acpi_external_file {
1082 struct acpi_external_file *next;
1085 /*****************************************************************************
1089 ****************************************************************************/
1091 struct acpi_db_method_info {
1093 acpi_handle main_thread_gate;
1094 acpi_handle thread_complete_gate;
1095 acpi_handle info_gate;
1096 acpi_thread_id *threads;
1104 char pathname[ACPI_DB_LINE_BUFFER_SIZE];
1106 acpi_object_type *types;
1109 * Arguments to be passed to method for the command
1111 * the Number of threads, ID of current thread and
1112 * Index of current thread inside all them created.
1115 #ifdef ACPI_DEBUGGER
1116 acpi_object_type arg_types[4];
1119 char num_threads_str[11];
1120 char id_of_thread_str[11];
1121 char index_of_thread_str[11];
1124 struct acpi_integrity_info {
1129 #define ACPI_DB_DISABLE_OUTPUT 0x00
1130 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1131 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1132 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1134 struct acpi_object_info {
1135 u32 types[ACPI_TOTAL_TYPES];
1138 /*****************************************************************************
1142 ****************************************************************************/
1144 /* Entry for a memory allocation (debug only) */
1146 #define ACPI_MEM_MALLOC 0
1147 #define ACPI_MEM_CALLOC 1
1148 #define ACPI_MAX_MODULE_NAME 16
1150 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1151 struct acpi_debug_mem_block *previous; \
1152 struct acpi_debug_mem_block *next; \
1156 char module[ACPI_MAX_MODULE_NAME]; \
1159 struct acpi_debug_mem_header {
1160 ACPI_COMMON_DEBUG_MEM_HEADER};
1162 struct acpi_debug_mem_block {
1163 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1166 #define ACPI_MEM_LIST_GLOBAL 0
1167 #define ACPI_MEM_LIST_NSNODE 1
1168 #define ACPI_MEM_LIST_MAX 1
1169 #define ACPI_NUM_MEM_LISTS 2
1171 /*****************************************************************************
1175 ****************************************************************************/
1177 struct ah_predefined_name {
1180 #ifndef ACPI_ASL_COMPILER
1185 struct ah_device_id {
1200 #endif /* __ACLOCAL_H__ */