[ACPICA]
[reactos.git] / reactos / drivers / bus / acpi / acpica / include / aclocal.h
1 /******************************************************************************
2 *
3 * Name: aclocal.h - Internal data types used across the ACPI subsystem
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************/
115
116 #ifndef __ACLOCAL_H__
117 #define __ACLOCAL_H__
118
119
120 /* acpisrc:StructDefs -- for acpisrc conversion */
121
122 #define ACPI_SERIALIZED 0xFF
123
124 typedef UINT32 ACPI_MUTEX_HANDLE;
125 #define ACPI_GLOBAL_LOCK (ACPI_SEMAPHORE) (-1)
126
127 /* Total number of aml opcodes defined */
128
129 #define AML_NUM_OPCODES 0x81
130
131
132 /* Forward declarations */
133
134 struct acpi_walk_state;
135 struct acpi_obj_mutex;
136 union acpi_parse_object;
137
138
139 /*****************************************************************************
140 *
141 * Mutex typedefs and structs
142 *
143 ****************************************************************************/
144
145
146 /*
147 * Predefined handles for the mutex objects used within the subsystem
148 * All mutex objects are automatically created by AcpiUtMutexInitialize.
149 *
150 * The acquire/release ordering protocol is implied via this list. Mutexes
151 * with a lower value must be acquired before mutexes with a higher value.
152 *
153 * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames
154 * table below also!
155 */
156 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */
157 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */
158 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */
159 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */
160 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */
161 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */
162 #define ACPI_MTX_DEBUG_CMD_COMPLETE 6 /* AML debugger */
163 #define ACPI_MTX_DEBUG_CMD_READY 7 /* AML debugger */
164
165 #define ACPI_MAX_MUTEX 7
166 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1
167
168
169 /* Lock structure for reader/writer interfaces */
170
171 typedef struct acpi_rw_lock
172 {
173 ACPI_MUTEX WriterMutex;
174 ACPI_MUTEX ReaderMutex;
175 UINT32 NumReaders;
176
177 } ACPI_RW_LOCK;
178
179
180 /*
181 * Predefined handles for spinlocks used within the subsystem.
182 * These spinlocks are created by AcpiUtMutexInitialize
183 */
184 #define ACPI_LOCK_GPES 0
185 #define ACPI_LOCK_HARDWARE 1
186
187 #define ACPI_MAX_LOCK 1
188 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1
189
190
191 /* This Thread ID means that the mutex is not in use (unlocked) */
192
193 #define ACPI_MUTEX_NOT_ACQUIRED (ACPI_THREAD_ID) -1
194
195 /* Table for the global mutexes */
196
197 typedef struct acpi_mutex_info
198 {
199 ACPI_MUTEX Mutex;
200 UINT32 UseCount;
201 ACPI_THREAD_ID ThreadId;
202
203 } ACPI_MUTEX_INFO;
204
205
206 /* Lock flag parameter for various interfaces */
207
208 #define ACPI_MTX_DO_NOT_LOCK 0
209 #define ACPI_MTX_LOCK 1
210
211
212 /* Field access granularities */
213
214 #define ACPI_FIELD_BYTE_GRANULARITY 1
215 #define ACPI_FIELD_WORD_GRANULARITY 2
216 #define ACPI_FIELD_DWORD_GRANULARITY 4
217 #define ACPI_FIELD_QWORD_GRANULARITY 8
218
219
220 #define ACPI_ENTRY_NOT_FOUND NULL
221
222
223 /*****************************************************************************
224 *
225 * Namespace typedefs and structs
226 *
227 ****************************************************************************/
228
229 /* Operational modes of the AML interpreter/scanner */
230
231 typedef enum
232 {
233 ACPI_IMODE_LOAD_PASS1 = 0x01,
234 ACPI_IMODE_LOAD_PASS2 = 0x02,
235 ACPI_IMODE_EXECUTE = 0x03
236
237 } ACPI_INTERPRETER_MODE;
238
239
240 /*
241 * The Namespace Node describes a named object that appears in the AML.
242 * DescriptorType is used to differentiate between internal descriptors.
243 *
244 * The node is optimized for both 32-bit and 64-bit platforms:
245 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
246 *
247 * Note: The DescriptorType and Type fields must appear in the identical
248 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
249 * structures.
250 */
251 typedef struct acpi_namespace_node
252 {
253 union acpi_operand_object *Object; /* Interpreter object */
254 UINT8 DescriptorType; /* Differentiate object descriptor types */
255 UINT8 Type; /* ACPI Type associated with this name */
256 UINT8 Flags; /* Miscellaneous flags */
257 ACPI_OWNER_ID OwnerId; /* Node creator */
258 ACPI_NAME_UNION Name; /* ACPI Name, always 4 chars per ACPI spec */
259 struct acpi_namespace_node *Parent; /* Parent node */
260 struct acpi_namespace_node *Child; /* First child */
261 struct acpi_namespace_node *Peer; /* First peer */
262
263 /*
264 * The following fields are used by the ASL compiler and disassembler only
265 */
266 #ifdef ACPI_LARGE_NAMESPACE_NODE
267 union acpi_parse_object *Op;
268 UINT32 Value;
269 UINT32 Length;
270 #endif
271
272 } ACPI_NAMESPACE_NODE;
273
274
275 /* Namespace Node flags */
276
277 #define ANOBJ_RESERVED 0x01 /* Available for use */
278 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */
279 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */
280 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */
281 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */
282 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */
283 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (InstallMethod) */
284
285 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */
286 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */
287 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */
288 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */
289
290
291 /* Internal ACPI table management - master table list */
292
293 typedef struct acpi_table_list
294 {
295 ACPI_TABLE_DESC *Tables; /* Table descriptor array */
296 UINT32 CurrentTableCount; /* Tables currently in the array */
297 UINT32 MaxTableCount; /* Max tables array will hold */
298 UINT8 Flags;
299
300 } ACPI_TABLE_LIST;
301
302 /* Flags for above */
303
304 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */
305 #define ACPI_ROOT_ORIGIN_ALLOCATED (1)
306 #define ACPI_ROOT_ALLOW_RESIZE (2)
307
308
309 /* Predefined (fixed) table indexes */
310
311 #define ACPI_TABLE_INDEX_DSDT (0)
312 #define ACPI_TABLE_INDEX_FACS (1)
313
314
315 typedef struct acpi_find_context
316 {
317 char *SearchFor;
318 ACPI_HANDLE *List;
319 UINT32 *Count;
320
321 } ACPI_FIND_CONTEXT;
322
323
324 typedef struct acpi_ns_search_data
325 {
326 ACPI_NAMESPACE_NODE *Node;
327
328 } ACPI_NS_SEARCH_DATA;
329
330
331 /* Object types used during package copies */
332
333 #define ACPI_COPY_TYPE_SIMPLE 0
334 #define ACPI_COPY_TYPE_PACKAGE 1
335
336
337 /* Info structure used to convert external<->internal namestrings */
338
339 typedef struct acpi_namestring_info
340 {
341 const char *ExternalName;
342 const char *NextExternalChar;
343 char *InternalName;
344 UINT32 Length;
345 UINT32 NumSegments;
346 UINT32 NumCarats;
347 BOOLEAN FullyQualified;
348
349 } ACPI_NAMESTRING_INFO;
350
351
352 /* Field creation info */
353
354 typedef struct acpi_create_field_info
355 {
356 ACPI_NAMESPACE_NODE *RegionNode;
357 ACPI_NAMESPACE_NODE *FieldNode;
358 ACPI_NAMESPACE_NODE *RegisterNode;
359 ACPI_NAMESPACE_NODE *DataRegisterNode;
360 ACPI_NAMESPACE_NODE *ConnectionNode;
361 UINT8 *ResourceBuffer;
362 UINT32 BankValue;
363 UINT32 FieldBitPosition;
364 UINT32 FieldBitLength;
365 UINT16 ResourceLength;
366 UINT8 FieldFlags;
367 UINT8 Attribute;
368 UINT8 FieldType;
369 UINT8 AccessLength;
370
371 } ACPI_CREATE_FIELD_INFO;
372
373
374 typedef
375 ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
376 struct acpi_walk_state *WalkState);
377
378
379 /*
380 * Bitmapped ACPI types. Used internally only
381 */
382 #define ACPI_BTYPE_ANY 0x00000000
383 #define ACPI_BTYPE_INTEGER 0x00000001
384 #define ACPI_BTYPE_STRING 0x00000002
385 #define ACPI_BTYPE_BUFFER 0x00000004
386 #define ACPI_BTYPE_PACKAGE 0x00000008
387 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
388 #define ACPI_BTYPE_DEVICE 0x00000020
389 #define ACPI_BTYPE_EVENT 0x00000040
390 #define ACPI_BTYPE_METHOD 0x00000080
391 #define ACPI_BTYPE_MUTEX 0x00000100
392 #define ACPI_BTYPE_REGION 0x00000200
393 #define ACPI_BTYPE_POWER 0x00000400
394 #define ACPI_BTYPE_PROCESSOR 0x00000800
395 #define ACPI_BTYPE_THERMAL 0x00001000
396 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
397 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
398 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
399 #define ACPI_BTYPE_REFERENCE 0x00010000
400 #define ACPI_BTYPE_RESOURCE 0x00020000
401
402 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
403
404 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
405 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
406 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
407 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
408 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
409
410 #pragma pack(1)
411
412 /*
413 * Information structure for ACPI predefined names.
414 * Each entry in the table contains the following items:
415 *
416 * Name - The ACPI reserved name
417 * ParamCount - Number of arguments to the method
418 * ExpectedReturnBtypes - Allowed type(s) for the return value
419 */
420 typedef struct acpi_name_info
421 {
422 char Name[ACPI_NAME_SIZE];
423 UINT16 ArgumentList;
424 UINT8 ExpectedBtypes;
425
426 } ACPI_NAME_INFO;
427
428 /*
429 * Secondary information structures for ACPI predefined objects that return
430 * package objects. This structure appears as the next entry in the table
431 * after the NAME_INFO structure above.
432 *
433 * The reason for this is to minimize the size of the predefined name table.
434 */
435
436 /*
437 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
438 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
439 * ACPI_PTYPE2_FIX_VAR
440 */
441 typedef struct acpi_package_info
442 {
443 UINT8 Type;
444 UINT8 ObjectType1;
445 UINT8 Count1;
446 UINT8 ObjectType2;
447 UINT8 Count2;
448 UINT16 Reserved;
449
450 } ACPI_PACKAGE_INFO;
451
452 /* Used for ACPI_PTYPE2_FIXED */
453
454 typedef struct acpi_package_info2
455 {
456 UINT8 Type;
457 UINT8 Count;
458 UINT8 ObjectType[4];
459 UINT8 Reserved;
460
461 } ACPI_PACKAGE_INFO2;
462
463 /* Used for ACPI_PTYPE1_OPTION */
464
465 typedef struct acpi_package_info3
466 {
467 UINT8 Type;
468 UINT8 Count;
469 UINT8 ObjectType[2];
470 UINT8 TailObjectType;
471 UINT16 Reserved;
472
473 } ACPI_PACKAGE_INFO3;
474
475 typedef union acpi_predefined_info
476 {
477 ACPI_NAME_INFO Info;
478 ACPI_PACKAGE_INFO RetInfo;
479 ACPI_PACKAGE_INFO2 RetInfo2;
480 ACPI_PACKAGE_INFO3 RetInfo3;
481
482 } ACPI_PREDEFINED_INFO;
483
484 /* Reset to default packing */
485
486 #pragma pack()
487
488
489 /* Return object auto-repair info */
490
491 typedef ACPI_STATUS (*ACPI_OBJECT_CONVERTER) (
492 union acpi_operand_object *OriginalObject,
493 union acpi_operand_object **ConvertedObject);
494
495 typedef struct acpi_simple_repair_info
496 {
497 char Name[ACPI_NAME_SIZE];
498 UINT32 UnexpectedBtypes;
499 UINT32 PackageIndex;
500 ACPI_OBJECT_CONVERTER ObjectConverter;
501
502 } ACPI_SIMPLE_REPAIR_INFO;
503
504
505 /*
506 * Bitmapped return value types
507 * Note: the actual data types must be contiguous, a loop in nspredef.c
508 * depends on this.
509 */
510 #define ACPI_RTYPE_ANY 0x00
511 #define ACPI_RTYPE_NONE 0x01
512 #define ACPI_RTYPE_INTEGER 0x02
513 #define ACPI_RTYPE_STRING 0x04
514 #define ACPI_RTYPE_BUFFER 0x08
515 #define ACPI_RTYPE_PACKAGE 0x10
516 #define ACPI_RTYPE_REFERENCE 0x20
517 #define ACPI_RTYPE_ALL 0x3F
518
519 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
520
521
522 /*****************************************************************************
523 *
524 * Event typedefs and structs
525 *
526 ****************************************************************************/
527
528 /* Dispatch info for each host-installed SCI handler */
529
530 typedef struct acpi_sci_handler_info
531 {
532 struct acpi_sci_handler_info *Next;
533 ACPI_SCI_HANDLER Address; /* Address of handler */
534 void *Context; /* Context to be passed to handler */
535
536 } ACPI_SCI_HANDLER_INFO;
537
538 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
539
540 typedef struct acpi_gpe_handler_info
541 {
542 ACPI_GPE_HANDLER Address; /* Address of handler, if any */
543 void *Context; /* Context to be passed to handler */
544 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level (saved) */
545 UINT8 OriginalFlags; /* Original (pre-handler) GPE info */
546 BOOLEAN OriginallyEnabled; /* True if GPE was originally enabled */
547
548 } ACPI_GPE_HANDLER_INFO;
549
550 /* Notify info for implicit notify, multiple device objects */
551
552 typedef struct acpi_gpe_notify_info
553 {
554 ACPI_NAMESPACE_NODE *DeviceNode; /* Device to be notified */
555 struct acpi_gpe_notify_info *Next;
556
557 } ACPI_GPE_NOTIFY_INFO;
558
559 /*
560 * GPE dispatch info. At any time, the GPE can have at most one type
561 * of dispatch - Method, Handler, or Implicit Notify.
562 */
563 typedef union acpi_gpe_dispatch_info
564 {
565 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level */
566 ACPI_GPE_HANDLER_INFO *Handler; /* Installed GPE handler */
567 ACPI_GPE_NOTIFY_INFO *NotifyList; /* List of _PRW devices for implicit notifies */
568
569 } ACPI_GPE_DISPATCH_INFO;
570
571 /*
572 * Information about a GPE, one per each GPE in an array.
573 * NOTE: Important to keep this struct as small as possible.
574 */
575 typedef struct acpi_gpe_event_info
576 {
577 union acpi_gpe_dispatch_info Dispatch; /* Either Method, Handler, or NotifyList */
578 struct acpi_gpe_register_info *RegisterInfo; /* Backpointer to register info */
579 UINT8 Flags; /* Misc info about this GPE */
580 UINT8 GpeNumber; /* This GPE */
581 UINT8 RuntimeCount; /* References to a run GPE */
582
583 } ACPI_GPE_EVENT_INFO;
584
585 /* Information about a GPE register pair, one per each status/enable pair in an array */
586
587 typedef struct acpi_gpe_register_info
588 {
589 ACPI_GENERIC_ADDRESS StatusAddress; /* Address of status reg */
590 ACPI_GENERIC_ADDRESS EnableAddress; /* Address of enable reg */
591 UINT8 EnableForWake; /* GPEs to keep enabled when sleeping */
592 UINT8 EnableForRun; /* GPEs to keep enabled when running */
593 UINT8 BaseGpeNumber; /* Base GPE number for this register */
594
595 } ACPI_GPE_REGISTER_INFO;
596
597 /*
598 * Information about a GPE register block, one per each installed block --
599 * GPE0, GPE1, and one per each installed GPE Block Device.
600 */
601 typedef struct acpi_gpe_block_info
602 {
603 ACPI_NAMESPACE_NODE *Node;
604 struct acpi_gpe_block_info *Previous;
605 struct acpi_gpe_block_info *Next;
606 struct acpi_gpe_xrupt_info *XruptBlock; /* Backpointer to interrupt block */
607 ACPI_GPE_REGISTER_INFO *RegisterInfo; /* One per GPE register pair */
608 ACPI_GPE_EVENT_INFO *EventInfo; /* One for each GPE */
609 ACPI_GENERIC_ADDRESS BlockAddress; /* Base address of the block */
610 UINT32 RegisterCount; /* Number of register pairs in block */
611 UINT16 GpeCount; /* Number of individual GPEs in block */
612 UINT8 BlockBaseNumber;/* Base GPE number for this block */
613 BOOLEAN Initialized; /* TRUE if this block is initialized */
614
615 } ACPI_GPE_BLOCK_INFO;
616
617 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
618
619 typedef struct acpi_gpe_xrupt_info
620 {
621 struct acpi_gpe_xrupt_info *Previous;
622 struct acpi_gpe_xrupt_info *Next;
623 ACPI_GPE_BLOCK_INFO *GpeBlockListHead; /* List of GPE blocks for this xrupt */
624 UINT32 InterruptNumber; /* System interrupt number */
625
626 } ACPI_GPE_XRUPT_INFO;
627
628 typedef struct acpi_gpe_walk_info
629 {
630 ACPI_NAMESPACE_NODE *GpeDevice;
631 ACPI_GPE_BLOCK_INFO *GpeBlock;
632 UINT16 Count;
633 ACPI_OWNER_ID OwnerId;
634 BOOLEAN ExecuteByOwnerId;
635
636 } ACPI_GPE_WALK_INFO;
637
638 typedef struct acpi_gpe_device_info
639 {
640 UINT32 Index;
641 UINT32 NextBlockBaseIndex;
642 ACPI_STATUS Status;
643 ACPI_NAMESPACE_NODE *GpeDevice;
644
645 } ACPI_GPE_DEVICE_INFO;
646
647 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
648 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
649 ACPI_GPE_BLOCK_INFO *GpeBlock,
650 void *Context);
651
652
653 /* Information about each particular fixed event */
654
655 typedef struct acpi_fixed_event_handler
656 {
657 ACPI_EVENT_HANDLER Handler; /* Address of handler. */
658 void *Context; /* Context to be passed to handler */
659
660 } ACPI_FIXED_EVENT_HANDLER;
661
662 typedef struct acpi_fixed_event_info
663 {
664 UINT8 StatusRegisterId;
665 UINT8 EnableRegisterId;
666 UINT16 StatusBitMask;
667 UINT16 EnableBitMask;
668
669 } ACPI_FIXED_EVENT_INFO;
670
671 /* Information used during field processing */
672
673 typedef struct acpi_field_info
674 {
675 UINT8 SkipField;
676 UINT8 FieldFlag;
677 UINT32 PkgLength;
678
679 } ACPI_FIELD_INFO;
680
681
682 /*****************************************************************************
683 *
684 * Generic "state" object for stacks
685 *
686 ****************************************************************************/
687
688 #define ACPI_CONTROL_NORMAL 0xC0
689 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
690 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
691 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
692 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
693
694
695 #define ACPI_STATE_COMMON \
696 void *Next; \
697 UINT8 DescriptorType; /* To differentiate various internal objs */\
698 UINT8 Flags; \
699 UINT16 Value; \
700 UINT16 State;
701
702 /* There are 2 bytes available here until the next natural alignment boundary */
703
704 typedef struct acpi_common_state
705 {
706 ACPI_STATE_COMMON
707 } ACPI_COMMON_STATE;
708
709
710 /*
711 * Update state - used to traverse complex objects such as packages
712 */
713 typedef struct acpi_update_state
714 {
715 ACPI_STATE_COMMON
716 union acpi_operand_object *Object;
717
718 } ACPI_UPDATE_STATE;
719
720
721 /*
722 * Pkg state - used to traverse nested package structures
723 */
724 typedef struct acpi_pkg_state
725 {
726 ACPI_STATE_COMMON
727 UINT16 Index;
728 union acpi_operand_object *SourceObject;
729 union acpi_operand_object *DestObject;
730 struct acpi_walk_state *WalkState;
731 void *ThisTargetObj;
732 UINT32 NumPackages;
733
734 } ACPI_PKG_STATE;
735
736
737 /*
738 * Control state - one per if/else and while constructs.
739 * Allows nesting of these constructs
740 */
741 typedef struct acpi_control_state
742 {
743 ACPI_STATE_COMMON
744 UINT16 Opcode;
745 union acpi_parse_object *PredicateOp;
746 UINT8 *AmlPredicateStart; /* Start of if/while predicate */
747 UINT8 *PackageEnd; /* End of if/while block */
748 UINT32 LoopCount; /* While() loop counter */
749
750 } ACPI_CONTROL_STATE;
751
752
753 /*
754 * Scope state - current scope during namespace lookups
755 */
756 typedef struct acpi_scope_state
757 {
758 ACPI_STATE_COMMON
759 ACPI_NAMESPACE_NODE *Node;
760
761 } ACPI_SCOPE_STATE;
762
763
764 typedef struct acpi_pscope_state
765 {
766 ACPI_STATE_COMMON
767 UINT32 ArgCount; /* Number of fixed arguments */
768 union acpi_parse_object *Op; /* Current op being parsed */
769 UINT8 *ArgEnd; /* Current argument end */
770 UINT8 *PkgEnd; /* Current package end */
771 UINT32 ArgList; /* Next argument to parse */
772
773 } ACPI_PSCOPE_STATE;
774
775
776 /*
777 * Thread state - one per thread across multiple walk states. Multiple walk
778 * states are created when there are nested control methods executing.
779 */
780 typedef struct acpi_thread_state
781 {
782 ACPI_STATE_COMMON
783 UINT8 CurrentSyncLevel; /* Mutex Sync (nested acquire) level */
784 struct acpi_walk_state *WalkStateList; /* Head of list of WalkStates for this thread */
785 union acpi_operand_object *AcquiredMutexList; /* List of all currently acquired mutexes */
786 ACPI_THREAD_ID ThreadId; /* Running thread ID */
787
788 } ACPI_THREAD_STATE;
789
790
791 /*
792 * Result values - used to accumulate the results of nested
793 * AML arguments
794 */
795 typedef struct acpi_result_values
796 {
797 ACPI_STATE_COMMON
798 union acpi_operand_object *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
799
800 } ACPI_RESULT_VALUES;
801
802
803 typedef
804 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
805 struct acpi_walk_state *WalkState,
806 union acpi_parse_object **OutOp);
807
808 typedef
809 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
810 struct acpi_walk_state *WalkState);
811
812
813 /* Global handlers for AML Notifies */
814
815 typedef struct acpi_global_notify_handler
816 {
817 ACPI_NOTIFY_HANDLER Handler;
818 void *Context;
819
820 } ACPI_GLOBAL_NOTIFY_HANDLER;
821
822 /*
823 * Notify info - used to pass info to the deferred notify
824 * handler/dispatcher.
825 */
826 typedef struct acpi_notify_info
827 {
828 ACPI_STATE_COMMON
829 UINT8 HandlerListId;
830 ACPI_NAMESPACE_NODE *Node;
831 union acpi_operand_object *HandlerListHead;
832 ACPI_GLOBAL_NOTIFY_HANDLER *Global;
833
834 } ACPI_NOTIFY_INFO;
835
836
837 /* Generic state is union of structs above */
838
839 typedef union acpi_generic_state
840 {
841 ACPI_COMMON_STATE Common;
842 ACPI_CONTROL_STATE Control;
843 ACPI_UPDATE_STATE Update;
844 ACPI_SCOPE_STATE Scope;
845 ACPI_PSCOPE_STATE ParseScope;
846 ACPI_PKG_STATE Pkg;
847 ACPI_THREAD_STATE Thread;
848 ACPI_RESULT_VALUES Results;
849 ACPI_NOTIFY_INFO Notify;
850
851 } ACPI_GENERIC_STATE;
852
853
854 /*****************************************************************************
855 *
856 * Interpreter typedefs and structs
857 *
858 ****************************************************************************/
859
860 typedef
861 ACPI_STATUS (*ACPI_EXECUTE_OP) (
862 struct acpi_walk_state *WalkState);
863
864 /* Address Range info block */
865
866 typedef struct acpi_address_range
867 {
868 struct acpi_address_range *Next;
869 ACPI_NAMESPACE_NODE *RegionNode;
870 ACPI_PHYSICAL_ADDRESS StartAddress;
871 ACPI_PHYSICAL_ADDRESS EndAddress;
872
873 } ACPI_ADDRESS_RANGE;
874
875
876 /*****************************************************************************
877 *
878 * Parser typedefs and structs
879 *
880 ****************************************************************************/
881
882 /*
883 * AML opcode, name, and argument layout
884 */
885 typedef struct acpi_opcode_info
886 {
887 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
888 char *Name; /* Opcode name (disassembler/debug only) */
889 #endif
890 UINT32 ParseArgs; /* Grammar/Parse time arguments */
891 UINT32 RuntimeArgs; /* Interpret time arguments */
892 UINT16 Flags; /* Misc flags */
893 UINT8 ObjectType; /* Corresponding internal object type */
894 UINT8 Class; /* Opcode class */
895 UINT8 Type; /* Opcode type */
896
897 } ACPI_OPCODE_INFO;
898
899 /* Structure for Resource Tag information */
900
901 typedef struct acpi_tag_info
902 {
903 UINT32 BitOffset;
904 UINT32 BitLength;
905
906 } ACPI_TAG_INFO;
907
908 /* Value associated with the parse object */
909
910 typedef union acpi_parse_value
911 {
912 UINT64 Integer; /* Integer constant (Up to 64 bits) */
913 UINT32 Size; /* bytelist or field size */
914 char *String; /* NULL terminated string */
915 UINT8 *Buffer; /* buffer or string */
916 char *Name; /* NULL terminated string */
917 union acpi_parse_object *Arg; /* arguments and contained ops */
918 ACPI_TAG_INFO Tag; /* Resource descriptor tag info */
919
920 } ACPI_PARSE_VALUE;
921
922
923 #ifdef ACPI_DISASSEMBLER
924 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
925 #else
926 #define ACPI_DISASM_ONLY_MEMBERS(a)
927 #endif
928
929 #define ACPI_PARSE_COMMON \
930 union acpi_parse_object *Parent; /* Parent op */\
931 UINT8 DescriptorType; /* To differentiate various internal objs */\
932 UINT8 Flags; /* Type of Op */\
933 UINT16 AmlOpcode; /* AML opcode */\
934 UINT32 AmlOffset; /* Offset of declaration in AML */\
935 union acpi_parse_object *Next; /* Next op */\
936 ACPI_NAMESPACE_NODE *Node; /* For use by interpreter */\
937 ACPI_PARSE_VALUE Value; /* Value or args associated with the opcode */\
938 UINT8 ArgListLength; /* Number of elements in the arg list */\
939 ACPI_DISASM_ONLY_MEMBERS (\
940 UINT8 DisasmFlags; /* Used during AML disassembly */\
941 UINT8 DisasmOpcode; /* Subtype used for disassembly */\
942 char AmlOpName[16]) /* Op name (debug only) */
943
944
945 /* Flags for DisasmFlags field above */
946
947 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
948 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
949 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
950 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
951 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
952 #define ACPI_DASM_EISAID 0x05 /* Integer is an EISAID */
953 #define ACPI_DASM_MATCHOP 0x06 /* Parent opcode is a Match() operator */
954 #define ACPI_DASM_LNOT_PREFIX 0x07 /* Start of a LNotEqual (etc.) pair of opcodes */
955 #define ACPI_DASM_LNOT_SUFFIX 0x08 /* End of a LNotEqual (etc.) pair of opcodes */
956 #define ACPI_DASM_HID_STRING 0x09 /* String is a _HID or _CID */
957 #define ACPI_DASM_IGNORE 0x0A /* Not used at this time */
958
959 /*
960 * Generic operation (for example: If, While, Store)
961 */
962 typedef struct acpi_parse_obj_common
963 {
964 ACPI_PARSE_COMMON
965 } ACPI_PARSE_OBJ_COMMON;
966
967
968 /*
969 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
970 * and bytelists.
971 */
972 typedef struct acpi_parse_obj_named
973 {
974 ACPI_PARSE_COMMON
975 UINT8 *Path;
976 UINT8 *Data; /* AML body or bytelist data */
977 UINT32 Length; /* AML length */
978 UINT32 Name; /* 4-byte name or zero if no name */
979
980 } ACPI_PARSE_OBJ_NAMED;
981
982
983 /* This version is used by the iASL compiler only */
984
985 #define ACPI_MAX_PARSEOP_NAME 20
986
987 typedef struct acpi_parse_obj_asl
988 {
989 ACPI_PARSE_COMMON
990 union acpi_parse_object *Child;
991 union acpi_parse_object *ParentMethod;
992 char *Filename;
993 char *ExternalName;
994 char *Namepath;
995 char NameSeg[4];
996 UINT32 ExtraValue;
997 UINT32 Column;
998 UINT32 LineNumber;
999 UINT32 LogicalLineNumber;
1000 UINT32 LogicalByteOffset;
1001 UINT32 EndLine;
1002 UINT32 EndLogicalLine;
1003 UINT32 AcpiBtype;
1004 UINT32 AmlLength;
1005 UINT32 AmlSubtreeLength;
1006 UINT32 FinalAmlLength;
1007 UINT32 FinalAmlOffset;
1008 UINT32 CompileFlags;
1009 UINT16 ParseOpcode;
1010 UINT8 AmlOpcodeLength;
1011 UINT8 AmlPkgLenBytes;
1012 UINT8 Extra;
1013 char ParseOpName[ACPI_MAX_PARSEOP_NAME];
1014
1015 } ACPI_PARSE_OBJ_ASL;
1016
1017 typedef union acpi_parse_object
1018 {
1019 ACPI_PARSE_OBJ_COMMON Common;
1020 ACPI_PARSE_OBJ_NAMED Named;
1021 ACPI_PARSE_OBJ_ASL Asl;
1022
1023 } ACPI_PARSE_OBJECT;
1024
1025
1026 /*
1027 * Parse state - one state per parser invocation and each control
1028 * method.
1029 */
1030 typedef struct acpi_parse_state
1031 {
1032 UINT8 *AmlStart; /* First AML byte */
1033 UINT8 *Aml; /* Next AML byte */
1034 UINT8 *AmlEnd; /* (last + 1) AML byte */
1035 UINT8 *PkgStart; /* Current package begin */
1036 UINT8 *PkgEnd; /* Current package end */
1037 union acpi_parse_object *StartOp; /* Root of parse tree */
1038 struct acpi_namespace_node *StartNode;
1039 union acpi_generic_state *Scope; /* Current scope */
1040 union acpi_parse_object *StartScope;
1041 UINT32 AmlSize;
1042
1043 } ACPI_PARSE_STATE;
1044
1045
1046 /* Parse object flags */
1047
1048 #define ACPI_PARSEOP_GENERIC 0x01
1049 #define ACPI_PARSEOP_NAMED 0x02
1050 #define ACPI_PARSEOP_DEFERRED 0x04
1051 #define ACPI_PARSEOP_BYTELIST 0x08
1052 #define ACPI_PARSEOP_IN_STACK 0x10
1053 #define ACPI_PARSEOP_TARGET 0x20
1054 #define ACPI_PARSEOP_IN_CACHE 0x80
1055
1056 /* Parse object DisasmFlags */
1057
1058 #define ACPI_PARSEOP_IGNORE 0x01
1059 #define ACPI_PARSEOP_PARAMLIST 0x02
1060 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
1061 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
1062 #define ACPI_PARSEOP_SPECIAL 0x10
1063
1064
1065 /*****************************************************************************
1066 *
1067 * Hardware (ACPI registers) and PNP
1068 *
1069 ****************************************************************************/
1070
1071 typedef struct acpi_bit_register_info
1072 {
1073 UINT8 ParentRegister;
1074 UINT8 BitPosition;
1075 UINT16 AccessBitMask;
1076
1077 } ACPI_BIT_REGISTER_INFO;
1078
1079
1080 /*
1081 * Some ACPI registers have bits that must be ignored -- meaning that they
1082 * must be preserved.
1083 */
1084 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
1085
1086 /* Write-only bits must be zeroed by software */
1087
1088 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
1089
1090 /* For control registers, both ignored and reserved bits must be preserved */
1091
1092 /*
1093 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1094 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1095 * bit position", section 4.7.3.2.1. However, on some machines the OS must
1096 * write a one to this bit after resume for the machine to work properly.
1097 * To enable this, we no longer attempt to preserve this bit. No machines
1098 * are known to fail if the bit is not preserved. (May 2009)
1099 */
1100 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
1101 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
1102 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1103 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1104
1105 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
1106
1107 /*
1108 * Register IDs
1109 * These are the full ACPI registers
1110 */
1111 #define ACPI_REGISTER_PM1_STATUS 0x01
1112 #define ACPI_REGISTER_PM1_ENABLE 0x02
1113 #define ACPI_REGISTER_PM1_CONTROL 0x03
1114 #define ACPI_REGISTER_PM2_CONTROL 0x04
1115 #define ACPI_REGISTER_PM_TIMER 0x05
1116 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
1117 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
1118
1119
1120 /* Masks used to access the BitRegisters */
1121
1122 #define ACPI_BITMASK_TIMER_STATUS 0x0001
1123 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
1124 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
1125 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
1126 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
1127 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
1128 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
1129 #define ACPI_BITMASK_WAKE_STATUS 0x8000
1130
1131 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
1132 ACPI_BITMASK_TIMER_STATUS | \
1133 ACPI_BITMASK_BUS_MASTER_STATUS | \
1134 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
1135 ACPI_BITMASK_POWER_BUTTON_STATUS | \
1136 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
1137 ACPI_BITMASK_RT_CLOCK_STATUS | \
1138 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
1139 ACPI_BITMASK_WAKE_STATUS)
1140
1141 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
1142 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
1143 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
1144 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
1145 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
1146 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
1147
1148 #define ACPI_BITMASK_SCI_ENABLE 0x0001
1149 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
1150 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
1151 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
1152 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
1153
1154 #define ACPI_BITMASK_ARB_DISABLE 0x0001
1155
1156
1157 /* Raw bit position of each BitRegister */
1158
1159 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
1160 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
1161 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
1162 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
1163 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
1164 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
1165 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
1166 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
1167
1168 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
1169 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
1170 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
1171 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
1172 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
1173 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
1174
1175 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
1176 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
1177 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
1178 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
1179 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
1180
1181 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
1182
1183
1184 /* Structs and definitions for _OSI support and I/O port validation */
1185
1186 #define ACPI_ALWAYS_ILLEGAL 0x00
1187
1188 typedef struct acpi_interface_info
1189 {
1190 char *Name;
1191 struct acpi_interface_info *Next;
1192 UINT8 Flags;
1193 UINT8 Value;
1194
1195 } ACPI_INTERFACE_INFO;
1196
1197 #define ACPI_OSI_INVALID 0x01
1198 #define ACPI_OSI_DYNAMIC 0x02
1199 #define ACPI_OSI_FEATURE 0x04
1200 #define ACPI_OSI_DEFAULT_INVALID 0x08
1201 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1202
1203 typedef struct acpi_port_info
1204 {
1205 char *Name;
1206 UINT16 Start;
1207 UINT16 End;
1208 UINT8 OsiDependency;
1209
1210 } ACPI_PORT_INFO;
1211
1212
1213 /*****************************************************************************
1214 *
1215 * Resource descriptors
1216 *
1217 ****************************************************************************/
1218
1219 /* ResourceType values */
1220
1221 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1222 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1223 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1224
1225 /* Resource descriptor types and masks */
1226
1227 #define ACPI_RESOURCE_NAME_LARGE 0x80
1228 #define ACPI_RESOURCE_NAME_SMALL 0x00
1229
1230 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1231 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1232 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1233
1234
1235 /*
1236 * Small resource descriptor "names" as defined by the ACPI specification.
1237 * Note: Bits 2:0 are used for the descriptor length
1238 */
1239 #define ACPI_RESOURCE_NAME_IRQ 0x20
1240 #define ACPI_RESOURCE_NAME_DMA 0x28
1241 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1242 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1243 #define ACPI_RESOURCE_NAME_IO 0x40
1244 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1245 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1246 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1247 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1248 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1249 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1250 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1251
1252 /*
1253 * Large resource descriptor "names" as defined by the ACPI specification.
1254 * Note: includes the Large Descriptor bit in bit[7]
1255 */
1256 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1257 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1258 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1259 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1260 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1261 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1262 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1263 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1264 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1265 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1266 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1267 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1268 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1269 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1270
1271
1272 /*****************************************************************************
1273 *
1274 * Miscellaneous
1275 *
1276 ****************************************************************************/
1277
1278 #define ACPI_ASCII_ZERO 0x30
1279
1280
1281 /*****************************************************************************
1282 *
1283 * Disassembler
1284 *
1285 ****************************************************************************/
1286
1287 typedef struct acpi_external_list
1288 {
1289 char *Path;
1290 char *InternalPath;
1291 struct acpi_external_list *Next;
1292 UINT32 Value;
1293 UINT16 Length;
1294 UINT16 Flags;
1295 UINT8 Type;
1296
1297 } ACPI_EXTERNAL_LIST;
1298
1299 /* Values for Flags field above */
1300
1301 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1302 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1303 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1304 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1305
1306
1307 typedef struct acpi_external_file
1308 {
1309 char *Path;
1310 struct acpi_external_file *Next;
1311
1312 } ACPI_EXTERNAL_FILE;
1313
1314
1315 /*****************************************************************************
1316 *
1317 * Debugger
1318 *
1319 ****************************************************************************/
1320
1321 typedef struct acpi_db_method_info
1322 {
1323 ACPI_HANDLE Method;
1324 ACPI_HANDLE MainThreadGate;
1325 ACPI_HANDLE ThreadCompleteGate;
1326 ACPI_HANDLE InfoGate;
1327 ACPI_THREAD_ID *Threads;
1328 UINT32 NumThreads;
1329 UINT32 NumCreated;
1330 UINT32 NumCompleted;
1331
1332 char *Name;
1333 UINT32 Flags;
1334 UINT32 NumLoops;
1335 char Pathname[ACPI_DB_LINE_BUFFER_SIZE];
1336 char **Args;
1337 ACPI_OBJECT_TYPE *Types;
1338
1339 /*
1340 * Arguments to be passed to method for the command
1341 * Threads -
1342 * the Number of threads, ID of current thread and
1343 * Index of current thread inside all them created.
1344 */
1345 char InitArgs;
1346 ACPI_OBJECT_TYPE ArgTypes[4];
1347 char *Arguments[4];
1348 char NumThreadsStr[11];
1349 char IdOfThreadStr[11];
1350 char IndexOfThreadStr[11];
1351
1352 } ACPI_DB_METHOD_INFO;
1353
1354 typedef struct acpi_integrity_info
1355 {
1356 UINT32 Nodes;
1357 UINT32 Objects;
1358
1359 } ACPI_INTEGRITY_INFO;
1360
1361
1362 #define ACPI_DB_DISABLE_OUTPUT 0x00
1363 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1364 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1365 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1366
1367
1368 /*****************************************************************************
1369 *
1370 * Debug
1371 *
1372 ****************************************************************************/
1373
1374 /* Entry for a memory allocation (debug only) */
1375
1376 #define ACPI_MEM_MALLOC 0
1377 #define ACPI_MEM_CALLOC 1
1378 #define ACPI_MAX_MODULE_NAME 16
1379
1380 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1381 struct acpi_debug_mem_block *Previous; \
1382 struct acpi_debug_mem_block *Next; \
1383 UINT32 Size; \
1384 UINT32 Component; \
1385 UINT32 Line; \
1386 char Module[ACPI_MAX_MODULE_NAME]; \
1387 UINT8 AllocType;
1388
1389 typedef struct acpi_debug_mem_header
1390 {
1391 ACPI_COMMON_DEBUG_MEM_HEADER
1392
1393 } ACPI_DEBUG_MEM_HEADER;
1394
1395 typedef struct acpi_debug_mem_block
1396 {
1397 ACPI_COMMON_DEBUG_MEM_HEADER
1398 UINT64 UserSpace;
1399
1400 } ACPI_DEBUG_MEM_BLOCK;
1401
1402
1403 #define ACPI_MEM_LIST_GLOBAL 0
1404 #define ACPI_MEM_LIST_NSNODE 1
1405 #define ACPI_MEM_LIST_MAX 1
1406 #define ACPI_NUM_MEM_LISTS 2
1407
1408
1409 /*****************************************************************************
1410 *
1411 * Info/help support
1412 *
1413 ****************************************************************************/
1414
1415 typedef struct ah_predefined_name
1416 {
1417 char *Name;
1418 char *Description;
1419 #ifndef ACPI_ASL_COMPILER
1420 char *Action;
1421 #endif
1422
1423 } AH_PREDEFINED_NAME;
1424
1425 typedef struct ah_device_id
1426 {
1427 char *Name;
1428 char *Description;
1429
1430 } AH_DEVICE_ID;
1431
1432 #endif /* __ACLOCAL_H__ */