xref: /illumos-gate/usr/src/uts/intel/sys/acpi/platform/acmsvc.h (revision 5328fc53d11d7151861fa272e4fb0248b8f0e145)
1 /******************************************************************************
2  *
3  * Name: acmsvc.h - VC specific defines, etc.
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, 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 __ACMSVC_H__
153 #define __ACMSVC_H__
154 
155 /* Note: do not include any C library headers here */
156 
157 /*
158  * Note: MSVC project files should define ACPI_DEBUGGER and ACPI_DISASSEMBLER
159  * as appropriate to enable editor functions like "Find all references".
160  * The editor isn't smart enough to dig through the include files to find
161  * out if these are actually defined.
162  */
163 
164 /* Eliminate warnings for "old" (non-secure) versions of clib functions */
165 
166 #ifndef _CRT_SECURE_NO_WARNINGS
167 #define _CRT_SECURE_NO_WARNINGS
168 #endif
169 
170 /* Eliminate warnings for POSIX clib function names (open, write, etc.) */
171 
172 #ifndef _CRT_NONSTDC_NO_DEPRECATE
173 #define _CRT_NONSTDC_NO_DEPRECATE
174 #endif
175 
176 #define COMPILER_DEPENDENT_INT64    __int64
177 #define COMPILER_DEPENDENT_UINT64   unsigned __int64
178 #define ACPI_INLINE                 __inline
179 
180 /*
181  * Calling conventions:
182  *
183  * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
184  * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
185  * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
186  * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
187  */
188 #define ACPI_SYSTEM_XFACE           __cdecl
189 #define ACPI_EXTERNAL_XFACE
190 #define ACPI_INTERNAL_XFACE
191 #define ACPI_INTERNAL_VAR_XFACE     __cdecl
192 
193 
194 /* Do not maintain the architecture specific stuffs for the EFI ports */
195 
196 #if defined(__i386__) && !defined(_GNU_EFI) && !defined(_EDK2_EFI)
197 /*
198  * Math helper functions
199  */
200 #ifndef ACPI_DIV_64_BY_32
201 #define ACPI_DIV_64_BY_32(n_hi, n_lo, d32, q32, r32) \
202 {                           \
203     __asm mov    edx, n_hi  \
204     __asm mov    eax, n_lo  \
205     __asm div    d32        \
206     __asm mov    q32, eax   \
207     __asm mov    r32, edx   \
208 }
209 #endif
210 
211 #ifndef ACPI_MUL_64_BY_32
212 #define ACPI_MUL_64_BY_32(n_hi, n_lo, m32, p32, c32) \
213 {                           \
214     __asm mov    edx, n_hi  \
215     __asm mov    eax, n_lo  \
216     __asm mul    m32        \
217     __asm mov    p32, eax   \
218     __asm mov    c32, edx   \
219 }
220 #endif
221 
222 #ifndef ACPI_SHIFT_LEFT_64_BY_32
223 #define ACPI_SHIFT_LEFT_64_BY_32(n_hi, n_lo, s32) \
224 {                               \
225     __asm mov    edx, n_hi      \
226     __asm mov    eax, n_lo      \
227     __asm mov    ecx, s32       \
228     __asm and    ecx, 31        \
229     __asm shld   edx, eax, cl   \
230     __asm shl    eax, cl        \
231     __asm mov    n_hi, edx      \
232     __asm mov    n_lo, eax      \
233 }
234 #endif
235 
236 #ifndef ACPI_SHIFT_RIGHT_64_BY_32
237 #define ACPI_SHIFT_RIGHT_64_BY_32(n_hi, n_lo, s32) \
238 {                               \
239     __asm mov    edx, n_hi      \
240     __asm mov    eax, n_lo      \
241     __asm mov    ecx, s32       \
242     __asm and    ecx, 31        \
243     __asm shrd   eax, edx, cl   \
244     __asm shr    edx, cl        \
245     __asm mov    n_hi, edx      \
246     __asm mov    n_lo, eax      \
247 }
248 #endif
249 
250 #ifndef ACPI_SHIFT_RIGHT_64
251 #define ACPI_SHIFT_RIGHT_64(n_hi, n_lo) \
252 {                           \
253     __asm shr    n_hi, 1    \
254     __asm rcr    n_lo, 1    \
255 }
256 #endif
257 #endif
258 
259 /* warn C4100: unreferenced formal parameter */
260 #pragma warning(disable:4100)
261 
262 /* warn C4127: conditional expression is constant */
263 #pragma warning(disable:4127)
264 
265 /* warn C4706: assignment within conditional expression */
266 #pragma warning(disable:4706)
267 
268 /* warn C4131: uses old-style declarator (iASL compiler only) */
269 #pragma warning(disable:4131)
270 
271 #if _MSC_VER > 1200 /* Versions above VC++ 6 */
272 #pragma warning( disable : 4295 ) /* needed for acpredef.h array */
273 #endif
274 
275 
276 /* Debug support. */
277 
278 #ifdef _DEBUG
279 
280 /*
281  * Debugging memory corruption issues with windows:
282  * Add #include <crtdbg.h> to accommon.h if necessary.
283  * Add _ASSERTE(_CrtCheckMemory()); where needed to test memory integrity.
284  * This can quickly localize the memory corruption.
285  */
286 #define ACPI_DEBUG_INITIALIZE() \
287     _CrtSetDbgFlag (\
288         _CRTDBG_CHECK_ALWAYS_DF | \
289         _CRTDBG_ALLOC_MEM_DF | \
290         _CRTDBG_DELAY_FREE_MEM_DF | \
291         _CRTDBG_LEAK_CHECK_DF | \
292         _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG));
293 
294 #if 0
295 /*
296  * _CrtSetBreakAlloc can be used to set a breakpoint at a particular
297  * memory leak, add to the macro above.
298  */
299 Detected memory leaks!
300 Dumping objects ->
301 ..\..\source\os_specific\service_layers\oswinxf.c(701) : {937} normal block at 0x002E9190, 40 bytes long.
302  Data: <                > 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
303 
304 _CrtSetBreakAlloc (937);
305 #endif
306 
307 #endif
308 
309 #if _MSC_VER > 1200 /* Versions above VC++ 6 */
310 #define COMPILER_VA_MACRO               1
311 #else
312 #endif
313 
314 /* Begin standard headers */
315 
316 /*
317  * warn C4001: nonstandard extension 'single line comment' was used
318  *
319  * We need to enable this for ACPICA internal files, but disable it for
320  * buggy MS runtime headers.
321  */
322 #pragma warning(push)
323 #pragma warning(disable:4001)
324 
325 #endif /* __ACMSVC_H__ */
326