projects / reactos.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
[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 - 2015, 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 0x82
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 UINT16 PinNumberIndex;
367 UINT8 FieldFlags;
368 UINT8 Attribute;
369 UINT8 FieldType;
370 UINT8 AccessLength;
371
372 } ACPI_CREATE_FIELD_INFO;
373
374
375 typedef
376 ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
377 struct acpi_walk_state *WalkState);
378
379
380 /*
381 * Bitmapped ACPI types. Used internally only
382 */
383 #define ACPI_BTYPE_ANY 0x00000000
384 #define ACPI_BTYPE_INTEGER 0x00000001
385 #define ACPI_BTYPE_STRING 0x00000002
386 #define ACPI_BTYPE_BUFFER 0x00000004
387 #define ACPI_BTYPE_PACKAGE 0x00000008
388 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
389 #define ACPI_BTYPE_DEVICE 0x00000020
390 #define ACPI_BTYPE_EVENT 0x00000040
391 #define ACPI_BTYPE_METHOD 0x00000080
392 #define ACPI_BTYPE_MUTEX 0x00000100
393 #define ACPI_BTYPE_REGION 0x00000200
394 #define ACPI_BTYPE_POWER 0x00000400
395 #define ACPI_BTYPE_PROCESSOR 0x00000800
396 #define ACPI_BTYPE_THERMAL 0x00001000
397 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
398 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
399 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
400 #define ACPI_BTYPE_REFERENCE 0x00010000
401 #define ACPI_BTYPE_RESOURCE 0x00020000
402
403 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
404
405 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
406 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
407 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
408 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
409 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
410
411 #pragma pack(1)
412
413 /*
414 * Information structure for ACPI predefined names.
415 * Each entry in the table contains the following items:
416 *
417 * Name - The ACPI reserved name
418 * ParamCount - Number of arguments to the method
419 * ExpectedReturnBtypes - Allowed type(s) for the return value
420 */
421 typedef struct acpi_name_info
422 {
423 char Name[ACPI_NAME_SIZE];
424 UINT16 ArgumentList;
425 UINT8 ExpectedBtypes;
426
427 } ACPI_NAME_INFO;
428
429 /*
430 * Secondary information structures for ACPI predefined objects that return
431 * package objects. This structure appears as the next entry in the table
432 * after the NAME_INFO structure above.
433 *
434 * The reason for this is to minimize the size of the predefined name table.
435 */
436
437 /*
438 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
439 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
440 * ACPI_PTYPE2_FIX_VAR
441 */
442 typedef struct acpi_package_info
443 {
444 UINT8 Type;
445 UINT8 ObjectType1;
446 UINT8 Count1;
447 UINT8 ObjectType2;
448 UINT8 Count2;
449 UINT16 Reserved;
450
451 } ACPI_PACKAGE_INFO;
452
453 /* Used for ACPI_PTYPE2_FIXED */
454
455 typedef struct acpi_package_info2
456 {
457 UINT8 Type;
458 UINT8 Count;
459 UINT8 ObjectType[4];
460 UINT8 Reserved;
461
462 } ACPI_PACKAGE_INFO2;
463
464 /* Used for ACPI_PTYPE1_OPTION */
465
466 typedef struct acpi_package_info3
467 {
468 UINT8 Type;
469 UINT8 Count;
470 UINT8 ObjectType[2];
471 UINT8 TailObjectType;
472 UINT16 Reserved;
473
474 } ACPI_PACKAGE_INFO3;
475
476 typedef union acpi_predefined_info
477 {
478 ACPI_NAME_INFO Info;
479 ACPI_PACKAGE_INFO RetInfo;
480 ACPI_PACKAGE_INFO2 RetInfo2;
481 ACPI_PACKAGE_INFO3 RetInfo3;
482
483 } ACPI_PREDEFINED_INFO;
484
485 /* Reset to default packing */
486
487 #pragma pack()
488
489
490 /* Return object auto-repair info */
491
492 typedef ACPI_STATUS (*ACPI_OBJECT_CONVERTER) (
493 union acpi_operand_object *OriginalObject,
494 union acpi_operand_object **ConvertedObject);
495
496 typedef struct acpi_simple_repair_info
497 {
498 char Name[ACPI_NAME_SIZE];
499 UINT32 UnexpectedBtypes;
500 UINT32 PackageIndex;
501 ACPI_OBJECT_CONVERTER ObjectConverter;
502
503 } ACPI_SIMPLE_REPAIR_INFO;
504
505
506 /*
507 * Bitmapped return value types
508 * Note: the actual data types must be contiguous, a loop in nspredef.c
509 * depends on this.
510 */
511 #define ACPI_RTYPE_ANY 0x00
512 #define ACPI_RTYPE_NONE 0x01
513 #define ACPI_RTYPE_INTEGER 0x02
514 #define ACPI_RTYPE_STRING 0x04
515 #define ACPI_RTYPE_BUFFER 0x08
516 #define ACPI_RTYPE_PACKAGE 0x10
517 #define ACPI_RTYPE_REFERENCE 0x20
518 #define ACPI_RTYPE_ALL 0x3F
519
520 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */
521
522
523 /*****************************************************************************
524 *
525 * Event typedefs and structs
526 *
527 ****************************************************************************/
528
529 /* Dispatch info for each host-installed SCI handler */
530
531 typedef struct acpi_sci_handler_info
532 {
533 struct acpi_sci_handler_info *Next;
534 ACPI_SCI_HANDLER Address; /* Address of handler */
535 void *Context; /* Context to be passed to handler */
536
537 } ACPI_SCI_HANDLER_INFO;
538
539 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
540
541 typedef struct acpi_gpe_handler_info
542 {
543 ACPI_GPE_HANDLER Address; /* Address of handler, if any */
544 void *Context; /* Context to be passed to handler */
545 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level (saved) */
546 UINT8 OriginalFlags; /* Original (pre-handler) GPE info */
547 BOOLEAN OriginallyEnabled; /* True if GPE was originally enabled */
548
549 } ACPI_GPE_HANDLER_INFO;
550
551 /* Notify info for implicit notify, multiple device objects */
552
553 typedef struct acpi_gpe_notify_info
554 {
555 ACPI_NAMESPACE_NODE *DeviceNode; /* Device to be notified */
556 struct acpi_gpe_notify_info *Next;
557
558 } ACPI_GPE_NOTIFY_INFO;
559
560 /*
561 * GPE dispatch info. At any time, the GPE can have at most one type
562 * of dispatch - Method, Handler, or Implicit Notify.
563 */
564 typedef union acpi_gpe_dispatch_info
565 {
566 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level */
567 ACPI_GPE_HANDLER_INFO *Handler; /* Installed GPE handler */
568 ACPI_GPE_NOTIFY_INFO *NotifyList; /* List of _PRW devices for implicit notifies */
569
570 } ACPI_GPE_DISPATCH_INFO;
571
572 /*
573 * Information about a GPE, one per each GPE in an array.
574 * NOTE: Important to keep this struct as small as possible.
575 */
576 typedef struct acpi_gpe_event_info
577 {
578 union acpi_gpe_dispatch_info Dispatch; /* Either Method, Handler, or NotifyList */
579 struct acpi_gpe_register_info *RegisterInfo; /* Backpointer to register info */
580 UINT8 Flags; /* Misc info about this GPE */
581 UINT8 GpeNumber; /* This GPE */
582 UINT8 RuntimeCount; /* References to a run GPE */
583
584 } ACPI_GPE_EVENT_INFO;
585
586 /* Information about a GPE register pair, one per each status/enable pair in an array */
587
588 typedef struct acpi_gpe_register_info
589 {
590 ACPI_GENERIC_ADDRESS StatusAddress; /* Address of status reg */
591 ACPI_GENERIC_ADDRESS EnableAddress; /* Address of enable reg */
592 UINT16 BaseGpeNumber; /* Base GPE number for this register */
593 UINT8 EnableForWake; /* GPEs to keep enabled when sleeping */
594 UINT8 EnableForRun; /* GPEs to keep enabled when running */
595 UINT8 EnableMask; /* Current mask of enabled GPEs */
596
597 } ACPI_GPE_REGISTER_INFO;
598
599 /*
600 * Information about a GPE register block, one per each installed block --
601 * GPE0, GPE1, and one per each installed GPE Block Device.
602 */
603 typedef struct acpi_gpe_block_info
604 {
605 ACPI_NAMESPACE_NODE *Node;
606 struct acpi_gpe_block_info *Previous;
607 struct acpi_gpe_block_info *Next;
608 struct acpi_gpe_xrupt_info *XruptBlock; /* Backpointer to interrupt block */
609 ACPI_GPE_REGISTER_INFO *RegisterInfo; /* One per GPE register pair */
610 ACPI_GPE_EVENT_INFO *EventInfo; /* One for each GPE */
611 UINT64 Address; /* Base address of the block */
612 UINT32 RegisterCount; /* Number of register pairs in block */
613 UINT16 GpeCount; /* Number of individual GPEs in block */
614 UINT16 BlockBaseNumber;/* Base GPE number for this block */
615 UINT8 SpaceId;
616 BOOLEAN Initialized; /* TRUE if this block is initialized */
617
618 } ACPI_GPE_BLOCK_INFO;
619
620 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
621
622 typedef struct acpi_gpe_xrupt_info
623 {
624 struct acpi_gpe_xrupt_info *Previous;
625 struct acpi_gpe_xrupt_info *Next;
626 ACPI_GPE_BLOCK_INFO *GpeBlockListHead; /* List of GPE blocks for this xrupt */
627 UINT32 InterruptNumber; /* System interrupt number */
628
629 } ACPI_GPE_XRUPT_INFO;
630
631 typedef struct acpi_gpe_walk_info
632 {
633 ACPI_NAMESPACE_NODE *GpeDevice;
634 ACPI_GPE_BLOCK_INFO *GpeBlock;
635 UINT16 Count;
636 ACPI_OWNER_ID OwnerId;
637 BOOLEAN ExecuteByOwnerId;
638
639 } ACPI_GPE_WALK_INFO;
640
641 typedef struct acpi_gpe_device_info
642 {
643 UINT32 Index;
644 UINT32 NextBlockBaseIndex;
645 ACPI_STATUS Status;
646 ACPI_NAMESPACE_NODE *GpeDevice;
647
648 } ACPI_GPE_DEVICE_INFO;
649
650 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
651 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
652 ACPI_GPE_BLOCK_INFO *GpeBlock,
653 void *Context);
654
655
656 /* Information about each particular fixed event */
657
658 typedef struct acpi_fixed_event_handler
659 {
660 ACPI_EVENT_HANDLER Handler; /* Address of handler. */
661 void *Context; /* Context to be passed to handler */
662
663 } ACPI_FIXED_EVENT_HANDLER;
664
665 typedef struct acpi_fixed_event_info
666 {
667 UINT8 StatusRegisterId;
668 UINT8 EnableRegisterId;
669 UINT16 StatusBitMask;
670 UINT16 EnableBitMask;
671
672 } ACPI_FIXED_EVENT_INFO;
673
674 /* Information used during field processing */
675
676 typedef struct acpi_field_info
677 {
678 UINT8 SkipField;
679 UINT8 FieldFlag;
680 UINT32 PkgLength;
681
682 } ACPI_FIELD_INFO;
683
684
685 /*****************************************************************************
686 *
687 * Generic "state" object for stacks
688 *
689 ****************************************************************************/
690
691 #define ACPI_CONTROL_NORMAL 0xC0
692 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1
693 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2
694 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3
695 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4
696
697
698 #define ACPI_STATE_COMMON \
699 void *Next; \
700 UINT8 DescriptorType; /* To differentiate various internal objs */\
701 UINT8 Flags; \
702 UINT16 Value; \
703 UINT16 State;
704
705 /* There are 2 bytes available here until the next natural alignment boundary */
706
707 typedef struct acpi_common_state
708 {
709 ACPI_STATE_COMMON
710 } ACPI_COMMON_STATE;
711
712
713 /*
714 * Update state - used to traverse complex objects such as packages
715 */
716 typedef struct acpi_update_state
717 {
718 ACPI_STATE_COMMON
719 union acpi_operand_object *Object;
720
721 } ACPI_UPDATE_STATE;
722
723
724 /*
725 * Pkg state - used to traverse nested package structures
726 */
727 typedef struct acpi_pkg_state
728 {
729 ACPI_STATE_COMMON
730 UINT16 Index;
731 union acpi_operand_object *SourceObject;
732 union acpi_operand_object *DestObject;
733 struct acpi_walk_state *WalkState;
734 void *ThisTargetObj;
735 UINT32 NumPackages;
736
737 } ACPI_PKG_STATE;
738
739
740 /*
741 * Control state - one per if/else and while constructs.
742 * Allows nesting of these constructs
743 */
744 typedef struct acpi_control_state
745 {
746 ACPI_STATE_COMMON
747 UINT16 Opcode;
748 union acpi_parse_object *PredicateOp;
749 UINT8 *AmlPredicateStart; /* Start of if/while predicate */
750 UINT8 *PackageEnd; /* End of if/while block */
751 UINT32 LoopCount; /* While() loop counter */
752
753 } ACPI_CONTROL_STATE;
754
755
756 /*
757 * Scope state - current scope during namespace lookups
758 */
759 typedef struct acpi_scope_state
760 {
761 ACPI_STATE_COMMON
762 ACPI_NAMESPACE_NODE *Node;
763
764 } ACPI_SCOPE_STATE;
765
766
767 typedef struct acpi_pscope_state
768 {
769 ACPI_STATE_COMMON
770 UINT32 ArgCount; /* Number of fixed arguments */
771 union acpi_parse_object *Op; /* Current op being parsed */
772 UINT8 *ArgEnd; /* Current argument end */
773 UINT8 *PkgEnd; /* Current package end */
774 UINT32 ArgList; /* Next argument to parse */
775
776 } ACPI_PSCOPE_STATE;
777
778
779 /*
780 * Thread state - one per thread across multiple walk states. Multiple walk
781 * states are created when there are nested control methods executing.
782 */
783 typedef struct acpi_thread_state
784 {
785 ACPI_STATE_COMMON
786 UINT8 CurrentSyncLevel; /* Mutex Sync (nested acquire) level */
787 struct acpi_walk_state *WalkStateList; /* Head of list of WalkStates for this thread */
788 union acpi_operand_object *AcquiredMutexList; /* List of all currently acquired mutexes */
789 ACPI_THREAD_ID ThreadId; /* Running thread ID */
790
791 } ACPI_THREAD_STATE;
792
793
794 /*
795 * Result values - used to accumulate the results of nested
796 * AML arguments
797 */
798 typedef struct acpi_result_values
799 {
800 ACPI_STATE_COMMON
801 union acpi_operand_object *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
802
803 } ACPI_RESULT_VALUES;
804
805
806 typedef
807 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
808 struct acpi_walk_state *WalkState,
809 union acpi_parse_object **OutOp);
810
811 typedef
812 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
813 struct acpi_walk_state *WalkState);
814
815
816 /* Global handlers for AML Notifies */
817
818 typedef struct acpi_global_notify_handler
819 {
820 ACPI_NOTIFY_HANDLER Handler;
821 void *Context;
822
823 } ACPI_GLOBAL_NOTIFY_HANDLER;
824
825 /*
826 * Notify info - used to pass info to the deferred notify
827 * handler/dispatcher.
828 */
829 typedef struct acpi_notify_info
830 {
831 ACPI_STATE_COMMON
832 UINT8 HandlerListId;
833 ACPI_NAMESPACE_NODE *Node;
834 union acpi_operand_object *HandlerListHead;
835 ACPI_GLOBAL_NOTIFY_HANDLER *Global;
836
837 } ACPI_NOTIFY_INFO;
838
839
840 /* Generic state is union of structs above */
841
842 typedef union acpi_generic_state
843 {
844 ACPI_COMMON_STATE Common;
845 ACPI_CONTROL_STATE Control;
846 ACPI_UPDATE_STATE Update;
847 ACPI_SCOPE_STATE Scope;
848 ACPI_PSCOPE_STATE ParseScope;
849 ACPI_PKG_STATE Pkg;
850 ACPI_THREAD_STATE Thread;
851 ACPI_RESULT_VALUES Results;
852 ACPI_NOTIFY_INFO Notify;
853
854 } ACPI_GENERIC_STATE;
855
856
857 /*****************************************************************************
858 *
859 * Interpreter typedefs and structs
860 *
861 ****************************************************************************/
862
863 typedef
864 ACPI_STATUS (*ACPI_EXECUTE_OP) (
865 struct acpi_walk_state *WalkState);
866
867 /* Address Range info block */
868
869 typedef struct acpi_address_range
870 {
871 struct acpi_address_range *Next;
872 ACPI_NAMESPACE_NODE *RegionNode;
873 ACPI_PHYSICAL_ADDRESS StartAddress;
874 ACPI_PHYSICAL_ADDRESS EndAddress;
875
876 } ACPI_ADDRESS_RANGE;
877
878
879 /*****************************************************************************
880 *
881 * Parser typedefs and structs
882 *
883 ****************************************************************************/
884
885 /*
886 * AML opcode, name, and argument layout
887 */
888 typedef struct acpi_opcode_info
889 {
890 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
891 char *Name; /* Opcode name (disassembler/debug only) */
892 #endif
893 UINT32 ParseArgs; /* Grammar/Parse time arguments */
894 UINT32 RuntimeArgs; /* Interpret time arguments */
895 UINT16 Flags; /* Misc flags */
896 UINT8 ObjectType; /* Corresponding internal object type */
897 UINT8 Class; /* Opcode class */
898 UINT8 Type; /* Opcode type */
899
900 } ACPI_OPCODE_INFO;
901
902 /* Structure for Resource Tag information */
903
904 typedef struct acpi_tag_info
905 {
906 UINT32 BitOffset;
907 UINT32 BitLength;
908
909 } ACPI_TAG_INFO;
910
911 /* Value associated with the parse object */
912
913 typedef union acpi_parse_value
914 {
915 UINT64 Integer; /* Integer constant (Up to 64 bits) */
916 UINT32 Size; /* bytelist or field size */
917 char *String; /* NULL terminated string */
918 UINT8 *Buffer; /* buffer or string */
919 char *Name; /* NULL terminated string */
920 union acpi_parse_object *Arg; /* arguments and contained ops */
921 ACPI_TAG_INFO Tag; /* Resource descriptor tag info */
922
923 } ACPI_PARSE_VALUE;
924
925
926 #ifdef ACPI_DISASSEMBLER
927 #define ACPI_DISASM_ONLY_MEMBERS(a) a;
928 #else
929 #define ACPI_DISASM_ONLY_MEMBERS(a)
930 #endif
931
932 #define ACPI_PARSE_COMMON \
933 union acpi_parse_object *Parent; /* Parent op */\
934 UINT8 DescriptorType; /* To differentiate various internal objs */\
935 UINT8 Flags; /* Type of Op */\
936 UINT16 AmlOpcode; /* AML opcode */\
937 UINT32 AmlOffset; /* Offset of declaration in AML */\
938 union acpi_parse_object *Next; /* Next op */\
939 ACPI_NAMESPACE_NODE *Node; /* For use by interpreter */\
940 ACPI_PARSE_VALUE Value; /* Value or args associated with the opcode */\
941 UINT8 ArgListLength; /* Number of elements in the arg list */\
942 ACPI_DISASM_ONLY_MEMBERS (\
943 UINT8 DisasmFlags; /* Used during AML disassembly */\
944 UINT8 DisasmOpcode; /* Subtype used for disassembly */\
945 char *OperatorSymbol;/* Used for C-style operator name strings */\
946 char AmlOpName[16]) /* Op name (debug only) */
947
948
949 /* Flags for DisasmFlags field above */
950
951 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */
952 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */
953 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */
954 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */
955 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */
956 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */
957 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */
958 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */
959 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a LNotEqual (etc.) pair of opcodes */
960 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a LNotEqual (etc.) pair of opcodes */
961 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */
962 #define ACPI_DASM_IGNORE 0x0B /* Not used at this time */
963
964 /*
965 * Generic operation (for example: If, While, Store)
966 */
967 typedef struct acpi_parse_obj_common
968 {
969 ACPI_PARSE_COMMON
970 } ACPI_PARSE_OBJ_COMMON;
971
972
973 /*
974 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
975 * and bytelists.
976 */
977 typedef struct acpi_parse_obj_named
978 {
979 ACPI_PARSE_COMMON
980 UINT8 *Path;
981 UINT8 *Data; /* AML body or bytelist data */
982 UINT32 Length; /* AML length */
983 UINT32 Name; /* 4-byte name or zero if no name */
984
985 } ACPI_PARSE_OBJ_NAMED;
986
987
988 /* This version is used by the iASL compiler only */
989
990 #define ACPI_MAX_PARSEOP_NAME 20
991
992 typedef struct acpi_parse_obj_asl
993 {
994 ACPI_PARSE_COMMON
995 union acpi_parse_object *Child;
996 union acpi_parse_object *ParentMethod;
997 char *Filename;
998 char *ExternalName;
999 char *Namepath;
1000 char NameSeg[4];
1001 UINT32 ExtraValue;
1002 UINT32 Column;
1003 UINT32 LineNumber;
1004 UINT32 LogicalLineNumber;
1005 UINT32 LogicalByteOffset;
1006 UINT32 EndLine;
1007 UINT32 EndLogicalLine;
1008 UINT32 AcpiBtype;
1009 UINT32 AmlLength;
1010 UINT32 AmlSubtreeLength;
1011 UINT32 FinalAmlLength;
1012 UINT32 FinalAmlOffset;
1013 UINT32 CompileFlags;
1014 UINT16 ParseOpcode;
1015 UINT8 AmlOpcodeLength;
1016 UINT8 AmlPkgLenBytes;
1017 UINT8 Extra;
1018 char ParseOpName[ACPI_MAX_PARSEOP_NAME];
1019
1020 } ACPI_PARSE_OBJ_ASL;
1021
1022 typedef union acpi_parse_object
1023 {
1024 ACPI_PARSE_OBJ_COMMON Common;
1025 ACPI_PARSE_OBJ_NAMED Named;
1026 ACPI_PARSE_OBJ_ASL Asl;
1027
1028 } ACPI_PARSE_OBJECT;
1029
1030
1031 /*
1032 * Parse state - one state per parser invocation and each control
1033 * method.
1034 */
1035 typedef struct acpi_parse_state
1036 {
1037 UINT8 *AmlStart; /* First AML byte */
1038 UINT8 *Aml; /* Next AML byte */
1039 UINT8 *AmlEnd; /* (last + 1) AML byte */
1040 UINT8 *PkgStart; /* Current package begin */
1041 UINT8 *PkgEnd; /* Current package end */
1042 union acpi_parse_object *StartOp; /* Root of parse tree */
1043 struct acpi_namespace_node *StartNode;
1044 union acpi_generic_state *Scope; /* Current scope */
1045 union acpi_parse_object *StartScope;
1046 UINT32 AmlSize;
1047
1048 } ACPI_PARSE_STATE;
1049
1050
1051 /* Parse object flags */
1052
1053 #define ACPI_PARSEOP_GENERIC 0x01
1054 #define ACPI_PARSEOP_NAMED 0x02
1055 #define ACPI_PARSEOP_DEFERRED 0x04
1056 #define ACPI_PARSEOP_BYTELIST 0x08
1057 #define ACPI_PARSEOP_IN_STACK 0x10
1058 #define ACPI_PARSEOP_TARGET 0x20
1059 #define ACPI_PARSEOP_IN_CACHE 0x80
1060
1061 /* Parse object DisasmFlags */
1062
1063 #define ACPI_PARSEOP_IGNORE 0x01
1064 #define ACPI_PARSEOP_PARAMLIST 0x02
1065 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04
1066 #define ACPI_PARSEOP_PREDEF_CHECKED 0x08
1067 #define ACPI_PARSEOP_SPECIAL 0x10
1068 #define ACPI_PARSEOP_COMPOUND 0x20
1069 #define ACPI_PARSEOP_ASSIGNMENT 0x40
1070
1071
1072 /*****************************************************************************
1073 *
1074 * Hardware (ACPI registers) and PNP
1075 *
1076 ****************************************************************************/
1077
1078 typedef struct acpi_bit_register_info
1079 {
1080 UINT8 ParentRegister;
1081 UINT8 BitPosition;
1082 UINT16 AccessBitMask;
1083
1084 } ACPI_BIT_REGISTER_INFO;
1085
1086
1087 /*
1088 * Some ACPI registers have bits that must be ignored -- meaning that they
1089 * must be preserved.
1090 */
1091 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */
1092
1093 /* Write-only bits must be zeroed by software */
1094
1095 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */
1096
1097 /* For control registers, both ignored and reserved bits must be preserved */
1098
1099 /*
1100 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1101 * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1102 * bit position", section 4.7.3.2.1. However, on some machines the OS must
1103 * write a one to this bit after resume for the machine to work properly.
1104 * To enable this, we no longer attempt to preserve this bit. No machines
1105 * are known to fail if the bit is not preserved. (May 2009)
1106 */
1107 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */
1108 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */
1109 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1110 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1111
1112 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */
1113
1114 /*
1115 * Register IDs
1116 * These are the full ACPI registers
1117 */
1118 #define ACPI_REGISTER_PM1_STATUS 0x01
1119 #define ACPI_REGISTER_PM1_ENABLE 0x02
1120 #define ACPI_REGISTER_PM1_CONTROL 0x03
1121 #define ACPI_REGISTER_PM2_CONTROL 0x04
1122 #define ACPI_REGISTER_PM_TIMER 0x05
1123 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06
1124 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07
1125
1126
1127 /* Masks used to access the BitRegisters */
1128
1129 #define ACPI_BITMASK_TIMER_STATUS 0x0001
1130 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010
1131 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020
1132 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100
1133 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200
1134 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400
1135 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */
1136 #define ACPI_BITMASK_WAKE_STATUS 0x8000
1137
1138 #define ACPI_BITMASK_ALL_FIXED_STATUS (\
1139 ACPI_BITMASK_TIMER_STATUS | \
1140 ACPI_BITMASK_BUS_MASTER_STATUS | \
1141 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \
1142 ACPI_BITMASK_POWER_BUTTON_STATUS | \
1143 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \
1144 ACPI_BITMASK_RT_CLOCK_STATUS | \
1145 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \
1146 ACPI_BITMASK_WAKE_STATUS)
1147
1148 #define ACPI_BITMASK_TIMER_ENABLE 0x0001
1149 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020
1150 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100
1151 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200
1152 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400
1153 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */
1154
1155 #define ACPI_BITMASK_SCI_ENABLE 0x0001
1156 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002
1157 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004
1158 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00
1159 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000
1160
1161 #define ACPI_BITMASK_ARB_DISABLE 0x0001
1162
1163
1164 /* Raw bit position of each BitRegister */
1165
1166 #define ACPI_BITPOSITION_TIMER_STATUS 0x00
1167 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04
1168 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05
1169 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08
1170 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09
1171 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A
1172 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */
1173 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F
1174
1175 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00
1176 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05
1177 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08
1178 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09
1179 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A
1180 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */
1181
1182 #define ACPI_BITPOSITION_SCI_ENABLE 0x00
1183 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01
1184 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02
1185 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A
1186 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D
1187
1188 #define ACPI_BITPOSITION_ARB_DISABLE 0x00
1189
1190
1191 /* Structs and definitions for _OSI support and I/O port validation */
1192
1193 #define ACPI_ALWAYS_ILLEGAL 0x00
1194
1195 typedef struct acpi_interface_info
1196 {
1197 char *Name;
1198 struct acpi_interface_info *Next;
1199 UINT8 Flags;
1200 UINT8 Value;
1201
1202 } ACPI_INTERFACE_INFO;
1203
1204 #define ACPI_OSI_INVALID 0x01
1205 #define ACPI_OSI_DYNAMIC 0x02
1206 #define ACPI_OSI_FEATURE 0x04
1207 #define ACPI_OSI_DEFAULT_INVALID 0x08
1208 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1209
1210 typedef struct acpi_port_info
1211 {
1212 char *Name;
1213 UINT16 Start;
1214 UINT16 End;
1215 UINT8 OsiDependency;
1216
1217 } ACPI_PORT_INFO;
1218
1219
1220 /*****************************************************************************
1221 *
1222 * Resource descriptors
1223 *
1224 ****************************************************************************/
1225
1226 /* ResourceType values */
1227
1228 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0
1229 #define ACPI_ADDRESS_TYPE_IO_RANGE 1
1230 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2
1231
1232 /* Resource descriptor types and masks */
1233
1234 #define ACPI_RESOURCE_NAME_LARGE 0x80
1235 #define ACPI_RESOURCE_NAME_SMALL 0x00
1236
1237 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */
1238 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */
1239 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */
1240
1241
1242 /*
1243 * Small resource descriptor "names" as defined by the ACPI specification.
1244 * Note: Bits 2:0 are used for the descriptor length
1245 */
1246 #define ACPI_RESOURCE_NAME_IRQ 0x20
1247 #define ACPI_RESOURCE_NAME_DMA 0x28
1248 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30
1249 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38
1250 #define ACPI_RESOURCE_NAME_IO 0x40
1251 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48
1252 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50
1253 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58
1254 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60
1255 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68
1256 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70
1257 #define ACPI_RESOURCE_NAME_END_TAG 0x78
1258
1259 /*
1260 * Large resource descriptor "names" as defined by the ACPI specification.
1261 * Note: includes the Large Descriptor bit in bit[7]
1262 */
1263 #define ACPI_RESOURCE_NAME_MEMORY24 0x81
1264 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82
1265 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83
1266 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84
1267 #define ACPI_RESOURCE_NAME_MEMORY32 0x85
1268 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86
1269 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87
1270 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88
1271 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89
1272 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A
1273 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B
1274 #define ACPI_RESOURCE_NAME_GPIO 0x8C
1275 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E
1276 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8E
1277
1278
1279 /*****************************************************************************
1280 *
1281 * Miscellaneous
1282 *
1283 ****************************************************************************/
1284
1285 #define ACPI_ASCII_ZERO 0x30
1286
1287
1288 /*****************************************************************************
1289 *
1290 * Disassembler
1291 *
1292 ****************************************************************************/
1293
1294 typedef struct acpi_external_list
1295 {
1296 char *Path;
1297 char *InternalPath;
1298 struct acpi_external_list *Next;
1299 UINT32 Value;
1300 UINT16 Length;
1301 UINT16 Flags;
1302 UINT8 Type;
1303
1304 } ACPI_EXTERNAL_LIST;
1305
1306 /* Values for Flags field above */
1307
1308 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */
1309 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */
1310 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */
1311 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */
1312
1313
1314 typedef struct acpi_external_file
1315 {
1316 char *Path;
1317 struct acpi_external_file *Next;
1318
1319 } ACPI_EXTERNAL_FILE;
1320
1321
1322 /*****************************************************************************
1323 *
1324 * Debugger
1325 *
1326 ****************************************************************************/
1327
1328 typedef struct acpi_db_method_info
1329 {
1330 ACPI_HANDLE Method;
1331 ACPI_HANDLE MainThreadGate;
1332 ACPI_HANDLE ThreadCompleteGate;
1333 ACPI_HANDLE InfoGate;
1334 ACPI_THREAD_ID *Threads;
1335 UINT32 NumThreads;
1336 UINT32 NumCreated;
1337 UINT32 NumCompleted;
1338
1339 char *Name;
1340 UINT32 Flags;
1341 UINT32 NumLoops;
1342 char Pathname[ACPI_DB_LINE_BUFFER_SIZE];
1343 char **Args;
1344 ACPI_OBJECT_TYPE *Types;
1345
1346 /*
1347 * Arguments to be passed to method for the command
1348 * Threads -
1349 * the Number of threads, ID of current thread and
1350 * Index of current thread inside all them created.
1351 */
1352 char InitArgs;
1353 ACPI_OBJECT_TYPE ArgTypes[4];
1354 char *Arguments[4];
1355 char NumThreadsStr[11];
1356 char IdOfThreadStr[11];
1357 char IndexOfThreadStr[11];
1358
1359 } ACPI_DB_METHOD_INFO;
1360
1361 typedef struct acpi_integrity_info
1362 {
1363 UINT32 Nodes;
1364 UINT32 Objects;
1365
1366 } ACPI_INTEGRITY_INFO;
1367
1368
1369 #define ACPI_DB_DISABLE_OUTPUT 0x00
1370 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01
1371 #define ACPI_DB_CONSOLE_OUTPUT 0x02
1372 #define ACPI_DB_DUPLICATE_OUTPUT 0x03
1373
1374
1375 /*****************************************************************************
1376 *
1377 * Debug
1378 *
1379 ****************************************************************************/
1380
1381 /* Entry for a memory allocation (debug only) */
1382
1383 #define ACPI_MEM_MALLOC 0
1384 #define ACPI_MEM_CALLOC 1
1385 #define ACPI_MAX_MODULE_NAME 16
1386
1387 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1388 struct acpi_debug_mem_block *Previous; \
1389 struct acpi_debug_mem_block *Next; \
1390 UINT32 Size; \
1391 UINT32 Component; \
1392 UINT32 Line; \
1393 char Module[ACPI_MAX_MODULE_NAME]; \
1394 UINT8 AllocType;
1395
1396 typedef struct acpi_debug_mem_header
1397 {
1398 ACPI_COMMON_DEBUG_MEM_HEADER
1399
1400 } ACPI_DEBUG_MEM_HEADER;
1401
1402 typedef struct acpi_debug_mem_block
1403 {
1404 ACPI_COMMON_DEBUG_MEM_HEADER
1405 UINT64 UserSpace;
1406
1407 } ACPI_DEBUG_MEM_BLOCK;
1408
1409
1410 #define ACPI_MEM_LIST_GLOBAL 0
1411 #define ACPI_MEM_LIST_NSNODE 1
1412 #define ACPI_MEM_LIST_MAX 1
1413 #define ACPI_NUM_MEM_LISTS 2
1414
1415
1416 /*****************************************************************************
1417 *
1418 * Info/help support
1419 *
1420 ****************************************************************************/
1421
1422 typedef struct ah_predefined_name
1423 {
1424 char *Name;
1425 char *Description;
1426 #ifndef ACPI_ASL_COMPILER
1427 char *Action;
1428 #endif
1429
1430 } AH_PREDEFINED_NAME;
1431
1432 typedef struct ah_device_id
1433 {
1434 char *Name;
1435 char *Description;
1436
1437 } AH_DEVICE_ID;
1438
1439 typedef struct ah_uuid
1440 {
1441 char *Description;
1442 char *String;
1443
1444 } AH_UUID;
1445
1446 #endif /* __ACLOCAL_H__ */
A free Windows-compatible Operating System