ACPICA: Update all ACPICA copyrights and signons to 2010
[linux-2.6.git] / drivers / acpi / acpica / aclocal.h
1 /******************************************************************************
2  *
3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2010, Intel Corp.
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  */
43
44 #ifndef __ACLOCAL_H__
45 #define __ACLOCAL_H__
46
47 /* acpisrc:struct_defs -- for acpisrc conversion */
48
49 #define ACPI_SERIALIZED                 0xFF
50
51 typedef u32 acpi_mutex_handle;
52 #define ACPI_GLOBAL_LOCK                (acpi_semaphore) (-1)
53
54 /* Total number of aml opcodes defined */
55
56 #define AML_NUM_OPCODES                 0x7F
57
58 /* Forward declarations */
59
60 struct acpi_walk_state;
61 struct acpi_obj_mutex;
62 union acpi_parse_object;
63
64 /*****************************************************************************
65  *
66  * Mutex typedefs and structs
67  *
68  ****************************************************************************/
69
70 /*
71  * Predefined handles for the mutex objects used within the subsystem
72  * All mutex objects are automatically created by acpi_ut_mutex_initialize.
73  *
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.
76  *
77  * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
78  * table below also!
79  */
80 #define ACPI_MTX_INTERPRETER            0       /* AML Interpreter, main lock */
81 #define ACPI_MTX_NAMESPACE              1       /* ACPI Namespace */
82 #define ACPI_MTX_TABLES                 2       /* Data for ACPI tables */
83 #define ACPI_MTX_EVENTS                 3       /* Data for ACPI events */
84 #define ACPI_MTX_CACHES                 4       /* Internal caches, general purposes */
85 #define ACPI_MTX_MEMORY                 5       /* Debug memory tracking lists */
86 #define ACPI_MTX_DEBUG_CMD_COMPLETE     6       /* AML debugger */
87 #define ACPI_MTX_DEBUG_CMD_READY        7       /* AML debugger */
88
89 #define ACPI_MAX_MUTEX                  7
90 #define ACPI_NUM_MUTEX                  ACPI_MAX_MUTEX+1
91
92 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
93 #ifdef DEFINE_ACPI_GLOBALS
94
95 /* Debug names for the mutexes above */
96
97 static char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = {
98         "ACPI_MTX_Interpreter",
99         "ACPI_MTX_Namespace",
100         "ACPI_MTX_Tables",
101         "ACPI_MTX_Events",
102         "ACPI_MTX_Caches",
103         "ACPI_MTX_Memory",
104         "ACPI_MTX_CommandComplete",
105         "ACPI_MTX_CommandReady"
106 };
107
108 #endif
109 #endif
110
111 /* Lock structure for reader/writer interfaces */
112
113 struct acpi_rw_lock {
114         acpi_mutex writer_mutex;
115         acpi_mutex reader_mutex;
116         u32 num_readers;
117 };
118
119 /*
120  * Predefined handles for spinlocks used within the subsystem.
121  * These spinlocks are created by acpi_ut_mutex_initialize
122  */
123 #define ACPI_LOCK_GPES                  0
124 #define ACPI_LOCK_HARDWARE              1
125
126 #define ACPI_MAX_LOCK                   1
127 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
128
129 /* This Thread ID means that the mutex is not in use (unlocked) */
130
131 #define ACPI_MUTEX_NOT_ACQUIRED         (acpi_thread_id) 0
132
133 /* Table for the global mutexes */
134
135 struct acpi_mutex_info {
136         acpi_mutex mutex;
137         u32 use_count;
138         acpi_thread_id thread_id;
139 };
140
141 /* Lock flag parameter for various interfaces */
142
143 #define ACPI_MTX_DO_NOT_LOCK            0
144 #define ACPI_MTX_LOCK                   1
145
146 /* Field access granularities */
147
148 #define ACPI_FIELD_BYTE_GRANULARITY     1
149 #define ACPI_FIELD_WORD_GRANULARITY     2
150 #define ACPI_FIELD_DWORD_GRANULARITY    4
151 #define ACPI_FIELD_QWORD_GRANULARITY    8
152
153 #define ACPI_ENTRY_NOT_FOUND            NULL
154
155 /*****************************************************************************
156  *
157  * Namespace typedefs and structs
158  *
159  ****************************************************************************/
160
161 /* Operational modes of the AML interpreter/scanner */
162
163 typedef enum {
164         ACPI_IMODE_LOAD_PASS1 = 0x01,
165         ACPI_IMODE_LOAD_PASS2 = 0x02,
166         ACPI_IMODE_EXECUTE = 0x03
167 } acpi_interpreter_mode;
168
169 /*
170  * The Namespace Node describes a named object that appears in the AML.
171  * descriptor_type is used to differentiate between internal descriptors.
172  *
173  * The node is optimized for both 32-bit and 64-bit platforms:
174  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
175  *
176  * Note: The descriptor_type and Type fields must appear in the identical
177  * position in both the struct acpi_namespace_node and union acpi_operand_object
178  * structures.
179  */
180 struct acpi_namespace_node {
181         union acpi_operand_object *object;      /* Interpreter object */
182         u8 descriptor_type;     /* Differentiate object descriptor types */
183         u8 type;                /* ACPI Type associated with this name */
184         u8 flags;               /* Miscellaneous flags */
185         acpi_owner_id owner_id; /* Node creator */
186         union acpi_name_union name;     /* ACPI Name, always 4 chars per ACPI spec */
187         struct acpi_namespace_node *child;      /* First child */
188         struct acpi_namespace_node *peer;       /* Peer. Parent if ANOBJ_END_OF_PEER_LIST set */
189
190         /*
191          * The following fields are used by the ASL compiler and disassembler only
192          */
193 #ifdef ACPI_LARGE_NAMESPACE_NODE
194         union acpi_parse_object *op;
195         u32 value;
196         u32 length;
197 #endif
198 };
199
200 /* Namespace Node flags */
201
202 #define ANOBJ_END_OF_PEER_LIST          0x01    /* End-of-list, Peer field points to parent */
203 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
204 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
205 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
206 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
207 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
208 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (install_method) */
209
210 #define ANOBJ_IS_EXTERNAL               0x08    /* i_aSL only: This object created via External() */
211 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* i_aSL only: Method has no return value */
212 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* i_aSL only: Method has at least one return value */
213 #define ANOBJ_IS_BIT_OFFSET             0x40    /* i_aSL only: Reference is a bit offset */
214 #define ANOBJ_IS_REFERENCED             0x80    /* i_aSL only: Object was referenced */
215
216 /* One internal RSDT for table management */
217
218 struct acpi_internal_rsdt {
219         struct acpi_table_desc *tables;
220         u32 count;
221         u32 size;
222         u8 flags;
223 };
224
225 /* Flags for above */
226
227 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
228 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
229 #define ACPI_ROOT_ALLOW_RESIZE          (2)
230
231 /* Predefined (fixed) table indexes */
232
233 #define ACPI_TABLE_INDEX_DSDT           (0)
234 #define ACPI_TABLE_INDEX_FACS           (1)
235
236 struct acpi_find_context {
237         char *search_for;
238         acpi_handle *list;
239         u32 *count;
240 };
241
242 struct acpi_ns_search_data {
243         struct acpi_namespace_node *node;
244 };
245
246 /* Object types used during package copies */
247
248 #define ACPI_COPY_TYPE_SIMPLE           0
249 #define ACPI_COPY_TYPE_PACKAGE          1
250
251 /* Info structure used to convert external<->internal namestrings */
252
253 struct acpi_namestring_info {
254         const char *external_name;
255         const char *next_external_char;
256         char *internal_name;
257         u32 length;
258         u32 num_segments;
259         u32 num_carats;
260         u8 fully_qualified;
261 };
262
263 /* Field creation info */
264
265 struct acpi_create_field_info {
266         struct acpi_namespace_node *region_node;
267         struct acpi_namespace_node *field_node;
268         struct acpi_namespace_node *register_node;
269         struct acpi_namespace_node *data_register_node;
270         u32 bank_value;
271         u32 field_bit_position;
272         u32 field_bit_length;
273         u8 field_flags;
274         u8 attribute;
275         u8 field_type;
276 };
277
278 typedef
279 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
280
281 /*
282  * Bitmapped ACPI types.  Used internally only
283  */
284 #define ACPI_BTYPE_ANY                  0x00000000
285 #define ACPI_BTYPE_INTEGER              0x00000001
286 #define ACPI_BTYPE_STRING               0x00000002
287 #define ACPI_BTYPE_BUFFER               0x00000004
288 #define ACPI_BTYPE_PACKAGE              0x00000008
289 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
290 #define ACPI_BTYPE_DEVICE               0x00000020
291 #define ACPI_BTYPE_EVENT                0x00000040
292 #define ACPI_BTYPE_METHOD               0x00000080
293 #define ACPI_BTYPE_MUTEX                0x00000100
294 #define ACPI_BTYPE_REGION               0x00000200
295 #define ACPI_BTYPE_POWER                0x00000400
296 #define ACPI_BTYPE_PROCESSOR            0x00000800
297 #define ACPI_BTYPE_THERMAL              0x00001000
298 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
299 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
300 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
301 #define ACPI_BTYPE_REFERENCE            0x00010000
302 #define ACPI_BTYPE_RESOURCE             0x00020000
303
304 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
305
306 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
307 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
308 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
309 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF      /* ARG or LOCAL */
310 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
311
312 /*
313  * Information structure for ACPI predefined names.
314  * Each entry in the table contains the following items:
315  *
316  * Name                 - The ACPI reserved name
317  * param_count          - Number of arguments to the method
318  * expected_return_btypes - Allowed type(s) for the return value
319  */
320 struct acpi_name_info {
321         char name[ACPI_NAME_SIZE];
322         u8 param_count;
323         u8 expected_btypes;
324 };
325
326 /*
327  * Secondary information structures for ACPI predefined objects that return
328  * package objects. This structure appears as the next entry in the table
329  * after the NAME_INFO structure above.
330  *
331  * The reason for this is to minimize the size of the predefined name table.
332  */
333
334 /*
335  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
336  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
337  */
338 struct acpi_package_info {
339         u8 type;
340         u8 object_type1;
341         u8 count1;
342         u8 object_type2;
343         u8 count2;
344         u8 reserved;
345 };
346
347 /* Used for ACPI_PTYPE2_FIXED */
348
349 struct acpi_package_info2 {
350         u8 type;
351         u8 count;
352         u8 object_type[4];
353 };
354
355 /* Used for ACPI_PTYPE1_OPTION */
356
357 struct acpi_package_info3 {
358         u8 type;
359         u8 count;
360         u8 object_type[2];
361         u8 tail_object_type;
362         u8 reserved;
363 };
364
365 union acpi_predefined_info {
366         struct acpi_name_info info;
367         struct acpi_package_info ret_info;
368         struct acpi_package_info2 ret_info2;
369         struct acpi_package_info3 ret_info3;
370 };
371
372 /* Data block used during object validation */
373
374 struct acpi_predefined_data {
375         char *pathname;
376         const union acpi_predefined_info *predefined;
377         u32 flags;
378         u8 node_flags;
379 };
380
381 /* Defines for Flags field above */
382
383 #define ACPI_OBJECT_REPAIRED    1
384
385 /*
386  * Bitmapped return value types
387  * Note: the actual data types must be contiguous, a loop in nspredef.c
388  * depends on this.
389  */
390 #define ACPI_RTYPE_ANY                  0x00
391 #define ACPI_RTYPE_NONE                 0x01
392 #define ACPI_RTYPE_INTEGER              0x02
393 #define ACPI_RTYPE_STRING               0x04
394 #define ACPI_RTYPE_BUFFER               0x08
395 #define ACPI_RTYPE_PACKAGE              0x10
396 #define ACPI_RTYPE_REFERENCE            0x20
397 #define ACPI_RTYPE_ALL                  0x3F
398
399 #define ACPI_NUM_RTYPES                 5       /* Number of actual object types */
400
401 /*****************************************************************************
402  *
403  * Event typedefs and structs
404  *
405  ****************************************************************************/
406
407 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
408
409 struct acpi_handler_info {
410         acpi_event_handler address;     /* Address of handler, if any */
411         void *context;          /* Context to be passed to handler */
412         struct acpi_namespace_node *method_node;        /* Method node for this GPE level (saved) */
413 };
414
415 union acpi_gpe_dispatch_info {
416         struct acpi_namespace_node *method_node;        /* Method node for this GPE level */
417         struct acpi_handler_info *handler;
418 };
419
420 /*
421  * Information about a GPE, one per each GPE in an array.
422  * NOTE: Important to keep this struct as small as possible.
423  */
424 struct acpi_gpe_event_info {
425         union acpi_gpe_dispatch_info dispatch;  /* Either Method or Handler */
426         struct acpi_gpe_register_info *register_info;   /* Backpointer to register info */
427         u8 flags;               /* Misc info about this GPE */
428         u8 gpe_number;          /* This GPE */
429 };
430
431 /* Information about a GPE register pair, one per each status/enable pair in an array */
432
433 struct acpi_gpe_register_info {
434         struct acpi_generic_address status_address;     /* Address of status reg */
435         struct acpi_generic_address enable_address;     /* Address of enable reg */
436         u8 enable_for_wake;     /* GPEs to keep enabled when sleeping */
437         u8 enable_for_run;      /* GPEs to keep enabled when running */
438         u8 base_gpe_number;     /* Base GPE number for this register */
439 };
440
441 /*
442  * Information about a GPE register block, one per each installed block --
443  * GPE0, GPE1, and one per each installed GPE Block Device.
444  */
445 struct acpi_gpe_block_info {
446         struct acpi_namespace_node *node;
447         struct acpi_gpe_block_info *previous;
448         struct acpi_gpe_block_info *next;
449         struct acpi_gpe_xrupt_info *xrupt_block;        /* Backpointer to interrupt block */
450         struct acpi_gpe_register_info *register_info;   /* One per GPE register pair */
451         struct acpi_gpe_event_info *event_info; /* One for each GPE */
452         struct acpi_generic_address block_address;      /* Base address of the block */
453         u32 register_count;     /* Number of register pairs in block */
454         u8 block_base_number;   /* Base GPE number for this block */
455 };
456
457 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
458
459 struct acpi_gpe_xrupt_info {
460         struct acpi_gpe_xrupt_info *previous;
461         struct acpi_gpe_xrupt_info *next;
462         struct acpi_gpe_block_info *gpe_block_list_head;        /* List of GPE blocks for this xrupt */
463         u32 interrupt_number;   /* System interrupt number */
464 };
465
466 struct acpi_gpe_walk_info {
467         struct acpi_namespace_node *gpe_device;
468         struct acpi_gpe_block_info *gpe_block;
469 };
470
471 struct acpi_gpe_device_info {
472         u32 index;
473         u32 next_block_base_index;
474         acpi_status status;
475         struct acpi_namespace_node *gpe_device;
476 };
477
478 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *gpe_xrupt_info,
479                 struct acpi_gpe_block_info *gpe_block, void *context);
480
481 /* Information about each particular fixed event */
482
483 struct acpi_fixed_event_handler {
484         acpi_event_handler handler;     /* Address of handler. */
485         void *context;          /* Context to be passed to handler */
486 };
487
488 struct acpi_fixed_event_info {
489         u8 status_register_id;
490         u8 enable_register_id;
491         u16 status_bit_mask;
492         u16 enable_bit_mask;
493 };
494
495 /* Information used during field processing */
496
497 struct acpi_field_info {
498         u8 skip_field;
499         u8 field_flag;
500         u32 pkg_length;
501 };
502
503 /*****************************************************************************
504  *
505  * Generic "state" object for stacks
506  *
507  ****************************************************************************/
508
509 #define ACPI_CONTROL_NORMAL                  0xC0
510 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
511 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
512 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
513 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
514
515 #define ACPI_STATE_COMMON \
516         void                            *next; \
517         u8                              descriptor_type; /* To differentiate various internal objs */\
518         u8                              flags; \
519         u16                             value; \
520         u16                             state;
521
522         /* There are 2 bytes available here until the next natural alignment boundary */
523
524 struct acpi_common_state {
525 ACPI_STATE_COMMON};
526
527 /*
528  * Update state - used to traverse complex objects such as packages
529  */
530 struct acpi_update_state {
531         ACPI_STATE_COMMON union acpi_operand_object *object;
532 };
533
534 /*
535  * Pkg state - used to traverse nested package structures
536  */
537 struct acpi_pkg_state {
538         ACPI_STATE_COMMON u16 index;
539         union acpi_operand_object *source_object;
540         union acpi_operand_object *dest_object;
541         struct acpi_walk_state *walk_state;
542         void *this_target_obj;
543         u32 num_packages;
544 };
545
546 /*
547  * Control state - one per if/else and while constructs.
548  * Allows nesting of these constructs
549  */
550 struct acpi_control_state {
551         ACPI_STATE_COMMON u16 opcode;
552         union acpi_parse_object *predicate_op;
553         u8 *aml_predicate_start;        /* Start of if/while predicate */
554         u8 *package_end;        /* End of if/while block */
555         u32 loop_count;         /* While() loop counter */
556 };
557
558 /*
559  * Scope state - current scope during namespace lookups
560  */
561 struct acpi_scope_state {
562         ACPI_STATE_COMMON struct acpi_namespace_node *node;
563 };
564
565 struct acpi_pscope_state {
566         ACPI_STATE_COMMON u32 arg_count;        /* Number of fixed arguments */
567         union acpi_parse_object *op;    /* Current op being parsed */
568         u8 *arg_end;            /* Current argument end */
569         u8 *pkg_end;            /* Current package end */
570         u32 arg_list;           /* Next argument to parse */
571 };
572
573 /*
574  * Thread state - one per thread across multiple walk states.  Multiple walk
575  * states are created when there are nested control methods executing.
576  */
577 struct acpi_thread_state {
578         ACPI_STATE_COMMON u8 current_sync_level;        /* Mutex Sync (nested acquire) level */
579         struct acpi_walk_state *walk_state_list;        /* Head of list of walk_states for this thread */
580         union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
581         acpi_thread_id thread_id;       /* Running thread ID */
582 };
583
584 /*
585  * Result values - used to accumulate the results of nested
586  * AML arguments
587  */
588 struct acpi_result_values {
589         ACPI_STATE_COMMON
590             union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
591 };
592
593 typedef
594 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
595                                     union acpi_parse_object ** out_op);
596
597 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
598
599 /*
600  * Notify info - used to pass info to the deferred notify
601  * handler/dispatcher.
602  */
603 struct acpi_notify_info {
604         ACPI_STATE_COMMON struct acpi_namespace_node *node;
605         union acpi_operand_object *handler_obj;
606 };
607
608 /* Generic state is union of structs above */
609
610 union acpi_generic_state {
611         struct acpi_common_state common;
612         struct acpi_control_state control;
613         struct acpi_update_state update;
614         struct acpi_scope_state scope;
615         struct acpi_pscope_state parse_scope;
616         struct acpi_pkg_state pkg;
617         struct acpi_thread_state thread;
618         struct acpi_result_values results;
619         struct acpi_notify_info notify;
620 };
621
622 /*****************************************************************************
623  *
624  * Interpreter typedefs and structs
625  *
626  ****************************************************************************/
627
628 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
629
630 /*****************************************************************************
631  *
632  * Parser typedefs and structs
633  *
634  ****************************************************************************/
635
636 /*
637  * AML opcode, name, and argument layout
638  */
639 struct acpi_opcode_info {
640 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
641         char *name;             /* Opcode name (disassembler/debug only) */
642 #endif
643         u32 parse_args;         /* Grammar/Parse time arguments */
644         u32 runtime_args;       /* Interpret time arguments */
645         u16 flags;              /* Misc flags */
646         u8 object_type;         /* Corresponding internal object type */
647         u8 class;               /* Opcode class */
648         u8 type;                /* Opcode type */
649 };
650
651 union acpi_parse_value {
652         acpi_integer integer;   /* Integer constant (Up to 64 bits) */
653         struct uint64_struct integer64; /* Structure overlay for 2 32-bit Dwords */
654         u32 size;               /* bytelist or field size */
655         char *string;           /* NULL terminated string */
656         u8 *buffer;             /* buffer or string */
657         char *name;             /* NULL terminated string */
658         union acpi_parse_object *arg;   /* arguments and contained ops */
659 };
660
661 #ifdef ACPI_DISASSEMBLER
662 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
663 #else
664 #define ACPI_DISASM_ONLY_MEMBERS(a)
665 #endif
666
667 #define ACPI_PARSE_COMMON \
668         union acpi_parse_object         *parent;        /* Parent op */\
669         u8                              descriptor_type; /* To differentiate various internal objs */\
670         u8                              flags;          /* Type of Op */\
671         u16                             aml_opcode;     /* AML opcode */\
672         u32                             aml_offset;     /* Offset of declaration in AML */\
673         union acpi_parse_object         *next;          /* Next op */\
674         struct acpi_namespace_node      *node;          /* For use by interpreter */\
675         union acpi_parse_value          value;          /* Value or args associated with the opcode */\
676         u8                              arg_list_length; /* Number of elements in the arg list */\
677         ACPI_DISASM_ONLY_MEMBERS (\
678         u8                              disasm_flags;   /* Used during AML disassembly */\
679         u8                              disasm_opcode;  /* Subtype used for disassembly */\
680         char                            aml_op_name[16])        /* Op name (debug only) */
681
682 #define ACPI_DASM_BUFFER                0x00
683 #define ACPI_DASM_RESOURCE              0x01
684 #define ACPI_DASM_STRING                0x02
685 #define ACPI_DASM_UNICODE               0x03
686 #define ACPI_DASM_EISAID                0x04
687 #define ACPI_DASM_MATCHOP               0x05
688 #define ACPI_DASM_LNOT_PREFIX           0x06
689 #define ACPI_DASM_LNOT_SUFFIX           0x07
690 #define ACPI_DASM_IGNORE                0x08
691
692 /*
693  * Generic operation (for example:  If, While, Store)
694  */
695 struct acpi_parse_obj_common {
696 ACPI_PARSE_COMMON};
697
698 /*
699  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
700  * and bytelists.
701  */
702 struct acpi_parse_obj_named {
703         ACPI_PARSE_COMMON u8 *path;
704         u8 *data;               /* AML body or bytelist data */
705         u32 length;             /* AML length */
706         u32 name;               /* 4-byte name or zero if no name */
707 };
708
709 /* This version is used by the i_aSL compiler only */
710
711 #define ACPI_MAX_PARSEOP_NAME   20
712
713 struct acpi_parse_obj_asl {
714         ACPI_PARSE_COMMON union acpi_parse_object *child;
715         union acpi_parse_object *parent_method;
716         char *filename;
717         char *external_name;
718         char *namepath;
719         char name_seg[4];
720         u32 extra_value;
721         u32 column;
722         u32 line_number;
723         u32 logical_line_number;
724         u32 logical_byte_offset;
725         u32 end_line;
726         u32 end_logical_line;
727         u32 acpi_btype;
728         u32 aml_length;
729         u32 aml_subtree_length;
730         u32 final_aml_length;
731         u32 final_aml_offset;
732         u32 compile_flags;
733         u16 parse_opcode;
734         u8 aml_opcode_length;
735         u8 aml_pkg_len_bytes;
736         u8 extra;
737         char parse_op_name[ACPI_MAX_PARSEOP_NAME];
738 };
739
740 union acpi_parse_object {
741         struct acpi_parse_obj_common common;
742         struct acpi_parse_obj_named named;
743         struct acpi_parse_obj_asl asl;
744 };
745
746 /*
747  * Parse state - one state per parser invocation and each control
748  * method.
749  */
750 struct acpi_parse_state {
751         u8 *aml_start;          /* First AML byte */
752         u8 *aml;                /* Next AML byte */
753         u8 *aml_end;            /* (last + 1) AML byte */
754         u8 *pkg_start;          /* Current package begin */
755         u8 *pkg_end;            /* Current package end */
756         union acpi_parse_object *start_op;      /* Root of parse tree */
757         struct acpi_namespace_node *start_node;
758         union acpi_generic_state *scope;        /* Current scope */
759         union acpi_parse_object *start_scope;
760         u32 aml_size;
761 };
762
763 /* Parse object flags */
764
765 #define ACPI_PARSEOP_GENERIC            0x01
766 #define ACPI_PARSEOP_NAMED              0x02
767 #define ACPI_PARSEOP_DEFERRED           0x04
768 #define ACPI_PARSEOP_BYTELIST           0x08
769 #define ACPI_PARSEOP_IN_STACK           0x10
770 #define ACPI_PARSEOP_TARGET             0x20
771 #define ACPI_PARSEOP_IN_CACHE           0x80
772
773 /* Parse object disasm_flags */
774
775 #define ACPI_PARSEOP_IGNORE             0x01
776 #define ACPI_PARSEOP_PARAMLIST          0x02
777 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
778 #define ACPI_PARSEOP_SPECIAL            0x10
779
780 /*****************************************************************************
781  *
782  * Hardware (ACPI registers) and PNP
783  *
784  ****************************************************************************/
785
786 struct acpi_bit_register_info {
787         u8 parent_register;
788         u8 bit_position;
789         u16 access_bit_mask;
790 };
791
792 /*
793  * Some ACPI registers have bits that must be ignored -- meaning that they
794  * must be preserved.
795  */
796 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
797
798 /* Write-only bits must be zeroed by software */
799
800 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
801
802 /* For control registers, both ignored and reserved bits must be preserved */
803
804 /*
805  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
806  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
807  * bit position", section 4.7.3.2.1. However, on some machines the OS must
808  * write a one to this bit after resume for the machine to work properly.
809  * To enable this, we no longer attempt to preserve this bit. No machines
810  * are known to fail if the bit is not preserved. (May 2009)
811  */
812 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
813 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
814 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
815                (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
816
817 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE      /* All except bit 0 */
818
819 /*
820  * Register IDs
821  * These are the full ACPI registers
822  */
823 #define ACPI_REGISTER_PM1_STATUS                0x01
824 #define ACPI_REGISTER_PM1_ENABLE                0x02
825 #define ACPI_REGISTER_PM1_CONTROL               0x03
826 #define ACPI_REGISTER_PM2_CONTROL               0x04
827 #define ACPI_REGISTER_PM_TIMER                  0x05
828 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
829 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
830
831 /* Masks used to access the bit_registers */
832
833 #define ACPI_BITMASK_TIMER_STATUS               0x0001
834 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
835 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
836 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
837 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
838 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
839 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
840 #define ACPI_BITMASK_WAKE_STATUS                0x8000
841
842 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
843         ACPI_BITMASK_TIMER_STATUS          | \
844         ACPI_BITMASK_BUS_MASTER_STATUS     | \
845         ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
846         ACPI_BITMASK_POWER_BUTTON_STATUS   | \
847         ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
848         ACPI_BITMASK_RT_CLOCK_STATUS       | \
849         ACPI_BITMASK_WAKE_STATUS)
850
851 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
852 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
853 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
854 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
855 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
856 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
857
858 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
859 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
860 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
861 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
862 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
863
864 #define ACPI_BITMASK_ARB_DISABLE                0x0001
865
866 /* Raw bit position of each bit_register */
867
868 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
869 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
870 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
871 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
872 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
873 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
874 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
875 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
876
877 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
878 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
879 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
880 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
881 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
882 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
883
884 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
885 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
886 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
887 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
888 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
889
890 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
891
892 /* Structs and definitions for _OSI support and I/O port validation */
893
894 #define ACPI_OSI_WIN_2000               0x01
895 #define ACPI_OSI_WIN_XP                 0x02
896 #define ACPI_OSI_WIN_XP_SP1             0x03
897 #define ACPI_OSI_WINSRV_2003            0x04
898 #define ACPI_OSI_WIN_XP_SP2             0x05
899 #define ACPI_OSI_WINSRV_2003_SP1        0x06
900 #define ACPI_OSI_WIN_VISTA              0x07
901 #define ACPI_OSI_WINSRV_2008            0x08
902 #define ACPI_OSI_WIN_VISTA_SP1          0x09
903 #define ACPI_OSI_WIN_7                  0x0A
904
905 #define ACPI_ALWAYS_ILLEGAL             0x00
906
907 struct acpi_interface_info {
908         char *name;
909         u8 value;
910 };
911
912 struct acpi_port_info {
913         char *name;
914         u16 start;
915         u16 end;
916         u8 osi_dependency;
917 };
918
919 /*****************************************************************************
920  *
921  * Resource descriptors
922  *
923  ****************************************************************************/
924
925 /* resource_type values */
926
927 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
928 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
929 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
930
931 /* Resource descriptor types and masks */
932
933 #define ACPI_RESOURCE_NAME_LARGE                0x80
934 #define ACPI_RESOURCE_NAME_SMALL                0x00
935
936 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78    /* Bits 6:3 contain the type */
937 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07    /* Bits 2:0 contain the length */
938 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F    /* Bits 6:0 contain the type */
939
940 /*
941  * Small resource descriptor "names" as defined by the ACPI specification.
942  * Note: Bits 2:0 are used for the descriptor length
943  */
944 #define ACPI_RESOURCE_NAME_IRQ                  0x20
945 #define ACPI_RESOURCE_NAME_DMA                  0x28
946 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
947 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
948 #define ACPI_RESOURCE_NAME_IO                   0x40
949 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
950 #define ACPI_RESOURCE_NAME_RESERVED_S1          0x50
951 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
952 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
953 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
954 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
955 #define ACPI_RESOURCE_NAME_END_TAG              0x78
956
957 /*
958  * Large resource descriptor "names" as defined by the ACPI specification.
959  * Note: includes the Large Descriptor bit in bit[7]
960  */
961 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
962 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
963 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
964 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
965 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
966 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
967 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
968 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
969 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
970 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
971 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
972 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8B
973
974 /*****************************************************************************
975  *
976  * Miscellaneous
977  *
978  ****************************************************************************/
979
980 #define ACPI_ASCII_ZERO                 0x30
981
982 /*****************************************************************************
983  *
984  * Debugger
985  *
986  ****************************************************************************/
987
988 struct acpi_db_method_info {
989         acpi_handle main_thread_gate;
990         acpi_handle thread_complete_gate;
991         u32 *threads;
992         u32 num_threads;
993         u32 num_created;
994         u32 num_completed;
995
996         char *name;
997         u32 flags;
998         u32 num_loops;
999         char pathname[128];
1000         char **args;
1001
1002         /*
1003          * Arguments to be passed to method for the command
1004          * Threads -
1005          *   the Number of threads, ID of current thread and
1006          *   Index of current thread inside all them created.
1007          */
1008         char init_args;
1009         char *arguments[4];
1010         char num_threads_str[11];
1011         char id_of_thread_str[11];
1012         char index_of_thread_str[11];
1013 };
1014
1015 struct acpi_integrity_info {
1016         u32 nodes;
1017         u32 objects;
1018 };
1019
1020 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1021 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1022 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1023
1024 /*****************************************************************************
1025  *
1026  * Debug
1027  *
1028  ****************************************************************************/
1029
1030 /* Entry for a memory allocation (debug only) */
1031
1032 #define ACPI_MEM_MALLOC                 0
1033 #define ACPI_MEM_CALLOC                 1
1034 #define ACPI_MAX_MODULE_NAME            16
1035
1036 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1037         struct acpi_debug_mem_block     *previous; \
1038         struct acpi_debug_mem_block     *next; \
1039         u32                             size; \
1040         u32                             component; \
1041         u32                             line; \
1042         char                            module[ACPI_MAX_MODULE_NAME]; \
1043         u8                              alloc_type;
1044
1045 struct acpi_debug_mem_header {
1046 ACPI_COMMON_DEBUG_MEM_HEADER};
1047
1048 struct acpi_debug_mem_block {
1049         ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1050 };
1051
1052 #define ACPI_MEM_LIST_GLOBAL            0
1053 #define ACPI_MEM_LIST_NSNODE            1
1054 #define ACPI_MEM_LIST_MAX               1
1055 #define ACPI_NUM_MEM_LISTS              2
1056
1057 #endif                          /* __ACLOCAL_H__ */