xref: /illumos-gate/usr/src/uts/intel/sys/acpi/platform/acwin.h (revision 968633ad8faee931821fd6b656eb0d96d4b186c0)
1 /******************************************************************************
2  *
3  * Name: acwin.h - OS specific defines, etc.
4  *       $Revision: 1.30 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights.  You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code.  No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision.  In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change.  Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee.  Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution.  In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government.  In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************/
116 
117 #ifndef __ACWIN_H__
118 #define __ACWIN_H__
119 
120 /*! [Begin] no source code translation (Keep the include) */
121 
122 /* Windows uses VC */
123 #ifdef _MSC_VER
124 #include "acmsvc.h"
125 #endif
126 /*! [End] no source code translation !*/
127 
128 #define ACPI_MACHINE_WIDTH      32
129 
130 #define isascii                 __isascii
131 #define inline                  __inline
132 
133 #define ACPI_USE_STANDARD_HEADERS
134 
135 #ifdef ACPI_DEFINE_ALTERNATE_TYPES
136 /*
137  * Types used only in (Linux) translated source, defined here to enable
138  * cross-platform compilation (i.e., generate the Linux code on Windows,
139  * for test purposes only)
140  */
141 typedef int                             s32;
142 typedef unsigned char                   u8;
143 typedef unsigned short                  u16;
144 typedef unsigned int                    u32;
145 typedef COMPILER_DEPENDENT_UINT64       u64;
146 #endif
147 
148 
149 /*
150  * Handle platform- and compiler-specific assembly language differences.
151  *
152  * Notes:
153  * 1) Interrupt 3 is used to break into a debugger
154  * 2) Interrupts are turned off during ACPI register setup
155  */
156 
157 /*! [Begin] no source code translation  */
158 
159 #define ACPI_ASM_MACROS
160 #ifdef ACPI_APPLICATION
161 #define BREAKPOINT3
162 #define ACPI_DISABLE_IRQS()
163 #define ACPI_ENABLE_IRQS()
164 #define ACPI_FLUSH_CPU_CACHE()
165 #else
166 #define BREAKPOINT3             __asm {int 3}
167 #define ACPI_DISABLE_IRQS()     __asm {cli}
168 #define ACPI_ENABLE_IRQS()      __asm {sti}
169 #define ACPI_FLUSH_CPU_CACHE()  __asm {WBINVD}
170 #endif
171 
172 #ifdef _DEBUG
173 #define ACPI_SIMPLE_RETURN_MACROS
174 #endif
175 
176 /*! [End] no source code translation !*/
177 
178 /*
179  * Global Lock acquire/release code
180  *
181  * Note: Handles case where the FACS pointer is null
182  */
183 #define ACPI_ACQUIRE_GLOBAL_LOCK(FacsPtr, Acq)  __asm \
184 {                                                   \
185         __asm mov           eax, 0xFF               \
186         __asm mov           ecx, FacsPtr            \
187         __asm or            ecx, ecx                \
188         __asm jz            exit_acq                \
189         __asm lea           ecx, [ecx].GlobalLock   \
190                                                     \
191         __asm acq10:                                \
192         __asm mov           eax, [ecx]              \
193         __asm mov           edx, eax                \
194         __asm and           edx, 0xFFFFFFFE         \
195         __asm bts           edx, 1                  \
196         __asm adc           edx, 0                  \
197         __asm lock cmpxchg  dword ptr [ecx], edx    \
198         __asm jnz           acq10                   \
199                                                     \
200         __asm cmp           dl, 3                   \
201         __asm sbb           eax, eax                \
202                                                     \
203         __asm exit_acq:                             \
204         __asm mov           Acq, al                 \
205 }
206 
207 #define ACPI_RELEASE_GLOBAL_LOCK(FacsPtr, Pnd) __asm \
208 {                                                   \
209         __asm xor           eax, eax                \
210         __asm mov           ecx, FacsPtr            \
211         __asm or            ecx, ecx                \
212         __asm jz            exit_rel                \
213         __asm lea           ecx, [ecx].GlobalLock   \
214                                                     \
215         __asm Rel10:                                \
216         __asm mov           eax, [ecx]              \
217         __asm mov           edx, eax                \
218         __asm and           edx, 0xFFFFFFFC         \
219         __asm lock cmpxchg  dword ptr [ecx], edx    \
220         __asm jnz           Rel10                   \
221                                                     \
222         __asm cmp           dl, 3                   \
223         __asm and           eax, 1                  \
224                                                     \
225         __asm exit_rel:                             \
226         __asm mov           Pnd, al                 \
227 }
228 
229 #endif /* __ACWIN_H__ */
230