xref: /illumos-gate/usr/src/uts/intel/sys/acpi/actypes.h (revision 35786f68)
17c478bd9Sstevel@tonic-gate /******************************************************************************
27c478bd9Sstevel@tonic-gate  *
37c478bd9Sstevel@tonic-gate  * Name: actypes.h - Common data types for the entire ACPI subsystem
47c478bd9Sstevel@tonic-gate  *
57c478bd9Sstevel@tonic-gate  *****************************************************************************/
67c478bd9Sstevel@tonic-gate 
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi  *
9*35786f68SRobert Mustacchi  * 1. Copyright Notice
10*35786f68SRobert Mustacchi  *
11*35786f68SRobert Mustacchi  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
127c478bd9Sstevel@tonic-gate  * All rights reserved.
137c478bd9Sstevel@tonic-gate  *
14*35786f68SRobert Mustacchi  * 2. License
15*35786f68SRobert Mustacchi  *
16*35786f68SRobert Mustacchi  * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi  * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi  * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi  * property rights.
20*35786f68SRobert Mustacchi  *
21*35786f68SRobert Mustacchi  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi  * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi  * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi  * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi  *
28*35786f68SRobert Mustacchi  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi  * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi  * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi  * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi  * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi  * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi  * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi  *
37*35786f68SRobert Mustacchi  * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi  * conditions are met:
39*35786f68SRobert Mustacchi  *
40*35786f68SRobert Mustacchi  * 3. Conditions
41*35786f68SRobert Mustacchi  *
42*35786f68SRobert Mustacchi  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi  * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi  * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi  * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi  * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi  * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi  * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi  * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi  * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi  * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi  *
54*35786f68SRobert Mustacchi  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi  * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi  * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi  * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi  * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi  * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi  * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi  * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi  * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi  * make.
65*35786f68SRobert Mustacchi  *
66*35786f68SRobert Mustacchi  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi  * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi  * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi  * distribution.
71*35786f68SRobert Mustacchi  *
72*35786f68SRobert Mustacchi  * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi  * Intel Code.
74*35786f68SRobert Mustacchi  *
75*35786f68SRobert Mustacchi  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi  * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi  * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi  *
80*35786f68SRobert Mustacchi  * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi  *
82*35786f68SRobert Mustacchi  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi  * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi  *
90*35786f68SRobert Mustacchi  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi  * LIMITED REMEDY.
98*35786f68SRobert Mustacchi  *
99*35786f68SRobert Mustacchi  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi  * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi  * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi  * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi  * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi  * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi  * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi  * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi  * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi  * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi  * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi  * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi  * such license, approval or letter.
113*35786f68SRobert Mustacchi  *
114*35786f68SRobert Mustacchi  *****************************************************************************
115*35786f68SRobert Mustacchi  *
116*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi  * following license:
118*35786f68SRobert Mustacchi  *
11926f3cdf0SGordon Ross  * Redistribution and use in source and binary forms, with or without
12026f3cdf0SGordon Ross  * modification, are permitted provided that the following conditions
12126f3cdf0SGordon Ross  * are met:
12226f3cdf0SGordon Ross  * 1. Redistributions of source code must retain the above copyright
12326f3cdf0SGordon Ross  *    notice, this list of conditions, and the following disclaimer,
12426f3cdf0SGordon Ross  *    without modification.
12526f3cdf0SGordon Ross  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12626f3cdf0SGordon Ross  *    substantially similar to the "NO WARRANTY" disclaimer below
12726f3cdf0SGordon Ross  *    ("Disclaimer") and any redistribution must be conditioned upon
12826f3cdf0SGordon Ross  *    including a substantially similar Disclaimer requirement for further
12926f3cdf0SGordon Ross  *    binary redistribution.
13026f3cdf0SGordon Ross  * 3. Neither the names of the above-listed copyright holders nor the names
13126f3cdf0SGordon Ross  *    of any contributors may be used to endorse or promote products derived
13226f3cdf0SGordon Ross  *    from this software without specific prior written permission.
1337c478bd9Sstevel@tonic-gate  *
13426f3cdf0SGordon Ross  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13526f3cdf0SGordon Ross  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
13726f3cdf0SGordon Ross  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi  *
146*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi  * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi  * Software Foundation.
149*35786f68SRobert Mustacchi  *
150*35786f68SRobert Mustacchi  *****************************************************************************/
1517c478bd9Sstevel@tonic-gate 
1527c478bd9Sstevel@tonic-gate #ifndef __ACTYPES_H__
1537c478bd9Sstevel@tonic-gate #define __ACTYPES_H__
1547c478bd9Sstevel@tonic-gate 
15527f7c583Smyers /* acpisrc:StructDefs -- for acpisrc conversion */
15627f7c583Smyers 
15730082d0cSmyers /*
158*35786f68SRobert Mustacchi  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
159*35786f68SRobert Mustacchi  * header and must be either 32 or 64. 16-bit ACPICA is no longer
160*35786f68SRobert Mustacchi  * supported, as of 12/2006.
16130082d0cSmyers  */
16230082d0cSmyers #ifndef ACPI_MACHINE_WIDTH
16330082d0cSmyers #error ACPI_MACHINE_WIDTH not defined
16430082d0cSmyers #endif
1657c478bd9Sstevel@tonic-gate 
1667c478bd9Sstevel@tonic-gate /*
1677c478bd9Sstevel@tonic-gate  * Data type ranges
1687c478bd9Sstevel@tonic-gate  * Note: These macros are designed to be compiler independent as well as
1697c478bd9Sstevel@tonic-gate  * working around problems that some 32-bit compilers have with 64-bit
1707c478bd9Sstevel@tonic-gate  * constants.
1717c478bd9Sstevel@tonic-gate  */
1727c478bd9Sstevel@tonic-gate #define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
1737c478bd9Sstevel@tonic-gate #define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
1747c478bd9Sstevel@tonic-gate #define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
1757c478bd9Sstevel@tonic-gate #define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
1767c478bd9Sstevel@tonic-gate #define ACPI_ASCII_MAX                  0x7F
1777c478bd9Sstevel@tonic-gate 
1787c478bd9Sstevel@tonic-gate 
1797c478bd9Sstevel@tonic-gate /*
18030082d0cSmyers  * Architecture-specific ACPICA Subsystem Data Types
18130082d0cSmyers  *
18230082d0cSmyers  * The goal of these types is to provide source code portability across
18330082d0cSmyers  * 16-bit, 32-bit, and 64-bit targets.
18430082d0cSmyers  *
18530082d0cSmyers  * 1) The following types are of fixed size for all targets (16/32/64):
18630082d0cSmyers  *
18730082d0cSmyers  * BOOLEAN      Logical boolean
18830082d0cSmyers  *
18930082d0cSmyers  * UINT8        8-bit  (1 byte) unsigned value
19030082d0cSmyers  * UINT16       16-bit (2 byte) unsigned value
19130082d0cSmyers  * UINT32       32-bit (4 byte) unsigned value
19230082d0cSmyers  * UINT64       64-bit (8 byte) unsigned value
19330082d0cSmyers  *
19430082d0cSmyers  * INT16        16-bit (2 byte) signed value
19530082d0cSmyers  * INT32        32-bit (4 byte) signed value
19630082d0cSmyers  * INT64        64-bit (8 byte) signed value
19730082d0cSmyers  *
19830082d0cSmyers  * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
199*35786f68SRobert Mustacchi  * compiler-dependent header(s) and were introduced because there is no
200*35786f68SRobert Mustacchi  * common 64-bit integer type across the various compilation models, as
201*35786f68SRobert Mustacchi  * shown in the table below.
20230082d0cSmyers  *
20330082d0cSmyers  * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
20430082d0cSmyers  * char      8    8     8     8     8    8
20530082d0cSmyers  * short     16   16    16    16    16   16
20630082d0cSmyers  * _int32         32
20730082d0cSmyers  * int       32   64    32    32    16   16
20830082d0cSmyers  * long      64   64    32    32    32   32
20930082d0cSmyers  * long long            64    64
21030082d0cSmyers  * pointer   64   64    64    32    32   32
21130082d0cSmyers  *
21230082d0cSmyers  * Note: ILP64 and LP32 are currently not supported.
21330082d0cSmyers  *
21430082d0cSmyers  *
21530082d0cSmyers  * 2) These types represent the native word size of the target mode of the
21630082d0cSmyers  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
21730082d0cSmyers  * usually used for memory allocation, efficient loop counters, and array
218*35786f68SRobert Mustacchi  * indexes. The types are similar to the size_t type in the C library and
219*35786f68SRobert Mustacchi  * are required because there is no C type that consistently represents the
220*35786f68SRobert Mustacchi  * native data width. ACPI_SIZE is needed because there is no guarantee
221*35786f68SRobert Mustacchi  * that a kernel-level C library is present.
22230082d0cSmyers  *
22330082d0cSmyers  * ACPI_SIZE        16/32/64-bit unsigned value
22430082d0cSmyers  * ACPI_NATIVE_INT  16/32/64-bit signed value
2257c478bd9Sstevel@tonic-gate  */
2267c478bd9Sstevel@tonic-gate 
22730082d0cSmyers /*******************************************************************************
22830082d0cSmyers  *
22930082d0cSmyers  * Common types for all compilers, all targets
23030082d0cSmyers  *
23130082d0cSmyers  ******************************************************************************/
2327c478bd9Sstevel@tonic-gate 
2337b1019a6SJerry Jelinek #ifndef ACPI_USE_SYSTEM_INTTYPES
2347b1019a6SJerry Jelinek 
23530082d0cSmyers typedef unsigned char                   BOOLEAN;
23630082d0cSmyers typedef unsigned char                   UINT8;
23730082d0cSmyers typedef unsigned short                  UINT16;
2387b1019a6SJerry Jelinek typedef short                           INT16;
23930082d0cSmyers typedef COMPILER_DEPENDENT_UINT64       UINT64;
24030082d0cSmyers typedef COMPILER_DEPENDENT_INT64        INT64;
2417c478bd9Sstevel@tonic-gate 
2427b1019a6SJerry Jelinek #endif /* ACPI_USE_SYSTEM_INTTYPES */
2437c478bd9Sstevel@tonic-gate 
24426f3cdf0SGordon Ross /*
24526f3cdf0SGordon Ross  * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
24626f3cdf0SGordon Ross  * across operating systems or even the various UNIX systems. Since ACPICA
24726f3cdf0SGordon Ross  * only needs the thread ID as a unique thread identifier, we use a UINT64
24826f3cdf0SGordon Ross  * as the only common data type - it will accommodate any type of pointer or
24926f3cdf0SGordon Ross  * any type of integer. It is up to the host-dependent OSL to cast the
25026f3cdf0SGordon Ross  * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
25126f3cdf0SGordon Ross  */
25226f3cdf0SGordon Ross #define ACPI_THREAD_ID                  UINT64
25326f3cdf0SGordon Ross 
25430082d0cSmyers 
25530082d0cSmyers /*******************************************************************************
25630082d0cSmyers  *
25730082d0cSmyers  * Types specific to 64-bit targets
25830082d0cSmyers  *
25930082d0cSmyers  ******************************************************************************/
2607c478bd9Sstevel@tonic-gate 
2617c478bd9Sstevel@tonic-gate #if ACPI_MACHINE_WIDTH == 64
2627c478bd9Sstevel@tonic-gate 
2637b1019a6SJerry Jelinek #ifndef ACPI_USE_SYSTEM_INTTYPES
2647c478bd9Sstevel@tonic-gate 
2657c478bd9Sstevel@tonic-gate typedef unsigned int                    UINT32;
26630082d0cSmyers typedef int                             INT32;
2677c478bd9Sstevel@tonic-gate 
2687b1019a6SJerry Jelinek #endif /* ACPI_USE_SYSTEM_INTTYPES */
2697c478bd9Sstevel@tonic-gate 
27030082d0cSmyers 
27130082d0cSmyers typedef INT64                           ACPI_NATIVE_INT;
272db2bae30SDana Myers typedef UINT64                          ACPI_SIZE;
2737c478bd9Sstevel@tonic-gate typedef UINT64                          ACPI_IO_ADDRESS;
2747c478bd9Sstevel@tonic-gate typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
2757c478bd9Sstevel@tonic-gate 
2767c478bd9Sstevel@tonic-gate #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
2777c478bd9Sstevel@tonic-gate #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
27830082d0cSmyers #define ACPI_USE_NATIVE_DIVIDE          /* Has native 64-bit integer support */
279*35786f68SRobert Mustacchi #define ACPI_USE_NATIVE_MATH64          /* Has native 64-bit integer support */
2807c478bd9Sstevel@tonic-gate 
2817c478bd9Sstevel@tonic-gate /*
28230082d0cSmyers  * In the case of the Itanium Processor Family (IPF), the hardware does not
283*35786f68SRobert Mustacchi  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
284*35786f68SRobert Mustacchi  * flag to indicate that special precautions must be taken to avoid alignment
285*35786f68SRobert Mustacchi  * faults. (IA64 or ia64 is currently used by existing compilers to indicate
286*35786f68SRobert Mustacchi  * IPF.)
28730082d0cSmyers  *
28830082d0cSmyers  * Note: EM64T and other X86-64 processors support misaligned transfers,
28930082d0cSmyers  * so there is no need to define this flag.
2907c478bd9Sstevel@tonic-gate  */
29130082d0cSmyers #if defined (__IA64__) || defined (__ia64__)
29230082d0cSmyers #define ACPI_MISALIGNMENT_NOT_SUPPORTED
29330082d0cSmyers #endif
2947c478bd9Sstevel@tonic-gate 
2957c478bd9Sstevel@tonic-gate 
29630082d0cSmyers /*******************************************************************************
29730082d0cSmyers  *
29830082d0cSmyers  * Types specific to 32-bit targets
29930082d0cSmyers  *
30030082d0cSmyers  ******************************************************************************/
30130082d0cSmyers 
30230082d0cSmyers #elif ACPI_MACHINE_WIDTH == 32
30330082d0cSmyers 
3047b1019a6SJerry Jelinek #ifndef ACPI_USE_SYSTEM_INTTYPES
30530082d0cSmyers 
30630082d0cSmyers typedef unsigned int                    UINT32;
30730082d0cSmyers typedef int                             INT32;
30830082d0cSmyers 
3097b1019a6SJerry Jelinek #endif /* ACPI_USE_SYSTEM_INTTYPES */
31030082d0cSmyers 
31130082d0cSmyers 
31230082d0cSmyers typedef INT32                           ACPI_NATIVE_INT;
313db2bae30SDana Myers typedef UINT32                          ACPI_SIZE;
3147b1019a6SJerry Jelinek 
3157b1019a6SJerry Jelinek #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
3167b1019a6SJerry Jelinek 
3177b1019a6SJerry Jelinek /*
3187b1019a6SJerry Jelinek  * OSPMs can define this to shrink the size of the structures for 32-bit
3197b1019a6SJerry Jelinek  * none PAE environment. ASL compiler may always define this to generate
3207b1019a6SJerry Jelinek  * 32-bit OSPM compliant tables.
3217b1019a6SJerry Jelinek  */
32230082d0cSmyers typedef UINT32                          ACPI_IO_ADDRESS;
323db2bae30SDana Myers typedef UINT32                          ACPI_PHYSICAL_ADDRESS;
32430082d0cSmyers 
3257b1019a6SJerry Jelinek #else /* ACPI_32BIT_PHYSICAL_ADDRESS */
3267b1019a6SJerry Jelinek 
3277b1019a6SJerry Jelinek /*
3287b1019a6SJerry Jelinek  * It is reported that, after some calculations, the physical addresses can
3297b1019a6SJerry Jelinek  * wrap over the 32-bit boundary on 32-bit PAE environment.
3307b1019a6SJerry Jelinek  * https://bugzilla.kernel.org/show_bug.cgi?id=87971
3317b1019a6SJerry Jelinek  */
3327b1019a6SJerry Jelinek typedef UINT64                          ACPI_IO_ADDRESS;
3337b1019a6SJerry Jelinek typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
3347b1019a6SJerry Jelinek 
3357b1019a6SJerry Jelinek #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */
3367b1019a6SJerry Jelinek 
33730082d0cSmyers #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
33830082d0cSmyers #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
33930082d0cSmyers 
34030082d0cSmyers #else
3417c478bd9Sstevel@tonic-gate 
342db2bae30SDana Myers /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
3437c478bd9Sstevel@tonic-gate 
34430082d0cSmyers #error unknown ACPI_MACHINE_WIDTH
34530082d0cSmyers #endif
3467c478bd9Sstevel@tonic-gate 
3477c478bd9Sstevel@tonic-gate 
34830082d0cSmyers /*******************************************************************************
34930082d0cSmyers  *
350aa2aa9a6SDana Myers  * OS-dependent types
35130082d0cSmyers  *
35227f7c583Smyers  * If the defaults below are not appropriate for the host system, they can
353aa2aa9a6SDana Myers  * be defined in the OS-specific header, and this will take precedence.
35430082d0cSmyers  *
35530082d0cSmyers  ******************************************************************************/
35630082d0cSmyers 
35727f7c583Smyers /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
35827f7c583Smyers 
35930082d0cSmyers #ifndef ACPI_CPU_FLAGS
360db2bae30SDana Myers #define ACPI_CPU_FLAGS                  ACPI_SIZE
36130082d0cSmyers #endif
36230082d0cSmyers 
36327f7c583Smyers /* Object returned from AcpiOsCreateCache */
36427f7c583Smyers 
36527f7c583Smyers #ifndef ACPI_CACHE_T
366aa2aa9a6SDana Myers #ifdef ACPI_USE_LOCAL_CACHE
36727f7c583Smyers #define ACPI_CACHE_T                    ACPI_MEMORY_LIST
368aa2aa9a6SDana Myers #else
369aa2aa9a6SDana Myers #define ACPI_CACHE_T                    void *
370aa2aa9a6SDana Myers #endif
37127f7c583Smyers #endif
37227f7c583Smyers 
373aa2aa9a6SDana Myers /*
374aa2aa9a6SDana Myers  * Synchronization objects - Mutexes, Semaphores, and SpinLocks
375aa2aa9a6SDana Myers  */
376aa2aa9a6SDana Myers #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
377aa2aa9a6SDana Myers /*
378aa2aa9a6SDana Myers  * These macros are used if the host OS does not support a mutex object.
379aa2aa9a6SDana Myers  * Map the OSL Mutex interfaces to binary semaphores.
380aa2aa9a6SDana Myers  */
381aa2aa9a6SDana Myers #define ACPI_MUTEX                      ACPI_SEMAPHORE
382aa2aa9a6SDana Myers #define AcpiOsCreateMutex(OutHandle)    AcpiOsCreateSemaphore (1, 1, OutHandle)
383aa2aa9a6SDana Myers #define AcpiOsDeleteMutex(Handle)       (void) AcpiOsDeleteSemaphore (Handle)
384aa2aa9a6SDana Myers #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
385aa2aa9a6SDana Myers #define AcpiOsReleaseMutex(Handle)      (void) AcpiOsSignalSemaphore (Handle, 1)
386aa2aa9a6SDana Myers #endif
387aa2aa9a6SDana Myers 
388aa2aa9a6SDana Myers /* Configurable types for synchronization objects */
389aa2aa9a6SDana Myers 
390aa2aa9a6SDana Myers #ifndef ACPI_SPINLOCK
391aa2aa9a6SDana Myers #define ACPI_SPINLOCK                   void *
392aa2aa9a6SDana Myers #endif
393aa2aa9a6SDana Myers 
394aa2aa9a6SDana Myers #ifndef ACPI_SEMAPHORE
395aa2aa9a6SDana Myers #define ACPI_SEMAPHORE                  void *
396aa2aa9a6SDana Myers #endif
397aa2aa9a6SDana Myers 
398aa2aa9a6SDana Myers #ifndef ACPI_MUTEX
399aa2aa9a6SDana Myers #define ACPI_MUTEX                      void *
400aa2aa9a6SDana Myers #endif
401aa2aa9a6SDana Myers 
402aa2aa9a6SDana Myers 
403aa2aa9a6SDana Myers /*******************************************************************************
404aa2aa9a6SDana Myers  *
405aa2aa9a6SDana Myers  * Compiler-dependent types
406aa2aa9a6SDana Myers  *
407aa2aa9a6SDana Myers  * If the defaults below are not appropriate for the host compiler, they can
408aa2aa9a6SDana Myers  * be defined in the compiler-specific header, and this will take precedence.
409aa2aa9a6SDana Myers  *
410aa2aa9a6SDana Myers  ******************************************************************************/
411aa2aa9a6SDana Myers 
41227f7c583Smyers /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
41327f7c583Smyers 
41427f7c583Smyers #ifndef ACPI_UINTPTR_T
41527f7c583Smyers #define ACPI_UINTPTR_T                  void *
41627f7c583Smyers #endif
41727f7c583Smyers 
41830082d0cSmyers /*
41930082d0cSmyers  * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
42030082d0cSmyers  * some compilers can catch printf format string problems
42130082d0cSmyers  */
42230082d0cSmyers #ifndef ACPI_PRINTF_LIKE
42330082d0cSmyers #define ACPI_PRINTF_LIKE(c)
42430082d0cSmyers #endif
42530082d0cSmyers 
42630082d0cSmyers /*
427*35786f68SRobert Mustacchi  * Some compilers complain about unused variables. Sometimes we don't want
428*35786f68SRobert Mustacchi  * to use all the variables (for example, _AcpiModuleName). This allows us
4297b1019a6SJerry Jelinek  * to tell the compiler in a per-variable manner that a variable
43030082d0cSmyers  * is unused
43130082d0cSmyers  */
43230082d0cSmyers #ifndef ACPI_UNUSED_VAR
43330082d0cSmyers #define ACPI_UNUSED_VAR
43430082d0cSmyers #endif
43530082d0cSmyers 
43627f7c583Smyers /*
437*35786f68SRobert Mustacchi  * All ACPICA external functions that are available to the rest of the
438*35786f68SRobert Mustacchi  * kernel are tagged with these macros which can be defined as appropriate
439*35786f68SRobert Mustacchi  * for the host.
4407b1019a6SJerry Jelinek  *
4417b1019a6SJerry Jelinek  * Notes:
4427b1019a6SJerry Jelinek  * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
4437b1019a6SJerry Jelinek  * interfaces that may need special processing.
4447b1019a6SJerry Jelinek  * ACPI_EXPORT_SYMBOL is used for all other public external functions.
44527f7c583Smyers  */
4467b1019a6SJerry Jelinek #ifndef ACPI_EXPORT_SYMBOL_INIT
4477b1019a6SJerry Jelinek #define ACPI_EXPORT_SYMBOL_INIT(Symbol)
4487b1019a6SJerry Jelinek #endif
4497b1019a6SJerry Jelinek 
45027f7c583Smyers #ifndef ACPI_EXPORT_SYMBOL
45127f7c583Smyers #define ACPI_EXPORT_SYMBOL(Symbol)
45227f7c583Smyers #endif
45327f7c583Smyers 
4547b1019a6SJerry Jelinek /*
4557b1019a6SJerry Jelinek  * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
4567b1019a6SJerry Jelinek  * utilities only.
4577b1019a6SJerry Jelinek  */
4587b1019a6SJerry Jelinek #ifndef ACPI_DEBUG_INITIALIZE
4597b1019a6SJerry Jelinek #define ACPI_DEBUG_INITIALIZE()
4607b1019a6SJerry Jelinek #endif
4617b1019a6SJerry Jelinek 
4627b1019a6SJerry Jelinek 
4637b1019a6SJerry Jelinek /*******************************************************************************
4647b1019a6SJerry Jelinek  *
4657b1019a6SJerry Jelinek  * Configuration
4667b1019a6SJerry Jelinek  *
4677b1019a6SJerry Jelinek  ******************************************************************************/
4687b1019a6SJerry Jelinek 
4697b1019a6SJerry Jelinek #ifdef ACPI_NO_MEM_ALLOCATIONS
4707b1019a6SJerry Jelinek 
4717b1019a6SJerry Jelinek #define ACPI_ALLOCATE(a)                NULL
4727b1019a6SJerry Jelinek #define ACPI_ALLOCATE_ZEROED(a)         NULL
4737b1019a6SJerry Jelinek #define ACPI_FREE(a)
4747b1019a6SJerry Jelinek #define ACPI_MEM_TRACKING(a)
4757b1019a6SJerry Jelinek 
4767b1019a6SJerry Jelinek #else /* ACPI_NO_MEM_ALLOCATIONS */
4777b1019a6SJerry Jelinek 
4787b1019a6SJerry Jelinek #ifdef ACPI_DBG_TRACK_ALLOCATIONS
4797b1019a6SJerry Jelinek /*
4807b1019a6SJerry Jelinek  * Memory allocation tracking (used by AcpiExec to detect memory leaks)
4817b1019a6SJerry Jelinek  */
4827b1019a6SJerry Jelinek #define ACPI_MEM_PARAMETERS             _COMPONENT, _AcpiModuleName, __LINE__
4837b1019a6SJerry Jelinek #define ACPI_ALLOCATE(a)                AcpiUtAllocateAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
4847b1019a6SJerry Jelinek #define ACPI_ALLOCATE_ZEROED(a)         AcpiUtAllocateZeroedAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
4857b1019a6SJerry Jelinek #define ACPI_FREE(a)                    AcpiUtFreeAndTrack (a, ACPI_MEM_PARAMETERS)
4867b1019a6SJerry Jelinek #define ACPI_MEM_TRACKING(a)            a
4877b1019a6SJerry Jelinek 
4887b1019a6SJerry Jelinek #else
4897b1019a6SJerry Jelinek /*
4907b1019a6SJerry Jelinek  * Normal memory allocation directly via the OS services layer
4917b1019a6SJerry Jelinek  */
4927b1019a6SJerry Jelinek #define ACPI_ALLOCATE(a)                AcpiOsAllocate ((ACPI_SIZE) (a))
4937b1019a6SJerry Jelinek #define ACPI_ALLOCATE_ZEROED(a)         AcpiOsAllocateZeroed ((ACPI_SIZE) (a))
4947b1019a6SJerry Jelinek #define ACPI_FREE(a)                    AcpiOsFree (a)
4957b1019a6SJerry Jelinek #define ACPI_MEM_TRACKING(a)
4967b1019a6SJerry Jelinek 
4977b1019a6SJerry Jelinek #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
4987b1019a6SJerry Jelinek 
4997b1019a6SJerry Jelinek #endif /* ACPI_NO_MEM_ALLOCATIONS */
5007b1019a6SJerry Jelinek 
50130082d0cSmyers 
502aa2aa9a6SDana Myers /******************************************************************************
503aa2aa9a6SDana Myers  *
504*35786f68SRobert Mustacchi  * ACPI Specification constants (Do not change unless the specification
505*35786f68SRobert Mustacchi  * changes)
506aa2aa9a6SDana Myers  *
507aa2aa9a6SDana Myers  *****************************************************************************/
508aa2aa9a6SDana Myers 
509aa2aa9a6SDana Myers /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
510aa2aa9a6SDana Myers 
511aa2aa9a6SDana Myers #define ACPI_MAX_GPE_BLOCKS             2
512aa2aa9a6SDana Myers 
513aa2aa9a6SDana Myers /* Default ACPI register widths */
514aa2aa9a6SDana Myers 
515aa2aa9a6SDana Myers #define ACPI_GPE_REGISTER_WIDTH         8
516aa2aa9a6SDana Myers #define ACPI_PM1_REGISTER_WIDTH         16
517aa2aa9a6SDana Myers #define ACPI_PM2_REGISTER_WIDTH         8
518aa2aa9a6SDana Myers #define ACPI_PM_TIMER_WIDTH             32
5197b1019a6SJerry Jelinek #define ACPI_RESET_REGISTER_WIDTH       8
520aa2aa9a6SDana Myers 
521aa2aa9a6SDana Myers /* Names within the namespace are 4 bytes long */
522aa2aa9a6SDana Myers 
523aa2aa9a6SDana Myers #define ACPI_NAME_SIZE                  4
524aa2aa9a6SDana Myers #define ACPI_PATH_SEGMENT_LENGTH        5           /* 4 chars for name + 1 char for separator */
525aa2aa9a6SDana Myers #define ACPI_PATH_SEPARATOR             '.'
526aa2aa9a6SDana Myers 
527aa2aa9a6SDana Myers /* Sizes for ACPI table headers */
528aa2aa9a6SDana Myers 
529aa2aa9a6SDana Myers #define ACPI_OEM_ID_SIZE                6
530aa2aa9a6SDana Myers #define ACPI_OEM_TABLE_ID_SIZE          8
531aa2aa9a6SDana Myers 
532aa2aa9a6SDana Myers /* ACPI/PNP hardware IDs */
533aa2aa9a6SDana Myers 
534aa2aa9a6SDana Myers #define PCI_ROOT_HID_STRING             "PNP0A03"
535aa2aa9a6SDana Myers #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
536aa2aa9a6SDana Myers 
537aa2aa9a6SDana Myers /* PM Timer ticks per second (HZ) */
538aa2aa9a6SDana Myers 
5397b1019a6SJerry Jelinek #define ACPI_PM_TIMER_FREQUENCY         3579545
540aa2aa9a6SDana Myers 
541aa2aa9a6SDana Myers 
54230082d0cSmyers /*******************************************************************************
54330082d0cSmyers  *
54430082d0cSmyers  * Independent types
54530082d0cSmyers  *
54630082d0cSmyers  ******************************************************************************/
5477c478bd9Sstevel@tonic-gate 
54830082d0cSmyers /* Logical defines and NULL */
54930082d0cSmyers 
5507c478bd9Sstevel@tonic-gate #ifdef FALSE
5517c478bd9Sstevel@tonic-gate #undef FALSE
5527c478bd9Sstevel@tonic-gate #endif
5537c478bd9Sstevel@tonic-gate #define FALSE                           (1 == 0)
5547c478bd9Sstevel@tonic-gate 
5557c478bd9Sstevel@tonic-gate #ifdef TRUE
5567c478bd9Sstevel@tonic-gate #undef TRUE
5577c478bd9Sstevel@tonic-gate #endif
5587c478bd9Sstevel@tonic-gate #define TRUE                            (1 == 1)
5597c478bd9Sstevel@tonic-gate 
5607c478bd9Sstevel@tonic-gate #ifndef NULL
5617c478bd9Sstevel@tonic-gate #define NULL                            (void *) 0
5627c478bd9Sstevel@tonic-gate #endif
5637c478bd9Sstevel@tonic-gate 
5647c478bd9Sstevel@tonic-gate 
5657c478bd9Sstevel@tonic-gate /*
566aa2aa9a6SDana Myers  * Miscellaneous types
5677c478bd9Sstevel@tonic-gate  */
5687c478bd9Sstevel@tonic-gate typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
5697c478bd9Sstevel@tonic-gate typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
5707c478bd9Sstevel@tonic-gate typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
57130082d0cSmyers typedef void *                          ACPI_HANDLE;    /* Actually a ptr to a NS Node */
5727c478bd9Sstevel@tonic-gate 
573aa2aa9a6SDana Myers 
5747b1019a6SJerry Jelinek /* Time constants for timer calculations */
5757b1019a6SJerry Jelinek 
5767b1019a6SJerry Jelinek #define ACPI_MSEC_PER_SEC               1000L
5777b1019a6SJerry Jelinek 
5787b1019a6SJerry Jelinek #define ACPI_USEC_PER_MSEC              1000L
5797b1019a6SJerry Jelinek #define ACPI_USEC_PER_SEC               1000000L
5807b1019a6SJerry Jelinek 
5817b1019a6SJerry Jelinek #define ACPI_100NSEC_PER_USEC           10L
5827b1019a6SJerry Jelinek #define ACPI_100NSEC_PER_MSEC           10000L
5837b1019a6SJerry Jelinek #define ACPI_100NSEC_PER_SEC            10000000L
5847b1019a6SJerry Jelinek 
5857b1019a6SJerry Jelinek #define ACPI_NSEC_PER_USEC              1000L
5867b1019a6SJerry Jelinek #define ACPI_NSEC_PER_MSEC              1000000L
5877b1019a6SJerry Jelinek #define ACPI_NSEC_PER_SEC               1000000000L
5887b1019a6SJerry Jelinek 
589*35786f68SRobert Mustacchi #define ACPI_TIME_AFTER(a, b)           ((INT64)((b) - (a)) < 0)
590*35786f68SRobert Mustacchi 
5917b1019a6SJerry Jelinek 
592aa2aa9a6SDana Myers /* Owner IDs are used to track namespace nodes for selective deletion */
593aa2aa9a6SDana Myers 
594aa2aa9a6SDana Myers typedef UINT8                           ACPI_OWNER_ID;
595aa2aa9a6SDana Myers #define ACPI_OWNER_ID_MAX               0xFF
596aa2aa9a6SDana Myers 
597aa2aa9a6SDana Myers 
5987c478bd9Sstevel@tonic-gate #define ACPI_INTEGER_BIT_SIZE           64
5997c478bd9Sstevel@tonic-gate #define ACPI_MAX_DECIMAL_DIGITS         20  /* 2^64 = 18,446,744,073,709,551,616 */
6007c478bd9Sstevel@tonic-gate #define ACPI_MAX64_DECIMAL_DIGITS       20
6017c478bd9Sstevel@tonic-gate #define ACPI_MAX32_DECIMAL_DIGITS       10
6027c478bd9Sstevel@tonic-gate #define ACPI_MAX16_DECIMAL_DIGITS        5
6037c478bd9Sstevel@tonic-gate #define ACPI_MAX8_DECIMAL_DIGITS         3
6047c478bd9Sstevel@tonic-gate 
6057c478bd9Sstevel@tonic-gate /*
6067c478bd9Sstevel@tonic-gate  * Constants with special meanings
6077c478bd9Sstevel@tonic-gate  */
608*35786f68SRobert Mustacchi #define ACPI_ROOT_OBJECT                ((ACPI_HANDLE) ACPI_TO_POINTER (ACPI_MAX_PTR))
609aa2aa9a6SDana Myers #define ACPI_WAIT_FOREVER               0xFFFF  /* UINT16, as per ACPI spec */
610aa2aa9a6SDana Myers #define ACPI_DO_NOT_WAIT                0
611aa2aa9a6SDana Myers 
61226f3cdf0SGordon Ross /*
613*35786f68SRobert Mustacchi  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
614*35786f68SRobert Mustacchi  * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
615*35786f68SRobert Mustacchi  * Note that this pertains to the ACPI integer type only, not to other
616*35786f68SRobert Mustacchi  * integers used in the implementation of the ACPICA subsystem.
61726f3cdf0SGordon Ross  *
61826f3cdf0SGordon Ross  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
61926f3cdf0SGordon Ross  * code base. It remains here for compatibility with device drivers that use
62026f3cdf0SGordon Ross  * the type. However, it will be removed in the future.
62126f3cdf0SGordon Ross  */
62226f3cdf0SGordon Ross typedef UINT64                          ACPI_INTEGER;
62326f3cdf0SGordon Ross #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
62426f3cdf0SGordon Ross 
625aa2aa9a6SDana Myers 
626aa2aa9a6SDana Myers /*******************************************************************************
627aa2aa9a6SDana Myers  *
628aa2aa9a6SDana Myers  * Commonly used macros
629aa2aa9a6SDana Myers  *
630aa2aa9a6SDana Myers  ******************************************************************************/
631aa2aa9a6SDana Myers 
632aa2aa9a6SDana Myers /* Data manipulation */
633aa2aa9a6SDana Myers 
634aa2aa9a6SDana Myers #define ACPI_LOBYTE(Integer)            ((UINT8)   (UINT16)(Integer))
635aa2aa9a6SDana Myers #define ACPI_HIBYTE(Integer)            ((UINT8) (((UINT16)(Integer)) >> 8))
636aa2aa9a6SDana Myers #define ACPI_LOWORD(Integer)            ((UINT16)  (UINT32)(Integer))
637aa2aa9a6SDana Myers #define ACPI_HIWORD(Integer)            ((UINT16)(((UINT32)(Integer)) >> 16))
638aa2aa9a6SDana Myers #define ACPI_LODWORD(Integer64)         ((UINT32)  (UINT64)(Integer64))
639aa2aa9a6SDana Myers #define ACPI_HIDWORD(Integer64)         ((UINT32)(((UINT64)(Integer64)) >> 32))
640aa2aa9a6SDana Myers 
641aa2aa9a6SDana Myers #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
642aa2aa9a6SDana Myers #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
643aa2aa9a6SDana Myers #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
644aa2aa9a6SDana Myers #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
645aa2aa9a6SDana Myers 
646aa2aa9a6SDana Myers /* Size calculation */
6477c478bd9Sstevel@tonic-gate 
648aa2aa9a6SDana Myers #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
649aa2aa9a6SDana Myers 
650aa2aa9a6SDana Myers /* Pointer manipulation */
651aa2aa9a6SDana Myers 
652aa2aa9a6SDana Myers #define ACPI_CAST_PTR(t, p)             ((t *) (ACPI_UINTPTR_T) (p))
653aa2aa9a6SDana Myers #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (ACPI_UINTPTR_T) (p))
654aa2aa9a6SDana Myers #define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
6557b1019a6SJerry Jelinek #define ACPI_SUB_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) - (ACPI_SIZE)(b)))
656*35786f68SRobert Mustacchi #define ACPI_PTR_DIFF(a, b)             ((ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b))))
657aa2aa9a6SDana Myers 
658aa2aa9a6SDana Myers /* Pointer/Integer type conversions */
659aa2aa9a6SDana Myers 
660*35786f68SRobert Mustacchi #define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) 0, (ACPI_SIZE) (i))
661*35786f68SRobert Mustacchi #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) 0)
662*35786f68SRobert Mustacchi #define ACPI_OFFSET(d, f)               ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) 0)
663aa2aa9a6SDana Myers #define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
664aa2aa9a6SDana Myers #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
665aa2aa9a6SDana Myers 
6667b1019a6SJerry Jelinek /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
6677b1019a6SJerry Jelinek 
668aa2aa9a6SDana Myers #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
669aa2aa9a6SDana Myers #define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
6707b1019a6SJerry Jelinek #define ACPI_MOVE_NAME(dest,src)        (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
671aa2aa9a6SDana Myers #else
6727b1019a6SJerry Jelinek #define ACPI_COMPARE_NAME(a,b)          (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
6737b1019a6SJerry Jelinek #define ACPI_MOVE_NAME(dest,src)        (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
674aa2aa9a6SDana Myers #endif
675aa2aa9a6SDana Myers 
6767b1019a6SJerry Jelinek /* Support for the special RSDP signature (8 characters) */
6777b1019a6SJerry Jelinek 
6787b1019a6SJerry Jelinek #define ACPI_VALIDATE_RSDP_SIG(a)       (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
6797b1019a6SJerry Jelinek #define ACPI_MAKE_RSDP_SIG(dest)        (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
6807b1019a6SJerry Jelinek 
681*35786f68SRobert Mustacchi /*
682*35786f68SRobert Mustacchi  * Algorithm to obtain access bit width.
683*35786f68SRobert Mustacchi  * Can be used with AccessWidth of ACPI_GENERIC_ADDRESS and AccessSize of
684*35786f68SRobert Mustacchi  * ACPI_RESOURCE_GENERIC_REGISTER.
685*35786f68SRobert Mustacchi  */
686*35786f68SRobert Mustacchi #define ACPI_ACCESS_BIT_WIDTH(size)     (1 << ((size) + 2))
687*35786f68SRobert Mustacchi 
688aa2aa9a6SDana Myers 
689aa2aa9a6SDana Myers /*******************************************************************************
690aa2aa9a6SDana Myers  *
691aa2aa9a6SDana Myers  * Miscellaneous constants
692aa2aa9a6SDana Myers  *
693aa2aa9a6SDana Myers  ******************************************************************************/
6947c478bd9Sstevel@tonic-gate 
6957c478bd9Sstevel@tonic-gate /*
696*35786f68SRobert Mustacchi  * Initialization sequence options
6977c478bd9Sstevel@tonic-gate  */
698*35786f68SRobert Mustacchi #define ACPI_FULL_INITIALIZATION        0x0000
699*35786f68SRobert Mustacchi #define ACPI_NO_FACS_INIT               0x0001
700*35786f68SRobert Mustacchi #define ACPI_NO_ACPI_ENABLE             0x0002
701*35786f68SRobert Mustacchi #define ACPI_NO_HARDWARE_INIT           0x0004
702*35786f68SRobert Mustacchi #define ACPI_NO_EVENT_INIT              0x0008
703*35786f68SRobert Mustacchi #define ACPI_NO_HANDLER_INIT            0x0010
704*35786f68SRobert Mustacchi #define ACPI_NO_OBJECT_INIT             0x0020
705*35786f68SRobert Mustacchi #define ACPI_NO_DEVICE_INIT             0x0040
706*35786f68SRobert Mustacchi #define ACPI_NO_ADDRESS_SPACE_INIT      0x0080
7077c478bd9Sstevel@tonic-gate 
7087c478bd9Sstevel@tonic-gate /*
7097c478bd9Sstevel@tonic-gate  * Initialization state
7107c478bd9Sstevel@tonic-gate  */
711db2bae30SDana Myers #define ACPI_SUBSYSTEM_INITIALIZE       0x01
712db2bae30SDana Myers #define ACPI_INITIALIZED_OK             0x02
7137c478bd9Sstevel@tonic-gate 
7147c478bd9Sstevel@tonic-gate /*
7157c478bd9Sstevel@tonic-gate  * Power state values
7167c478bd9Sstevel@tonic-gate  */
7177c478bd9Sstevel@tonic-gate #define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
7187c478bd9Sstevel@tonic-gate 
7197c478bd9Sstevel@tonic-gate #define ACPI_STATE_S0                   (UINT8) 0
7207c478bd9Sstevel@tonic-gate #define ACPI_STATE_S1                   (UINT8) 1
7217c478bd9Sstevel@tonic-gate #define ACPI_STATE_S2                   (UINT8) 2
7227c478bd9Sstevel@tonic-gate #define ACPI_STATE_S3                   (UINT8) 3
7237c478bd9Sstevel@tonic-gate #define ACPI_STATE_S4                   (UINT8) 4
7247c478bd9Sstevel@tonic-gate #define ACPI_STATE_S5                   (UINT8) 5
7257c478bd9Sstevel@tonic-gate #define ACPI_S_STATES_MAX               ACPI_STATE_S5
7267c478bd9Sstevel@tonic-gate #define ACPI_S_STATE_COUNT              6
7277c478bd9Sstevel@tonic-gate 
7287c478bd9Sstevel@tonic-gate #define ACPI_STATE_D0                   (UINT8) 0
7297c478bd9Sstevel@tonic-gate #define ACPI_STATE_D1                   (UINT8) 1
7307c478bd9Sstevel@tonic-gate #define ACPI_STATE_D2                   (UINT8) 2
7317c478bd9Sstevel@tonic-gate #define ACPI_STATE_D3                   (UINT8) 3
7327c478bd9Sstevel@tonic-gate #define ACPI_D_STATES_MAX               ACPI_STATE_D3
7337c478bd9Sstevel@tonic-gate #define ACPI_D_STATE_COUNT              4
7347c478bd9Sstevel@tonic-gate 
7357c478bd9Sstevel@tonic-gate #define ACPI_STATE_C0                   (UINT8) 0
7367c478bd9Sstevel@tonic-gate #define ACPI_STATE_C1                   (UINT8) 1
7377c478bd9Sstevel@tonic-gate #define ACPI_STATE_C2                   (UINT8) 2
7387c478bd9Sstevel@tonic-gate #define ACPI_STATE_C3                   (UINT8) 3
7397c478bd9Sstevel@tonic-gate #define ACPI_C_STATES_MAX               ACPI_STATE_C3
7407c478bd9Sstevel@tonic-gate #define ACPI_C_STATE_COUNT              4
7417c478bd9Sstevel@tonic-gate 
7427c478bd9Sstevel@tonic-gate /*
7437c478bd9Sstevel@tonic-gate  * Sleep type invalid value
7447c478bd9Sstevel@tonic-gate  */
7457c478bd9Sstevel@tonic-gate #define ACPI_SLEEP_TYPE_MAX             0x7
7467c478bd9Sstevel@tonic-gate #define ACPI_SLEEP_TYPE_INVALID         0xFF
7477c478bd9Sstevel@tonic-gate 
7487c478bd9Sstevel@tonic-gate /*
7497c478bd9Sstevel@tonic-gate  * Standard notify values
7507c478bd9Sstevel@tonic-gate  */
751db2bae30SDana Myers #define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0x00
752db2bae30SDana Myers #define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 0x01
753db2bae30SDana Myers #define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 0x02
754db2bae30SDana Myers #define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 0x03
755db2bae30SDana Myers #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 0x04
756db2bae30SDana Myers #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 0x05
757db2bae30SDana Myers #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 0x06
758db2bae30SDana Myers #define ACPI_NOTIFY_POWER_FAULT         (UINT8) 0x07
759db2bae30SDana Myers #define ACPI_NOTIFY_CAPABILITIES_CHECK  (UINT8) 0x08
760db2bae30SDana Myers #define ACPI_NOTIFY_DEVICE_PLD_CHECK    (UINT8) 0x09
761db2bae30SDana Myers #define ACPI_NOTIFY_RESERVED            (UINT8) 0x0A
762db2bae30SDana Myers #define ACPI_NOTIFY_LOCALITY_UPDATE     (UINT8) 0x0B
7637b1019a6SJerry Jelinek #define ACPI_NOTIFY_SHUTDOWN_REQUEST    (UINT8) 0x0C
7647b1019a6SJerry Jelinek #define ACPI_NOTIFY_AFFINITY_UPDATE     (UINT8) 0x0D
765*35786f68SRobert Mustacchi #define ACPI_NOTIFY_MEMORY_UPDATE       (UINT8) 0x0E
766db2bae30SDana Myers 
767*35786f68SRobert Mustacchi #define ACPI_GENERIC_NOTIFY_MAX         0x0E
7687b1019a6SJerry Jelinek #define ACPI_SPECIFIC_NOTIFY_MAX        0x84
7697c478bd9Sstevel@tonic-gate 
7707c478bd9Sstevel@tonic-gate /*
771aa2aa9a6SDana Myers  * Types associated with ACPI names and objects. The first group of
7727c478bd9Sstevel@tonic-gate  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
773aa2aa9a6SDana Myers  * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
7747c478bd9Sstevel@tonic-gate  * only add to the first group if the spec changes.
7757c478bd9Sstevel@tonic-gate  *
7767c478bd9Sstevel@tonic-gate  * NOTE: Types must be kept in sync with the global AcpiNsProperties
7777c478bd9Sstevel@tonic-gate  * and AcpiNsTypeNames arrays.
7787c478bd9Sstevel@tonic-gate  */
7797c478bd9Sstevel@tonic-gate typedef UINT32                          ACPI_OBJECT_TYPE;
7807c478bd9Sstevel@tonic-gate 
7817c478bd9Sstevel@tonic-gate #define ACPI_TYPE_ANY                   0x00
7827c478bd9Sstevel@tonic-gate #define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
7837c478bd9Sstevel@tonic-gate #define ACPI_TYPE_STRING                0x02
7847c478bd9Sstevel@tonic-gate #define ACPI_TYPE_BUFFER                0x03
7857c478bd9Sstevel@tonic-gate #define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
7867c478bd9Sstevel@tonic-gate #define ACPI_TYPE_FIELD_UNIT            0x05
7877c478bd9Sstevel@tonic-gate #define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
7887c478bd9Sstevel@tonic-gate #define ACPI_TYPE_EVENT                 0x07
7897c478bd9Sstevel@tonic-gate #define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
7907c478bd9Sstevel@tonic-gate #define ACPI_TYPE_MUTEX                 0x09
7917c478bd9Sstevel@tonic-gate #define ACPI_TYPE_REGION                0x0A
7927c478bd9Sstevel@tonic-gate #define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
7937c478bd9Sstevel@tonic-gate #define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
7947c478bd9Sstevel@tonic-gate #define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
7957c478bd9Sstevel@tonic-gate #define ACPI_TYPE_BUFFER_FIELD          0x0E
7967c478bd9Sstevel@tonic-gate #define ACPI_TYPE_DDB_HANDLE            0x0F
7977c478bd9Sstevel@tonic-gate #define ACPI_TYPE_DEBUG_OBJECT          0x10
7987c478bd9Sstevel@tonic-gate 
7997c478bd9Sstevel@tonic-gate #define ACPI_TYPE_EXTERNAL_MAX          0x10
8007b1019a6SJerry Jelinek #define ACPI_NUM_TYPES                  (ACPI_TYPE_EXTERNAL_MAX + 1)
8017c478bd9Sstevel@tonic-gate 
8027c478bd9Sstevel@tonic-gate /*
8037c478bd9Sstevel@tonic-gate  * These are object types that do not map directly to the ACPI
804*35786f68SRobert Mustacchi  * ObjectType() operator. They are used for various internal purposes
805*35786f68SRobert Mustacchi  * only. If new predefined ACPI_TYPEs are added (via the ACPI
806*35786f68SRobert Mustacchi  * specification), these internal types must move upwards. (There
807*35786f68SRobert Mustacchi  * is code that depends on these values being contiguous with the
808*35786f68SRobert Mustacchi  * external types above.)
8097c478bd9Sstevel@tonic-gate  */
8107c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
8117c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
8127c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
8137c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
8147c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_ALIAS           0x15
8157c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
8167c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_NOTIFY          0x17
8177c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
8187c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_RESOURCE        0x19
8197c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
8207c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_SCOPE           0x1B  /* 1 Name, multiple ObjectList Nodes */
8217c478bd9Sstevel@tonic-gate 
8227c478bd9Sstevel@tonic-gate #define ACPI_TYPE_NS_NODE_MAX           0x1B  /* Last typecode used within a NS Node */
8237b1019a6SJerry Jelinek #define ACPI_TOTAL_TYPES                (ACPI_TYPE_NS_NODE_MAX + 1)
8247c478bd9Sstevel@tonic-gate 
8257c478bd9Sstevel@tonic-gate /*
8267c478bd9Sstevel@tonic-gate  * These are special object types that never appear in
8277b1019a6SJerry Jelinek  * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
8287c478bd9Sstevel@tonic-gate  */
8297c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_EXTRA           0x1C
8307c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_DATA            0x1D
8317c478bd9Sstevel@tonic-gate 
8327c478bd9Sstevel@tonic-gate #define ACPI_TYPE_LOCAL_MAX             0x1D
8337c478bd9Sstevel@tonic-gate 
8347c478bd9Sstevel@tonic-gate /* All types above here are invalid */
8357c478bd9Sstevel@tonic-gate 
8367c478bd9Sstevel@tonic-gate #define ACPI_TYPE_INVALID               0x1E
8377c478bd9Sstevel@tonic-gate #define ACPI_TYPE_NOT_FOUND             0xFF
8387c478bd9Sstevel@tonic-gate 
839db2bae30SDana Myers #define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
840db2bae30SDana Myers 
841db2bae30SDana Myers 
8427c478bd9Sstevel@tonic-gate /*
8437c478bd9Sstevel@tonic-gate  * All I/O
8447c478bd9Sstevel@tonic-gate  */
8457c478bd9Sstevel@tonic-gate #define ACPI_READ                       0
8467c478bd9Sstevel@tonic-gate #define ACPI_WRITE                      1
8477c478bd9Sstevel@tonic-gate #define ACPI_IO_MASK                    1
8487c478bd9Sstevel@tonic-gate 
8497c478bd9Sstevel@tonic-gate /*
8507c478bd9Sstevel@tonic-gate  * Event Types: Fixed & General Purpose
8517c478bd9Sstevel@tonic-gate  */
8527c478bd9Sstevel@tonic-gate typedef UINT32                          ACPI_EVENT_TYPE;
8537c478bd9Sstevel@tonic-gate 
8547c478bd9Sstevel@tonic-gate /*
8557c478bd9Sstevel@tonic-gate  * Fixed events
8567c478bd9Sstevel@tonic-gate  */
8577c478bd9Sstevel@tonic-gate #define ACPI_EVENT_PMTIMER              0
8587c478bd9Sstevel@tonic-gate #define ACPI_EVENT_GLOBAL               1
8597c478bd9Sstevel@tonic-gate #define ACPI_EVENT_POWER_BUTTON         2
8607c478bd9Sstevel@tonic-gate #define ACPI_EVENT_SLEEP_BUTTON         3
8617c478bd9Sstevel@tonic-gate #define ACPI_EVENT_RTC                  4
8627c478bd9Sstevel@tonic-gate #define ACPI_EVENT_MAX                  4
8637c478bd9Sstevel@tonic-gate #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
8647c478bd9Sstevel@tonic-gate 
8657c478bd9Sstevel@tonic-gate /*
8667c478bd9Sstevel@tonic-gate  * Event Status - Per event
8677c478bd9Sstevel@tonic-gate  * -------------
8687c478bd9Sstevel@tonic-gate  * The encoding of ACPI_EVENT_STATUS is illustrated below.
8697c478bd9Sstevel@tonic-gate  * Note that a set bit (1) indicates the property is TRUE
8707c478bd9Sstevel@tonic-gate  * (e.g. if bit 0 is set then the event is enabled).
871*35786f68SRobert Mustacchi  * +-------------+-+-+-+-+-+-+
872*35786f68SRobert Mustacchi  * |   Bits 31:6 |5|4|3|2|1|0|
873*35786f68SRobert Mustacchi  * +-------------+-+-+-+-+-+-+
874*35786f68SRobert Mustacchi  *          |     | | | | | |
875*35786f68SRobert Mustacchi  *          |     | | | | | +- Enabled?
876*35786f68SRobert Mustacchi  *          |     | | | | +--- Enabled for wake?
877*35786f68SRobert Mustacchi  *          |     | | | +----- Status bit set?
878*35786f68SRobert Mustacchi  *          |     | | +------- Enable bit set?
879*35786f68SRobert Mustacchi  *          |     | +--------- Has a handler?
880*35786f68SRobert Mustacchi  *          |     +----------- Masked?
881*35786f68SRobert Mustacchi  *          +----------------- <Reserved>
8827c478bd9Sstevel@tonic-gate  */
8837c478bd9Sstevel@tonic-gate typedef UINT32                          ACPI_EVENT_STATUS;
8847c478bd9Sstevel@tonic-gate 
8857c478bd9Sstevel@tonic-gate #define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
8867c478bd9Sstevel@tonic-gate #define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
8877c478bd9Sstevel@tonic-gate #define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
8887b1019a6SJerry Jelinek #define ACPI_EVENT_FLAG_STATUS_SET      (ACPI_EVENT_STATUS) 0x04
8897b1019a6SJerry Jelinek #define ACPI_EVENT_FLAG_ENABLE_SET      (ACPI_EVENT_STATUS) 0x08
8907b1019a6SJerry Jelinek #define ACPI_EVENT_FLAG_HAS_HANDLER     (ACPI_EVENT_STATUS) 0x10
891*35786f68SRobert Mustacchi #define ACPI_EVENT_FLAG_MASKED          (ACPI_EVENT_STATUS) 0x20
8927b1019a6SJerry Jelinek #define ACPI_EVENT_FLAG_SET             ACPI_EVENT_FLAG_STATUS_SET
8937c478bd9Sstevel@tonic-gate 
89426f3cdf0SGordon Ross /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
89526f3cdf0SGordon Ross 
8967c478bd9Sstevel@tonic-gate #define ACPI_GPE_ENABLE                 0
8977c478bd9Sstevel@tonic-gate #define ACPI_GPE_DISABLE                1
89826f3cdf0SGordon Ross #define ACPI_GPE_CONDITIONAL_ENABLE     2
8997c478bd9Sstevel@tonic-gate 
9007c478bd9Sstevel@tonic-gate /*
9017c478bd9Sstevel@tonic-gate  * GPE info flags - Per GPE
902*35786f68SRobert Mustacchi  * +---+-+-+-+---+
903*35786f68SRobert Mustacchi  * |7:6|5|4|3|2:0|
904*35786f68SRobert Mustacchi  * +---+-+-+-+---+
905*35786f68SRobert Mustacchi  *   |  | | |  |
906*35786f68SRobert Mustacchi  *   |  | | |  +-- Type of dispatch:to method, handler, notify, or none
907*35786f68SRobert Mustacchi  *   |  | | +----- Interrupt type: edge or level triggered
908*35786f68SRobert Mustacchi  *   |  | +------- Is a Wake GPE
909*35786f68SRobert Mustacchi  *   |  +--------- Has been enabled automatically at init time
910*35786f68SRobert Mustacchi  *   +------------ <Reserved>
9117c478bd9Sstevel@tonic-gate  */
91226f3cdf0SGordon Ross #define ACPI_GPE_DISPATCH_NONE          (UINT8) 0x00
91326f3cdf0SGordon Ross #define ACPI_GPE_DISPATCH_METHOD        (UINT8) 0x01
91426f3cdf0SGordon Ross #define ACPI_GPE_DISPATCH_HANDLER       (UINT8) 0x02
91526f3cdf0SGordon Ross #define ACPI_GPE_DISPATCH_NOTIFY        (UINT8) 0x03
9167b1019a6SJerry Jelinek #define ACPI_GPE_DISPATCH_RAW_HANDLER   (UINT8) 0x04
9177b1019a6SJerry Jelinek #define ACPI_GPE_DISPATCH_MASK          (UINT8) 0x07
9187b1019a6SJerry Jelinek #define ACPI_GPE_DISPATCH_TYPE(flags)   ((UINT8) ((flags) & ACPI_GPE_DISPATCH_MASK))
9197c478bd9Sstevel@tonic-gate 
9207b1019a6SJerry Jelinek #define ACPI_GPE_LEVEL_TRIGGERED        (UINT8) 0x08
92126f3cdf0SGordon Ross #define ACPI_GPE_EDGE_TRIGGERED         (UINT8) 0x00
9227b1019a6SJerry Jelinek #define ACPI_GPE_XRUPT_TYPE_MASK        (UINT8) 0x08
9237c478bd9Sstevel@tonic-gate 
9247b1019a6SJerry Jelinek #define ACPI_GPE_CAN_WAKE               (UINT8) 0x10
925*35786f68SRobert Mustacchi #define ACPI_GPE_AUTO_ENABLED           (UINT8) 0x20
926*35786f68SRobert Mustacchi #define ACPI_GPE_INITIALIZED            (UINT8) 0x40
9277c478bd9Sstevel@tonic-gate 
9287c478bd9Sstevel@tonic-gate /*
9297c478bd9Sstevel@tonic-gate  * Flags for GPE and Lock interfaces
9307c478bd9Sstevel@tonic-gate  */
9317c478bd9Sstevel@tonic-gate #define ACPI_NOT_ISR                    0x1
9327c478bd9Sstevel@tonic-gate #define ACPI_ISR                        0x0
9337c478bd9Sstevel@tonic-gate 
9347c478bd9Sstevel@tonic-gate 
9357c478bd9Sstevel@tonic-gate /* Notify types */
9367c478bd9Sstevel@tonic-gate 
9377c478bd9Sstevel@tonic-gate #define ACPI_SYSTEM_NOTIFY              0x1
9387c478bd9Sstevel@tonic-gate #define ACPI_DEVICE_NOTIFY              0x2
939db2bae30SDana Myers #define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
9407c478bd9Sstevel@tonic-gate #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
9417b1019a6SJerry Jelinek #define ACPI_NUM_NOTIFY_TYPES           2
9427c478bd9Sstevel@tonic-gate 
9437b1019a6SJerry Jelinek #define ACPI_MAX_SYS_NOTIFY             0x7F
9447b1019a6SJerry Jelinek #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
9457b1019a6SJerry Jelinek 
9467b1019a6SJerry Jelinek #define ACPI_SYSTEM_HANDLER_LIST        0 /* Used as index, must be SYSTEM_NOTIFY -1 */
9477b1019a6SJerry Jelinek #define ACPI_DEVICE_HANDLER_LIST        1 /* Used as index, must be DEVICE_NOTIFY -1 */
9487c478bd9Sstevel@tonic-gate 
9497c478bd9Sstevel@tonic-gate 
9507c478bd9Sstevel@tonic-gate /* Address Space (Operation Region) Types */
9517c478bd9Sstevel@tonic-gate 
9527c478bd9Sstevel@tonic-gate typedef UINT8                           ACPI_ADR_SPACE_TYPE;
9537c478bd9Sstevel@tonic-gate 
9547c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
9557c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
9567c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
9577c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
9587c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
9597c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
9607c478bd9Sstevel@tonic-gate #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
96157190917SDana Myers #define ACPI_ADR_SPACE_IPMI             (ACPI_ADR_SPACE_TYPE) 7
9627b1019a6SJerry Jelinek #define ACPI_ADR_SPACE_GPIO             (ACPI_ADR_SPACE_TYPE) 8
9637b1019a6SJerry Jelinek #define ACPI_ADR_SPACE_GSBUS            (ACPI_ADR_SPACE_TYPE) 9
9647b1019a6SJerry Jelinek #define ACPI_ADR_SPACE_PLATFORM_COMM    (ACPI_ADR_SPACE_TYPE) 10
9657c478bd9Sstevel@tonic-gate 
9667b1019a6SJerry Jelinek #define ACPI_NUM_PREDEFINED_REGIONS     11
96726f3cdf0SGordon Ross 
96826f3cdf0SGordon Ross /*
96926f3cdf0SGordon Ross  * Special Address Spaces
97026f3cdf0SGordon Ross  *
97126f3cdf0SGordon Ross  * Note: A Data Table region is a special type of operation region
97226f3cdf0SGordon Ross  * that has its own AML opcode. However, internally, the AML
97326f3cdf0SGordon Ross  * interpreter simply creates an operation region with an an address
97426f3cdf0SGordon Ross  * space type of ACPI_ADR_SPACE_DATA_TABLE.
97526f3cdf0SGordon Ross  */
97626f3cdf0SGordon Ross #define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
97726f3cdf0SGordon Ross #define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 0x7F
97826f3cdf0SGordon Ross 
97926f3cdf0SGordon Ross /* Values for _REG connection code */
98026f3cdf0SGordon Ross 
98126f3cdf0SGordon Ross #define ACPI_REG_DISCONNECT             0
98226f3cdf0SGordon Ross #define ACPI_REG_CONNECT                1
9837c478bd9Sstevel@tonic-gate 
9847c478bd9Sstevel@tonic-gate /*
9857c478bd9Sstevel@tonic-gate  * BitRegister IDs
986aa2aa9a6SDana Myers  *
987aa2aa9a6SDana Myers  * These values are intended to be used by the hardware interfaces
988aa2aa9a6SDana Myers  * and are mapped to individual bitfields defined within the ACPI
989aa2aa9a6SDana Myers  * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
990aa2aa9a6SDana Myers  * for this mapping.
9917c478bd9Sstevel@tonic-gate  */
992aa2aa9a6SDana Myers 
993aa2aa9a6SDana Myers /* PM1 Status register */
994aa2aa9a6SDana Myers 
9957c478bd9Sstevel@tonic-gate #define ACPI_BITREG_TIMER_STATUS                0x00
9967c478bd9Sstevel@tonic-gate #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
9977c478bd9Sstevel@tonic-gate #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
9987c478bd9Sstevel@tonic-gate #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
9997c478bd9Sstevel@tonic-gate #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
10007c478bd9Sstevel@tonic-gate #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
10017c478bd9Sstevel@tonic-gate #define ACPI_BITREG_WAKE_STATUS                 0x06
10027c478bd9Sstevel@tonic-gate #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
10037c478bd9Sstevel@tonic-gate 
1004aa2aa9a6SDana Myers /* PM1 Enable register */
1005aa2aa9a6SDana Myers 
10067c478bd9Sstevel@tonic-gate #define ACPI_BITREG_TIMER_ENABLE                0x08
10077c478bd9Sstevel@tonic-gate #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
10087c478bd9Sstevel@tonic-gate #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
10097c478bd9Sstevel@tonic-gate #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
10107c478bd9Sstevel@tonic-gate #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
1011aa2aa9a6SDana Myers #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
1012aa2aa9a6SDana Myers 
1013aa2aa9a6SDana Myers /* PM1 Control register */
10147c478bd9Sstevel@tonic-gate 
1015aa2aa9a6SDana Myers #define ACPI_BITREG_SCI_ENABLE                  0x0E
1016aa2aa9a6SDana Myers #define ACPI_BITREG_BUS_MASTER_RLD              0x0F
1017aa2aa9a6SDana Myers #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
1018aa2aa9a6SDana Myers #define ACPI_BITREG_SLEEP_TYPE                  0x11
1019aa2aa9a6SDana Myers #define ACPI_BITREG_SLEEP_ENABLE                0x12
10207c478bd9Sstevel@tonic-gate 
1021aa2aa9a6SDana Myers /* PM2 Control register */
10227c478bd9Sstevel@tonic-gate 
1023aa2aa9a6SDana Myers #define ACPI_BITREG_ARB_DISABLE                 0x13
1024aa2aa9a6SDana Myers 
1025aa2aa9a6SDana Myers #define ACPI_BITREG_MAX                         0x13
10267c478bd9Sstevel@tonic-gate #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
10277c478bd9Sstevel@tonic-gate 
10287c478bd9Sstevel@tonic-gate 
1029aa2aa9a6SDana Myers /* Status register values. A 1 clears a status bit. 0 = no effect */
1030aa2aa9a6SDana Myers 
1031aa2aa9a6SDana Myers #define ACPI_CLEAR_STATUS                       1
1032aa2aa9a6SDana Myers 
1033aa2aa9a6SDana Myers /* Enable and Control register values */
1034aa2aa9a6SDana Myers 
1035aa2aa9a6SDana Myers #define ACPI_ENABLE_EVENT                       1
1036aa2aa9a6SDana Myers #define ACPI_DISABLE_EVENT                      0
1037aa2aa9a6SDana Myers 
1038aa2aa9a6SDana Myers 
10397b1019a6SJerry Jelinek /* Sleep function dispatch */
10407b1019a6SJerry Jelinek 
10417b1019a6SJerry Jelinek typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) (
10427b1019a6SJerry Jelinek     UINT8                   SleepState);
10437b1019a6SJerry Jelinek 
10447b1019a6SJerry Jelinek typedef struct acpi_sleep_functions
10457b1019a6SJerry Jelinek {
10467b1019a6SJerry Jelinek     ACPI_SLEEP_FUNCTION     LegacyFunction;
10477b1019a6SJerry Jelinek     ACPI_SLEEP_FUNCTION     ExtendedFunction;
10487b1019a6SJerry Jelinek 
10497b1019a6SJerry Jelinek } ACPI_SLEEP_FUNCTIONS;
10507b1019a6SJerry Jelinek 
10517b1019a6SJerry Jelinek 
10527c478bd9Sstevel@tonic-gate /*
10537c478bd9Sstevel@tonic-gate  * External ACPI object definition
10547c478bd9Sstevel@tonic-gate  */
1055db2bae30SDana Myers 
1056db2bae30SDana Myers /*
1057*35786f68SRobert Mustacchi  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
1058*35786f68SRobert Mustacchi  * element or an unresolved named reference.
1059db2bae30SDana Myers  */
10607c478bd9Sstevel@tonic-gate typedef union acpi_object
10617c478bd9Sstevel@tonic-gate {
106227f7c583Smyers     ACPI_OBJECT_TYPE                Type;   /* See definition of AcpiNsType for values */
10637c478bd9Sstevel@tonic-gate     struct
10647c478bd9Sstevel@tonic-gate     {
1065db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_INTEGER */
106626f3cdf0SGordon Ross         UINT64                          Value;      /* The actual number */
10677c478bd9Sstevel@tonic-gate     } Integer;
10687c478bd9Sstevel@tonic-gate 
10697c478bd9Sstevel@tonic-gate     struct
10707c478bd9Sstevel@tonic-gate     {
1071db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_STRING */
107227f7c583Smyers         UINT32                          Length;     /* # of bytes in string, excluding trailing null */
107327f7c583Smyers         char                            *Pointer;   /* points to the string value */
10747c478bd9Sstevel@tonic-gate     } String;
10757c478bd9Sstevel@tonic-gate 
10767c478bd9Sstevel@tonic-gate     struct
10777c478bd9Sstevel@tonic-gate     {
1078db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_BUFFER */
107927f7c583Smyers         UINT32                          Length;     /* # of bytes in buffer */
108027f7c583Smyers         UINT8                           *Pointer;   /* points to the buffer */
10817c478bd9Sstevel@tonic-gate     } Buffer;
10827c478bd9Sstevel@tonic-gate 
10837c478bd9Sstevel@tonic-gate     struct
10847c478bd9Sstevel@tonic-gate     {
1085db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PACKAGE */
108627f7c583Smyers         UINT32                          Count;      /* # of elements in package */
108727f7c583Smyers         union acpi_object               *Elements;  /* Pointer to an array of ACPI_OBJECTs */
10887c478bd9Sstevel@tonic-gate     } Package;
10897c478bd9Sstevel@tonic-gate 
10907c478bd9Sstevel@tonic-gate     struct
10917c478bd9Sstevel@tonic-gate     {
1092db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_LOCAL_REFERENCE */
1093db2bae30SDana Myers         ACPI_OBJECT_TYPE                ActualType; /* Type associated with the Handle */
1094db2bae30SDana Myers         ACPI_HANDLE                     Handle;     /* object reference */
1095db2bae30SDana Myers     } Reference;
1096db2bae30SDana Myers 
1097db2bae30SDana Myers     struct
1098db2bae30SDana Myers     {
1099db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PROCESSOR */
110027f7c583Smyers         UINT32                          ProcId;
110127f7c583Smyers         ACPI_IO_ADDRESS                 PblkAddress;
110227f7c583Smyers         UINT32                          PblkLength;
11037c478bd9Sstevel@tonic-gate     } Processor;
11047c478bd9Sstevel@tonic-gate 
11057c478bd9Sstevel@tonic-gate     struct
11067c478bd9Sstevel@tonic-gate     {
1107db2bae30SDana Myers         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_POWER */
110827f7c583Smyers         UINT32                          SystemLevel;
110927f7c583Smyers         UINT32                          ResourceOrder;
11107c478bd9Sstevel@tonic-gate     } PowerResource;
11117c478bd9Sstevel@tonic-gate 
11127c478bd9Sstevel@tonic-gate } ACPI_OBJECT;
11137c478bd9Sstevel@tonic-gate 
11147c478bd9Sstevel@tonic-gate 
11157c478bd9Sstevel@tonic-gate /*
11167c478bd9Sstevel@tonic-gate  * List of objects, used as a parameter list for control method evaluation
11177c478bd9Sstevel@tonic-gate  */
11187c478bd9Sstevel@tonic-gate typedef struct acpi_object_list
11197c478bd9Sstevel@tonic-gate {
112027f7c583Smyers     UINT32                          Count;
112127f7c583Smyers     ACPI_OBJECT                     *Pointer;
11227c478bd9Sstevel@tonic-gate 
11237c478bd9Sstevel@tonic-gate } ACPI_OBJECT_LIST;
11247c478bd9Sstevel@tonic-gate 
11257c478bd9Sstevel@tonic-gate 
11267c478bd9Sstevel@tonic-gate /*
11277c478bd9Sstevel@tonic-gate  * Miscellaneous common Data Structures used by the interfaces
11287c478bd9Sstevel@tonic-gate  */
11297c478bd9Sstevel@tonic-gate #define ACPI_NO_BUFFER              0
11307b1019a6SJerry Jelinek 
11317b1019a6SJerry Jelinek #ifdef ACPI_NO_MEM_ALLOCATIONS
11327b1019a6SJerry Jelinek 
11337b1019a6SJerry Jelinek #define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (0)
11347b1019a6SJerry Jelinek #define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (0)
11357b1019a6SJerry Jelinek 
11367b1019a6SJerry Jelinek #else /* ACPI_NO_MEM_ALLOCATIONS */
11377b1019a6SJerry Jelinek 
11387b1019a6SJerry Jelinek #define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)    /* Let ACPICA allocate buffer */
11397b1019a6SJerry Jelinek #define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)    /* For internal use only (enables tracking) */
11407b1019a6SJerry Jelinek 
11417b1019a6SJerry Jelinek #endif /* ACPI_NO_MEM_ALLOCATIONS */
11427c478bd9Sstevel@tonic-gate 
11437c478bd9Sstevel@tonic-gate typedef struct acpi_buffer
11447c478bd9Sstevel@tonic-gate {
114527f7c583Smyers     ACPI_SIZE                       Length;         /* Length in bytes of the buffer */
114627f7c583Smyers     void                            *Pointer;       /* pointer to buffer */
11477c478bd9Sstevel@tonic-gate 
11487c478bd9Sstevel@tonic-gate } ACPI_BUFFER;
11497c478bd9Sstevel@tonic-gate 
11507c478bd9Sstevel@tonic-gate 
11517c478bd9Sstevel@tonic-gate /*
11527c478bd9Sstevel@tonic-gate  * NameType for AcpiGetName
11537c478bd9Sstevel@tonic-gate  */
11547c478bd9Sstevel@tonic-gate #define ACPI_FULL_PATHNAME              0
11557c478bd9Sstevel@tonic-gate #define ACPI_SINGLE_NAME                1
11567b1019a6SJerry Jelinek #define ACPI_FULL_PATHNAME_NO_TRAILING  2
11577b1019a6SJerry Jelinek #define ACPI_NAME_TYPE_MAX              2
11587c478bd9Sstevel@tonic-gate 
11597c478bd9Sstevel@tonic-gate 
1160aa2aa9a6SDana Myers /*
1161aa2aa9a6SDana Myers  * Predefined Namespace items
1162aa2aa9a6SDana Myers  */
1163aa2aa9a6SDana Myers typedef struct acpi_predefined_names
1164aa2aa9a6SDana Myers {
11657b1019a6SJerry Jelinek     const char                      *Name;
1166aa2aa9a6SDana Myers     UINT8                           Type;
1167aa2aa9a6SDana Myers     char                            *Val;
1168aa2aa9a6SDana Myers 
1169aa2aa9a6SDana Myers } ACPI_PREDEFINED_NAMES;
1170aa2aa9a6SDana Myers 
1171aa2aa9a6SDana Myers 
11727c478bd9Sstevel@tonic-gate /*
11737c478bd9Sstevel@tonic-gate  * Structure and flags for AcpiGetSystemInfo
11747c478bd9Sstevel@tonic-gate  */
11757c478bd9Sstevel@tonic-gate #define ACPI_SYS_MODE_UNKNOWN           0x0000
11767c478bd9Sstevel@tonic-gate #define ACPI_SYS_MODE_ACPI              0x0001
11777c478bd9Sstevel@tonic-gate #define ACPI_SYS_MODE_LEGACY            0x0002
11787c478bd9Sstevel@tonic-gate #define ACPI_SYS_MODES_MASK             0x0003
11797c478bd9Sstevel@tonic-gate 
11807c478bd9Sstevel@tonic-gate 
11817c478bd9Sstevel@tonic-gate /*
11827c478bd9Sstevel@tonic-gate  * System info returned by AcpiGetSystemInfo()
11837c478bd9Sstevel@tonic-gate  */
11847c478bd9Sstevel@tonic-gate typedef struct acpi_system_info
11857c478bd9Sstevel@tonic-gate {
118627f7c583Smyers     UINT32                          AcpiCaVersion;
118727f7c583Smyers     UINT32                          Flags;
118827f7c583Smyers     UINT32                          TimerResolution;
118927f7c583Smyers     UINT32                          Reserved1;
119027f7c583Smyers     UINT32                          Reserved2;
119127f7c583Smyers     UINT32                          DebugLevel;
119227f7c583Smyers     UINT32                          DebugLayer;
11937c478bd9Sstevel@tonic-gate 
11947c478bd9Sstevel@tonic-gate } ACPI_SYSTEM_INFO;
11957c478bd9Sstevel@tonic-gate 
11967c478bd9Sstevel@tonic-gate 
1197db2bae30SDana Myers /*
1198aa2aa9a6SDana Myers  * System statistics returned by AcpiGetStatistics()
1199db2bae30SDana Myers  */
1200db2bae30SDana Myers typedef struct acpi_statistics
1201db2bae30SDana Myers {
1202db2bae30SDana Myers     UINT32                          SciCount;
1203db2bae30SDana Myers     UINT32                          GpeCount;
1204db2bae30SDana Myers     UINT32                          FixedEventCount[ACPI_NUM_FIXED_EVENTS];
1205db2bae30SDana Myers     UINT32                          MethodCount;
1206db2bae30SDana Myers 
1207db2bae30SDana Myers } ACPI_STATISTICS;
1208db2bae30SDana Myers 
1209db2bae30SDana Myers 
12107c478bd9Sstevel@tonic-gate /*
12117c478bd9Sstevel@tonic-gate  * Types specific to the OS service interfaces
12127c478bd9Sstevel@tonic-gate  */
12137c478bd9Sstevel@tonic-gate typedef UINT32
12147c478bd9Sstevel@tonic-gate (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
121527f7c583Smyers     void                            *Context);
12167c478bd9Sstevel@tonic-gate 
12177c478bd9Sstevel@tonic-gate typedef void
12187c478bd9Sstevel@tonic-gate (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
121927f7c583Smyers     void                            *Context);
12207c478bd9Sstevel@tonic-gate 
12217c478bd9Sstevel@tonic-gate /*
12227c478bd9Sstevel@tonic-gate  * Various handlers and callback procedures
12237c478bd9Sstevel@tonic-gate  */
122426f3cdf0SGordon Ross typedef
12257b1019a6SJerry Jelinek UINT32 (*ACPI_SCI_HANDLER) (
12267b1019a6SJerry Jelinek     void                            *Context);
12277b1019a6SJerry Jelinek 
12287b1019a6SJerry Jelinek typedef
122926f3cdf0SGordon Ross void (*ACPI_GBL_EVENT_HANDLER) (
123026f3cdf0SGordon Ross     UINT32                          EventType,
123126f3cdf0SGordon Ross     ACPI_HANDLE                     Device,
123226f3cdf0SGordon Ross     UINT32                          EventNumber,
123326f3cdf0SGordon Ross     void                            *Context);
123426f3cdf0SGordon Ross 
123526f3cdf0SGordon Ross #define ACPI_EVENT_TYPE_GPE         0
123626f3cdf0SGordon Ross #define ACPI_EVENT_TYPE_FIXED       1
123726f3cdf0SGordon Ross 
12387c478bd9Sstevel@tonic-gate typedef
12397c478bd9Sstevel@tonic-gate UINT32 (*ACPI_EVENT_HANDLER) (
124027f7c583Smyers     void                            *Context);
12417c478bd9Sstevel@tonic-gate 
124226f3cdf0SGordon Ross typedef
124326f3cdf0SGordon Ross UINT32 (*ACPI_GPE_HANDLER) (
124426f3cdf0SGordon Ross     ACPI_HANDLE                     GpeDevice,
124526f3cdf0SGordon Ross     UINT32                          GpeNumber,
124626f3cdf0SGordon Ross     void                            *Context);
124726f3cdf0SGordon Ross 
12487c478bd9Sstevel@tonic-gate typedef
12497c478bd9Sstevel@tonic-gate void (*ACPI_NOTIFY_HANDLER) (
125027f7c583Smyers     ACPI_HANDLE                     Device,
125127f7c583Smyers     UINT32                          Value,
125227f7c583Smyers     void                            *Context);
12537c478bd9Sstevel@tonic-gate 
12547c478bd9Sstevel@tonic-gate typedef
12557c478bd9Sstevel@tonic-gate void (*ACPI_OBJECT_HANDLER) (
125627f7c583Smyers     ACPI_HANDLE                     Object,
125727f7c583Smyers     void                            *Data);
12587c478bd9Sstevel@tonic-gate 
12597c478bd9Sstevel@tonic-gate typedef
12607c478bd9Sstevel@tonic-gate ACPI_STATUS (*ACPI_INIT_HANDLER) (
126127f7c583Smyers     ACPI_HANDLE                     Object,
126227f7c583Smyers     UINT32                          Function);
12637c478bd9Sstevel@tonic-gate 
12647c478bd9Sstevel@tonic-gate #define ACPI_INIT_DEVICE_INI        1
12657c478bd9Sstevel@tonic-gate 
12667c478bd9Sstevel@tonic-gate typedef
12677c478bd9Sstevel@tonic-gate ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
126827f7c583Smyers     ACPI_STATUS                     AmlStatus,
126927f7c583Smyers     ACPI_NAME                       Name,
127027f7c583Smyers     UINT16                          Opcode,
127127f7c583Smyers     UINT32                          AmlOffset,
127227f7c583Smyers     void                            *Context);
12737c478bd9Sstevel@tonic-gate 
1274aa2aa9a6SDana Myers /* Table Event handler (Load, LoadTable, etc.) and types */
1275db2bae30SDana Myers 
1276db2bae30SDana Myers typedef
1277db2bae30SDana Myers ACPI_STATUS (*ACPI_TABLE_HANDLER) (
1278db2bae30SDana Myers     UINT32                          Event,
1279db2bae30SDana Myers     void                            *Table,
1280db2bae30SDana Myers     void                            *Context);
1281db2bae30SDana Myers 
1282*35786f68SRobert Mustacchi 
1283*35786f68SRobert Mustacchi /* Table Event Types */
1284*35786f68SRobert Mustacchi 
1285*35786f68SRobert Mustacchi #define ACPI_TABLE_EVENT_LOAD           0x0
1286*35786f68SRobert Mustacchi #define ACPI_TABLE_EVENT_UNLOAD         0x1
1287*35786f68SRobert Mustacchi #define ACPI_TABLE_EVENT_INSTALL        0x2
1288*35786f68SRobert Mustacchi #define ACPI_TABLE_EVENT_UNINSTALL      0x3
1289*35786f68SRobert Mustacchi #define ACPI_NUM_TABLE_EVENTS           4
1290db2bae30SDana Myers 
12917c478bd9Sstevel@tonic-gate 
12927c478bd9Sstevel@tonic-gate /* Address Spaces (For Operation Regions) */
12937c478bd9Sstevel@tonic-gate 
12947c478bd9Sstevel@tonic-gate typedef
12957c478bd9Sstevel@tonic-gate ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
129627f7c583Smyers     UINT32                          Function,
129727f7c583Smyers     ACPI_PHYSICAL_ADDRESS           Address,
129827f7c583Smyers     UINT32                          BitWidth,
129926f3cdf0SGordon Ross     UINT64                          *Value,
130027f7c583Smyers     void                            *HandlerContext,
130127f7c583Smyers     void                            *RegionContext);
13027c478bd9Sstevel@tonic-gate 
130327f7c583Smyers #define ACPI_DEFAULT_HANDLER            NULL
13047c478bd9Sstevel@tonic-gate 
13057b1019a6SJerry Jelinek /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
13067b1019a6SJerry Jelinek 
13077b1019a6SJerry Jelinek typedef struct acpi_connection_info
13087b1019a6SJerry Jelinek {
13097b1019a6SJerry Jelinek     UINT8                           *Connection;
13107b1019a6SJerry Jelinek     UINT16                          Length;
13117b1019a6SJerry Jelinek     UINT8                           AccessLength;
13127b1019a6SJerry Jelinek 
13137b1019a6SJerry Jelinek } ACPI_CONNECTION_INFO;
13147b1019a6SJerry Jelinek 
13157b1019a6SJerry Jelinek 
13167c478bd9Sstevel@tonic-gate typedef
13177c478bd9Sstevel@tonic-gate ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
131827f7c583Smyers     ACPI_HANDLE                     RegionHandle,
131927f7c583Smyers     UINT32                          Function,
132027f7c583Smyers     void                            *HandlerContext,
132127f7c583Smyers     void                            **RegionContext);
13227c478bd9Sstevel@tonic-gate 
13237c478bd9Sstevel@tonic-gate #define ACPI_REGION_ACTIVATE    0
13247c478bd9Sstevel@tonic-gate #define ACPI_REGION_DEACTIVATE  1
13257c478bd9Sstevel@tonic-gate 
13267c478bd9Sstevel@tonic-gate typedef
13277c478bd9Sstevel@tonic-gate ACPI_STATUS (*ACPI_WALK_CALLBACK) (
132826f3cdf0SGordon Ross     ACPI_HANDLE                     Object,
132927f7c583Smyers     UINT32                          NestingLevel,
133027f7c583Smyers     void                            *Context,
133127f7c583Smyers     void                            **ReturnValue);
13327c478bd9Sstevel@tonic-gate 
133326f3cdf0SGordon Ross typedef
133426f3cdf0SGordon Ross UINT32 (*ACPI_INTERFACE_HANDLER) (
133526f3cdf0SGordon Ross     ACPI_STRING                     InterfaceName,
133626f3cdf0SGordon Ross     UINT32                          Supported);
133726f3cdf0SGordon Ross 
13387c478bd9Sstevel@tonic-gate 
13397c478bd9Sstevel@tonic-gate /* Interrupt handler return values */
13407c478bd9Sstevel@tonic-gate 
13417c478bd9Sstevel@tonic-gate #define ACPI_INTERRUPT_NOT_HANDLED      0x00
13427c478bd9Sstevel@tonic-gate #define ACPI_INTERRUPT_HANDLED          0x01
13437c478bd9Sstevel@tonic-gate 
134426f3cdf0SGordon Ross /* GPE handler return values */
134526f3cdf0SGordon Ross 
134626f3cdf0SGordon Ross #define ACPI_REENABLE_GPE               0x80
134726f3cdf0SGordon Ross 
134826f3cdf0SGordon Ross 
134957190917SDana Myers /* Length of 32-bit EISAID values when converted back to a string */
135057190917SDana Myers 
135157190917SDana Myers #define ACPI_EISAID_STRING_SIZE         8   /* Includes null terminator */
13527c478bd9Sstevel@tonic-gate 
135357190917SDana Myers /* Length of UUID (string) values */
1354aa2aa9a6SDana Myers 
1355aa2aa9a6SDana Myers #define ACPI_UUID_LENGTH                16
1356aa2aa9a6SDana Myers 
13577b1019a6SJerry Jelinek /* Length of 3-byte PCI class code values when converted back to a string */
13587b1019a6SJerry Jelinek 
13597b1019a6SJerry Jelinek #define ACPI_PCICLS_STRING_SIZE         7   /* Includes null terminator */
13607b1019a6SJerry Jelinek 
136157190917SDana Myers 
136257190917SDana Myers /* Structures used for device/processor HID, UID, CID */
13637c478bd9Sstevel@tonic-gate 
13647b1019a6SJerry Jelinek typedef struct acpi_pnp_device_id
13657c478bd9Sstevel@tonic-gate {
136657190917SDana Myers     UINT32                          Length;             /* Length of string + null */
136757190917SDana Myers     char                            *String;
13687c478bd9Sstevel@tonic-gate 
13697b1019a6SJerry Jelinek } ACPI_PNP_DEVICE_ID;
13707c478bd9Sstevel@tonic-gate 
13717b1019a6SJerry Jelinek typedef struct acpi_pnp_device_id_list
13727c478bd9Sstevel@tonic-gate {
137357190917SDana Myers     UINT32                          Count;              /* Number of IDs in Ids array */
137457190917SDana Myers     UINT32                          ListSize;           /* Size of list, including ID strings */
13757b1019a6SJerry Jelinek     ACPI_PNP_DEVICE_ID              Ids[1];             /* ID array */
13767c478bd9Sstevel@tonic-gate 
13777b1019a6SJerry Jelinek } ACPI_PNP_DEVICE_ID_LIST;
13787c478bd9Sstevel@tonic-gate 
137957190917SDana Myers /*
138057190917SDana Myers  * Structure returned from AcpiGetObjectInfo.
1381*35786f68SRobert Mustacchi  * Optimized for both 32-bit and 64-bit builds.
138257190917SDana Myers  */
138357190917SDana Myers typedef struct acpi_device_info
13847c478bd9Sstevel@tonic-gate {
138557190917SDana Myers     UINT32                          InfoSize;           /* Size of info, including ID strings */
138657190917SDana Myers     UINT32                          Name;               /* ACPI object Name */
138757190917SDana Myers     ACPI_OBJECT_TYPE                Type;               /* ACPI object Type */
138857190917SDana Myers     UINT8                           ParamCount;         /* If a method, required parameter count */
13897b1019a6SJerry Jelinek     UINT16                          Valid;              /* Indicates which optional fields are valid */
139057190917SDana Myers     UINT8                           Flags;              /* Miscellaneous info */
139157190917SDana Myers     UINT8                           HighestDstates[4];  /* _SxD values: 0xFF indicates not valid */
139257190917SDana Myers     UINT8                           LowestDstates[5];   /* _SxW values: 0xFF indicates not valid */
139326f3cdf0SGordon Ross     UINT64                          Address;            /* _ADR value */
13947b1019a6SJerry Jelinek     ACPI_PNP_DEVICE_ID              HardwareId;         /* _HID value */
13957b1019a6SJerry Jelinek     ACPI_PNP_DEVICE_ID              UniqueId;           /* _UID value */
13967b1019a6SJerry Jelinek     ACPI_PNP_DEVICE_ID              ClassCode;          /* _CLS value */
13977b1019a6SJerry Jelinek     ACPI_PNP_DEVICE_ID_LIST         CompatibleIdList;   /* _CID list <must be last> */
139857190917SDana Myers 
139957190917SDana Myers } ACPI_DEVICE_INFO;
14007c478bd9Sstevel@tonic-gate 
140157190917SDana Myers /* Values for Flags field above (AcpiGetObjectInfo) */
14027c478bd9Sstevel@tonic-gate 
140357190917SDana Myers #define ACPI_PCI_ROOT_BRIDGE            0x01
14047c478bd9Sstevel@tonic-gate 
140557190917SDana Myers /* Flags for Valid field above (AcpiGetObjectInfo) */
14067c478bd9Sstevel@tonic-gate 
14077b1019a6SJerry Jelinek #define ACPI_VALID_ADR                  0x0002
14087b1019a6SJerry Jelinek #define ACPI_VALID_HID                  0x0004
14097b1019a6SJerry Jelinek #define ACPI_VALID_UID                  0x0008
14107b1019a6SJerry Jelinek #define ACPI_VALID_CID                  0x0020
14117b1019a6SJerry Jelinek #define ACPI_VALID_CLS                  0x0040
14127b1019a6SJerry Jelinek #define ACPI_VALID_SXDS                 0x0100
14137b1019a6SJerry Jelinek #define ACPI_VALID_SXWS                 0x0200
14147c478bd9Sstevel@tonic-gate 
141530082d0cSmyers /* Flags for _STA method */
141630082d0cSmyers 
141730082d0cSmyers #define ACPI_STA_DEVICE_PRESENT         0x01
141830082d0cSmyers #define ACPI_STA_DEVICE_ENABLED         0x02
141930082d0cSmyers #define ACPI_STA_DEVICE_UI              0x04
142027f7c583Smyers #define ACPI_STA_DEVICE_FUNCTIONING     0x08
142127f7c583Smyers #define ACPI_STA_DEVICE_OK              0x08 /* Synonym */
142230082d0cSmyers #define ACPI_STA_BATTERY_PRESENT        0x10
142330082d0cSmyers 
14247c478bd9Sstevel@tonic-gate 
14257c478bd9Sstevel@tonic-gate /* Context structs for address space handlers */
14267c478bd9Sstevel@tonic-gate 
14277c478bd9Sstevel@tonic-gate typedef struct acpi_pci_id
14287c478bd9Sstevel@tonic-gate {
142927f7c583Smyers     UINT16                          Segment;
143027f7c583Smyers     UINT16                          Bus;
143127f7c583Smyers     UINT16                          Device;
143227f7c583Smyers     UINT16                          Function;
14337c478bd9Sstevel@tonic-gate 
14347c478bd9Sstevel@tonic-gate } ACPI_PCI_ID;
14357c478bd9Sstevel@tonic-gate 
14367c478bd9Sstevel@tonic-gate typedef struct acpi_mem_space_context
14377c478bd9Sstevel@tonic-gate {
143827f7c583Smyers     UINT32                          Length;
143927f7c583Smyers     ACPI_PHYSICAL_ADDRESS           Address;
144027f7c583Smyers     ACPI_PHYSICAL_ADDRESS           MappedPhysicalAddress;
144127f7c583Smyers     UINT8                           *MappedLogicalAddress;
144227f7c583Smyers     ACPI_SIZE                       MappedLength;
14437c478bd9Sstevel@tonic-gate 
14447c478bd9Sstevel@tonic-gate } ACPI_MEM_SPACE_CONTEXT;
14457c478bd9Sstevel@tonic-gate 
14467c478bd9Sstevel@tonic-gate 
14477c478bd9Sstevel@tonic-gate /*
1448aa2aa9a6SDana Myers  * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
14497c478bd9Sstevel@tonic-gate  */
1450aa2aa9a6SDana Myers typedef struct acpi_memory_list
145130082d0cSmyers {
14527b1019a6SJerry Jelinek     const char                      *ListName;
1453aa2aa9a6SDana Myers     void                            *ListHead;
1454aa2aa9a6SDana Myers     UINT16                          ObjectSize;
1455aa2aa9a6SDana Myers     UINT16                          MaxDepth;
1456aa2aa9a6SDana Myers     UINT16                          CurrentDepth;
1457aa2aa9a6SDana Myers 
1458aa2aa9a6SDana Myers #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1459aa2aa9a6SDana Myers 
1460aa2aa9a6SDana Myers     /* Statistics for debug memory tracking only */
1461aa2aa9a6SDana Myers 
1462aa2aa9a6SDana Myers     UINT32                          TotalAllocated;
1463aa2aa9a6SDana Myers     UINT32                          TotalFreed;
1464aa2aa9a6SDana Myers     UINT32                          MaxOccupied;
1465aa2aa9a6SDana Myers     UINT32                          TotalSize;
1466aa2aa9a6SDana Myers     UINT32                          CurrentTotalSize;
1467aa2aa9a6SDana Myers     UINT32                          Requests;
1468aa2aa9a6SDana Myers     UINT32                          Hits;
1469aa2aa9a6SDana Myers #endif
14707c478bd9Sstevel@tonic-gate 
1471aa2aa9a6SDana Myers } ACPI_MEMORY_LIST;
14727c478bd9Sstevel@tonic-gate 
14737c478bd9Sstevel@tonic-gate 
14747b1019a6SJerry Jelinek /* Definitions of trace event types */
14757b1019a6SJerry Jelinek 
14767b1019a6SJerry Jelinek typedef enum
14777b1019a6SJerry Jelinek {
14787b1019a6SJerry Jelinek     ACPI_TRACE_AML_METHOD,
14797b1019a6SJerry Jelinek     ACPI_TRACE_AML_OPCODE,
14807b1019a6SJerry Jelinek     ACPI_TRACE_AML_REGION
14817b1019a6SJerry Jelinek 
14827b1019a6SJerry Jelinek } ACPI_TRACE_EVENT_TYPE;
14837b1019a6SJerry Jelinek 
14847b1019a6SJerry Jelinek 
14857b1019a6SJerry Jelinek /* Definitions of _OSI support */
14867b1019a6SJerry Jelinek 
14877b1019a6SJerry Jelinek #define ACPI_VENDOR_STRINGS                 0x01
14887b1019a6SJerry Jelinek #define ACPI_FEATURE_STRINGS                0x02
14897b1019a6SJerry Jelinek #define ACPI_ENABLE_INTERFACES              0x00
14907b1019a6SJerry Jelinek #define ACPI_DISABLE_INTERFACES             0x04
14917b1019a6SJerry Jelinek 
14927b1019a6SJerry Jelinek #define ACPI_DISABLE_ALL_VENDOR_STRINGS     (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
14937b1019a6SJerry Jelinek #define ACPI_DISABLE_ALL_FEATURE_STRINGS    (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
14947b1019a6SJerry Jelinek #define ACPI_DISABLE_ALL_STRINGS            (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
14957b1019a6SJerry Jelinek #define ACPI_ENABLE_ALL_VENDOR_STRINGS      (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
14967b1019a6SJerry Jelinek #define ACPI_ENABLE_ALL_FEATURE_STRINGS     (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
14977b1019a6SJerry Jelinek #define ACPI_ENABLE_ALL_STRINGS             (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
14987b1019a6SJerry Jelinek 
14997b1019a6SJerry Jelinek #define ACPI_OSI_WIN_2000               0x01
15007b1019a6SJerry Jelinek #define ACPI_OSI_WIN_XP                 0x02
15017b1019a6SJerry Jelinek #define ACPI_OSI_WIN_XP_SP1             0x03
15027b1019a6SJerry Jelinek #define ACPI_OSI_WINSRV_2003            0x04
15037b1019a6SJerry Jelinek #define ACPI_OSI_WIN_XP_SP2             0x05
15047b1019a6SJerry Jelinek #define ACPI_OSI_WINSRV_2003_SP1        0x06
15057b1019a6SJerry Jelinek #define ACPI_OSI_WIN_VISTA              0x07
15067b1019a6SJerry Jelinek #define ACPI_OSI_WINSRV_2008            0x08
15077b1019a6SJerry Jelinek #define ACPI_OSI_WIN_VISTA_SP1          0x09
15087b1019a6SJerry Jelinek #define ACPI_OSI_WIN_VISTA_SP2          0x0A
15097b1019a6SJerry Jelinek #define ACPI_OSI_WIN_7                  0x0B
15107b1019a6SJerry Jelinek #define ACPI_OSI_WIN_8                  0x0C
15117b1019a6SJerry Jelinek #define ACPI_OSI_WIN_10                 0x0D
1512*35786f68SRobert Mustacchi #define ACPI_OSI_WIN_10_RS1             0x0E
1513*35786f68SRobert Mustacchi #define ACPI_OSI_WIN_10_RS2             0x0F
1514*35786f68SRobert Mustacchi #define ACPI_OSI_WIN_10_RS3             0x10
15157b1019a6SJerry Jelinek 
15167b1019a6SJerry Jelinek 
15177b1019a6SJerry Jelinek /* Definitions of getopt */
15187b1019a6SJerry Jelinek 
15197b1019a6SJerry Jelinek #define ACPI_OPT_END                    -1
15207b1019a6SJerry Jelinek 
15217b1019a6SJerry Jelinek 
15227c478bd9Sstevel@tonic-gate #endif /* __ACTYPES_H__ */
1523