[ACPICA] Update to version 20171215. CORE-15222
[reactos.git] / 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 #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_NAME_SIZE 4
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
486 typedef UINT8 ACPI_OWNER_ID;
487 #define ACPI_OWNER_ID_MAX 0xFF
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_ADD_PTR (ACPI_HANDLE, NULL, 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 */
514 typedef UINT64 ACPI_INTEGER;
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_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i)
553 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
554 #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) NULL)
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_NAME(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
562 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
563 #else
564 #define ACPI_COMPARE_NAME(a,b) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
565 #define ACPI_MOVE_NAME(dest,src) (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_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 /*
574 * Algorithm to obtain access bit width.
575 * Can be used with AccessWidth of ACPI_GENERIC_ADDRESS and AccessSize of
576 * ACPI_RESOURCE_GENERIC_REGISTER.
577 */
578 #define ACPI_ACCESS_BIT_WIDTH(size) (1 << ((size) + 2))
579
580
581 /*******************************************************************************
582 *
583 * Miscellaneous constants
584 *
585 ******************************************************************************/
586
587 /*
588 * Initialization sequence
589 */
590 #define ACPI_FULL_INITIALIZATION 0x00
591 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
592 #define ACPI_NO_HARDWARE_INIT 0x02
593 #define ACPI_NO_EVENT_INIT 0x04
594 #define ACPI_NO_HANDLER_INIT 0x08
595 #define ACPI_NO_ACPI_ENABLE 0x10
596 #define ACPI_NO_DEVICE_INIT 0x20
597 #define ACPI_NO_OBJECT_INIT 0x40
598 #define ACPI_NO_FACS_INIT 0x80
599
600 /*
601 * Initialization state
602 */
603 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
604 #define ACPI_INITIALIZED_OK 0x02
605
606 /*
607 * Power state values
608 */
609 #define ACPI_STATE_UNKNOWN (UINT8) 0xFF
610
611 #define ACPI_STATE_S0 (UINT8) 0
612 #define ACPI_STATE_S1 (UINT8) 1
613 #define ACPI_STATE_S2 (UINT8) 2
614 #define ACPI_STATE_S3 (UINT8) 3
615 #define ACPI_STATE_S4 (UINT8) 4
616 #define ACPI_STATE_S5 (UINT8) 5
617 #define ACPI_S_STATES_MAX ACPI_STATE_S5
618 #define ACPI_S_STATE_COUNT 6
619
620 #define ACPI_STATE_D0 (UINT8) 0
621 #define ACPI_STATE_D1 (UINT8) 1
622 #define ACPI_STATE_D2 (UINT8) 2
623 #define ACPI_STATE_D3 (UINT8) 3
624 #define ACPI_D_STATES_MAX ACPI_STATE_D3
625 #define ACPI_D_STATE_COUNT 4
626
627 #define ACPI_STATE_C0 (UINT8) 0
628 #define ACPI_STATE_C1 (UINT8) 1
629 #define ACPI_STATE_C2 (UINT8) 2
630 #define ACPI_STATE_C3 (UINT8) 3
631 #define ACPI_C_STATES_MAX ACPI_STATE_C3
632 #define ACPI_C_STATE_COUNT 4
633
634 /*
635 * Sleep type invalid value
636 */
637 #define ACPI_SLEEP_TYPE_MAX 0x7
638 #define ACPI_SLEEP_TYPE_INVALID 0xFF
639
640 /*
641 * Standard notify values
642 */
643 #define ACPI_NOTIFY_BUS_CHECK (UINT8) 0x00
644 #define ACPI_NOTIFY_DEVICE_CHECK (UINT8) 0x01
645 #define ACPI_NOTIFY_DEVICE_WAKE (UINT8) 0x02
646 #define ACPI_NOTIFY_EJECT_REQUEST (UINT8) 0x03
647 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (UINT8) 0x04
648 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (UINT8) 0x05
649 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (UINT8) 0x06
650 #define ACPI_NOTIFY_POWER_FAULT (UINT8) 0x07
651 #define ACPI_NOTIFY_CAPABILITIES_CHECK (UINT8) 0x08
652 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (UINT8) 0x09
653 #define ACPI_NOTIFY_RESERVED (UINT8) 0x0A
654 #define ACPI_NOTIFY_LOCALITY_UPDATE (UINT8) 0x0B
655 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (UINT8) 0x0C
656 #define ACPI_NOTIFY_AFFINITY_UPDATE (UINT8) 0x0D
657 #define ACPI_NOTIFY_MEMORY_UPDATE (UINT8) 0x0E
658
659 #define ACPI_GENERIC_NOTIFY_MAX 0x0E
660 #define ACPI_SPECIFIC_NOTIFY_MAX 0x84
661
662 /*
663 * Types associated with ACPI names and objects. The first group of
664 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
665 * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
666 * only add to the first group if the spec changes.
667 *
668 * NOTE: Types must be kept in sync with the global AcpiNsProperties
669 * and AcpiNsTypeNames arrays.
670 */
671 typedef UINT32 ACPI_OBJECT_TYPE;
672
673 #define ACPI_TYPE_ANY 0x00
674 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
675 #define ACPI_TYPE_STRING 0x02
676 #define ACPI_TYPE_BUFFER 0x03
677 #define ACPI_TYPE_PACKAGE 0x04 /* ByteConst, multiple DataTerm/Constant/SuperName */
678 #define ACPI_TYPE_FIELD_UNIT 0x05
679 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
680 #define ACPI_TYPE_EVENT 0x07
681 #define ACPI_TYPE_METHOD 0x08 /* Name, ByteConst, multiple Code */
682 #define ACPI_TYPE_MUTEX 0x09
683 #define ACPI_TYPE_REGION 0x0A
684 #define ACPI_TYPE_POWER 0x0B /* Name,ByteConst,WordConst,multi Node */
685 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
686 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
687 #define ACPI_TYPE_BUFFER_FIELD 0x0E
688 #define ACPI_TYPE_DDB_HANDLE 0x0F
689 #define ACPI_TYPE_DEBUG_OBJECT 0x10
690
691 #define ACPI_TYPE_EXTERNAL_MAX 0x10
692 #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1)
693
694 /*
695 * These are object types that do not map directly to the ACPI
696 * ObjectType() operator. They are used for various internal purposes
697 * only. If new predefined ACPI_TYPEs are added (via the ACPI
698 * specification), these internal types must move upwards. (There
699 * is code that depends on these values being contiguous with the
700 * external types above.)
701 */
702 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
703 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
704 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
705 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, RefOf, Index */
706 #define ACPI_TYPE_LOCAL_ALIAS 0x15
707 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
708 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
709 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
710 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
711 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
712 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple ObjectList Nodes */
713
714 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
715 #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1)
716
717 /*
718 * These are special object types that never appear in
719 * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
720 */
721 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
722 #define ACPI_TYPE_LOCAL_DATA 0x1D
723
724 #define ACPI_TYPE_LOCAL_MAX 0x1D
725
726 /* All types above here are invalid */
727
728 #define ACPI_TYPE_INVALID 0x1E
729 #define ACPI_TYPE_NOT_FOUND 0xFF
730
731 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
732
733
734 /*
735 * All I/O
736 */
737 #define ACPI_READ 0
738 #define ACPI_WRITE 1
739 #define ACPI_IO_MASK 1
740
741 /*
742 * Event Types: Fixed & General Purpose
743 */
744 typedef UINT32 ACPI_EVENT_TYPE;
745
746 /*
747 * Fixed events
748 */
749 #define ACPI_EVENT_PMTIMER 0
750 #define ACPI_EVENT_GLOBAL 1
751 #define ACPI_EVENT_POWER_BUTTON 2
752 #define ACPI_EVENT_SLEEP_BUTTON 3
753 #define ACPI_EVENT_RTC 4
754 #define ACPI_EVENT_MAX 4
755 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
756
757 /*
758 * Event Status - Per event
759 * -------------
760 * The encoding of ACPI_EVENT_STATUS is illustrated below.
761 * Note that a set bit (1) indicates the property is TRUE
762 * (e.g. if bit 0 is set then the event is enabled).
763 * +-------------+-+-+-+-+-+-+
764 * | Bits 31:6 |5|4|3|2|1|0|
765 * +-------------+-+-+-+-+-+-+
766 * | | | | | | |
767 * | | | | | | +- Enabled?
768 * | | | | | +--- Enabled for wake?
769 * | | | | +----- Status bit set?
770 * | | | +------- Enable bit set?
771 * | | +--------- Has a handler?
772 * | +----------- Masked?
773 * +----------------- <Reserved>
774 */
775 typedef UINT32 ACPI_EVENT_STATUS;
776
777 #define ACPI_EVENT_FLAG_DISABLED (ACPI_EVENT_STATUS) 0x00
778 #define ACPI_EVENT_FLAG_ENABLED (ACPI_EVENT_STATUS) 0x01
779 #define ACPI_EVENT_FLAG_WAKE_ENABLED (ACPI_EVENT_STATUS) 0x02
780 #define ACPI_EVENT_FLAG_STATUS_SET (ACPI_EVENT_STATUS) 0x04
781 #define ACPI_EVENT_FLAG_ENABLE_SET (ACPI_EVENT_STATUS) 0x08
782 #define ACPI_EVENT_FLAG_HAS_HANDLER (ACPI_EVENT_STATUS) 0x10
783 #define ACPI_EVENT_FLAG_MASKED (ACPI_EVENT_STATUS) 0x20
784 #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET
785
786 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
787
788 #define ACPI_GPE_ENABLE 0
789 #define ACPI_GPE_DISABLE 1
790 #define ACPI_GPE_CONDITIONAL_ENABLE 2
791
792 /*
793 * GPE info flags - Per GPE
794 * +---+-+-+-+---+
795 * |7:6|5|4|3|2:0|
796 * +---+-+-+-+---+
797 * | | | | |
798 * | | | | +-- Type of dispatch:to method, handler, notify, or none
799 * | | | +----- Interrupt type: edge or level triggered
800 * | | +------- Is a Wake GPE
801 * | +--------- Is GPE masked by the software GPE masking mechanism
802 * +------------ <Reserved>
803 */
804 #define ACPI_GPE_DISPATCH_NONE (UINT8) 0x00
805 #define ACPI_GPE_DISPATCH_METHOD (UINT8) 0x01
806 #define ACPI_GPE_DISPATCH_HANDLER (UINT8) 0x02
807 #define ACPI_GPE_DISPATCH_NOTIFY (UINT8) 0x03
808 #define ACPI_GPE_DISPATCH_RAW_HANDLER (UINT8) 0x04
809 #define ACPI_GPE_DISPATCH_MASK (UINT8) 0x07
810 #define ACPI_GPE_DISPATCH_TYPE(flags) ((UINT8) ((flags) & ACPI_GPE_DISPATCH_MASK))
811
812 #define ACPI_GPE_LEVEL_TRIGGERED (UINT8) 0x08
813 #define ACPI_GPE_EDGE_TRIGGERED (UINT8) 0x00
814 #define ACPI_GPE_XRUPT_TYPE_MASK (UINT8) 0x08
815
816 #define ACPI_GPE_CAN_WAKE (UINT8) 0x10
817
818 /*
819 * Flags for GPE and Lock interfaces
820 */
821 #define ACPI_NOT_ISR 0x1
822 #define ACPI_ISR 0x0
823
824
825 /* Notify types */
826
827 #define ACPI_SYSTEM_NOTIFY 0x1
828 #define ACPI_DEVICE_NOTIFY 0x2
829 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
830 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
831 #define ACPI_NUM_NOTIFY_TYPES 2
832
833 #define ACPI_MAX_SYS_NOTIFY 0x7F
834 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
835
836 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
837 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
838
839
840 /* Address Space (Operation Region) Types */
841
842 typedef UINT8 ACPI_ADR_SPACE_TYPE;
843
844 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (ACPI_ADR_SPACE_TYPE) 0
845 #define ACPI_ADR_SPACE_SYSTEM_IO (ACPI_ADR_SPACE_TYPE) 1
846 #define ACPI_ADR_SPACE_PCI_CONFIG (ACPI_ADR_SPACE_TYPE) 2
847 #define ACPI_ADR_SPACE_EC (ACPI_ADR_SPACE_TYPE) 3
848 #define ACPI_ADR_SPACE_SMBUS (ACPI_ADR_SPACE_TYPE) 4
849 #define ACPI_ADR_SPACE_CMOS (ACPI_ADR_SPACE_TYPE) 5
850 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (ACPI_ADR_SPACE_TYPE) 6
851 #define ACPI_ADR_SPACE_IPMI (ACPI_ADR_SPACE_TYPE) 7
852 #define ACPI_ADR_SPACE_GPIO (ACPI_ADR_SPACE_TYPE) 8
853 #define ACPI_ADR_SPACE_GSBUS (ACPI_ADR_SPACE_TYPE) 9
854 #define ACPI_ADR_SPACE_PLATFORM_COMM (ACPI_ADR_SPACE_TYPE) 10
855
856 #define ACPI_NUM_PREDEFINED_REGIONS 11
857
858 /*
859 * Special Address Spaces
860 *
861 * Note: A Data Table region is a special type of operation region
862 * that has its own AML opcode. However, internally, the AML
863 * interpreter simply creates an operation region with an an address
864 * space type of ACPI_ADR_SPACE_DATA_TABLE.
865 */
866 #define ACPI_ADR_SPACE_DATA_TABLE (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
867 #define ACPI_ADR_SPACE_FIXED_HARDWARE (ACPI_ADR_SPACE_TYPE) 0x7F
868
869 /* Values for _REG connection code */
870
871 #define ACPI_REG_DISCONNECT 0
872 #define ACPI_REG_CONNECT 1
873
874 /*
875 * BitRegister IDs
876 *
877 * These values are intended to be used by the hardware interfaces
878 * and are mapped to individual bitfields defined within the ACPI
879 * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
880 * for this mapping.
881 */
882
883 /* PM1 Status register */
884
885 #define ACPI_BITREG_TIMER_STATUS 0x00
886 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
887 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
888 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
889 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
890 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
891 #define ACPI_BITREG_WAKE_STATUS 0x06
892 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
893
894 /* PM1 Enable register */
895
896 #define ACPI_BITREG_TIMER_ENABLE 0x08
897 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
898 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
899 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
900 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
901 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
902
903 /* PM1 Control register */
904
905 #define ACPI_BITREG_SCI_ENABLE 0x0E
906 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
907 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
908 #define ACPI_BITREG_SLEEP_TYPE 0x11
909 #define ACPI_BITREG_SLEEP_ENABLE 0x12
910
911 /* PM2 Control register */
912
913 #define ACPI_BITREG_ARB_DISABLE 0x13
914
915 #define ACPI_BITREG_MAX 0x13
916 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
917
918
919 /* Status register values. A 1 clears a status bit. 0 = no effect */
920
921 #define ACPI_CLEAR_STATUS 1
922
923 /* Enable and Control register values */
924
925 #define ACPI_ENABLE_EVENT 1
926 #define ACPI_DISABLE_EVENT 0
927
928
929 /* Sleep function dispatch */
930
931 typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) (
932 UINT8 SleepState);
933
934 typedef struct acpi_sleep_functions
935 {
936 ACPI_SLEEP_FUNCTION LegacyFunction;
937 ACPI_SLEEP_FUNCTION ExtendedFunction;
938
939 } ACPI_SLEEP_FUNCTIONS;
940
941
942 /*
943 * External ACPI object definition
944 */
945
946 /*
947 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
948 * element or an unresolved named reference.
949 */
950 typedef union acpi_object
951 {
952 ACPI_OBJECT_TYPE Type; /* See definition of AcpiNsType for values */
953 struct
954 {
955 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_INTEGER */
956 UINT64 Value; /* The actual number */
957 } Integer;
958
959 struct
960 {
961 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_STRING */
962 UINT32 Length; /* # of bytes in string, excluding trailing null */
963 char *Pointer; /* points to the string value */
964 } String;
965
966 struct
967 {
968 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_BUFFER */
969 UINT32 Length; /* # of bytes in buffer */
970 UINT8 *Pointer; /* points to the buffer */
971 } Buffer;
972
973 struct
974 {
975 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PACKAGE */
976 UINT32 Count; /* # of elements in package */
977 union acpi_object *Elements; /* Pointer to an array of ACPI_OBJECTs */
978 } Package;
979
980 struct
981 {
982 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_LOCAL_REFERENCE */
983 ACPI_OBJECT_TYPE ActualType; /* Type associated with the Handle */
984 ACPI_HANDLE Handle; /* object reference */
985 } Reference;
986
987 struct
988 {
989 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PROCESSOR */
990 UINT32 ProcId;
991 ACPI_IO_ADDRESS PblkAddress;
992 UINT32 PblkLength;
993 } Processor;
994
995 struct
996 {
997 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_POWER */
998 UINT32 SystemLevel;
999 UINT32 ResourceOrder;
1000 } PowerResource;
1001
1002 } ACPI_OBJECT;
1003
1004
1005 /*
1006 * List of objects, used as a parameter list for control method evaluation
1007 */
1008 typedef struct acpi_object_list
1009 {
1010 UINT32 Count;
1011 ACPI_OBJECT *Pointer;
1012
1013 } ACPI_OBJECT_LIST;
1014
1015
1016 /*
1017 * Miscellaneous common Data Structures used by the interfaces
1018 */
1019 #define ACPI_NO_BUFFER 0
1020
1021 #ifdef ACPI_NO_MEM_ALLOCATIONS
1022
1023 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (0)
1024 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (0)
1025
1026 #else /* ACPI_NO_MEM_ALLOCATIONS */
1027
1028 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (-1) /* Let ACPICA allocate buffer */
1029 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (-2) /* For internal use only (enables tracking) */
1030
1031 #endif /* ACPI_NO_MEM_ALLOCATIONS */
1032
1033 typedef struct acpi_buffer
1034 {
1035 ACPI_SIZE Length; /* Length in bytes of the buffer */
1036 void *Pointer; /* pointer to buffer */
1037
1038 } ACPI_BUFFER;
1039
1040
1041 /*
1042 * NameType for AcpiGetName
1043 */
1044 #define ACPI_FULL_PATHNAME 0
1045 #define ACPI_SINGLE_NAME 1
1046 #define ACPI_FULL_PATHNAME_NO_TRAILING 2
1047 #define ACPI_NAME_TYPE_MAX 2
1048
1049
1050 /*
1051 * Predefined Namespace items
1052 */
1053 typedef struct acpi_predefined_names
1054 {
1055 const char *Name;
1056 UINT8 Type;
1057 char *Val;
1058
1059 } ACPI_PREDEFINED_NAMES;
1060
1061
1062 /*
1063 * Structure and flags for AcpiGetSystemInfo
1064 */
1065 #define ACPI_SYS_MODE_UNKNOWN 0x0000
1066 #define ACPI_SYS_MODE_ACPI 0x0001
1067 #define ACPI_SYS_MODE_LEGACY 0x0002
1068 #define ACPI_SYS_MODES_MASK 0x0003
1069
1070
1071 /*
1072 * System info returned by AcpiGetSystemInfo()
1073 */
1074 typedef struct acpi_system_info
1075 {
1076 UINT32 AcpiCaVersion;
1077 UINT32 Flags;
1078 UINT32 TimerResolution;
1079 UINT32 Reserved1;
1080 UINT32 Reserved2;
1081 UINT32 DebugLevel;
1082 UINT32 DebugLayer;
1083
1084 } ACPI_SYSTEM_INFO;
1085
1086
1087 /*
1088 * System statistics returned by AcpiGetStatistics()
1089 */
1090 typedef struct acpi_statistics
1091 {
1092 UINT32 SciCount;
1093 UINT32 GpeCount;
1094 UINT32 FixedEventCount[ACPI_NUM_FIXED_EVENTS];
1095 UINT32 MethodCount;
1096
1097 } ACPI_STATISTICS;
1098
1099
1100 /*
1101 * Types specific to the OS service interfaces
1102 */
1103 typedef UINT32
1104 (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
1105 void *Context);
1106
1107 typedef void
1108 (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
1109 void *Context);
1110
1111 /*
1112 * Various handlers and callback procedures
1113 */
1114 typedef
1115 UINT32 (*ACPI_SCI_HANDLER) (
1116 void *Context);
1117
1118 typedef
1119 void (*ACPI_GBL_EVENT_HANDLER) (
1120 UINT32 EventType,
1121 ACPI_HANDLE Device,
1122 UINT32 EventNumber,
1123 void *Context);
1124
1125 #define ACPI_EVENT_TYPE_GPE 0
1126 #define ACPI_EVENT_TYPE_FIXED 1
1127
1128 typedef
1129 UINT32 (*ACPI_EVENT_HANDLER) (
1130 void *Context);
1131
1132 typedef
1133 UINT32 (*ACPI_GPE_HANDLER) (
1134 ACPI_HANDLE GpeDevice,
1135 UINT32 GpeNumber,
1136 void *Context);
1137
1138 typedef
1139 void (*ACPI_NOTIFY_HANDLER) (
1140 ACPI_HANDLE Device,
1141 UINT32 Value,
1142 void *Context);
1143
1144 typedef
1145 void (*ACPI_OBJECT_HANDLER) (
1146 ACPI_HANDLE Object,
1147 void *Data);
1148
1149 typedef
1150 ACPI_STATUS (*ACPI_INIT_HANDLER) (
1151 ACPI_HANDLE Object,
1152 UINT32 Function);
1153
1154 #define ACPI_INIT_DEVICE_INI 1
1155
1156 typedef
1157 ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
1158 ACPI_STATUS AmlStatus,
1159 ACPI_NAME Name,
1160 UINT16 Opcode,
1161 UINT32 AmlOffset,
1162 void *Context);
1163
1164 /* Table Event handler (Load, LoadTable, etc.) and types */
1165
1166 typedef
1167 ACPI_STATUS (*ACPI_TABLE_HANDLER) (
1168 UINT32 Event,
1169 void *Table,
1170 void *Context);
1171
1172
1173 /* Table Event Types */
1174
1175 #define ACPI_TABLE_EVENT_LOAD 0x0
1176 #define ACPI_TABLE_EVENT_UNLOAD 0x1
1177 #define ACPI_TABLE_EVENT_INSTALL 0x2
1178 #define ACPI_TABLE_EVENT_UNINSTALL 0x3
1179 #define ACPI_NUM_TABLE_EVENTS 4
1180
1181
1182 /* Address Spaces (For Operation Regions) */
1183
1184 typedef
1185 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
1186 UINT32 Function,
1187 ACPI_PHYSICAL_ADDRESS Address,
1188 UINT32 BitWidth,
1189 UINT64 *Value,
1190 void *HandlerContext,
1191 void *RegionContext);
1192
1193 #define ACPI_DEFAULT_HANDLER NULL
1194
1195 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1196
1197 typedef struct acpi_connection_info
1198 {
1199 UINT8 *Connection;
1200 UINT16 Length;
1201 UINT8 AccessLength;
1202
1203 } ACPI_CONNECTION_INFO;
1204
1205
1206 typedef
1207 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
1208 ACPI_HANDLE RegionHandle,
1209 UINT32 Function,
1210 void *HandlerContext,
1211 void **RegionContext);
1212
1213 #define ACPI_REGION_ACTIVATE 0
1214 #define ACPI_REGION_DEACTIVATE 1
1215
1216 typedef
1217 ACPI_STATUS (*ACPI_WALK_CALLBACK) (
1218 ACPI_HANDLE Object,
1219 UINT32 NestingLevel,
1220 void *Context,
1221 void **ReturnValue);
1222
1223 typedef
1224 UINT32 (*ACPI_INTERFACE_HANDLER) (
1225 ACPI_STRING InterfaceName,
1226 UINT32 Supported);
1227
1228
1229 /* Interrupt handler return values */
1230
1231 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1232 #define ACPI_INTERRUPT_HANDLED 0x01
1233
1234 /* GPE handler return values */
1235
1236 #define ACPI_REENABLE_GPE 0x80
1237
1238
1239 /* Length of 32-bit EISAID values when converted back to a string */
1240
1241 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1242
1243 /* Length of UUID (string) values */
1244
1245 #define ACPI_UUID_LENGTH 16
1246
1247 /* Length of 3-byte PCI class code values when converted back to a string */
1248
1249 #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */
1250
1251
1252 /* Structures used for device/processor HID, UID, CID */
1253
1254 typedef struct acpi_pnp_device_id
1255 {
1256 UINT32 Length; /* Length of string + null */
1257 char *String;
1258
1259 } ACPI_PNP_DEVICE_ID;
1260
1261 typedef struct acpi_pnp_device_id_list
1262 {
1263 UINT32 Count; /* Number of IDs in Ids array */
1264 UINT32 ListSize; /* Size of list, including ID strings */
1265 ACPI_PNP_DEVICE_ID Ids[1]; /* ID array */
1266
1267 } ACPI_PNP_DEVICE_ID_LIST;
1268
1269 /*
1270 * Structure returned from AcpiGetObjectInfo.
1271 * Optimized for both 32-bit and 64-bit builds.
1272 */
1273 typedef struct acpi_device_info
1274 {
1275 UINT32 InfoSize; /* Size of info, including ID strings */
1276 UINT32 Name; /* ACPI object Name */
1277 ACPI_OBJECT_TYPE Type; /* ACPI object Type */
1278 UINT8 ParamCount; /* If a method, required parameter count */
1279 UINT16 Valid; /* Indicates which optional fields are valid */
1280 UINT8 Flags; /* Miscellaneous info */
1281 UINT8 HighestDstates[4]; /* _SxD values: 0xFF indicates not valid */
1282 UINT8 LowestDstates[5]; /* _SxW values: 0xFF indicates not valid */
1283 UINT32 CurrentStatus; /* _STA value */
1284 UINT64 Address; /* _ADR value */
1285 ACPI_PNP_DEVICE_ID HardwareId; /* _HID value */
1286 ACPI_PNP_DEVICE_ID UniqueId; /* _UID value */
1287 ACPI_PNP_DEVICE_ID ClassCode; /* _CLS value */
1288 ACPI_PNP_DEVICE_ID_LIST CompatibleIdList; /* _CID list <must be last> */
1289
1290 } ACPI_DEVICE_INFO;
1291
1292 /* Values for Flags field above (AcpiGetObjectInfo) */
1293
1294 #define ACPI_PCI_ROOT_BRIDGE 0x01
1295
1296 /* Flags for Valid field above (AcpiGetObjectInfo) */
1297
1298 #define ACPI_VALID_STA 0x0001
1299 #define ACPI_VALID_ADR 0x0002
1300 #define ACPI_VALID_HID 0x0004
1301 #define ACPI_VALID_UID 0x0008
1302 #define ACPI_VALID_CID 0x0020
1303 #define ACPI_VALID_CLS 0x0040
1304 #define ACPI_VALID_SXDS 0x0100
1305 #define ACPI_VALID_SXWS 0x0200
1306
1307 /* Flags for _STA method */
1308
1309 #define ACPI_STA_DEVICE_PRESENT 0x01
1310 #define ACPI_STA_DEVICE_ENABLED 0x02
1311 #define ACPI_STA_DEVICE_UI 0x04
1312 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1313 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1314 #define ACPI_STA_BATTERY_PRESENT 0x10
1315
1316
1317 /* Context structs for address space handlers */
1318
1319 typedef struct acpi_pci_id
1320 {
1321 UINT16 Segment;
1322 UINT16 Bus;
1323 UINT16 Device;
1324 UINT16 Function;
1325
1326 } ACPI_PCI_ID;
1327
1328 typedef struct acpi_mem_space_context
1329 {
1330 UINT32 Length;
1331 ACPI_PHYSICAL_ADDRESS Address;
1332 ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress;
1333 UINT8 *MappedLogicalAddress;
1334 ACPI_SIZE MappedLength;
1335
1336 } ACPI_MEM_SPACE_CONTEXT;
1337
1338
1339 /*
1340 * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1341 */
1342 typedef struct acpi_memory_list
1343 {
1344 const char *ListName;
1345 void *ListHead;
1346 UINT16 ObjectSize;
1347 UINT16 MaxDepth;
1348 UINT16 CurrentDepth;
1349
1350 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1351
1352 /* Statistics for debug memory tracking only */
1353
1354 UINT32 TotalAllocated;
1355 UINT32 TotalFreed;
1356 UINT32 MaxOccupied;
1357 UINT32 TotalSize;
1358 UINT32 CurrentTotalSize;
1359 UINT32 Requests;
1360 UINT32 Hits;
1361 #endif
1362
1363 } ACPI_MEMORY_LIST;
1364
1365
1366 /* Definitions of trace event types */
1367
1368 typedef enum
1369 {
1370 ACPI_TRACE_AML_METHOD,
1371 ACPI_TRACE_AML_OPCODE,
1372 ACPI_TRACE_AML_REGION
1373
1374 } ACPI_TRACE_EVENT_TYPE;
1375
1376
1377 /* Definitions of _OSI support */
1378
1379 #define ACPI_VENDOR_STRINGS 0x01
1380 #define ACPI_FEATURE_STRINGS 0x02
1381 #define ACPI_ENABLE_INTERFACES 0x00
1382 #define ACPI_DISABLE_INTERFACES 0x04
1383
1384 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1385 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1386 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1387 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1388 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1389 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1390
1391 #define ACPI_OSI_WIN_2000 0x01
1392 #define ACPI_OSI_WIN_XP 0x02
1393 #define ACPI_OSI_WIN_XP_SP1 0x03
1394 #define ACPI_OSI_WINSRV_2003 0x04
1395 #define ACPI_OSI_WIN_XP_SP2 0x05
1396 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1397 #define ACPI_OSI_WIN_VISTA 0x07
1398 #define ACPI_OSI_WINSRV_2008 0x08
1399 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1400 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1401 #define ACPI_OSI_WIN_7 0x0B
1402 #define ACPI_OSI_WIN_8 0x0C
1403 #define ACPI_OSI_WIN_10 0x0D
1404 #define ACPI_OSI_WIN_10_RS1 0x0E
1405 #define ACPI_OSI_WIN_10_RS2 0x0F
1406
1407
1408 /* Definitions of getopt */
1409
1410 #define ACPI_OPT_END -1
1411
1412
1413 #endif /* __ACTYPES_H__ */