ia64/linux-2.6.18-xen.hg

view include/acpi/aclocal.h @ 608:905f275ed4d8

From 2.6.19: Set SCI_EN when resuming from S3

When resuming from S3, some platforms may clear SCI_EN bit in
PM1_CONTROL register and cause SCI interrupt disabled in Domain0. This
patch fixes this issue as Linux-2.6.19 does.

Signed-off-by: Huacai Chen <huacai.chen@intel.com>
author Keir Fraser <keir.fraser@citrix.com>
date Mon Jul 21 09:51:36 2008 +0100 (2008-07-21)
parents 831230e53067
children
line source
1 /******************************************************************************
2 *
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
4 *
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2006, R. Byron Moore
9 * All rights reserved.
10 *
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.
25 *
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.
29 *
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.
42 */
44 #ifndef __ACLOCAL_H__
45 #define __ACLOCAL_H__
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 /*****************************************************************************
67 *
68 * Mutex typedefs and structs
69 *
70 ****************************************************************************/
72 /*
73 * Predefined handles for the mutex objects used within the subsystem
74 * All mutex objects are automatically created by acpi_ut_mutex_initialize.
75 *
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.
78 *
79 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
80 * table below also!
81 */
82 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
83 #define ACPI_MTX_TABLES 1 /* Data for ACPI tables */
84 #define ACPI_MTX_NAMESPACE 2 /* ACPI Namespace */
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_Tables",
102 "ACPI_MTX_Namespace",
103 "ACPI_MTX_Events",
104 "ACPI_MTX_Caches",
105 "ACPI_MTX_Memory",
106 "ACPI_MTX_CommandComplete",
107 "ACPI_MTX_CommandReady"
108 };
110 #endif
111 #endif
113 /*
114 * Predefined handles for spinlocks used within the subsystem.
115 * These spinlocks are created by acpi_ut_mutex_initialize
116 */
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 {
135 acpi_mutex mutex;
136 u32 use_count;
137 acpi_thread_id thread_id;
138 };
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 /*****************************************************************************
155 *
156 * Namespace typedefs and structs
157 *
158 ****************************************************************************/
160 /* Operational modes of the AML interpreter/scanner */
162 typedef enum {
163 ACPI_IMODE_LOAD_PASS1 = 0x01,
164 ACPI_IMODE_LOAD_PASS2 = 0x02,
165 ACPI_IMODE_EXECUTE = 0x0E
166 } acpi_interpreter_mode;
168 union acpi_name_union {
169 u32 integer;
170 char ascii[4];
171 };
173 /*
174 * The Namespace Node describes a named object that appears in the AML.
175 * descriptor_type is used to differentiate between internal descriptors.
176 *
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.
179 *
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
182 * structures.
183 */
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 */
194 /*
195 * The following fields are used by the ASL compiler and disassembler only
196 */
197 #ifdef ACPI_LARGE_NAMESPACE_NODE
198 union acpi_parse_object *op;
199 u32 value;
200 u32 length;
201 #endif
202 };
204 /* Namespace Node flags */
206 #define ANOBJ_END_OF_PEER_LIST 0x01 /* End-of-list, Peer field points to parent */
207 #define ANOBJ_RESERVED 0x02 /* Available for future use */
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 */
212 #define ANOBJ_IS_EXTERNAL 0x08 /* i_aSL only: This object created via External() */
213 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* i_aSL only: Method has no return value */
214 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* i_aSL only: Method has at least one return value */
215 #define ANOBJ_IS_BIT_OFFSET 0x40 /* i_aSL only: Reference is a bit offset */
216 #define ANOBJ_IS_REFERENCED 0x80 /* i_aSL only: Object was referenced */
218 /*
219 * ACPI Table Descriptor. One per ACPI table
220 */
221 struct acpi_table_desc {
222 struct acpi_table_desc *prev;
223 struct acpi_table_desc *next;
224 struct acpi_table_desc *installed_desc;
225 struct acpi_table_header *pointer;
226 u8 *aml_start;
227 u64 physical_address;
228 acpi_size length;
229 u32 aml_length;
230 acpi_owner_id owner_id;
231 u8 type;
232 u8 allocation;
233 u8 loaded_into_namespace;
234 };
236 struct acpi_table_list {
237 struct acpi_table_desc *next;
238 u32 count;
239 };
241 struct acpi_find_context {
242 char *search_for;
243 acpi_handle *list;
244 u32 *count;
245 };
247 struct acpi_ns_search_data {
248 struct acpi_namespace_node *node;
249 };
251 /*
252 * Predefined Namespace items
253 */
254 struct acpi_predefined_names {
255 char *name;
256 u8 type;
257 char *val;
258 };
260 /* Object types used during package copies */
262 #define ACPI_COPY_TYPE_SIMPLE 0
263 #define ACPI_COPY_TYPE_PACKAGE 1
265 /* Info structure used to convert external<->internal namestrings */
267 struct acpi_namestring_info {
268 char *external_name;
269 char *next_external_char;
270 char *internal_name;
271 u32 length;
272 u32 num_segments;
273 u32 num_carats;
274 u8 fully_qualified;
275 };
277 /* Field creation info */
279 struct acpi_create_field_info {
280 struct acpi_namespace_node *region_node;
281 struct acpi_namespace_node *field_node;
282 struct acpi_namespace_node *register_node;
283 struct acpi_namespace_node *data_register_node;
284 u32 bank_value;
285 u32 field_bit_position;
286 u32 field_bit_length;
287 u8 field_flags;
288 u8 attribute;
289 u8 field_type;
290 };
292 typedef
293 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
295 /*
296 * Bitmapped ACPI types. Used internally only
297 */
298 #define ACPI_BTYPE_ANY 0x00000000
299 #define ACPI_BTYPE_INTEGER 0x00000001
300 #define ACPI_BTYPE_STRING 0x00000002
301 #define ACPI_BTYPE_BUFFER 0x00000004
302 #define ACPI_BTYPE_PACKAGE 0x00000008
303 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
304 #define ACPI_BTYPE_DEVICE 0x00000020
305 #define ACPI_BTYPE_EVENT 0x00000040
306 #define ACPI_BTYPE_METHOD 0x00000080
307 #define ACPI_BTYPE_MUTEX 0x00000100
308 #define ACPI_BTYPE_REGION 0x00000200
309 #define ACPI_BTYPE_POWER 0x00000400
310 #define ACPI_BTYPE_PROCESSOR 0x00000800
311 #define ACPI_BTYPE_THERMAL 0x00001000
312 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
313 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
314 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
315 #define ACPI_BTYPE_REFERENCE 0x00010000
316 #define ACPI_BTYPE_RESOURCE 0x00020000
318 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
320 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
321 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
322 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
323 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
324 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
326 /*****************************************************************************
327 *
328 * Event typedefs and structs
329 *
330 ****************************************************************************/
332 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
334 struct acpi_handler_info {
335 acpi_event_handler address; /* Address of handler, if any */
336 void *context; /* Context to be passed to handler */
337 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
338 };
340 union acpi_gpe_dispatch_info {
341 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
342 struct acpi_handler_info *handler;
343 };
345 /*
346 * Information about a GPE, one per each GPE in an array.
347 * NOTE: Important to keep this struct as small as possible.
348 */
349 struct acpi_gpe_event_info {
350 union acpi_gpe_dispatch_info dispatch; /* Either Method or Handler */
351 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
352 u8 flags; /* Misc info about this GPE */
353 u8 register_bit; /* This GPE bit within the register */
354 };
356 /* Information about a GPE register pair, one per each status/enable pair in an array */
358 struct acpi_gpe_register_info {
359 struct acpi_generic_address status_address; /* Address of status reg */
360 struct acpi_generic_address enable_address; /* Address of enable reg */
361 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
362 u8 enable_for_run; /* GPEs to keep enabled when running */
363 u8 base_gpe_number; /* Base GPE number for this register */
364 };
366 /*
367 * Information about a GPE register block, one per each installed block --
368 * GPE0, GPE1, and one per each installed GPE Block Device.
369 */
370 struct acpi_gpe_block_info {
371 struct acpi_namespace_node *node;
372 struct acpi_gpe_block_info *previous;
373 struct acpi_gpe_block_info *next;
374 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
375 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
376 struct acpi_gpe_event_info *event_info; /* One for each GPE */
377 struct acpi_generic_address block_address; /* Base address of the block */
378 u32 register_count; /* Number of register pairs in block */
379 u8 block_base_number; /* Base GPE number for this block */
380 };
382 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
384 struct acpi_gpe_xrupt_info {
385 struct acpi_gpe_xrupt_info *previous;
386 struct acpi_gpe_xrupt_info *next;
387 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
388 u32 interrupt_number; /* System interrupt number */
389 };
391 struct acpi_gpe_walk_info {
392 struct acpi_namespace_node *gpe_device;
393 struct acpi_gpe_block_info *gpe_block;
394 };
396 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
397 gpe_xrupt_info,
398 struct acpi_gpe_block_info *
399 gpe_block);
401 /* Information about each particular fixed event */
403 struct acpi_fixed_event_handler {
404 acpi_event_handler handler; /* Address of handler. */
405 void *context; /* Context to be passed to handler */
406 };
408 struct acpi_fixed_event_info {
409 u8 status_register_id;
410 u8 enable_register_id;
411 u16 status_bit_mask;
412 u16 enable_bit_mask;
413 };
415 /* Information used during field processing */
417 struct acpi_field_info {
418 u8 skip_field;
419 u8 field_flag;
420 u32 pkg_length;
421 };
423 /*****************************************************************************
424 *
425 * Generic "state" object for stacks
426 *
427 ****************************************************************************/
429 #define ACPI_CONTROL_NORMAL 0xC0
430 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
431 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
432 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
433 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
435 #define ACPI_STATE_COMMON \
436 void *next; \
437 u8 descriptor_type; /* To differentiate various internal objs */\
438 u8 flags; \
439 u16 value; \
440 u16 state;
442 /* There are 2 bytes available here until the next natural alignment boundary */
444 struct acpi_common_state {
445 ACPI_STATE_COMMON};
447 /*
448 * Update state - used to traverse complex objects such as packages
449 */
450 struct acpi_update_state {
451 ACPI_STATE_COMMON union acpi_operand_object *object;
452 };
454 /*
455 * Pkg state - used to traverse nested package structures
456 */
457 struct acpi_pkg_state {
458 ACPI_STATE_COMMON u16 index;
459 union acpi_operand_object *source_object;
460 union acpi_operand_object *dest_object;
461 struct acpi_walk_state *walk_state;
462 void *this_target_obj;
463 u32 num_packages;
464 };
466 /*
467 * Control state - one per if/else and while constructs.
468 * Allows nesting of these constructs
469 */
470 struct acpi_control_state {
471 ACPI_STATE_COMMON u16 opcode;
472 union acpi_parse_object *predicate_op;
473 u8 *aml_predicate_start; /* Start of if/while predicate */
474 u8 *package_end; /* End of if/while block */
475 };
477 /*
478 * Scope state - current scope during namespace lookups
479 */
480 struct acpi_scope_state {
481 ACPI_STATE_COMMON struct acpi_namespace_node *node;
482 };
484 struct acpi_pscope_state {
485 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
486 union acpi_parse_object *op; /* Current op being parsed */
487 u8 *arg_end; /* Current argument end */
488 u8 *pkg_end; /* Current package end */
489 u32 arg_list; /* Next argument to parse */
490 };
492 /*
493 * Thread state - one per thread across multiple walk states. Multiple walk
494 * states are created when there are nested control methods executing.
495 */
496 struct acpi_thread_state {
497 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
498 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
499 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
500 acpi_thread_id thread_id; /* Running thread ID */
501 };
503 /*
504 * Result values - used to accumulate the results of nested
505 * AML arguments
506 */
507 struct acpi_result_values {
508 ACPI_STATE_COMMON u8 num_results;
509 u8 last_insert;
510 union acpi_operand_object *obj_desc[ACPI_OBJ_NUM_OPERANDS];
511 };
513 typedef
514 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
515 union acpi_parse_object ** out_op);
517 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
519 /*
520 * Notify info - used to pass info to the deferred notify
521 * handler/dispatcher.
522 */
523 struct acpi_notify_info {
524 ACPI_STATE_COMMON struct acpi_namespace_node *node;
525 union acpi_operand_object *handler_obj;
526 };
528 /* Generic state is union of structs above */
530 union acpi_generic_state {
531 struct acpi_common_state common;
532 struct acpi_control_state control;
533 struct acpi_update_state update;
534 struct acpi_scope_state scope;
535 struct acpi_pscope_state parse_scope;
536 struct acpi_pkg_state pkg;
537 struct acpi_thread_state thread;
538 struct acpi_result_values results;
539 struct acpi_notify_info notify;
540 };
542 /*****************************************************************************
543 *
544 * Interpreter typedefs and structs
545 *
546 ****************************************************************************/
548 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
550 /*****************************************************************************
551 *
552 * Parser typedefs and structs
553 *
554 ****************************************************************************/
556 /*
557 * AML opcode, name, and argument layout
558 */
559 struct acpi_opcode_info {
560 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
561 char *name; /* Opcode name (disassembler/debug only) */
562 #endif
563 u32 parse_args; /* Grammar/Parse time arguments */
564 u32 runtime_args; /* Interpret time arguments */
565 u16 flags; /* Misc flags */
566 u8 object_type; /* Corresponding internal object type */
567 u8 class; /* Opcode class */
568 u8 type; /* Opcode type */
569 };
571 union acpi_parse_value {
572 acpi_integer integer; /* Integer constant (Up to 64 bits) */
573 struct uint64_struct integer64; /* Structure overlay for 2 32-bit Dwords */
574 u32 size; /* bytelist or field size */
575 char *string; /* NULL terminated string */
576 u8 *buffer; /* buffer or string */
577 char *name; /* NULL terminated string */
578 union acpi_parse_object *arg; /* arguments and contained ops */
579 };
581 #define ACPI_PARSE_COMMON \
582 union acpi_parse_object *parent; /* Parent op */\
583 u8 descriptor_type; /* To differentiate various internal objs */\
584 u8 flags; /* Type of Op */\
585 u16 aml_opcode; /* AML opcode */\
586 u32 aml_offset; /* Offset of declaration in AML */\
587 union acpi_parse_object *next; /* Next op */\
588 struct acpi_namespace_node *node; /* For use by interpreter */\
589 union acpi_parse_value value; /* Value or args associated with the opcode */\
590 ACPI_DISASM_ONLY_MEMBERS (\
591 u8 disasm_flags; /* Used during AML disassembly */\
592 u8 disasm_opcode; /* Subtype used for disassembly */\
593 char aml_op_name[16]) /* Op name (debug only) */
595 #define ACPI_DASM_BUFFER 0x00
596 #define ACPI_DASM_RESOURCE 0x01
597 #define ACPI_DASM_STRING 0x02
598 #define ACPI_DASM_UNICODE 0x03
599 #define ACPI_DASM_EISAID 0x04
600 #define ACPI_DASM_MATCHOP 0x05
601 #define ACPI_DASM_LNOT_PREFIX 0x06
602 #define ACPI_DASM_LNOT_SUFFIX 0x07
603 #define ACPI_DASM_IGNORE 0x08
605 /*
606 * Generic operation (for example: If, While, Store)
607 */
608 struct acpi_parse_obj_common {
609 ACPI_PARSE_COMMON};
611 /*
612 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
613 * and bytelists.
614 */
615 struct acpi_parse_obj_named {
616 ACPI_PARSE_COMMON u8 * path;
617 u8 *data; /* AML body or bytelist data */
618 u32 length; /* AML length */
619 u32 name; /* 4-byte name or zero if no name */
620 };
622 /* This version is used by the i_aSL compiler only */
624 #define ACPI_MAX_PARSEOP_NAME 20
626 struct acpi_parse_obj_asl {
627 ACPI_PARSE_COMMON union acpi_parse_object *child;
628 union acpi_parse_object *parent_method;
629 char *filename;
630 char *external_name;
631 char *namepath;
632 char name_seg[4];
633 u32 extra_value;
634 u32 column;
635 u32 line_number;
636 u32 logical_line_number;
637 u32 logical_byte_offset;
638 u32 end_line;
639 u32 end_logical_line;
640 u32 acpi_btype;
641 u32 aml_length;
642 u32 aml_subtree_length;
643 u32 final_aml_length;
644 u32 final_aml_offset;
645 u32 compile_flags;
646 u16 parse_opcode;
647 u8 aml_opcode_length;
648 u8 aml_pkg_len_bytes;
649 u8 extra;
650 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
651 };
653 union acpi_parse_object {
654 struct acpi_parse_obj_common common;
655 struct acpi_parse_obj_named named;
656 struct acpi_parse_obj_asl asl;
657 };
659 /*
660 * Parse state - one state per parser invocation and each control
661 * method.
662 */
663 struct acpi_parse_state {
664 u8 *aml_start; /* First AML byte */
665 u8 *aml; /* Next AML byte */
666 u8 *aml_end; /* (last + 1) AML byte */
667 u8 *pkg_start; /* Current package begin */
668 u8 *pkg_end; /* Current package end */
669 union acpi_parse_object *start_op; /* Root of parse tree */
670 struct acpi_namespace_node *start_node;
671 union acpi_generic_state *scope; /* Current scope */
672 union acpi_parse_object *start_scope;
673 u32 aml_size;
674 };
676 /* Parse object flags */
678 #define ACPI_PARSEOP_GENERIC 0x01
679 #define ACPI_PARSEOP_NAMED 0x02
680 #define ACPI_PARSEOP_DEFERRED 0x04
681 #define ACPI_PARSEOP_BYTELIST 0x08
682 #define ACPI_PARSEOP_IN_CACHE 0x80
684 /* Parse object disasm_flags */
686 #define ACPI_PARSEOP_IGNORE 0x01
687 #define ACPI_PARSEOP_PARAMLIST 0x02
688 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
689 #define ACPI_PARSEOP_SPECIAL 0x10
691 /*****************************************************************************
692 *
693 * Hardware (ACPI registers) and PNP
694 *
695 ****************************************************************************/
697 #define PCI_ROOT_HID_STRING "PNP0A03"
698 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
700 struct acpi_bit_register_info {
701 u8 parent_register;
702 u8 bit_position;
703 u16 access_bit_mask;
704 };
706 /*
707 * Some ACPI registers have bits that must be ignored -- meaning that they
708 * must be preserved.
709 */
710 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
711 #define ACPI_PM1_CONTROL_PRESERVED_BITS 0x0200 /* Bit 9 (whatever) */
713 /*
714 * Register IDs
715 * These are the full ACPI registers
716 */
717 #define ACPI_REGISTER_PM1_STATUS 0x01
718 #define ACPI_REGISTER_PM1_ENABLE 0x02
719 #define ACPI_REGISTER_PM1_CONTROL 0x03
720 #define ACPI_REGISTER_PM1A_CONTROL 0x04
721 #define ACPI_REGISTER_PM1B_CONTROL 0x05
722 #define ACPI_REGISTER_PM2_CONTROL 0x06
723 #define ACPI_REGISTER_PM_TIMER 0x07
724 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x08
725 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x09
727 /* Masks used to access the bit_registers */
729 #define ACPI_BITMASK_TIMER_STATUS 0x0001
730 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
731 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
732 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
733 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
734 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
735 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
736 #define ACPI_BITMASK_WAKE_STATUS 0x8000
738 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
739 ACPI_BITMASK_TIMER_STATUS | \
740 ACPI_BITMASK_BUS_MASTER_STATUS | \
741 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
742 ACPI_BITMASK_POWER_BUTTON_STATUS | \
743 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
744 ACPI_BITMASK_RT_CLOCK_STATUS | \
745 ACPI_BITMASK_WAKE_STATUS)
747 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
748 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
749 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
750 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
751 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
752 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
754 #define ACPI_BITMASK_SCI_ENABLE 0x0001
755 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
756 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
757 #define ACPI_BITMASK_SLEEP_TYPE_X 0x1C00
758 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
760 #define ACPI_BITMASK_ARB_DISABLE 0x0001
762 /* Raw bit position of each bit_register */
764 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
765 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
766 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
767 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
768 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
769 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
770 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
771 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
773 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
774 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
775 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
776 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
777 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
778 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
780 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
781 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
782 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
783 #define ACPI_BITPOSITION_SLEEP_TYPE_X 0x0A
784 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
786 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
788 /*****************************************************************************
789 *
790 * Resource descriptors
791 *
792 ****************************************************************************/
794 /* resource_type values */
796 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
797 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
798 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
800 /* Resource descriptor types and masks */
802 #define ACPI_RESOURCE_NAME_LARGE 0x80
803 #define ACPI_RESOURCE_NAME_SMALL 0x00
805 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
806 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
807 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
809 /*
810 * Small resource descriptor "names" as defined by the ACPI specification.
811 * Note: Bits 2:0 are used for the descriptor length
812 */
813 #define ACPI_RESOURCE_NAME_IRQ 0x20
814 #define ACPI_RESOURCE_NAME_DMA 0x28
815 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
816 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
817 #define ACPI_RESOURCE_NAME_IO 0x40
818 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
819 #define ACPI_RESOURCE_NAME_RESERVED_S1 0x50
820 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
821 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
822 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
823 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
824 #define ACPI_RESOURCE_NAME_END_TAG 0x78
826 /*
827 * Large resource descriptor "names" as defined by the ACPI specification.
828 * Note: includes the Large Descriptor bit in bit[7]
829 */
830 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
831 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
832 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
833 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
834 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
835 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
836 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
837 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
838 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
839 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
840 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
841 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B
843 /*****************************************************************************
844 *
845 * Miscellaneous
846 *
847 ****************************************************************************/
849 #define ACPI_ASCII_ZERO 0x30
851 /*****************************************************************************
852 *
853 * Debugger
854 *
855 ****************************************************************************/
857 struct acpi_db_method_info {
858 acpi_handle thread_gate;
859 char *name;
860 char **args;
861 u32 flags;
862 u32 num_loops;
863 char pathname[128];
864 };
866 struct acpi_integrity_info {
867 u32 nodes;
868 u32 objects;
869 };
871 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
872 #define ACPI_DB_CONSOLE_OUTPUT 0x02
873 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
875 /*****************************************************************************
876 *
877 * Debug
878 *
879 ****************************************************************************/
881 /* Entry for a memory allocation (debug only) */
883 #define ACPI_MEM_MALLOC 0
884 #define ACPI_MEM_CALLOC 1
885 #define ACPI_MAX_MODULE_NAME 16
887 #define ACPI_COMMON_DEBUG_MEM_HEADER \
888 struct acpi_debug_mem_block *previous; \
889 struct acpi_debug_mem_block *next; \
890 u32 size; \
891 u32 component; \
892 u32 line; \
893 char module[ACPI_MAX_MODULE_NAME]; \
894 u8 alloc_type;
896 struct acpi_debug_mem_header {
897 ACPI_COMMON_DEBUG_MEM_HEADER};
899 struct acpi_debug_mem_block {
900 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
901 };
903 #define ACPI_MEM_LIST_GLOBAL 0
904 #define ACPI_MEM_LIST_NSNODE 1
905 #define ACPI_MEM_LIST_MAX 1
906 #define ACPI_NUM_MEM_LISTS 2
908 struct acpi_memory_list {
909 char *list_name;
910 void *list_head;
911 u16 object_size;
912 u16 max_depth;
913 u16 current_depth;
914 u16 link_offset;
916 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
918 /* Statistics for debug memory tracking only */
920 u32 total_allocated;
921 u32 total_freed;
922 u32 current_total_size;
923 u32 requests;
924 u32 hits;
925 #endif
926 };
928 #endif /* __ACLOCAL_H__ */