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