s390/ptrace: get rid of long longs in psw_bits
[linux/fpc-iii.git] / drivers / acpi / acpica / aclocal.h
blobe1dd784d851599e12a8adbf831d3f560f3c0dc94
1 /******************************************************************************
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2015, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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.
44 #ifndef __ACLOCAL_H__
45 #define __ACLOCAL_H__
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
78 * table below also!
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 */
87 #define ACPI_MAX_MUTEX 5
88 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
90 /* Lock structure for reader/writer interfaces */
92 struct acpi_rw_lock {
93 acpi_mutex writer_mutex;
94 acpi_mutex reader_mutex;
95 u32 num_readers;
99 * Predefined handles for spinlocks used within the subsystem.
100 * These spinlocks are created by acpi_ut_mutex_initialize
102 #define ACPI_LOCK_GPES 0
103 #define ACPI_LOCK_HARDWARE 1
105 #define ACPI_MAX_LOCK 1
106 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
108 /* This Thread ID means that the mutex is not in use (unlocked) */
110 #define ACPI_MUTEX_NOT_ACQUIRED (acpi_thread_id) 0
112 /* This Thread ID means an invalid thread ID */
114 #ifdef ACPI_OS_INVALID_THREAD_ID
115 #define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID
116 #else
117 #define ACPI_INVALID_THREAD_ID ((acpi_thread_id) 0xFFFFFFFF)
118 #endif
120 /* Table for the global mutexes */
122 struct acpi_mutex_info {
123 acpi_mutex mutex;
124 u32 use_count;
125 acpi_thread_id thread_id;
128 /* Lock flag parameter for various interfaces */
130 #define ACPI_MTX_DO_NOT_LOCK 0
131 #define ACPI_MTX_LOCK 1
133 /* Field access granularities */
135 #define ACPI_FIELD_BYTE_GRANULARITY 1
136 #define ACPI_FIELD_WORD_GRANULARITY 2
137 #define ACPI_FIELD_DWORD_GRANULARITY 4
138 #define ACPI_FIELD_QWORD_GRANULARITY 8
140 #define ACPI_ENTRY_NOT_FOUND NULL
142 /*****************************************************************************
144 * Namespace typedefs and structs
146 ****************************************************************************/
148 /* Operational modes of the AML interpreter/scanner */
150 typedef enum {
151 ACPI_IMODE_LOAD_PASS1 = 0x01,
152 ACPI_IMODE_LOAD_PASS2 = 0x02,
153 ACPI_IMODE_EXECUTE = 0x03
154 } acpi_interpreter_mode;
157 * The Namespace Node describes a named object that appears in the AML.
158 * descriptor_type is used to differentiate between internal descriptors.
160 * The node is optimized for both 32-bit and 64-bit platforms:
161 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
163 * Note: The descriptor_type and Type fields must appear in the identical
164 * position in both the struct acpi_namespace_node and union acpi_operand_object
165 * structures.
167 struct acpi_namespace_node {
168 union acpi_operand_object *object; /* Interpreter object */
169 u8 descriptor_type; /* Differentiate object descriptor types */
170 u8 type; /* ACPI Type associated with this name */
171 u8 flags; /* Miscellaneous flags */
172 acpi_owner_id owner_id; /* Node creator */
173 union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */
174 struct acpi_namespace_node *parent; /* Parent node */
175 struct acpi_namespace_node *child; /* First child */
176 struct acpi_namespace_node *peer; /* First peer */
179 * The following fields are used by the ASL compiler and disassembler only
181 #ifdef ACPI_LARGE_NAMESPACE_NODE
182 union acpi_parse_object *op;
183 void *method_locals;
184 void *method_args;
185 u32 value;
186 u32 length;
187 u8 arg_count;
189 #endif
192 /* Namespace Node flags */
194 #define ANOBJ_RESERVED 0x01 /* Available for use */
195 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
196 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
197 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
198 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
199 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
200 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
202 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
203 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
204 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
205 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
207 /* Internal ACPI table management - master table list */
209 struct acpi_table_list {
210 struct acpi_table_desc *tables; /* Table descriptor array */
211 u32 current_table_count; /* Tables currently in the array */
212 u32 max_table_count; /* Max tables array will hold */
213 u8 flags;
216 /* Flags for above */
218 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
219 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
220 #define ACPI_ROOT_ALLOW_RESIZE (2)
222 /* Predefined table indexes */
224 #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF)
226 struct acpi_find_context {
227 char *search_for;
228 acpi_handle *list;
229 u32 *count;
232 struct acpi_ns_search_data {
233 struct acpi_namespace_node *node;
236 /* Object types used during package copies */
238 #define ACPI_COPY_TYPE_SIMPLE 0
239 #define ACPI_COPY_TYPE_PACKAGE 1
241 /* Info structure used to convert external<->internal namestrings */
243 struct acpi_namestring_info {
244 const char *external_name;
245 const char *next_external_char;
246 char *internal_name;
247 u32 length;
248 u32 num_segments;
249 u32 num_carats;
250 u8 fully_qualified;
253 /* Field creation info */
255 struct acpi_create_field_info {
256 struct acpi_namespace_node *region_node;
257 struct acpi_namespace_node *field_node;
258 struct acpi_namespace_node *register_node;
259 struct acpi_namespace_node *data_register_node;
260 struct acpi_namespace_node *connection_node;
261 u8 *resource_buffer;
262 u32 bank_value;
263 u32 field_bit_position;
264 u32 field_bit_length;
265 u16 resource_length;
266 u16 pin_number_index;
267 u8 field_flags;
268 u8 attribute;
269 u8 field_type;
270 u8 access_length;
273 typedef
274 acpi_status(*acpi_internal_method) (struct acpi_walk_state * walk_state);
277 * Bitmapped ACPI types. Used internally only
279 #define ACPI_BTYPE_ANY 0x00000000
280 #define ACPI_BTYPE_INTEGER 0x00000001
281 #define ACPI_BTYPE_STRING 0x00000002
282 #define ACPI_BTYPE_BUFFER 0x00000004
283 #define ACPI_BTYPE_PACKAGE 0x00000008
284 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
285 #define ACPI_BTYPE_DEVICE 0x00000020
286 #define ACPI_BTYPE_EVENT 0x00000040
287 #define ACPI_BTYPE_METHOD 0x00000080
288 #define ACPI_BTYPE_MUTEX 0x00000100
289 #define ACPI_BTYPE_REGION 0x00000200
290 #define ACPI_BTYPE_POWER 0x00000400
291 #define ACPI_BTYPE_PROCESSOR 0x00000800
292 #define ACPI_BTYPE_THERMAL 0x00001000
293 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
294 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
295 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
296 #define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), ref_of(), etc (type6_opcodes) */
297 #define ACPI_BTYPE_RESOURCE 0x00020000
298 #define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */
300 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
302 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
304 /* Used by Copy, de_ref_of, Store, Printf, Fprintf */
306 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE)
307 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
308 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
309 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
311 #pragma pack(1)
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];
323 u16 argument_list;
324 u8 expected_btypes;
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,
338 * ACPI_PTYPE2_FIX_VAR
340 struct acpi_package_info {
341 u8 type;
342 u8 object_type1;
343 u8 count1;
344 u8 object_type2;
345 u8 count2;
346 u16 reserved;
349 /* Used for ACPI_PTYPE2_FIXED */
351 struct acpi_package_info2 {
352 u8 type;
353 u8 count;
354 u8 object_type[4];
355 u8 reserved;
358 /* Used for ACPI_PTYPE1_OPTION */
360 struct acpi_package_info3 {
361 u8 type;
362 u8 count;
363 u8 object_type[2];
364 u8 tail_object_type;
365 u16 reserved;
368 struct acpi_package_info4 {
369 u8 type;
370 u8 object_type1;
371 u8 count1;
372 u8 sub_object_types;
373 u8 pkg_count;
374 u16 reserved;
377 union acpi_predefined_info {
378 struct acpi_name_info info;
379 struct acpi_package_info ret_info;
380 struct acpi_package_info2 ret_info2;
381 struct acpi_package_info3 ret_info3;
382 struct acpi_package_info4 ret_info4;
385 /* Reset to default packing */
387 #pragma pack()
389 /* Return object auto-repair info */
391 typedef acpi_status(*acpi_object_converter) (union acpi_operand_object
392 *original_object,
393 union acpi_operand_object
394 **converted_object);
396 struct acpi_simple_repair_info {
397 char name[ACPI_NAME_SIZE];
398 u32 unexpected_btypes;
399 u32 package_index;
400 acpi_object_converter object_converter;
404 * Bitmapped return value types
405 * Note: the actual data types must be contiguous, a loop in nspredef.c
406 * depends on this.
408 #define ACPI_RTYPE_ANY 0x00
409 #define ACPI_RTYPE_NONE 0x01
410 #define ACPI_RTYPE_INTEGER 0x02
411 #define ACPI_RTYPE_STRING 0x04
412 #define ACPI_RTYPE_BUFFER 0x08
413 #define ACPI_RTYPE_PACKAGE 0x10
414 #define ACPI_RTYPE_REFERENCE 0x20
415 #define ACPI_RTYPE_ALL 0x3F
417 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
419 /* Info for running the _REG methods */
421 struct acpi_reg_walk_info {
422 acpi_adr_space_type space_id;
423 u32 reg_run_count;
426 /*****************************************************************************
428 * Event typedefs and structs
430 ****************************************************************************/
432 /* Dispatch info for each host-installed SCI handler */
434 struct acpi_sci_handler_info {
435 struct acpi_sci_handler_info *next;
436 acpi_sci_handler address; /* Address of handler */
437 void *context; /* Context to be passed to handler */
440 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
442 struct acpi_gpe_handler_info {
443 acpi_gpe_handler address; /* Address of handler, if any */
444 void *context; /* Context to be passed to handler */
445 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
446 u8 original_flags; /* Original (pre-handler) GPE info */
447 u8 originally_enabled; /* True if GPE was originally enabled */
450 /* Notify info for implicit notify, multiple device objects */
452 struct acpi_gpe_notify_info {
453 struct acpi_namespace_node *device_node; /* Device to be notified */
454 struct acpi_gpe_notify_info *next;
458 * GPE dispatch info. At any time, the GPE can have at most one type
459 * of dispatch - Method, Handler, or Implicit Notify.
461 union acpi_gpe_dispatch_info {
462 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
463 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */
464 struct acpi_gpe_notify_info *notify_list; /* List of _PRW devices for implicit notifies */
468 * Information about a GPE, one per each GPE in an array.
469 * NOTE: Important to keep this struct as small as possible.
471 struct acpi_gpe_event_info {
472 union acpi_gpe_dispatch_info dispatch; /* Either Method, Handler, or notify_list */
473 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
474 u8 flags; /* Misc info about this GPE */
475 u8 gpe_number; /* This GPE */
476 u8 runtime_count; /* References to a run GPE */
479 /* Information about a GPE register pair, one per each status/enable pair in an array */
481 struct acpi_gpe_register_info {
482 struct acpi_generic_address status_address; /* Address of status reg */
483 struct acpi_generic_address enable_address; /* Address of enable reg */
484 u16 base_gpe_number; /* Base GPE number for this register */
485 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
486 u8 enable_for_run; /* GPEs to keep enabled when running */
487 u8 enable_mask; /* Current mask of enabled GPEs */
491 * Information about a GPE register block, one per each installed block --
492 * GPE0, GPE1, and one per each installed GPE Block Device.
494 struct acpi_gpe_block_info {
495 struct acpi_namespace_node *node;
496 struct acpi_gpe_block_info *previous;
497 struct acpi_gpe_block_info *next;
498 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
499 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
500 struct acpi_gpe_event_info *event_info; /* One for each GPE */
501 u64 address; /* Base address of the block */
502 u32 register_count; /* Number of register pairs in block */
503 u16 gpe_count; /* Number of individual GPEs in block */
504 u16 block_base_number; /* Base GPE number for this block */
505 u8 space_id;
506 u8 initialized; /* TRUE if this block is initialized */
509 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
511 struct acpi_gpe_xrupt_info {
512 struct acpi_gpe_xrupt_info *previous;
513 struct acpi_gpe_xrupt_info *next;
514 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
515 u32 interrupt_number; /* System interrupt number */
518 struct acpi_gpe_walk_info {
519 struct acpi_namespace_node *gpe_device;
520 struct acpi_gpe_block_info *gpe_block;
521 u16 count;
522 acpi_owner_id owner_id;
523 u8 execute_by_owner_id;
526 struct acpi_gpe_device_info {
527 u32 index;
528 u32 next_block_base_index;
529 acpi_status status;
530 struct acpi_namespace_node *gpe_device;
533 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
534 gpe_xrupt_info,
535 struct acpi_gpe_block_info *gpe_block,
536 void *context);
538 /* Information about each particular fixed event */
540 struct acpi_fixed_event_handler {
541 acpi_event_handler handler; /* Address of handler. */
542 void *context; /* Context to be passed to handler */
545 struct acpi_fixed_event_info {
546 u8 status_register_id;
547 u8 enable_register_id;
548 u16 status_bit_mask;
549 u16 enable_bit_mask;
552 /* Information used during field processing */
554 struct acpi_field_info {
555 u8 skip_field;
556 u8 field_flag;
557 u32 pkg_length;
560 /*****************************************************************************
562 * Generic "state" object for stacks
564 ****************************************************************************/
566 #define ACPI_CONTROL_NORMAL 0xC0
567 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
568 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
569 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
570 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
572 #define ACPI_STATE_COMMON \
573 void *next; \
574 u8 descriptor_type; /* To differentiate various internal objs */\
575 u8 flags; \
576 u16 value; \
577 u16 state;
579 /* There are 2 bytes available here until the next natural alignment boundary */
581 struct acpi_common_state {
582 ACPI_STATE_COMMON};
585 * Update state - used to traverse complex objects such as packages
587 struct acpi_update_state {
588 ACPI_STATE_COMMON union acpi_operand_object *object;
592 * Pkg state - used to traverse nested package structures
594 struct acpi_pkg_state {
595 ACPI_STATE_COMMON u16 index;
596 union acpi_operand_object *source_object;
597 union acpi_operand_object *dest_object;
598 struct acpi_walk_state *walk_state;
599 void *this_target_obj;
600 u32 num_packages;
604 * Control state - one per if/else and while constructs.
605 * Allows nesting of these constructs
607 struct acpi_control_state {
608 ACPI_STATE_COMMON u16 opcode;
609 union acpi_parse_object *predicate_op;
610 u8 *aml_predicate_start; /* Start of if/while predicate */
611 u8 *package_end; /* End of if/while block */
612 u32 loop_count; /* While() loop counter */
616 * Scope state - current scope during namespace lookups
618 struct acpi_scope_state {
619 ACPI_STATE_COMMON struct acpi_namespace_node *node;
622 struct acpi_pscope_state {
623 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
624 union acpi_parse_object *op; /* Current op being parsed */
625 u8 *arg_end; /* Current argument end */
626 u8 *pkg_end; /* Current package end */
627 u32 arg_list; /* Next argument to parse */
631 * Thread state - one per thread across multiple walk states. Multiple walk
632 * states are created when there are nested control methods executing.
634 struct acpi_thread_state {
635 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
636 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
637 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
638 acpi_thread_id thread_id; /* Running thread ID */
642 * Result values - used to accumulate the results of nested
643 * AML arguments
645 struct acpi_result_values {
646 ACPI_STATE_COMMON
647 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
650 typedef
651 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
652 union acpi_parse_object ** out_op);
654 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
656 /* Global handlers for AML Notifies */
658 struct acpi_global_notify_handler {
659 acpi_notify_handler handler;
660 void *context;
664 * Notify info - used to pass info to the deferred notify
665 * handler/dispatcher.
667 struct acpi_notify_info {
668 ACPI_STATE_COMMON u8 handler_list_id;
669 struct acpi_namespace_node *node;
670 union acpi_operand_object *handler_list_head;
671 struct acpi_global_notify_handler *global;
674 /* Generic state is union of structs above */
676 union acpi_generic_state {
677 struct acpi_common_state common;
678 struct acpi_control_state control;
679 struct acpi_update_state update;
680 struct acpi_scope_state scope;
681 struct acpi_pscope_state parse_scope;
682 struct acpi_pkg_state pkg;
683 struct acpi_thread_state thread;
684 struct acpi_result_values results;
685 struct acpi_notify_info notify;
688 /*****************************************************************************
690 * Interpreter typedefs and structs
692 ****************************************************************************/
694 typedef acpi_status(*acpi_execute_op) (struct acpi_walk_state * walk_state);
696 /* Address Range info block */
698 struct acpi_address_range {
699 struct acpi_address_range *next;
700 struct acpi_namespace_node *region_node;
701 acpi_physical_address start_address;
702 acpi_physical_address end_address;
705 /*****************************************************************************
707 * Parser typedefs and structs
709 ****************************************************************************/
712 * AML opcode, name, and argument layout
714 struct acpi_opcode_info {
715 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
716 char *name; /* Opcode name (disassembler/debug only) */
717 #endif
718 u32 parse_args; /* Grammar/Parse time arguments */
719 u32 runtime_args; /* Interpret time arguments */
720 u16 flags; /* Misc flags */
721 u8 object_type; /* Corresponding internal object type */
722 u8 class; /* Opcode class */
723 u8 type; /* Opcode type */
726 /* Value associated with the parse object */
728 union acpi_parse_value {
729 u64 integer; /* Integer constant (Up to 64 bits) */
730 u32 size; /* bytelist or field size */
731 char *string; /* NULL terminated string */
732 u8 *buffer; /* buffer or string */
733 char *name; /* NULL terminated string */
734 union acpi_parse_object *arg; /* arguments and contained ops */
737 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
738 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
739 #else
740 #define ACPI_DISASM_ONLY_MEMBERS(a)
741 #endif
743 #define ACPI_PARSE_COMMON \
744 union acpi_parse_object *parent; /* Parent op */\
745 u8 descriptor_type; /* To differentiate various internal objs */\
746 u8 flags; /* Type of Op */\
747 u16 aml_opcode; /* AML opcode */\
748 u8 *aml; /* Address of declaration in AML */\
749 union acpi_parse_object *next; /* Next op */\
750 struct acpi_namespace_node *node; /* For use by interpreter */\
751 union acpi_parse_value value; /* Value or args associated with the opcode */\
752 u8 arg_list_length; /* Number of elements in the arg list */\
753 ACPI_DISASM_ONLY_MEMBERS (\
754 u8 disasm_flags; /* Used during AML disassembly */\
755 u8 disasm_opcode; /* Subtype used for disassembly */\
756 char *operator_symbol;/* Used for C-style operator name strings */\
757 char aml_op_name[16]) /* Op name (debug only) */
759 /* Flags for disasm_flags field above */
761 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
762 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
763 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
764 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
765 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
766 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
767 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
768 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
769 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */
770 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */
771 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
772 #define ACPI_DASM_IGNORE 0x0B /* Not used at this time */
775 * Generic operation (for example: If, While, Store)
777 struct acpi_parse_obj_common {
778 ACPI_PARSE_COMMON};
781 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
782 * and bytelists.
784 struct acpi_parse_obj_named {
785 ACPI_PARSE_COMMON u8 *path;
786 u8 *data; /* AML body or bytelist data */
787 u32 length; /* AML length */
788 u32 name; /* 4-byte name or zero if no name */
791 /* This version is used by the iASL compiler only */
793 #define ACPI_MAX_PARSEOP_NAME 20
795 struct acpi_parse_obj_asl {
796 ACPI_PARSE_COMMON union acpi_parse_object *child;
797 union acpi_parse_object *parent_method;
798 char *filename;
799 char *external_name;
800 char *namepath;
801 char name_seg[4];
802 u32 extra_value;
803 u32 column;
804 u32 line_number;
805 u32 logical_line_number;
806 u32 logical_byte_offset;
807 u32 end_line;
808 u32 end_logical_line;
809 u32 acpi_btype;
810 u32 aml_length;
811 u32 aml_subtree_length;
812 u32 final_aml_length;
813 u32 final_aml_offset;
814 u32 compile_flags;
815 u16 parse_opcode;
816 u8 aml_opcode_length;
817 u8 aml_pkg_len_bytes;
818 u8 extra;
819 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
822 union acpi_parse_object {
823 struct acpi_parse_obj_common common;
824 struct acpi_parse_obj_named named;
825 struct acpi_parse_obj_asl asl;
829 * Parse state - one state per parser invocation and each control
830 * method.
832 struct acpi_parse_state {
833 u8 *aml_start; /* First AML byte */
834 u8 *aml; /* Next AML byte */
835 u8 *aml_end; /* (last + 1) AML byte */
836 u8 *pkg_start; /* Current package begin */
837 u8 *pkg_end; /* Current package end */
838 union acpi_parse_object *start_op; /* Root of parse tree */
839 struct acpi_namespace_node *start_node;
840 union acpi_generic_state *scope; /* Current scope */
841 union acpi_parse_object *start_scope;
842 u32 aml_size;
845 /* Parse object flags */
847 #define ACPI_PARSEOP_GENERIC 0x01
848 #define ACPI_PARSEOP_NAMED 0x02
849 #define ACPI_PARSEOP_DEFERRED 0x04
850 #define ACPI_PARSEOP_BYTELIST 0x08
851 #define ACPI_PARSEOP_IN_STACK 0x10
852 #define ACPI_PARSEOP_TARGET 0x20
853 #define ACPI_PARSEOP_IN_CACHE 0x80
855 /* Parse object disasm_flags */
857 #define ACPI_PARSEOP_IGNORE 0x01
858 #define ACPI_PARSEOP_PARAMLIST 0x02
859 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
860 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
861 #define ACPI_PARSEOP_CLOSING_PAREN 0x10
862 #define ACPI_PARSEOP_COMPOUND 0x20
863 #define ACPI_PARSEOP_ASSIGNMENT 0x40
865 /*****************************************************************************
867 * Hardware (ACPI registers) and PNP
869 ****************************************************************************/
871 struct acpi_bit_register_info {
872 u8 parent_register;
873 u8 bit_position;
874 u16 access_bit_mask;
878 * Some ACPI registers have bits that must be ignored -- meaning that they
879 * must be preserved.
881 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
883 /* Write-only bits must be zeroed by software */
885 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
887 /* For control registers, both ignored and reserved bits must be preserved */
890 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
891 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
892 * bit position", section 4.7.3.2.1. However, on some machines the OS must
893 * write a one to this bit after resume for the machine to work properly.
894 * To enable this, we no longer attempt to preserve this bit. No machines
895 * are known to fail if the bit is not preserved. (May 2009)
897 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
898 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
899 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
900 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
902 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
905 * Register IDs
906 * These are the full ACPI registers
908 #define ACPI_REGISTER_PM1_STATUS 0x01
909 #define ACPI_REGISTER_PM1_ENABLE 0x02
910 #define ACPI_REGISTER_PM1_CONTROL 0x03
911 #define ACPI_REGISTER_PM2_CONTROL 0x04
912 #define ACPI_REGISTER_PM_TIMER 0x05
913 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
914 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
916 /* Masks used to access the bit_registers */
918 #define ACPI_BITMASK_TIMER_STATUS 0x0001
919 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
920 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
921 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
922 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
923 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
924 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
925 #define ACPI_BITMASK_WAKE_STATUS 0x8000
927 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
928 ACPI_BITMASK_TIMER_STATUS | \
929 ACPI_BITMASK_BUS_MASTER_STATUS | \
930 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
931 ACPI_BITMASK_POWER_BUTTON_STATUS | \
932 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
933 ACPI_BITMASK_RT_CLOCK_STATUS | \
934 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
935 ACPI_BITMASK_WAKE_STATUS)
937 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
938 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
939 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
940 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
941 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
942 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
944 #define ACPI_BITMASK_SCI_ENABLE 0x0001
945 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
946 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
947 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
948 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
950 #define ACPI_BITMASK_ARB_DISABLE 0x0001
952 /* Raw bit position of each bit_register */
954 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
955 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
956 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
957 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
958 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
959 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
960 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
961 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
963 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
964 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
965 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
966 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
967 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
968 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
970 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
971 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
972 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
973 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
974 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
976 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
978 /* Structs and definitions for _OSI support and I/O port validation */
980 #define ACPI_ALWAYS_ILLEGAL 0x00
982 struct acpi_interface_info {
983 char *name;
984 struct acpi_interface_info *next;
985 u8 flags;
986 u8 value;
989 #define ACPI_OSI_INVALID 0x01
990 #define ACPI_OSI_DYNAMIC 0x02
991 #define ACPI_OSI_FEATURE 0x04
992 #define ACPI_OSI_DEFAULT_INVALID 0x08
993 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
995 struct acpi_port_info {
996 char *name;
997 u16 start;
998 u16 end;
999 u8 osi_dependency;
1002 /*****************************************************************************
1004 * Resource descriptors
1006 ****************************************************************************/
1008 /* resource_type values */
1010 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1011 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1012 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1014 /* Resource descriptor types and masks */
1016 #define ACPI_RESOURCE_NAME_LARGE 0x80
1017 #define ACPI_RESOURCE_NAME_SMALL 0x00
1019 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1020 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1021 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1024 * Small resource descriptor "names" as defined by the ACPI specification.
1025 * Note: Bits 2:0 are used for the descriptor length
1027 #define ACPI_RESOURCE_NAME_IRQ 0x20
1028 #define ACPI_RESOURCE_NAME_DMA 0x28
1029 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1030 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1031 #define ACPI_RESOURCE_NAME_IO 0x40
1032 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1033 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1034 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1035 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1036 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1037 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1038 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1041 * Large resource descriptor "names" as defined by the ACPI specification.
1042 * Note: includes the Large Descriptor bit in bit[7]
1044 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1045 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1046 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1047 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1048 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1049 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1050 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1051 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1052 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1053 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1054 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1055 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1056 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1057 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1059 /*****************************************************************************
1061 * Miscellaneous
1063 ****************************************************************************/
1065 #define ACPI_ASCII_ZERO 0x30
1067 /*****************************************************************************
1069 * Disassembler
1071 ****************************************************************************/
1073 struct acpi_external_list {
1074 char *path;
1075 char *internal_path;
1076 struct acpi_external_list *next;
1077 u32 value;
1078 u16 length;
1079 u16 flags;
1080 u8 type;
1083 /* Values for Flags field above */
1085 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1086 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1087 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1088 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1090 struct acpi_external_file {
1091 char *path;
1092 struct acpi_external_file *next;
1095 /*****************************************************************************
1097 * Debugger
1099 ****************************************************************************/
1101 struct acpi_db_method_info {
1102 acpi_handle method;
1103 acpi_handle main_thread_gate;
1104 acpi_handle thread_complete_gate;
1105 acpi_handle info_gate;
1106 acpi_thread_id *threads;
1107 u32 num_threads;
1108 u32 num_created;
1109 u32 num_completed;
1111 char *name;
1112 u32 flags;
1113 u32 num_loops;
1114 char pathname[ACPI_DB_LINE_BUFFER_SIZE];
1115 char **args;
1116 acpi_object_type *types;
1119 * Arguments to be passed to method for the command
1120 * Threads -
1121 * the Number of threads, ID of current thread and
1122 * Index of current thread inside all them created.
1124 char init_args;
1125 #ifdef ACPI_DEBUGGER
1126 acpi_object_type arg_types[4];
1127 #endif
1128 char *arguments[4];
1129 char num_threads_str[11];
1130 char id_of_thread_str[11];
1131 char index_of_thread_str[11];
1134 struct acpi_integrity_info {
1135 u32 nodes;
1136 u32 objects;
1139 #define ACPI_DB_DISABLE_OUTPUT 0x00
1140 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1141 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1142 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1144 struct acpi_object_info {
1145 u32 types[ACPI_TOTAL_TYPES];
1148 /*****************************************************************************
1150 * Debug
1152 ****************************************************************************/
1154 /* Entry for a memory allocation (debug only) */
1156 #define ACPI_MEM_MALLOC 0
1157 #define ACPI_MEM_CALLOC 1
1158 #define ACPI_MAX_MODULE_NAME 16
1160 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1161 struct acpi_debug_mem_block *previous; \
1162 struct acpi_debug_mem_block *next; \
1163 u32 size; \
1164 u32 component; \
1165 u32 line; \
1166 char module[ACPI_MAX_MODULE_NAME]; \
1167 u8 alloc_type;
1169 struct acpi_debug_mem_header {
1170 ACPI_COMMON_DEBUG_MEM_HEADER};
1172 struct acpi_debug_mem_block {
1173 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1176 #define ACPI_MEM_LIST_GLOBAL 0
1177 #define ACPI_MEM_LIST_NSNODE 1
1178 #define ACPI_MEM_LIST_MAX 1
1179 #define ACPI_NUM_MEM_LISTS 2
1181 /*****************************************************************************
1183 * Info/help support
1185 ****************************************************************************/
1187 struct ah_predefined_name {
1188 char *name;
1189 char *description;
1190 #ifndef ACPI_ASL_COMPILER
1191 char *action;
1192 #endif
1195 struct ah_device_id {
1196 char *name;
1197 char *description;
1200 struct ah_uuid {
1201 char *description;
1202 char *string;
1205 struct ah_table {
1206 char *signature;
1207 char *description;
1210 #endif /* __ACLOCAL_H__ */