Kernel bump from 4.1.3-rt to 4.1.7-rt.
[kvmfornfv.git] / kernel / 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 - 2015, 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                 0x82
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    /* iASL only: This object created via External() */
193 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* iASL only: Method has no return value */
194 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* iASL only: Method has at least one return value */
195 #define ANOBJ_IS_REFERENCED             0x80    /* iASL only: Object was referenced */
196
197 /* Internal ACPI table management - master table list */
198
199 struct acpi_table_list {
200         struct acpi_table_desc *tables; /* Table descriptor array */
201         u32 current_table_count;        /* Tables currently in the array */
202         u32 max_table_count;    /* Max tables array will hold */
203         u8 flags;
204 };
205
206 /* Flags for above */
207
208 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
209 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
210 #define ACPI_ROOT_ALLOW_RESIZE          (2)
211
212 /* Predefined (fixed) table indexes */
213
214 #define ACPI_TABLE_INDEX_DSDT           (0)
215 #define ACPI_TABLE_INDEX_FACS           (1)
216 #define ACPI_TABLE_INDEX_X_FACS         (2)
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         u16 pin_number_index;
259         u8 field_flags;
260         u8 attribute;
261         u8 field_type;
262         u8 access_length;
263 };
264
265 typedef
266 acpi_status(*acpi_internal_method) (struct acpi_walk_state * walk_state);
267
268 /*
269  * Bitmapped ACPI types. Used internally only
270  */
271 #define ACPI_BTYPE_ANY                  0x00000000
272 #define ACPI_BTYPE_INTEGER              0x00000001
273 #define ACPI_BTYPE_STRING               0x00000002
274 #define ACPI_BTYPE_BUFFER               0x00000004
275 #define ACPI_BTYPE_PACKAGE              0x00000008
276 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
277 #define ACPI_BTYPE_DEVICE               0x00000020
278 #define ACPI_BTYPE_EVENT                0x00000040
279 #define ACPI_BTYPE_METHOD               0x00000080
280 #define ACPI_BTYPE_MUTEX                0x00000100
281 #define ACPI_BTYPE_REGION               0x00000200
282 #define ACPI_BTYPE_POWER                0x00000400
283 #define ACPI_BTYPE_PROCESSOR            0x00000800
284 #define ACPI_BTYPE_THERMAL              0x00001000
285 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
286 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
287 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
288 #define ACPI_BTYPE_REFERENCE            0x00010000
289 #define ACPI_BTYPE_RESOURCE             0x00020000
290
291 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
292
293 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
294 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
295 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
296 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF      /* ARG or LOCAL */
297 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
298
299 #pragma pack(1)
300
301 /*
302  * Information structure for ACPI predefined names.
303  * Each entry in the table contains the following items:
304  *
305  * name                 - The ACPI reserved name
306  * param_count          - Number of arguments to the method
307  * expected_return_btypes - Allowed type(s) for the return value
308  */
309 struct acpi_name_info {
310         char name[ACPI_NAME_SIZE];
311         u16 argument_list;
312         u8 expected_btypes;
313 };
314
315 /*
316  * Secondary information structures for ACPI predefined objects that return
317  * package objects. This structure appears as the next entry in the table
318  * after the NAME_INFO structure above.
319  *
320  * The reason for this is to minimize the size of the predefined name table.
321  */
322
323 /*
324  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
325  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
326  * ACPI_PTYPE2_FIX_VAR
327  */
328 struct acpi_package_info {
329         u8 type;
330         u8 object_type1;
331         u8 count1;
332         u8 object_type2;
333         u8 count2;
334         u16 reserved;
335 };
336
337 /* Used for ACPI_PTYPE2_FIXED */
338
339 struct acpi_package_info2 {
340         u8 type;
341         u8 count;
342         u8 object_type[4];
343         u8 reserved;
344 };
345
346 /* Used for ACPI_PTYPE1_OPTION */
347
348 struct acpi_package_info3 {
349         u8 type;
350         u8 count;
351         u8 object_type[2];
352         u8 tail_object_type;
353         u16 reserved;
354 };
355
356 union acpi_predefined_info {
357         struct acpi_name_info info;
358         struct acpi_package_info ret_info;
359         struct acpi_package_info2 ret_info2;
360         struct acpi_package_info3 ret_info3;
361 };
362
363 /* Reset to default packing */
364
365 #pragma pack()
366
367 /* Return object auto-repair info */
368
369 typedef acpi_status(*acpi_object_converter) (union acpi_operand_object
370                                              *original_object,
371                                              union acpi_operand_object
372                                              **converted_object);
373
374 struct acpi_simple_repair_info {
375         char name[ACPI_NAME_SIZE];
376         u32 unexpected_btypes;
377         u32 package_index;
378         acpi_object_converter object_converter;
379 };
380
381 /*
382  * Bitmapped return value types
383  * Note: the actual data types must be contiguous, a loop in nspredef.c
384  * depends on this.
385  */
386 #define ACPI_RTYPE_ANY                  0x00
387 #define ACPI_RTYPE_NONE                 0x01
388 #define ACPI_RTYPE_INTEGER              0x02
389 #define ACPI_RTYPE_STRING               0x04
390 #define ACPI_RTYPE_BUFFER               0x08
391 #define ACPI_RTYPE_PACKAGE              0x10
392 #define ACPI_RTYPE_REFERENCE            0x20
393 #define ACPI_RTYPE_ALL                  0x3F
394
395 #define ACPI_NUM_RTYPES                 5       /* Number of actual object types */
396
397 /*****************************************************************************
398  *
399  * Event typedefs and structs
400  *
401  ****************************************************************************/
402
403 /* Dispatch info for each host-installed SCI handler */
404
405 struct acpi_sci_handler_info {
406         struct acpi_sci_handler_info *next;
407         acpi_sci_handler address;       /* Address of handler */
408         void *context;          /* Context to be passed to handler */
409 };
410
411 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
412
413 struct acpi_gpe_handler_info {
414         acpi_gpe_handler address;       /* Address of handler, if any */
415         void *context;          /* Context to be passed to handler */
416         struct acpi_namespace_node *method_node;        /* Method node for this GPE level (saved) */
417         u8 original_flags;      /* Original (pre-handler) GPE info */
418         u8 originally_enabled;  /* True if GPE was originally enabled */
419 };
420
421 /* Notify info for implicit notify, multiple device objects */
422
423 struct acpi_gpe_notify_info {
424         struct acpi_namespace_node *device_node;        /* Device to be notified */
425         struct acpi_gpe_notify_info *next;
426 };
427
428 /*
429  * GPE dispatch info. At any time, the GPE can have at most one type
430  * of dispatch - Method, Handler, or Implicit Notify.
431  */
432 union acpi_gpe_dispatch_info {
433         struct acpi_namespace_node *method_node;        /* Method node for this GPE level */
434         struct acpi_gpe_handler_info *handler;  /* Installed GPE handler */
435         struct acpi_gpe_notify_info *notify_list;       /* List of _PRW devices for implicit notifies */
436 };
437
438 /*
439  * Information about a GPE, one per each GPE in an array.
440  * NOTE: Important to keep this struct as small as possible.
441  */
442 struct acpi_gpe_event_info {
443         union acpi_gpe_dispatch_info dispatch;  /* Either Method, Handler, or notify_list */
444         struct acpi_gpe_register_info *register_info;   /* Backpointer to register info */
445         u8 flags;               /* Misc info about this GPE */
446         u8 gpe_number;          /* This GPE */
447         u8 runtime_count;       /* References to a run GPE */
448 };
449
450 /* Information about a GPE register pair, one per each status/enable pair in an array */
451
452 struct acpi_gpe_register_info {
453         struct acpi_generic_address status_address;     /* Address of status reg */
454         struct acpi_generic_address enable_address;     /* Address of enable reg */
455         u16 base_gpe_number;    /* Base GPE number for this register */
456         u8 enable_for_wake;     /* GPEs to keep enabled when sleeping */
457         u8 enable_for_run;      /* GPEs to keep enabled when running */
458         u8 enable_mask;         /* Current mask of enabled GPEs */
459 };
460
461 /*
462  * Information about a GPE register block, one per each installed block --
463  * GPE0, GPE1, and one per each installed GPE Block Device.
464  */
465 struct acpi_gpe_block_info {
466         struct acpi_namespace_node *node;
467         struct acpi_gpe_block_info *previous;
468         struct acpi_gpe_block_info *next;
469         struct acpi_gpe_xrupt_info *xrupt_block;        /* Backpointer to interrupt block */
470         struct acpi_gpe_register_info *register_info;   /* One per GPE register pair */
471         struct acpi_gpe_event_info *event_info; /* One for each GPE */
472         u64 address;            /* Base address of the block */
473         u32 register_count;     /* Number of register pairs in block */
474         u16 gpe_count;          /* Number of individual GPEs in block */
475         u16 block_base_number;  /* Base GPE number for this block */
476         u8 space_id;
477         u8 initialized;         /* TRUE if this block is initialized */
478 };
479
480 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
481
482 struct acpi_gpe_xrupt_info {
483         struct acpi_gpe_xrupt_info *previous;
484         struct acpi_gpe_xrupt_info *next;
485         struct acpi_gpe_block_info *gpe_block_list_head;        /* List of GPE blocks for this xrupt */
486         u32 interrupt_number;   /* System interrupt number */
487 };
488
489 struct acpi_gpe_walk_info {
490         struct acpi_namespace_node *gpe_device;
491         struct acpi_gpe_block_info *gpe_block;
492         u16 count;
493         acpi_owner_id owner_id;
494         u8 execute_by_owner_id;
495 };
496
497 struct acpi_gpe_device_info {
498         u32 index;
499         u32 next_block_base_index;
500         acpi_status status;
501         struct acpi_namespace_node *gpe_device;
502 };
503
504 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
505                                          gpe_xrupt_info,
506                                          struct acpi_gpe_block_info *gpe_block,
507                                          void *context);
508
509 /* Information about each particular fixed event */
510
511 struct acpi_fixed_event_handler {
512         acpi_event_handler handler;     /* Address of handler. */
513         void *context;          /* Context to be passed to handler */
514 };
515
516 struct acpi_fixed_event_info {
517         u8 status_register_id;
518         u8 enable_register_id;
519         u16 status_bit_mask;
520         u16 enable_bit_mask;
521 };
522
523 /* Information used during field processing */
524
525 struct acpi_field_info {
526         u8 skip_field;
527         u8 field_flag;
528         u32 pkg_length;
529 };
530
531 /*****************************************************************************
532  *
533  * Generic "state" object for stacks
534  *
535  ****************************************************************************/
536
537 #define ACPI_CONTROL_NORMAL                  0xC0
538 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
539 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
540 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
541 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
542
543 #define ACPI_STATE_COMMON \
544         void                            *next; \
545         u8                              descriptor_type; /* To differentiate various internal objs */\
546         u8                              flags; \
547         u16                             value; \
548         u16                             state;
549
550         /* There are 2 bytes available here until the next natural alignment boundary */
551
552 struct acpi_common_state {
553 ACPI_STATE_COMMON};
554
555 /*
556  * Update state - used to traverse complex objects such as packages
557  */
558 struct acpi_update_state {
559         ACPI_STATE_COMMON union acpi_operand_object *object;
560 };
561
562 /*
563  * Pkg state - used to traverse nested package structures
564  */
565 struct acpi_pkg_state {
566         ACPI_STATE_COMMON u16 index;
567         union acpi_operand_object *source_object;
568         union acpi_operand_object *dest_object;
569         struct acpi_walk_state *walk_state;
570         void *this_target_obj;
571         u32 num_packages;
572 };
573
574 /*
575  * Control state - one per if/else and while constructs.
576  * Allows nesting of these constructs
577  */
578 struct acpi_control_state {
579         ACPI_STATE_COMMON u16 opcode;
580         union acpi_parse_object *predicate_op;
581         u8 *aml_predicate_start;        /* Start of if/while predicate */
582         u8 *package_end;        /* End of if/while block */
583         u32 loop_count;         /* While() loop counter */
584 };
585
586 /*
587  * Scope state - current scope during namespace lookups
588  */
589 struct acpi_scope_state {
590         ACPI_STATE_COMMON struct acpi_namespace_node *node;
591 };
592
593 struct acpi_pscope_state {
594         ACPI_STATE_COMMON u32 arg_count;        /* Number of fixed arguments */
595         union acpi_parse_object *op;    /* Current op being parsed */
596         u8 *arg_end;            /* Current argument end */
597         u8 *pkg_end;            /* Current package end */
598         u32 arg_list;           /* Next argument to parse */
599 };
600
601 /*
602  * Thread state - one per thread across multiple walk states. Multiple walk
603  * states are created when there are nested control methods executing.
604  */
605 struct acpi_thread_state {
606         ACPI_STATE_COMMON u8 current_sync_level;        /* Mutex Sync (nested acquire) level */
607         struct acpi_walk_state *walk_state_list;        /* Head of list of walk_states for this thread */
608         union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
609         acpi_thread_id thread_id;       /* Running thread ID */
610 };
611
612 /*
613  * Result values - used to accumulate the results of nested
614  * AML arguments
615  */
616 struct acpi_result_values {
617         ACPI_STATE_COMMON
618             union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
619 };
620
621 typedef
622 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
623                                     union acpi_parse_object ** out_op);
624
625 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
626
627 /* Global handlers for AML Notifies */
628
629 struct acpi_global_notify_handler {
630         acpi_notify_handler handler;
631         void *context;
632 };
633
634 /*
635  * Notify info - used to pass info to the deferred notify
636  * handler/dispatcher.
637  */
638 struct acpi_notify_info {
639         ACPI_STATE_COMMON u8 handler_list_id;
640         struct acpi_namespace_node *node;
641         union acpi_operand_object *handler_list_head;
642         struct acpi_global_notify_handler *global;
643 };
644
645 /* Generic state is union of structs above */
646
647 union acpi_generic_state {
648         struct acpi_common_state common;
649         struct acpi_control_state control;
650         struct acpi_update_state update;
651         struct acpi_scope_state scope;
652         struct acpi_pscope_state parse_scope;
653         struct acpi_pkg_state pkg;
654         struct acpi_thread_state thread;
655         struct acpi_result_values results;
656         struct acpi_notify_info notify;
657 };
658
659 /*****************************************************************************
660  *
661  * Interpreter typedefs and structs
662  *
663  ****************************************************************************/
664
665 typedef acpi_status(*acpi_execute_op) (struct acpi_walk_state * walk_state);
666
667 /* Address Range info block */
668
669 struct acpi_address_range {
670         struct acpi_address_range *next;
671         struct acpi_namespace_node *region_node;
672         acpi_physical_address start_address;
673         acpi_physical_address end_address;
674 };
675
676 /*****************************************************************************
677  *
678  * Parser typedefs and structs
679  *
680  ****************************************************************************/
681
682 /*
683  * AML opcode, name, and argument layout
684  */
685 struct acpi_opcode_info {
686 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
687         char *name;             /* Opcode name (disassembler/debug only) */
688 #endif
689         u32 parse_args;         /* Grammar/Parse time arguments */
690         u32 runtime_args;       /* Interpret time arguments */
691         u16 flags;              /* Misc flags */
692         u8 object_type;         /* Corresponding internal object type */
693         u8 class;               /* Opcode class */
694         u8 type;                /* Opcode type */
695 };
696
697 /* Value associated with the parse object */
698
699 union acpi_parse_value {
700         u64 integer;            /* Integer constant (Up to 64 bits) */
701         u32 size;               /* bytelist or field size */
702         char *string;           /* NULL terminated string */
703         u8 *buffer;             /* buffer or string */
704         char *name;             /* NULL terminated string */
705         union acpi_parse_object *arg;   /* arguments and contained ops */
706 };
707
708 #ifdef ACPI_DISASSEMBLER
709 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
710 #else
711 #define ACPI_DISASM_ONLY_MEMBERS(a)
712 #endif
713
714 #define ACPI_PARSE_COMMON \
715         union acpi_parse_object         *parent;        /* Parent op */\
716         u8                              descriptor_type; /* To differentiate various internal objs */\
717         u8                              flags;          /* Type of Op */\
718         u16                             aml_opcode;     /* AML opcode */\
719         u32                             aml_offset;     /* Offset of declaration in AML */\
720         union acpi_parse_object         *next;          /* Next op */\
721         struct acpi_namespace_node      *node;          /* For use by interpreter */\
722         union acpi_parse_value          value;          /* Value or args associated with the opcode */\
723         u8                              arg_list_length; /* Number of elements in the arg list */\
724         ACPI_DISASM_ONLY_MEMBERS (\
725         u8                              disasm_flags;   /* Used during AML disassembly */\
726         u8                              disasm_opcode;  /* Subtype used for disassembly */\
727         char                            *operator_symbol;/* Used for C-style operator name strings */\
728         char                            aml_op_name[16])        /* Op name (debug only) */
729
730 /* Flags for disasm_flags field above */
731
732 #define ACPI_DASM_BUFFER                0x00    /* Buffer is a simple data buffer */
733 #define ACPI_DASM_RESOURCE              0x01    /* Buffer is a Resource Descriptor */
734 #define ACPI_DASM_STRING                0x02    /* Buffer is a ASCII string */
735 #define ACPI_DASM_UNICODE               0x03    /* Buffer is a Unicode string */
736 #define ACPI_DASM_PLD_METHOD            0x04    /* Buffer is a _PLD method bit-packed buffer */
737 #define ACPI_DASM_UUID                  0x05    /* Buffer is a UUID/GUID */
738 #define ACPI_DASM_EISAID                0x06    /* Integer is an EISAID */
739 #define ACPI_DASM_MATCHOP               0x07    /* Parent opcode is a Match() operator */
740 #define ACPI_DASM_LNOT_PREFIX           0x08    /* Start of a Lnot_equal (etc.) pair of opcodes */
741 #define ACPI_DASM_LNOT_SUFFIX           0x09    /* End  of a Lnot_equal (etc.) pair of opcodes */
742 #define ACPI_DASM_HID_STRING            0x0A    /* String is a _HID or _CID */
743 #define ACPI_DASM_IGNORE                0x0B    /* Not used at this time */
744
745 /*
746  * Generic operation (for example:  If, While, Store)
747  */
748 struct acpi_parse_obj_common {
749 ACPI_PARSE_COMMON};
750
751 /*
752  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
753  * and bytelists.
754  */
755 struct acpi_parse_obj_named {
756         ACPI_PARSE_COMMON u8 *path;
757         u8 *data;               /* AML body or bytelist data */
758         u32 length;             /* AML length */
759         u32 name;               /* 4-byte name or zero if no name */
760 };
761
762 /* This version is used by the iASL compiler only */
763
764 #define ACPI_MAX_PARSEOP_NAME   20
765
766 struct acpi_parse_obj_asl {
767         ACPI_PARSE_COMMON union acpi_parse_object *child;
768         union acpi_parse_object *parent_method;
769         char *filename;
770         char *external_name;
771         char *namepath;
772         char name_seg[4];
773         u32 extra_value;
774         u32 column;
775         u32 line_number;
776         u32 logical_line_number;
777         u32 logical_byte_offset;
778         u32 end_line;
779         u32 end_logical_line;
780         u32 acpi_btype;
781         u32 aml_length;
782         u32 aml_subtree_length;
783         u32 final_aml_length;
784         u32 final_aml_offset;
785         u32 compile_flags;
786         u16 parse_opcode;
787         u8 aml_opcode_length;
788         u8 aml_pkg_len_bytes;
789         u8 extra;
790         char parse_op_name[ACPI_MAX_PARSEOP_NAME];
791 };
792
793 union acpi_parse_object {
794         struct acpi_parse_obj_common common;
795         struct acpi_parse_obj_named named;
796         struct acpi_parse_obj_asl asl;
797 };
798
799 /*
800  * Parse state - one state per parser invocation and each control
801  * method.
802  */
803 struct acpi_parse_state {
804         u8 *aml_start;          /* First AML byte */
805         u8 *aml;                /* Next AML byte */
806         u8 *aml_end;            /* (last + 1) AML byte */
807         u8 *pkg_start;          /* Current package begin */
808         u8 *pkg_end;            /* Current package end */
809         union acpi_parse_object *start_op;      /* Root of parse tree */
810         struct acpi_namespace_node *start_node;
811         union acpi_generic_state *scope;        /* Current scope */
812         union acpi_parse_object *start_scope;
813         u32 aml_size;
814 };
815
816 /* Parse object flags */
817
818 #define ACPI_PARSEOP_GENERIC            0x01
819 #define ACPI_PARSEOP_NAMED              0x02
820 #define ACPI_PARSEOP_DEFERRED           0x04
821 #define ACPI_PARSEOP_BYTELIST           0x08
822 #define ACPI_PARSEOP_IN_STACK           0x10
823 #define ACPI_PARSEOP_TARGET             0x20
824 #define ACPI_PARSEOP_IN_CACHE           0x80
825
826 /* Parse object disasm_flags */
827
828 #define ACPI_PARSEOP_IGNORE             0x01
829 #define ACPI_PARSEOP_PARAMLIST          0x02
830 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
831 #define ACPI_PARSEOP_PREDEF_CHECKED     0x08
832 #define ACPI_PARSEOP_SPECIAL            0x10
833 #define ACPI_PARSEOP_COMPOUND           0x20
834 #define ACPI_PARSEOP_ASSIGNMENT         0x40
835
836 /*****************************************************************************
837  *
838  * Hardware (ACPI registers) and PNP
839  *
840  ****************************************************************************/
841
842 struct acpi_bit_register_info {
843         u8 parent_register;
844         u8 bit_position;
845         u16 access_bit_mask;
846 };
847
848 /*
849  * Some ACPI registers have bits that must be ignored -- meaning that they
850  * must be preserved.
851  */
852 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
853
854 /* Write-only bits must be zeroed by software */
855
856 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
857
858 /* For control registers, both ignored and reserved bits must be preserved */
859
860 /*
861  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
862  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
863  * bit position", section 4.7.3.2.1. However, on some machines the OS must
864  * write a one to this bit after resume for the machine to work properly.
865  * To enable this, we no longer attempt to preserve this bit. No machines
866  * are known to fail if the bit is not preserved. (May 2009)
867  */
868 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
869 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
870 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
871                (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
872
873 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE      /* All except bit 0 */
874
875 /*
876  * Register IDs
877  * These are the full ACPI registers
878  */
879 #define ACPI_REGISTER_PM1_STATUS                0x01
880 #define ACPI_REGISTER_PM1_ENABLE                0x02
881 #define ACPI_REGISTER_PM1_CONTROL               0x03
882 #define ACPI_REGISTER_PM2_CONTROL               0x04
883 #define ACPI_REGISTER_PM_TIMER                  0x05
884 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
885 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
886
887 /* Masks used to access the bit_registers */
888
889 #define ACPI_BITMASK_TIMER_STATUS               0x0001
890 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
891 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
892 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
893 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
894 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
895 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
896 #define ACPI_BITMASK_WAKE_STATUS                0x8000
897
898 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
899         ACPI_BITMASK_TIMER_STATUS          | \
900         ACPI_BITMASK_BUS_MASTER_STATUS     | \
901         ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
902         ACPI_BITMASK_POWER_BUTTON_STATUS   | \
903         ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
904         ACPI_BITMASK_RT_CLOCK_STATUS       | \
905         ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
906         ACPI_BITMASK_WAKE_STATUS)
907
908 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
909 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
910 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
911 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
912 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
913 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
914
915 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
916 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
917 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
918 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
919 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
920
921 #define ACPI_BITMASK_ARB_DISABLE                0x0001
922
923 /* Raw bit position of each bit_register */
924
925 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
926 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
927 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
928 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
929 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
930 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
931 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
932 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
933
934 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
935 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
936 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
937 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
938 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
939 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
940
941 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
942 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
943 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
944 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
945 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
946
947 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
948
949 /* Structs and definitions for _OSI support and I/O port validation */
950
951 #define ACPI_ALWAYS_ILLEGAL             0x00
952
953 struct acpi_interface_info {
954         char *name;
955         struct acpi_interface_info *next;
956         u8 flags;
957         u8 value;
958 };
959
960 #define ACPI_OSI_INVALID                0x01
961 #define ACPI_OSI_DYNAMIC                0x02
962 #define ACPI_OSI_FEATURE                0x04
963 #define ACPI_OSI_DEFAULT_INVALID        0x08
964 #define ACPI_OSI_OPTIONAL_FEATURE       (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
965
966 struct acpi_port_info {
967         char *name;
968         u16 start;
969         u16 end;
970         u8 osi_dependency;
971 };
972
973 /*****************************************************************************
974  *
975  * Resource descriptors
976  *
977  ****************************************************************************/
978
979 /* resource_type values */
980
981 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
982 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
983 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
984
985 /* Resource descriptor types and masks */
986
987 #define ACPI_RESOURCE_NAME_LARGE                0x80
988 #define ACPI_RESOURCE_NAME_SMALL                0x00
989
990 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78    /* Bits 6:3 contain the type */
991 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07    /* Bits 2:0 contain the length */
992 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F    /* Bits 6:0 contain the type */
993
994 /*
995  * Small resource descriptor "names" as defined by the ACPI specification.
996  * Note: Bits 2:0 are used for the descriptor length
997  */
998 #define ACPI_RESOURCE_NAME_IRQ                  0x20
999 #define ACPI_RESOURCE_NAME_DMA                  0x28
1000 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
1001 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
1002 #define ACPI_RESOURCE_NAME_IO                   0x40
1003 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
1004 #define ACPI_RESOURCE_NAME_FIXED_DMA            0x50
1005 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
1006 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
1007 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
1008 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
1009 #define ACPI_RESOURCE_NAME_END_TAG              0x78
1010
1011 /*
1012  * Large resource descriptor "names" as defined by the ACPI specification.
1013  * Note: includes the Large Descriptor bit in bit[7]
1014  */
1015 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
1016 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
1017 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
1018 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
1019 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1020 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1021 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1022 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1023 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1024 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1025 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1026 #define ACPI_RESOURCE_NAME_GPIO                 0x8C
1027 #define ACPI_RESOURCE_NAME_SERIAL_BUS           0x8E
1028 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8E
1029
1030 /*****************************************************************************
1031  *
1032  * Miscellaneous
1033  *
1034  ****************************************************************************/
1035
1036 #define ACPI_ASCII_ZERO                 0x30
1037
1038 /*****************************************************************************
1039  *
1040  * Disassembler
1041  *
1042  ****************************************************************************/
1043
1044 struct acpi_external_list {
1045         char *path;
1046         char *internal_path;
1047         struct acpi_external_list *next;
1048         u32 value;
1049         u16 length;
1050         u16 flags;
1051         u8 type;
1052 };
1053
1054 /* Values for Flags field above */
1055
1056 #define ACPI_EXT_RESOLVED_REFERENCE         0x01        /* Object was resolved during cross ref */
1057 #define ACPI_EXT_ORIGIN_FROM_FILE           0x02        /* External came from a file */
1058 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED    0x04        /* Deallocate internal path on completion */
1059 #define ACPI_EXT_EXTERNAL_EMITTED           0x08        /* External() statement has been emitted */
1060
1061 struct acpi_external_file {
1062         char *path;
1063         struct acpi_external_file *next;
1064 };
1065
1066 /*****************************************************************************
1067  *
1068  * Debugger
1069  *
1070  ****************************************************************************/
1071
1072 struct acpi_db_method_info {
1073         acpi_handle method;
1074         acpi_handle main_thread_gate;
1075         acpi_handle thread_complete_gate;
1076         acpi_handle info_gate;
1077         acpi_thread_id *threads;
1078         u32 num_threads;
1079         u32 num_created;
1080         u32 num_completed;
1081
1082         char *name;
1083         u32 flags;
1084         u32 num_loops;
1085         char pathname[ACPI_DB_LINE_BUFFER_SIZE];
1086         char **args;
1087         acpi_object_type *types;
1088
1089         /*
1090          * Arguments to be passed to method for the command
1091          * Threads -
1092          *   the Number of threads, ID of current thread and
1093          *   Index of current thread inside all them created.
1094          */
1095         char init_args;
1096         char *arguments[4];
1097         char num_threads_str[11];
1098         char id_of_thread_str[11];
1099         char index_of_thread_str[11];
1100 };
1101
1102 struct acpi_integrity_info {
1103         u32 nodes;
1104         u32 objects;
1105 };
1106
1107 #define ACPI_DB_DISABLE_OUTPUT          0x00
1108 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1109 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1110 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1111
1112 /*****************************************************************************
1113  *
1114  * Debug
1115  *
1116  ****************************************************************************/
1117
1118 /* Entry for a memory allocation (debug only) */
1119
1120 #define ACPI_MEM_MALLOC                 0
1121 #define ACPI_MEM_CALLOC                 1
1122 #define ACPI_MAX_MODULE_NAME            16
1123
1124 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1125         struct acpi_debug_mem_block     *previous; \
1126         struct acpi_debug_mem_block     *next; \
1127         u32                             size; \
1128         u32                             component; \
1129         u32                             line; \
1130         char                            module[ACPI_MAX_MODULE_NAME]; \
1131         u8                              alloc_type;
1132
1133 struct acpi_debug_mem_header {
1134 ACPI_COMMON_DEBUG_MEM_HEADER};
1135
1136 struct acpi_debug_mem_block {
1137         ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1138 };
1139
1140 #define ACPI_MEM_LIST_GLOBAL            0
1141 #define ACPI_MEM_LIST_NSNODE            1
1142 #define ACPI_MEM_LIST_MAX               1
1143 #define ACPI_NUM_MEM_LISTS              2
1144
1145 /*****************************************************************************
1146  *
1147  * Info/help support
1148  *
1149  ****************************************************************************/
1150
1151 struct ah_predefined_name {
1152         char *name;
1153         char *description;
1154 #ifndef ACPI_ASL_COMPILER
1155         char *action;
1156 #endif
1157 };
1158
1159 struct ah_device_id {
1160         char *name;
1161         char *description;
1162 };
1163
1164 struct ah_uuid {
1165         char *description;
1166         char *string;
1167 };
1168
1169 #endif                          /* __ACLOCAL_H__ */