Loading...
1/******************************************************************************
2 *
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, 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
51typedef u32 acpi_mutex_handle;
52#define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1)
53
54/* Total number of aml opcodes defined */
55
56#define AML_NUM_OPCODES 0x7F
57
58/* Forward declarations */
59
60struct acpi_walk_state;
61struct acpi_obj_mutex;
62union 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
94struct 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
116struct 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
144typedef 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 */
161struct 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
200struct 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
218struct acpi_find_context {
219 char *search_for;
220 acpi_handle *list;
221 u32 *count;
222};
223
224struct 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
235struct 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
247struct 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 u32 bank_value;
253 u32 field_bit_position;
254 u32 field_bit_length;
255 u8 field_flags;
256 u8 attribute;
257 u8 field_type;
258};
259
260typedef
261acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
262
263/*
264 * Bitmapped ACPI types. Used internally only
265 */
266#define ACPI_BTYPE_ANY 0x00000000
267#define ACPI_BTYPE_INTEGER 0x00000001
268#define ACPI_BTYPE_STRING 0x00000002
269#define ACPI_BTYPE_BUFFER 0x00000004
270#define ACPI_BTYPE_PACKAGE 0x00000008
271#define ACPI_BTYPE_FIELD_UNIT 0x00000010
272#define ACPI_BTYPE_DEVICE 0x00000020
273#define ACPI_BTYPE_EVENT 0x00000040
274#define ACPI_BTYPE_METHOD 0x00000080
275#define ACPI_BTYPE_MUTEX 0x00000100
276#define ACPI_BTYPE_REGION 0x00000200
277#define ACPI_BTYPE_POWER 0x00000400
278#define ACPI_BTYPE_PROCESSOR 0x00000800
279#define ACPI_BTYPE_THERMAL 0x00001000
280#define ACPI_BTYPE_BUFFER_FIELD 0x00002000
281#define ACPI_BTYPE_DDB_HANDLE 0x00004000
282#define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
283#define ACPI_BTYPE_REFERENCE 0x00010000
284#define ACPI_BTYPE_RESOURCE 0x00020000
285
286#define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
287
288#define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
289#define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
290#define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
291#define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
292#define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
293
294/*
295 * Information structure for ACPI predefined names.
296 * Each entry in the table contains the following items:
297 *
298 * Name - The ACPI reserved name
299 * param_count - Number of arguments to the method
300 * expected_return_btypes - Allowed type(s) for the return value
301 */
302struct acpi_name_info {
303 char name[ACPI_NAME_SIZE];
304 u8 param_count;
305 u8 expected_btypes;
306};
307
308/*
309 * Secondary information structures for ACPI predefined objects that return
310 * package objects. This structure appears as the next entry in the table
311 * after the NAME_INFO structure above.
312 *
313 * The reason for this is to minimize the size of the predefined name table.
314 */
315
316/*
317 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
318 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
319 */
320struct acpi_package_info {
321 u8 type;
322 u8 object_type1;
323 u8 count1;
324 u8 object_type2;
325 u8 count2;
326 u8 reserved;
327};
328
329/* Used for ACPI_PTYPE2_FIXED */
330
331struct acpi_package_info2 {
332 u8 type;
333 u8 count;
334 u8 object_type[4];
335};
336
337/* Used for ACPI_PTYPE1_OPTION */
338
339struct acpi_package_info3 {
340 u8 type;
341 u8 count;
342 u8 object_type[2];
343 u8 tail_object_type;
344 u8 reserved;
345};
346
347union acpi_predefined_info {
348 struct acpi_name_info info;
349 struct acpi_package_info ret_info;
350 struct acpi_package_info2 ret_info2;
351 struct acpi_package_info3 ret_info3;
352};
353
354/* Data block used during object validation */
355
356struct acpi_predefined_data {
357 char *pathname;
358 const union acpi_predefined_info *predefined;
359 union acpi_operand_object *parent_package;
360 struct acpi_namespace_node *node;
361 u32 flags;
362 u8 node_flags;
363};
364
365/* Defines for Flags field above */
366
367#define ACPI_OBJECT_REPAIRED 1
368
369/*
370 * Bitmapped return value types
371 * Note: the actual data types must be contiguous, a loop in nspredef.c
372 * depends on this.
373 */
374#define ACPI_RTYPE_ANY 0x00
375#define ACPI_RTYPE_NONE 0x01
376#define ACPI_RTYPE_INTEGER 0x02
377#define ACPI_RTYPE_STRING 0x04
378#define ACPI_RTYPE_BUFFER 0x08
379#define ACPI_RTYPE_PACKAGE 0x10
380#define ACPI_RTYPE_REFERENCE 0x20
381#define ACPI_RTYPE_ALL 0x3F
382
383#define ACPI_NUM_RTYPES 5 /* Number of actual object types */
384
385/*****************************************************************************
386 *
387 * Event typedefs and structs
388 *
389 ****************************************************************************/
390
391/* Dispatch info for each GPE -- either a method or handler, cannot be both */
392
393struct acpi_gpe_handler_info {
394 acpi_gpe_handler address; /* Address of handler, if any */
395 void *context; /* Context to be passed to handler */
396 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
397 u8 original_flags; /* Original (pre-handler) GPE info */
398 u8 originally_enabled; /* True if GPE was originally enabled */
399};
400
401struct acpi_gpe_notify_object {
402 struct acpi_namespace_node *node;
403 struct acpi_gpe_notify_object *next;
404};
405
406union acpi_gpe_dispatch_info {
407 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
408 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */
409 struct acpi_gpe_notify_object device; /* List of _PRW devices for implicit notify */
410};
411
412/*
413 * Information about a GPE, one per each GPE in an array.
414 * NOTE: Important to keep this struct as small as possible.
415 */
416struct acpi_gpe_event_info {
417 union acpi_gpe_dispatch_info dispatch; /* Either Method or Handler */
418 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
419 u8 flags; /* Misc info about this GPE */
420 u8 gpe_number; /* This GPE */
421 u8 runtime_count; /* References to a run GPE */
422};
423
424/* Information about a GPE register pair, one per each status/enable pair in an array */
425
426struct acpi_gpe_register_info {
427 struct acpi_generic_address status_address; /* Address of status reg */
428 struct acpi_generic_address enable_address; /* Address of enable reg */
429 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
430 u8 enable_for_run; /* GPEs to keep enabled when running */
431 u8 base_gpe_number; /* Base GPE number for this register */
432};
433
434/*
435 * Information about a GPE register block, one per each installed block --
436 * GPE0, GPE1, and one per each installed GPE Block Device.
437 */
438struct acpi_gpe_block_info {
439 struct acpi_namespace_node *node;
440 struct acpi_gpe_block_info *previous;
441 struct acpi_gpe_block_info *next;
442 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
443 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
444 struct acpi_gpe_event_info *event_info; /* One for each GPE */
445 struct acpi_generic_address block_address; /* Base address of the block */
446 u32 register_count; /* Number of register pairs in block */
447 u16 gpe_count; /* Number of individual GPEs in block */
448 u8 block_base_number; /* Base GPE number for this block */
449 u8 initialized; /* TRUE if this block is initialized */
450};
451
452/* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
453
454struct acpi_gpe_xrupt_info {
455 struct acpi_gpe_xrupt_info *previous;
456 struct acpi_gpe_xrupt_info *next;
457 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
458 u32 interrupt_number; /* System interrupt number */
459};
460
461struct acpi_gpe_walk_info {
462 struct acpi_namespace_node *gpe_device;
463 struct acpi_gpe_block_info *gpe_block;
464 u16 count;
465 acpi_owner_id owner_id;
466 u8 execute_by_owner_id;
467};
468
469struct acpi_gpe_device_info {
470 u32 index;
471 u32 next_block_base_index;
472 acpi_status status;
473 struct acpi_namespace_node *gpe_device;
474};
475
476typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *gpe_xrupt_info,
477 struct acpi_gpe_block_info *gpe_block, void *context);
478
479/* Information about each particular fixed event */
480
481struct acpi_fixed_event_handler {
482 acpi_event_handler handler; /* Address of handler. */
483 void *context; /* Context to be passed to handler */
484};
485
486struct acpi_fixed_event_info {
487 u8 status_register_id;
488 u8 enable_register_id;
489 u16 status_bit_mask;
490 u16 enable_bit_mask;
491};
492
493/* Information used during field processing */
494
495struct acpi_field_info {
496 u8 skip_field;
497 u8 field_flag;
498 u32 pkg_length;
499};
500
501/*****************************************************************************
502 *
503 * Generic "state" object for stacks
504 *
505 ****************************************************************************/
506
507#define ACPI_CONTROL_NORMAL 0xC0
508#define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
509#define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
510#define ACPI_CONTROL_PREDICATE_FALSE 0xC3
511#define ACPI_CONTROL_PREDICATE_TRUE 0xC4
512
513#define ACPI_STATE_COMMON \
514 void *next; \
515 u8 descriptor_type; /* To differentiate various internal objs */\
516 u8 flags; \
517 u16 value; \
518 u16 state;
519
520 /* There are 2 bytes available here until the next natural alignment boundary */
521
522struct acpi_common_state {
523ACPI_STATE_COMMON};
524
525/*
526 * Update state - used to traverse complex objects such as packages
527 */
528struct acpi_update_state {
529 ACPI_STATE_COMMON union acpi_operand_object *object;
530};
531
532/*
533 * Pkg state - used to traverse nested package structures
534 */
535struct acpi_pkg_state {
536 ACPI_STATE_COMMON u16 index;
537 union acpi_operand_object *source_object;
538 union acpi_operand_object *dest_object;
539 struct acpi_walk_state *walk_state;
540 void *this_target_obj;
541 u32 num_packages;
542};
543
544/*
545 * Control state - one per if/else and while constructs.
546 * Allows nesting of these constructs
547 */
548struct acpi_control_state {
549 ACPI_STATE_COMMON u16 opcode;
550 union acpi_parse_object *predicate_op;
551 u8 *aml_predicate_start; /* Start of if/while predicate */
552 u8 *package_end; /* End of if/while block */
553 u32 loop_count; /* While() loop counter */
554};
555
556/*
557 * Scope state - current scope during namespace lookups
558 */
559struct acpi_scope_state {
560 ACPI_STATE_COMMON struct acpi_namespace_node *node;
561};
562
563struct acpi_pscope_state {
564 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
565 union acpi_parse_object *op; /* Current op being parsed */
566 u8 *arg_end; /* Current argument end */
567 u8 *pkg_end; /* Current package end */
568 u32 arg_list; /* Next argument to parse */
569};
570
571/*
572 * Thread state - one per thread across multiple walk states. Multiple walk
573 * states are created when there are nested control methods executing.
574 */
575struct acpi_thread_state {
576 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
577 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
578 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
579 acpi_thread_id thread_id; /* Running thread ID */
580};
581
582/*
583 * Result values - used to accumulate the results of nested
584 * AML arguments
585 */
586struct acpi_result_values {
587 ACPI_STATE_COMMON
588 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
589};
590
591typedef
592acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
593 union acpi_parse_object ** out_op);
594
595typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
596
597/*
598 * Notify info - used to pass info to the deferred notify
599 * handler/dispatcher.
600 */
601struct acpi_notify_info {
602 ACPI_STATE_COMMON struct acpi_namespace_node *node;
603 union acpi_operand_object *handler_obj;
604};
605
606/* Generic state is union of structs above */
607
608union acpi_generic_state {
609 struct acpi_common_state common;
610 struct acpi_control_state control;
611 struct acpi_update_state update;
612 struct acpi_scope_state scope;
613 struct acpi_pscope_state parse_scope;
614 struct acpi_pkg_state pkg;
615 struct acpi_thread_state thread;
616 struct acpi_result_values results;
617 struct acpi_notify_info notify;
618};
619
620/*****************************************************************************
621 *
622 * Interpreter typedefs and structs
623 *
624 ****************************************************************************/
625
626typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
627
628/*****************************************************************************
629 *
630 * Parser typedefs and structs
631 *
632 ****************************************************************************/
633
634/*
635 * AML opcode, name, and argument layout
636 */
637struct acpi_opcode_info {
638#if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
639 char *name; /* Opcode name (disassembler/debug only) */
640#endif
641 u32 parse_args; /* Grammar/Parse time arguments */
642 u32 runtime_args; /* Interpret time arguments */
643 u16 flags; /* Misc flags */
644 u8 object_type; /* Corresponding internal object type */
645 u8 class; /* Opcode class */
646 u8 type; /* Opcode type */
647};
648
649union acpi_parse_value {
650 u64 integer; /* Integer constant (Up to 64 bits) */
651 u32 size; /* bytelist or field size */
652 char *string; /* NULL terminated string */
653 u8 *buffer; /* buffer or string */
654 char *name; /* NULL terminated string */
655 union acpi_parse_object *arg; /* arguments and contained ops */
656};
657
658#ifdef ACPI_DISASSEMBLER
659#define ACPI_DISASM_ONLY_MEMBERS(a) a;
660#else
661#define ACPI_DISASM_ONLY_MEMBERS(a)
662#endif
663
664#define ACPI_PARSE_COMMON \
665 union acpi_parse_object *parent; /* Parent op */\
666 u8 descriptor_type; /* To differentiate various internal objs */\
667 u8 flags; /* Type of Op */\
668 u16 aml_opcode; /* AML opcode */\
669 u32 aml_offset; /* Offset of declaration in AML */\
670 union acpi_parse_object *next; /* Next op */\
671 struct acpi_namespace_node *node; /* For use by interpreter */\
672 union acpi_parse_value value; /* Value or args associated with the opcode */\
673 u8 arg_list_length; /* Number of elements in the arg list */\
674 ACPI_DISASM_ONLY_MEMBERS (\
675 u8 disasm_flags; /* Used during AML disassembly */\
676 u8 disasm_opcode; /* Subtype used for disassembly */\
677 char aml_op_name[16]) /* Op name (debug only) */
678
679#define ACPI_DASM_BUFFER 0x00
680#define ACPI_DASM_RESOURCE 0x01
681#define ACPI_DASM_STRING 0x02
682#define ACPI_DASM_UNICODE 0x03
683#define ACPI_DASM_EISAID 0x04
684#define ACPI_DASM_MATCHOP 0x05
685#define ACPI_DASM_LNOT_PREFIX 0x06
686#define ACPI_DASM_LNOT_SUFFIX 0x07
687#define ACPI_DASM_IGNORE 0x08
688
689/*
690 * Generic operation (for example: If, While, Store)
691 */
692struct acpi_parse_obj_common {
693ACPI_PARSE_COMMON};
694
695/*
696 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
697 * and bytelists.
698 */
699struct acpi_parse_obj_named {
700 ACPI_PARSE_COMMON u8 *path;
701 u8 *data; /* AML body or bytelist data */
702 u32 length; /* AML length */
703 u32 name; /* 4-byte name or zero if no name */
704};
705
706/* This version is used by the i_aSL compiler only */
707
708#define ACPI_MAX_PARSEOP_NAME 20
709
710struct acpi_parse_obj_asl {
711 ACPI_PARSE_COMMON union acpi_parse_object *child;
712 union acpi_parse_object *parent_method;
713 char *filename;
714 char *external_name;
715 char *namepath;
716 char name_seg[4];
717 u32 extra_value;
718 u32 column;
719 u32 line_number;
720 u32 logical_line_number;
721 u32 logical_byte_offset;
722 u32 end_line;
723 u32 end_logical_line;
724 u32 acpi_btype;
725 u32 aml_length;
726 u32 aml_subtree_length;
727 u32 final_aml_length;
728 u32 final_aml_offset;
729 u32 compile_flags;
730 u16 parse_opcode;
731 u8 aml_opcode_length;
732 u8 aml_pkg_len_bytes;
733 u8 extra;
734 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
735};
736
737union acpi_parse_object {
738 struct acpi_parse_obj_common common;
739 struct acpi_parse_obj_named named;
740 struct acpi_parse_obj_asl asl;
741};
742
743/*
744 * Parse state - one state per parser invocation and each control
745 * method.
746 */
747struct acpi_parse_state {
748 u8 *aml_start; /* First AML byte */
749 u8 *aml; /* Next AML byte */
750 u8 *aml_end; /* (last + 1) AML byte */
751 u8 *pkg_start; /* Current package begin */
752 u8 *pkg_end; /* Current package end */
753 union acpi_parse_object *start_op; /* Root of parse tree */
754 struct acpi_namespace_node *start_node;
755 union acpi_generic_state *scope; /* Current scope */
756 union acpi_parse_object *start_scope;
757 u32 aml_size;
758};
759
760/* Parse object flags */
761
762#define ACPI_PARSEOP_GENERIC 0x01
763#define ACPI_PARSEOP_NAMED 0x02
764#define ACPI_PARSEOP_DEFERRED 0x04
765#define ACPI_PARSEOP_BYTELIST 0x08
766#define ACPI_PARSEOP_IN_STACK 0x10
767#define ACPI_PARSEOP_TARGET 0x20
768#define ACPI_PARSEOP_IN_CACHE 0x80
769
770/* Parse object disasm_flags */
771
772#define ACPI_PARSEOP_IGNORE 0x01
773#define ACPI_PARSEOP_PARAMLIST 0x02
774#define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
775#define ACPI_PARSEOP_SPECIAL 0x10
776
777/*****************************************************************************
778 *
779 * Hardware (ACPI registers) and PNP
780 *
781 ****************************************************************************/
782
783struct acpi_bit_register_info {
784 u8 parent_register;
785 u8 bit_position;
786 u16 access_bit_mask;
787};
788
789/*
790 * Some ACPI registers have bits that must be ignored -- meaning that they
791 * must be preserved.
792 */
793#define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
794
795/* Write-only bits must be zeroed by software */
796
797#define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
798
799/* For control registers, both ignored and reserved bits must be preserved */
800
801/*
802 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
803 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
804 * bit position", section 4.7.3.2.1. However, on some machines the OS must
805 * write a one to this bit after resume for the machine to work properly.
806 * To enable this, we no longer attempt to preserve this bit. No machines
807 * are known to fail if the bit is not preserved. (May 2009)
808 */
809#define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
810#define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
811#define ACPI_PM1_CONTROL_PRESERVED_BITS \
812 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
813
814#define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
815
816/*
817 * Register IDs
818 * These are the full ACPI registers
819 */
820#define ACPI_REGISTER_PM1_STATUS 0x01
821#define ACPI_REGISTER_PM1_ENABLE 0x02
822#define ACPI_REGISTER_PM1_CONTROL 0x03
823#define ACPI_REGISTER_PM2_CONTROL 0x04
824#define ACPI_REGISTER_PM_TIMER 0x05
825#define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
826#define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
827
828/* Masks used to access the bit_registers */
829
830#define ACPI_BITMASK_TIMER_STATUS 0x0001
831#define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
832#define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
833#define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
834#define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
835#define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
836#define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
837#define ACPI_BITMASK_WAKE_STATUS 0x8000
838
839#define ACPI_BITMASK_ALL_FIXED_STATUS (\
840 ACPI_BITMASK_TIMER_STATUS | \
841 ACPI_BITMASK_BUS_MASTER_STATUS | \
842 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
843 ACPI_BITMASK_POWER_BUTTON_STATUS | \
844 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
845 ACPI_BITMASK_RT_CLOCK_STATUS | \
846 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
847 ACPI_BITMASK_WAKE_STATUS)
848
849#define ACPI_BITMASK_TIMER_ENABLE 0x0001
850#define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
851#define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
852#define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
853#define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
854#define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
855
856#define ACPI_BITMASK_SCI_ENABLE 0x0001
857#define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
858#define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
859#define ACPI_BITMASK_SLEEP_TYPE 0x1C00
860#define ACPI_BITMASK_SLEEP_ENABLE 0x2000
861
862#define ACPI_BITMASK_ARB_DISABLE 0x0001
863
864/* Raw bit position of each bit_register */
865
866#define ACPI_BITPOSITION_TIMER_STATUS 0x00
867#define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
868#define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
869#define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
870#define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
871#define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
872#define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
873#define ACPI_BITPOSITION_WAKE_STATUS 0x0F
874
875#define ACPI_BITPOSITION_TIMER_ENABLE 0x00
876#define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
877#define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
878#define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
879#define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
880#define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
881
882#define ACPI_BITPOSITION_SCI_ENABLE 0x00
883#define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
884#define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
885#define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
886#define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
887
888#define ACPI_BITPOSITION_ARB_DISABLE 0x00
889
890/* Structs and definitions for _OSI support and I/O port validation */
891
892#define ACPI_OSI_WIN_2000 0x01
893#define ACPI_OSI_WIN_XP 0x02
894#define ACPI_OSI_WIN_XP_SP1 0x03
895#define ACPI_OSI_WINSRV_2003 0x04
896#define ACPI_OSI_WIN_XP_SP2 0x05
897#define ACPI_OSI_WINSRV_2003_SP1 0x06
898#define ACPI_OSI_WIN_VISTA 0x07
899#define ACPI_OSI_WINSRV_2008 0x08
900#define ACPI_OSI_WIN_VISTA_SP1 0x09
901#define ACPI_OSI_WIN_VISTA_SP2 0x0A
902#define ACPI_OSI_WIN_7 0x0B
903
904#define ACPI_ALWAYS_ILLEGAL 0x00
905
906struct acpi_interface_info {
907 char *name;
908 struct acpi_interface_info *next;
909 u8 flags;
910 u8 value;
911};
912
913#define ACPI_OSI_INVALID 0x01
914#define ACPI_OSI_DYNAMIC 0x02
915
916struct acpi_port_info {
917 char *name;
918 u16 start;
919 u16 end;
920 u8 osi_dependency;
921};
922
923/*****************************************************************************
924 *
925 * Resource descriptors
926 *
927 ****************************************************************************/
928
929/* resource_type values */
930
931#define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
932#define ACPI_ADDRESS_TYPE_IO_RANGE 1
933#define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
934
935/* Resource descriptor types and masks */
936
937#define ACPI_RESOURCE_NAME_LARGE 0x80
938#define ACPI_RESOURCE_NAME_SMALL 0x00
939
940#define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
941#define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
942#define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
943
944/*
945 * Small resource descriptor "names" as defined by the ACPI specification.
946 * Note: Bits 2:0 are used for the descriptor length
947 */
948#define ACPI_RESOURCE_NAME_IRQ 0x20
949#define ACPI_RESOURCE_NAME_DMA 0x28
950#define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
951#define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
952#define ACPI_RESOURCE_NAME_IO 0x40
953#define ACPI_RESOURCE_NAME_FIXED_IO 0x48
954#define ACPI_RESOURCE_NAME_RESERVED_S1 0x50
955#define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
956#define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
957#define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
958#define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
959#define ACPI_RESOURCE_NAME_END_TAG 0x78
960
961/*
962 * Large resource descriptor "names" as defined by the ACPI specification.
963 * Note: includes the Large Descriptor bit in bit[7]
964 */
965#define ACPI_RESOURCE_NAME_MEMORY24 0x81
966#define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
967#define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
968#define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
969#define ACPI_RESOURCE_NAME_MEMORY32 0x85
970#define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
971#define ACPI_RESOURCE_NAME_ADDRESS32 0x87
972#define ACPI_RESOURCE_NAME_ADDRESS16 0x88
973#define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
974#define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
975#define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
976#define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B
977
978/*****************************************************************************
979 *
980 * Miscellaneous
981 *
982 ****************************************************************************/
983
984#define ACPI_ASCII_ZERO 0x30
985
986/*****************************************************************************
987 *
988 * Debugger
989 *
990 ****************************************************************************/
991
992struct acpi_db_method_info {
993 acpi_handle main_thread_gate;
994 acpi_handle thread_complete_gate;
995 acpi_thread_id *threads;
996 u32 num_threads;
997 u32 num_created;
998 u32 num_completed;
999
1000 char *name;
1001 u32 flags;
1002 u32 num_loops;
1003 char pathname[128];
1004 char **args;
1005
1006 /*
1007 * Arguments to be passed to method for the command
1008 * Threads -
1009 * the Number of threads, ID of current thread and
1010 * Index of current thread inside all them created.
1011 */
1012 char init_args;
1013 char *arguments[4];
1014 char num_threads_str[11];
1015 char id_of_thread_str[11];
1016 char index_of_thread_str[11];
1017};
1018
1019struct acpi_integrity_info {
1020 u32 nodes;
1021 u32 objects;
1022};
1023
1024#define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1025#define ACPI_DB_CONSOLE_OUTPUT 0x02
1026#define ACPI_DB_DUPLICATE_OUTPUT 0x03
1027
1028/*****************************************************************************
1029 *
1030 * Debug
1031 *
1032 ****************************************************************************/
1033
1034/* Entry for a memory allocation (debug only) */
1035
1036#define ACPI_MEM_MALLOC 0
1037#define ACPI_MEM_CALLOC 1
1038#define ACPI_MAX_MODULE_NAME 16
1039
1040#define ACPI_COMMON_DEBUG_MEM_HEADER \
1041 struct acpi_debug_mem_block *previous; \
1042 struct acpi_debug_mem_block *next; \
1043 u32 size; \
1044 u32 component; \
1045 u32 line; \
1046 char module[ACPI_MAX_MODULE_NAME]; \
1047 u8 alloc_type;
1048
1049struct acpi_debug_mem_header {
1050ACPI_COMMON_DEBUG_MEM_HEADER};
1051
1052struct acpi_debug_mem_block {
1053 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1054};
1055
1056#define ACPI_MEM_LIST_GLOBAL 0
1057#define ACPI_MEM_LIST_NSNODE 1
1058#define ACPI_MEM_LIST_MAX 1
1059#define ACPI_NUM_MEM_LISTS 2
1060
1061#endif /* __ACLOCAL_H__ */
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: aclocal.h - Internal data types used across the ACPI subsystem
5 *
6 * Copyright (C) 2000 - 2019, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef __ACLOCAL_H__
11#define __ACLOCAL_H__
12
13/* acpisrc:struct_defs -- for acpisrc conversion */
14
15#define ACPI_SERIALIZED 0xFF
16
17typedef u32 acpi_mutex_handle;
18#define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1)
19
20/* Total number of aml opcodes defined */
21
22#define AML_NUM_OPCODES 0x83
23
24/* Forward declarations */
25
26struct acpi_walk_state;
27struct acpi_obj_mutex;
28union acpi_parse_object;
29
30/*****************************************************************************
31 *
32 * Mutex typedefs and structs
33 *
34 ****************************************************************************/
35
36/*
37 * Predefined handles for the mutex objects used within the subsystem
38 * All mutex objects are automatically created by acpi_ut_mutex_initialize.
39 *
40 * The acquire/release ordering protocol is implied via this list. Mutexes
41 * with a lower value must be acquired before mutexes with a higher value.
42 *
43 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
44 * table below also!
45 */
46#define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
47#define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */
48#define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
49#define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
50#define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
51#define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
52
53#define ACPI_MAX_MUTEX 5
54#define ACPI_NUM_MUTEX (ACPI_MAX_MUTEX+1)
55
56/* Lock structure for reader/writer interfaces */
57
58struct acpi_rw_lock {
59 acpi_mutex writer_mutex;
60 acpi_mutex reader_mutex;
61 u32 num_readers;
62};
63
64/*
65 * Predefined handles for spinlocks used within the subsystem.
66 * These spinlocks are created by acpi_ut_mutex_initialize
67 */
68#define ACPI_LOCK_GPES 0
69#define ACPI_LOCK_HARDWARE 1
70
71#define ACPI_MAX_LOCK 1
72#define ACPI_NUM_LOCK (ACPI_MAX_LOCK+1)
73
74/* This Thread ID means that the mutex is not in use (unlocked) */
75
76#define ACPI_MUTEX_NOT_ACQUIRED ((acpi_thread_id) 0)
77
78/* This Thread ID means an invalid thread ID */
79
80#ifdef ACPI_OS_INVALID_THREAD_ID
81#define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID
82#else
83#define ACPI_INVALID_THREAD_ID ((acpi_thread_id) 0xFFFFFFFF)
84#endif
85
86/* Table for the global mutexes */
87
88struct acpi_mutex_info {
89 acpi_mutex mutex;
90 u32 use_count;
91 acpi_thread_id thread_id;
92};
93
94/* Lock flag parameter for various interfaces */
95
96#define ACPI_MTX_DO_NOT_LOCK 0
97#define ACPI_MTX_LOCK 1
98
99/* Field access granularities */
100
101#define ACPI_FIELD_BYTE_GRANULARITY 1
102#define ACPI_FIELD_WORD_GRANULARITY 2
103#define ACPI_FIELD_DWORD_GRANULARITY 4
104#define ACPI_FIELD_QWORD_GRANULARITY 8
105
106#define ACPI_ENTRY_NOT_FOUND NULL
107
108/*****************************************************************************
109 *
110 * Namespace typedefs and structs
111 *
112 ****************************************************************************/
113
114/* Operational modes of the AML interpreter/scanner */
115
116typedef enum {
117 ACPI_IMODE_LOAD_PASS1 = 0x01,
118 ACPI_IMODE_LOAD_PASS2 = 0x02,
119 ACPI_IMODE_EXECUTE = 0x03
120} acpi_interpreter_mode;
121
122/*
123 * The Namespace Node describes a named object that appears in the AML.
124 * descriptor_type is used to differentiate between internal descriptors.
125 *
126 * The node is optimized for both 32-bit and 64-bit platforms:
127 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
128 *
129 * Note: The descriptor_type and Type fields must appear in the identical
130 * position in both the struct acpi_namespace_node and union acpi_operand_object
131 * structures.
132 */
133struct acpi_namespace_node {
134 union acpi_operand_object *object; /* Interpreter object */
135 u8 descriptor_type; /* Differentiate object descriptor types */
136 u8 type; /* ACPI Type associated with this name */
137 u16 flags; /* Miscellaneous flags */
138 union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */
139 struct acpi_namespace_node *parent; /* Parent node */
140 struct acpi_namespace_node *child; /* First child */
141 struct acpi_namespace_node *peer; /* First peer */
142 acpi_owner_id owner_id; /* Node creator */
143
144 /*
145 * The following fields are used by the ASL compiler and disassembler only
146 */
147#ifdef ACPI_LARGE_NAMESPACE_NODE
148 union acpi_parse_object *op;
149 void *method_locals;
150 void *method_args;
151 u32 value;
152 u32 length;
153 u8 arg_count;
154
155#endif
156};
157
158/* Namespace Node flags */
159
160#define ANOBJ_RESERVED 0x01 /* Available for use */
161#define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
162#define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
163#define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
164#define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
165#define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
166#define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */
167#define ANOBJ_NODE_EARLY_INIT 0x80 /* acpi_exec only: Node was create via init file (-fi) */
168
169#define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
170#define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
171#define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
172#define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
173
174/* Internal ACPI table management - master table list */
175
176struct acpi_table_list {
177 struct acpi_table_desc *tables; /* Table descriptor array */
178 u32 current_table_count; /* Tables currently in the array */
179 u32 max_table_count; /* Max tables array will hold */
180 u8 flags;
181};
182
183/* Flags for above */
184
185#define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
186#define ACPI_ROOT_ORIGIN_ALLOCATED (1)
187#define ACPI_ROOT_ALLOW_RESIZE (2)
188
189/* List to manage incoming ACPI tables */
190
191struct acpi_new_table_desc {
192 struct acpi_table_header *table;
193 struct acpi_new_table_desc *next;
194};
195
196/* Predefined table indexes */
197
198#define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF)
199
200struct acpi_find_context {
201 char *search_for;
202 acpi_handle *list;
203 u32 *count;
204};
205
206struct acpi_ns_search_data {
207 struct acpi_namespace_node *node;
208};
209
210/* Object types used during package copies */
211
212#define ACPI_COPY_TYPE_SIMPLE 0
213#define ACPI_COPY_TYPE_PACKAGE 1
214
215/* Info structure used to convert external<->internal namestrings */
216
217struct acpi_namestring_info {
218 const char *external_name;
219 const char *next_external_char;
220 char *internal_name;
221 u32 length;
222 u32 num_segments;
223 u32 num_carats;
224 u8 fully_qualified;
225};
226
227/* Field creation info */
228
229struct acpi_create_field_info {
230 struct acpi_namespace_node *region_node;
231 struct acpi_namespace_node *field_node;
232 struct acpi_namespace_node *register_node;
233 struct acpi_namespace_node *data_register_node;
234 struct acpi_namespace_node *connection_node;
235 u8 *resource_buffer;
236 u32 bank_value;
237 u32 field_bit_position;
238 u32 field_bit_length;
239 u16 resource_length;
240 u16 pin_number_index;
241 u8 field_flags;
242 u8 attribute;
243 u8 field_type;
244 u8 access_length;
245};
246
247typedef
248acpi_status (*acpi_internal_method) (struct acpi_walk_state * walk_state);
249
250/*
251 * Bitmapped ACPI types. Used internally only
252 */
253#define ACPI_BTYPE_ANY 0x00000000
254#define ACPI_BTYPE_INTEGER 0x00000001
255#define ACPI_BTYPE_STRING 0x00000002
256#define ACPI_BTYPE_BUFFER 0x00000004
257#define ACPI_BTYPE_PACKAGE 0x00000008
258#define ACPI_BTYPE_FIELD_UNIT 0x00000010
259#define ACPI_BTYPE_DEVICE 0x00000020
260#define ACPI_BTYPE_EVENT 0x00000040
261#define ACPI_BTYPE_METHOD 0x00000080
262#define ACPI_BTYPE_MUTEX 0x00000100
263#define ACPI_BTYPE_REGION 0x00000200
264#define ACPI_BTYPE_POWER 0x00000400
265#define ACPI_BTYPE_PROCESSOR 0x00000800
266#define ACPI_BTYPE_THERMAL 0x00001000
267#define ACPI_BTYPE_BUFFER_FIELD 0x00002000
268#define ACPI_BTYPE_DDB_HANDLE 0x00004000
269#define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
270#define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), ref_of(), etc (type6_opcodes) */
271#define ACPI_BTYPE_RESOURCE 0x00020000
272#define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */
273
274#define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
275
276#define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
277
278 /* Used by Copy, de_ref_of, Store, Printf, Fprintf */
279
280#define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE)
281#define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
282#define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
283#define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
284
285#pragma pack(1)
286
287/*
288 * Information structure for ACPI predefined names.
289 * Each entry in the table contains the following items:
290 *
291 * name - The ACPI reserved name
292 * param_count - Number of arguments to the method
293 * expected_return_btypes - Allowed type(s) for the return value
294 */
295struct acpi_name_info {
296 char name[ACPI_NAMESEG_SIZE];
297 u16 argument_list;
298 u8 expected_btypes;
299};
300
301/*
302 * Secondary information structures for ACPI predefined objects that return
303 * package objects. This structure appears as the next entry in the table
304 * after the NAME_INFO structure above.
305 *
306 * The reason for this is to minimize the size of the predefined name table.
307 */
308
309/*
310 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
311 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
312 * ACPI_PTYPE2_FIX_VAR
313 */
314struct acpi_package_info {
315 u8 type;
316 u8 object_type1;
317 u8 count1;
318 u8 object_type2;
319 u8 count2;
320 u16 reserved;
321};
322
323/* Used for ACPI_PTYPE2_FIXED */
324
325struct acpi_package_info2 {
326 u8 type;
327 u8 count;
328 u8 object_type[4];
329 u8 reserved;
330};
331
332/* Used for ACPI_PTYPE1_OPTION */
333
334struct acpi_package_info3 {
335 u8 type;
336 u8 count;
337 u8 object_type[2];
338 u8 tail_object_type;
339 u16 reserved;
340};
341
342struct acpi_package_info4 {
343 u8 type;
344 u8 object_type1;
345 u8 count1;
346 u8 sub_object_types;
347 u8 pkg_count;
348 u16 reserved;
349};
350
351union acpi_predefined_info {
352 struct acpi_name_info info;
353 struct acpi_package_info ret_info;
354 struct acpi_package_info2 ret_info2;
355 struct acpi_package_info3 ret_info3;
356 struct acpi_package_info4 ret_info4;
357};
358
359/* Reset to default packing */
360
361#pragma pack()
362
363/* Return object auto-repair info */
364
365typedef acpi_status (*acpi_object_converter) (struct acpi_namespace_node *
366 scope,
367 union acpi_operand_object *
368 original_object,
369 union acpi_operand_object **
370 converted_object);
371
372struct acpi_simple_repair_info {
373 char name[ACPI_NAMESEG_SIZE];
374 u32 unexpected_btypes;
375 u32 package_index;
376 acpi_object_converter object_converter;
377};
378
379/*
380 * Bitmapped return value types
381 * Note: the actual data types must be contiguous, a loop in nspredef.c
382 * depends on this.
383 */
384#define ACPI_RTYPE_ANY 0x00
385#define ACPI_RTYPE_NONE 0x01
386#define ACPI_RTYPE_INTEGER 0x02
387#define ACPI_RTYPE_STRING 0x04
388#define ACPI_RTYPE_BUFFER 0x08
389#define ACPI_RTYPE_PACKAGE 0x10
390#define ACPI_RTYPE_REFERENCE 0x20
391#define ACPI_RTYPE_ALL 0x3F
392
393#define ACPI_NUM_RTYPES 5 /* Number of actual object types */
394
395/* Info for running the _REG methods */
396
397struct acpi_reg_walk_info {
398 u32 function;
399 u32 reg_run_count;
400 acpi_adr_space_type space_id;
401};
402
403/*****************************************************************************
404 *
405 * Event typedefs and structs
406 *
407 ****************************************************************************/
408
409/* Dispatch info for each host-installed SCI handler */
410
411struct acpi_sci_handler_info {
412 struct acpi_sci_handler_info *next;
413 acpi_sci_handler address; /* Address of handler */
414 void *context; /* Context to be passed to handler */
415};
416
417/* Dispatch info for each GPE -- either a method or handler, cannot be both */
418
419struct acpi_gpe_handler_info {
420 acpi_gpe_handler address; /* Address of handler, if any */
421 void *context; /* Context to be passed to handler */
422 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
423 u8 original_flags; /* Original (pre-handler) GPE info */
424 u8 originally_enabled; /* True if GPE was originally enabled */
425};
426
427/* Notify info for implicit notify, multiple device objects */
428
429struct acpi_gpe_notify_info {
430 struct acpi_namespace_node *device_node; /* Device to be notified */
431 struct acpi_gpe_notify_info *next;
432};
433
434/*
435 * GPE dispatch info. At any time, the GPE can have at most one type
436 * of dispatch - Method, Handler, or Implicit Notify.
437 */
438union acpi_gpe_dispatch_info {
439 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
440 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */
441 struct acpi_gpe_notify_info *notify_list; /* List of _PRW devices for implicit notifies */
442};
443
444/*
445 * Information about a GPE, one per each GPE in an array.
446 * NOTE: Important to keep this struct as small as possible.
447 */
448struct acpi_gpe_event_info {
449 union acpi_gpe_dispatch_info dispatch; /* Either Method, Handler, or notify_list */
450 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
451 u8 flags; /* Misc info about this GPE */
452 u8 gpe_number; /* This GPE */
453 u8 runtime_count; /* References to a run GPE */
454 u8 disable_for_dispatch; /* Masked during dispatching */
455};
456
457/* Information about a GPE register pair, one per each status/enable pair in an array */
458
459struct acpi_gpe_register_info {
460 struct acpi_generic_address status_address; /* Address of status reg */
461 struct acpi_generic_address enable_address; /* Address of enable reg */
462 u16 base_gpe_number; /* Base GPE number for this register */
463 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
464 u8 enable_for_run; /* GPEs to keep enabled when running */
465 u8 mask_for_run; /* GPEs to keep masked when running */
466 u8 enable_mask; /* Current mask of enabled GPEs */
467};
468
469/*
470 * Information about a GPE register block, one per each installed block --
471 * GPE0, GPE1, and one per each installed GPE Block Device.
472 */
473struct acpi_gpe_block_info {
474 struct acpi_namespace_node *node;
475 struct acpi_gpe_block_info *previous;
476 struct acpi_gpe_block_info *next;
477 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
478 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
479 struct acpi_gpe_event_info *event_info; /* One for each GPE */
480 u64 address; /* Base address of the block */
481 u32 register_count; /* Number of register pairs in block */
482 u16 gpe_count; /* Number of individual GPEs in block */
483 u16 block_base_number; /* Base GPE number for this block */
484 u8 space_id;
485 u8 initialized; /* TRUE if this block is initialized */
486};
487
488/* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
489
490struct acpi_gpe_xrupt_info {
491 struct acpi_gpe_xrupt_info *previous;
492 struct acpi_gpe_xrupt_info *next;
493 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
494 u32 interrupt_number; /* System interrupt number */
495};
496
497struct acpi_gpe_walk_info {
498 struct acpi_namespace_node *gpe_device;
499 struct acpi_gpe_block_info *gpe_block;
500 u16 count;
501 acpi_owner_id owner_id;
502 u8 execute_by_owner_id;
503};
504
505struct acpi_gpe_device_info {
506 u32 index;
507 u32 next_block_base_index;
508 acpi_status status;
509 struct acpi_namespace_node *gpe_device;
510};
511
512typedef acpi_status (*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
513 gpe_xrupt_info,
514 struct acpi_gpe_block_info *
515 gpe_block, void *context);
516
517/* Information about each particular fixed event */
518
519struct acpi_fixed_event_handler {
520 acpi_event_handler handler; /* Address of handler. */
521 void *context; /* Context to be passed to handler */
522};
523
524struct acpi_fixed_event_info {
525 u8 status_register_id;
526 u8 enable_register_id;
527 u16 status_bit_mask;
528 u16 enable_bit_mask;
529};
530
531/* Information used during field processing */
532
533struct acpi_field_info {
534 u8 skip_field;
535 u8 field_flag;
536 u32 pkg_length;
537};
538
539/*****************************************************************************
540 *
541 * Generic "state" object for stacks
542 *
543 ****************************************************************************/
544
545#define ACPI_CONTROL_NORMAL 0xC0
546#define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
547#define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
548#define ACPI_CONTROL_PREDICATE_FALSE 0xC3
549#define ACPI_CONTROL_PREDICATE_TRUE 0xC4
550
551#define ACPI_STATE_COMMON \
552 void *next; \
553 u8 descriptor_type; /* To differentiate various internal objs */\
554 u8 flags; \
555 u16 value; \
556 u16 state;
557
558 /* There are 2 bytes available here until the next natural alignment boundary */
559
560struct acpi_common_state {
561ACPI_STATE_COMMON};
562
563/*
564 * Update state - used to traverse complex objects such as packages
565 */
566struct acpi_update_state {
567 ACPI_STATE_COMMON union acpi_operand_object *object;
568};
569
570/*
571 * Pkg state - used to traverse nested package structures
572 */
573struct acpi_pkg_state {
574 ACPI_STATE_COMMON u32 index;
575 union acpi_operand_object *source_object;
576 union acpi_operand_object *dest_object;
577 struct acpi_walk_state *walk_state;
578 void *this_target_obj;
579 u32 num_packages;
580};
581
582/*
583 * Control state - one per if/else and while constructs.
584 * Allows nesting of these constructs
585 */
586struct acpi_control_state {
587 ACPI_STATE_COMMON u16 opcode;
588 union acpi_parse_object *predicate_op;
589 u8 *aml_predicate_start; /* Start of if/while predicate */
590 u8 *package_end; /* End of if/while block */
591 u64 loop_timeout; /* While() loop timeout */
592};
593
594/*
595 * Scope state - current scope during namespace lookups
596 */
597struct acpi_scope_state {
598 ACPI_STATE_COMMON struct acpi_namespace_node *node;
599};
600
601struct acpi_pscope_state {
602 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */
603 union acpi_parse_object *op; /* Current op being parsed */
604 u8 *arg_end; /* Current argument end */
605 u8 *pkg_end; /* Current package end */
606 u32 arg_list; /* Next argument to parse */
607};
608
609/*
610 * Thread state - one per thread across multiple walk states. Multiple walk
611 * states are created when there are nested control methods executing.
612 */
613struct acpi_thread_state {
614 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */
615 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
616 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
617 acpi_thread_id thread_id; /* Running thread ID */
618};
619
620/*
621 * Result values - used to accumulate the results of nested
622 * AML arguments
623 */
624struct acpi_result_values {
625 ACPI_STATE_COMMON
626 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
627};
628
629typedef
630acpi_status (*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
631 union acpi_parse_object ** out_op);
632
633typedef
634acpi_status (*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
635
636/* Global handlers for AML Notifies */
637
638struct acpi_global_notify_handler {
639 acpi_notify_handler handler;
640 void *context;
641};
642
643/*
644 * Notify info - used to pass info to the deferred notify
645 * handler/dispatcher.
646 */
647struct acpi_notify_info {
648 ACPI_STATE_COMMON u8 handler_list_id;
649 struct acpi_namespace_node *node;
650 union acpi_operand_object *handler_list_head;
651 struct acpi_global_notify_handler *global;
652};
653
654/* Generic state is union of structs above */
655
656union acpi_generic_state {
657 struct acpi_common_state common;
658 struct acpi_control_state control;
659 struct acpi_update_state update;
660 struct acpi_scope_state scope;
661 struct acpi_pscope_state parse_scope;
662 struct acpi_pkg_state pkg;
663 struct acpi_thread_state thread;
664 struct acpi_result_values results;
665 struct acpi_notify_info notify;
666};
667
668/*****************************************************************************
669 *
670 * Interpreter typedefs and structs
671 *
672 ****************************************************************************/
673
674typedef
675acpi_status (*acpi_execute_op) (struct acpi_walk_state * walk_state);
676
677/* Address Range info block */
678
679struct acpi_address_range {
680 struct acpi_address_range *next;
681 struct acpi_namespace_node *region_node;
682 acpi_physical_address start_address;
683 acpi_physical_address end_address;
684};
685
686/*****************************************************************************
687 *
688 * Parser typedefs and structs
689 *
690 ****************************************************************************/
691
692/*
693 * AML opcode, name, and argument layout
694 */
695struct acpi_opcode_info {
696#if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
697 char *name; /* Opcode name (disassembler/debug only) */
698#endif
699 u32 parse_args; /* Grammar/Parse time arguments */
700 u32 runtime_args; /* Interpret time arguments */
701 u16 flags; /* Misc flags */
702 u8 object_type; /* Corresponding internal object type */
703 u8 class; /* Opcode class */
704 u8 type; /* Opcode type */
705};
706
707/* Value associated with the parse object */
708
709union acpi_parse_value {
710 u64 integer; /* Integer constant (Up to 64 bits) */
711 u32 size; /* bytelist or field size */
712 char *string; /* NULL terminated string */
713 u8 *buffer; /* buffer or string */
714 char *name; /* NULL terminated string */
715 union acpi_parse_object *arg; /* arguments and contained ops */
716};
717
718#if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
719#define ACPI_DISASM_ONLY_MEMBERS(a) a;
720#else
721#define ACPI_DISASM_ONLY_MEMBERS(a)
722#endif
723
724#if defined(ACPI_ASL_COMPILER)
725#define ACPI_CONVERTER_ONLY_MEMBERS(a) a;
726#else
727#define ACPI_CONVERTER_ONLY_MEMBERS(a)
728#endif
729
730#define ACPI_PARSE_COMMON \
731 union acpi_parse_object *parent; /* Parent op */\
732 u8 descriptor_type; /* To differentiate various internal objs */\
733 u8 flags; /* Type of Op */\
734 u16 aml_opcode; /* AML opcode */\
735 u8 *aml; /* Address of declaration in AML */\
736 union acpi_parse_object *next; /* Next op */\
737 struct acpi_namespace_node *node; /* For use by interpreter */\
738 union acpi_parse_value value; /* Value or args associated with the opcode */\
739 u8 arg_list_length; /* Number of elements in the arg list */\
740 ACPI_DISASM_ONLY_MEMBERS (\
741 u16 disasm_flags; /* Used during AML disassembly */\
742 u8 disasm_opcode; /* Subtype used for disassembly */\
743 char *operator_symbol; /* Used for C-style operator name strings */\
744 char aml_op_name[16]) /* Op name (debug only) */\
745 ACPI_CONVERTER_ONLY_MEMBERS (\
746 char *inline_comment; /* Inline comment */\
747 char *end_node_comment; /* End of node comment */\
748 char *name_comment; /* Comment associated with the first parameter of the name node */\
749 char *close_brace_comment; /* Comments that come after } on the same as } */\
750 struct acpi_comment_node *comment_list; /* comments that appears before this node */\
751 struct acpi_comment_node *end_blk_comment; /* comments that at the end of a block but before ) or } */\
752 char *cv_filename; /* Filename associated with this node. Used for ASL/ASL+ converter */\
753 char *cv_parent_filename) /* Parent filename associated with this node. Used for ASL/ASL+ converter */
754
755/* categories of comments */
756
757typedef enum {
758 STANDARD_COMMENT = 1,
759 INLINE_COMMENT,
760 ENDNODE_COMMENT,
761 OPENBRACE_COMMENT,
762 CLOSE_BRACE_COMMENT,
763 STD_DEFBLK_COMMENT,
764 END_DEFBLK_COMMENT,
765 FILENAME_COMMENT,
766 PARENTFILENAME_COMMENT,
767 ENDBLK_COMMENT,
768 INCLUDE_COMMENT
769} asl_comment_types;
770
771/* Internal opcodes for disasm_opcode field above */
772
773#define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
774#define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
775#define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
776#define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
777#define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
778#define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
779#define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
780#define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
781#define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */
782#define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */
783#define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
784#define ACPI_DASM_IGNORE_SINGLE 0x0B /* Ignore the opcode but not it's children */
785#define ACPI_DASM_SWITCH 0x0C /* While is a Switch */
786#define ACPI_DASM_SWITCH_PREDICATE 0x0D /* Object is a predicate for a Switch or Case block */
787#define ACPI_DASM_CASE 0x0E /* If/Else is a Case in a Switch/Case block */
788#define ACPI_DASM_DEFAULT 0x0F /* Else is a Default in a Switch/Case block */
789
790/*
791 * List struct used in the -ca option
792 */
793struct acpi_comment_node {
794 char *comment;
795 struct acpi_comment_node *next;
796};
797
798struct acpi_comment_addr_node {
799 u8 *addr;
800 struct acpi_comment_addr_node *next;
801};
802
803/*
804 * File node - used for "Include" operator file stack and
805 * dependency tree for the -ca option
806 */
807struct acpi_file_node {
808 void *file;
809 char *filename;
810 char *file_start; /* Points to AML and indicates when the AML for this particular file starts. */
811 char *file_end; /* Points to AML and indicates when the AML for this particular file ends. */
812 struct acpi_file_node *next;
813 struct acpi_file_node *parent;
814 u8 include_written;
815 struct acpi_comment_node *include_comment;
816};
817
818/*
819 * Generic operation (for example: If, While, Store)
820 */
821struct acpi_parse_obj_common {
822ACPI_PARSE_COMMON};
823
824/*
825 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
826 * and bytelists.
827 */
828struct acpi_parse_obj_named {
829 ACPI_PARSE_COMMON char *path;
830 u8 *data; /* AML body or bytelist data */
831 u32 length; /* AML length */
832 u32 name; /* 4-byte name or zero if no name */
833};
834
835/* This version is used by the iASL compiler only */
836
837#define ACPI_MAX_PARSEOP_NAME 20
838
839struct acpi_parse_obj_asl {
840 ACPI_PARSE_COMMON union acpi_parse_object *child;
841 union acpi_parse_object *parent_method;
842 char *filename;
843 u8 file_changed;
844 char *parent_filename;
845 char *external_name;
846 char *namepath;
847 char name_seg[4];
848 u32 extra_value;
849 u32 column;
850 u32 line_number;
851 u32 logical_line_number;
852 u32 logical_byte_offset;
853 u32 end_line;
854 u32 end_logical_line;
855 u32 acpi_btype;
856 u32 aml_length;
857 u32 aml_subtree_length;
858 u32 final_aml_length;
859 u32 final_aml_offset;
860 u32 compile_flags;
861 u16 parse_opcode;
862 u8 aml_opcode_length;
863 u8 aml_pkg_len_bytes;
864 u8 extra;
865 char parse_op_name[ACPI_MAX_PARSEOP_NAME];
866};
867
868union acpi_parse_object {
869 struct acpi_parse_obj_common common;
870 struct acpi_parse_obj_named named;
871 struct acpi_parse_obj_asl asl;
872};
873
874struct asl_comment_state {
875 u8 comment_type;
876 u32 spaces_before;
877 union acpi_parse_object *latest_parse_op;
878 union acpi_parse_object *parsing_paren_brace_node;
879 u8 capture_comments;
880};
881
882/*
883 * Parse state - one state per parser invocation and each control
884 * method.
885 */
886struct acpi_parse_state {
887 u8 *aml_start; /* First AML byte */
888 u8 *aml; /* Next AML byte */
889 u8 *aml_end; /* (last + 1) AML byte */
890 u8 *pkg_start; /* Current package begin */
891 u8 *pkg_end; /* Current package end */
892 union acpi_parse_object *start_op; /* Root of parse tree */
893 struct acpi_namespace_node *start_node;
894 union acpi_generic_state *scope; /* Current scope */
895 union acpi_parse_object *start_scope;
896 u32 aml_size;
897};
898
899/* Parse object flags */
900
901#define ACPI_PARSEOP_GENERIC 0x01
902#define ACPI_PARSEOP_NAMED_OBJECT 0x02
903#define ACPI_PARSEOP_DEFERRED 0x04
904#define ACPI_PARSEOP_BYTELIST 0x08
905#define ACPI_PARSEOP_IN_STACK 0x10
906#define ACPI_PARSEOP_TARGET 0x20
907#define ACPI_PARSEOP_IN_CACHE 0x80
908
909/* Parse object disasm_flags */
910
911#define ACPI_PARSEOP_IGNORE 0x0001
912#define ACPI_PARSEOP_PARAMETER_LIST 0x0002
913#define ACPI_PARSEOP_EMPTY_TERMLIST 0x0004
914#define ACPI_PARSEOP_PREDEFINED_CHECKED 0x0008
915#define ACPI_PARSEOP_CLOSING_PAREN 0x0010
916#define ACPI_PARSEOP_COMPOUND_ASSIGNMENT 0x0020
917#define ACPI_PARSEOP_ASSIGNMENT 0x0040
918#define ACPI_PARSEOP_ELSEIF 0x0080
919#define ACPI_PARSEOP_LEGACY_ASL_ONLY 0x0100
920
921/*****************************************************************************
922 *
923 * Hardware (ACPI registers) and PNP
924 *
925 ****************************************************************************/
926
927struct acpi_bit_register_info {
928 u8 parent_register;
929 u8 bit_position;
930 u16 access_bit_mask;
931};
932
933/*
934 * Some ACPI registers have bits that must be ignored -- meaning that they
935 * must be preserved.
936 */
937#define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
938
939/* Write-only bits must be zeroed by software */
940
941#define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
942
943/* For control registers, both ignored and reserved bits must be preserved */
944
945/*
946 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
947 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
948 * bit position", section 4.7.3.2.1. However, on some machines the OS must
949 * write a one to this bit after resume for the machine to work properly.
950 * To enable this, we no longer attempt to preserve this bit. No machines
951 * are known to fail if the bit is not preserved. (May 2009)
952 */
953#define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
954#define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
955#define ACPI_PM1_CONTROL_PRESERVED_BITS \
956 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
957
958#define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
959
960/*
961 * Register IDs
962 * These are the full ACPI registers
963 */
964#define ACPI_REGISTER_PM1_STATUS 0x01
965#define ACPI_REGISTER_PM1_ENABLE 0x02
966#define ACPI_REGISTER_PM1_CONTROL 0x03
967#define ACPI_REGISTER_PM2_CONTROL 0x04
968#define ACPI_REGISTER_PM_TIMER 0x05
969#define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
970#define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
971
972/* Masks used to access the bit_registers */
973
974#define ACPI_BITMASK_TIMER_STATUS 0x0001
975#define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
976#define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
977#define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
978#define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
979#define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
980#define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
981#define ACPI_BITMASK_WAKE_STATUS 0x8000
982
983#define ACPI_BITMASK_ALL_FIXED_STATUS (\
984 ACPI_BITMASK_TIMER_STATUS | \
985 ACPI_BITMASK_BUS_MASTER_STATUS | \
986 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
987 ACPI_BITMASK_POWER_BUTTON_STATUS | \
988 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
989 ACPI_BITMASK_RT_CLOCK_STATUS | \
990 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
991 ACPI_BITMASK_WAKE_STATUS)
992
993#define ACPI_BITMASK_TIMER_ENABLE 0x0001
994#define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
995#define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
996#define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
997#define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
998#define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
999
1000#define ACPI_BITMASK_SCI_ENABLE 0x0001
1001#define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
1002#define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
1003#define ACPI_BITMASK_SLEEP_TYPE 0x1C00
1004#define ACPI_BITMASK_SLEEP_ENABLE 0x2000
1005
1006#define ACPI_BITMASK_ARB_DISABLE 0x0001
1007
1008/* Raw bit position of each bit_register */
1009
1010#define ACPI_BITPOSITION_TIMER_STATUS 0x00
1011#define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
1012#define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
1013#define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
1014#define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
1015#define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
1016#define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
1017#define ACPI_BITPOSITION_WAKE_STATUS 0x0F
1018
1019#define ACPI_BITPOSITION_TIMER_ENABLE 0x00
1020#define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
1021#define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
1022#define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
1023#define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
1024#define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
1025
1026#define ACPI_BITPOSITION_SCI_ENABLE 0x00
1027#define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
1028#define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
1029#define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
1030#define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
1031
1032#define ACPI_BITPOSITION_ARB_DISABLE 0x00
1033
1034/* Structs and definitions for _OSI support and I/O port validation */
1035
1036#define ACPI_ALWAYS_ILLEGAL 0x00
1037
1038struct acpi_interface_info {
1039 char *name;
1040 struct acpi_interface_info *next;
1041 u8 flags;
1042 u8 value;
1043};
1044
1045#define ACPI_OSI_INVALID 0x01
1046#define ACPI_OSI_DYNAMIC 0x02
1047#define ACPI_OSI_FEATURE 0x04
1048#define ACPI_OSI_DEFAULT_INVALID 0x08
1049#define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1050
1051struct acpi_port_info {
1052 char *name;
1053 u16 start;
1054 u16 end;
1055 u8 osi_dependency;
1056};
1057
1058/*****************************************************************************
1059 *
1060 * Resource descriptors
1061 *
1062 ****************************************************************************/
1063
1064/* resource_type values */
1065
1066#define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1067#define ACPI_ADDRESS_TYPE_IO_RANGE 1
1068#define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1069
1070/* Resource descriptor types and masks */
1071
1072#define ACPI_RESOURCE_NAME_LARGE 0x80
1073#define ACPI_RESOURCE_NAME_SMALL 0x00
1074
1075#define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1076#define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1077#define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1078
1079/*
1080 * Small resource descriptor "names" as defined by the ACPI specification.
1081 * Note: Bits 2:0 are used for the descriptor length
1082 */
1083#define ACPI_RESOURCE_NAME_IRQ 0x20
1084#define ACPI_RESOURCE_NAME_DMA 0x28
1085#define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1086#define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1087#define ACPI_RESOURCE_NAME_IO 0x40
1088#define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1089#define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1090#define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1091#define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1092#define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1093#define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1094#define ACPI_RESOURCE_NAME_END_TAG 0x78
1095
1096/*
1097 * Large resource descriptor "names" as defined by the ACPI specification.
1098 * Note: includes the Large Descriptor bit in bit[7]
1099 */
1100#define ACPI_RESOURCE_NAME_MEMORY24 0x81
1101#define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1102#define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1103#define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1104#define ACPI_RESOURCE_NAME_MEMORY32 0x85
1105#define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1106#define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1107#define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1108#define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1109#define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1110#define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1111#define ACPI_RESOURCE_NAME_GPIO 0x8C
1112#define ACPI_RESOURCE_NAME_PIN_FUNCTION 0x8D
1113#define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1114#define ACPI_RESOURCE_NAME_PIN_CONFIG 0x8F
1115#define ACPI_RESOURCE_NAME_PIN_GROUP 0x90
1116#define ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION 0x91
1117#define ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG 0x92
1118#define ACPI_RESOURCE_NAME_LARGE_MAX 0x92
1119
1120/*****************************************************************************
1121 *
1122 * Miscellaneous
1123 *
1124 ****************************************************************************/
1125
1126#define ACPI_ASCII_ZERO 0x30
1127
1128/*****************************************************************************
1129 *
1130 * Disassembler
1131 *
1132 ****************************************************************************/
1133
1134struct acpi_external_list {
1135 char *path;
1136 char *internal_path;
1137 struct acpi_external_list *next;
1138 u32 value;
1139 u16 length;
1140 u16 flags;
1141 u8 type;
1142};
1143
1144/* Values for Flags field above */
1145
1146#define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1147#define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1148#define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1149#define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1150#define ACPI_EXT_ORIGIN_FROM_OPCODE 0x10 /* External came from a External() opcode */
1151#define ACPI_EXT_CONFLICTING_DECLARATION 0x20 /* External has a conflicting declaration within AML */
1152
1153struct acpi_external_file {
1154 char *path;
1155 struct acpi_external_file *next;
1156};
1157
1158struct acpi_parse_object_list {
1159 union acpi_parse_object *op;
1160 struct acpi_parse_object_list *next;
1161};
1162
1163/*****************************************************************************
1164 *
1165 * Debugger
1166 *
1167 ****************************************************************************/
1168
1169struct acpi_db_method_info {
1170 acpi_handle method;
1171 acpi_handle main_thread_gate;
1172 acpi_handle thread_complete_gate;
1173 acpi_handle info_gate;
1174 acpi_thread_id *threads;
1175 u32 num_threads;
1176 u32 num_created;
1177 u32 num_completed;
1178
1179 char *name;
1180 u32 flags;
1181 u32 num_loops;
1182 char pathname[ACPI_DB_LINE_BUFFER_SIZE];
1183 char **args;
1184 acpi_object_type *types;
1185
1186 /*
1187 * Arguments to be passed to method for the commands Threads and
1188 * Background. Note, ACPI specifies a maximum of 7 arguments (0 - 6).
1189 *
1190 * For the Threads command, the Number of threads, ID of current
1191 * thread and Index of current thread inside all them created.
1192 */
1193 char init_args;
1194#ifdef ACPI_DEBUGGER
1195 acpi_object_type arg_types[ACPI_METHOD_NUM_ARGS];
1196#endif
1197 char *arguments[ACPI_METHOD_NUM_ARGS];
1198 char num_threads_str[11];
1199 char id_of_thread_str[11];
1200 char index_of_thread_str[11];
1201};
1202
1203struct acpi_integrity_info {
1204 u32 nodes;
1205 u32 objects;
1206};
1207
1208#define ACPI_DB_DISABLE_OUTPUT 0x00
1209#define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1210#define ACPI_DB_CONSOLE_OUTPUT 0x02
1211#define ACPI_DB_DUPLICATE_OUTPUT 0x03
1212
1213struct acpi_object_info {
1214 u32 types[ACPI_TOTAL_TYPES];
1215};
1216
1217/*****************************************************************************
1218 *
1219 * Debug
1220 *
1221 ****************************************************************************/
1222
1223/* Entry for a memory allocation (debug only) */
1224
1225#define ACPI_MEM_MALLOC 0
1226#define ACPI_MEM_CALLOC 1
1227#define ACPI_MAX_MODULE_NAME 16
1228
1229#define ACPI_COMMON_DEBUG_MEM_HEADER \
1230 struct acpi_debug_mem_block *previous; \
1231 struct acpi_debug_mem_block *next; \
1232 u32 size; \
1233 u32 component; \
1234 u32 line; \
1235 char module[ACPI_MAX_MODULE_NAME]; \
1236 u8 alloc_type;
1237
1238struct acpi_debug_mem_header {
1239ACPI_COMMON_DEBUG_MEM_HEADER};
1240
1241struct acpi_debug_mem_block {
1242 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1243};
1244
1245#define ACPI_MEM_LIST_GLOBAL 0
1246#define ACPI_MEM_LIST_NSNODE 1
1247#define ACPI_MEM_LIST_MAX 1
1248#define ACPI_NUM_MEM_LISTS 2
1249
1250/*****************************************************************************
1251 *
1252 * Info/help support
1253 *
1254 ****************************************************************************/
1255
1256struct ah_predefined_name {
1257 char *name;
1258 char *description;
1259#ifndef ACPI_ASL_COMPILER
1260 char *action;
1261#endif
1262};
1263
1264struct ah_device_id {
1265 char *name;
1266 char *description;
1267};
1268
1269struct ah_uuid {
1270 char *description;
1271 char *string;
1272};
1273
1274struct ah_table {
1275 char *signature;
1276 char *description;
1277};
1278
1279#endif /* __ACLOCAL_H__ */