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