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