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