1/******************************************************************************
2 *
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************/
115
116#ifndef __ACTYPES_H__
117#define __ACTYPES_H__
118
119/* acpisrc:StructDefs -- for acpisrc conversion */
120
121/*
122 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
123 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
124 * 12/2006.
125 */
126#ifndef ACPI_MACHINE_WIDTH
127#error ACPI_MACHINE_WIDTH not defined
128#endif
129
130/*! [Begin] no source code translation */
131
132/*
133 * Data type ranges
134 * Note: These macros are designed to be compiler independent as well as
135 * working around problems that some 32-bit compilers have with 64-bit
136 * constants.
137 */
138#define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
139#define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
140#define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
141#define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
142#define ACPI_ASCII_MAX                  0x7F
143
144
145/*
146 * Architecture-specific ACPICA Subsystem Data Types
147 *
148 * The goal of these types is to provide source code portability across
149 * 16-bit, 32-bit, and 64-bit targets.
150 *
151 * 1) The following types are of fixed size for all targets (16/32/64):
152 *
153 * BOOLEAN      Logical boolean
154 *
155 * UINT8        8-bit  (1 byte) unsigned value
156 * UINT16       16-bit (2 byte) unsigned value
157 * UINT32       32-bit (4 byte) unsigned value
158 * UINT64       64-bit (8 byte) unsigned value
159 *
160 * INT16        16-bit (2 byte) signed value
161 * INT32        32-bit (4 byte) signed value
162 * INT64        64-bit (8 byte) signed value
163 *
164 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
165 * compiler-dependent header(s) and were introduced because there is no common
166 * 64-bit integer type across the various compilation models, as shown in
167 * the table below.
168 *
169 * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
170 * char      8    8     8     8     8    8
171 * short     16   16    16    16    16   16
172 * _int32         32
173 * int       32   64    32    32    16   16
174 * long      64   64    32    32    32   32
175 * long long            64    64
176 * pointer   64   64    64    32    32   32
177 *
178 * Note: ILP64 and LP32 are currently not supported.
179 *
180 *
181 * 2) These types represent the native word size of the target mode of the
182 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
183 * usually used for memory allocation, efficient loop counters, and array
184 * indexes. The types are similar to the size_t type in the C library and are
185 * required because there is no C type that consistently represents the native
186 * data width. ACPI_SIZE is needed because there is no guarantee that a
187 * kernel-level C library is present.
188 *
189 * ACPI_SIZE        16/32/64-bit unsigned value
190 * ACPI_NATIVE_INT  16/32/64-bit signed value
191 */
192
193/*******************************************************************************
194 *
195 * Common types for all compilers, all targets
196 *
197 ******************************************************************************/
198
199typedef unsigned char                   BOOLEAN;
200typedef unsigned char                   UINT8;
201typedef unsigned short                  UINT16;
202typedef COMPILER_DEPENDENT_UINT64       UINT64;
203typedef COMPILER_DEPENDENT_INT64        INT64;
204
205/*! [End] no source code translation !*/
206
207/*
208 * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
209 * across operating systems or even the various UNIX systems. Since ACPICA
210 * only needs the thread ID as a unique thread identifier, we use a UINT64
211 * as the only common data type - it will accommodate any type of pointer or
212 * any type of integer. It is up to the host-dependent OSL to cast the
213 * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
214 */
215#define ACPI_THREAD_ID                  UINT64
216
217
218/*******************************************************************************
219 *
220 * Types specific to 64-bit targets
221 *
222 ******************************************************************************/
223
224#if ACPI_MACHINE_WIDTH == 64
225
226/*! [Begin] no source code translation (keep the typedefs as-is) */
227
228typedef unsigned int                    UINT32;
229typedef int                             INT32;
230
231/*! [End] no source code translation !*/
232
233
234typedef INT64                           ACPI_NATIVE_INT;
235typedef UINT64                          ACPI_SIZE;
236typedef UINT64                          ACPI_IO_ADDRESS;
237typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
238
239#define ACPI_MAX_PTR                    ACPI_UINT64_MAX
240#define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
241#define ACPI_USE_NATIVE_DIVIDE          /* Has native 64-bit integer support */
242
243/*
244 * In the case of the Itanium Processor Family (IPF), the hardware does not
245 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
246 * to indicate that special precautions must be taken to avoid alignment faults.
247 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
248 *
249 * Note: EM64T and other X86-64 processors support misaligned transfers,
250 * so there is no need to define this flag.
251 */
252#if defined (__IA64__) || defined (__ia64__)
253#define ACPI_MISALIGNMENT_NOT_SUPPORTED
254#endif
255
256
257/*******************************************************************************
258 *
259 * Types specific to 32-bit targets
260 *
261 ******************************************************************************/
262
263#elif ACPI_MACHINE_WIDTH == 32
264
265/*! [Begin] no source code translation (keep the typedefs as-is) */
266
267typedef unsigned int                    UINT32;
268typedef int                             INT32;
269
270/*! [End] no source code translation !*/
271
272
273typedef INT32                           ACPI_NATIVE_INT;
274typedef UINT32                          ACPI_SIZE;
275typedef UINT32                          ACPI_IO_ADDRESS;
276typedef UINT32                          ACPI_PHYSICAL_ADDRESS;
277
278#define ACPI_MAX_PTR                    ACPI_UINT32_MAX
279#define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
280
281#else
282
283/* ACPI_MACHINE_WIDTH must be either 64 or 32 */
284
285#error unknown ACPI_MACHINE_WIDTH
286#endif
287
288
289/*******************************************************************************
290 *
291 * OS-dependent types
292 *
293 * If the defaults below are not appropriate for the host system, they can
294 * be defined in the OS-specific header, and this will take precedence.
295 *
296 ******************************************************************************/
297
298/* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
299
300#ifndef ACPI_CPU_FLAGS
301#define ACPI_CPU_FLAGS                  ACPI_SIZE
302#endif
303
304/* Object returned from AcpiOsCreateCache */
305
306#ifndef ACPI_CACHE_T
307#ifdef ACPI_USE_LOCAL_CACHE
308#define ACPI_CACHE_T                    ACPI_MEMORY_LIST
309#else
310#define ACPI_CACHE_T                    void *
311#endif
312#endif
313
314/*
315 * Synchronization objects - Mutexes, Semaphores, and SpinLocks
316 */
317#if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
318/*
319 * These macros are used if the host OS does not support a mutex object.
320 * Map the OSL Mutex interfaces to binary semaphores.
321 */
322#define ACPI_MUTEX                      ACPI_SEMAPHORE
323#define AcpiOsCreateMutex(OutHandle)    AcpiOsCreateSemaphore (1, 1, OutHandle)
324#define AcpiOsDeleteMutex(Handle)       (void) AcpiOsDeleteSemaphore (Handle)
325#define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
326#define AcpiOsReleaseMutex(Handle)      (void) AcpiOsSignalSemaphore (Handle, 1)
327#endif
328
329/* Configurable types for synchronization objects */
330
331#ifndef ACPI_SPINLOCK
332#define ACPI_SPINLOCK                   void *
333#endif
334
335#ifndef ACPI_SEMAPHORE
336#define ACPI_SEMAPHORE                  void *
337#endif
338
339#ifndef ACPI_MUTEX
340#define ACPI_MUTEX                      void *
341#endif
342
343
344/*******************************************************************************
345 *
346 * Compiler-dependent types
347 *
348 * If the defaults below are not appropriate for the host compiler, they can
349 * be defined in the compiler-specific header, and this will take precedence.
350 *
351 ******************************************************************************/
352
353/* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
354
355#ifndef ACPI_UINTPTR_T
356#define ACPI_UINTPTR_T                  void *
357#endif
358
359/*
360 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
361 * some compilers can catch printf format string problems
362 */
363#ifndef ACPI_PRINTF_LIKE
364#define ACPI_PRINTF_LIKE(c)
365#endif
366
367/*
368 * Some compilers complain about unused variables. Sometimes we don't want to
369 * use all the variables (for example, _AcpiModuleName). This allows us
370 * to to tell the compiler in a per-variable manner that a variable
371 * is unused
372 */
373#ifndef ACPI_UNUSED_VAR
374#define ACPI_UNUSED_VAR
375#endif
376
377/*
378 * All ACPICA functions that are available to the rest of the kernel are
379 * tagged with this macro which can be defined as appropriate for the host.
380 */
381#ifndef ACPI_EXPORT_SYMBOL
382#define ACPI_EXPORT_SYMBOL(Symbol)
383#endif
384
385
386/******************************************************************************
387 *
388 * ACPI Specification constants (Do not change unless the specification changes)
389 *
390 *****************************************************************************/
391
392/* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
393
394#define ACPI_MAX_GPE_BLOCKS             2
395
396/* Default ACPI register widths */
397
398#define ACPI_GPE_REGISTER_WIDTH         8
399#define ACPI_PM1_REGISTER_WIDTH         16
400#define ACPI_PM2_REGISTER_WIDTH         8
401#define ACPI_PM_TIMER_WIDTH             32
402
403/* Names within the namespace are 4 bytes long */
404
405#define ACPI_NAME_SIZE                  4
406#define ACPI_PATH_SEGMENT_LENGTH        5           /* 4 chars for name + 1 char for separator */
407#define ACPI_PATH_SEPARATOR             '.'
408
409/* Sizes for ACPI table headers */
410
411#define ACPI_OEM_ID_SIZE                6
412#define ACPI_OEM_TABLE_ID_SIZE          8
413
414/* ACPI/PNP hardware IDs */
415
416#define PCI_ROOT_HID_STRING             "PNP0A03"
417#define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
418
419/* PM Timer ticks per second (HZ) */
420
421#define PM_TIMER_FREQUENCY              3579545
422
423
424/*******************************************************************************
425 *
426 * Independent types
427 *
428 ******************************************************************************/
429
430/* Logical defines and NULL */
431
432#ifdef FALSE
433#undef FALSE
434#endif
435#define FALSE                           (1 == 0)
436
437#ifdef TRUE
438#undef TRUE
439#endif
440#define TRUE                            (1 == 1)
441
442#ifndef NULL
443#define NULL                            (void *) 0
444#endif
445
446
447/*
448 * Miscellaneous types
449 */
450typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
451typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
452typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
453typedef void *                          ACPI_HANDLE;    /* Actually a ptr to a NS Node */
454
455
456/* Owner IDs are used to track namespace nodes for selective deletion */
457
458typedef UINT8                           ACPI_OWNER_ID;
459#define ACPI_OWNER_ID_MAX               0xFF
460
461
462#define ACPI_INTEGER_BIT_SIZE           64
463#define ACPI_MAX_DECIMAL_DIGITS         20  /* 2^64 = 18,446,744,073,709,551,616 */
464#define ACPI_MAX64_DECIMAL_DIGITS       20
465#define ACPI_MAX32_DECIMAL_DIGITS       10
466#define ACPI_MAX16_DECIMAL_DIGITS        5
467#define ACPI_MAX8_DECIMAL_DIGITS         3
468
469/*
470 * Constants with special meanings
471 */
472#define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (ACPI_HANDLE, NULL, ACPI_MAX_PTR)
473#define ACPI_WAIT_FOREVER               0xFFFF  /* UINT16, as per ACPI spec */
474#define ACPI_DO_NOT_WAIT                0
475
476/*
477 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
478 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
479 * pertains to the ACPI integer type only, not to other integers used in the
480 * implementation of the ACPICA subsystem.
481 *
482 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
483 * code base. It remains here for compatibility with device drivers that use
484 * the type. However, it will be removed in the future.
485 */
486typedef UINT64                          ACPI_INTEGER;
487#define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
488
489
490/*******************************************************************************
491 *
492 * Commonly used macros
493 *
494 ******************************************************************************/
495
496/* Data manipulation */
497
498#define ACPI_LOBYTE(Integer)            ((UINT8)   (UINT16)(Integer))
499#define ACPI_HIBYTE(Integer)            ((UINT8) (((UINT16)(Integer)) >> 8))
500#define ACPI_LOWORD(Integer)            ((UINT16)  (UINT32)(Integer))
501#define ACPI_HIWORD(Integer)            ((UINT16)(((UINT32)(Integer)) >> 16))
502#define ACPI_LODWORD(Integer64)         ((UINT32)  (UINT64)(Integer64))
503#define ACPI_HIDWORD(Integer64)         ((UINT32)(((UINT64)(Integer64)) >> 32))
504
505#define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
506#define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
507#define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
508#define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
509
510/* Size calculation */
511
512#define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
513
514/* Pointer manipulation */
515
516#define ACPI_CAST_PTR(t, p)             ((t *) (ACPI_UINTPTR_T) (p))
517#define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (ACPI_UINTPTR_T) (p))
518#define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
519#define ACPI_PTR_DIFF(a, b)             (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b)))
520
521/* Pointer/Integer type conversions */
522
523#define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i)
524#define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) NULL)
525#define ACPI_OFFSET(d, f)               (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
526#define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
527#define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
528
529/* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
530
531#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
532#define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
533#define ACPI_MOVE_NAME(dest,src)        (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
534#else
535#define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
536#define ACPI_MOVE_NAME(dest,src)        (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
537#endif
538
539
540/*******************************************************************************
541 *
542 * Miscellaneous constants
543 *
544 ******************************************************************************/
545
546/*
547 * Initialization sequence
548 */
549#define ACPI_FULL_INITIALIZATION        0x00
550#define ACPI_NO_ADDRESS_SPACE_INIT      0x01
551#define ACPI_NO_HARDWARE_INIT           0x02
552#define ACPI_NO_EVENT_INIT              0x04
553#define ACPI_NO_HANDLER_INIT            0x08
554#define ACPI_NO_ACPI_ENABLE             0x10
555#define ACPI_NO_DEVICE_INIT             0x20
556#define ACPI_NO_OBJECT_INIT             0x40
557
558/*
559 * Initialization state
560 */
561#define ACPI_SUBSYSTEM_INITIALIZE       0x01
562#define ACPI_INITIALIZED_OK             0x02
563
564/*
565 * Power state values
566 */
567#define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
568
569#define ACPI_STATE_S0                   (UINT8) 0
570#define ACPI_STATE_S1                   (UINT8) 1
571#define ACPI_STATE_S2                   (UINT8) 2
572#define ACPI_STATE_S3                   (UINT8) 3
573#define ACPI_STATE_S4                   (UINT8) 4
574#define ACPI_STATE_S5                   (UINT8) 5
575#define ACPI_S_STATES_MAX               ACPI_STATE_S5
576#define ACPI_S_STATE_COUNT              6
577
578#define ACPI_STATE_D0                   (UINT8) 0
579#define ACPI_STATE_D1                   (UINT8) 1
580#define ACPI_STATE_D2                   (UINT8) 2
581#define ACPI_STATE_D3                   (UINT8) 3
582#define ACPI_D_STATES_MAX               ACPI_STATE_D3
583#define ACPI_D_STATE_COUNT              4
584
585#define ACPI_STATE_C0                   (UINT8) 0
586#define ACPI_STATE_C1                   (UINT8) 1
587#define ACPI_STATE_C2                   (UINT8) 2
588#define ACPI_STATE_C3                   (UINT8) 3
589#define ACPI_C_STATES_MAX               ACPI_STATE_C3
590#define ACPI_C_STATE_COUNT              4
591
592/*
593 * Sleep type invalid value
594 */
595#define ACPI_SLEEP_TYPE_MAX             0x7
596#define ACPI_SLEEP_TYPE_INVALID         0xFF
597
598/*
599 * Standard notify values
600 */
601#define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0x00
602#define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 0x01
603#define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 0x02
604#define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 0x03
605#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 0x04
606#define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 0x05
607#define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 0x06
608#define ACPI_NOTIFY_POWER_FAULT         (UINT8) 0x07
609#define ACPI_NOTIFY_CAPABILITIES_CHECK  (UINT8) 0x08
610#define ACPI_NOTIFY_DEVICE_PLD_CHECK    (UINT8) 0x09
611#define ACPI_NOTIFY_RESERVED            (UINT8) 0x0A
612#define ACPI_NOTIFY_LOCALITY_UPDATE     (UINT8) 0x0B
613#define ACPI_NOTIFY_SHUTDOWN_REQUEST    (UINT8) 0x0C
614
615#define ACPI_NOTIFY_MAX                 0x0C
616
617/*
618 * Types associated with ACPI names and objects. The first group of
619 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
620 * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
621 * only add to the first group if the spec changes.
622 *
623 * NOTE: Types must be kept in sync with the global AcpiNsProperties
624 * and AcpiNsTypeNames arrays.
625 */
626typedef UINT32                          ACPI_OBJECT_TYPE;
627
628#define ACPI_TYPE_ANY                   0x00
629#define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
630#define ACPI_TYPE_STRING                0x02
631#define ACPI_TYPE_BUFFER                0x03
632#define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
633#define ACPI_TYPE_FIELD_UNIT            0x05
634#define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
635#define ACPI_TYPE_EVENT                 0x07
636#define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
637#define ACPI_TYPE_MUTEX                 0x09
638#define ACPI_TYPE_REGION                0x0A
639#define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
640#define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
641#define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
642#define ACPI_TYPE_BUFFER_FIELD          0x0E
643#define ACPI_TYPE_DDB_HANDLE            0x0F
644#define ACPI_TYPE_DEBUG_OBJECT          0x10
645
646#define ACPI_TYPE_EXTERNAL_MAX          0x10
647
648/*
649 * These are object types that do not map directly to the ACPI
650 * ObjectType() operator. They are used for various internal purposes only.
651 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
652 * internal types must move upwards. (There is code that depends on these
653 * values being contiguous with the external types above.)
654 */
655#define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
656#define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
657#define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
658#define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
659#define ACPI_TYPE_LOCAL_ALIAS           0x15
660#define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
661#define ACPI_TYPE_LOCAL_NOTIFY          0x17
662#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
663#define ACPI_TYPE_LOCAL_RESOURCE        0x19
664#define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
665#define ACPI_TYPE_LOCAL_SCOPE           0x1B  /* 1 Name, multiple ObjectList Nodes */
666
667#define ACPI_TYPE_NS_NODE_MAX           0x1B  /* Last typecode used within a NS Node */
668
669/*
670 * These are special object types that never appear in
671 * a Namespace node, only in an ACPI_OPERAND_OBJECT
672 */
673#define ACPI_TYPE_LOCAL_EXTRA           0x1C
674#define ACPI_TYPE_LOCAL_DATA            0x1D
675
676#define ACPI_TYPE_LOCAL_MAX             0x1D
677
678/* All types above here are invalid */
679
680#define ACPI_TYPE_INVALID               0x1E
681#define ACPI_TYPE_NOT_FOUND             0xFF
682
683#define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
684
685
686/*
687 * All I/O
688 */
689#define ACPI_READ                       0
690#define ACPI_WRITE                      1
691#define ACPI_IO_MASK                    1
692
693/*
694 * Event Types: Fixed & General Purpose
695 */
696typedef UINT32                          ACPI_EVENT_TYPE;
697
698/*
699 * Fixed events
700 */
701#define ACPI_EVENT_PMTIMER              0
702#define ACPI_EVENT_GLOBAL               1
703#define ACPI_EVENT_POWER_BUTTON         2
704#define ACPI_EVENT_SLEEP_BUTTON         3
705#define ACPI_EVENT_RTC                  4
706#define ACPI_EVENT_MAX                  4
707#define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
708
709/*
710 * Event Status - Per event
711 * -------------
712 * The encoding of ACPI_EVENT_STATUS is illustrated below.
713 * Note that a set bit (1) indicates the property is TRUE
714 * (e.g. if bit 0 is set then the event is enabled).
715 * +-------------+-+-+-+
716 * |   Bits 31:3 |2|1|0|
717 * +-------------+-+-+-+
718 *          |     | | |
719 *          |     | | +- Enabled?
720 *          |     | +--- Enabled for wake?
721 *          |     +----- Set?
722 *          +----------- <Reserved>
723 */
724typedef UINT32                          ACPI_EVENT_STATUS;
725
726#define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
727#define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
728#define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
729#define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
730
731/*
732 * General Purpose Events (GPE)
733 */
734#define ACPI_GPE_INVALID                0xFF
735#define ACPI_GPE_MAX                    0xFF
736#define ACPI_NUM_GPE                    256
737
738/* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
739
740#define ACPI_GPE_ENABLE                 0
741#define ACPI_GPE_DISABLE                1
742#define ACPI_GPE_CONDITIONAL_ENABLE     2
743
744/*
745 * GPE info flags - Per GPE
746 * +-------+-+-+---+
747 * |  7:4  |3|2|1:0|
748 * +-------+-+-+---+
749 *     |    | |  |
750 *     |    | |  +-- Type of dispatch:to method, handler, notify, or none
751 *     |    | +----- Interrupt type: edge or level triggered
752 *     |    +------- Is a Wake GPE
753 *     +------------ <Reserved>
754 */
755#define ACPI_GPE_DISPATCH_NONE          (UINT8) 0x00
756#define ACPI_GPE_DISPATCH_METHOD        (UINT8) 0x01
757#define ACPI_GPE_DISPATCH_HANDLER       (UINT8) 0x02
758#define ACPI_GPE_DISPATCH_NOTIFY        (UINT8) 0x03
759#define ACPI_GPE_DISPATCH_MASK          (UINT8) 0x03
760
761#define ACPI_GPE_LEVEL_TRIGGERED        (UINT8) 0x04
762#define ACPI_GPE_EDGE_TRIGGERED         (UINT8) 0x00
763#define ACPI_GPE_XRUPT_TYPE_MASK        (UINT8) 0x04
764
765#define ACPI_GPE_CAN_WAKE               (UINT8) 0x08
766
767/*
768 * Flags for GPE and Lock interfaces
769 */
770#define ACPI_NOT_ISR                    0x1
771#define ACPI_ISR                        0x0
772
773
774/* Notify types */
775
776#define ACPI_SYSTEM_NOTIFY              0x1
777#define ACPI_DEVICE_NOTIFY              0x2
778#define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
779#define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
780#define ACPI_NUM_NOTIFY_TYPES           2
781
782#define ACPI_MAX_SYS_NOTIFY             0x7F
783#define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
784
785#define ACPI_SYSTEM_HANDLER_LIST        0 /* Used as index, must be SYSTEM_NOTIFY -1 */
786#define ACPI_DEVICE_HANDLER_LIST        1 /* Used as index, must be DEVICE_NOTIFY -1 */
787
788
789/* Address Space (Operation Region) Types */
790
791typedef UINT8                           ACPI_ADR_SPACE_TYPE;
792
793#define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
794#define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
795#define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
796#define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
797#define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
798#define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
799#define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
800#define ACPI_ADR_SPACE_IPMI             (ACPI_ADR_SPACE_TYPE) 7
801#define ACPI_ADR_SPACE_GPIO             (ACPI_ADR_SPACE_TYPE) 8
802#define ACPI_ADR_SPACE_GSBUS            (ACPI_ADR_SPACE_TYPE) 9
803#define ACPI_ADR_SPACE_PLATFORM_COMM    (ACPI_ADR_SPACE_TYPE) 10
804
805#define ACPI_NUM_PREDEFINED_REGIONS     11
806
807/*
808 * Special Address Spaces
809 *
810 * Note: A Data Table region is a special type of operation region
811 * that has its own AML opcode. However, internally, the AML
812 * interpreter simply creates an operation region with an an address
813 * space type of ACPI_ADR_SPACE_DATA_TABLE.
814 */
815#define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
816#define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 0x7F
817
818/* Values for _REG connection code */
819
820#define ACPI_REG_DISCONNECT             0
821#define ACPI_REG_CONNECT                1
822
823/*
824 * BitRegister IDs
825 *
826 * These values are intended to be used by the hardware interfaces
827 * and are mapped to individual bitfields defined within the ACPI
828 * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
829 * for this mapping.
830 */
831
832/* PM1 Status register */
833
834#define ACPI_BITREG_TIMER_STATUS                0x00
835#define ACPI_BITREG_BUS_MASTER_STATUS           0x01
836#define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
837#define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
838#define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
839#define ACPI_BITREG_RT_CLOCK_STATUS             0x05
840#define ACPI_BITREG_WAKE_STATUS                 0x06
841#define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
842
843/* PM1 Enable register */
844
845#define ACPI_BITREG_TIMER_ENABLE                0x08
846#define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
847#define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
848#define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
849#define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
850#define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
851
852/* PM1 Control register */
853
854#define ACPI_BITREG_SCI_ENABLE                  0x0E
855#define ACPI_BITREG_BUS_MASTER_RLD              0x0F
856#define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
857#define ACPI_BITREG_SLEEP_TYPE                  0x11
858#define ACPI_BITREG_SLEEP_ENABLE                0x12
859
860/* PM2 Control register */
861
862#define ACPI_BITREG_ARB_DISABLE                 0x13
863
864#define ACPI_BITREG_MAX                         0x13
865#define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
866
867
868/* Status register values. A 1 clears a status bit. 0 = no effect */
869
870#define ACPI_CLEAR_STATUS                       1
871
872/* Enable and Control register values */
873
874#define ACPI_ENABLE_EVENT                       1
875#define ACPI_DISABLE_EVENT                      0
876
877
878/* Sleep function dispatch */
879
880typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) (
881    UINT8                   SleepState);
882
883typedef struct acpi_sleep_functions
884{
885    ACPI_SLEEP_FUNCTION     LegacyFunction;
886    ACPI_SLEEP_FUNCTION     ExtendedFunction;
887
888} ACPI_SLEEP_FUNCTIONS;
889
890
891/*
892 * External ACPI object definition
893 */
894
895/*
896 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
897 * or an unresolved named reference.
898 */
899typedef union acpi_object
900{
901    ACPI_OBJECT_TYPE                Type;   /* See definition of AcpiNsType for values */
902    struct
903    {
904        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_INTEGER */
905        UINT64                          Value;      /* The actual number */
906    } Integer;
907
908    struct
909    {
910        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_STRING */
911        UINT32                          Length;     /* # of bytes in string, excluding trailing null */
912        char                            *Pointer;   /* points to the string value */
913    } String;
914
915    struct
916    {
917        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_BUFFER */
918        UINT32                          Length;     /* # of bytes in buffer */
919        UINT8                           *Pointer;   /* points to the buffer */
920    } Buffer;
921
922    struct
923    {
924        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PACKAGE */
925        UINT32                          Count;      /* # of elements in package */
926        union acpi_object               *Elements;  /* Pointer to an array of ACPI_OBJECTs */
927    } Package;
928
929    struct
930    {
931        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_LOCAL_REFERENCE */
932        ACPI_OBJECT_TYPE                ActualType; /* Type associated with the Handle */
933        ACPI_HANDLE                     Handle;     /* object reference */
934    } Reference;
935
936    struct
937    {
938        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PROCESSOR */
939        UINT32                          ProcId;
940        ACPI_IO_ADDRESS                 PblkAddress;
941        UINT32                          PblkLength;
942    } Processor;
943
944    struct
945    {
946        ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_POWER */
947        UINT32                          SystemLevel;
948        UINT32                          ResourceOrder;
949    } PowerResource;
950
951} ACPI_OBJECT;
952
953
954/*
955 * List of objects, used as a parameter list for control method evaluation
956 */
957typedef struct acpi_object_list
958{
959    UINT32                          Count;
960    ACPI_OBJECT                     *Pointer;
961
962} ACPI_OBJECT_LIST;
963
964
965/*
966 * Miscellaneous common Data Structures used by the interfaces
967 */
968#define ACPI_NO_BUFFER              0
969#define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
970#define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)
971
972typedef struct acpi_buffer
973{
974    ACPI_SIZE                       Length;         /* Length in bytes of the buffer */
975    void                            *Pointer;       /* pointer to buffer */
976
977} ACPI_BUFFER;
978
979
980/*
981 * NameType for AcpiGetName
982 */
983#define ACPI_FULL_PATHNAME              0
984#define ACPI_SINGLE_NAME                1
985#define ACPI_NAME_TYPE_MAX              1
986
987
988/*
989 * Predefined Namespace items
990 */
991typedef struct acpi_predefined_names
992{
993    char                            *Name;
994    UINT8                           Type;
995    char                            *Val;
996
997} ACPI_PREDEFINED_NAMES;
998
999
1000/*
1001 * Structure and flags for AcpiGetSystemInfo
1002 */
1003#define ACPI_SYS_MODE_UNKNOWN           0x0000
1004#define ACPI_SYS_MODE_ACPI              0x0001
1005#define ACPI_SYS_MODE_LEGACY            0x0002
1006#define ACPI_SYS_MODES_MASK             0x0003
1007
1008
1009/*
1010 * System info returned by AcpiGetSystemInfo()
1011 */
1012typedef struct acpi_system_info
1013{
1014    UINT32                          AcpiCaVersion;
1015    UINT32                          Flags;
1016    UINT32                          TimerResolution;
1017    UINT32                          Reserved1;
1018    UINT32                          Reserved2;
1019    UINT32                          DebugLevel;
1020    UINT32                          DebugLayer;
1021
1022} ACPI_SYSTEM_INFO;
1023
1024
1025/*
1026 * System statistics returned by AcpiGetStatistics()
1027 */
1028typedef struct acpi_statistics
1029{
1030    UINT32                          SciCount;
1031    UINT32                          GpeCount;
1032    UINT32                          FixedEventCount[ACPI_NUM_FIXED_EVENTS];
1033    UINT32                          MethodCount;
1034
1035} ACPI_STATISTICS;
1036
1037
1038/* Table Event Types */
1039
1040#define ACPI_TABLE_EVENT_LOAD           0x0
1041#define ACPI_TABLE_EVENT_UNLOAD         0x1
1042#define ACPI_NUM_TABLE_EVENTS           2
1043
1044
1045/*
1046 * Types specific to the OS service interfaces
1047 */
1048typedef UINT32
1049(ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
1050    void                            *Context);
1051
1052typedef void
1053(ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
1054    void                            *Context);
1055
1056/*
1057 * Various handlers and callback procedures
1058 */
1059typedef
1060void (*ACPI_GBL_EVENT_HANDLER) (
1061    UINT32                          EventType,
1062    ACPI_HANDLE                     Device,
1063    UINT32                          EventNumber,
1064    void                            *Context);
1065
1066#define ACPI_EVENT_TYPE_GPE         0
1067#define ACPI_EVENT_TYPE_FIXED       1
1068
1069typedef
1070UINT32 (*ACPI_EVENT_HANDLER) (
1071    void                            *Context);
1072
1073typedef
1074UINT32 (*ACPI_GPE_HANDLER) (
1075    ACPI_HANDLE                     GpeDevice,
1076    UINT32                          GpeNumber,
1077    void                            *Context);
1078
1079typedef
1080void (*ACPI_NOTIFY_HANDLER) (
1081    ACPI_HANDLE                     Device,
1082    UINT32                          Value,
1083    void                            *Context);
1084
1085typedef
1086void (*ACPI_OBJECT_HANDLER) (
1087    ACPI_HANDLE                     Object,
1088    void                            *Data);
1089
1090typedef
1091ACPI_STATUS (*ACPI_INIT_HANDLER) (
1092    ACPI_HANDLE                     Object,
1093    UINT32                          Function);
1094
1095#define ACPI_INIT_DEVICE_INI        1
1096
1097typedef
1098ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
1099    ACPI_STATUS                     AmlStatus,
1100    ACPI_NAME                       Name,
1101    UINT16                          Opcode,
1102    UINT32                          AmlOffset,
1103    void                            *Context);
1104
1105/* Table Event handler (Load, LoadTable, etc.) and types */
1106
1107typedef
1108ACPI_STATUS (*ACPI_TABLE_HANDLER) (
1109    UINT32                          Event,
1110    void                            *Table,
1111    void                            *Context);
1112
1113#define ACPI_TABLE_LOAD             0x0
1114#define ACPI_TABLE_UNLOAD           0x1
1115#define ACPI_NUM_TABLE_EVENTS       2
1116
1117
1118/* Address Spaces (For Operation Regions) */
1119
1120typedef
1121ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
1122    UINT32                          Function,
1123    ACPI_PHYSICAL_ADDRESS           Address,
1124    UINT32                          BitWidth,
1125    UINT64                          *Value,
1126    void                            *HandlerContext,
1127    void                            *RegionContext);
1128
1129#define ACPI_DEFAULT_HANDLER            NULL
1130
1131/* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1132
1133typedef struct acpi_connection_info
1134{
1135    UINT8                           *Connection;
1136    UINT16                          Length;
1137    UINT8                           AccessLength;
1138
1139} ACPI_CONNECTION_INFO;
1140
1141
1142typedef
1143ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
1144    ACPI_HANDLE                     RegionHandle,
1145    UINT32                          Function,
1146    void                            *HandlerContext,
1147    void                            **RegionContext);
1148
1149#define ACPI_REGION_ACTIVATE    0
1150#define ACPI_REGION_DEACTIVATE  1
1151
1152typedef
1153ACPI_STATUS (*ACPI_WALK_CALLBACK) (
1154    ACPI_HANDLE                     Object,
1155    UINT32                          NestingLevel,
1156    void                            *Context,
1157    void                            **ReturnValue);
1158
1159typedef
1160UINT32 (*ACPI_INTERFACE_HANDLER) (
1161    ACPI_STRING                     InterfaceName,
1162    UINT32                          Supported);
1163
1164
1165/* Interrupt handler return values */
1166
1167#define ACPI_INTERRUPT_NOT_HANDLED      0x00
1168#define ACPI_INTERRUPT_HANDLED          0x01
1169
1170/* GPE handler return values */
1171
1172#define ACPI_REENABLE_GPE               0x80
1173
1174
1175/* Length of 32-bit EISAID values when converted back to a string */
1176
1177#define ACPI_EISAID_STRING_SIZE         8   /* Includes null terminator */
1178
1179/* Length of UUID (string) values */
1180
1181#define ACPI_UUID_LENGTH                16
1182
1183
1184/* Structures used for device/processor HID, UID, CID, and SUB */
1185
1186typedef struct acpi_pnp_device_id
1187{
1188    UINT32                          Length;             /* Length of string + null */
1189    char                            *String;
1190
1191} ACPI_PNP_DEVICE_ID;
1192
1193typedef struct acpi_pnp_device_id_list
1194{
1195    UINT32                          Count;              /* Number of IDs in Ids array */
1196    UINT32                          ListSize;           /* Size of list, including ID strings */
1197    ACPI_PNP_DEVICE_ID              Ids[1];             /* ID array */
1198
1199} ACPI_PNP_DEVICE_ID_LIST;
1200
1201/*
1202 * Structure returned from AcpiGetObjectInfo.
1203 * Optimized for both 32- and 64-bit builds
1204 */
1205typedef struct acpi_device_info
1206{
1207    UINT32                          InfoSize;           /* Size of info, including ID strings */
1208    UINT32                          Name;               /* ACPI object Name */
1209    ACPI_OBJECT_TYPE                Type;               /* ACPI object Type */
1210    UINT8                           ParamCount;         /* If a method, required parameter count */
1211    UINT8                           Valid;              /* Indicates which optional fields are valid */
1212    UINT8                           Flags;              /* Miscellaneous info */
1213    UINT8                           HighestDstates[4];  /* _SxD values: 0xFF indicates not valid */
1214    UINT8                           LowestDstates[5];   /* _SxW values: 0xFF indicates not valid */
1215    UINT32                          CurrentStatus;      /* _STA value */
1216    UINT64                          Address;            /* _ADR value */
1217    ACPI_PNP_DEVICE_ID              HardwareId;         /* _HID value */
1218    ACPI_PNP_DEVICE_ID              UniqueId;           /* _UID value */
1219    ACPI_PNP_DEVICE_ID              SubsystemId;        /* _SUB value */
1220    ACPI_PNP_DEVICE_ID_LIST         CompatibleIdList;   /* _CID list <must be last> */
1221
1222} ACPI_DEVICE_INFO;
1223
1224/* Values for Flags field above (AcpiGetObjectInfo) */
1225
1226#define ACPI_PCI_ROOT_BRIDGE            0x01
1227
1228/* Flags for Valid field above (AcpiGetObjectInfo) */
1229
1230#define ACPI_VALID_STA                  0x01
1231#define ACPI_VALID_ADR                  0x02
1232#define ACPI_VALID_HID                  0x04
1233#define ACPI_VALID_UID                  0x08
1234#define ACPI_VALID_SUB                  0x10
1235#define ACPI_VALID_CID                  0x20
1236#define ACPI_VALID_SXDS                 0x40
1237#define ACPI_VALID_SXWS                 0x80
1238
1239/* Flags for _STA return value (CurrentStatus above) */
1240
1241#define ACPI_STA_DEVICE_PRESENT         0x01
1242#define ACPI_STA_DEVICE_ENABLED         0x02
1243#define ACPI_STA_DEVICE_UI              0x04
1244#define ACPI_STA_DEVICE_FUNCTIONING     0x08
1245#define ACPI_STA_DEVICE_OK              0x08 /* Synonym */
1246#define ACPI_STA_BATTERY_PRESENT        0x10
1247
1248
1249/* Context structs for address space handlers */
1250
1251typedef struct acpi_pci_id
1252{
1253    UINT16                          Segment;
1254    UINT16                          Bus;
1255    UINT16                          Device;
1256    UINT16                          Function;
1257
1258} ACPI_PCI_ID;
1259
1260typedef struct acpi_mem_space_context
1261{
1262    UINT32                          Length;
1263    ACPI_PHYSICAL_ADDRESS           Address;
1264    ACPI_PHYSICAL_ADDRESS           MappedPhysicalAddress;
1265    UINT8                           *MappedLogicalAddress;
1266    ACPI_SIZE                       MappedLength;
1267
1268} ACPI_MEM_SPACE_CONTEXT;
1269
1270
1271/*
1272 * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1273 */
1274typedef struct acpi_memory_list
1275{
1276    char                            *ListName;
1277    void                            *ListHead;
1278    UINT16                          ObjectSize;
1279    UINT16                          MaxDepth;
1280    UINT16                          CurrentDepth;
1281    UINT16                          LinkOffset;
1282
1283#ifdef ACPI_DBG_TRACK_ALLOCATIONS
1284
1285    /* Statistics for debug memory tracking only */
1286
1287    UINT32                          TotalAllocated;
1288    UINT32                          TotalFreed;
1289    UINT32                          MaxOccupied;
1290    UINT32                          TotalSize;
1291    UINT32                          CurrentTotalSize;
1292    UINT32                          Requests;
1293    UINT32                          Hits;
1294#endif
1295
1296} ACPI_MEMORY_LIST;
1297
1298
1299#endif /* __ACTYPES_H__ */
1300