xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acmacros.h (revision 35786f68)
1 /******************************************************************************
2  *
3  * Name: acmacros.h - C macros for the entire subsystem.
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 __ACMACROS_H__
153 #define __ACMACROS_H__
154 
155 
156 /*
157  * Extract data using a pointer. Any more than a byte and we
158  * get into potential alignment issues -- see the STORE macros below.
159  * Use with care.
160  */
161 #define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (UINT8, (ptr))
162 #define ACPI_CAST16(ptr)                ACPI_CAST_PTR (UINT16, (ptr))
163 #define ACPI_CAST32(ptr)                ACPI_CAST_PTR (UINT32, (ptr))
164 #define ACPI_CAST64(ptr)                ACPI_CAST_PTR (UINT64, (ptr))
165 #define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
166 #define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
167 #define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
168 #define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
169 #define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (UINT8) (val))
170 #define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (UINT16) (val))
171 #define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (UINT32) (val))
172 #define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (UINT64) (val))
173 
174 /*
175  * printf() format helper. This macro is a workaround for the difficulties
176  * with emitting 64-bit integers and 64-bit pointers with the same code
177  * for both 32-bit and 64-bit hosts.
178  */
179 #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
180 
181 
182 /*
183  * Macros for moving data around to/from buffers that are possibly unaligned.
184  * If the hardware supports the transfer of unaligned data, just do the store.
185  * Otherwise, we have to move one byte at a time.
186  */
187 #ifdef ACPI_BIG_ENDIAN
188 /*
189  * Macros for big-endian machines
190  */
191 
192 /* These macros reverse the bytes during the move, converting little-endian to big endian */
193 
194                                                      /* Big Endian      <==        Little Endian */
195                                                      /*  Hi...Lo                     Lo...Hi     */
196 /* 16-bit source, 16/32/64 destination */
197 
198 #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
199                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
200 
201 #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d))=0;\
202                                            ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
203                                            ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
204 
205 #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
206                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
207                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
208 
209 /* 32-bit source, 16/32/64 destination */
210 
211 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
212 
213 #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
214                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
215                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
216                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
217 
218 #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
219                                            ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
220                                            ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
221                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
222                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
223 
224 /* 64-bit source, 16/32/64 destination */
225 
226 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
227 
228 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
229 
230 #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
231                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
232                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
233                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
234                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
235                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
236                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
237                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
238 #else
239 /*
240  * Macros for little-endian machines
241  */
242 
243 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
244 
245 /* The hardware supports unaligned transfers, just do the little-endian move */
246 
247 /* 16-bit source, 16/32/64 destination */
248 
249 #define ACPI_MOVE_16_TO_16(d, s)        *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
250 #define ACPI_MOVE_16_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
251 #define ACPI_MOVE_16_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
252 
253 /* 32-bit source, 16/32/64 destination */
254 
255 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
256 #define ACPI_MOVE_32_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
257 #define ACPI_MOVE_32_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
258 
259 /* 64-bit source, 16/32/64 destination */
260 
261 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
262 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
263 #define ACPI_MOVE_64_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
264 
265 #else
266 /*
267  * The hardware does not support unaligned transfers. We must move the
268  * data one byte at a time. These macros work whether the source or
269  * the destination (or both) is/are unaligned. (Little-endian move)
270  */
271 
272 /* 16-bit source, 16/32/64 destination */
273 
274 #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
275                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
276 
277 #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
278 #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
279 
280 /* 32-bit source, 16/32/64 destination */
281 
282 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
283 
284 #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
285                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
286                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
287                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
288 
289 #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
290 
291 /* 64-bit source, 16/32/64 destination */
292 
293 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
294 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
295 #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
296                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
297                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
298                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
299                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
300                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
301                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
302                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
303 #endif
304 #endif
305 
306 
307 /*
308  * Fast power-of-two math macros for non-optimized compilers
309  */
310 #define _ACPI_DIV(value, PowerOf2)      ((UINT32) ((value) >> (PowerOf2)))
311 #define _ACPI_MUL(value, PowerOf2)      ((UINT32) ((value) << (PowerOf2)))
312 #define _ACPI_MOD(value, Divisor)       ((UINT32) ((value) & ((Divisor) -1)))
313 
314 #define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
315 #define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
316 #define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
317 
318 #define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
319 #define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
320 #define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
321 
322 #define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
323 #define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
324 #define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
325 
326 #define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
327 #define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
328 #define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
329 
330 #define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
331 #define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
332 #define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
333 
334 /* Test for ASCII character */
335 
336 #define ACPI_IS_ASCII(c)                ((c) < 0x80)
337 
338 /* Signed integers */
339 
340 #define ACPI_SIGN_POSITIVE              0
341 #define ACPI_SIGN_NEGATIVE              1
342 
343 
344 /*
345  * Rounding macros (Power of two boundaries only)
346  */
347 #define ACPI_ROUND_DOWN(value, boundary)    (((ACPI_SIZE)(value)) & \
348                                                 (~(((ACPI_SIZE) boundary)-1)))
349 
350 #define ACPI_ROUND_UP(value, boundary)      ((((ACPI_SIZE)(value)) + \
351                                                 (((ACPI_SIZE) boundary)-1)) & \
352                                                 (~(((ACPI_SIZE) boundary)-1)))
353 
354 /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
355 
356 #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
357 #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
358 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
359 
360 #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
361 #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
362 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
363 
364 #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
365 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
366 
367 #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
368 
369 /* Generic (non-power-of-two) rounding */
370 
371 #define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
372 
373 #define ACPI_IS_MISALIGNED(value)           (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
374 
375 /* Generic bit manipulation */
376 
377 #ifndef ACPI_USE_NATIVE_BIT_FINDER
378 
379 #define __ACPI_FIND_LAST_BIT_2(a, r)        ((((UINT8)  (a)) & 0x02) ? (r)+1 : (r))
380 #define __ACPI_FIND_LAST_BIT_4(a, r)        ((((UINT8)  (a)) & 0x0C) ? \
381                                              __ACPI_FIND_LAST_BIT_2  ((a)>>2,  (r)+2) : \
382                                              __ACPI_FIND_LAST_BIT_2  ((a), (r)))
383 #define __ACPI_FIND_LAST_BIT_8(a, r)        ((((UINT8)  (a)) & 0xF0) ? \
384                                              __ACPI_FIND_LAST_BIT_4  ((a)>>4,  (r)+4) : \
385                                              __ACPI_FIND_LAST_BIT_4  ((a), (r)))
386 #define __ACPI_FIND_LAST_BIT_16(a, r)       ((((UINT16) (a)) & 0xFF00) ? \
387                                              __ACPI_FIND_LAST_BIT_8  ((a)>>8,  (r)+8) : \
388                                              __ACPI_FIND_LAST_BIT_8  ((a), (r)))
389 #define __ACPI_FIND_LAST_BIT_32(a, r)       ((((UINT32) (a)) & 0xFFFF0000) ? \
390                                              __ACPI_FIND_LAST_BIT_16 ((a)>>16, (r)+16) : \
391                                              __ACPI_FIND_LAST_BIT_16 ((a), (r)))
392 #define __ACPI_FIND_LAST_BIT_64(a, r)       ((((UINT64) (a)) & 0xFFFFFFFF00000000) ? \
393                                              __ACPI_FIND_LAST_BIT_32 ((a)>>32, (r)+32) : \
394                                              __ACPI_FIND_LAST_BIT_32 ((a), (r)))
395 
396 #define ACPI_FIND_LAST_BIT_8(a)             ((a) ? __ACPI_FIND_LAST_BIT_8 (a, 1) : 0)
397 #define ACPI_FIND_LAST_BIT_16(a)            ((a) ? __ACPI_FIND_LAST_BIT_16 (a, 1) : 0)
398 #define ACPI_FIND_LAST_BIT_32(a)            ((a) ? __ACPI_FIND_LAST_BIT_32 (a, 1) : 0)
399 #define ACPI_FIND_LAST_BIT_64(a)            ((a) ? __ACPI_FIND_LAST_BIT_64 (a, 1) : 0)
400 
401 #define __ACPI_FIND_FIRST_BIT_2(a, r)       ((((UINT8) (a)) & 0x01) ? (r) : (r)+1)
402 #define __ACPI_FIND_FIRST_BIT_4(a, r)       ((((UINT8) (a)) & 0x03) ? \
403                                              __ACPI_FIND_FIRST_BIT_2  ((a), (r)) : \
404                                              __ACPI_FIND_FIRST_BIT_2  ((a)>>2, (r)+2))
405 #define __ACPI_FIND_FIRST_BIT_8(a, r)       ((((UINT8) (a)) & 0x0F) ? \
406                                              __ACPI_FIND_FIRST_BIT_4  ((a), (r)) : \
407                                              __ACPI_FIND_FIRST_BIT_4  ((a)>>4, (r)+4))
408 #define __ACPI_FIND_FIRST_BIT_16(a, r)      ((((UINT16) (a)) & 0x00FF) ? \
409                                              __ACPI_FIND_FIRST_BIT_8  ((a), (r)) : \
410                                              __ACPI_FIND_FIRST_BIT_8  ((a)>>8, (r)+8))
411 #define __ACPI_FIND_FIRST_BIT_32(a, r)      ((((UINT32) (a)) & 0x0000FFFF) ? \
412                                              __ACPI_FIND_FIRST_BIT_16 ((a), (r)) : \
413                                              __ACPI_FIND_FIRST_BIT_16 ((a)>>16, (r)+16))
414 #define __ACPI_FIND_FIRST_BIT_64(a, r)      ((((UINT64) (a)) & 0x00000000FFFFFFFF) ? \
415                                              __ACPI_FIND_FIRST_BIT_32 ((a), (r)) : \
416                                              __ACPI_FIND_FIRST_BIT_32 ((a)>>32, (r)+32))
417 
418 #define ACPI_FIND_FIRST_BIT_8(a)            ((a) ? __ACPI_FIND_FIRST_BIT_8 (a, 1) : 0)
419 #define ACPI_FIND_FIRST_BIT_16(a)           ((a) ? __ACPI_FIND_FIRST_BIT_16 (a, 1) : 0)
420 #define ACPI_FIND_FIRST_BIT_32(a)           ((a) ? __ACPI_FIND_FIRST_BIT_32 (a, 1) : 0)
421 #define ACPI_FIND_FIRST_BIT_64(a)           ((a) ? __ACPI_FIND_FIRST_BIT_64 (a, 1) : 0)
422 
423 #endif /* ACPI_USE_NATIVE_BIT_FINDER */
424 
425 /* Generic (power-of-two) rounding */
426 
427 #define ACPI_ROUND_UP_POWER_OF_TWO_8(a)     ((UINT8) \
428                                             (((UINT16) 1) <<  ACPI_FIND_LAST_BIT_8  ((a)  - 1)))
429 #define ACPI_ROUND_DOWN_POWER_OF_TWO_8(a)   ((UINT8) \
430                                             (((UINT16) 1) << (ACPI_FIND_LAST_BIT_8  ((a)) - 1)))
431 #define ACPI_ROUND_UP_POWER_OF_TWO_16(a)    ((UINT16) \
432                                             (((UINT32) 1) <<  ACPI_FIND_LAST_BIT_16 ((a)  - 1)))
433 #define ACPI_ROUND_DOWN_POWER_OF_TWO_16(a)  ((UINT16) \
434                                             (((UINT32) 1) << (ACPI_FIND_LAST_BIT_16 ((a)) - 1)))
435 #define ACPI_ROUND_UP_POWER_OF_TWO_32(a)    ((UINT32) \
436                                             (((UINT64) 1) <<  ACPI_FIND_LAST_BIT_32 ((a)  - 1)))
437 #define ACPI_ROUND_DOWN_POWER_OF_TWO_32(a)  ((UINT32) \
438                                             (((UINT64) 1) << (ACPI_FIND_LAST_BIT_32 ((a)) - 1)))
439 #define ACPI_IS_ALIGNED(a, s)               (((a) & ((s) - 1)) == 0)
440 #define ACPI_IS_POWER_OF_TWO(a)             ACPI_IS_ALIGNED(a, a)
441 
442 /*
443  * Bitmask creation
444  * Bit positions start at zero.
445  * MASK_BITS_ABOVE creates a mask starting AT the position and above
446  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
447  * MASK_BITS_ABOVE/BELOW accepts a bit offset to create a mask
448  * MASK_BITS_ABOVE/BELOW_32/64 accepts a bit width to create a mask
449  * Note: The ACPI_INTEGER_BIT_SIZE check is used to bypass compiler
450  * differences with the shift operator
451  */
452 #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
453 #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((UINT32) (position)))
454 #define ACPI_MASK_BITS_ABOVE_32(width)      ((UINT32) ACPI_MASK_BITS_ABOVE(width))
455 #define ACPI_MASK_BITS_BELOW_32(width)      ((UINT32) ACPI_MASK_BITS_BELOW(width))
456 #define ACPI_MASK_BITS_ABOVE_64(width)      ((width) == ACPI_INTEGER_BIT_SIZE ? \
457                                                 ACPI_UINT64_MAX : \
458                                                 ACPI_MASK_BITS_ABOVE(width))
459 #define ACPI_MASK_BITS_BELOW_64(width)      ((width) == ACPI_INTEGER_BIT_SIZE ? \
460                                                 (UINT64) 0 : \
461                                                 ACPI_MASK_BITS_BELOW(width))
462 
463 /* Bitfields within ACPI registers */
464 
465 #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \
466     ((Val << Pos) & Mask)
467 
468 #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \
469     Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask)
470 
471 #define ACPI_INSERT_BITS(Target, Mask, Source) \
472     Target = ((Target & (~(Mask))) | (Source & Mask))
473 
474 /* Generic bitfield macros and masks */
475 
476 #define ACPI_GET_BITS(SourcePtr, Position, Mask) \
477     ((*(SourcePtr) >> (Position)) & (Mask))
478 
479 #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \
480     (*(TargetPtr) |= (((Value) & (Mask)) << (Position)))
481 
482 #define ACPI_1BIT_MASK      0x00000001
483 #define ACPI_2BIT_MASK      0x00000003
484 #define ACPI_3BIT_MASK      0x00000007
485 #define ACPI_4BIT_MASK      0x0000000F
486 #define ACPI_5BIT_MASK      0x0000001F
487 #define ACPI_6BIT_MASK      0x0000003F
488 #define ACPI_7BIT_MASK      0x0000007F
489 #define ACPI_8BIT_MASK      0x000000FF
490 #define ACPI_16BIT_MASK     0x0000FFFF
491 #define ACPI_24BIT_MASK     0x00FFFFFF
492 
493 /* Macros to extract flag bits from position zero */
494 
495 #define ACPI_GET_1BIT_FLAG(Value)                   ((Value) & ACPI_1BIT_MASK)
496 #define ACPI_GET_2BIT_FLAG(Value)                   ((Value) & ACPI_2BIT_MASK)
497 #define ACPI_GET_3BIT_FLAG(Value)                   ((Value) & ACPI_3BIT_MASK)
498 #define ACPI_GET_4BIT_FLAG(Value)                   ((Value) & ACPI_4BIT_MASK)
499 
500 /* Macros to extract flag bits from position one and above */
501 
502 #define ACPI_EXTRACT_1BIT_FLAG(Field, Position)     (ACPI_GET_1BIT_FLAG ((Field) >> Position))
503 #define ACPI_EXTRACT_2BIT_FLAG(Field, Position)     (ACPI_GET_2BIT_FLAG ((Field) >> Position))
504 #define ACPI_EXTRACT_3BIT_FLAG(Field, Position)     (ACPI_GET_3BIT_FLAG ((Field) >> Position))
505 #define ACPI_EXTRACT_4BIT_FLAG(Field, Position)     (ACPI_GET_4BIT_FLAG ((Field) >> Position))
506 
507 /* ACPI Pathname helpers */
508 
509 #define ACPI_IS_ROOT_PREFIX(c)      ((c) == (UINT8) 0x5C) /* Backslash */
510 #define ACPI_IS_PARENT_PREFIX(c)    ((c) == (UINT8) 0x5E) /* Carat */
511 #define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (UINT8) 0x2E) /* Period (dot) */
512 
513 /*
514  * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
515  * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
516  * appear. This macro is used to distinguish them.
517  *
518  * The "DescriptorType" field is the second field in both structures.
519  */
520 #define ACPI_GET_DESCRIPTOR_PTR(d)      (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer)
521 #define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p))
522 #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
523 #define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t))
524 
525 /*
526  * Macros for the master AML opcode table
527  */
528 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
529 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
530     {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
531 #else
532 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
533     {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
534 #endif
535 
536 #define ARG_TYPE_WIDTH                  5
537 #define ARG_1(x)                        ((UINT32)(x))
538 #define ARG_2(x)                        ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
539 #define ARG_3(x)                        ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
540 #define ARG_4(x)                        ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
541 #define ARG_5(x)                        ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
542 #define ARG_6(x)                        ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
543 
544 #define ARGI_LIST1(a)                   (ARG_1(a))
545 #define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
546 #define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
547 #define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
548 #define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
549 #define ARGI_LIST6(a, b, c, d, e, f)    (ARG_1(f)|ARG_2(e)|ARG_3(d)|ARG_4(c)|ARG_5(b)|ARG_6(a))
550 
551 #define ARGP_LIST1(a)                   (ARG_1(a))
552 #define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
553 #define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
554 #define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
555 #define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
556 #define ARGP_LIST6(a, b, c, d, e, f)    (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)|ARG_6(f))
557 
558 #define GET_CURRENT_ARG_TYPE(List)      (List & ((UINT32) 0x1F))
559 #define INCREMENT_ARG_LIST(List)        (List >>= ((UINT32) ARG_TYPE_WIDTH))
560 
561 /*
562  * Ascii error messages can be configured out
563  */
564 #ifndef ACPI_NO_ERROR_MESSAGES
565 /*
566  * Error reporting. The callers module and line number are inserted by AE_INFO,
567  * the plist contains a set of parens to allow variable-length lists.
568  * These macros are used for both the debug and non-debug versions of the code.
569  */
570 #define ACPI_ERROR_NAMESPACE(s, p, e)       AcpiUtPrefixedNamespaceError (AE_INFO, s, p, e);
571 #define ACPI_ERROR_METHOD(s, n, p, e)       AcpiUtMethodError (AE_INFO, s, n, p, e);
572 #define ACPI_WARN_PREDEFINED(plist)         AcpiUtPredefinedWarning plist
573 #define ACPI_INFO_PREDEFINED(plist)         AcpiUtPredefinedInfo plist
574 #define ACPI_BIOS_ERROR_PREDEFINED(plist)   AcpiUtPredefinedBiosError plist
575 #define ACPI_ERROR_ONLY(s)                  s
576 
577 #else
578 
579 /* No error messages */
580 
581 #define ACPI_ERROR_NAMESPACE(s, p, e)
582 #define ACPI_ERROR_METHOD(s, n, p, e)
583 #define ACPI_WARN_PREDEFINED(plist)
584 #define ACPI_INFO_PREDEFINED(plist)
585 #define ACPI_BIOS_ERROR_PREDEFINED(plist)
586 #define ACPI_ERROR_ONLY(s)
587 
588 #endif /* ACPI_NO_ERROR_MESSAGES */
589 
590 #if (!ACPI_REDUCED_HARDWARE)
591 #define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
592 #else
593 #define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
594 #endif
595 
596 
597 /*
598  * Macros used for ACPICA utilities only
599  */
600 
601 /* Generate a UUID */
602 
603 #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
604     (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
605     (b) & 0xFF, ((b) >> 8) & 0xFF, \
606     (c) & 0xFF, ((c) >> 8) & 0xFF, \
607     (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
608 
609 #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
610 
611 
612 /*
613  * Macors used for the ASL-/ASL+ converter utility
614  */
615 #ifdef ACPI_ASL_COMPILER
616 
617 #define ASL_CV_LABEL_FILENODE(a)         CvLabelFileNode(a);
618 #define ASL_CV_CAPTURE_COMMENTS_ONLY(a)   CvCaptureCommentsOnly (a);
619 #define ASL_CV_CAPTURE_COMMENTS(a)       CvCaptureComments (a);
620 #define ASL_CV_TRANSFER_COMMENTS(a)      CvTransferComments (a);
621 #define ASL_CV_CLOSE_PAREN(a,b)          CvCloseParenWriteComment(a,b);
622 #define ASL_CV_CLOSE_BRACE(a,b)          CvCloseBraceWriteComment(a,b);
623 #define ASL_CV_SWITCH_FILES(a,b)         CvSwitchFiles(a,b);
624 #define ASL_CV_CLEAR_OP_COMMENTS(a)       CvClearOpComments(a);
625 #define ASL_CV_PRINT_ONE_COMMENT(a,b,c,d) CvPrintOneCommentType (a,b,c,d);
626 #define ASL_CV_PRINT_ONE_COMMENT_LIST(a,b) CvPrintOneCommentList (a,b);
627 #define ASL_CV_FILE_HAS_SWITCHED(a)       CvFileHasSwitched(a)
628 #define ASL_CV_INIT_FILETREE(a,b,c)      CvInitFileTree(a,b,c);
629 
630 #else
631 
632 #define ASL_CV_LABEL_FILENODE(a)
633 #define ASL_CV_CAPTURE_COMMENTS_ONLY(a)
634 #define ASL_CV_CAPTURE_COMMENTS(a)
635 #define ASL_CV_TRANSFER_COMMENTS(a)
636 #define ASL_CV_CLOSE_PAREN(a,b)          AcpiOsPrintf (")");
637 #define ASL_CV_CLOSE_BRACE(a,b)          AcpiOsPrintf ("}");
638 #define ASL_CV_SWITCH_FILES(a,b)
639 #define ASL_CV_CLEAR_OP_COMMENTS(a)
640 #define ASL_CV_PRINT_ONE_COMMENT(a,b,c,d)
641 #define ASL_CV_PRINT_ONE_COMMENT_LIST(a,b)
642 #define ASL_CV_FILE_HAS_SWITCHED(a)       0
643 #define ASL_CV_INIT_FILETREE(a,b,c)
644 
645 #endif
646 
647 #endif /* ACMACROS_H */
648