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