xref: /openbmc/linux/include/acpi/actypes.h (revision 69fad28c)
1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
3  *
4  * Name: actypes.h - Common data types for the entire ACPI subsystem
5  *
6  * Copyright (C) 2000 - 2018, Intel Corp.
7  *
8  *****************************************************************************/
9 
10 #ifndef __ACTYPES_H__
11 #define __ACTYPES_H__
12 
13 /* acpisrc:struct_defs -- for acpisrc conversion */
14 
15 /*
16  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
17  * header and must be either 32 or 64. 16-bit ACPICA is no longer
18  * supported, as of 12/2006.
19  */
20 #ifndef ACPI_MACHINE_WIDTH
21 #error ACPI_MACHINE_WIDTH not defined
22 #endif
23 
24 /*
25  * Data type ranges
26  * Note: These macros are designed to be compiler independent as well as
27  * working around problems that some 32-bit compilers have with 64-bit
28  * constants.
29  */
30 #define ACPI_UINT8_MAX                  (u8) (~((u8)  0))	/* 0xFF               */
31 #define ACPI_UINT16_MAX                 (u16)(~((u16) 0))	/* 0xFFFF             */
32 #define ACPI_UINT32_MAX                 (u32)(~((u32) 0))	/* 0xFFFFFFFF         */
33 #define ACPI_UINT64_MAX                 (u64)(~((u64) 0))	/* 0xFFFFFFFFFFFFFFFF */
34 #define ACPI_ASCII_MAX                  0x7F
35 
36 /*
37  * Architecture-specific ACPICA Subsystem Data Types
38  *
39  * The goal of these types is to provide source code portability across
40  * 16-bit, 32-bit, and 64-bit targets.
41  *
42  * 1) The following types are of fixed size for all targets (16/32/64):
43  *
44  * u8           Logical boolean
45  *
46  * u8           8-bit  (1 byte) unsigned value
47  * u16          16-bit (2 byte) unsigned value
48  * u32          32-bit (4 byte) unsigned value
49  * u64          64-bit (8 byte) unsigned value
50  *
51  * s16          16-bit (2 byte) signed value
52  * s32          32-bit (4 byte) signed value
53  * s64          64-bit (8 byte) signed value
54  *
55  * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the
56  * compiler-dependent header(s) and were introduced because there is no
57  * common 64-bit integer type across the various compilation models, as
58  * shown in the table below.
59  *
60  * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
61  * char      8    8     8     8     8    8
62  * short     16   16    16    16    16   16
63  * _int32         32
64  * int       32   64    32    32    16   16
65  * long      64   64    32    32    32   32
66  * long long            64    64
67  * pointer   64   64    64    32    32   32
68  *
69  * Note: ILP64 and LP32 are currently not supported.
70  *
71  *
72  * 2) These types represent the native word size of the target mode of the
73  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
74  * usually used for memory allocation, efficient loop counters, and array
75  * indexes. The types are similar to the size_t type in the C library and
76  * are required because there is no C type that consistently represents the
77  * native data width. acpi_size is needed because there is no guarantee
78  * that a kernel-level C library is present.
79  *
80  * acpi_size        16/32/64-bit unsigned value
81  * acpi_native_int  16/32/64-bit signed value
82  */
83 
84 /*******************************************************************************
85  *
86  * Common types for all compilers, all targets
87  *
88  ******************************************************************************/
89 
90 #ifndef ACPI_USE_SYSTEM_INTTYPES
91 
92 typedef unsigned char u8;
93 typedef unsigned short u16;
94 typedef short s16;
95 typedef COMPILER_DEPENDENT_UINT64 u64;
96 typedef COMPILER_DEPENDENT_INT64 s64;
97 
98 #endif				/* ACPI_USE_SYSTEM_INTTYPES */
99 
100 /*
101  * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
102  * across operating systems or even the various UNIX systems. Since ACPICA
103  * only needs the thread ID as a unique thread identifier, we use a u64
104  * as the only common data type - it will accommodate any type of pointer or
105  * any type of integer. It is up to the host-dependent OSL to cast the
106  * native thread ID type to a u64 (in acpi_os_get_thread_id).
107  */
108 #define acpi_thread_id                  u64
109 
110 /*******************************************************************************
111  *
112  * Types specific to 64-bit targets
113  *
114  ******************************************************************************/
115 
116 #if ACPI_MACHINE_WIDTH == 64
117 
118 #ifndef ACPI_USE_SYSTEM_INTTYPES
119 
120 typedef unsigned int u32;
121 typedef int s32;
122 
123 #endif				/* ACPI_USE_SYSTEM_INTTYPES */
124 
125 typedef s64 acpi_native_int;
126 
127 typedef u64 acpi_size;
128 typedef u64 acpi_io_address;
129 typedef u64 acpi_physical_address;
130 
131 #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
132 #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
133 
134 #define ACPI_USE_NATIVE_DIVIDE	/* Has native 64-bit integer support */
135 #define ACPI_USE_NATIVE_MATH64	/* Has native 64-bit integer support */
136 
137 /*
138  * In the case of the Itanium Processor Family (IPF), the hardware does not
139  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
140  * flag to indicate that special precautions must be taken to avoid alignment
141  * faults. (IA64 or ia64 is currently used by existing compilers to indicate
142  * IPF.)
143  *
144  * Note: EM64T and other X86-64 processors support misaligned transfers,
145  * so there is no need to define this flag.
146  */
147 #if defined (__IA64__) || defined (__ia64__)
148 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
149 #endif
150 
151 /*******************************************************************************
152  *
153  * Types specific to 32-bit targets
154  *
155  ******************************************************************************/
156 
157 #elif ACPI_MACHINE_WIDTH == 32
158 
159 #ifndef ACPI_USE_SYSTEM_INTTYPES
160 
161 typedef unsigned int u32;
162 typedef int s32;
163 
164 #endif				/* ACPI_USE_SYSTEM_INTTYPES */
165 
166 typedef s32 acpi_native_int;
167 
168 typedef u32 acpi_size;
169 
170 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
171 
172 /*
173  * OSPMs can define this to shrink the size of the structures for 32-bit
174  * none PAE environment. ASL compiler may always define this to generate
175  * 32-bit OSPM compliant tables.
176  */
177 typedef u32 acpi_io_address;
178 typedef u32 acpi_physical_address;
179 
180 #else				/* ACPI_32BIT_PHYSICAL_ADDRESS */
181 
182 /*
183  * It is reported that, after some calculations, the physical addresses can
184  * wrap over the 32-bit boundary on 32-bit PAE environment.
185  * https://bugzilla.kernel.org/show_bug.cgi?id=87971
186  */
187 typedef u64 acpi_io_address;
188 typedef u64 acpi_physical_address;
189 
190 #endif				/* ACPI_32BIT_PHYSICAL_ADDRESS */
191 
192 #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
193 #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
194 
195 #else
196 
197 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
198 
199 #error unknown ACPI_MACHINE_WIDTH
200 #endif
201 
202 /*******************************************************************************
203  *
204  * OS-dependent types
205  *
206  * If the defaults below are not appropriate for the host system, they can
207  * be defined in the OS-specific header, and this will take precedence.
208  *
209  ******************************************************************************/
210 
211 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
212 
213 #ifndef acpi_cpu_flags
214 #define acpi_cpu_flags			acpi_size
215 #endif
216 
217 /* Object returned from acpi_os_create_cache */
218 
219 #ifndef acpi_cache_t
220 #ifdef ACPI_USE_LOCAL_CACHE
221 #define acpi_cache_t                    struct acpi_memory_list
222 #else
223 #define acpi_cache_t                    void *
224 #endif
225 #endif
226 
227 /*
228  * Synchronization objects - Mutexes, Semaphores, and spin_locks
229  */
230 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
231 /*
232  * These macros are used if the host OS does not support a mutex object.
233  * Map the OSL Mutex interfaces to binary semaphores.
234  */
235 #define acpi_mutex                      acpi_semaphore
236 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
237 #define acpi_os_delete_mutex(handle)    (void) acpi_os_delete_semaphore (handle)
238 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
239 #define acpi_os_release_mutex(handle)   (void) acpi_os_signal_semaphore (handle, 1)
240 #endif
241 
242 /* Configurable types for synchronization objects */
243 
244 #ifndef acpi_spinlock
245 #define acpi_spinlock                   void *
246 #endif
247 
248 #ifndef acpi_raw_spinlock
249 #define acpi_raw_spinlock		acpi_spinlock
250 #endif
251 
252 #ifndef acpi_semaphore
253 #define acpi_semaphore                  void *
254 #endif
255 
256 #ifndef acpi_mutex
257 #define acpi_mutex                      void *
258 #endif
259 
260 /*******************************************************************************
261  *
262  * Compiler-dependent types
263  *
264  * If the defaults below are not appropriate for the host compiler, they can
265  * be defined in the compiler-specific header, and this will take precedence.
266  *
267  ******************************************************************************/
268 
269 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
270 
271 #ifndef acpi_uintptr_t
272 #define acpi_uintptr_t                  void *
273 #endif
274 
275 /*
276  * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
277  * some compilers can catch printf format string problems
278  */
279 #ifndef ACPI_PRINTF_LIKE
280 #define ACPI_PRINTF_LIKE(c)
281 #endif
282 
283 /*
284  * Some compilers complain about unused variables. Sometimes we don't want
285  * to use all the variables (for example, _acpi_module_name). This allows us
286  * to tell the compiler in a per-variable manner that a variable
287  * is unused
288  */
289 #ifndef ACPI_UNUSED_VAR
290 #define ACPI_UNUSED_VAR
291 #endif
292 
293 /*
294  * All ACPICA external functions that are available to the rest of the
295  * kernel are tagged with these macros which can be defined as appropriate
296  * for the host.
297  *
298  * Notes:
299  * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
300  * interfaces that may need special processing.
301  * ACPI_EXPORT_SYMBOL is used for all other public external functions.
302  */
303 #ifndef ACPI_EXPORT_SYMBOL_INIT
304 #define ACPI_EXPORT_SYMBOL_INIT(symbol)
305 #endif
306 
307 #ifndef ACPI_EXPORT_SYMBOL
308 #define ACPI_EXPORT_SYMBOL(symbol)
309 #endif
310 
311 /*
312  * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
313  * utilities only.
314  */
315 #ifndef ACPI_DEBUG_INITIALIZE
316 #define ACPI_DEBUG_INITIALIZE()
317 #endif
318 
319 /*******************************************************************************
320  *
321  * Configuration
322  *
323  ******************************************************************************/
324 
325 #ifdef ACPI_NO_MEM_ALLOCATIONS
326 
327 #define ACPI_ALLOCATE(a)                NULL
328 #define ACPI_ALLOCATE_ZEROED(a)         NULL
329 #define ACPI_FREE(a)
330 #define ACPI_MEM_TRACKING(a)
331 
332 #else				/* ACPI_NO_MEM_ALLOCATIONS */
333 
334 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
335 /*
336  * Memory allocation tracking (used by acpi_exec to detect memory leaks)
337  */
338 #define ACPI_MEM_PARAMETERS             _COMPONENT, _acpi_module_name, __LINE__
339 #define ACPI_ALLOCATE(a)                acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
340 #define ACPI_ALLOCATE_ZEROED(a)         acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
341 #define ACPI_FREE(a)                    acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS)
342 #define ACPI_MEM_TRACKING(a)            a
343 
344 #else
345 /*
346  * Normal memory allocation directly via the OS services layer
347  */
348 #define ACPI_ALLOCATE(a)                acpi_os_allocate ((acpi_size) (a))
349 #define ACPI_ALLOCATE_ZEROED(a)         acpi_os_allocate_zeroed ((acpi_size) (a))
350 #define ACPI_FREE(a)                    acpi_os_free (a)
351 #define ACPI_MEM_TRACKING(a)
352 
353 #endif				/* ACPI_DBG_TRACK_ALLOCATIONS */
354 
355 #endif				/* ACPI_NO_MEM_ALLOCATIONS */
356 
357 /******************************************************************************
358  *
359  * ACPI Specification constants (Do not change unless the specification
360  * changes)
361  *
362  *****************************************************************************/
363 
364 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
365 
366 #define ACPI_MAX_GPE_BLOCKS             2
367 
368 /* Default ACPI register widths */
369 
370 #define ACPI_GPE_REGISTER_WIDTH         8
371 #define ACPI_PM1_REGISTER_WIDTH         16
372 #define ACPI_PM2_REGISTER_WIDTH         8
373 #define ACPI_PM_TIMER_WIDTH             32
374 #define ACPI_RESET_REGISTER_WIDTH       8
375 
376 /* Names within the namespace are 4 bytes long */
377 
378 #define ACPI_NAME_SIZE                  4
379 #define ACPI_PATH_SEGMENT_LENGTH        5	/* 4 chars for name + 1 char for separator */
380 #define ACPI_PATH_SEPARATOR             '.'
381 
382 /* Sizes for ACPI table headers */
383 
384 #define ACPI_OEM_ID_SIZE                6
385 #define ACPI_OEM_TABLE_ID_SIZE          8
386 
387 /* ACPI/PNP hardware IDs */
388 
389 #define PCI_ROOT_HID_STRING             "PNP0A03"
390 #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
391 
392 /* PM Timer ticks per second (HZ) */
393 
394 #define ACPI_PM_TIMER_FREQUENCY         3579545
395 
396 /*******************************************************************************
397  *
398  * Independent types
399  *
400  ******************************************************************************/
401 
402 /* Logical defines and NULL */
403 
404 #ifdef FALSE
405 #undef FALSE
406 #endif
407 #define FALSE                           (1 == 0)
408 
409 #ifdef TRUE
410 #undef TRUE
411 #endif
412 #define TRUE                            (1 == 1)
413 
414 #ifndef NULL
415 #define NULL                            (void *) 0
416 #endif
417 
418 /*
419  * Miscellaneous types
420  */
421 typedef u32 acpi_status;	/* All ACPI Exceptions */
422 typedef u32 acpi_name;		/* 4-byte ACPI name */
423 typedef char *acpi_string;	/* Null terminated ASCII string */
424 typedef void *acpi_handle;	/* Actually a ptr to a NS Node */
425 
426 /* Time constants for timer calculations */
427 
428 #define ACPI_MSEC_PER_SEC               1000L
429 
430 #define ACPI_USEC_PER_MSEC              1000L
431 #define ACPI_USEC_PER_SEC               1000000L
432 
433 #define ACPI_100NSEC_PER_USEC           10L
434 #define ACPI_100NSEC_PER_MSEC           10000L
435 #define ACPI_100NSEC_PER_SEC            10000000L
436 
437 #define ACPI_NSEC_PER_USEC              1000L
438 #define ACPI_NSEC_PER_MSEC              1000000L
439 #define ACPI_NSEC_PER_SEC               1000000000L
440 
441 #define ACPI_TIME_AFTER(a, b)           ((s64)((b) - (a)) < 0)
442 
443 /* Owner IDs are used to track namespace nodes for selective deletion */
444 
445 typedef u8 acpi_owner_id;
446 #define ACPI_OWNER_ID_MAX               0xFF
447 
448 #define ACPI_INTEGER_BIT_SIZE           64
449 #define ACPI_MAX_DECIMAL_DIGITS         20	/* 2^64 = 18,446,744,073,709,551,616 */
450 #define ACPI_MAX64_DECIMAL_DIGITS       20
451 #define ACPI_MAX32_DECIMAL_DIGITS       10
452 #define ACPI_MAX16_DECIMAL_DIGITS        5
453 #define ACPI_MAX8_DECIMAL_DIGITS         3
454 
455 /*
456  * Constants with special meanings
457  */
458 #define ACPI_ROOT_OBJECT                ((acpi_handle) ACPI_TO_POINTER (ACPI_MAX_PTR))
459 #define ACPI_WAIT_FOREVER               0xFFFF	/* u16, as per ACPI spec */
460 #define ACPI_DO_NOT_WAIT                0
461 
462 /*
463  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
464  * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
465  * Note that this pertains to the ACPI integer type only, not to other
466  * integers used in the implementation of the ACPICA subsystem.
467  *
468  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
469  * code base. It remains here for compatibility with device drivers that use
470  * the type. However, it will be removed in the future.
471  */
472 typedef u64 acpi_integer;
473 #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
474 
475 /*******************************************************************************
476  *
477  * Commonly used macros
478  *
479  ******************************************************************************/
480 
481 /* Data manipulation */
482 
483 #define ACPI_LOBYTE(integer)            ((u8)   (u16)(integer))
484 #define ACPI_HIBYTE(integer)            ((u8) (((u16)(integer)) >> 8))
485 #define ACPI_LOWORD(integer)            ((u16)  (u32)(integer))
486 #define ACPI_HIWORD(integer)            ((u16)(((u32)(integer)) >> 16))
487 #define ACPI_LODWORD(integer64)         ((u32)  (u64)(integer64))
488 #define ACPI_HIDWORD(integer64)         ((u32)(((u64)(integer64)) >> 32))
489 
490 #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
491 #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
492 #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
493 #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
494 
495 /* Size calculation */
496 
497 #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
498 
499 /* Pointer manipulation */
500 
501 #define ACPI_CAST_PTR(t, p)             ((t *) (acpi_uintptr_t) (p))
502 #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (acpi_uintptr_t) (p))
503 #define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
504 #define ACPI_SUB_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) - (acpi_size)(b)))
505 #define ACPI_PTR_DIFF(a, b)             ((acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b))))
506 
507 /* Pointer/Integer type conversions */
508 
509 #define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) 0, (acpi_size) (i))
510 #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) 0)
511 #define ACPI_OFFSET(d, f)               ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) 0)
512 #define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
513 #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
514 
515 /* Optimizations for 4-character (32-bit) acpi_name manipulation */
516 
517 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
518 #define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
519 #define ACPI_MOVE_NAME(dest,src)        (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
520 #else
521 #define ACPI_COMPARE_NAME(a,b)          (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
522 #define ACPI_MOVE_NAME(dest,src)        (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
523 #endif
524 
525 /* Support for the special RSDP signature (8 characters) */
526 
527 #define ACPI_VALIDATE_RSDP_SIG(a)       (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
528 #define ACPI_MAKE_RSDP_SIG(dest)        (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
529 
530 /* Support for OEMx signature (x can be any character) */
531 #define ACPI_IS_OEM_SIG(a)        (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_OEM_NAME, 3) &&\
532 	 strnlen (a, ACPI_NAME_SIZE) == ACPI_NAME_SIZE)
533 
534 /*
535  * Algorithm to obtain access bit width.
536  * Can be used with access_width of struct acpi_generic_address and access_size of
537  * struct acpi_resource_generic_register.
538  */
539 #define ACPI_ACCESS_BIT_WIDTH(size)     (1 << ((size) + 2))
540 
541 /*******************************************************************************
542  *
543  * Miscellaneous constants
544  *
545  ******************************************************************************/
546 
547 /*
548  * Initialization sequence options
549  */
550 #define ACPI_FULL_INITIALIZATION        0x0000
551 #define ACPI_NO_FACS_INIT               0x0001
552 #define ACPI_NO_ACPI_ENABLE             0x0002
553 #define ACPI_NO_HARDWARE_INIT           0x0004
554 #define ACPI_NO_EVENT_INIT              0x0008
555 #define ACPI_NO_HANDLER_INIT            0x0010
556 #define ACPI_NO_OBJECT_INIT             0x0020
557 #define ACPI_NO_DEVICE_INIT             0x0040
558 #define ACPI_NO_ADDRESS_SPACE_INIT      0x0080
559 
560 /*
561  * Initialization state
562  */
563 #define ACPI_SUBSYSTEM_INITIALIZE       0x01
564 #define ACPI_INITIALIZED_OK             0x02
565 
566 /*
567  * Power state values
568  */
569 #define ACPI_STATE_UNKNOWN              (u8) 0xFF
570 
571 #define ACPI_STATE_S0                   (u8) 0
572 #define ACPI_STATE_S1                   (u8) 1
573 #define ACPI_STATE_S2                   (u8) 2
574 #define ACPI_STATE_S3                   (u8) 3
575 #define ACPI_STATE_S4                   (u8) 4
576 #define ACPI_STATE_S5                   (u8) 5
577 #define ACPI_S_STATES_MAX               ACPI_STATE_S5
578 #define ACPI_S_STATE_COUNT              6
579 
580 #define ACPI_STATE_D0                   (u8) 0
581 #define ACPI_STATE_D1                   (u8) 1
582 #define ACPI_STATE_D2                   (u8) 2
583 #define ACPI_STATE_D3_HOT               (u8) 3
584 #define ACPI_STATE_D3                   (u8) 4
585 #define ACPI_STATE_D3_COLD              ACPI_STATE_D3
586 #define ACPI_D_STATES_MAX               ACPI_STATE_D3
587 #define ACPI_D_STATE_COUNT              5
588 
589 #define ACPI_STATE_C0                   (u8) 0
590 #define ACPI_STATE_C1                   (u8) 1
591 #define ACPI_STATE_C2                   (u8) 2
592 #define ACPI_STATE_C3                   (u8) 3
593 #define ACPI_C_STATES_MAX               ACPI_STATE_C3
594 #define ACPI_C_STATE_COUNT              4
595 
596 /*
597  * Sleep type invalid value
598  */
599 #define ACPI_SLEEP_TYPE_MAX             0x7
600 #define ACPI_SLEEP_TYPE_INVALID         0xFF
601 
602 /*
603  * Standard notify values
604  */
605 #define ACPI_NOTIFY_BUS_CHECK           (u8) 0x00
606 #define ACPI_NOTIFY_DEVICE_CHECK        (u8) 0x01
607 #define ACPI_NOTIFY_DEVICE_WAKE         (u8) 0x02
608 #define ACPI_NOTIFY_EJECT_REQUEST       (u8) 0x03
609 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (u8) 0x04
610 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (u8) 0x05
611 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (u8) 0x06
612 #define ACPI_NOTIFY_POWER_FAULT         (u8) 0x07
613 #define ACPI_NOTIFY_CAPABILITIES_CHECK  (u8) 0x08
614 #define ACPI_NOTIFY_DEVICE_PLD_CHECK    (u8) 0x09
615 #define ACPI_NOTIFY_RESERVED            (u8) 0x0A
616 #define ACPI_NOTIFY_LOCALITY_UPDATE     (u8) 0x0B
617 #define ACPI_NOTIFY_SHUTDOWN_REQUEST    (u8) 0x0C
618 #define ACPI_NOTIFY_AFFINITY_UPDATE     (u8) 0x0D
619 #define ACPI_NOTIFY_MEMORY_UPDATE       (u8) 0x0E
620 
621 #define ACPI_GENERIC_NOTIFY_MAX         0x0E
622 #define ACPI_SPECIFIC_NOTIFY_MAX        0x84
623 
624 /*
625  * Types associated with ACPI names and objects. The first group of
626  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
627  * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
628  * only add to the first group if the spec changes.
629  *
630  * NOTE: Types must be kept in sync with the global acpi_ns_properties
631  * and acpi_ns_type_names arrays.
632  */
633 typedef u32 acpi_object_type;
634 
635 #define ACPI_TYPE_ANY                   0x00
636 #define ACPI_TYPE_INTEGER               0x01	/* Byte/Word/Dword/Zero/One/Ones */
637 #define ACPI_TYPE_STRING                0x02
638 #define ACPI_TYPE_BUFFER                0x03
639 #define ACPI_TYPE_PACKAGE               0x04	/* byte_const, multiple data_term/Constant/super_name */
640 #define ACPI_TYPE_FIELD_UNIT            0x05
641 #define ACPI_TYPE_DEVICE                0x06	/* Name, multiple Node */
642 #define ACPI_TYPE_EVENT                 0x07
643 #define ACPI_TYPE_METHOD                0x08	/* Name, byte_const, multiple Code */
644 #define ACPI_TYPE_MUTEX                 0x09
645 #define ACPI_TYPE_REGION                0x0A
646 #define ACPI_TYPE_POWER                 0x0B	/* Name,byte_const,word_const,multi Node */
647 #define ACPI_TYPE_PROCESSOR             0x0C	/* Name,byte_const,Dword_const,byte_const,multi nm_o */
648 #define ACPI_TYPE_THERMAL               0x0D	/* Name, multiple Node */
649 #define ACPI_TYPE_BUFFER_FIELD          0x0E
650 #define ACPI_TYPE_DDB_HANDLE            0x0F
651 #define ACPI_TYPE_DEBUG_OBJECT          0x10
652 
653 #define ACPI_TYPE_EXTERNAL_MAX          0x10
654 #define ACPI_NUM_TYPES                  (ACPI_TYPE_EXTERNAL_MAX + 1)
655 
656 /*
657  * These are object types that do not map directly to the ACPI
658  * object_type() operator. They are used for various internal purposes
659  * only. If new predefined ACPI_TYPEs are added (via the ACPI
660  * specification), these internal types must move upwards. (There
661  * is code that depends on these values being contiguous with the
662  * external types above.)
663  */
664 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
665 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
666 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
667 #define ACPI_TYPE_LOCAL_REFERENCE       0x14	/* Arg#, Local#, Name, Debug, ref_of, Index */
668 #define ACPI_TYPE_LOCAL_ALIAS           0x15
669 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
670 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
671 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
672 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
673 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
674 #define ACPI_TYPE_LOCAL_SCOPE           0x1B	/* 1 Name, multiple object_list Nodes */
675 
676 #define ACPI_TYPE_NS_NODE_MAX           0x1B	/* Last typecode used within a NS Node */
677 #define ACPI_TOTAL_TYPES                (ACPI_TYPE_NS_NODE_MAX + 1)
678 
679 /*
680  * These are special object types that never appear in
681  * a Namespace node, only in an object of union acpi_operand_object
682  */
683 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
684 #define ACPI_TYPE_LOCAL_DATA            0x1D
685 
686 #define ACPI_TYPE_LOCAL_MAX             0x1D
687 
688 /* All types above here are invalid */
689 
690 #define ACPI_TYPE_INVALID               0x1E
691 #define ACPI_TYPE_NOT_FOUND             0xFF
692 
693 #define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
694 
695 /*
696  * All I/O
697  */
698 #define ACPI_READ                       0
699 #define ACPI_WRITE                      1
700 #define ACPI_IO_MASK                    1
701 
702 /*
703  * Event Types: Fixed & General Purpose
704  */
705 typedef u32 acpi_event_type;
706 
707 /*
708  * Fixed events
709  */
710 #define ACPI_EVENT_PMTIMER              0
711 #define ACPI_EVENT_GLOBAL               1
712 #define ACPI_EVENT_POWER_BUTTON         2
713 #define ACPI_EVENT_SLEEP_BUTTON         3
714 #define ACPI_EVENT_RTC                  4
715 #define ACPI_EVENT_MAX                  4
716 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
717 
718 /*
719  * Event status - Per event
720  * -------------
721  * The encoding of acpi_event_status is illustrated below.
722  * Note that a set bit (1) indicates the property is TRUE
723  * (e.g. if bit 0 is set then the event is enabled).
724  * +-------------+-+-+-+-+-+-+
725  * |   Bits 31:6 |5|4|3|2|1|0|
726  * +-------------+-+-+-+-+-+-+
727  *          |     | | | | | |
728  *          |     | | | | | +- Enabled?
729  *          |     | | | | +--- Enabled for wake?
730  *          |     | | | +----- Status bit set?
731  *          |     | | +------- Enable bit set?
732  *          |     | +--------- Has a handler?
733  *          |     +----------- Masked?
734  *          +----------------- <Reserved>
735  */
736 typedef u32 acpi_event_status;
737 
738 #define ACPI_EVENT_FLAG_DISABLED        (acpi_event_status) 0x00
739 #define ACPI_EVENT_FLAG_ENABLED         (acpi_event_status) 0x01
740 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (acpi_event_status) 0x02
741 #define ACPI_EVENT_FLAG_STATUS_SET      (acpi_event_status) 0x04
742 #define ACPI_EVENT_FLAG_ENABLE_SET      (acpi_event_status) 0x08
743 #define ACPI_EVENT_FLAG_HAS_HANDLER     (acpi_event_status) 0x10
744 #define ACPI_EVENT_FLAG_MASKED          (acpi_event_status) 0x20
745 #define ACPI_EVENT_FLAG_SET             ACPI_EVENT_FLAG_STATUS_SET
746 
747 /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
748 
749 #define ACPI_GPE_ENABLE                 0
750 #define ACPI_GPE_DISABLE                1
751 #define ACPI_GPE_CONDITIONAL_ENABLE     2
752 
753 /*
754  * GPE info flags - Per GPE
755  * +---+-+-+-+---+
756  * |7:6|5|4|3|2:0|
757  * +---+-+-+-+---+
758  *   |  | | |  |
759  *   |  | | |  +-- Type of dispatch:to method, handler, notify, or none
760  *   |  | | +----- Interrupt type: edge or level triggered
761  *   |  | +------- Is a Wake GPE
762  *   |  +--------- Has been enabled automatically at init time
763  *   +------------ <Reserved>
764  */
765 #define ACPI_GPE_DISPATCH_NONE          (u8) 0x00
766 #define ACPI_GPE_DISPATCH_METHOD        (u8) 0x01
767 #define ACPI_GPE_DISPATCH_HANDLER       (u8) 0x02
768 #define ACPI_GPE_DISPATCH_NOTIFY        (u8) 0x03
769 #define ACPI_GPE_DISPATCH_RAW_HANDLER   (u8) 0x04
770 #define ACPI_GPE_DISPATCH_MASK          (u8) 0x07
771 #define ACPI_GPE_DISPATCH_TYPE(flags)   ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
772 
773 #define ACPI_GPE_LEVEL_TRIGGERED        (u8) 0x08
774 #define ACPI_GPE_EDGE_TRIGGERED         (u8) 0x00
775 #define ACPI_GPE_XRUPT_TYPE_MASK        (u8) 0x08
776 
777 #define ACPI_GPE_CAN_WAKE               (u8) 0x10
778 #define ACPI_GPE_AUTO_ENABLED           (u8) 0x20
779 #define ACPI_GPE_INITIALIZED            (u8) 0x40
780 
781 /*
782  * Flags for GPE and Lock interfaces
783  */
784 #define ACPI_NOT_ISR                    0x1
785 #define ACPI_ISR                        0x0
786 
787 /* Notify types */
788 
789 #define ACPI_SYSTEM_NOTIFY              0x1
790 #define ACPI_DEVICE_NOTIFY              0x2
791 #define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
792 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
793 #define ACPI_NUM_NOTIFY_TYPES           2
794 
795 #define ACPI_MAX_SYS_NOTIFY             0x7F
796 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
797 
798 #define ACPI_SYSTEM_HANDLER_LIST        0	/* Used as index, must be SYSTEM_NOTIFY -1 */
799 #define ACPI_DEVICE_HANDLER_LIST        1	/* Used as index, must be DEVICE_NOTIFY -1 */
800 
801 /* Address Space (Operation Region) Types */
802 
803 typedef u8 acpi_adr_space_type;
804 
805 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (acpi_adr_space_type) 0
806 #define ACPI_ADR_SPACE_SYSTEM_IO        (acpi_adr_space_type) 1
807 #define ACPI_ADR_SPACE_PCI_CONFIG       (acpi_adr_space_type) 2
808 #define ACPI_ADR_SPACE_EC               (acpi_adr_space_type) 3
809 #define ACPI_ADR_SPACE_SMBUS            (acpi_adr_space_type) 4
810 #define ACPI_ADR_SPACE_CMOS             (acpi_adr_space_type) 5
811 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (acpi_adr_space_type) 6
812 #define ACPI_ADR_SPACE_IPMI             (acpi_adr_space_type) 7
813 #define ACPI_ADR_SPACE_GPIO             (acpi_adr_space_type) 8
814 #define ACPI_ADR_SPACE_GSBUS            (acpi_adr_space_type) 9
815 #define ACPI_ADR_SPACE_PLATFORM_COMM    (acpi_adr_space_type) 10
816 
817 #define ACPI_NUM_PREDEFINED_REGIONS     11
818 
819 /*
820  * Special Address Spaces
821  *
822  * Note: A Data Table region is a special type of operation region
823  * that has its own AML opcode. However, internally, the AML
824  * interpreter simply creates an operation region with an an address
825  * space type of ACPI_ADR_SPACE_DATA_TABLE.
826  */
827 #define ACPI_ADR_SPACE_DATA_TABLE       (acpi_adr_space_type) 0x7E	/* Internal to ACPICA only */
828 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (acpi_adr_space_type) 0x7F
829 
830 /* Values for _REG connection code */
831 
832 #define ACPI_REG_DISCONNECT             0
833 #define ACPI_REG_CONNECT                1
834 
835 /*
836  * bit_register IDs
837  *
838  * These values are intended to be used by the hardware interfaces
839  * and are mapped to individual bitfields defined within the ACPI
840  * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
841  * for this mapping.
842  */
843 
844 /* PM1 Status register */
845 
846 #define ACPI_BITREG_TIMER_STATUS                0x00
847 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
848 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
849 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
850 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
851 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
852 #define ACPI_BITREG_WAKE_STATUS                 0x06
853 #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
854 
855 /* PM1 Enable register */
856 
857 #define ACPI_BITREG_TIMER_ENABLE                0x08
858 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
859 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
860 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
861 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
862 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
863 
864 /* PM1 Control register */
865 
866 #define ACPI_BITREG_SCI_ENABLE                  0x0E
867 #define ACPI_BITREG_BUS_MASTER_RLD              0x0F
868 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
869 #define ACPI_BITREG_SLEEP_TYPE                  0x11
870 #define ACPI_BITREG_SLEEP_ENABLE                0x12
871 
872 /* PM2 Control register */
873 
874 #define ACPI_BITREG_ARB_DISABLE                 0x13
875 
876 #define ACPI_BITREG_MAX                         0x13
877 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
878 
879 /* Status register values. A 1 clears a status bit. 0 = no effect */
880 
881 #define ACPI_CLEAR_STATUS                       1
882 
883 /* Enable and Control register values */
884 
885 #define ACPI_ENABLE_EVENT                       1
886 #define ACPI_DISABLE_EVENT                      0
887 
888 /* Sleep function dispatch */
889 
890 typedef acpi_status (*acpi_sleep_function) (u8 sleep_state);
891 
892 struct acpi_sleep_functions {
893 	acpi_sleep_function legacy_function;
894 	acpi_sleep_function extended_function;
895 };
896 
897 /*
898  * External ACPI object definition
899  */
900 
901 /*
902  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
903  * element or an unresolved named reference.
904  */
905 union acpi_object {
906 	acpi_object_type type;	/* See definition of acpi_ns_type for values */
907 	struct {
908 		acpi_object_type type;	/* ACPI_TYPE_INTEGER */
909 		u64 value;	/* The actual number */
910 	} integer;
911 
912 	struct {
913 		acpi_object_type type;	/* ACPI_TYPE_STRING */
914 		u32 length;	/* # of bytes in string, excluding trailing null */
915 		char *pointer;	/* points to the string value */
916 	} string;
917 
918 	struct {
919 		acpi_object_type type;	/* ACPI_TYPE_BUFFER */
920 		u32 length;	/* # of bytes in buffer */
921 		u8 *pointer;	/* points to the buffer */
922 	} buffer;
923 
924 	struct {
925 		acpi_object_type type;	/* ACPI_TYPE_PACKAGE */
926 		u32 count;	/* # of elements in package */
927 		union acpi_object *elements;	/* Pointer to an array of ACPI_OBJECTs */
928 	} package;
929 
930 	struct {
931 		acpi_object_type type;	/* ACPI_TYPE_LOCAL_REFERENCE */
932 		acpi_object_type actual_type;	/* Type associated with the Handle */
933 		acpi_handle handle;	/* object reference */
934 	} reference;
935 
936 	struct {
937 		acpi_object_type type;	/* ACPI_TYPE_PROCESSOR */
938 		u32 proc_id;
939 		acpi_io_address pblk_address;
940 		u32 pblk_length;
941 	} processor;
942 
943 	struct {
944 		acpi_object_type type;	/* ACPI_TYPE_POWER */
945 		u32 system_level;
946 		u32 resource_order;
947 	} power_resource;
948 };
949 
950 /*
951  * List of objects, used as a parameter list for control method evaluation
952  */
953 struct acpi_object_list {
954 	u32 count;
955 	union acpi_object *pointer;
956 };
957 
958 /*
959  * Miscellaneous common Data Structures used by the interfaces
960  */
961 #define ACPI_NO_BUFFER              0
962 
963 #ifdef ACPI_NO_MEM_ALLOCATIONS
964 
965 #define ACPI_ALLOCATE_BUFFER        (acpi_size) (0)
966 #define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (0)
967 
968 #else				/* ACPI_NO_MEM_ALLOCATIONS */
969 
970 #define ACPI_ALLOCATE_BUFFER        (acpi_size) (-1)	/* Let ACPICA allocate buffer */
971 #define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (-2)	/* For internal use only (enables tracking) */
972 
973 #endif				/* ACPI_NO_MEM_ALLOCATIONS */
974 
975 struct acpi_buffer {
976 	acpi_size length;	/* Length in bytes of the buffer */
977 	void *pointer;		/* pointer to buffer */
978 };
979 
980 /*
981  * name_type for acpi_get_name
982  */
983 #define ACPI_FULL_PATHNAME              0
984 #define ACPI_SINGLE_NAME                1
985 #define ACPI_FULL_PATHNAME_NO_TRAILING  2
986 #define ACPI_NAME_TYPE_MAX              2
987 
988 /*
989  * Predefined Namespace items
990  */
991 struct acpi_predefined_names {
992 	const char *name;
993 	u8 type;
994 	char *val;
995 };
996 
997 /*
998  * Structure and flags for acpi_get_system_info
999  */
1000 #define ACPI_SYS_MODE_UNKNOWN           0x0000
1001 #define ACPI_SYS_MODE_ACPI              0x0001
1002 #define ACPI_SYS_MODE_LEGACY            0x0002
1003 #define ACPI_SYS_MODES_MASK             0x0003
1004 
1005 /*
1006  * System info returned by acpi_get_system_info()
1007  */
1008 struct acpi_system_info {
1009 	u32 acpi_ca_version;
1010 	u32 flags;
1011 	u32 timer_resolution;
1012 	u32 reserved1;
1013 	u32 reserved2;
1014 	u32 debug_level;
1015 	u32 debug_layer;
1016 };
1017 
1018 /*
1019  * System statistics returned by acpi_get_statistics()
1020  */
1021 struct acpi_statistics {
1022 	u32 sci_count;
1023 	u32 gpe_count;
1024 	u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
1025 	u32 method_count;
1026 };
1027 
1028 /*
1029  * Types specific to the OS service interfaces
1030  */
1031 typedef u32
1032  (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
1033 
1034 typedef void
1035  (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
1036 
1037 /*
1038  * Various handlers and callback procedures
1039  */
1040 typedef
1041 u32 (*acpi_sci_handler) (void *context);
1042 
1043 typedef
1044 void (*acpi_gbl_event_handler) (u32 event_type,
1045 			       acpi_handle device,
1046 			       u32 event_number, void *context);
1047 
1048 #define ACPI_EVENT_TYPE_GPE         0
1049 #define ACPI_EVENT_TYPE_FIXED       1
1050 
1051 typedef
1052 u32(*acpi_event_handler) (void *context);
1053 
1054 typedef
1055 u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
1056 
1057 typedef
1058 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
1059 
1060 typedef
1061 void (*acpi_object_handler) (acpi_handle object, void *data);
1062 
1063 typedef
1064 acpi_status (*acpi_init_handler) (acpi_handle object, u32 function);
1065 
1066 #define ACPI_INIT_DEVICE_INI        1
1067 
1068 typedef
1069 acpi_status (*acpi_exception_handler) (acpi_status aml_status,
1070 				       acpi_name name,
1071 				       u16 opcode,
1072 				       u32 aml_offset, void *context);
1073 
1074 /* Table Event handler (Load, load_table, etc.) and types */
1075 
1076 typedef
1077 acpi_status (*acpi_table_handler) (u32 event, void *table, void *context);
1078 
1079 /* Table Event Types */
1080 
1081 #define ACPI_TABLE_EVENT_LOAD           0x0
1082 #define ACPI_TABLE_EVENT_UNLOAD         0x1
1083 #define ACPI_TABLE_EVENT_INSTALL        0x2
1084 #define ACPI_TABLE_EVENT_UNINSTALL      0x3
1085 #define ACPI_NUM_TABLE_EVENTS           4
1086 
1087 /* Address Spaces (For Operation Regions) */
1088 
1089 typedef
1090 acpi_status (*acpi_adr_space_handler) (u32 function,
1091 				       acpi_physical_address address,
1092 				       u32 bit_width,
1093 				       u64 *value,
1094 				       void *handler_context,
1095 				       void *region_context);
1096 
1097 #define ACPI_DEFAULT_HANDLER            NULL
1098 
1099 /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
1100 
1101 struct acpi_connection_info {
1102 	u8 *connection;
1103 	u16 length;
1104 	u8 access_length;
1105 };
1106 
1107 typedef
1108 acpi_status (*acpi_adr_space_setup) (acpi_handle region_handle,
1109 				     u32 function,
1110 				     void *handler_context,
1111 				     void **region_context);
1112 
1113 #define ACPI_REGION_ACTIVATE    0
1114 #define ACPI_REGION_DEACTIVATE  1
1115 
1116 typedef
1117 acpi_status (*acpi_walk_callback) (acpi_handle object,
1118 				   u32 nesting_level,
1119 				   void *context, void **return_value);
1120 
1121 typedef
1122 u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1123 
1124 /* Interrupt handler return values */
1125 
1126 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
1127 #define ACPI_INTERRUPT_HANDLED          0x01
1128 
1129 /* GPE handler return values */
1130 
1131 #define ACPI_REENABLE_GPE               0x80
1132 
1133 /* Length of 32-bit EISAID values when converted back to a string */
1134 
1135 #define ACPI_EISAID_STRING_SIZE         8	/* Includes null terminator */
1136 
1137 /* Length of UUID (string) values */
1138 
1139 #define ACPI_UUID_LENGTH                16
1140 
1141 /* Length of 3-byte PCI class code values when converted back to a string */
1142 
1143 #define ACPI_PCICLS_STRING_SIZE         7	/* Includes null terminator */
1144 
1145 /* Structures used for device/processor HID, UID, CID */
1146 
1147 struct acpi_pnp_device_id {
1148 	u32 length;		/* Length of string + null */
1149 	char *string;
1150 };
1151 
1152 struct acpi_pnp_device_id_list {
1153 	u32 count;		/* Number of IDs in Ids array */
1154 	u32 list_size;		/* Size of list, including ID strings */
1155 	struct acpi_pnp_device_id ids[1];	/* ID array */
1156 };
1157 
1158 /*
1159  * Structure returned from acpi_get_object_info.
1160  * Optimized for both 32-bit and 64-bit builds.
1161  */
1162 struct acpi_device_info {
1163 	u32 info_size;		/* Size of info, including ID strings */
1164 	u32 name;		/* ACPI object Name */
1165 	acpi_object_type type;	/* ACPI object Type */
1166 	u8 param_count;		/* If a method, required parameter count */
1167 	u16 valid;		/* Indicates which optional fields are valid */
1168 	u8 flags;		/* Miscellaneous info */
1169 	u8 highest_dstates[4];	/* _sx_d values: 0xFF indicates not valid */
1170 	u8 lowest_dstates[5];	/* _sx_w values: 0xFF indicates not valid */
1171 	u64 address;	/* _ADR value */
1172 	struct acpi_pnp_device_id hardware_id;	/* _HID value */
1173 	struct acpi_pnp_device_id unique_id;	/* _UID value */
1174 	struct acpi_pnp_device_id class_code;	/* _CLS value */
1175 	struct acpi_pnp_device_id_list compatible_id_list;	/* _CID list <must be last> */
1176 };
1177 
1178 /* Values for Flags field above (acpi_get_object_info) */
1179 
1180 #define ACPI_PCI_ROOT_BRIDGE            0x01
1181 
1182 /* Flags for Valid field above (acpi_get_object_info) */
1183 
1184 #define ACPI_VALID_ADR                  0x0002
1185 #define ACPI_VALID_HID                  0x0004
1186 #define ACPI_VALID_UID                  0x0008
1187 #define ACPI_VALID_CID                  0x0020
1188 #define ACPI_VALID_CLS                  0x0040
1189 #define ACPI_VALID_SXDS                 0x0100
1190 #define ACPI_VALID_SXWS                 0x0200
1191 
1192 /* Flags for _STA method */
1193 
1194 #define ACPI_STA_DEVICE_PRESENT         0x01
1195 #define ACPI_STA_DEVICE_ENABLED         0x02
1196 #define ACPI_STA_DEVICE_UI              0x04
1197 #define ACPI_STA_DEVICE_FUNCTIONING     0x08
1198 #define ACPI_STA_DEVICE_OK              0x08	/* Synonym */
1199 #define ACPI_STA_BATTERY_PRESENT        0x10
1200 
1201 /* Context structs for address space handlers */
1202 
1203 struct acpi_pci_id {
1204 	u16 segment;
1205 	u16 bus;
1206 	u16 device;
1207 	u16 function;
1208 };
1209 
1210 struct acpi_mem_space_context {
1211 	u32 length;
1212 	acpi_physical_address address;
1213 	acpi_physical_address mapped_physical_address;
1214 	u8 *mapped_logical_address;
1215 	acpi_size mapped_length;
1216 };
1217 
1218 /*
1219  * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1220  */
1221 struct acpi_memory_list {
1222 	const char *list_name;
1223 	void *list_head;
1224 	u16 object_size;
1225 	u16 max_depth;
1226 	u16 current_depth;
1227 
1228 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1229 
1230 	/* Statistics for debug memory tracking only */
1231 
1232 	u32 total_allocated;
1233 	u32 total_freed;
1234 	u32 max_occupied;
1235 	u32 total_size;
1236 	u32 current_total_size;
1237 	u32 requests;
1238 	u32 hits;
1239 #endif
1240 };
1241 
1242 /* Definitions of trace event types */
1243 
1244 typedef enum {
1245 	ACPI_TRACE_AML_METHOD,
1246 	ACPI_TRACE_AML_OPCODE,
1247 	ACPI_TRACE_AML_REGION
1248 } acpi_trace_event_type;
1249 
1250 /* Definitions of _OSI support */
1251 
1252 #define ACPI_VENDOR_STRINGS                 0x01
1253 #define ACPI_FEATURE_STRINGS                0x02
1254 #define ACPI_ENABLE_INTERFACES              0x00
1255 #define ACPI_DISABLE_INTERFACES             0x04
1256 
1257 #define ACPI_DISABLE_ALL_VENDOR_STRINGS     (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1258 #define ACPI_DISABLE_ALL_FEATURE_STRINGS    (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1259 #define ACPI_DISABLE_ALL_STRINGS            (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1260 #define ACPI_ENABLE_ALL_VENDOR_STRINGS      (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1261 #define ACPI_ENABLE_ALL_FEATURE_STRINGS     (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1262 #define ACPI_ENABLE_ALL_STRINGS             (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1263 
1264 #define ACPI_OSI_WIN_2000               0x01
1265 #define ACPI_OSI_WIN_XP                 0x02
1266 #define ACPI_OSI_WIN_XP_SP1             0x03
1267 #define ACPI_OSI_WINSRV_2003            0x04
1268 #define ACPI_OSI_WIN_XP_SP2             0x05
1269 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1270 #define ACPI_OSI_WIN_VISTA              0x07
1271 #define ACPI_OSI_WINSRV_2008            0x08
1272 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1273 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1274 #define ACPI_OSI_WIN_7                  0x0B
1275 #define ACPI_OSI_WIN_8                  0x0C
1276 #define ACPI_OSI_WIN_10                 0x0D
1277 #define ACPI_OSI_WIN_10_RS1             0x0E
1278 #define ACPI_OSI_WIN_10_RS2             0x0F
1279 #define ACPI_OSI_WIN_10_RS3             0x10
1280 #define ACPI_OSI_WIN_10_RS4             0x11
1281 #define ACPI_OSI_WIN_10_RS5             0x12
1282 
1283 /* Definitions of getopt */
1284 
1285 #define ACPI_OPT_END                    -1
1286 
1287 #endif				/* __ACTYPES_H__ */
1288