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