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