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;
182 /* Namespace Node flags */
184 #define ANOBJ_RESERVED 0x01 /* Available for use */
185 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
186 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
187 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
188 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
189 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
190 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
192 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
193 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
194 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
195 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
197 /* Internal ACPI table management - master table list */
199 struct acpi_table_list {
200 struct acpi_table_desc *tables; /* Table descriptor array */
201 u32 current_table_count; /* Tables currently in the array */
202 u32 max_table_count; /* Max tables array will hold */
206 /* Flags for above */
208 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
209 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
210 #define ACPI_ROOT_ALLOW_RESIZE (2)
212 /* Predefined (fixed) table indexes */
214 #define ACPI_TABLE_INDEX_DSDT (0)
215 #define ACPI_TABLE_INDEX_FACS (1)
217 struct acpi_find_context {
223 struct acpi_ns_search_data {
224 struct acpi_namespace_node *node;
227 /* Object types used during package copies */
229 #define ACPI_COPY_TYPE_SIMPLE 0
230 #define ACPI_COPY_TYPE_PACKAGE 1
232 /* Info structure used to convert external<->internal namestrings */
234 struct acpi_namestring_info {
235 const char *external_name;
236 const char *next_external_char;
244 /* Field creation info */
246 struct acpi_create_field_info {
247 struct acpi_namespace_node *region_node;
248 struct acpi_namespace_node *field_node;
249 struct acpi_namespace_node *register_node;
250 struct acpi_namespace_node *data_register_node;
251 struct acpi_namespace_node *connection_node;
254 u32 field_bit_position;
255 u32 field_bit_length;
257 u16 pin_number_index;
265 acpi_status(*acpi_internal_method) (struct acpi_walk_state * walk_state);
268 * Bitmapped ACPI types. Used internally only
270 #define ACPI_BTYPE_ANY 0x00000000
271 #define ACPI_BTYPE_INTEGER 0x00000001
272 #define ACPI_BTYPE_STRING 0x00000002
273 #define ACPI_BTYPE_BUFFER 0x00000004
274 #define ACPI_BTYPE_PACKAGE 0x00000008
275 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
276 #define ACPI_BTYPE_DEVICE 0x00000020
277 #define ACPI_BTYPE_EVENT 0x00000040
278 #define ACPI_BTYPE_METHOD 0x00000080
279 #define ACPI_BTYPE_MUTEX 0x00000100
280 #define ACPI_BTYPE_REGION 0x00000200
281 #define ACPI_BTYPE_POWER 0x00000400
282 #define ACPI_BTYPE_PROCESSOR 0x00000800
283 #define ACPI_BTYPE_THERMAL 0x00001000
284 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
285 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
286 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
287 #define ACPI_BTYPE_REFERENCE 0x00010000
288 #define ACPI_BTYPE_RESOURCE 0x00020000
290 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
292 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
293 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
294 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
295 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
296 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
301 * Information structure for ACPI predefined names.
302 * Each entry in the table contains the following items:
304 * name - The ACPI reserved name
305 * param_count - Number of arguments to the method
306 * expected_return_btypes - Allowed type(s) for the return value
308 struct acpi_name_info {
309 char name[ACPI_NAME_SIZE];
315 * Secondary information structures for ACPI predefined objects that return
316 * package objects. This structure appears as the next entry in the table
317 * after the NAME_INFO structure above.
319 * The reason for this is to minimize the size of the predefined name table.
323 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
324 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
325 * ACPI_PTYPE2_FIX_VAR
327 struct acpi_package_info {
336 /* Used for ACPI_PTYPE2_FIXED */
338 struct acpi_package_info2 {
345 /* Used for ACPI_PTYPE1_OPTION */
347 struct acpi_package_info3 {
355 struct acpi_package_info4 {
364 union acpi_predefined_info {
365 struct acpi_name_info info;
366 struct acpi_package_info ret_info;
367 struct acpi_package_info2 ret_info2;
368 struct acpi_package_info3 ret_info3;
369 struct acpi_package_info4 ret_info4;
372 /* Reset to default packing */
376 /* Return object auto-repair info */
378 typedef acpi_status(*acpi_object_converter) (union acpi_operand_object
380 union acpi_operand_object
383 struct acpi_simple_repair_info {
384 char name[ACPI_NAME_SIZE];
385 u32 unexpected_btypes;
387 acpi_object_converter object_converter;
391 * Bitmapped return value types
392 * Note: the actual data types must be contiguous, a loop in nspredef.c
395 #define ACPI_RTYPE_ANY 0x00
396 #define ACPI_RTYPE_NONE 0x01
397 #define ACPI_RTYPE_INTEGER 0x02
398 #define ACPI_RTYPE_STRING 0x04
399 #define ACPI_RTYPE_BUFFER 0x08
400 #define ACPI_RTYPE_PACKAGE 0x10
401 #define ACPI_RTYPE_REFERENCE 0x20
402 #define ACPI_RTYPE_ALL 0x3F
404 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
406 /*****************************************************************************
408 * Event typedefs and structs
410 ****************************************************************************/
412 /* Dispatch info for each host-installed SCI handler */
414 struct acpi_sci_handler_info {
415 struct acpi_sci_handler_info *next;
416 acpi_sci_handler address; /* Address of handler */
417 void *context; /* Context to be passed to handler */
420 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
422 struct acpi_gpe_handler_info {
423 acpi_gpe_handler address; /* Address of handler, if any */
424 void *context; /* Context to be passed to handler */
425 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
426 u8 original_flags; /* Original (pre-handler) GPE info */
427 u8 originally_enabled; /* True if GPE was originally enabled */
430 /* Notify info for implicit notify, multiple device objects */
432 struct acpi_gpe_notify_info {
433 struct acpi_namespace_node *device_node; /* Device to be notified */
434 struct acpi_gpe_notify_info *next;
438 * GPE dispatch info. At any time, the GPE can have at most one type
439 * of dispatch - Method, Handler, or Implicit Notify.
441 union acpi_gpe_dispatch_info {
442 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
443 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */
444 struct acpi_gpe_notify_info *notify_list; /* List of _PRW devices for implicit notifies */
448 * Information about a GPE, one per each GPE in an array.
449 * NOTE: Important to keep this struct as small as possible.
451 struct acpi_gpe_event_info {
452 union acpi_gpe_dispatch_info dispatch; /* Either Method, Handler, or notify_list */
453 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
454 u8 flags; /* Misc info about this GPE */
455 u8 gpe_number; /* This GPE */
456 u8 runtime_count; /* References to a run GPE */
459 /* Information about a GPE register pair, one per each status/enable pair in an array */
461 struct acpi_gpe_register_info {
462 struct acpi_generic_address status_address; /* Address of status reg */
463 struct acpi_generic_address enable_address; /* Address of enable reg */
464 u16 base_gpe_number; /* Base GPE number for this register */
465 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
466 u8 enable_for_run; /* GPEs to keep enabled when running */
467 u8 enable_mask; /* Current mask of enabled GPEs */
471 * Information about a GPE register block, one per each installed block --
472 * GPE0, GPE1, and one per each installed GPE Block Device.
474 struct acpi_gpe_block_info {
475 struct acpi_namespace_node *node;
476 struct acpi_gpe_block_info *previous;
477 struct acpi_gpe_block_info *next;
478 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
479 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
480 struct acpi_gpe_event_info *event_info; /* One for each GPE */
481 u64 address; /* Base address of the block */
482 u32 register_count; /* Number of register pairs in block */
483 u16 gpe_count; /* Number of individual GPEs in block */
484 u16 block_base_number; /* Base GPE number for this block */
486 u8 initialized; /* TRUE if this block is initialized */
489 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
491 struct acpi_gpe_xrupt_info {
492 struct acpi_gpe_xrupt_info *previous;
493 struct acpi_gpe_xrupt_info *next;
494 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
495 u32 interrupt_number; /* System interrupt number */
498 struct acpi_gpe_walk_info {
499 struct acpi_namespace_node *gpe_device;
500 struct acpi_gpe_block_info *gpe_block;
502 acpi_owner_id owner_id;
503 u8 execute_by_owner_id;
506 struct acpi_gpe_device_info {
508 u32 next_block_base_index;
510 struct acpi_namespace_node *gpe_device;
513 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
515 struct acpi_gpe_block_info *gpe_block,
518 /* Information about each particular fixed event */
520 struct acpi_fixed_event_handler {
521 acpi_event_handler handler; /* Address of handler. */
522 void *context; /* Context to be passed to handler */
525 struct acpi_fixed_event_info {
526 u8 status_register_id;
527 u8 enable_register_id;
532 /* Information used during field processing */
534 struct acpi_field_info {
540 /*****************************************************************************
542 * Generic "state" object for stacks
544 ****************************************************************************/
546 #define ACPI_CONTROL_NORMAL 0xC0
547 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
548 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
549 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
550 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
552 #define ACPI_STATE_COMMON \
554 u8 descriptor_type; /* To differentiate various internal objs */\
559 /* There are 2 bytes available here until the next natural alignment boundary */
561 struct acpi_common_state {
565 * Update state - used to traverse complex objects such as packages
567 struct acpi_update_state {
568 ACPI_STATE_COMMON union acpi_operand_object *object;
572 * Pkg state - used to traverse nested package structures
574 struct acpi_pkg_state {
575 ACPI_STATE_COMMON u16 index;
576 union acpi_operand_object *source_object;
577 union acpi_operand_object *dest_object;
578 struct acpi_walk_state *walk_state;
579 void *this_target_obj;
584 * Control state - one per if/else and while constructs.
585 * Allows nesting of these constructs
587 struct acpi_control_state {
588 ACPI_STATE_COMMON u16 opcode;
589 union acpi_parse_object *predicate_op;
590 u8 *aml_predicate_start; /* Start of if/while predicate */
591 u8 *package_end; /* End of if/while block */
592 u32 loop_count; /* While() loop counter */
596 * Scope state - current scope during namespace lookups
598 struct acpi_scope_state {
599 ACPI_STATE_COMMON struct acpi_namespace_node *node;
602 struct acpi_pscope_state {
603 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
604 union acpi_parse_object *op; /* Current op being parsed */
605 u8 *arg_end; /* Current argument end */
606 u8 *pkg_end; /* Current package end */
607 u32 arg_list; /* Next argument to parse */
611 * Thread state - one per thread across multiple walk states. Multiple walk
612 * states are created when there are nested control methods executing.
614 struct acpi_thread_state {
615 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
616 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
617 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
618 acpi_thread_id thread_id; /* Running thread ID */
622 * Result values - used to accumulate the results of nested
625 struct acpi_result_values {
627 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
631 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
632 union acpi_parse_object ** out_op);
634 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
636 /* Global handlers for AML Notifies */
638 struct acpi_global_notify_handler {
639 acpi_notify_handler handler;
644 * Notify info - used to pass info to the deferred notify
645 * handler/dispatcher.
647 struct acpi_notify_info {
648 ACPI_STATE_COMMON u8 handler_list_id;
649 struct acpi_namespace_node *node;
650 union acpi_operand_object *handler_list_head;
651 struct acpi_global_notify_handler *global;
654 /* Generic state is union of structs above */
656 union acpi_generic_state {
657 struct acpi_common_state common;
658 struct acpi_control_state control;
659 struct acpi_update_state update;
660 struct acpi_scope_state scope;
661 struct acpi_pscope_state parse_scope;
662 struct acpi_pkg_state pkg;
663 struct acpi_thread_state thread;
664 struct acpi_result_values results;
665 struct acpi_notify_info notify;
668 /*****************************************************************************
670 * Interpreter typedefs and structs
672 ****************************************************************************/
674 typedef acpi_status(*acpi_execute_op) (struct acpi_walk_state * walk_state);
676 /* Address Range info block */
678 struct acpi_address_range {
679 struct acpi_address_range *next;
680 struct acpi_namespace_node *region_node;
681 acpi_physical_address start_address;
682 acpi_physical_address end_address;
685 /*****************************************************************************
687 * Parser typedefs and structs
689 ****************************************************************************/
692 * AML opcode, name, and argument layout
694 struct acpi_opcode_info {
695 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
696 char *name; /* Opcode name (disassembler/debug only) */
698 u32 parse_args; /* Grammar/Parse time arguments */
699 u32 runtime_args; /* Interpret time arguments */
700 u16 flags; /* Misc flags */
701 u8 object_type; /* Corresponding internal object type */
702 u8 class; /* Opcode class */
703 u8 type; /* Opcode type */
706 /* Value associated with the parse object */
708 union acpi_parse_value {
709 u64 integer; /* Integer constant (Up to 64 bits) */
710 u32 size; /* bytelist or field size */
711 char *string; /* NULL terminated string */
712 u8 *buffer; /* buffer or string */
713 char *name; /* NULL terminated string */
714 union acpi_parse_object *arg; /* arguments and contained ops */
717 #ifdef ACPI_DISASSEMBLER
718 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
720 #define ACPI_DISASM_ONLY_MEMBERS(a)
723 #define ACPI_PARSE_COMMON \
724 union acpi_parse_object *parent; /* Parent op */\
725 u8 descriptor_type; /* To differentiate various internal objs */\
726 u8 flags; /* Type of Op */\
727 u16 aml_opcode; /* AML opcode */\
728 u32 aml_offset; /* Offset of declaration in AML */\
729 union acpi_parse_object *next; /* Next op */\
730 struct acpi_namespace_node *node; /* For use by interpreter */\
731 union acpi_parse_value value; /* Value or args associated with the opcode */\
732 u8 arg_list_length; /* Number of elements in the arg list */\
733 ACPI_DISASM_ONLY_MEMBERS (\
734 u8 disasm_flags; /* Used during AML disassembly */\
735 u8 disasm_opcode; /* Subtype used for disassembly */\
736 char *operator_symbol;/* Used for C-style operator name strings */\
737 char aml_op_name[16]) /* Op name (debug only) */
739 /* Flags for disasm_flags field above */
741 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
742 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
743 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
744 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
745 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
746 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
747 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
748 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
749 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */
750 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */
751 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
752 #define ACPI_DASM_IGNORE 0x0B /* Not used at this time */
755 * Generic operation (for example: If, While, Store)
757 struct acpi_parse_obj_common {
761 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
764 struct acpi_parse_obj_named {
765 ACPI_PARSE_COMMON u8 *path;
766 u8 *data; /* AML body or bytelist data */
767 u32 length; /* AML length */
768 u32 name; /* 4-byte name or zero if no name */
771 /* This version is used by the iASL compiler only */
773 #define ACPI_MAX_PARSEOP_NAME 20
775 struct acpi_parse_obj_asl {
776 ACPI_PARSE_COMMON union acpi_parse_object *child;
777 union acpi_parse_object *parent_method;
785 u32 logical_line_number;
786 u32 logical_byte_offset;
788 u32 end_logical_line;
791 u32 aml_subtree_length;
792 u32 final_aml_length;
793 u32 final_aml_offset;
796 u8 aml_opcode_length;
797 u8 aml_pkg_len_bytes;
799 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
802 union acpi_parse_object {
803 struct acpi_parse_obj_common common;
804 struct acpi_parse_obj_named named;
805 struct acpi_parse_obj_asl asl;
809 * Parse state - one state per parser invocation and each control
812 struct acpi_parse_state {
813 u8 *aml_start; /* First AML byte */
814 u8 *aml; /* Next AML byte */
815 u8 *aml_end; /* (last + 1) AML byte */
816 u8 *pkg_start; /* Current package begin */
817 u8 *pkg_end; /* Current package end */
818 union acpi_parse_object *start_op; /* Root of parse tree */
819 struct acpi_namespace_node *start_node;
820 union acpi_generic_state *scope; /* Current scope */
821 union acpi_parse_object *start_scope;
825 /* Parse object flags */
827 #define ACPI_PARSEOP_GENERIC 0x01
828 #define ACPI_PARSEOP_NAMED 0x02
829 #define ACPI_PARSEOP_DEFERRED 0x04
830 #define ACPI_PARSEOP_BYTELIST 0x08
831 #define ACPI_PARSEOP_IN_STACK 0x10
832 #define ACPI_PARSEOP_TARGET 0x20
833 #define ACPI_PARSEOP_IN_CACHE 0x80
835 /* Parse object disasm_flags */
837 #define ACPI_PARSEOP_IGNORE 0x01
838 #define ACPI_PARSEOP_PARAMLIST 0x02
839 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
840 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
841 #define ACPI_PARSEOP_SPECIAL 0x10
842 #define ACPI_PARSEOP_COMPOUND 0x20
843 #define ACPI_PARSEOP_ASSIGNMENT 0x40
845 /*****************************************************************************
847 * Hardware (ACPI registers) and PNP
849 ****************************************************************************/
851 struct acpi_bit_register_info {
858 * Some ACPI registers have bits that must be ignored -- meaning that they
861 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
863 /* Write-only bits must be zeroed by software */
865 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
867 /* For control registers, both ignored and reserved bits must be preserved */
870 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
871 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
872 * bit position", section 4.7.3.2.1. However, on some machines the OS must
873 * write a one to this bit after resume for the machine to work properly.
874 * To enable this, we no longer attempt to preserve this bit. No machines
875 * are known to fail if the bit is not preserved. (May 2009)
877 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
878 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
879 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
880 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
882 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
886 * These are the full ACPI registers
888 #define ACPI_REGISTER_PM1_STATUS 0x01
889 #define ACPI_REGISTER_PM1_ENABLE 0x02
890 #define ACPI_REGISTER_PM1_CONTROL 0x03
891 #define ACPI_REGISTER_PM2_CONTROL 0x04
892 #define ACPI_REGISTER_PM_TIMER 0x05
893 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
894 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
896 /* Masks used to access the bit_registers */
898 #define ACPI_BITMASK_TIMER_STATUS 0x0001
899 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
900 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
901 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
902 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
903 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
904 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
905 #define ACPI_BITMASK_WAKE_STATUS 0x8000
907 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
908 ACPI_BITMASK_TIMER_STATUS | \
909 ACPI_BITMASK_BUS_MASTER_STATUS | \
910 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
911 ACPI_BITMASK_POWER_BUTTON_STATUS | \
912 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
913 ACPI_BITMASK_RT_CLOCK_STATUS | \
914 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
915 ACPI_BITMASK_WAKE_STATUS)
917 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
918 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
919 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
920 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
921 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
922 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
924 #define ACPI_BITMASK_SCI_ENABLE 0x0001
925 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
926 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
927 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
928 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
930 #define ACPI_BITMASK_ARB_DISABLE 0x0001
932 /* Raw bit position of each bit_register */
934 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
935 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
936 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
937 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
938 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
939 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
940 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
941 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
943 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
944 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
945 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
946 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
947 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
948 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
950 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
951 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
952 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
953 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
954 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
956 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
958 /* Structs and definitions for _OSI support and I/O port validation */
960 #define ACPI_ALWAYS_ILLEGAL 0x00
962 struct acpi_interface_info {
964 struct acpi_interface_info *next;
969 #define ACPI_OSI_INVALID 0x01
970 #define ACPI_OSI_DYNAMIC 0x02
971 #define ACPI_OSI_FEATURE 0x04
972 #define ACPI_OSI_DEFAULT_INVALID 0x08
973 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
975 struct acpi_port_info {
982 /*****************************************************************************
984 * Resource descriptors
986 ****************************************************************************/
988 /* resource_type values */
990 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
991 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
992 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
994 /* Resource descriptor types and masks */
996 #define ACPI_RESOURCE_NAME_LARGE 0x80
997 #define ACPI_RESOURCE_NAME_SMALL 0x00
999 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1000 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1001 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1004 * Small resource descriptor "names" as defined by the ACPI specification.
1005 * Note: Bits 2:0 are used for the descriptor length
1007 #define ACPI_RESOURCE_NAME_IRQ 0x20
1008 #define ACPI_RESOURCE_NAME_DMA 0x28
1009 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1010 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1011 #define ACPI_RESOURCE_NAME_IO 0x40
1012 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1013 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1014 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1015 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1016 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1017 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1018 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1021 * Large resource descriptor "names" as defined by the ACPI specification.
1022 * Note: includes the Large Descriptor bit in bit[7]
1024 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1025 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1026 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1027 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1028 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1029 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1030 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1031 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1032 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1033 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1034 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1035 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1036 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1037 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1039 /*****************************************************************************
1043 ****************************************************************************/
1045 #define ACPI_ASCII_ZERO 0x30
1047 /*****************************************************************************
1051 ****************************************************************************/
1053 struct acpi_external_list {
1055 char *internal_path;
1056 struct acpi_external_list *next;
1063 /* Values for Flags field above */
1065 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1066 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1067 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1068 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1070 struct acpi_external_file {
1072 struct acpi_external_file *next;
1075 /*****************************************************************************
1079 ****************************************************************************/
1081 struct acpi_db_method_info {
1083 acpi_handle main_thread_gate;
1084 acpi_handle thread_complete_gate;
1085 acpi_handle info_gate;
1086 acpi_thread_id *threads;
1094 char pathname[ACPI_DB_LINE_BUFFER_SIZE];
1096 acpi_object_type *types;
1099 * Arguments to be passed to method for the command
1101 * the Number of threads, ID of current thread and
1102 * Index of current thread inside all them created.
1106 char num_threads_str[11];
1107 char id_of_thread_str[11];
1108 char index_of_thread_str[11];
1111 struct acpi_integrity_info {
1116 #define ACPI_DB_DISABLE_OUTPUT 0x00
1117 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1118 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1119 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1121 /*****************************************************************************
1125 ****************************************************************************/
1127 /* Entry for a memory allocation (debug only) */
1129 #define ACPI_MEM_MALLOC 0
1130 #define ACPI_MEM_CALLOC 1
1131 #define ACPI_MAX_MODULE_NAME 16
1133 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1134 struct acpi_debug_mem_block *previous; \
1135 struct acpi_debug_mem_block *next; \
1139 char module[ACPI_MAX_MODULE_NAME]; \
1142 struct acpi_debug_mem_header {
1143 ACPI_COMMON_DEBUG_MEM_HEADER};
1145 struct acpi_debug_mem_block {
1146 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1149 #define ACPI_MEM_LIST_GLOBAL 0
1150 #define ACPI_MEM_LIST_NSNODE 1
1151 #define ACPI_MEM_LIST_MAX 1
1152 #define ACPI_NUM_MEM_LISTS 2
1154 /*****************************************************************************
1158 ****************************************************************************/
1160 struct ah_predefined_name {
1163 #ifndef ACPI_ASL_COMPILER
1168 struct ah_device_id {
1183 #endif /* __ACLOCAL_H__ */