ia64/xen-unstable

view xen/include/acpi/aclocal.h @ 19836:d9890e67d2b7

tools: add SHAREDIR to buildmakevars2file

c/s 19818 dropped SHAREDIR from xen/util/path.py, which broke the "xm
new" command. This patch adds SHAREDIR back to the new
buildmakevars2file-closure function.

Signed-off-by: Ryan O'Connor <rjo@cs.ubc.ca>
author Keir Fraser <keir.fraser@citrix.com>
date Thu Jun 25 13:05:10 2009 +0100 (2009-06-25)
parents 13cba2e78a65
children
line source
1 /******************************************************************************
2 *
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
4 *
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2007, 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_NAMESPACE 1 /* ACPI Namespace */
84 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
85 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
86 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
87 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
88 #define ACPI_MTX_DEBUG_CMD_COMPLETE 6 /* AML debugger */
89 #define ACPI_MTX_DEBUG_CMD_READY 7 /* AML debugger */
91 #define ACPI_MAX_MUTEX 7
92 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
94 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
95 #ifdef DEFINE_ACPI_GLOBALS
97 /* Debug names for the mutexes above */
99 static char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = {
100 "ACPI_MTX_Interpreter",
101 "ACPI_MTX_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 = 0x03
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_TEMPORARY 0x02 /* Node is create by a method and is temporary */
208 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
209 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
210 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
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 acpi_physical_address address;
223 struct acpi_table_header *pointer;
224 u32 length; /* Length fixed at 32 bits */
225 union acpi_name_union signature;
226 acpi_owner_id owner_id;
227 u8 flags;
228 };
230 /* Flags for above */
232 #define ACPI_TABLE_ORIGIN_UNKNOWN (0)
233 #define ACPI_TABLE_ORIGIN_MAPPED (1)
234 #define ACPI_TABLE_ORIGIN_ALLOCATED (2)
235 #define ACPI_TABLE_ORIGIN_MASK (3)
236 #define ACPI_TABLE_IS_LOADED (4)
238 /* One internal RSDT for table management */
240 struct acpi_internal_rsdt {
241 struct acpi_table_desc *tables;
242 u32 count;
243 u32 size;
244 u8 flags;
245 };
247 /* Flags for above */
249 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
250 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
251 #define ACPI_ROOT_ALLOW_RESIZE (2)
253 /* Predefined (fixed) table indexes */
255 #define ACPI_TABLE_INDEX_DSDT (0)
256 #define ACPI_TABLE_INDEX_FACS (1)
258 struct acpi_find_context {
259 char *search_for;
260 acpi_handle *list;
261 u32 *count;
262 };
264 struct acpi_ns_search_data {
265 struct acpi_namespace_node *node;
266 };
268 /*
269 * Predefined Namespace items
270 */
271 struct acpi_predefined_names {
272 char *name;
273 u8 type;
274 char *val;
275 };
277 /* Object types used during package copies */
279 #define ACPI_COPY_TYPE_SIMPLE 0
280 #define ACPI_COPY_TYPE_PACKAGE 1
282 /* Info structure used to convert external<->internal namestrings */
284 struct acpi_namestring_info {
285 char *external_name;
286 char *next_external_char;
287 char *internal_name;
288 u32 length;
289 u32 num_segments;
290 u32 num_carats;
291 u8 fully_qualified;
292 };
294 /* Field creation info */
296 struct acpi_create_field_info {
297 struct acpi_namespace_node *region_node;
298 struct acpi_namespace_node *field_node;
299 struct acpi_namespace_node *register_node;
300 struct acpi_namespace_node *data_register_node;
301 u32 bank_value;
302 u32 field_bit_position;
303 u32 field_bit_length;
304 u8 field_flags;
305 u8 attribute;
306 u8 field_type;
307 };
309 typedef
310 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
312 /*
313 * Bitmapped ACPI types. Used internally only
314 */
315 #define ACPI_BTYPE_ANY 0x00000000
316 #define ACPI_BTYPE_INTEGER 0x00000001
317 #define ACPI_BTYPE_STRING 0x00000002
318 #define ACPI_BTYPE_BUFFER 0x00000004
319 #define ACPI_BTYPE_PACKAGE 0x00000008
320 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
321 #define ACPI_BTYPE_DEVICE 0x00000020
322 #define ACPI_BTYPE_EVENT 0x00000040
323 #define ACPI_BTYPE_METHOD 0x00000080
324 #define ACPI_BTYPE_MUTEX 0x00000100
325 #define ACPI_BTYPE_REGION 0x00000200
326 #define ACPI_BTYPE_POWER 0x00000400
327 #define ACPI_BTYPE_PROCESSOR 0x00000800
328 #define ACPI_BTYPE_THERMAL 0x00001000
329 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
330 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
331 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
332 #define ACPI_BTYPE_REFERENCE 0x00010000
333 #define ACPI_BTYPE_RESOURCE 0x00020000
335 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
337 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
338 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
339 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
340 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
341 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
343 /*****************************************************************************
344 *
345 * Event typedefs and structs
346 *
347 ****************************************************************************/
349 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
351 struct acpi_handler_info {
352 acpi_event_handler address; /* Address of handler, if any */
353 void *context; /* Context to be passed to handler */
354 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
355 };
357 union acpi_gpe_dispatch_info {
358 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
359 struct acpi_handler_info *handler;
360 };
362 /*
363 * Information about a GPE, one per each GPE in an array.
364 * NOTE: Important to keep this struct as small as possible.
365 */
366 struct acpi_gpe_event_info {
367 union acpi_gpe_dispatch_info dispatch; /* Either Method or Handler */
368 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
369 u8 flags; /* Misc info about this GPE */
370 u8 gpe_number; /* This GPE */
371 };
373 /* Information about a GPE register pair, one per each status/enable pair in an array */
375 struct acpi_gpe_register_info {
376 struct acpi_generic_address status_address; /* Address of status reg */
377 struct acpi_generic_address enable_address; /* Address of enable reg */
378 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
379 u8 enable_for_run; /* GPEs to keep enabled when running */
380 u8 base_gpe_number; /* Base GPE number for this register */
381 };
383 /*
384 * Information about a GPE register block, one per each installed block --
385 * GPE0, GPE1, and one per each installed GPE Block Device.
386 */
387 struct acpi_gpe_block_info {
388 struct acpi_namespace_node *node;
389 struct acpi_gpe_block_info *previous;
390 struct acpi_gpe_block_info *next;
391 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
392 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
393 struct acpi_gpe_event_info *event_info; /* One for each GPE */
394 struct acpi_generic_address block_address; /* Base address of the block */
395 u32 register_count; /* Number of register pairs in block */
396 u8 block_base_number; /* Base GPE number for this block */
397 };
399 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
401 struct acpi_gpe_xrupt_info {
402 struct acpi_gpe_xrupt_info *previous;
403 struct acpi_gpe_xrupt_info *next;
404 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
405 u32 interrupt_number; /* System interrupt number */
406 };
408 struct acpi_gpe_walk_info {
409 struct acpi_namespace_node *gpe_device;
410 struct acpi_gpe_block_info *gpe_block;
411 };
413 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
414 gpe_xrupt_info,
415 struct acpi_gpe_block_info *
416 gpe_block);
418 /* Information about each particular fixed event */
420 struct acpi_fixed_event_handler {
421 acpi_event_handler handler; /* Address of handler. */
422 void *context; /* Context to be passed to handler */
423 };
425 struct acpi_fixed_event_info {
426 u8 status_register_id;
427 u8 enable_register_id;
428 u16 status_bit_mask;
429 u16 enable_bit_mask;
430 };
432 /* Information used during field processing */
434 struct acpi_field_info {
435 u8 skip_field;
436 u8 field_flag;
437 u32 pkg_length;
438 };
440 /*****************************************************************************
441 *
442 * Generic "state" object for stacks
443 *
444 ****************************************************************************/
446 #define ACPI_CONTROL_NORMAL 0xC0
447 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
448 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
449 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
450 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
452 #define ACPI_STATE_COMMON \
453 void *next; \
454 u8 descriptor_type; /* To differentiate various internal objs */\
455 u8 flags; \
456 u16 value; \
457 u16 state;
459 /* There are 2 bytes available here until the next natural alignment boundary */
461 struct acpi_common_state {
462 ACPI_STATE_COMMON};
464 /*
465 * Update state - used to traverse complex objects such as packages
466 */
467 struct acpi_update_state {
468 ACPI_STATE_COMMON union acpi_operand_object *object;
469 };
471 /*
472 * Pkg state - used to traverse nested package structures
473 */
474 struct acpi_pkg_state {
475 ACPI_STATE_COMMON u16 index;
476 union acpi_operand_object *source_object;
477 union acpi_operand_object *dest_object;
478 struct acpi_walk_state *walk_state;
479 void *this_target_obj;
480 u32 num_packages;
481 };
483 /*
484 * Control state - one per if/else and while constructs.
485 * Allows nesting of these constructs
486 */
487 struct acpi_control_state {
488 ACPI_STATE_COMMON u16 opcode;
489 union acpi_parse_object *predicate_op;
490 u8 *aml_predicate_start; /* Start of if/while predicate */
491 u8 *package_end; /* End of if/while block */
492 };
494 /*
495 * Scope state - current scope during namespace lookups
496 */
497 struct acpi_scope_state {
498 ACPI_STATE_COMMON struct acpi_namespace_node *node;
499 };
501 struct acpi_pscope_state {
502 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
503 union acpi_parse_object *op; /* Current op being parsed */
504 u8 *arg_end; /* Current argument end */
505 u8 *pkg_end; /* Current package end */
506 u32 arg_list; /* Next argument to parse */
507 };
509 /*
510 * Thread state - one per thread across multiple walk states. Multiple walk
511 * states are created when there are nested control methods executing.
512 */
513 struct acpi_thread_state {
514 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
515 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
516 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
517 acpi_thread_id thread_id; /* Running thread ID */
518 };
520 /*
521 * Result values - used to accumulate the results of nested
522 * AML arguments
523 */
524 struct acpi_result_values {
525 ACPI_STATE_COMMON u8 num_results;
526 u8 last_insert;
527 union acpi_operand_object *obj_desc[ACPI_OBJ_NUM_OPERANDS];
528 };
530 typedef
531 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
532 union acpi_parse_object ** out_op);
534 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
536 /*
537 * Notify info - used to pass info to the deferred notify
538 * handler/dispatcher.
539 */
540 struct acpi_notify_info {
541 ACPI_STATE_COMMON struct acpi_namespace_node *node;
542 union acpi_operand_object *handler_obj;
543 };
545 /* Generic state is union of structs above */
547 union acpi_generic_state {
548 struct acpi_common_state common;
549 struct acpi_control_state control;
550 struct acpi_update_state update;
551 struct acpi_scope_state scope;
552 struct acpi_pscope_state parse_scope;
553 struct acpi_pkg_state pkg;
554 struct acpi_thread_state thread;
555 struct acpi_result_values results;
556 struct acpi_notify_info notify;
557 };
559 /*****************************************************************************
560 *
561 * Interpreter typedefs and structs
562 *
563 ****************************************************************************/
565 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
567 /*****************************************************************************
568 *
569 * Parser typedefs and structs
570 *
571 ****************************************************************************/
573 /*
574 * AML opcode, name, and argument layout
575 */
576 struct acpi_opcode_info {
577 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
578 char *name; /* Opcode name (disassembler/debug only) */
579 #endif
580 u32 parse_args; /* Grammar/Parse time arguments */
581 u32 runtime_args; /* Interpret time arguments */
582 u16 flags; /* Misc flags */
583 u8 object_type; /* Corresponding internal object type */
584 u8 class; /* Opcode class */
585 u8 type; /* Opcode type */
586 };
588 union acpi_parse_value {
589 acpi_integer integer; /* Integer constant (Up to 64 bits) */
590 struct uint64_struct integer64; /* Structure overlay for 2 32-bit Dwords */
591 u32 size; /* bytelist or field size */
592 char *string; /* NULL terminated string */
593 u8 *buffer; /* buffer or string */
594 char *name; /* NULL terminated string */
595 union acpi_parse_object *arg; /* arguments and contained ops */
596 };
598 #define ACPI_PARSE_COMMON \
599 union acpi_parse_object *parent; /* Parent op */\
600 u8 descriptor_type; /* To differentiate various internal objs */\
601 u8 flags; /* Type of Op */\
602 u16 aml_opcode; /* AML opcode */\
603 u32 aml_offset; /* Offset of declaration in AML */\
604 union acpi_parse_object *next; /* Next op */\
605 struct acpi_namespace_node *node; /* For use by interpreter */\
606 union acpi_parse_value value; /* Value or args associated with the opcode */\
607 ACPI_DISASM_ONLY_MEMBERS (\
608 u8 disasm_flags; /* Used during AML disassembly */\
609 u8 disasm_opcode; /* Subtype used for disassembly */\
610 char aml_op_name[16]) /* Op name (debug only) */
612 #define ACPI_DASM_BUFFER 0x00
613 #define ACPI_DASM_RESOURCE 0x01
614 #define ACPI_DASM_STRING 0x02
615 #define ACPI_DASM_UNICODE 0x03
616 #define ACPI_DASM_EISAID 0x04
617 #define ACPI_DASM_MATCHOP 0x05
618 #define ACPI_DASM_LNOT_PREFIX 0x06
619 #define ACPI_DASM_LNOT_SUFFIX 0x07
620 #define ACPI_DASM_IGNORE 0x08
622 /*
623 * Generic operation (for example: If, While, Store)
624 */
625 struct acpi_parse_obj_common {
626 ACPI_PARSE_COMMON};
628 /*
629 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
630 * and bytelists.
631 */
632 struct acpi_parse_obj_named {
633 ACPI_PARSE_COMMON u8 *path;
634 u8 *data; /* AML body or bytelist data */
635 u32 length; /* AML length */
636 u32 name; /* 4-byte name or zero if no name */
637 };
639 /* This version is used by the i_aSL compiler only */
641 #define ACPI_MAX_PARSEOP_NAME 20
643 struct acpi_parse_obj_asl {
644 ACPI_PARSE_COMMON union acpi_parse_object *child;
645 union acpi_parse_object *parent_method;
646 char *filename;
647 char *external_name;
648 char *namepath;
649 char name_seg[4];
650 u32 extra_value;
651 u32 column;
652 u32 line_number;
653 u32 logical_line_number;
654 u32 logical_byte_offset;
655 u32 end_line;
656 u32 end_logical_line;
657 u32 acpi_btype;
658 u32 aml_length;
659 u32 aml_subtree_length;
660 u32 final_aml_length;
661 u32 final_aml_offset;
662 u32 compile_flags;
663 u16 parse_opcode;
664 u8 aml_opcode_length;
665 u8 aml_pkg_len_bytes;
666 u8 extra;
667 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
668 };
670 union acpi_parse_object {
671 struct acpi_parse_obj_common common;
672 struct acpi_parse_obj_named named;
673 struct acpi_parse_obj_asl asl;
674 };
676 /*
677 * Parse state - one state per parser invocation and each control
678 * method.
679 */
680 struct acpi_parse_state {
681 u8 *aml_start; /* First AML byte */
682 u8 *aml; /* Next AML byte */
683 u8 *aml_end; /* (last + 1) AML byte */
684 u8 *pkg_start; /* Current package begin */
685 u8 *pkg_end; /* Current package end */
686 union acpi_parse_object *start_op; /* Root of parse tree */
687 struct acpi_namespace_node *start_node;
688 union acpi_generic_state *scope; /* Current scope */
689 union acpi_parse_object *start_scope;
690 u32 aml_size;
691 };
693 /* Parse object flags */
695 #define ACPI_PARSEOP_GENERIC 0x01
696 #define ACPI_PARSEOP_NAMED 0x02
697 #define ACPI_PARSEOP_DEFERRED 0x04
698 #define ACPI_PARSEOP_BYTELIST 0x08
699 #define ACPI_PARSEOP_IN_CACHE 0x80
701 /* Parse object disasm_flags */
703 #define ACPI_PARSEOP_IGNORE 0x01
704 #define ACPI_PARSEOP_PARAMLIST 0x02
705 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
706 #define ACPI_PARSEOP_SPECIAL 0x10
708 /*****************************************************************************
709 *
710 * Hardware (ACPI registers) and PNP
711 *
712 ****************************************************************************/
714 #define PCI_ROOT_HID_STRING "PNP0A03"
715 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
717 struct acpi_bit_register_info {
718 u8 parent_register;
719 u8 bit_position;
720 u16 access_bit_mask;
721 };
723 /*
724 * Some ACPI registers have bits that must be ignored -- meaning that they
725 * must be preserved.
726 */
727 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
728 #define ACPI_PM1_CONTROL_PRESERVED_BITS 0x0200 /* Bit 9 (whatever) */
730 /*
731 * Register IDs
732 * These are the full ACPI registers
733 */
734 #define ACPI_REGISTER_PM1_STATUS 0x01
735 #define ACPI_REGISTER_PM1_ENABLE 0x02
736 #define ACPI_REGISTER_PM1_CONTROL 0x03
737 #define ACPI_REGISTER_PM1A_CONTROL 0x04
738 #define ACPI_REGISTER_PM1B_CONTROL 0x05
739 #define ACPI_REGISTER_PM2_CONTROL 0x06
740 #define ACPI_REGISTER_PM_TIMER 0x07
741 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x08
742 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x09
744 /* Masks used to access the bit_registers */
746 #define ACPI_BITMASK_TIMER_STATUS 0x0001
747 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
748 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
749 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
750 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
751 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
752 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
753 #define ACPI_BITMASK_WAKE_STATUS 0x8000
755 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
756 ACPI_BITMASK_TIMER_STATUS | \
757 ACPI_BITMASK_BUS_MASTER_STATUS | \
758 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
759 ACPI_BITMASK_POWER_BUTTON_STATUS | \
760 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
761 ACPI_BITMASK_RT_CLOCK_STATUS | \
762 ACPI_BITMASK_WAKE_STATUS)
764 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
765 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
766 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
767 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
768 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
769 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
771 #define ACPI_BITMASK_SCI_ENABLE 0x0001
772 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
773 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
774 #define ACPI_BITMASK_SLEEP_TYPE_X 0x1C00
775 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
777 #define ACPI_BITMASK_ARB_DISABLE 0x0001
779 /* Raw bit position of each bit_register */
781 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
782 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
783 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
784 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
785 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
786 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
787 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
788 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
790 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
791 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
792 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
793 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
794 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
795 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
797 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
798 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
799 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
800 #define ACPI_BITPOSITION_SLEEP_TYPE_X 0x0A
801 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
803 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
805 /*****************************************************************************
806 *
807 * Resource descriptors
808 *
809 ****************************************************************************/
811 /* resource_type values */
813 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
814 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
815 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
817 /* Resource descriptor types and masks */
819 #define ACPI_RESOURCE_NAME_LARGE 0x80
820 #define ACPI_RESOURCE_NAME_SMALL 0x00
822 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
823 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
824 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
826 /*
827 * Small resource descriptor "names" as defined by the ACPI specification.
828 * Note: Bits 2:0 are used for the descriptor length
829 */
830 #define ACPI_RESOURCE_NAME_IRQ 0x20
831 #define ACPI_RESOURCE_NAME_DMA 0x28
832 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
833 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
834 #define ACPI_RESOURCE_NAME_IO 0x40
835 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
836 #define ACPI_RESOURCE_NAME_RESERVED_S1 0x50
837 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
838 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
839 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
840 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
841 #define ACPI_RESOURCE_NAME_END_TAG 0x78
843 /*
844 * Large resource descriptor "names" as defined by the ACPI specification.
845 * Note: includes the Large Descriptor bit in bit[7]
846 */
847 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
848 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
849 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
850 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
851 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
852 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
853 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
854 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
855 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
856 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
857 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
858 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B
860 /*****************************************************************************
861 *
862 * Miscellaneous
863 *
864 ****************************************************************************/
866 #define ACPI_ASCII_ZERO 0x30
868 /*****************************************************************************
869 *
870 * Debugger
871 *
872 ****************************************************************************/
874 struct acpi_db_method_info {
875 acpi_handle main_thread_gate;
876 acpi_handle thread_complete_gate;
877 u32 *threads;
878 u32 num_threads;
879 u32 num_created;
880 u32 num_completed;
882 char *name;
883 u32 flags;
884 u32 num_loops;
885 char pathname[128];
886 char **args;
888 /*
889 * Arguments to be passed to method for the command
890 * Threads -
891 * the Number of threads, ID of current thread and
892 * Index of current thread inside all them created.
893 */
894 char init_args;
895 char *arguments[4];
896 char num_threads_str[11];
897 char id_of_thread_str[11];
898 char index_of_thread_str[11];
899 };
901 struct acpi_integrity_info {
902 u32 nodes;
903 u32 objects;
904 };
906 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
907 #define ACPI_DB_CONSOLE_OUTPUT 0x02
908 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
910 /*****************************************************************************
911 *
912 * Debug
913 *
914 ****************************************************************************/
916 /* Entry for a memory allocation (debug only) */
918 #define ACPI_MEM_MALLOC 0
919 #define ACPI_MEM_CALLOC 1
920 #define ACPI_MAX_MODULE_NAME 16
922 #define ACPI_COMMON_DEBUG_MEM_HEADER \
923 struct acpi_debug_mem_block *previous; \
924 struct acpi_debug_mem_block *next; \
925 u32 size; \
926 u32 component; \
927 u32 line; \
928 char module[ACPI_MAX_MODULE_NAME]; \
929 u8 alloc_type;
931 struct acpi_debug_mem_header {
932 ACPI_COMMON_DEBUG_MEM_HEADER};
934 struct acpi_debug_mem_block {
935 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
936 };
938 #define ACPI_MEM_LIST_GLOBAL 0
939 #define ACPI_MEM_LIST_NSNODE 1
940 #define ACPI_MEM_LIST_MAX 1
941 #define ACPI_NUM_MEM_LISTS 2
943 struct acpi_memory_list {
944 char *list_name;
945 void *list_head;
946 u16 object_size;
947 u16 max_depth;
948 u16 current_depth;
949 u16 link_offset;
951 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
953 /* Statistics for debug memory tracking only */
955 u32 total_allocated;
956 u32 total_freed;
957 u32 max_occupied;
958 u32 total_size;
959 u32 current_total_size;
960 u32 requests;
961 u32 hits;
962 #endif
963 };
965 #endif /* __ACLOCAL_H__ */