ReactOS  0.4.14-dev-552-g2fad488
actypes.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Name: actypes.h - Common data types for the entire ACPI subsystem
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2019, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  * notice, this list of conditions, and the following disclaimer,
16  * without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  * substantially similar to the "NO WARRANTY" disclaimer below
19  * ("Disclaimer") and any redistribution must be conditioned upon
20  * including a substantially similar Disclaimer requirement for further
21  * binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  * of any contributors may be used to endorse or promote products derived
24  * from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ACTYPES_H__
45 #define __ACTYPES_H__
46 
47 /* acpisrc:StructDefs -- for acpisrc conversion */
48 
49 /*
50  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
51  * header and must be either 32 or 64. 16-bit ACPICA is no longer
52  * supported, as of 12/2006.
53  */
54 #ifndef ACPI_MACHINE_WIDTH
55 #error ACPI_MACHINE_WIDTH not defined
56 #endif
57 
58 /*
59  * Data type ranges
60  * Note: These macros are designed to be compiler independent as well as
61  * working around problems that some 32-bit compilers have with 64-bit
62  * constants.
63  */
64 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
65 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
66 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
67 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
68 #define ACPI_ASCII_MAX 0x7F
69 
70 
71 /*
72  * Architecture-specific ACPICA Subsystem Data Types
73  *
74  * The goal of these types is to provide source code portability across
75  * 16-bit, 32-bit, and 64-bit targets.
76  *
77  * 1) The following types are of fixed size for all targets (16/32/64):
78  *
79  * BOOLEAN Logical boolean
80  *
81  * UINT8 8-bit (1 byte) unsigned value
82  * UINT16 16-bit (2 byte) unsigned value
83  * UINT32 32-bit (4 byte) unsigned value
84  * UINT64 64-bit (8 byte) unsigned value
85  *
86  * INT16 16-bit (2 byte) signed value
87  * INT32 32-bit (4 byte) signed value
88  * INT64 64-bit (8 byte) signed value
89  *
90  * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
91  * compiler-dependent header(s) and were introduced because there is no
92  * common 64-bit integer type across the various compilation models, as
93  * shown in the table below.
94  *
95  * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
96  * char 8 8 8 8 8 8
97  * short 16 16 16 16 16 16
98  * _int32 32
99  * int 32 64 32 32 16 16
100  * long 64 64 32 32 32 32
101  * long long 64 64
102  * pointer 64 64 64 32 32 32
103  *
104  * Note: ILP64 and LP32 are currently not supported.
105  *
106  *
107  * 2) These types represent the native word size of the target mode of the
108  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
109  * usually used for memory allocation, efficient loop counters, and array
110  * indexes. The types are similar to the size_t type in the C library and
111  * are required because there is no C type that consistently represents the
112  * native data width. ACPI_SIZE is needed because there is no guarantee
113  * that a kernel-level C library is present.
114  *
115  * ACPI_SIZE 16/32/64-bit unsigned value
116  * ACPI_NATIVE_INT 16/32/64-bit signed value
117  */
118 
119 /*******************************************************************************
120  *
121  * Common types for all compilers, all targets
122  *
123  ******************************************************************************/
124 
125 #ifndef ACPI_USE_SYSTEM_INTTYPES
126 
127 typedef unsigned char BOOLEAN;
128 typedef unsigned char UINT8;
129 typedef unsigned short UINT16;
130 typedef short INT16;
133 
134 #endif /* ACPI_USE_SYSTEM_INTTYPES */
135 
136 /*
137  * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
138  * across operating systems or even the various UNIX systems. Since ACPICA
139  * only needs the thread ID as a unique thread identifier, we use a UINT64
140  * as the only common data type - it will accommodate any type of pointer or
141  * any type of integer. It is up to the host-dependent OSL to cast the
142  * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
143  */
144 #define ACPI_THREAD_ID UINT64
145 
146 
147 /*******************************************************************************
148  *
149  * Types specific to 64-bit targets
150  *
151  ******************************************************************************/
152 
153 #if ACPI_MACHINE_WIDTH == 64
154 
155 #ifndef ACPI_USE_SYSTEM_INTTYPES
156 
157 typedef unsigned int UINT32;
158 typedef int INT32;
159 
160 #endif /* ACPI_USE_SYSTEM_INTTYPES */
161 
162 
163 typedef INT64 ACPI_NATIVE_INT;
164 typedef UINT64 ACPI_SIZE;
165 typedef UINT64 ACPI_IO_ADDRESS;
166 typedef UINT64 ACPI_PHYSICAL_ADDRESS;
167 
168 #define ACPI_MAX_PTR ACPI_UINT64_MAX
169 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
170 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
171 #define ACPI_USE_NATIVE_MATH64 /* Has native 64-bit integer support */
172 
173 /*
174  * In the case of the Itanium Processor Family (IPF), the hardware does not
175  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
176  * flag to indicate that special precautions must be taken to avoid alignment
177  * faults. (IA64 or ia64 is currently used by existing compilers to indicate
178  * IPF.)
179  *
180  * Note: EM64T and other X86-64 processors support misaligned transfers,
181  * so there is no need to define this flag.
182  */
183 #if defined (__IA64__) || defined (__ia64__)
184 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
185 #endif
186 
187 
188 /*******************************************************************************
189  *
190  * Types specific to 32-bit targets
191  *
192  ******************************************************************************/
193 
194 #elif ACPI_MACHINE_WIDTH == 32
195 
196 #ifndef ACPI_USE_SYSTEM_INTTYPES
197 
198 typedef unsigned int UINT32;
199 typedef int INT32;
200 
201 #endif /* ACPI_USE_SYSTEM_INTTYPES */
202 
203 
204 typedef INT32 ACPI_NATIVE_INT;
205 typedef UINT32 ACPI_SIZE;
206 
207 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
208 
209 /*
210  * OSPMs can define this to shrink the size of the structures for 32-bit
211  * none PAE environment. ASL compiler may always define this to generate
212  * 32-bit OSPM compliant tables.
213  */
214 typedef UINT32 ACPI_IO_ADDRESS;
215 typedef UINT32 ACPI_PHYSICAL_ADDRESS;
216 
217 #else /* ACPI_32BIT_PHYSICAL_ADDRESS */
218 
219 /*
220  * It is reported that, after some calculations, the physical addresses can
221  * wrap over the 32-bit boundary on 32-bit PAE environment.
222  * https://bugzilla.kernel.org/show_bug.cgi?id=87971
223  */
224 typedef UINT64 ACPI_IO_ADDRESS;
225 typedef UINT64 ACPI_PHYSICAL_ADDRESS;
226 
227 #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */
228 
229 #define ACPI_MAX_PTR ACPI_UINT32_MAX
230 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
231 
232 #else
233 
234 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
235 
236 #error unknown ACPI_MACHINE_WIDTH
237 #endif
238 
239 
240 /*******************************************************************************
241  *
242  * OS-dependent types
243  *
244  * If the defaults below are not appropriate for the host system, they can
245  * be defined in the OS-specific header, and this will take precedence.
246  *
247  ******************************************************************************/
248 
249 /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
250 
251 #ifndef ACPI_CPU_FLAGS
252 #define ACPI_CPU_FLAGS ACPI_SIZE
253 #endif
254 
255 /* Object returned from AcpiOsCreateCache */
256 
257 #ifndef ACPI_CACHE_T
258 #ifdef ACPI_USE_LOCAL_CACHE
259 #define ACPI_CACHE_T ACPI_MEMORY_LIST
260 #else
261 #define ACPI_CACHE_T void *
262 #endif
263 #endif
264 
265 /*
266  * Synchronization objects - Mutexes, Semaphores, and SpinLocks
267  */
268 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
269 /*
270  * These macros are used if the host OS does not support a mutex object.
271  * Map the OSL Mutex interfaces to binary semaphores.
272  */
273 #define ACPI_MUTEX ACPI_SEMAPHORE
274 #define AcpiOsCreateMutex(OutHandle) AcpiOsCreateSemaphore (1, 1, OutHandle)
275 #define AcpiOsDeleteMutex(Handle) (void) AcpiOsDeleteSemaphore (Handle)
276 #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
277 #define AcpiOsReleaseMutex(Handle) (void) AcpiOsSignalSemaphore (Handle, 1)
278 #endif
279 
280 /* Configurable types for synchronization objects */
281 
282 #ifndef ACPI_SPINLOCK
283 #define ACPI_SPINLOCK void *
284 #endif
285 
286 #ifndef ACPI_SEMAPHORE
287 #define ACPI_SEMAPHORE void *
288 #endif
289 
290 #ifndef ACPI_MUTEX
291 #define ACPI_MUTEX void *
292 #endif
293 
294 
295 /*******************************************************************************
296  *
297  * Compiler-dependent types
298  *
299  * If the defaults below are not appropriate for the host compiler, they can
300  * be defined in the compiler-specific header, and this will take precedence.
301  *
302  ******************************************************************************/
303 
304 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
305 
306 #ifndef ACPI_UINTPTR_T
307 #define ACPI_UINTPTR_T void *
308 #endif
309 
310 /*
311  * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
312  * some compilers can catch printf format string problems
313  */
314 #ifndef ACPI_PRINTF_LIKE
315 #define ACPI_PRINTF_LIKE(c)
316 #endif
317 
318 /*
319  * Some compilers complain about unused variables. Sometimes we don't want
320  * to use all the variables (for example, _AcpiModuleName). This allows us
321  * to tell the compiler in a per-variable manner that a variable
322  * is unused
323  */
324 #ifndef ACPI_UNUSED_VAR
325 #define ACPI_UNUSED_VAR
326 #endif
327 
328 /*
329  * All ACPICA external functions that are available to the rest of the
330  * kernel are tagged with these macros which can be defined as appropriate
331  * for the host.
332  *
333  * Notes:
334  * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
335  * interfaces that may need special processing.
336  * ACPI_EXPORT_SYMBOL is used for all other public external functions.
337  */
338 #ifndef ACPI_EXPORT_SYMBOL_INIT
339 #define ACPI_EXPORT_SYMBOL_INIT(Symbol)
340 #endif
341 
342 #ifndef ACPI_EXPORT_SYMBOL
343 #define ACPI_EXPORT_SYMBOL(Symbol)
344 #endif
345 
346 /*
347  * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
348  * utilities only.
349  */
350 #ifndef ACPI_DEBUG_INITIALIZE
351 #define ACPI_DEBUG_INITIALIZE()
352 #endif
353 
354 
355 /*******************************************************************************
356  *
357  * Configuration
358  *
359  ******************************************************************************/
360 
361 #ifdef ACPI_NO_MEM_ALLOCATIONS
362 
363 #define ACPI_ALLOCATE(a) NULL
364 #define ACPI_ALLOCATE_ZEROED(a) NULL
365 #define ACPI_FREE(a)
366 #define ACPI_MEM_TRACKING(a)
367 
368 #else /* ACPI_NO_MEM_ALLOCATIONS */
369 
370 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
371 /*
372  * Memory allocation tracking (used by AcpiExec to detect memory leaks)
373  */
374 #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__
375 #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
376 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
377 #define ACPI_FREE(a) AcpiUtFreeAndTrack (a, ACPI_MEM_PARAMETERS)
378 #define ACPI_MEM_TRACKING(a) a
379 
380 #else
381 /*
382  * Normal memory allocation directly via the OS services layer
383  */
384 #define ACPI_ALLOCATE(a) AcpiOsAllocate ((ACPI_SIZE) (a))
385 #define ACPI_ALLOCATE_ZEROED(a) AcpiOsAllocateZeroed ((ACPI_SIZE) (a))
386 #define ACPI_FREE(a) AcpiOsFree (a)
387 #define ACPI_MEM_TRACKING(a)
388 
389 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
390 
391 #endif /* ACPI_NO_MEM_ALLOCATIONS */
392 
393 
394 /******************************************************************************
395  *
396  * ACPI Specification constants (Do not change unless the specification
397  * changes)
398  *
399  *****************************************************************************/
400 
401 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
402 
403 #define ACPI_MAX_GPE_BLOCKS 2
404 
405 /* Default ACPI register widths */
406 
407 #define ACPI_GPE_REGISTER_WIDTH 8
408 #define ACPI_PM1_REGISTER_WIDTH 16
409 #define ACPI_PM2_REGISTER_WIDTH 8
410 #define ACPI_PM_TIMER_WIDTH 32
411 #define ACPI_RESET_REGISTER_WIDTH 8
412 
413 /* Names within the namespace are 4 bytes long */
414 
415 #define ACPI_NAMESEG_SIZE 4 /* Fixed by ACPI spec */
416 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
417 #define ACPI_PATH_SEPARATOR '.'
418 
419 /* Sizes for ACPI table headers */
420 
421 #define ACPI_OEM_ID_SIZE 6
422 #define ACPI_OEM_TABLE_ID_SIZE 8
423 
424 /* ACPI/PNP hardware IDs */
425 
426 #define PCI_ROOT_HID_STRING "PNP0A03"
427 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
428 
429 /* PM Timer ticks per second (HZ) */
430 
431 #define ACPI_PM_TIMER_FREQUENCY 3579545
432 
433 
434 /*******************************************************************************
435  *
436  * Independent types
437  *
438  ******************************************************************************/
439 
440 /* Logical defines and NULL */
441 
442 #ifdef FALSE
443 #undef FALSE
444 #endif
445 #define FALSE (1 == 0)
446 
447 #ifdef TRUE
448 #undef TRUE
449 #endif
450 #define TRUE (1 == 1)
451 
452 #ifndef NULL
453 #define NULL (void *) 0
454 #endif
455 
456 
457 /*
458  * Miscellaneous types
459  */
460 typedef UINT32 ACPI_STATUS; /* All ACPI Exceptions */
461 typedef UINT32 ACPI_NAME; /* 4-byte ACPI name */
462 typedef char * ACPI_STRING; /* Null terminated ASCII string */
463 typedef void * ACPI_HANDLE; /* Actually a ptr to a NS Node */
464 
465 
466 /* Time constants for timer calculations */
467 
468 #define ACPI_MSEC_PER_SEC 1000L
469 
470 #define ACPI_USEC_PER_MSEC 1000L
471 #define ACPI_USEC_PER_SEC 1000000L
472 
473 #define ACPI_100NSEC_PER_USEC 10L
474 #define ACPI_100NSEC_PER_MSEC 10000L
475 #define ACPI_100NSEC_PER_SEC 10000000L
476 
477 #define ACPI_NSEC_PER_USEC 1000L
478 #define ACPI_NSEC_PER_MSEC 1000000L
479 #define ACPI_NSEC_PER_SEC 1000000000L
480 
481 #define ACPI_TIME_AFTER(a, b) ((INT64)((b) - (a)) < 0)
482 
483 
484 /* Owner IDs are used to track namespace nodes for selective deletion */
485 
487 #define ACPI_OWNER_ID_MAX 0xFFF /* 4095 possible owner IDs */
488 
489 
490 #define ACPI_INTEGER_BIT_SIZE 64
491 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
492 #define ACPI_MAX64_DECIMAL_DIGITS 20
493 #define ACPI_MAX32_DECIMAL_DIGITS 10
494 #define ACPI_MAX16_DECIMAL_DIGITS 5
495 #define ACPI_MAX8_DECIMAL_DIGITS 3
496 
497 /*
498  * Constants with special meanings
499  */
500 #define ACPI_ROOT_OBJECT ((ACPI_HANDLE) ACPI_TO_POINTER (ACPI_MAX_PTR))
501 #define ACPI_WAIT_FOREVER 0xFFFF /* UINT16, as per ACPI spec */
502 #define ACPI_DO_NOT_WAIT 0
503 
504 /*
505  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
506  * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
507  * Note that this pertains to the ACPI integer type only, not to other
508  * integers used in the implementation of the ACPICA subsystem.
509  *
510  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
511  * code base. It remains here for compatibility with device drivers that use
512  * the type. However, it will be removed in the future.
513  */
515 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
516 
517 
518 /*******************************************************************************
519  *
520  * Commonly used macros
521  *
522  ******************************************************************************/
523 
524 /* Data manipulation */
525 
526 #define ACPI_LOBYTE(Integer) ((UINT8) (UINT16)(Integer))
527 #define ACPI_HIBYTE(Integer) ((UINT8) (((UINT16)(Integer)) >> 8))
528 #define ACPI_LOWORD(Integer) ((UINT16) (UINT32)(Integer))
529 #define ACPI_HIWORD(Integer) ((UINT16)(((UINT32)(Integer)) >> 16))
530 #define ACPI_LODWORD(Integer64) ((UINT32) (UINT64)(Integer64))
531 #define ACPI_HIDWORD(Integer64) ((UINT32)(((UINT64)(Integer64)) >> 32))
532 
533 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
534 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
535 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
536 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
537 
538 /* Size calculation */
539 
540 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
541 
542 /* Pointer manipulation */
543 
544 #define ACPI_CAST_PTR(t, p) ((t *) (ACPI_UINTPTR_T) (p))
545 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (ACPI_UINTPTR_T) (p))
546 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
547 #define ACPI_SUB_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) - (ACPI_SIZE)(b)))
548 #define ACPI_PTR_DIFF(a, b) ((ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b))))
549 
550 /* Pointer/Integer type conversions */
551 
552 #define ACPI_TO_POINTER(i) ACPI_CAST_PTR (void, (ACPI_SIZE) (i))
553 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) 0)
554 #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) 0)
555 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
556 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
557 
558 /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
559 
560 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
561 #define ACPI_COMPARE_NAMESEG(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
562 #define ACPI_COPY_NAMESEG(dest,src) (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
563 #else
564 #define ACPI_COMPARE_NAMESEG(a,b) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAMESEG_SIZE))
565 #define ACPI_COPY_NAMESEG(dest,src) (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAMESEG_SIZE))
566 #endif
567 
568 /* Support for the special RSDP signature (8 characters) */
569 
570 #define ACPI_VALIDATE_RSDP_SIG(a) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
571 #define ACPI_MAKE_RSDP_SIG(dest) (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
572 
573 /* Support for OEMx signature (x can be any character) */
574 #define ACPI_IS_OEM_SIG(a) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_OEM_NAME, 3) &&\
575  strnlen (a, ACPI_NAMESEG_SIZE) == ACPI_NAMESEG_SIZE)
576 
577 /*
578  * Algorithm to obtain access bit width.
579  * Can be used with AccessWidth of ACPI_GENERIC_ADDRESS and AccessSize of
580  * ACPI_RESOURCE_GENERIC_REGISTER.
581  */
582 #define ACPI_ACCESS_BIT_WIDTH(size) (1 << ((size) + 2))
583 
584 
585 /*******************************************************************************
586  *
587  * Miscellaneous constants
588  *
589  ******************************************************************************/
590 
591 /*
592  * Initialization sequence options
593  */
594 #define ACPI_FULL_INITIALIZATION 0x0000
595 #define ACPI_NO_FACS_INIT 0x0001
596 #define ACPI_NO_ACPI_ENABLE 0x0002
597 #define ACPI_NO_HARDWARE_INIT 0x0004
598 #define ACPI_NO_EVENT_INIT 0x0008
599 #define ACPI_NO_HANDLER_INIT 0x0010
600 #define ACPI_NO_OBJECT_INIT 0x0020
601 #define ACPI_NO_DEVICE_INIT 0x0040
602 #define ACPI_NO_ADDRESS_SPACE_INIT 0x0080
603 
604 /*
605  * Initialization state
606  */
607 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
608 #define ACPI_INITIALIZED_OK 0x02
609 
610 /*
611  * Power state values
612  */
613 #define ACPI_STATE_UNKNOWN (UINT8) 0xFF
614 
615 #define ACPI_STATE_S0 (UINT8) 0
616 #define ACPI_STATE_S1 (UINT8) 1
617 #define ACPI_STATE_S2 (UINT8) 2
618 #define ACPI_STATE_S3 (UINT8) 3
619 #define ACPI_STATE_S4 (UINT8) 4
620 #define ACPI_STATE_S5 (UINT8) 5
621 #define ACPI_S_STATES_MAX ACPI_STATE_S5
622 #define ACPI_S_STATE_COUNT 6
623 
624 #define ACPI_STATE_D0 (UINT8) 0
625 #define ACPI_STATE_D1 (UINT8) 1
626 #define ACPI_STATE_D2 (UINT8) 2
627 #define ACPI_STATE_D3 (UINT8) 3
628 #define ACPI_D_STATES_MAX ACPI_STATE_D3
629 #define ACPI_D_STATE_COUNT 4
630 
631 #define ACPI_STATE_C0 (UINT8) 0
632 #define ACPI_STATE_C1 (UINT8) 1
633 #define ACPI_STATE_C2 (UINT8) 2
634 #define ACPI_STATE_C3 (UINT8) 3
635 #define ACPI_C_STATES_MAX ACPI_STATE_C3
636 #define ACPI_C_STATE_COUNT 4
637 
638 /*
639  * Sleep type invalid value
640  */
641 #define ACPI_SLEEP_TYPE_MAX 0x7
642 #define ACPI_SLEEP_TYPE_INVALID 0xFF
643 
644 /*
645  * Standard notify values
646  */
647 #define ACPI_NOTIFY_BUS_CHECK (UINT8) 0x00
648 #define ACPI_NOTIFY_DEVICE_CHECK (UINT8) 0x01
649 #define ACPI_NOTIFY_DEVICE_WAKE (UINT8) 0x02
650 #define ACPI_NOTIFY_EJECT_REQUEST (UINT8) 0x03
651 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (UINT8) 0x04
652 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (UINT8) 0x05
653 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (UINT8) 0x06
654 #define ACPI_NOTIFY_POWER_FAULT (UINT8) 0x07
655 #define ACPI_NOTIFY_CAPABILITIES_CHECK (UINT8) 0x08
656 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (UINT8) 0x09
657 #define ACPI_NOTIFY_RESERVED (UINT8) 0x0A
658 #define ACPI_NOTIFY_LOCALITY_UPDATE (UINT8) 0x0B
659 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (UINT8) 0x0C
660 #define ACPI_NOTIFY_AFFINITY_UPDATE (UINT8) 0x0D
661 #define ACPI_NOTIFY_MEMORY_UPDATE (UINT8) 0x0E
662 #define ACPI_NOTIFY_DISCONNECT_RECOVER (UINT8) 0x0F
663 
664 #define ACPI_GENERIC_NOTIFY_MAX 0x0F
665 #define ACPI_SPECIFIC_NOTIFY_MAX 0x84
666 
667 /*
668  * Types associated with ACPI names and objects. The first group of
669  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
670  * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
671  * only add to the first group if the spec changes.
672  *
673  * NOTE: Types must be kept in sync with the global AcpiNsProperties
674  * and AcpiNsTypeNames arrays.
675  */
677 
678 #define ACPI_TYPE_ANY 0x00
679 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
680 #define ACPI_TYPE_STRING 0x02
681 #define ACPI_TYPE_BUFFER 0x03
682 #define ACPI_TYPE_PACKAGE 0x04 /* ByteConst, multiple DataTerm/Constant/SuperName */
683 #define ACPI_TYPE_FIELD_UNIT 0x05
684 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
685 #define ACPI_TYPE_EVENT 0x07
686 #define ACPI_TYPE_METHOD 0x08 /* Name, ByteConst, multiple Code */
687 #define ACPI_TYPE_MUTEX 0x09
688 #define ACPI_TYPE_REGION 0x0A
689 #define ACPI_TYPE_POWER 0x0B /* Name,ByteConst,WordConst,multi Node */
690 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
691 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
692 #define ACPI_TYPE_BUFFER_FIELD 0x0E
693 #define ACPI_TYPE_DDB_HANDLE 0x0F
694 #define ACPI_TYPE_DEBUG_OBJECT 0x10
695 
696 #define ACPI_TYPE_EXTERNAL_MAX 0x10
697 #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1)
698 
699 /*
700  * These are object types that do not map directly to the ACPI
701  * ObjectType() operator. They are used for various internal purposes
702  * only. If new predefined ACPI_TYPEs are added (via the ACPI
703  * specification), these internal types must move upwards. (There
704  * is code that depends on these values being contiguous with the
705  * external types above.)
706  */
707 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
708 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
709 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
710 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, RefOf, Index */
711 #define ACPI_TYPE_LOCAL_ALIAS 0x15
712 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
713 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
714 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
715 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
716 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
717 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple ObjectList Nodes */
718 
719 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
720 #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1)
721 
722 /*
723  * These are special object types that never appear in
724  * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
725  */
726 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
727 #define ACPI_TYPE_LOCAL_DATA 0x1D
728 
729 #define ACPI_TYPE_LOCAL_MAX 0x1D
730 
731 /* All types above here are invalid */
732 
733 #define ACPI_TYPE_INVALID 0x1E
734 #define ACPI_TYPE_NOT_FOUND 0xFF
735 
736 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
737 
738 
739 /*
740  * All I/O
741  */
742 #define ACPI_READ 0
743 #define ACPI_WRITE 1
744 #define ACPI_IO_MASK 1
745 
746 /*
747  * Event Types: Fixed & General Purpose
748  */
750 
751 /*
752  * Fixed events
753  */
754 #define ACPI_EVENT_PMTIMER 0
755 #define ACPI_EVENT_GLOBAL 1
756 #define ACPI_EVENT_POWER_BUTTON 2
757 #define ACPI_EVENT_SLEEP_BUTTON 3
758 #define ACPI_EVENT_RTC 4
759 #define ACPI_EVENT_MAX 4
760 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
761 
762 /*
763  * Event Status - Per event
764  * -------------
765  * The encoding of ACPI_EVENT_STATUS is illustrated below.
766  * Note that a set bit (1) indicates the property is TRUE
767  * (e.g. if bit 0 is set then the event is enabled).
768  * +-------------+-+-+-+-+-+-+
769  * | Bits 31:6 |5|4|3|2|1|0|
770  * +-------------+-+-+-+-+-+-+
771  * | | | | | | |
772  * | | | | | | +- Enabled?
773  * | | | | | +--- Enabled for wake?
774  * | | | | +----- Status bit set?
775  * | | | +------- Enable bit set?
776  * | | +--------- Has a handler?
777  * | +----------- Masked?
778  * +----------------- <Reserved>
779  */
781 
782 #define ACPI_EVENT_FLAG_DISABLED (ACPI_EVENT_STATUS) 0x00
783 #define ACPI_EVENT_FLAG_ENABLED (ACPI_EVENT_STATUS) 0x01
784 #define ACPI_EVENT_FLAG_WAKE_ENABLED (ACPI_EVENT_STATUS) 0x02
785 #define ACPI_EVENT_FLAG_STATUS_SET (ACPI_EVENT_STATUS) 0x04
786 #define ACPI_EVENT_FLAG_ENABLE_SET (ACPI_EVENT_STATUS) 0x08
787 #define ACPI_EVENT_FLAG_HAS_HANDLER (ACPI_EVENT_STATUS) 0x10
788 #define ACPI_EVENT_FLAG_MASKED (ACPI_EVENT_STATUS) 0x20
789 #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET
790 
791 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
792 
793 #define ACPI_GPE_ENABLE 0
794 #define ACPI_GPE_DISABLE 1
795 #define ACPI_GPE_CONDITIONAL_ENABLE 2
796 
797 /*
798  * GPE info flags - Per GPE
799  * +---+-+-+-+---+
800  * |7:6|5|4|3|2:0|
801  * +---+-+-+-+---+
802  * | | | | |
803  * | | | | +-- Type of dispatch:to method, handler, notify, or none
804  * | | | +----- Interrupt type: edge or level triggered
805  * | | +------- Is a Wake GPE
806  * | +--------- Has been enabled automatically at init time
807  * +------------ <Reserved>
808  */
809 #define ACPI_GPE_DISPATCH_NONE (UINT8) 0x00
810 #define ACPI_GPE_DISPATCH_METHOD (UINT8) 0x01
811 #define ACPI_GPE_DISPATCH_HANDLER (UINT8) 0x02
812 #define ACPI_GPE_DISPATCH_NOTIFY (UINT8) 0x03
813 #define ACPI_GPE_DISPATCH_RAW_HANDLER (UINT8) 0x04
814 #define ACPI_GPE_DISPATCH_MASK (UINT8) 0x07
815 #define ACPI_GPE_DISPATCH_TYPE(flags) ((UINT8) ((flags) & ACPI_GPE_DISPATCH_MASK))
816 
817 #define ACPI_GPE_LEVEL_TRIGGERED (UINT8) 0x08
818 #define ACPI_GPE_EDGE_TRIGGERED (UINT8) 0x00
819 #define ACPI_GPE_XRUPT_TYPE_MASK (UINT8) 0x08
820 
821 #define ACPI_GPE_CAN_WAKE (UINT8) 0x10
822 #define ACPI_GPE_AUTO_ENABLED (UINT8) 0x20
823 #define ACPI_GPE_INITIALIZED (UINT8) 0x40
824 
825 /*
826  * Flags for GPE and Lock interfaces
827  */
828 #define ACPI_NOT_ISR 0x1
829 #define ACPI_ISR 0x0
830 
831 
832 /* Notify types */
833 
834 #define ACPI_SYSTEM_NOTIFY 0x1
835 #define ACPI_DEVICE_NOTIFY 0x2
836 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
837 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
838 #define ACPI_NUM_NOTIFY_TYPES 2
839 
840 #define ACPI_MAX_SYS_NOTIFY 0x7F
841 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
842 
843 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
844 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
845 
846 
847 /* Address Space (Operation Region) Types */
848 
850 
851 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (ACPI_ADR_SPACE_TYPE) 0
852 #define ACPI_ADR_SPACE_SYSTEM_IO (ACPI_ADR_SPACE_TYPE) 1
853 #define ACPI_ADR_SPACE_PCI_CONFIG (ACPI_ADR_SPACE_TYPE) 2
854 #define ACPI_ADR_SPACE_EC (ACPI_ADR_SPACE_TYPE) 3
855 #define ACPI_ADR_SPACE_SMBUS (ACPI_ADR_SPACE_TYPE) 4
856 #define ACPI_ADR_SPACE_CMOS (ACPI_ADR_SPACE_TYPE) 5
857 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (ACPI_ADR_SPACE_TYPE) 6
858 #define ACPI_ADR_SPACE_IPMI (ACPI_ADR_SPACE_TYPE) 7
859 #define ACPI_ADR_SPACE_GPIO (ACPI_ADR_SPACE_TYPE) 8
860 #define ACPI_ADR_SPACE_GSBUS (ACPI_ADR_SPACE_TYPE) 9
861 #define ACPI_ADR_SPACE_PLATFORM_COMM (ACPI_ADR_SPACE_TYPE) 10
862 
863 #define ACPI_NUM_PREDEFINED_REGIONS 11
864 
865 /*
866  * Special Address Spaces
867  *
868  * Note: A Data Table region is a special type of operation region
869  * that has its own AML opcode. However, internally, the AML
870  * interpreter simply creates an operation region with an an address
871  * space type of ACPI_ADR_SPACE_DATA_TABLE.
872  */
873 #define ACPI_ADR_SPACE_DATA_TABLE (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
874 #define ACPI_ADR_SPACE_FIXED_HARDWARE (ACPI_ADR_SPACE_TYPE) 0x7F
875 
876 /* Values for _REG connection code */
877 
878 #define ACPI_REG_DISCONNECT 0
879 #define ACPI_REG_CONNECT 1
880 
881 /*
882  * BitRegister IDs
883  *
884  * These values are intended to be used by the hardware interfaces
885  * and are mapped to individual bitfields defined within the ACPI
886  * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
887  * for this mapping.
888  */
889 
890 /* PM1 Status register */
891 
892 #define ACPI_BITREG_TIMER_STATUS 0x00
893 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
894 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
895 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
896 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
897 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
898 #define ACPI_BITREG_WAKE_STATUS 0x06
899 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
900 
901 /* PM1 Enable register */
902 
903 #define ACPI_BITREG_TIMER_ENABLE 0x08
904 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
905 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
906 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
907 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
908 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
909 
910 /* PM1 Control register */
911 
912 #define ACPI_BITREG_SCI_ENABLE 0x0E
913 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
914 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
915 #define ACPI_BITREG_SLEEP_TYPE 0x11
916 #define ACPI_BITREG_SLEEP_ENABLE 0x12
917 
918 /* PM2 Control register */
919 
920 #define ACPI_BITREG_ARB_DISABLE 0x13
921 
922 #define ACPI_BITREG_MAX 0x13
923 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
924 
925 
926 /* Status register values. A 1 clears a status bit. 0 = no effect */
927 
928 #define ACPI_CLEAR_STATUS 1
929 
930 /* Enable and Control register values */
931 
932 #define ACPI_ENABLE_EVENT 1
933 #define ACPI_DISABLE_EVENT 0
934 
935 
936 /* Sleep function dispatch */
937 
939  UINT8 SleepState);
940 
941 typedef struct acpi_sleep_functions
942 {
945 
947 
948 
949 /*
950  * External ACPI object definition
951  */
952 
953 /*
954  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
955  * element or an unresolved named reference.
956  */
957 typedef union acpi_object
958 {
959  ACPI_OBJECT_TYPE Type; /* See definition of AcpiNsType for values */
960  struct
961  {
962  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_INTEGER */
963  UINT64 Value; /* The actual number */
964  } Integer;
965 
966  struct
967  {
968  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_STRING */
969  UINT32 Length; /* # of bytes in string, excluding trailing null */
970  char *Pointer; /* points to the string value */
971  } String;
972 
973  struct
974  {
975  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_BUFFER */
976  UINT32 Length; /* # of bytes in buffer */
977  UINT8 *Pointer; /* points to the buffer */
978  } Buffer;
979 
980  struct
981  {
982  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PACKAGE */
983  UINT32 Count; /* # of elements in package */
984  union acpi_object *Elements; /* Pointer to an array of ACPI_OBJECTs */
985  } Package;
986 
987  struct
988  {
989  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_LOCAL_REFERENCE */
990  ACPI_OBJECT_TYPE ActualType; /* Type associated with the Handle */
991  ACPI_HANDLE Handle; /* object reference */
992  } Reference;
993 
994  struct
995  {
996  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PROCESSOR */
998  ACPI_IO_ADDRESS PblkAddress;
1000  } Processor;
1001 
1002  struct
1003  {
1004  ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_POWER */
1007  } PowerResource;
1008 
1009 } ACPI_OBJECT;
1010 
1011 
1012 /*
1013  * List of objects, used as a parameter list for control method evaluation
1014  */
1015 typedef struct acpi_object_list
1016 {
1019 
1021 
1022 
1023 /*
1024  * Miscellaneous common Data Structures used by the interfaces
1025  */
1026 #define ACPI_NO_BUFFER 0
1027 
1028 #ifdef ACPI_NO_MEM_ALLOCATIONS
1029 
1030 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (0)
1031 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (0)
1032 
1033 #else /* ACPI_NO_MEM_ALLOCATIONS */
1034 
1035 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (-1) /* Let ACPICA allocate buffer */
1036 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (-2) /* For internal use only (enables tracking) */
1037 
1038 #endif /* ACPI_NO_MEM_ALLOCATIONS */
1039 
1040 typedef struct acpi_buffer
1041 {
1042  ACPI_SIZE Length; /* Length in bytes of the buffer */
1043  void *Pointer; /* pointer to buffer */
1044 
1045 } ACPI_BUFFER;
1046 
1047 
1048 /*
1049  * NameType for AcpiGetName
1050  */
1051 #define ACPI_FULL_PATHNAME 0
1052 #define ACPI_SINGLE_NAME 1
1053 #define ACPI_FULL_PATHNAME_NO_TRAILING 2
1054 #define ACPI_NAME_TYPE_MAX 2
1055 
1056 
1057 /*
1058  * Predefined Namespace items
1059  */
1061 {
1062  const char *Name;
1064  char *Val;
1065 
1067 
1068 
1069 /*
1070  * Structure and flags for AcpiGetSystemInfo
1071  */
1072 #define ACPI_SYS_MODE_UNKNOWN 0x0000
1073 #define ACPI_SYS_MODE_ACPI 0x0001
1074 #define ACPI_SYS_MODE_LEGACY 0x0002
1075 #define ACPI_SYS_MODES_MASK 0x0003
1076 
1077 
1078 /*
1079  * System info returned by AcpiGetSystemInfo()
1080  */
1081 typedef struct acpi_system_info
1082 {
1090 
1092 
1093 
1094 /*
1095  * System statistics returned by AcpiGetStatistics()
1096  */
1097 typedef struct acpi_statistics
1098 {
1103 
1104 } ACPI_STATISTICS;
1105 
1106 
1107 /*
1108  * Types specific to the OS service interfaces
1109  */
1110 typedef UINT32
1112  void *Context);
1113 
1114 typedef void
1116  void *Context);
1117 
1118 /*
1119  * Various handlers and callback procedures
1120  */
1121 typedef
1123  void *Context);
1124 
1125 typedef
1127  UINT32 EventType,
1129  UINT32 EventNumber,
1130  void *Context);
1131 
1132 #define ACPI_EVENT_TYPE_GPE 0
1133 #define ACPI_EVENT_TYPE_FIXED 1
1134 
1135 typedef
1137  void *Context);
1138 
1139 typedef
1141  ACPI_HANDLE GpeDevice,
1142  UINT32 GpeNumber,
1143  void *Context);
1144 
1145 typedef
1148  UINT32 Value,
1149  void *Context);
1150 
1151 typedef
1154  void *Data);
1155 
1156 typedef
1159  UINT32 Function);
1160 
1161 #define ACPI_INIT_DEVICE_INI 1
1162 
1163 typedef
1165  ACPI_STATUS AmlStatus,
1166  ACPI_NAME Name,
1167  UINT16 Opcode,
1168  UINT32 AmlOffset,
1169  void *Context);
1170 
1171 /* Table Event handler (Load, LoadTable, etc.) and types */
1172 
1173 typedef
1175  UINT32 Event,
1176  void *Table,
1177  void *Context);
1178 
1179 
1180 /* Table Event Types */
1181 
1182 #define ACPI_TABLE_EVENT_LOAD 0x0
1183 #define ACPI_TABLE_EVENT_UNLOAD 0x1
1184 #define ACPI_TABLE_EVENT_INSTALL 0x2
1185 #define ACPI_TABLE_EVENT_UNINSTALL 0x3
1186 #define ACPI_NUM_TABLE_EVENTS 4
1187 
1188 
1189 /* Address Spaces (For Operation Regions) */
1190 
1191 typedef
1193  UINT32 Function,
1194  ACPI_PHYSICAL_ADDRESS Address,
1195  UINT32 BitWidth,
1196  UINT64 *Value,
1197  void *HandlerContext,
1198  void *RegionContext);
1199 
1200 #define ACPI_DEFAULT_HANDLER NULL
1201 
1202 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1203 
1204 typedef struct acpi_connection_info
1205 {
1209 
1211 
1212 
1213 typedef
1215  ACPI_HANDLE RegionHandle,
1216  UINT32 Function,
1217  void *HandlerContext,
1218  void **RegionContext);
1219 
1220 #define ACPI_REGION_ACTIVATE 0
1221 #define ACPI_REGION_DEACTIVATE 1
1222 
1223 typedef
1226  UINT32 NestingLevel,
1227  void *Context,
1228  void **ReturnValue);
1229 
1230 typedef
1232  ACPI_STRING InterfaceName,
1233  UINT32 Supported);
1234 
1235 
1236 /* Interrupt handler return values */
1237 
1238 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1239 #define ACPI_INTERRUPT_HANDLED 0x01
1240 
1241 /* GPE handler return values */
1242 
1243 #define ACPI_REENABLE_GPE 0x80
1244 
1245 
1246 /* Length of 32-bit EISAID values when converted back to a string */
1247 
1248 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1249 
1250 /* Length of UUID (string) values */
1251 
1252 #define ACPI_UUID_LENGTH 16
1253 
1254 /* Length of 3-byte PCI class code values when converted back to a string */
1255 
1256 #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */
1257 
1258 
1259 /* Structures used for device/processor HID, UID, CID */
1260 
1261 typedef struct acpi_pnp_device_id
1262 {
1263  UINT32 Length; /* Length of string + null */
1264  char *String;
1265 
1267 
1269 {
1270  UINT32 Count; /* Number of IDs in Ids array */
1271  UINT32 ListSize; /* Size of list, including ID strings */
1272  ACPI_PNP_DEVICE_ID Ids[1]; /* ID array */
1273 
1275 
1276 /*
1277  * Structure returned from AcpiGetObjectInfo.
1278  * Optimized for both 32-bit and 64-bit builds.
1279  */
1280 typedef struct acpi_device_info
1281 {
1282  UINT32 InfoSize; /* Size of info, including ID strings */
1283  UINT32 Name; /* ACPI object Name */
1284  ACPI_OBJECT_TYPE Type; /* ACPI object Type */
1285  UINT8 ParamCount; /* If a method, required parameter count */
1286  UINT16 Valid; /* Indicates which optional fields are valid */
1287  UINT8 Flags; /* Miscellaneous info */
1288  UINT8 HighestDstates[4]; /* _SxD values: 0xFF indicates not valid */
1289  UINT8 LowestDstates[5]; /* _SxW values: 0xFF indicates not valid */
1290  UINT64 Address; /* _ADR value */
1291  ACPI_PNP_DEVICE_ID HardwareId; /* _HID value */
1292  ACPI_PNP_DEVICE_ID UniqueId; /* _UID value */
1293  ACPI_PNP_DEVICE_ID ClassCode; /* _CLS value */
1294  ACPI_PNP_DEVICE_ID_LIST CompatibleIdList; /* _CID list <must be last> */
1295 
1297 
1298 /* Values for Flags field above (AcpiGetObjectInfo) */
1299 
1300 #define ACPI_PCI_ROOT_BRIDGE 0x01
1301 
1302 /* Flags for Valid field above (AcpiGetObjectInfo) */
1303 
1304 #define ACPI_VALID_ADR 0x0002
1305 #define ACPI_VALID_HID 0x0004
1306 #define ACPI_VALID_UID 0x0008
1307 #define ACPI_VALID_CID 0x0020
1308 #define ACPI_VALID_CLS 0x0040
1309 #define ACPI_VALID_SXDS 0x0100
1310 #define ACPI_VALID_SXWS 0x0200
1311 
1312 /* Flags for _STA method */
1313 
1314 #define ACPI_STA_DEVICE_PRESENT 0x01
1315 #define ACPI_STA_DEVICE_ENABLED 0x02
1316 #define ACPI_STA_DEVICE_UI 0x04
1317 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1318 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1319 #define ACPI_STA_BATTERY_PRESENT 0x10
1320 
1321 
1322 /* Context structs for address space handlers */
1323 
1324 typedef struct acpi_pci_id
1325 {
1330 
1331 } ACPI_PCI_ID;
1332 
1334 {
1336  ACPI_PHYSICAL_ADDRESS Address;
1337  ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress;
1339  ACPI_SIZE MappedLength;
1340 
1342 
1343 
1344 /*
1345  * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1346  */
1347 typedef struct acpi_memory_list
1348 {
1349  const char *ListName;
1350  void *ListHead;
1354 
1355 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1356 
1357  /* Statistics for debug memory tracking only */
1358 
1359  UINT32 TotalAllocated;
1360  UINT32 TotalFreed;
1361  UINT32 MaxOccupied;
1362  UINT32 TotalSize;
1363  UINT32 CurrentTotalSize;
1364  UINT32 Requests;
1365  UINT32 Hits;
1366 #endif
1367 
1369 
1370 
1371 /* Definitions of trace event types */
1372 
1373 typedef enum
1374 {
1378 
1380 
1381 
1382 /* Definitions of _OSI support */
1383 
1384 #define ACPI_VENDOR_STRINGS 0x01
1385 #define ACPI_FEATURE_STRINGS 0x02
1386 #define ACPI_ENABLE_INTERFACES 0x00
1387 #define ACPI_DISABLE_INTERFACES 0x04
1388 
1389 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1390 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1391 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1392 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1393 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1394 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1395 
1396 #define ACPI_OSI_WIN_2000 0x01
1397 #define ACPI_OSI_WIN_XP 0x02
1398 #define ACPI_OSI_WIN_XP_SP1 0x03
1399 #define ACPI_OSI_WINSRV_2003 0x04
1400 #define ACPI_OSI_WIN_XP_SP2 0x05
1401 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1402 #define ACPI_OSI_WIN_VISTA 0x07
1403 #define ACPI_OSI_WINSRV_2008 0x08
1404 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1405 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1406 #define ACPI_OSI_WIN_7 0x0B
1407 #define ACPI_OSI_WIN_8 0x0C
1408 #define ACPI_OSI_WIN_8_1 0x0D
1409 #define ACPI_OSI_WIN_10 0x0E
1410 #define ACPI_OSI_WIN_10_RS1 0x0F
1411 #define ACPI_OSI_WIN_10_RS2 0x10
1412 #define ACPI_OSI_WIN_10_RS3 0x11
1413 #define ACPI_OSI_WIN_10_RS4 0x12
1414 #define ACPI_OSI_WIN_10_RS5 0x13
1415 #define ACPI_OSI_WIN_10_19H1 0x14
1416 
1417 
1418 /* Definitions of getopt */
1419 
1420 #define ACPI_OPT_END -1
1421 
1422 
1423 #endif /* __ACTYPES_H__ */
_In_opt_ ULONG _Out_ PULONG Value
Definition: rtlfuncs.h:2343
ACPI_OBJECT_TYPE Type
Definition: actypes.h:1284
UINT16 MaxDepth
Definition: actypes.h:1352
struct acpi_system_info ACPI_SYSTEM_INFO
UINT16 CurrentDepth
Definition: actypes.h:1353
ACPI_PNP_DEVICE_ID ClassCode
Definition: actypes.h:1293
union acpi_object ACPI_OBJECT
UINT32 DebugLayer
Definition: actypes.h:1089
ASMGENDATA Table[]
Definition: genincdata.c:61
UINT8 ACPI_ADR_SPACE_TYPE
Definition: actypes.h:849
UINT32 DebugLevel
Definition: actypes.h:1088
_In_ PVOID _In_ ULONG Opcode
Definition: hubbusif.h:330
ACPI_STATUS(* ACPI_ADR_SPACE_SETUP)(ACPI_HANDLE RegionHandle, UINT32 Function, void *HandlerContext, void **RegionContext)
Definition: actypes.h:1214
struct png_info_def **typedef void(__cdecl typeof(png_destroy_read_struct))(struct png_struct_def **
Definition: typeof.h:49
ACPI_STATUS(* ACPI_ADR_SPACE_HANDLER)(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 BitWidth, UINT64 *Value, void *HandlerContext, void *RegionContext)
Definition: actypes.h:1192
_In_ PIRP _In_ PDEVICE_OBJECT Device
Definition: fatprocs.h:2020
UINT64 ACPI_INTEGER
Definition: actypes.h:514
ACPI_OBJECT_TYPE ActualType
Definition: actypes.h:990
struct acpi_pnp_device_id_list ACPI_PNP_DEVICE_ID_LIST
UINT8 HighestDstates[4]
Definition: actypes.h:1288
struct acpi_object::@598 Integer
UINT16 Bus
Definition: actypes.h:1327
ACPI_STATUS(* ACPI_INIT_HANDLER)(ACPI_HANDLE Object, UINT32 Function)
Definition: actypes.h:1157
ACPI_PNP_DEVICE_ID Ids[1]
Definition: actypes.h:1272
ACPI_SIZE Length
Definition: actypes.h:1042
COMPILER_DEPENDENT_UINT64 UINT64
Definition: actypes.h:131
struct acpi_object::@599 String
ACPI_HANDLE Handle
Definition: actypes.h:991
UINT32 PblkLength
Definition: actypes.h:999
char * Pointer
Definition: actypes.h:970
UINT32(* ACPI_SCI_HANDLER)(void *Context)
Definition: actypes.h:1122
void(* ACPI_NOTIFY_HANDLER)(ACPI_HANDLE Device, UINT32 Value, void *Context)
Definition: actypes.h:1146
void * Pointer
Definition: actypes.h:1043
UINT16 Device
Definition: actypes.h:1328
UINT8 * Pointer
Definition: actypes.h:977
UINT32 ACPI_STATUS
Definition: actypes.h:460
ACPI_STATUS(* ACPI_WALK_CALLBACK)(ACPI_HANDLE Object, UINT32 NestingLevel, void *Context, void **ReturnValue)
Definition: actypes.h:1224
UINT32(* ACPI_GPE_HANDLER)(ACPI_HANDLE GpeDevice, UINT32 GpeNumber, void *Context)
Definition: actypes.h:1140
UINT32 SciCount
Definition: actypes.h:1099
ACPI_PNP_DEVICE_ID HardwareId
Definition: actypes.h:1291
struct acpi_pnp_device_id ACPI_PNP_DEVICE_ID
ACPI_STATUS(* ACPI_TABLE_HANDLER)(UINT32 Event, void *Table, void *Context)
Definition: actypes.h:1174
UINT32 void void ** ReturnValue
Definition: acevents.h:214
UINT32(ACPI_SYSTEM_XFACE * ACPI_OSD_HANDLER)(void *Context)
Definition: actypes.h:1111
static LPOVERLAPPED_COMPLETION_ROUTINE Function
Definition: sync.c:684
unsigned int UINT32
char * ACPI_STRING
Definition: actypes.h:462
short INT16
Definition: actypes.h:130
struct acpi_object::@601 Package
struct NameRec_ * Name
Definition: cdprocs.h:464
UINT32 GpeCount
Definition: actypes.h:1100
_In_ PVOID _In_ ULONG Event
Definition: iotypes.h:435
static WCHAR Address[46]
Definition: ping.c:68
const char * ListName
Definition: actypes.h:1349
_In_ LPGUID _In_ PVOID Data
Definition: classpnp.h:778
UINT32 ACPI_OBJECT_TYPE
Definition: actypes.h:676
ACPI_SIZE MappedLength
Definition: actypes.h:1339
UINT32 TimerResolution
Definition: actypes.h:1085
#define COMPILER_DEPENDENT_INT64
Definition: accygwin.h:72
ACPI_STATUS(* ACPI_SLEEP_FUNCTION)(UINT8 SleepState)
Definition: actypes.h:938
ACPI_STATUS(* ACPI_EXCEPTION_HANDLER)(ACPI_STATUS AmlStatus, ACPI_NAME Name, UINT16 Opcode, UINT32 AmlOffset, void *Context)
Definition: actypes.h:1164
UINT32 Count
Definition: actypes.h:983
UINT32 ACPI_EVENT_TYPE
Definition: actypes.h:749
struct acpi_object::@602 Reference
ACPI_TRACE_EVENT_TYPE
Definition: actypes.h:1373
UINT32 InfoSize
Definition: actypes.h:1282
UINT32 Length
Definition: actypes.h:969
UINT32(* ACPI_EVENT_HANDLER)(void *Context)
Definition: actypes.h:1136
ACPI_PNP_DEVICE_ID UniqueId
Definition: actypes.h:1292
#define ACPI_SYSTEM_XFACE
Definition: acenv.h:311
UINT8 LowestDstates[5]
Definition: actypes.h:1289
UINT16 Segment
Definition: actypes.h:1326
UINT16 ACPI_OWNER_ID
Definition: actypes.h:486
struct acpi_object::@603 Processor
UINT32 ACPI_EVENT_STATUS
Definition: actypes.h:780
struct acpi_connection_info ACPI_CONNECTION_INFO
ACPI_SLEEP_FUNCTION LegacyFunction
Definition: actypes.h:943
UINT64 Value
Definition: actypes.h:963
void * ListHead
Definition: actypes.h:1350
unsigned short UINT16
Definition: actypes.h:129
ACPI_PHYSICAL_ADDRESS Address
Definition: actypes.h:1336
struct acpi_object_list ACPI_OBJECT_LIST
static IUnknown Object
Definition: main.c:512
UINT32 ProcId
Definition: actypes.h:997
ACPI_IO_ADDRESS PblkAddress
Definition: actypes.h:998
unsigned char BOOLEAN
Definition: actypes.h:127
#define ACPI_NUM_FIXED_EVENTS
Definition: actypes.h:760
struct acpi_statistics ACPI_STATISTICS
struct acpi_predefined_names ACPI_PREDEFINED_NAMES
UINT32 ACPI_NAME
Definition: actypes.h:461
ACPI_GPE_EVENT_INFO UINT32 GpeNumber
Definition: acevents.h:195
UINT16 ObjectSize
Definition: actypes.h:1351
signed long long INT64
UINT32 Reserved2
Definition: actypes.h:1087
struct acpi_pci_id ACPI_PCI_ID
struct acpi_object::@600 Buffer
ACPI_SLEEP_FUNCTION ExtendedFunction
Definition: actypes.h:944
struct acpi_buffer ACPI_BUFFER
COMPILER_DEPENDENT_INT64 INT64
Definition: actypes.h:132
UINT64 Address
Definition: actypes.h:1290
const char * Name
Definition: actypes.h:1062
#define COMPILER_DEPENDENT_UINT64
Definition: accygwin.h:73
struct acpi_device_info ACPI_DEVICE_INFO
UINT32 Reserved1
Definition: actypes.h:1086
struct acpi_mem_space_context ACPI_MEM_SPACE_CONTEXT
struct acpi_memory_list ACPI_MEMORY_LIST
UINT32 AcpiCaVersion
Definition: actypes.h:1083
UINT32 ResourceOrder
Definition: actypes.h:1006
UINT32(* ACPI_INTERFACE_HANDLER)(ACPI_STRING InterfaceName, UINT32 Supported)
Definition: actypes.h:1231
unsigned short UINT16
UINT32 FixedEventCount[ACPI_NUM_FIXED_EVENTS]
Definition: actypes.h:1101
UINT32 MethodCount
Definition: actypes.h:1102
UINT8 ParamCount
Definition: actypes.h:1285
unsigned char UINT8
Definition: actypes.h:128
UINT32 SystemLevel
Definition: actypes.h:1005
ACPI_OBJECT * Pointer
Definition: actypes.h:1018
ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress
Definition: actypes.h:1337
void * ACPI_HANDLE
Definition: actypes.h:463
struct tagContext Context
Definition: acpixf.h:1030
signed int INT32
UINT8 * MappedLogicalAddress
Definition: actypes.h:1338
_In_ ACCESS_MASK _In_opt_ POBJECT_ATTRIBUTES _In_ EVENT_TYPE EventType
Definition: exfuncs.h:165
void(* ACPI_OBJECT_HANDLER)(ACPI_HANDLE Object, void *Data)
Definition: actypes.h:1152
union acpi_object * Elements
Definition: actypes.h:984
struct acpi_object::@604 PowerResource
UINT16 Function
Definition: actypes.h:1329
unsigned long long UINT64
ACPI_OBJECT_TYPE Type
Definition: actypes.h:959
ACPI_PNP_DEVICE_ID_LIST CompatibleIdList
Definition: actypes.h:1294
unsigned char UINT8
void(* ACPI_GBL_EVENT_HANDLER)(UINT32 EventType, ACPI_HANDLE Device, UINT32 EventNumber, void *Context)
Definition: actypes.h:1126
void(ACPI_SYSTEM_XFACE * ACPI_OSD_EXEC_CALLBACK)(void *Context)
Definition: actypes.h:1115
struct acpi_sleep_functions ACPI_SLEEP_FUNCTIONS