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