ACPICA: Update local C library module comments for ASCII table
[deliverable/linux.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 /* Notify info for implicit notify, multiple device objects */
408
409 struct acpi_gpe_notify_info {
410 struct acpi_namespace_node *device_node; /* Device to be notified */
411 struct acpi_gpe_notify_info *next;
412 };
413
414 struct acpi_gpe_notify_object {
415 struct acpi_namespace_node *node;
416 struct acpi_gpe_notify_object *next;
417 };
418
419 union acpi_gpe_dispatch_info {
420 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
421 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */
422 struct acpi_gpe_notify_info *notify_list; /* List of _PRW devices for implicit notifies */
423 };
424
425 /*
426 * Information about a GPE, one per each GPE in an array.
427 * NOTE: Important to keep this struct as small as possible.
428 */
429 struct acpi_gpe_event_info {
430 union acpi_gpe_dispatch_info dispatch; /* Either Method, Handler, or notify_list */
431 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
432 u8 flags; /* Misc info about this GPE */
433 u8 gpe_number; /* This GPE */
434 u8 runtime_count; /* References to a run GPE */
435 };
436
437 /* Information about a GPE register pair, one per each status/enable pair in an array */
438
439 struct acpi_gpe_register_info {
440 struct acpi_generic_address status_address; /* Address of status reg */
441 struct acpi_generic_address enable_address; /* Address of enable reg */
442 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
443 u8 enable_for_run; /* GPEs to keep enabled when running */
444 u8 base_gpe_number; /* Base GPE number for this register */
445 };
446
447 /*
448 * Information about a GPE register block, one per each installed block --
449 * GPE0, GPE1, and one per each installed GPE Block Device.
450 */
451 struct acpi_gpe_block_info {
452 struct acpi_namespace_node *node;
453 struct acpi_gpe_block_info *previous;
454 struct acpi_gpe_block_info *next;
455 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
456 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
457 struct acpi_gpe_event_info *event_info; /* One for each GPE */
458 struct acpi_generic_address block_address; /* Base address of the block */
459 u32 register_count; /* Number of register pairs in block */
460 u16 gpe_count; /* Number of individual GPEs in block */
461 u8 block_base_number; /* Base GPE number for this block */
462 u8 initialized; /* TRUE if this block is initialized */
463 };
464
465 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
466
467 struct acpi_gpe_xrupt_info {
468 struct acpi_gpe_xrupt_info *previous;
469 struct acpi_gpe_xrupt_info *next;
470 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
471 u32 interrupt_number; /* System interrupt number */
472 };
473
474 struct acpi_gpe_walk_info {
475 struct acpi_namespace_node *gpe_device;
476 struct acpi_gpe_block_info *gpe_block;
477 u16 count;
478 acpi_owner_id owner_id;
479 u8 execute_by_owner_id;
480 };
481
482 struct acpi_gpe_device_info {
483 u32 index;
484 u32 next_block_base_index;
485 acpi_status status;
486 struct acpi_namespace_node *gpe_device;
487 };
488
489 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
490 gpe_xrupt_info,
491 struct acpi_gpe_block_info *gpe_block,
492 void *context);
493
494 /* Information about each particular fixed event */
495
496 struct acpi_fixed_event_handler {
497 acpi_event_handler handler; /* Address of handler. */
498 void *context; /* Context to be passed to handler */
499 };
500
501 struct acpi_fixed_event_info {
502 u8 status_register_id;
503 u8 enable_register_id;
504 u16 status_bit_mask;
505 u16 enable_bit_mask;
506 };
507
508 /* Information used during field processing */
509
510 struct acpi_field_info {
511 u8 skip_field;
512 u8 field_flag;
513 u32 pkg_length;
514 };
515
516 /*****************************************************************************
517 *
518 * Generic "state" object for stacks
519 *
520 ****************************************************************************/
521
522 #define ACPI_CONTROL_NORMAL 0xC0
523 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
524 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
525 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
526 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
527
528 #define ACPI_STATE_COMMON \
529 void *next; \
530 u8 descriptor_type; /* To differentiate various internal objs */\
531 u8 flags; \
532 u16 value; \
533 u16 state;
534
535 /* There are 2 bytes available here until the next natural alignment boundary */
536
537 struct acpi_common_state {
538 ACPI_STATE_COMMON};
539
540 /*
541 * Update state - used to traverse complex objects such as packages
542 */
543 struct acpi_update_state {
544 ACPI_STATE_COMMON union acpi_operand_object *object;
545 };
546
547 /*
548 * Pkg state - used to traverse nested package structures
549 */
550 struct acpi_pkg_state {
551 ACPI_STATE_COMMON u16 index;
552 union acpi_operand_object *source_object;
553 union acpi_operand_object *dest_object;
554 struct acpi_walk_state *walk_state;
555 void *this_target_obj;
556 u32 num_packages;
557 };
558
559 /*
560 * Control state - one per if/else and while constructs.
561 * Allows nesting of these constructs
562 */
563 struct acpi_control_state {
564 ACPI_STATE_COMMON u16 opcode;
565 union acpi_parse_object *predicate_op;
566 u8 *aml_predicate_start; /* Start of if/while predicate */
567 u8 *package_end; /* End of if/while block */
568 u32 loop_count; /* While() loop counter */
569 };
570
571 /*
572 * Scope state - current scope during namespace lookups
573 */
574 struct acpi_scope_state {
575 ACPI_STATE_COMMON struct acpi_namespace_node *node;
576 };
577
578 struct acpi_pscope_state {
579 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
580 union acpi_parse_object *op; /* Current op being parsed */
581 u8 *arg_end; /* Current argument end */
582 u8 *pkg_end; /* Current package end */
583 u32 arg_list; /* Next argument to parse */
584 };
585
586 /*
587 * Thread state - one per thread across multiple walk states. Multiple walk
588 * states are created when there are nested control methods executing.
589 */
590 struct acpi_thread_state {
591 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
592 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
593 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
594 acpi_thread_id thread_id; /* Running thread ID */
595 };
596
597 /*
598 * Result values - used to accumulate the results of nested
599 * AML arguments
600 */
601 struct acpi_result_values {
602 ACPI_STATE_COMMON
603 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
604 };
605
606 typedef
607 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
608 union acpi_parse_object ** out_op);
609
610 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
611
612 /* Global handlers for AML Notifies */
613
614 struct acpi_global_notify_handler {
615 acpi_notify_handler handler;
616 void *context;
617 };
618
619 /*
620 * Notify info - used to pass info to the deferred notify
621 * handler/dispatcher.
622 */
623 struct acpi_notify_info {
624 ACPI_STATE_COMMON u8 handler_list_id;
625 struct acpi_namespace_node *node;
626 union acpi_operand_object *handler_list_head;
627 struct acpi_global_notify_handler *global;
628 };
629
630 /* Generic state is union of structs above */
631
632 union acpi_generic_state {
633 struct acpi_common_state common;
634 struct acpi_control_state control;
635 struct acpi_update_state update;
636 struct acpi_scope_state scope;
637 struct acpi_pscope_state parse_scope;
638 struct acpi_pkg_state pkg;
639 struct acpi_thread_state thread;
640 struct acpi_result_values results;
641 struct acpi_notify_info notify;
642 };
643
644 /*****************************************************************************
645 *
646 * Interpreter typedefs and structs
647 *
648 ****************************************************************************/
649
650 typedef acpi_status(*acpi_execute_op) (struct acpi_walk_state * walk_state);
651
652 /* Address Range info block */
653
654 struct acpi_address_range {
655 struct acpi_address_range *next;
656 struct acpi_namespace_node *region_node;
657 acpi_physical_address start_address;
658 acpi_physical_address end_address;
659 };
660
661 /*****************************************************************************
662 *
663 * Parser typedefs and structs
664 *
665 ****************************************************************************/
666
667 /*
668 * AML opcode, name, and argument layout
669 */
670 struct acpi_opcode_info {
671 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
672 char *name; /* Opcode name (disassembler/debug only) */
673 #endif
674 u32 parse_args; /* Grammar/Parse time arguments */
675 u32 runtime_args; /* Interpret time arguments */
676 u16 flags; /* Misc flags */
677 u8 object_type; /* Corresponding internal object type */
678 u8 class; /* Opcode class */
679 u8 type; /* Opcode type */
680 };
681
682 union acpi_parse_value {
683 u64 integer; /* Integer constant (Up to 64 bits) */
684 u32 size; /* bytelist or field size */
685 char *string; /* NULL terminated string */
686 u8 *buffer; /* buffer or string */
687 char *name; /* NULL terminated string */
688 union acpi_parse_object *arg; /* arguments and contained ops */
689 };
690
691 #ifdef ACPI_DISASSEMBLER
692 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
693 #else
694 #define ACPI_DISASM_ONLY_MEMBERS(a)
695 #endif
696
697 #define ACPI_PARSE_COMMON \
698 union acpi_parse_object *parent; /* Parent op */\
699 u8 descriptor_type; /* To differentiate various internal objs */\
700 u8 flags; /* Type of Op */\
701 u16 aml_opcode; /* AML opcode */\
702 u32 aml_offset; /* Offset of declaration in AML */\
703 union acpi_parse_object *next; /* Next op */\
704 struct acpi_namespace_node *node; /* For use by interpreter */\
705 union acpi_parse_value value; /* Value or args associated with the opcode */\
706 u8 arg_list_length; /* Number of elements in the arg list */\
707 ACPI_DISASM_ONLY_MEMBERS (\
708 u8 disasm_flags; /* Used during AML disassembly */\
709 u8 disasm_opcode; /* Subtype used for disassembly */\
710 char aml_op_name[16]) /* Op name (debug only) */
711
712 /* Flags for disasm_flags field above */
713
714 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
715 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
716 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
717 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
718 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
719 #define ACPI_DASM_EISAID 0x05 /* Integer is an EISAID */
720 #define ACPI_DASM_MATCHOP 0x06 /* Parent opcode is a Match() operator */
721 #define ACPI_DASM_LNOT_PREFIX 0x07 /* Start of a Lnot_equal (etc.) pair of opcodes */
722 #define ACPI_DASM_LNOT_SUFFIX 0x08 /* End of a Lnot_equal (etc.) pair of opcodes */
723 #define ACPI_DASM_IGNORE 0x09 /* Not used at this time */
724
725 /*
726 * Generic operation (for example: If, While, Store)
727 */
728 struct acpi_parse_obj_common {
729 ACPI_PARSE_COMMON};
730
731 /*
732 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
733 * and bytelists.
734 */
735 struct acpi_parse_obj_named {
736 ACPI_PARSE_COMMON u8 *path;
737 u8 *data; /* AML body or bytelist data */
738 u32 length; /* AML length */
739 u32 name; /* 4-byte name or zero if no name */
740 };
741
742 /* This version is used by the iASL compiler only */
743
744 #define ACPI_MAX_PARSEOP_NAME 20
745
746 struct acpi_parse_obj_asl {
747 ACPI_PARSE_COMMON union acpi_parse_object *child;
748 union acpi_parse_object *parent_method;
749 char *filename;
750 char *external_name;
751 char *namepath;
752 char name_seg[4];
753 u32 extra_value;
754 u32 column;
755 u32 line_number;
756 u32 logical_line_number;
757 u32 logical_byte_offset;
758 u32 end_line;
759 u32 end_logical_line;
760 u32 acpi_btype;
761 u32 aml_length;
762 u32 aml_subtree_length;
763 u32 final_aml_length;
764 u32 final_aml_offset;
765 u32 compile_flags;
766 u16 parse_opcode;
767 u8 aml_opcode_length;
768 u8 aml_pkg_len_bytes;
769 u8 extra;
770 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
771 };
772
773 union acpi_parse_object {
774 struct acpi_parse_obj_common common;
775 struct acpi_parse_obj_named named;
776 struct acpi_parse_obj_asl asl;
777 };
778
779 /*
780 * Parse state - one state per parser invocation and each control
781 * method.
782 */
783 struct acpi_parse_state {
784 u8 *aml_start; /* First AML byte */
785 u8 *aml; /* Next AML byte */
786 u8 *aml_end; /* (last + 1) AML byte */
787 u8 *pkg_start; /* Current package begin */
788 u8 *pkg_end; /* Current package end */
789 union acpi_parse_object *start_op; /* Root of parse tree */
790 struct acpi_namespace_node *start_node;
791 union acpi_generic_state *scope; /* Current scope */
792 union acpi_parse_object *start_scope;
793 u32 aml_size;
794 };
795
796 /* Parse object flags */
797
798 #define ACPI_PARSEOP_GENERIC 0x01
799 #define ACPI_PARSEOP_NAMED 0x02
800 #define ACPI_PARSEOP_DEFERRED 0x04
801 #define ACPI_PARSEOP_BYTELIST 0x08
802 #define ACPI_PARSEOP_IN_STACK 0x10
803 #define ACPI_PARSEOP_TARGET 0x20
804 #define ACPI_PARSEOP_IN_CACHE 0x80
805
806 /* Parse object disasm_flags */
807
808 #define ACPI_PARSEOP_IGNORE 0x01
809 #define ACPI_PARSEOP_PARAMLIST 0x02
810 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
811 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
812 #define ACPI_PARSEOP_SPECIAL 0x10
813
814 /*****************************************************************************
815 *
816 * Hardware (ACPI registers) and PNP
817 *
818 ****************************************************************************/
819
820 struct acpi_bit_register_info {
821 u8 parent_register;
822 u8 bit_position;
823 u16 access_bit_mask;
824 };
825
826 /*
827 * Some ACPI registers have bits that must be ignored -- meaning that they
828 * must be preserved.
829 */
830 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
831
832 /* Write-only bits must be zeroed by software */
833
834 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
835
836 /* For control registers, both ignored and reserved bits must be preserved */
837
838 /*
839 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
840 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
841 * bit position", section 4.7.3.2.1. However, on some machines the OS must
842 * write a one to this bit after resume for the machine to work properly.
843 * To enable this, we no longer attempt to preserve this bit. No machines
844 * are known to fail if the bit is not preserved. (May 2009)
845 */
846 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
847 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
848 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
849 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
850
851 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
852
853 /*
854 * Register IDs
855 * These are the full ACPI registers
856 */
857 #define ACPI_REGISTER_PM1_STATUS 0x01
858 #define ACPI_REGISTER_PM1_ENABLE 0x02
859 #define ACPI_REGISTER_PM1_CONTROL 0x03
860 #define ACPI_REGISTER_PM2_CONTROL 0x04
861 #define ACPI_REGISTER_PM_TIMER 0x05
862 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
863 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
864
865 /* Masks used to access the bit_registers */
866
867 #define ACPI_BITMASK_TIMER_STATUS 0x0001
868 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
869 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
870 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
871 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
872 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
873 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
874 #define ACPI_BITMASK_WAKE_STATUS 0x8000
875
876 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
877 ACPI_BITMASK_TIMER_STATUS | \
878 ACPI_BITMASK_BUS_MASTER_STATUS | \
879 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
880 ACPI_BITMASK_POWER_BUTTON_STATUS | \
881 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
882 ACPI_BITMASK_RT_CLOCK_STATUS | \
883 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
884 ACPI_BITMASK_WAKE_STATUS)
885
886 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
887 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
888 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
889 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
890 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
891 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
892
893 #define ACPI_BITMASK_SCI_ENABLE 0x0001
894 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
895 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
896 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
897 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
898
899 #define ACPI_BITMASK_ARB_DISABLE 0x0001
900
901 /* Raw bit position of each bit_register */
902
903 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
904 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
905 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
906 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
907 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
908 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
909 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
910 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
911
912 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
913 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
914 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
915 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
916 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
917 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
918
919 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
920 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
921 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
922 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
923 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
924
925 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
926
927 /* Structs and definitions for _OSI support and I/O port validation */
928
929 #define ACPI_OSI_WIN_2000 0x01
930 #define ACPI_OSI_WIN_XP 0x02
931 #define ACPI_OSI_WIN_XP_SP1 0x03
932 #define ACPI_OSI_WINSRV_2003 0x04
933 #define ACPI_OSI_WIN_XP_SP2 0x05
934 #define ACPI_OSI_WINSRV_2003_SP1 0x06
935 #define ACPI_OSI_WIN_VISTA 0x07
936 #define ACPI_OSI_WINSRV_2008 0x08
937 #define ACPI_OSI_WIN_VISTA_SP1 0x09
938 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
939 #define ACPI_OSI_WIN_7 0x0B
940 #define ACPI_OSI_WIN_8 0x0C
941
942 #define ACPI_ALWAYS_ILLEGAL 0x00
943
944 struct acpi_interface_info {
945 char *name;
946 struct acpi_interface_info *next;
947 u8 flags;
948 u8 value;
949 };
950
951 #define ACPI_OSI_INVALID 0x01
952 #define ACPI_OSI_DYNAMIC 0x02
953
954 struct acpi_port_info {
955 char *name;
956 u16 start;
957 u16 end;
958 u8 osi_dependency;
959 };
960
961 /*****************************************************************************
962 *
963 * Resource descriptors
964 *
965 ****************************************************************************/
966
967 /* resource_type values */
968
969 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
970 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
971 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
972
973 /* Resource descriptor types and masks */
974
975 #define ACPI_RESOURCE_NAME_LARGE 0x80
976 #define ACPI_RESOURCE_NAME_SMALL 0x00
977
978 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
979 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
980 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
981
982 /*
983 * Small resource descriptor "names" as defined by the ACPI specification.
984 * Note: Bits 2:0 are used for the descriptor length
985 */
986 #define ACPI_RESOURCE_NAME_IRQ 0x20
987 #define ACPI_RESOURCE_NAME_DMA 0x28
988 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
989 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
990 #define ACPI_RESOURCE_NAME_IO 0x40
991 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
992 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
993 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
994 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
995 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
996 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
997 #define ACPI_RESOURCE_NAME_END_TAG 0x78
998
999 /*
1000 * Large resource descriptor "names" as defined by the ACPI specification.
1001 * Note: includes the Large Descriptor bit in bit[7]
1002 */
1003 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1004 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1005 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1006 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1007 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1008 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1009 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1010 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1011 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1012 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1013 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1014 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1015 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1016 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1017
1018 /*****************************************************************************
1019 *
1020 * Miscellaneous
1021 *
1022 ****************************************************************************/
1023
1024 #define ACPI_ASCII_ZERO 0x30
1025
1026 /*****************************************************************************
1027 *
1028 * Debugger
1029 *
1030 ****************************************************************************/
1031
1032 struct acpi_db_method_info {
1033 acpi_handle method;
1034 acpi_handle main_thread_gate;
1035 acpi_handle thread_complete_gate;
1036 acpi_handle info_gate;
1037 acpi_thread_id *threads;
1038 u32 num_threads;
1039 u32 num_created;
1040 u32 num_completed;
1041
1042 char *name;
1043 u32 flags;
1044 u32 num_loops;
1045 char pathname[128];
1046 char **args;
1047 acpi_object_type *types;
1048
1049 /*
1050 * Arguments to be passed to method for the command
1051 * Threads -
1052 * the Number of threads, ID of current thread and
1053 * Index of current thread inside all them created.
1054 */
1055 char init_args;
1056 char *arguments[4];
1057 char num_threads_str[11];
1058 char id_of_thread_str[11];
1059 char index_of_thread_str[11];
1060 };
1061
1062 struct acpi_integrity_info {
1063 u32 nodes;
1064 u32 objects;
1065 };
1066
1067 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1068 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1069 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1070
1071 /*****************************************************************************
1072 *
1073 * Debug
1074 *
1075 ****************************************************************************/
1076
1077 /* Entry for a memory allocation (debug only) */
1078
1079 #define ACPI_MEM_MALLOC 0
1080 #define ACPI_MEM_CALLOC 1
1081 #define ACPI_MAX_MODULE_NAME 16
1082
1083 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1084 struct acpi_debug_mem_block *previous; \
1085 struct acpi_debug_mem_block *next; \
1086 u32 size; \
1087 u32 component; \
1088 u32 line; \
1089 char module[ACPI_MAX_MODULE_NAME]; \
1090 u8 alloc_type;
1091
1092 struct acpi_debug_mem_header {
1093 ACPI_COMMON_DEBUG_MEM_HEADER};
1094
1095 struct acpi_debug_mem_block {
1096 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1097 };
1098
1099 #define ACPI_MEM_LIST_GLOBAL 0
1100 #define ACPI_MEM_LIST_NSNODE 1
1101 #define ACPI_MEM_LIST_MAX 1
1102 #define ACPI_NUM_MEM_LISTS 2
1103
1104 /*****************************************************************************
1105 *
1106 * Info/help support
1107 *
1108 ****************************************************************************/
1109
1110 struct ah_predefined_name {
1111 char *name;
1112 char *description;
1113 #ifndef ACPI_ASL_COMPILER
1114 char *action;
1115 #endif
1116 };
1117
1118 #endif /* __ACLOCAL_H__ */
This page took 0.057583 seconds and 5 git commands to generate.