]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/acpi/aclocal.h
projects / mirror_ubuntu-artful-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ACPICA 20050708 from Bob Moore <robert.moore@intel.com>
[mirror_ubuntu-artful-kernel.git] / include / acpi / aclocal.h
CommitLineData
1da177e4
LT		 1/******************************************************************************
2 *
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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
48#define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
49
50typedef void * acpi_mutex;
51typedef u32 acpi_mutex_handle;
52
53
54/* Total number of aml opcodes defined */
55
56#define AML_NUM_OPCODES 0x7F
57
58
f9f4601f
RM		 59/* Forward declarations */
60
61struct acpi_walk_state ;
62struct acpi_obj_mutex;
63union acpi_parse_object ;
64
65
1da177e4
LT		 66/*****************************************************************************
67 *
68 * Mutex typedefs and structs
69 *
70 ****************************************************************************/
71
72
73/*
74 * Predefined handles for the mutex objects used within the subsystem
75 * All mutex objects are automatically created by acpi_ut_mutex_initialize.
76 *
77 * The acquire/release ordering protocol is implied via this list. Mutexes
78 * with a lower value must be acquired before mutexes with a higher value.
79 *
80 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names table also!
81 */
1da177e4
LT		 82#define ACPI_MTX_EXECUTE 0
83#define ACPI_MTX_INTERPRETER 1
84#define ACPI_MTX_PARSER 2
85#define ACPI_MTX_DISPATCHER 3
86#define ACPI_MTX_TABLES 4
87#define ACPI_MTX_OP_REGIONS 5
88#define ACPI_MTX_NAMESPACE 6
89#define ACPI_MTX_EVENTS 7
90#define ACPI_MTX_HARDWARE 8
91#define ACPI_MTX_CACHES 9
92#define ACPI_MTX_MEMORY 10
93#define ACPI_MTX_DEBUG_CMD_COMPLETE 11
94#define ACPI_MTX_DEBUG_CMD_READY 12
95
96#define MAX_MUTEX 12
97#define NUM_MUTEX MAX_MUTEX+1
98
99
100#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
101#ifdef DEFINE_ACPI_GLOBALS
102
103/* Names for the mutexes used in the subsystem */
104
105static char *acpi_gbl_mutex_names[] =
106{
107 "ACPI_MTX_Execute",
108 "ACPI_MTX_Interpreter",
109 "ACPI_MTX_Parser",
110 "ACPI_MTX_Dispatcher",
111 "ACPI_MTX_Tables",
112 "ACPI_MTX_op_regions",
113 "ACPI_MTX_Namespace",
114 "ACPI_MTX_Events",
115 "ACPI_MTX_Hardware",
116 "ACPI_MTX_Caches",
117 "ACPI_MTX_Memory",
118 "ACPI_MTX_debug_cmd_complete",
119 "ACPI_MTX_debug_cmd_ready",
120};
121
122#endif
123#endif
124
125
f9f4601f
RM		 126/* Owner IDs are used to track namespace nodes for selective deletion */
127
128typedef u8 acpi_owner_id;
129#define ACPI_OWNER_ID_MAX 0xFF
130
131/* This Thread ID means that the mutex is not in use (unlocked) */
132
133#define ACPI_MUTEX_NOT_ACQUIRED (u32) -1
134
1da177e4
LT		 135/* Table for the global mutexes */
136
137struct acpi_mutex_info
138{
139 acpi_mutex mutex;
140 u32 use_count;
f9f4601f 141 u32 thread_id;
1da177e4
LT		 142};
143
1da177e4
LT		 144
145/* Lock flag parameter for various interfaces */
146
147#define ACPI_MTX_DO_NOT_LOCK 0
148#define ACPI_MTX_LOCK 1
149
150
1da177e4
LT		 151/* Field access granularities */
152
153#define ACPI_FIELD_BYTE_GRANULARITY 1
154#define ACPI_FIELD_WORD_GRANULARITY 2
155#define ACPI_FIELD_DWORD_GRANULARITY 4
156#define ACPI_FIELD_QWORD_GRANULARITY 8
157
44f6c012 158
1da177e4
LT		 159/*****************************************************************************
160 *
161 * Namespace typedefs and structs
162 *
163 ****************************************************************************/
164
1da177e4
LT		 165/* Operational modes of the AML interpreter/scanner */
166
167typedef enum
168{
169 ACPI_IMODE_LOAD_PASS1 = 0x01,
170 ACPI_IMODE_LOAD_PASS2 = 0x02,
171 ACPI_IMODE_EXECUTE = 0x0E
172
173} acpi_interpreter_mode;
174
175
176/*
177 * The Node describes a named object that appears in the AML
178 * An acpi_node is used to store Nodes.
179 *
180 * data_type is used to differentiate between internal descriptors, and MUST
181 * be the first byte in this structure.
182 */
1da177e4
LT		 183union acpi_name_union
184{
185 u32 integer;
186 char ascii[4];
187};
188
189struct acpi_namespace_node
190{
191 u8 descriptor; /* Used to differentiate object descriptor types */
192 u8 type; /* Type associated with this name */
f9f4601f 193 u16 reference_count; /* Current count of references and children */
1da177e4
LT		 194 union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */
195 union acpi_operand_object *object; /* Pointer to attached ACPI object (optional) */
196 struct acpi_namespace_node *child; /* First child */
197 struct acpi_namespace_node *peer; /* Next peer*/
f9f4601f 198 u8 owner_id; /* Who created this node */
1da177e4 199 u8 flags;
f9f4601f
RM		 200
201 /* Fields used by the ASL compiler only */
202
203#ifdef ACPI_ASL_COMPILER
204 u32 value;
205 union acpi_parse_object *op;
206#endif
1da177e4
LT		 207};
208
209
210#define ACPI_ENTRY_NOT_FOUND NULL
211
212
213/* Node flags */
214
215#define ANOBJ_RESERVED 0x01
216#define ANOBJ_END_OF_PEER_LIST 0x02
217#define ANOBJ_DATA_WIDTH_32 0x04 /* Parent table is 64-bits */
218#define ANOBJ_METHOD_ARG 0x08
219#define ANOBJ_METHOD_LOCAL 0x10
220#define ANOBJ_METHOD_NO_RETVAL 0x20
221#define ANOBJ_METHOD_SOME_NO_RETVAL 0x40
222#define ANOBJ_IS_BIT_OFFSET 0x80
223
224/*
225 * ACPI Table Descriptor. One per ACPI table
226 */
227struct acpi_table_desc
228{
229 struct acpi_table_desc *prev;
230 struct acpi_table_desc *next;
231 struct acpi_table_desc *installed_desc;
232 struct acpi_table_header *pointer;
233 u8 *aml_start;
234 u64 physical_address;
235 u32 aml_length;
236 acpi_size length;
f9f4601f 237 acpi_owner_id owner_id;
1da177e4
LT		 238 u8 type;
239 u8 allocation;
240 u8 loaded_into_namespace;
241};
242
243struct acpi_table_list
244{
245 struct acpi_table_desc *next;
246 u32 count;
247};
248
249
250struct acpi_find_context
251{
252 char *search_for;
253 acpi_handle *list;
254 u32 *count;
255};
256
257
258struct acpi_ns_search_data
259{
260 struct acpi_namespace_node *node;
261};
262
263
264/*
265 * Predefined Namespace items
266 */
267struct acpi_predefined_names
268{
269 char *name;
270 u8 type;
271 char *val;
272};
273
274
275/* Object types used during package copies */
276
277
278#define ACPI_COPY_TYPE_SIMPLE 0
279#define ACPI_COPY_TYPE_PACKAGE 1
280
281/* Info structure used to convert external<->internal namestrings */
282
283struct acpi_namestring_info
284{
285 char *external_name;
286 char *next_external_char;
287 char *internal_name;
288 u32 length;
289 u32 num_segments;
290 u32 num_carats;
291 u8 fully_qualified;
292};
293
294
295/* Field creation info */
296
297struct acpi_create_field_info
298{
299 struct acpi_namespace_node *region_node;
300 struct acpi_namespace_node *field_node;
301 struct acpi_namespace_node *register_node;
302 struct acpi_namespace_node *data_register_node;
303 u32 bank_value;
304 u32 field_bit_position;
305 u32 field_bit_length;
306 u8 field_flags;
307 u8 attribute;
308 u8 field_type;
309};
310
311
312/*****************************************************************************
313 *
314 * Event typedefs and structs
315 *
316 ****************************************************************************/
317
318/* Dispatch info for each GPE -- either a method or handler, cannot be both */
319
320struct acpi_handler_info
321{
322 acpi_event_handler address; /* Address of handler, if any */
323 void *context; /* Context to be passed to handler */
324 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */
325};
326
327union acpi_gpe_dispatch_info
328{
329 struct acpi_namespace_node *method_node; /* Method node for this GPE level */
330 struct acpi_handler_info *handler;
331};
332
333/*
334 * Information about a GPE, one per each GPE in an array.
335 * NOTE: Important to keep this struct as small as possible.
336 */
337struct acpi_gpe_event_info
338{
339 union acpi_gpe_dispatch_info dispatch; /* Either Method or Handler */
340 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */
341 u8 flags; /* Misc info about this GPE */
342 u8 register_bit; /* This GPE bit within the register */
343};
344
345/* Information about a GPE register pair, one per each status/enable pair in an array */
346
347struct acpi_gpe_register_info
348{
349 struct acpi_generic_address status_address; /* Address of status reg */
350 struct acpi_generic_address enable_address; /* Address of enable reg */
351 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
352 u8 enable_for_run; /* GPEs to keep enabled when running */
353 u8 base_gpe_number; /* Base GPE number for this register */
354};
355
356/*
357 * Information about a GPE register block, one per each installed block --
358 * GPE0, GPE1, and one per each installed GPE Block Device.
359 */
360struct acpi_gpe_block_info
361{
362 struct acpi_namespace_node *node;
363 struct acpi_gpe_block_info *previous;
364 struct acpi_gpe_block_info *next;
365 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */
366 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */
367 struct acpi_gpe_event_info *event_info; /* One for each GPE */
368 struct acpi_generic_address block_address; /* Base address of the block */
369 u32 register_count; /* Number of register pairs in block */
370 u8 block_base_number;/* Base GPE number for this block */
371};
372
373/* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
374
375struct acpi_gpe_xrupt_info
376{
377 struct acpi_gpe_xrupt_info *previous;
378 struct acpi_gpe_xrupt_info *next;
379 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */
6f42ccf2 380 u32 interrupt_number; /* System interrupt number */
1da177e4
LT		 381};
382
383
384struct acpi_gpe_walk_info
385{
386 struct acpi_namespace_node *gpe_device;
387 struct acpi_gpe_block_info *gpe_block;
388};
389
390
391typedef acpi_status (*ACPI_GPE_CALLBACK) (
392 struct acpi_gpe_xrupt_info *gpe_xrupt_info,
393 struct acpi_gpe_block_info *gpe_block);
394
395
396/* Information about each particular fixed event */
397
398struct acpi_fixed_event_handler
399{
400 acpi_event_handler handler; /* Address of handler. */
401 void *context; /* Context to be passed to handler */
402};
403
404struct acpi_fixed_event_info
405{
406 u8 status_register_id;
407 u8 enable_register_id;
408 u16 status_bit_mask;
409 u16 enable_bit_mask;
410};
411
412/* Information used during field processing */
413
414struct acpi_field_info
415{
416 u8 skip_field;
417 u8 field_flag;
418 u32 pkg_length;
419};
420
421
422/*****************************************************************************
423 *
424 * Generic "state" object for stacks
425 *
426 ****************************************************************************/
427
1da177e4
LT		 428#define ACPI_CONTROL_NORMAL 0xC0
429#define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
430#define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
431#define ACPI_CONTROL_PREDICATE_FALSE 0xC3
432#define ACPI_CONTROL_PREDICATE_TRUE 0xC4
433
434
1da177e4
LT		 435#define ACPI_STATE_COMMON /* Two 32-bit fields and a pointer */\
436 u8 data_type; /* To differentiate various internal objs */\
437 u8 flags; \
438 u16 value; \
439 u16 state; \
440 u16 reserved; \
441 void *next; \
442
443struct acpi_common_state
444{
445 ACPI_STATE_COMMON
446};
447
448
449/*
450 * Update state - used to traverse complex objects such as packages
451 */
452struct acpi_update_state
453{
454 ACPI_STATE_COMMON
455 union acpi_operand_object *object;
456};
457
458
459/*
460 * Pkg state - used to traverse nested package structures
461 */
462struct acpi_pkg_state
463{
464 ACPI_STATE_COMMON
465 union acpi_operand_object *source_object;
466 union acpi_operand_object *dest_object;
467 struct acpi_walk_state *walk_state;
468 void *this_target_obj;
469 u32 num_packages;
470 u16 index;
471};
472
473
474/*
475 * Control state - one per if/else and while constructs.
476 * Allows nesting of these constructs
477 */
478struct acpi_control_state
479{
480 ACPI_STATE_COMMON
481 union acpi_parse_object *predicate_op;
482 u8 *aml_predicate_start; /* Start of if/while predicate */
483 u8 *package_end; /* End of if/while block */
484 u16 opcode;
485};
486
487
488/*
489 * Scope state - current scope during namespace lookups
490 */
491struct acpi_scope_state
492{
493 ACPI_STATE_COMMON
494 struct acpi_namespace_node *node;
495};
496
497
498struct acpi_pscope_state
499{
500 ACPI_STATE_COMMON
501 union acpi_parse_object *op; /* Current op being parsed */
502 u8 *arg_end; /* Current argument end */
503 u8 *pkg_end; /* Current package end */
504 u32 arg_list; /* Next argument to parse */
505 u32 arg_count; /* Number of fixed arguments */
506};
507
508
509/*
510 * Thread state - one per thread across multiple walk states. Multiple walk
511 * states are created when there are nested control methods executing.
512 */
513struct acpi_thread_state
514{
515 ACPI_STATE_COMMON
516 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */
517 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
518 u32 thread_id; /* Running thread ID */
519 u8 current_sync_level; /* Mutex Sync (nested acquire) level */
520};
521
522
523/*
524 * Result values - used to accumulate the results of nested
525 * AML arguments
526 */
527struct acpi_result_values
528{
529 ACPI_STATE_COMMON
530 union acpi_operand_object *obj_desc [ACPI_OBJ_NUM_OPERANDS];
531 u8 num_results;
532 u8 last_insert;
533};
534
535
536typedef
537acpi_status (*acpi_parse_downwards) (
538 struct acpi_walk_state *walk_state,
539 union acpi_parse_object **out_op);
540
541typedef
542acpi_status (*acpi_parse_upwards) (
543 struct acpi_walk_state *walk_state);
544
545
546/*
547 * Notify info - used to pass info to the deferred notify
548 * handler/dispatcher.
549 */
550struct acpi_notify_info
551{
552 ACPI_STATE_COMMON
553 struct acpi_namespace_node *node;
554 union acpi_operand_object *handler_obj;
555};
556
557
558/* Generic state is union of structs above */
559
560union acpi_generic_state
561{
562 struct acpi_common_state common;
563 struct acpi_control_state control;
564 struct acpi_update_state update;
565 struct acpi_scope_state scope;
566 struct acpi_pscope_state parse_scope;
567 struct acpi_pkg_state pkg;
568 struct acpi_thread_state thread;
569 struct acpi_result_values results;
570 struct acpi_notify_info notify;
571};
572
573
574/*****************************************************************************
575 *
576 * Interpreter typedefs and structs
577 *
578 ****************************************************************************/
579
580typedef
581acpi_status (*ACPI_EXECUTE_OP) (
582 struct acpi_walk_state *walk_state);
583
584
585/*****************************************************************************
586 *
587 * Parser typedefs and structs
588 *
589 ****************************************************************************/
590
591/*
592 * AML opcode, name, and argument layout
593 */
594struct acpi_opcode_info
595{
596#if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
597 char *name; /* Opcode name (disassembler/debug only) */
598#endif
599 u32 parse_args; /* Grammar/Parse time arguments */
600 u32 runtime_args; /* Interpret time arguments */
601 u32 flags; /* Misc flags */
602 u8 object_type; /* Corresponding internal object type */
603 u8 class; /* Opcode class */
604 u8 type; /* Opcode type */
605};
606
1da177e4
LT		 607union acpi_parse_value
608{
609 acpi_integer integer; /* Integer constant (Up to 64 bits) */
610 struct uint64_struct integer64; /* Structure overlay for 2 32-bit Dwords */
611 u32 size; /* bytelist or field size */
612 char *string; /* NULL terminated string */
613 u8 *buffer; /* buffer or string */
614 char *name; /* NULL terminated string */
615 union acpi_parse_object *arg; /* arguments and contained ops */
616};
617
1da177e4
LT		 618#define ACPI_PARSE_COMMON \
619 u8 data_type; /* To differentiate various internal objs */\
620 u8 flags; /* Type of Op */\
621 u16 aml_opcode; /* AML opcode */\
622 u32 aml_offset; /* Offset of declaration in AML */\
623 union acpi_parse_object *parent; /* Parent op */\
624 union acpi_parse_object *next; /* Next op */\
625 ACPI_DISASM_ONLY_MEMBERS (\
626 u8 disasm_flags; /* Used during AML disassembly */\
627 u8 disasm_opcode; /* Subtype used for disassembly */\
628 char aml_op_name[16]) /* Op name (debug only) */\
629 /* NON-DEBUG members below: */\
630 struct acpi_namespace_node *node; /* For use by interpreter */\
631 union acpi_parse_value value; /* Value or args associated with the opcode */\
632
633
634#define ACPI_DASM_BUFFER 0x00
635#define ACPI_DASM_RESOURCE 0x01
636#define ACPI_DASM_STRING 0x02
637#define ACPI_DASM_UNICODE 0x03
638#define ACPI_DASM_EISAID 0x04
639#define ACPI_DASM_MATCHOP 0x05
640
641/*
642 * generic operation (for example: If, While, Store)
643 */
644struct acpi_parse_obj_common
645{
646 ACPI_PARSE_COMMON
647};
648
649
650/*
651 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
652 * and bytelists.
653 */
654struct acpi_parse_obj_named
655{
656 ACPI_PARSE_COMMON
657 u8 *path;
658 u8 *data; /* AML body or bytelist data */
659 u32 length; /* AML length */
660 u32 name; /* 4-byte name or zero if no name */
661};
662
663
664/* The parse node is the fundamental element of the parse tree */
665
666struct acpi_parse_obj_asl
667{
668 ACPI_PARSE_COMMON
669 union acpi_parse_object *child;
670 union acpi_parse_object *parent_method;
671 char *filename;
672 char *external_name;
673 char *namepath;
674 char name_seg[4];
675 u32 extra_value;
676 u32 column;
677 u32 line_number;
678 u32 logical_line_number;
679 u32 logical_byte_offset;
680 u32 end_line;
681 u32 end_logical_line;
682 u32 acpi_btype;
683 u32 aml_length;
684 u32 aml_subtree_length;
685 u32 final_aml_length;
686 u32 final_aml_offset;
687 u32 compile_flags;
688 u16 parse_opcode;
689 u8 aml_opcode_length;
690 u8 aml_pkg_len_bytes;
691 u8 extra;
692 char parse_op_name[12];
693};
694
1da177e4
LT		 695union acpi_parse_object
696{
697 struct acpi_parse_obj_common common;
698 struct acpi_parse_obj_named named;
699 struct acpi_parse_obj_asl asl;
700};
701
702
703/*
704 * Parse state - one state per parser invocation and each control
705 * method.
706 */
707struct acpi_parse_state
708{
709 u32 aml_size;
710 u8 *aml_start; /* First AML byte */
711 u8 *aml; /* Next AML byte */
712 u8 *aml_end; /* (last + 1) AML byte */
713 u8 *pkg_start; /* Current package begin */
714 u8 *pkg_end; /* Current package end */
715 union acpi_parse_object *start_op; /* Root of parse tree */
716 struct acpi_namespace_node *start_node;
717 union acpi_generic_state *scope; /* Current scope */
718 union acpi_parse_object *start_scope;
719};
720
721
722/* Parse object flags */
723
724#define ACPI_PARSEOP_GENERIC 0x01
725#define ACPI_PARSEOP_NAMED 0x02
726#define ACPI_PARSEOP_DEFERRED 0x04
727#define ACPI_PARSEOP_BYTELIST 0x08
728#define ACPI_PARSEOP_IN_CACHE 0x80
729
730/* Parse object disasm_flags */
731
732#define ACPI_PARSEOP_IGNORE 0x01
733#define ACPI_PARSEOP_PARAMLIST 0x02
734#define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
735#define ACPI_PARSEOP_SPECIAL 0x10
736
737
738/*****************************************************************************
739 *
740 * Hardware (ACPI registers) and PNP
741 *
742 ****************************************************************************/
743
744#define PCI_ROOT_HID_STRING "PNP0A03"
6f42ccf2 745#define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
1da177e4
LT		 746
747struct acpi_bit_register_info
748{
749 u8 parent_register;
750 u8 bit_position;
751 u16 access_bit_mask;
752};
753
754
755/*
756 * Register IDs
757 * These are the full ACPI registers
758 */
759#define ACPI_REGISTER_PM1_STATUS 0x01
760#define ACPI_REGISTER_PM1_ENABLE 0x02
761#define ACPI_REGISTER_PM1_CONTROL 0x03
762#define ACPI_REGISTER_PM1A_CONTROL 0x04
763#define ACPI_REGISTER_PM1B_CONTROL 0x05
764#define ACPI_REGISTER_PM2_CONTROL 0x06
765#define ACPI_REGISTER_PM_TIMER 0x07
766#define ACPI_REGISTER_PROCESSOR_BLOCK 0x08
767#define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x09
768
769
770/* Masks used to access the bit_registers */
771
772#define ACPI_BITMASK_TIMER_STATUS 0x0001
773#define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
774#define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
775#define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
776#define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
777#define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
778#define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
779#define ACPI_BITMASK_WAKE_STATUS 0x8000
780
781#define ACPI_BITMASK_ALL_FIXED_STATUS (ACPI_BITMASK_TIMER_STATUS | \
782 ACPI_BITMASK_BUS_MASTER_STATUS | \
783 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
784 ACPI_BITMASK_POWER_BUTTON_STATUS | \
785 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
786 ACPI_BITMASK_RT_CLOCK_STATUS | \
787 ACPI_BITMASK_WAKE_STATUS)
788
789#define ACPI_BITMASK_TIMER_ENABLE 0x0001
790#define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
791#define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
792#define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
793#define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
794#define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
795
796#define ACPI_BITMASK_SCI_ENABLE 0x0001
797#define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
798#define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
799#define ACPI_BITMASK_SLEEP_TYPE_X 0x1C00
800#define ACPI_BITMASK_SLEEP_ENABLE 0x2000
801
802#define ACPI_BITMASK_ARB_DISABLE 0x0001
803
804
805/* Raw bit position of each bit_register */
806
807#define ACPI_BITPOSITION_TIMER_STATUS 0x00
808#define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
809#define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
810#define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
811#define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
812#define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
813#define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
814#define ACPI_BITPOSITION_WAKE_STATUS 0x0F
815
816#define ACPI_BITPOSITION_TIMER_ENABLE 0x00
817#define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
818#define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
819#define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
820#define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
821#define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
822
823#define ACPI_BITPOSITION_SCI_ENABLE 0x00
824#define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
825#define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
826#define ACPI_BITPOSITION_SLEEP_TYPE_X 0x0A
827#define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
828
829#define ACPI_BITPOSITION_ARB_DISABLE 0x00
830
831
832/*****************************************************************************
833 *
834 * Resource descriptors
835 *
836 ****************************************************************************/
837
1da177e4
LT		 838/* resource_type values */
839
840#define ACPI_RESOURCE_TYPE_MEMORY_RANGE 0
841#define ACPI_RESOURCE_TYPE_IO_RANGE 1
842#define ACPI_RESOURCE_TYPE_BUS_NUMBER_RANGE 2
843
844/* Resource descriptor types and masks */
845
846#define ACPI_RDESC_TYPE_LARGE 0x80
847#define ACPI_RDESC_TYPE_SMALL 0x00
848
849#define ACPI_RDESC_TYPE_MASK 0x80
850#define ACPI_RDESC_SMALL_MASK 0x78 /* Only bits 6:3 contain the type */
851
852
853/*
854 * Small resource descriptor types
855 * Note: The 3 length bits (2:0) must be zero
856 */
857#define ACPI_RDESC_TYPE_IRQ_FORMAT 0x20
858#define ACPI_RDESC_TYPE_DMA_FORMAT 0x28
859#define ACPI_RDESC_TYPE_START_DEPENDENT 0x30
860#define ACPI_RDESC_TYPE_END_DEPENDENT 0x38
861#define ACPI_RDESC_TYPE_IO_PORT 0x40
862#define ACPI_RDESC_TYPE_FIXED_IO_PORT 0x48
863#define ACPI_RDESC_TYPE_SMALL_VENDOR 0x70
864#define ACPI_RDESC_TYPE_END_TAG 0x78
865
866/*
867 * Large resource descriptor types
868 */
869#define ACPI_RDESC_TYPE_MEMORY_24 0x81
870#define ACPI_RDESC_TYPE_GENERAL_REGISTER 0x82
871#define ACPI_RDESC_TYPE_LARGE_VENDOR 0x84
872#define ACPI_RDESC_TYPE_MEMORY_32 0x85
873#define ACPI_RDESC_TYPE_FIXED_MEMORY_32 0x86
874#define ACPI_RDESC_TYPE_DWORD_ADDRESS_SPACE 0x87
875#define ACPI_RDESC_TYPE_WORD_ADDRESS_SPACE 0x88
876#define ACPI_RDESC_TYPE_EXTENDED_XRUPT 0x89
877#define ACPI_RDESC_TYPE_QWORD_ADDRESS_SPACE 0x8A
878#define ACPI_RDESC_TYPE_EXTENDED_ADDRESS_SPACE 0x8B
879
880
881/*****************************************************************************
882 *
883 * Miscellaneous
884 *
885 ****************************************************************************/
886
887#define ACPI_ASCII_ZERO 0x30
888
889
890/*****************************************************************************
891 *
892 * Debugger
893 *
894 ****************************************************************************/
895
896struct acpi_db_method_info
897{
898 acpi_handle thread_gate;
899 char *name;
900 char **args;
901 u32 flags;
902 u32 num_loops;
903 char pathname[128];
904};
905
906struct acpi_integrity_info
907{
908 u32 nodes;
909 u32 objects;
910};
911
912
913#define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
914#define ACPI_DB_CONSOLE_OUTPUT 0x02
915#define ACPI_DB_DUPLICATE_OUTPUT 0x03
916
917
918/*****************************************************************************
919 *
920 * Debug
921 *
922 ****************************************************************************/
923
1da177e4
LT		 924/* Entry for a memory allocation (debug only) */
925
926#define ACPI_MEM_MALLOC 0
927#define ACPI_MEM_CALLOC 1
928#define ACPI_MAX_MODULE_NAME 16
929
930#define ACPI_COMMON_DEBUG_MEM_HEADER \
931 struct acpi_debug_mem_block *previous; \
932 struct acpi_debug_mem_block *next; \
933 u32 size; \
934 u32 component; \
935 u32 line; \
936 char module[ACPI_MAX_MODULE_NAME]; \
937 u8 alloc_type;
938
939struct acpi_debug_mem_header
940{
941 ACPI_COMMON_DEBUG_MEM_HEADER
942};
943
944struct acpi_debug_mem_block
945{
946 ACPI_COMMON_DEBUG_MEM_HEADER
947 u64 user_space;
948};
949
950
951#define ACPI_MEM_LIST_GLOBAL 0
952#define ACPI_MEM_LIST_NSNODE 1
73459f73
RM		 953#define ACPI_MEM_LIST_MAX 1
954#define ACPI_NUM_MEM_LISTS 2
1da177e4
LT		 955
956
957struct acpi_memory_list
958{
73459f73 959 char *list_name;
1da177e4 960 void *list_head;
1da177e4 961 u16 object_size;
73459f73
RM		 962 u16 max_depth;
963 u16 current_depth;
964 u16 link_offset;
1da177e4
LT		 965
966#ifdef ACPI_DBG_TRACK_ALLOCATIONS
967
968 /* Statistics for debug memory tracking only */
969
970 u32 total_allocated;
971 u32 total_freed;
972 u32 current_total_size;
73459f73
RM		 973 u32 requests;
974 u32 hits;
1da177e4
LT		 975#endif
976};
977
1da177e4 978#endif /* __ACLOCAL_H__ */
Ubuntu Artful kernel mirror