1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
50 #define ACPI_DO_NOT_WAIT 0
51 #define ACPI_SERIALIZED 0xFF
53 typedef u32 acpi_mutex_handle;
54 #define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1)
56 /* Total number of aml opcodes defined */
58 #define AML_NUM_OPCODES 0x7F
60 /* Forward declarations */
62 struct acpi_walk_state;
63 struct acpi_obj_mutex;
64 union acpi_parse_object;
66 /*****************************************************************************
68 * Mutex typedefs and structs
70 ****************************************************************************/
73 * Predefined handles for the mutex objects used within the subsystem
74 * All mutex objects are automatically created by acpi_ut_mutex_initialize.
76 * The acquire/release ordering protocol is implied via this list. Mutexes
77 * with a lower value must be acquired before mutexes with a higher value.
79 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
82 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
83 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */
84 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
85 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
86 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
87 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
88 #define ACPI_MTX_DEBUG_CMD_COMPLETE 6 /* AML debugger */
89 #define ACPI_MTX_DEBUG_CMD_READY 7 /* AML debugger */
91 #define ACPI_MAX_MUTEX 7
92 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
94 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
95 #ifdef DEFINE_ACPI_GLOBALS
97 /* Debug names for the mutexes above */
99 static char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = {
100 "ACPI_MTX_Interpreter",
101 "ACPI_MTX_Namespace",
106 "ACPI_MTX_CommandComplete",
107 "ACPI_MTX_CommandReady"
114 * Predefined handles for spinlocks used within the subsystem.
115 * These spinlocks are created by acpi_ut_mutex_initialize
117 #define ACPI_LOCK_GPES 0
118 #define ACPI_LOCK_HARDWARE 1
120 #define ACPI_MAX_LOCK 1
121 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
123 /* Owner IDs are used to track namespace nodes for selective deletion */
125 typedef u8 acpi_owner_id;
126 #define ACPI_OWNER_ID_MAX 0xFF
128 /* This Thread ID means that the mutex is not in use (unlocked) */
130 #define ACPI_MUTEX_NOT_ACQUIRED (acpi_thread_id) 0
132 /* Table for the global mutexes */
134 struct acpi_mutex_info {
137 acpi_thread_id thread_id;
140 /* Lock flag parameter for various interfaces */
142 #define ACPI_MTX_DO_NOT_LOCK 0
143 #define ACPI_MTX_LOCK 1
145 /* Field access granularities */
147 #define ACPI_FIELD_BYTE_GRANULARITY 1
148 #define ACPI_FIELD_WORD_GRANULARITY 2
149 #define ACPI_FIELD_DWORD_GRANULARITY 4
150 #define ACPI_FIELD_QWORD_GRANULARITY 8
152 #define ACPI_ENTRY_NOT_FOUND NULL
154 /*****************************************************************************
156 * Namespace typedefs and structs
158 ****************************************************************************/
160 /* Operational modes of the AML interpreter/scanner */
163 ACPI_IMODE_LOAD_PASS1 = 0x01,
164 ACPI_IMODE_LOAD_PASS2 = 0x02,
165 ACPI_IMODE_EXECUTE = 0x03
166 } acpi_interpreter_mode;
168 union acpi_name_union {
174 * The Namespace Node describes a named object that appears in the AML.
175 * descriptor_type is used to differentiate between internal descriptors.
177 * The node is optimized for both 32-bit and 64-bit platforms:
178 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
180 * Note: The descriptor_type and Type fields must appear in the identical
181 * position in both the struct acpi_namespace_node and union acpi_operand_object
184 struct acpi_namespace_node {
185 union acpi_operand_object *object; /* Interpreter object */
186 u8 descriptor_type; /* Differentiate object descriptor types */
187 u8 type; /* ACPI Type associated with this name */
188 u8 flags; /* Miscellaneous flags */
189 acpi_owner_id owner_id; /* Node creator */
190 union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */
191 struct acpi_namespace_node *child; /* First child */
192 struct acpi_namespace_node *peer; /* Peer. Parent if ANOBJ_END_OF_PEER_LIST set */
195 * The following fields are used by the ASL compiler and disassembler only
197 #ifdef ACPI_LARGE_NAMESPACE_NODE
198 union acpi_parse_object *op;
204 /* Namespace Node flags */
206 #define ANOBJ_END_OF_PEER_LIST 0x01 /* End-of-list, Peer field points to parent */
207 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
208 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
209 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
210 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
211 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
213 #define ANOBJ_IS_EXTERNAL 0x08 /* i_aSL only: This object created via External() */
214 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* i_aSL only: Method has no return value */
215 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* i_aSL only: Method has at least one return value */
216 #define ANOBJ_IS_BIT_OFFSET 0x40 /* i_aSL only: Reference is a bit offset */
217 #define ANOBJ_IS_REFERENCED 0x80 /* i_aSL only: Object was referenced */
220 * ACPI Table Descriptor. One per ACPI table
222 struct acpi_table_desc {
223 acpi_physical_address address;
224 struct acpi_table_header *pointer;
225 u32 length; /* Length fixed at 32 bits */
226 union acpi_name_union signature;
227 acpi_owner_id owner_id;
231 /* Flags for above */
233 #define ACPI_TABLE_ORIGIN_UNKNOWN (0)
234 #define ACPI_TABLE_ORIGIN_MAPPED (1)
235 #define ACPI_TABLE_ORIGIN_ALLOCATED (2)
236 #define ACPI_TABLE_ORIGIN_MASK (3)
237 #define ACPI_TABLE_IS_LOADED (4)
239 /* One internal RSDT for table management */
241 struct acpi_internal_rsdt {
242 struct acpi_table_desc *tables;
248 /* Flags for above */
250 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
251 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
252 #define ACPI_ROOT_ALLOW_RESIZE (2)
254 /* Predefined (fixed) table indexes */
256 #define ACPI_TABLE_INDEX_DSDT (0)
257 #define ACPI_TABLE_INDEX_FACS (1)
259 struct acpi_find_context {
265 struct acpi_ns_search_data {
266 struct acpi_namespace_node *node;
270 * Predefined Namespace items
272 struct acpi_predefined_names {
278 /* Object types used during package copies */
280 #define ACPI_COPY_TYPE_SIMPLE 0
281 #define ACPI_COPY_TYPE_PACKAGE 1
283 /* Info structure used to convert external<->internal namestrings */
285 struct acpi_namestring_info {
286 const char *external_name;
287 const char *next_external_char;
295 /* Field creation info */
297 struct acpi_create_field_info {
298 struct acpi_namespace_node *region_node;
299 struct acpi_namespace_node *field_node;
300 struct acpi_namespace_node *register_node;
301 struct acpi_namespace_node *data_register_node;
303 u32 field_bit_position;
304 u32 field_bit_length;
311 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
314 * Bitmapped ACPI types. Used internally only
316 #define ACPI_BTYPE_ANY 0x00000000
317 #define ACPI_BTYPE_INTEGER 0x00000001
318 #define ACPI_BTYPE_STRING 0x00000002
319 #define ACPI_BTYPE_BUFFER 0x00000004
320 #define ACPI_BTYPE_PACKAGE 0x00000008
321 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
322 #define ACPI_BTYPE_DEVICE 0x00000020
323 #define ACPI_BTYPE_EVENT 0x00000040
324 #define ACPI_BTYPE_METHOD 0x00000080
325 #define ACPI_BTYPE_MUTEX 0x00000100
326 #define ACPI_BTYPE_REGION 0x00000200
327 #define ACPI_BTYPE_POWER 0x00000400
328 #define ACPI_BTYPE_PROCESSOR 0x00000800
329 #define ACPI_BTYPE_THERMAL 0x00001000
330 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
331 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
332 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
333 #define ACPI_BTYPE_REFERENCE 0x00010000
334 #define ACPI_BTYPE_RESOURCE 0x00020000
336 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
338 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
339 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
340 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
341 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
342 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
345 * Information structure for ACPI predefined names.
346 * Each entry in the table contains the following items:
348 * Name - The ACPI reserved name
349 * param_count - Number of arguments to the method
350 * expected_return_btypes - Allowed type(s) for the return value
352 struct acpi_name_info {
353 char name[ACPI_NAME_SIZE];
359 * Secondary information structures for ACPI predefined objects that return
360 * package objects. This structure appears as the next entry in the table
361 * after the NAME_INFO structure above.
363 * The reason for this is to minimize the size of the predefined name table.
367 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
368 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
370 struct acpi_package_info {
379 /* Used for ACPI_PTYPE2_FIXED */
381 struct acpi_package_info2 {
387 /* Used for ACPI_PTYPE1_OPTION */
389 struct acpi_package_info3 {
397 union acpi_predefined_info {
398 struct acpi_name_info info;
399 struct acpi_package_info ret_info;
400 struct acpi_package_info2 ret_info2;
401 struct acpi_package_info3 ret_info3;
405 * Bitmapped return value types
406 * Note: the actual data types must be contiguous, a loop in nspredef.c
409 #define ACPI_RTYPE_ANY 0x00
410 #define ACPI_RTYPE_NONE 0x01
411 #define ACPI_RTYPE_INTEGER 0x02
412 #define ACPI_RTYPE_STRING 0x04
413 #define ACPI_RTYPE_BUFFER 0x08
414 #define ACPI_RTYPE_PACKAGE 0x10
415 #define ACPI_RTYPE_REFERENCE 0x20
416 #define ACPI_RTYPE_ALL 0x3F
418 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
420 /*****************************************************************************
422 * Event typedefs and structs
424 ****************************************************************************/
426 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
428 struct acpi_handler_info {
429 acpi_event_handler address; /* Address of handler, if any */
430 void *context; /* Context to be passed to handler */
431 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
434 union acpi_gpe_dispatch_info {
435 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
436 struct acpi_handler_info *handler;
440 * Information about a GPE, one per each GPE in an array.
441 * NOTE: Important to keep this struct as small as possible.
443 struct acpi_gpe_event_info {
444 union acpi_gpe_dispatch_info dispatch; /* Either Method or Handler */
445 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
446 u8 flags; /* Misc info about this GPE */
447 u8 gpe_number; /* This GPE */
450 /* Information about a GPE register pair, one per each status/enable pair in an array */
452 struct acpi_gpe_register_info {
453 struct acpi_generic_address status_address; /* Address of status reg */
454 struct acpi_generic_address enable_address; /* Address of enable reg */
455 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
456 u8 enable_for_run; /* GPEs to keep enabled when running */
457 u8 base_gpe_number; /* Base GPE number for this register */
461 * Information about a GPE register block, one per each installed block --
462 * GPE0, GPE1, and one per each installed GPE Block Device.
464 struct acpi_gpe_block_info {
465 struct acpi_namespace_node *node;
466 struct acpi_gpe_block_info *previous;
467 struct acpi_gpe_block_info *next;
468 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
469 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
470 struct acpi_gpe_event_info *event_info; /* One for each GPE */
471 struct acpi_generic_address block_address; /* Base address of the block */
472 u32 register_count; /* Number of register pairs in block */
473 u8 block_base_number; /* Base GPE number for this block */
476 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
478 struct acpi_gpe_xrupt_info {
479 struct acpi_gpe_xrupt_info *previous;
480 struct acpi_gpe_xrupt_info *next;
481 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
482 u32 interrupt_number; /* System interrupt number */
485 struct acpi_gpe_walk_info {
486 struct acpi_namespace_node *gpe_device;
487 struct acpi_gpe_block_info *gpe_block;
490 struct acpi_gpe_device_info {
492 u32 next_block_base_index;
494 struct acpi_namespace_node *gpe_device;
497 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *gpe_xrupt_info,
498 struct acpi_gpe_block_info *gpe_block, void *context);
500 /* Information about each particular fixed event */
502 struct acpi_fixed_event_handler {
503 acpi_event_handler handler; /* Address of handler. */
504 void *context; /* Context to be passed to handler */
507 struct acpi_fixed_event_info {
508 u8 status_register_id;
509 u8 enable_register_id;
514 /* Information used during field processing */
516 struct acpi_field_info {
522 /*****************************************************************************
524 * Generic "state" object for stacks
526 ****************************************************************************/
528 #define ACPI_CONTROL_NORMAL 0xC0
529 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
530 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
531 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
532 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
534 #define ACPI_STATE_COMMON \
536 u8 descriptor_type; /* To differentiate various internal objs */\
541 /* There are 2 bytes available here until the next natural alignment boundary */
543 struct acpi_common_state {
547 * Update state - used to traverse complex objects such as packages
549 struct acpi_update_state {
550 ACPI_STATE_COMMON union acpi_operand_object *object;
554 * Pkg state - used to traverse nested package structures
556 struct acpi_pkg_state {
557 ACPI_STATE_COMMON u16 index;
558 union acpi_operand_object *source_object;
559 union acpi_operand_object *dest_object;
560 struct acpi_walk_state *walk_state;
561 void *this_target_obj;
566 * Control state - one per if/else and while constructs.
567 * Allows nesting of these constructs
569 struct acpi_control_state {
570 ACPI_STATE_COMMON u16 opcode;
571 union acpi_parse_object *predicate_op;
572 u8 *aml_predicate_start; /* Start of if/while predicate */
573 u8 *package_end; /* End of if/while block */
574 u32 loop_count; /* While() loop counter */
578 * Scope state - current scope during namespace lookups
580 struct acpi_scope_state {
581 ACPI_STATE_COMMON struct acpi_namespace_node *node;
584 struct acpi_pscope_state {
585 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
586 union acpi_parse_object *op; /* Current op being parsed */
587 u8 *arg_end; /* Current argument end */
588 u8 *pkg_end; /* Current package end */
589 u32 arg_list; /* Next argument to parse */
593 * Thread state - one per thread across multiple walk states. Multiple walk
594 * states are created when there are nested control methods executing.
596 struct acpi_thread_state {
597 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
598 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
599 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
600 acpi_thread_id thread_id; /* Running thread ID */
604 * Result values - used to accumulate the results of nested
607 struct acpi_result_values {
609 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
613 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
614 union acpi_parse_object ** out_op);
616 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
619 * Notify info - used to pass info to the deferred notify
620 * handler/dispatcher.
622 struct acpi_notify_info {
623 ACPI_STATE_COMMON struct acpi_namespace_node *node;
624 union acpi_operand_object *handler_obj;
627 /* Generic state is union of structs above */
629 union acpi_generic_state {
630 struct acpi_common_state common;
631 struct acpi_control_state control;
632 struct acpi_update_state update;
633 struct acpi_scope_state scope;
634 struct acpi_pscope_state parse_scope;
635 struct acpi_pkg_state pkg;
636 struct acpi_thread_state thread;
637 struct acpi_result_values results;
638 struct acpi_notify_info notify;
641 /*****************************************************************************
643 * Interpreter typedefs and structs
645 ****************************************************************************/
647 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
649 /*****************************************************************************
651 * Parser typedefs and structs
653 ****************************************************************************/
656 * AML opcode, name, and argument layout
658 struct acpi_opcode_info {
659 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
660 char *name; /* Opcode name (disassembler/debug only) */
662 u32 parse_args; /* Grammar/Parse time arguments */
663 u32 runtime_args; /* Interpret time arguments */
664 u16 flags; /* Misc flags */
665 u8 object_type; /* Corresponding internal object type */
666 u8 class; /* Opcode class */
667 u8 type; /* Opcode type */
670 union acpi_parse_value {
671 acpi_integer integer; /* Integer constant (Up to 64 bits) */
672 struct uint64_struct integer64; /* Structure overlay for 2 32-bit Dwords */
673 u32 size; /* bytelist or field size */
674 char *string; /* NULL terminated string */
675 u8 *buffer; /* buffer or string */
676 char *name; /* NULL terminated string */
677 union acpi_parse_object *arg; /* arguments and contained ops */
680 #define ACPI_PARSE_COMMON \
681 union acpi_parse_object *parent; /* Parent op */\
682 u8 descriptor_type; /* To differentiate various internal objs */\
683 u8 flags; /* Type of Op */\
684 u16 aml_opcode; /* AML opcode */\
685 u32 aml_offset; /* Offset of declaration in AML */\
686 union acpi_parse_object *next; /* Next op */\
687 struct acpi_namespace_node *node; /* For use by interpreter */\
688 union acpi_parse_value value; /* Value or args associated with the opcode */\
689 u8 arg_list_length; /* Number of elements in the arg list */\
690 ACPI_DISASM_ONLY_MEMBERS (\
691 u8 disasm_flags; /* Used during AML disassembly */\
692 u8 disasm_opcode; /* Subtype used for disassembly */\
693 char aml_op_name[16]) /* Op name (debug only) */
695 #define ACPI_DASM_BUFFER 0x00
696 #define ACPI_DASM_RESOURCE 0x01
697 #define ACPI_DASM_STRING 0x02
698 #define ACPI_DASM_UNICODE 0x03
699 #define ACPI_DASM_EISAID 0x04
700 #define ACPI_DASM_MATCHOP 0x05
701 #define ACPI_DASM_LNOT_PREFIX 0x06
702 #define ACPI_DASM_LNOT_SUFFIX 0x07
703 #define ACPI_DASM_IGNORE 0x08
706 * Generic operation (for example: If, While, Store)
708 struct acpi_parse_obj_common {
712 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
715 struct acpi_parse_obj_named {
716 ACPI_PARSE_COMMON u8 *path;
717 u8 *data; /* AML body or bytelist data */
718 u32 length; /* AML length */
719 u32 name; /* 4-byte name or zero if no name */
722 /* This version is used by the i_aSL compiler only */
724 #define ACPI_MAX_PARSEOP_NAME 20
726 struct acpi_parse_obj_asl {
727 ACPI_PARSE_COMMON union acpi_parse_object *child;
728 union acpi_parse_object *parent_method;
736 u32 logical_line_number;
737 u32 logical_byte_offset;
739 u32 end_logical_line;
742 u32 aml_subtree_length;
743 u32 final_aml_length;
744 u32 final_aml_offset;
747 u8 aml_opcode_length;
748 u8 aml_pkg_len_bytes;
750 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
753 union acpi_parse_object {
754 struct acpi_parse_obj_common common;
755 struct acpi_parse_obj_named named;
756 struct acpi_parse_obj_asl asl;
760 * Parse state - one state per parser invocation and each control
763 struct acpi_parse_state {
764 u8 *aml_start; /* First AML byte */
765 u8 *aml; /* Next AML byte */
766 u8 *aml_end; /* (last + 1) AML byte */
767 u8 *pkg_start; /* Current package begin */
768 u8 *pkg_end; /* Current package end */
769 union acpi_parse_object *start_op; /* Root of parse tree */
770 struct acpi_namespace_node *start_node;
771 union acpi_generic_state *scope; /* Current scope */
772 union acpi_parse_object *start_scope;
776 /* Parse object flags */
778 #define ACPI_PARSEOP_GENERIC 0x01
779 #define ACPI_PARSEOP_NAMED 0x02
780 #define ACPI_PARSEOP_DEFERRED 0x04
781 #define ACPI_PARSEOP_BYTELIST 0x08
782 #define ACPI_PARSEOP_IN_STACK 0x10
783 #define ACPI_PARSEOP_TARGET 0x20
784 #define ACPI_PARSEOP_IN_CACHE 0x80
786 /* Parse object disasm_flags */
788 #define ACPI_PARSEOP_IGNORE 0x01
789 #define ACPI_PARSEOP_PARAMLIST 0x02
790 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
791 #define ACPI_PARSEOP_SPECIAL 0x10
793 /*****************************************************************************
795 * Hardware (ACPI registers) and PNP
797 ****************************************************************************/
799 #define PCI_ROOT_HID_STRING "PNP0A03"
800 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
802 struct acpi_bit_register_info {
809 * Some ACPI registers have bits that must be ignored -- meaning that they
812 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
813 #define ACPI_PM1_CONTROL_PRESERVED_BITS 0x0200 /* Bit 9 (whatever) */
817 * These are the full ACPI registers
819 #define ACPI_REGISTER_PM1_STATUS 0x01
820 #define ACPI_REGISTER_PM1_ENABLE 0x02
821 #define ACPI_REGISTER_PM1_CONTROL 0x03
822 #define ACPI_REGISTER_PM1A_CONTROL 0x04
823 #define ACPI_REGISTER_PM1B_CONTROL 0x05
824 #define ACPI_REGISTER_PM2_CONTROL 0x06
825 #define ACPI_REGISTER_PM_TIMER 0x07
826 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x08
827 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x09
829 /* Masks used to access the bit_registers */
831 #define ACPI_BITMASK_TIMER_STATUS 0x0001
832 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
833 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
834 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
835 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
836 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
837 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
838 #define ACPI_BITMASK_WAKE_STATUS 0x8000
840 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
841 ACPI_BITMASK_TIMER_STATUS | \
842 ACPI_BITMASK_BUS_MASTER_STATUS | \
843 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
844 ACPI_BITMASK_POWER_BUTTON_STATUS | \
845 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
846 ACPI_BITMASK_RT_CLOCK_STATUS | \
847 ACPI_BITMASK_WAKE_STATUS)
849 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
850 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
851 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
852 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
853 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
854 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
856 #define ACPI_BITMASK_SCI_ENABLE 0x0001
857 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
858 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
859 #define ACPI_BITMASK_SLEEP_TYPE_X 0x1C00
860 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
862 #define ACPI_BITMASK_ARB_DISABLE 0x0001
864 /* Raw bit position of each bit_register */
866 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
867 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
868 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
869 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
870 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
871 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
872 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
873 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
875 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
876 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
877 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
878 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
879 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
880 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
882 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
883 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
884 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
885 #define ACPI_BITPOSITION_SLEEP_TYPE_X 0x0A
886 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
888 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
890 /*****************************************************************************
892 * Resource descriptors
894 ****************************************************************************/
896 /* resource_type values */
898 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
899 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
900 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
902 /* Resource descriptor types and masks */
904 #define ACPI_RESOURCE_NAME_LARGE 0x80
905 #define ACPI_RESOURCE_NAME_SMALL 0x00
907 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
908 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
909 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
912 * Small resource descriptor "names" as defined by the ACPI specification.
913 * Note: Bits 2:0 are used for the descriptor length
915 #define ACPI_RESOURCE_NAME_IRQ 0x20
916 #define ACPI_RESOURCE_NAME_DMA 0x28
917 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
918 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
919 #define ACPI_RESOURCE_NAME_IO 0x40
920 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
921 #define ACPI_RESOURCE_NAME_RESERVED_S1 0x50
922 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
923 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
924 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
925 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
926 #define ACPI_RESOURCE_NAME_END_TAG 0x78
929 * Large resource descriptor "names" as defined by the ACPI specification.
930 * Note: includes the Large Descriptor bit in bit[7]
932 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
933 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
934 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
935 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
936 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
937 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
938 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
939 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
940 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
941 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
942 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
943 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B
945 /*****************************************************************************
949 ****************************************************************************/
951 #define ACPI_ASCII_ZERO 0x30
953 /*****************************************************************************
957 ****************************************************************************/
959 struct acpi_db_method_info {
960 acpi_handle main_thread_gate;
961 acpi_handle thread_complete_gate;
974 * Arguments to be passed to method for the command
976 * the Number of threads, ID of current thread and
977 * Index of current thread inside all them created.
981 char num_threads_str[11];
982 char id_of_thread_str[11];
983 char index_of_thread_str[11];
986 struct acpi_integrity_info {
991 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
992 #define ACPI_DB_CONSOLE_OUTPUT 0x02
993 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
995 /*****************************************************************************
999 ****************************************************************************/
1001 /* Entry for a memory allocation (debug only) */
1003 #define ACPI_MEM_MALLOC 0
1004 #define ACPI_MEM_CALLOC 1
1005 #define ACPI_MAX_MODULE_NAME 16
1007 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1008 struct acpi_debug_mem_block *previous; \
1009 struct acpi_debug_mem_block *next; \
1013 char module[ACPI_MAX_MODULE_NAME]; \
1016 struct acpi_debug_mem_header {
1017 ACPI_COMMON_DEBUG_MEM_HEADER};
1019 struct acpi_debug_mem_block {
1020 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1023 #define ACPI_MEM_LIST_GLOBAL 0
1024 #define ACPI_MEM_LIST_NSNODE 1
1025 #define ACPI_MEM_LIST_MAX 1
1026 #define ACPI_NUM_MEM_LISTS 2
1028 struct acpi_memory_list {
1036 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1038 /* Statistics for debug memory tracking only */
1040 u32 total_allocated;
1044 u32 current_total_size;
1050 #endif /* __ACLOCAL_H__ */