1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2010, 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 0x7F
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 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
93 #ifdef DEFINE_ACPI_GLOBALS
95 /* Debug names for the mutexes above */
97 static char *acpi_gbl_mutex_names
[ACPI_NUM_MUTEX
] = {
98 "ACPI_MTX_Interpreter",
104 "ACPI_MTX_CommandComplete",
105 "ACPI_MTX_CommandReady"
111 /* Lock structure for reader/writer interfaces */
113 struct acpi_rw_lock
{
114 acpi_mutex writer_mutex
;
115 acpi_mutex reader_mutex
;
120 * Predefined handles for spinlocks used within the subsystem.
121 * These spinlocks are created by acpi_ut_mutex_initialize
123 #define ACPI_LOCK_GPES 0
124 #define ACPI_LOCK_HARDWARE 1
126 #define ACPI_MAX_LOCK 1
127 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
129 /* This Thread ID means that the mutex is not in use (unlocked) */
131 #define ACPI_MUTEX_NOT_ACQUIRED (acpi_thread_id) 0
133 /* Table for the global mutexes */
135 struct acpi_mutex_info
{
138 acpi_thread_id thread_id
;
141 /* Lock flag parameter for various interfaces */
143 #define ACPI_MTX_DO_NOT_LOCK 0
144 #define ACPI_MTX_LOCK 1
146 /* Field access granularities */
148 #define ACPI_FIELD_BYTE_GRANULARITY 1
149 #define ACPI_FIELD_WORD_GRANULARITY 2
150 #define ACPI_FIELD_DWORD_GRANULARITY 4
151 #define ACPI_FIELD_QWORD_GRANULARITY 8
153 #define ACPI_ENTRY_NOT_FOUND NULL
155 /*****************************************************************************
157 * Namespace typedefs and structs
159 ****************************************************************************/
161 /* Operational modes of the AML interpreter/scanner */
164 ACPI_IMODE_LOAD_PASS1
= 0x01,
165 ACPI_IMODE_LOAD_PASS2
= 0x02,
166 ACPI_IMODE_EXECUTE
= 0x03
167 } acpi_interpreter_mode
;
170 * The Namespace Node describes a named object that appears in the AML.
171 * descriptor_type is used to differentiate between internal descriptors.
173 * The node is optimized for both 32-bit and 64-bit platforms:
174 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
176 * Note: The descriptor_type and Type fields must appear in the identical
177 * position in both the struct acpi_namespace_node and union acpi_operand_object
180 struct acpi_namespace_node
{
181 union acpi_operand_object
*object
; /* Interpreter object */
182 u8 descriptor_type
; /* Differentiate object descriptor types */
183 u8 type
; /* ACPI Type associated with this name */
184 u8 flags
; /* Miscellaneous flags */
185 acpi_owner_id owner_id
; /* Node creator */
186 union acpi_name_union name
; /* ACPI Name, always 4 chars per ACPI spec */
187 struct acpi_namespace_node
*parent
; /* Parent node */
188 struct acpi_namespace_node
*child
; /* First child */
189 struct acpi_namespace_node
*peer
; /* First peer */
192 * The following fields are used by the ASL compiler and disassembler only
194 #ifdef ACPI_LARGE_NAMESPACE_NODE
195 union acpi_parse_object
*op
;
201 /* Namespace Node flags */
203 #define ANOBJ_RESERVED 0x01 /* Available for use */
204 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
205 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
206 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
207 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
208 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
209 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
211 #define ANOBJ_IS_EXTERNAL 0x08 /* i_aSL only: This object created via External() */
212 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* i_aSL only: Method has no return value */
213 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* i_aSL only: Method has at least one return value */
214 #define ANOBJ_IS_BIT_OFFSET 0x40 /* i_aSL only: Reference is a bit offset */
215 #define ANOBJ_IS_REFERENCED 0x80 /* i_aSL only: Object was referenced */
217 /* Internal ACPI table management - master table list */
219 struct acpi_table_list
{
220 struct acpi_table_desc
*tables
; /* Table descriptor array */
221 u32 current_table_count
; /* Tables currently in the array */
222 u32 max_table_count
; /* Max tables array will hold */
226 /* Flags for above */
228 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
229 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
230 #define ACPI_ROOT_ALLOW_RESIZE (2)
232 /* Predefined (fixed) table indexes */
234 #define ACPI_TABLE_INDEX_DSDT (0)
235 #define ACPI_TABLE_INDEX_FACS (1)
237 struct acpi_find_context
{
243 struct acpi_ns_search_data
{
244 struct acpi_namespace_node
*node
;
247 /* Object types used during package copies */
249 #define ACPI_COPY_TYPE_SIMPLE 0
250 #define ACPI_COPY_TYPE_PACKAGE 1
252 /* Info structure used to convert external<->internal namestrings */
254 struct acpi_namestring_info
{
255 const char *external_name
;
256 const char *next_external_char
;
264 /* Field creation info */
266 struct acpi_create_field_info
{
267 struct acpi_namespace_node
*region_node
;
268 struct acpi_namespace_node
*field_node
;
269 struct acpi_namespace_node
*register_node
;
270 struct acpi_namespace_node
*data_register_node
;
272 u32 field_bit_position
;
273 u32 field_bit_length
;
280 acpi_status(*ACPI_INTERNAL_METHOD
) (struct acpi_walk_state
* walk_state
);
283 * Bitmapped ACPI types. Used internally only
285 #define ACPI_BTYPE_ANY 0x00000000
286 #define ACPI_BTYPE_INTEGER 0x00000001
287 #define ACPI_BTYPE_STRING 0x00000002
288 #define ACPI_BTYPE_BUFFER 0x00000004
289 #define ACPI_BTYPE_PACKAGE 0x00000008
290 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
291 #define ACPI_BTYPE_DEVICE 0x00000020
292 #define ACPI_BTYPE_EVENT 0x00000040
293 #define ACPI_BTYPE_METHOD 0x00000080
294 #define ACPI_BTYPE_MUTEX 0x00000100
295 #define ACPI_BTYPE_REGION 0x00000200
296 #define ACPI_BTYPE_POWER 0x00000400
297 #define ACPI_BTYPE_PROCESSOR 0x00000800
298 #define ACPI_BTYPE_THERMAL 0x00001000
299 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
300 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
301 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
302 #define ACPI_BTYPE_REFERENCE 0x00010000
303 #define ACPI_BTYPE_RESOURCE 0x00020000
305 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
307 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
308 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
309 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
310 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
311 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
314 * Information structure for ACPI predefined names.
315 * Each entry in the table contains the following items:
317 * Name - The ACPI reserved name
318 * param_count - Number of arguments to the method
319 * expected_return_btypes - Allowed type(s) for the return value
321 struct acpi_name_info
{
322 char name
[ACPI_NAME_SIZE
];
328 * Secondary information structures for ACPI predefined objects that return
329 * package objects. This structure appears as the next entry in the table
330 * after the NAME_INFO structure above.
332 * The reason for this is to minimize the size of the predefined name table.
336 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
337 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
339 struct acpi_package_info
{
348 /* Used for ACPI_PTYPE2_FIXED */
350 struct acpi_package_info2
{
356 /* Used for ACPI_PTYPE1_OPTION */
358 struct acpi_package_info3
{
366 union acpi_predefined_info
{
367 struct acpi_name_info info
;
368 struct acpi_package_info ret_info
;
369 struct acpi_package_info2 ret_info2
;
370 struct acpi_package_info3 ret_info3
;
373 /* Data block used during object validation */
375 struct acpi_predefined_data
{
377 const union acpi_predefined_info
*predefined
;
378 union acpi_operand_object
*parent_package
;
383 /* Defines for Flags field above */
385 #define ACPI_OBJECT_REPAIRED 1
388 * Bitmapped return value types
389 * Note: the actual data types must be contiguous, a loop in nspredef.c
392 #define ACPI_RTYPE_ANY 0x00
393 #define ACPI_RTYPE_NONE 0x01
394 #define ACPI_RTYPE_INTEGER 0x02
395 #define ACPI_RTYPE_STRING 0x04
396 #define ACPI_RTYPE_BUFFER 0x08
397 #define ACPI_RTYPE_PACKAGE 0x10
398 #define ACPI_RTYPE_REFERENCE 0x20
399 #define ACPI_RTYPE_ALL 0x3F
401 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
403 /*****************************************************************************
405 * Event typedefs and structs
407 ****************************************************************************/
409 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
411 struct acpi_handler_info
{
412 acpi_event_handler address
; /* Address of handler, if any */
413 void *context
; /* Context to be passed to handler */
414 struct acpi_namespace_node
*method_node
; /* Method node for this GPE level (saved) */
417 union acpi_gpe_dispatch_info
{
418 struct acpi_namespace_node
*method_node
; /* Method node for this GPE level */
419 struct acpi_handler_info
*handler
;
423 * Information about a GPE, one per each GPE in an array.
424 * NOTE: Important to keep this struct as small as possible.
426 struct acpi_gpe_event_info
{
427 union acpi_gpe_dispatch_info dispatch
; /* Either Method or Handler */
428 struct acpi_gpe_register_info
*register_info
; /* Backpointer to register info */
429 u8 flags
; /* Misc info about this GPE */
430 u8 gpe_number
; /* This GPE */
431 u8 runtime_count
; /* References to a run GPE */
434 /* Information about a GPE register pair, one per each status/enable pair in an array */
436 struct acpi_gpe_register_info
{
437 struct acpi_generic_address status_address
; /* Address of status reg */
438 struct acpi_generic_address enable_address
; /* Address of enable reg */
439 u8 enable_for_wake
; /* GPEs to keep enabled when sleeping */
440 u8 enable_for_run
; /* GPEs to keep enabled when running */
441 u8 base_gpe_number
; /* Base GPE number for this register */
445 * Information about a GPE register block, one per each installed block --
446 * GPE0, GPE1, and one per each installed GPE Block Device.
448 struct acpi_gpe_block_info
{
449 struct acpi_namespace_node
*node
;
450 struct acpi_gpe_block_info
*previous
;
451 struct acpi_gpe_block_info
*next
;
452 struct acpi_gpe_xrupt_info
*xrupt_block
; /* Backpointer to interrupt block */
453 struct acpi_gpe_register_info
*register_info
; /* One per GPE register pair */
454 struct acpi_gpe_event_info
*event_info
; /* One for each GPE */
455 struct acpi_generic_address block_address
; /* Base address of the block */
456 u32 register_count
; /* Number of register pairs in block */
457 u16 gpe_count
; /* Number of individual GPEs in block */
458 u8 block_base_number
; /* Base GPE number for this block */
461 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
463 struct acpi_gpe_xrupt_info
{
464 struct acpi_gpe_xrupt_info
*previous
;
465 struct acpi_gpe_xrupt_info
*next
;
466 struct acpi_gpe_block_info
*gpe_block_list_head
; /* List of GPE blocks for this xrupt */
467 u32 interrupt_number
; /* System interrupt number */
470 struct acpi_gpe_walk_info
{
471 struct acpi_namespace_node
*gpe_device
;
472 struct acpi_gpe_block_info
*gpe_block
;
474 acpi_owner_id owner_id
;
476 u8 execute_by_owner_id
;
479 struct acpi_gpe_device_info
{
481 u32 next_block_base_index
;
483 struct acpi_namespace_node
*gpe_device
;
486 typedef acpi_status(*acpi_gpe_callback
) (struct acpi_gpe_xrupt_info
*gpe_xrupt_info
,
487 struct acpi_gpe_block_info
*gpe_block
, void *context
);
489 /* Information about each particular fixed event */
491 struct acpi_fixed_event_handler
{
492 acpi_event_handler handler
; /* Address of handler. */
493 void *context
; /* Context to be passed to handler */
496 struct acpi_fixed_event_info
{
497 u8 status_register_id
;
498 u8 enable_register_id
;
503 /* Information used during field processing */
505 struct acpi_field_info
{
511 /*****************************************************************************
513 * Generic "state" object for stacks
515 ****************************************************************************/
517 #define ACPI_CONTROL_NORMAL 0xC0
518 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
519 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
520 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
521 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
523 #define ACPI_STATE_COMMON \
525 u8 descriptor_type; /* To differentiate various internal objs */\
530 /* There are 2 bytes available here until the next natural alignment boundary */
532 struct acpi_common_state
{
536 * Update state - used to traverse complex objects such as packages
538 struct acpi_update_state
{
539 ACPI_STATE_COMMON
union acpi_operand_object
*object
;
543 * Pkg state - used to traverse nested package structures
545 struct acpi_pkg_state
{
546 ACPI_STATE_COMMON u16 index
;
547 union acpi_operand_object
*source_object
;
548 union acpi_operand_object
*dest_object
;
549 struct acpi_walk_state
*walk_state
;
550 void *this_target_obj
;
555 * Control state - one per if/else and while constructs.
556 * Allows nesting of these constructs
558 struct acpi_control_state
{
559 ACPI_STATE_COMMON u16 opcode
;
560 union acpi_parse_object
*predicate_op
;
561 u8
*aml_predicate_start
; /* Start of if/while predicate */
562 u8
*package_end
; /* End of if/while block */
563 u32 loop_count
; /* While() loop counter */
567 * Scope state - current scope during namespace lookups
569 struct acpi_scope_state
{
570 ACPI_STATE_COMMON
struct acpi_namespace_node
*node
;
573 struct acpi_pscope_state
{
574 ACPI_STATE_COMMON u32 arg_count
; /* Number of fixed arguments */
575 union acpi_parse_object
*op
; /* Current op being parsed */
576 u8
*arg_end
; /* Current argument end */
577 u8
*pkg_end
; /* Current package end */
578 u32 arg_list
; /* Next argument to parse */
582 * Thread state - one per thread across multiple walk states. Multiple walk
583 * states are created when there are nested control methods executing.
585 struct acpi_thread_state
{
586 ACPI_STATE_COMMON u8 current_sync_level
; /* Mutex Sync (nested acquire) level */
587 struct acpi_walk_state
*walk_state_list
; /* Head of list of walk_states for this thread */
588 union acpi_operand_object
*acquired_mutex_list
; /* List of all currently acquired mutexes */
589 acpi_thread_id thread_id
; /* Running thread ID */
593 * Result values - used to accumulate the results of nested
596 struct acpi_result_values
{
598 union acpi_operand_object
*obj_desc
[ACPI_RESULTS_FRAME_OBJ_NUM
];
602 acpi_status(*acpi_parse_downwards
) (struct acpi_walk_state
* walk_state
,
603 union acpi_parse_object
** out_op
);
605 typedef acpi_status(*acpi_parse_upwards
) (struct acpi_walk_state
* walk_state
);
608 * Notify info - used to pass info to the deferred notify
609 * handler/dispatcher.
611 struct acpi_notify_info
{
612 ACPI_STATE_COMMON
struct acpi_namespace_node
*node
;
613 union acpi_operand_object
*handler_obj
;
616 /* Generic state is union of structs above */
618 union acpi_generic_state
{
619 struct acpi_common_state common
;
620 struct acpi_control_state control
;
621 struct acpi_update_state update
;
622 struct acpi_scope_state scope
;
623 struct acpi_pscope_state parse_scope
;
624 struct acpi_pkg_state pkg
;
625 struct acpi_thread_state thread
;
626 struct acpi_result_values results
;
627 struct acpi_notify_info notify
;
630 /*****************************************************************************
632 * Interpreter typedefs and structs
634 ****************************************************************************/
636 typedef acpi_status(*ACPI_EXECUTE_OP
) (struct acpi_walk_state
* walk_state
);
638 /*****************************************************************************
640 * Parser typedefs and structs
642 ****************************************************************************/
645 * AML opcode, name, and argument layout
647 struct acpi_opcode_info
{
648 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
649 char *name
; /* Opcode name (disassembler/debug only) */
651 u32 parse_args
; /* Grammar/Parse time arguments */
652 u32 runtime_args
; /* Interpret time arguments */
653 u16 flags
; /* Misc flags */
654 u8 object_type
; /* Corresponding internal object type */
655 u8
class; /* Opcode class */
656 u8 type
; /* Opcode type */
659 union acpi_parse_value
{
660 u64 integer
; /* Integer constant (Up to 64 bits) */
661 u32 size
; /* bytelist or field size */
662 char *string
; /* NULL terminated string */
663 u8
*buffer
; /* buffer or string */
664 char *name
; /* NULL terminated string */
665 union acpi_parse_object
*arg
; /* arguments and contained ops */
668 #ifdef ACPI_DISASSEMBLER
669 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
671 #define ACPI_DISASM_ONLY_MEMBERS(a)
674 #define ACPI_PARSE_COMMON \
675 union acpi_parse_object *parent; /* Parent op */\
676 u8 descriptor_type; /* To differentiate various internal objs */\
677 u8 flags; /* Type of Op */\
678 u16 aml_opcode; /* AML opcode */\
679 u32 aml_offset; /* Offset of declaration in AML */\
680 union acpi_parse_object *next; /* Next op */\
681 struct acpi_namespace_node *node; /* For use by interpreter */\
682 union acpi_parse_value value; /* Value or args associated with the opcode */\
683 u8 arg_list_length; /* Number of elements in the arg list */\
684 ACPI_DISASM_ONLY_MEMBERS (\
685 u8 disasm_flags; /* Used during AML disassembly */\
686 u8 disasm_opcode; /* Subtype used for disassembly */\
687 char aml_op_name[16]) /* Op name (debug only) */
689 #define ACPI_DASM_BUFFER 0x00
690 #define ACPI_DASM_RESOURCE 0x01
691 #define ACPI_DASM_STRING 0x02
692 #define ACPI_DASM_UNICODE 0x03
693 #define ACPI_DASM_EISAID 0x04
694 #define ACPI_DASM_MATCHOP 0x05
695 #define ACPI_DASM_LNOT_PREFIX 0x06
696 #define ACPI_DASM_LNOT_SUFFIX 0x07
697 #define ACPI_DASM_IGNORE 0x08
700 * Generic operation (for example: If, While, Store)
702 struct acpi_parse_obj_common
{
706 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
709 struct acpi_parse_obj_named
{
710 ACPI_PARSE_COMMON u8
*path
;
711 u8
*data
; /* AML body or bytelist data */
712 u32 length
; /* AML length */
713 u32 name
; /* 4-byte name or zero if no name */
716 /* This version is used by the i_aSL compiler only */
718 #define ACPI_MAX_PARSEOP_NAME 20
720 struct acpi_parse_obj_asl
{
721 ACPI_PARSE_COMMON
union acpi_parse_object
*child
;
722 union acpi_parse_object
*parent_method
;
730 u32 logical_line_number
;
731 u32 logical_byte_offset
;
733 u32 end_logical_line
;
736 u32 aml_subtree_length
;
737 u32 final_aml_length
;
738 u32 final_aml_offset
;
741 u8 aml_opcode_length
;
742 u8 aml_pkg_len_bytes
;
744 char parse_op_name
[ACPI_MAX_PARSEOP_NAME
];
747 union acpi_parse_object
{
748 struct acpi_parse_obj_common common
;
749 struct acpi_parse_obj_named named
;
750 struct acpi_parse_obj_asl asl
;
754 * Parse state - one state per parser invocation and each control
757 struct acpi_parse_state
{
758 u8
*aml_start
; /* First AML byte */
759 u8
*aml
; /* Next AML byte */
760 u8
*aml_end
; /* (last + 1) AML byte */
761 u8
*pkg_start
; /* Current package begin */
762 u8
*pkg_end
; /* Current package end */
763 union acpi_parse_object
*start_op
; /* Root of parse tree */
764 struct acpi_namespace_node
*start_node
;
765 union acpi_generic_state
*scope
; /* Current scope */
766 union acpi_parse_object
*start_scope
;
770 /* Parse object flags */
772 #define ACPI_PARSEOP_GENERIC 0x01
773 #define ACPI_PARSEOP_NAMED 0x02
774 #define ACPI_PARSEOP_DEFERRED 0x04
775 #define ACPI_PARSEOP_BYTELIST 0x08
776 #define ACPI_PARSEOP_IN_STACK 0x10
777 #define ACPI_PARSEOP_TARGET 0x20
778 #define ACPI_PARSEOP_IN_CACHE 0x80
780 /* Parse object disasm_flags */
782 #define ACPI_PARSEOP_IGNORE 0x01
783 #define ACPI_PARSEOP_PARAMLIST 0x02
784 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
785 #define ACPI_PARSEOP_SPECIAL 0x10
787 /*****************************************************************************
789 * Hardware (ACPI registers) and PNP
791 ****************************************************************************/
793 struct acpi_bit_register_info
{
800 * Some ACPI registers have bits that must be ignored -- meaning that they
803 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
805 /* Write-only bits must be zeroed by software */
807 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
809 /* For control registers, both ignored and reserved bits must be preserved */
812 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
813 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
814 * bit position", section 4.7.3.2.1. However, on some machines the OS must
815 * write a one to this bit after resume for the machine to work properly.
816 * To enable this, we no longer attempt to preserve this bit. No machines
817 * are known to fail if the bit is not preserved. (May 2009)
819 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
820 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
821 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
822 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
824 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
828 * These are the full ACPI registers
830 #define ACPI_REGISTER_PM1_STATUS 0x01
831 #define ACPI_REGISTER_PM1_ENABLE 0x02
832 #define ACPI_REGISTER_PM1_CONTROL 0x03
833 #define ACPI_REGISTER_PM2_CONTROL 0x04
834 #define ACPI_REGISTER_PM_TIMER 0x05
835 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
836 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
838 /* Masks used to access the bit_registers */
840 #define ACPI_BITMASK_TIMER_STATUS 0x0001
841 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
842 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
843 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
844 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
845 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
846 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
847 #define ACPI_BITMASK_WAKE_STATUS 0x8000
849 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
850 ACPI_BITMASK_TIMER_STATUS | \
851 ACPI_BITMASK_BUS_MASTER_STATUS | \
852 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
853 ACPI_BITMASK_POWER_BUTTON_STATUS | \
854 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
855 ACPI_BITMASK_RT_CLOCK_STATUS | \
856 ACPI_BITMASK_WAKE_STATUS)
858 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
859 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
860 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
861 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
862 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
863 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
865 #define ACPI_BITMASK_SCI_ENABLE 0x0001
866 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
867 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
868 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
869 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
871 #define ACPI_BITMASK_ARB_DISABLE 0x0001
873 /* Raw bit position of each bit_register */
875 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
876 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
877 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
878 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
879 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
880 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
881 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
882 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
884 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
885 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
886 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
887 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
888 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
889 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
891 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
892 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
893 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
894 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
895 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
897 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
899 /* Structs and definitions for _OSI support and I/O port validation */
901 #define ACPI_OSI_WIN_2000 0x01
902 #define ACPI_OSI_WIN_XP 0x02
903 #define ACPI_OSI_WIN_XP_SP1 0x03
904 #define ACPI_OSI_WINSRV_2003 0x04
905 #define ACPI_OSI_WIN_XP_SP2 0x05
906 #define ACPI_OSI_WINSRV_2003_SP1 0x06
907 #define ACPI_OSI_WIN_VISTA 0x07
908 #define ACPI_OSI_WINSRV_2008 0x08
909 #define ACPI_OSI_WIN_VISTA_SP1 0x09
910 #define ACPI_OSI_WIN_7 0x0A
912 #define ACPI_ALWAYS_ILLEGAL 0x00
914 struct acpi_interface_info
{
919 struct acpi_port_info
{
926 /*****************************************************************************
928 * Resource descriptors
930 ****************************************************************************/
932 /* resource_type values */
934 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
935 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
936 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
938 /* Resource descriptor types and masks */
940 #define ACPI_RESOURCE_NAME_LARGE 0x80
941 #define ACPI_RESOURCE_NAME_SMALL 0x00
943 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
944 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
945 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
948 * Small resource descriptor "names" as defined by the ACPI specification.
949 * Note: Bits 2:0 are used for the descriptor length
951 #define ACPI_RESOURCE_NAME_IRQ 0x20
952 #define ACPI_RESOURCE_NAME_DMA 0x28
953 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
954 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
955 #define ACPI_RESOURCE_NAME_IO 0x40
956 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
957 #define ACPI_RESOURCE_NAME_RESERVED_S1 0x50
958 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
959 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
960 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
961 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
962 #define ACPI_RESOURCE_NAME_END_TAG 0x78
965 * Large resource descriptor "names" as defined by the ACPI specification.
966 * Note: includes the Large Descriptor bit in bit[7]
968 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
969 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
970 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
971 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
972 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
973 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
974 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
975 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
976 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
977 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
978 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
979 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B
981 /*****************************************************************************
985 ****************************************************************************/
987 #define ACPI_ASCII_ZERO 0x30
989 /*****************************************************************************
993 ****************************************************************************/
995 struct acpi_db_method_info
{
996 acpi_handle main_thread_gate
;
997 acpi_handle thread_complete_gate
;
1010 * Arguments to be passed to method for the command
1012 * the Number of threads, ID of current thread and
1013 * Index of current thread inside all them created.
1017 char num_threads_str
[11];
1018 char id_of_thread_str
[11];
1019 char index_of_thread_str
[11];
1022 struct acpi_integrity_info
{
1027 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1028 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1029 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1031 /*****************************************************************************
1035 ****************************************************************************/
1037 /* Entry for a memory allocation (debug only) */
1039 #define ACPI_MEM_MALLOC 0
1040 #define ACPI_MEM_CALLOC 1
1041 #define ACPI_MAX_MODULE_NAME 16
1043 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1044 struct acpi_debug_mem_block *previous; \
1045 struct acpi_debug_mem_block *next; \
1049 char module[ACPI_MAX_MODULE_NAME]; \
1052 struct acpi_debug_mem_header
{
1053 ACPI_COMMON_DEBUG_MEM_HEADER
};
1055 struct acpi_debug_mem_block
{
1056 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space
;
1059 #define ACPI_MEM_LIST_GLOBAL 0
1060 #define ACPI_MEM_LIST_NSNODE 1
1061 #define ACPI_MEM_LIST_MAX 1
1062 #define ACPI_NUM_MEM_LISTS 2
1064 #endif /* __ACLOCAL_H__ */