1 /******************************************************************************
2  *
3  * Name: acwin.h - OS specific defines, etc.
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ACWIN_H__
153 #define __ACWIN_H__
154 
155 #include <io.h>
156 
157 #define ACPI_USE_STANDARD_HEADERS
158 #define ACPI_USE_SYSTEM_CLIBRARY
159 
160  /* Note: do not include any C library headers here */
161 
162  /*
163  * Note: MSVC project files should define ACPI_DEBUGGER and ACPI_DISASSEMBLER
164  * as appropriate to enable editor functions like "Find all references".
165  * The editor isn't smart enough to dig through the include files to find
166  * out if these are actually defined.
167  */
168 
169  /* Eliminate warnings for "old" (non-secure) versions of clib functions */
170 
171 #ifndef _CRT_SECURE_NO_WARNINGS
172 #define _CRT_SECURE_NO_WARNINGS
173 #endif
174 
175 /* Eliminate warnings for POSIX clib function names (open, write, etc.) */
176 
177 #ifndef _CRT_NONSTDC_NO_DEPRECATE
178 #define _CRT_NONSTDC_NO_DEPRECATE
179 #endif
180 
181 
182 #define ACPI_MACHINE_WIDTH      32
183 #define ACPI_USE_NATIVE_DIVIDE
184 #define ACPI_USE_NATIVE_MATH64
185 
186 #ifdef ACPI_DEFINE_ALTERNATE_TYPES
187 /*
188  * Types used only in (Linux) translated source, defined here to enable
189  * cross-platform compilation (i.e., generate the Linux code on Windows,
190  * for test purposes only)
191  */
192 typedef int                             s32;
193 typedef unsigned char                   u8;
194 typedef unsigned short                  u16;
195 typedef unsigned int                    u32;
196 typedef COMPILER_DEPENDENT_UINT64       u64;
197 #endif
198 
199 /*
200  * Map low I/O functions for MS. This allows us to disable MS language
201  * extensions for maximum portability.
202  */
203 #define open            _open
204 #define read            _read
205 #define write           _write
206 #define close           _close
207 #define stat            _stat
208 #define fstat           _fstat
209 #define mkdir           _mkdir
210 #define fileno          _fileno
211 #define isatty          _isatty
212 
213 #if _MSC_VER <= 1200 /* Versions below VC++ 6 */
214 #define vsnprintf       _vsnprintf
215 #endif
216 #define O_RDONLY        _O_RDONLY
217 #define O_BINARY        _O_BINARY
218 #define O_CREAT         _O_CREAT
219 #define O_WRONLY        _O_WRONLY
220 #define O_TRUNC         _O_TRUNC
221 #define S_IREAD         _S_IREAD
222 #define S_IWRITE        _S_IWRITE
223 #define S_IFDIR         _S_IFDIR
224 #if _MSC_VER < 1900
225 #define snprintf        _snprintf
226 #endif
227 
228 
229 /*
230  * Handle platform- and compiler-specific assembly language differences.
231  *
232  * Notes:
233  * 1) Interrupt 3 is used to break into a debugger
234  * 2) Interrupts are turned off during ACPI register setup
235  */
236 
237 /*! [Begin] no source code translation  */
238 
239 #ifdef ACPI_APPLICATION
240 #define ACPI_FLUSH_CPU_CACHE()
241 #else
242 #define ACPI_FLUSH_CPU_CACHE()  __asm {WBINVD}
243 #endif
244 
245 #ifdef _DEBUG
246 #define ACPI_SIMPLE_RETURN_MACROS
247 #endif
248 
249 /*! [End] no source code translation !*/
250 
251 /*
252  * Global Lock acquire/release code
253  *
254  * Note: Handles case where the FACS pointer is null
255  */
256 #define ACPI_ACQUIRE_GLOBAL_LOCK(FacsPtr, Acq)  __asm \
257 {                                                   \
258         __asm mov           eax, 0xFF               \
259         __asm mov           ecx, FacsPtr            \
260         __asm or            ecx, ecx                \
261         __asm jz            exit_acq                \
262         __asm lea           ecx, [ecx].GlobalLock   \
263                                                     \
264         __asm acq10:                                \
265         __asm mov           eax, [ecx]              \
266         __asm mov           edx, eax                \
267         __asm and           edx, 0xFFFFFFFE         \
268         __asm bts           edx, 1                  \
269         __asm adc           edx, 0                  \
270         __asm lock cmpxchg  dword ptr [ecx], edx    \
271         __asm jnz           acq10                   \
272                                                     \
273         __asm cmp           dl, 3                   \
274         __asm sbb           eax, eax                \
275                                                     \
276         __asm exit_acq:                             \
277         __asm mov           Acq, al                 \
278 }
279 
280 #define ACPI_RELEASE_GLOBAL_LOCK(FacsPtr, Pnd) __asm \
281 {                                                   \
282         __asm xor           eax, eax                \
283         __asm mov           ecx, FacsPtr            \
284         __asm or            ecx, ecx                \
285         __asm jz            exit_rel                \
286         __asm lea           ecx, [ecx].GlobalLock   \
287                                                     \
288         __asm Rel10:                                \
289         __asm mov           eax, [ecx]              \
290         __asm mov           edx, eax                \
291         __asm and           edx, 0xFFFFFFFC         \
292         __asm lock cmpxchg  dword ptr [ecx], edx    \
293         __asm jnz           Rel10                   \
294                                                     \
295         __asm cmp           dl, 3                   \
296         __asm and           eax, 1                  \
297                                                     \
298         __asm exit_rel:                             \
299         __asm mov           Pnd, al                 \
300 }
301 
302 #endif /* __ACWIN_H__ */
303