[ACPICA]
[reactos.git] / reactos / drivers / bus / acpi / acpica / include / platform / acgcc.h
1 /******************************************************************************
2 *
3 * Name: acgcc.h - GCC 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 __ACGCC_H__
117 #define __ACGCC_H__
118
119 #define ACPI_INLINE __inline__
120
121 /* Function name is used for debug output. Non-ANSI, compiler-dependent */
122
123 #define ACPI_GET_FUNCTION_NAME __func__
124
125 /*
126 * This macro is used to tag functions as "printf-like" because
127 * some compilers (like GCC) can catch printf format string problems.
128 */
129 #define ACPI_PRINTF_LIKE(c) __attribute__ ((__format__ (__printf__, c, c+1)))
130
131 /*
132 * Some compilers complain about unused variables. Sometimes we don't want to
133 * use all the variables (for example, _AcpiModuleName). This allows us
134 * to tell the compiler warning in a per-variable manner that a variable
135 * is unused.
136 */
137 #define ACPI_UNUSED_VAR __attribute__ ((unused))
138
139 /*
140 * Some versions of gcc implement strchr() with a buggy macro. So,
141 * undef it here. Prevents error messages of this form (usually from the
142 * file getopt.c):
143 *
144 * error: logical '&&' with non-zero constant will always evaluate as true
145 */
146 #ifdef strchr
147 #undef strchr
148 #endif
149
150
151 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
152
153 #ifdef ACPI_APPLICATION
154 #define ACPI_FLUSH_CPU_CACHE()
155 #else
156 #define ACPI_FLUSH_CPU_CACHE() asm ("WBINVD")
157 #endif
158
159 /*
160 * Global Lock acquire/release code
161 *
162 * Note: Taken from our old adaptation.
163 * TODO: Check whether it is equivalent to the MSVC code
164 * (which was also the same in the older version).
165 */
166 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acq) \
167 do { \
168 int dummy; \
169 asm("1: movl (%1),%%eax;" \
170 "movl %%eax,%%edx;" \
171 "andl %2,%%edx;" \
172 "btsl $0x1,%%edx;" \
173 "adcl $0x0,%%edx;" \
174 "lock; cmpxchgl %%edx,(%1);" \
175 "jnz 1b;" \
176 "cmpb $0x3,%%dl;" \
177 "sbbl %%eax,%%eax" \
178 :"=a"(Acq),"=c"(dummy):"c"(GLptr),"i"(~1L):"dx"); \
179 } while(0)
180
181 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Acq) \
182 do { \
183 int dummy; \
184 asm("1: movl (%1),%%eax;" \
185 "movl %%eax,%%edx;" \
186 "andl %2,%%edx;" \
187 "lock; cmpxchgl %%edx,(%1);" \
188 "jnz 1b;" \
189 "andl $0x1,%%eax" \
190 :"=a"(Acq),"=c"(dummy):"c"(GLptr),"i"(~3L):"dx"); \
191 } while(0)
192
193
194 /*
195 * Note: This is also taken from our old adaptation.
196 * See acmsvc.h for where it came originally.
197 */
198 #define ACPI_DIV_64_BY_32(n_hi, n_lo, d32, q32, r32) \
199 { \
200 q32 = n_hi / d32; \
201 r32 = n_lo / d32; \
202 }
203
204 #define ACPI_SHIFT_RIGHT_64(n_hi, n_lo) \
205 { \
206 n_hi >>= 1; \
207 n_lo >>= 1; \
208 }
209
210
211 #endif /* __ACGCC_H__ */