xref: /freebsd/sys/contrib/dev/acpica/include/acmacros.h (revision 9268022b74279434ed6300244e3f977e56a8ceb5)
1 /******************************************************************************
2  *
3  * Name: acmacros.h - C macros for the entire subsystem.
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ACMACROS_H__
45 #define __ACMACROS_H__
46 
47 
48 /*
49  * Extract data using a pointer. Any more than a byte and we
50  * get into potential aligment issues -- see the STORE macros below.
51  * Use with care.
52  */
53 #define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (UINT8, (ptr))
54 #define ACPI_CAST16(ptr)                ACPI_CAST_PTR (UINT16, (ptr))
55 #define ACPI_CAST32(ptr)                ACPI_CAST_PTR (UINT32, (ptr))
56 #define ACPI_CAST64(ptr)                ACPI_CAST_PTR (UINT64, (ptr))
57 #define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
58 #define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
59 #define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
60 #define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
61 #define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (UINT8) (val))
62 #define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (UINT16) (val))
63 #define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (UINT32) (val))
64 #define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (UINT64) (val))
65 
66 /*
67  * printf() format helpers. These macros are workarounds for the difficulties
68  * with emitting 64-bit integers and 64-bit pointers with the same code
69  * for both 32-bit and 64-bit hosts.
70  */
71 #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
72 
73 #if ACPI_MACHINE_WIDTH == 64
74 #define ACPI_FORMAT_NATIVE_UINT(i)      ACPI_FORMAT_UINT64(i)
75 #define ACPI_FORMAT_TO_UINT(i)          ACPI_FORMAT_UINT64(i)
76 #define ACPI_PRINTF_UINT                 "0x%8.8X%8.8X"
77 
78 #else
79 #define ACPI_FORMAT_NATIVE_UINT(i)      0, (UINT32) (i)
80 #define ACPI_FORMAT_TO_UINT(i)          (UINT32) (i)
81 #define ACPI_PRINTF_UINT                 "0x%8.8X"
82 #endif
83 
84 
85 /*
86  * Macros for moving data around to/from buffers that are possibly unaligned.
87  * If the hardware supports the transfer of unaligned data, just do the store.
88  * Otherwise, we have to move one byte at a time.
89  */
90 #ifdef ACPI_BIG_ENDIAN
91 /*
92  * Macros for big-endian machines
93  */
94 
95 /* These macros reverse the bytes during the move, converting little-endian to big endian */
96 
97                                                      /* Big Endian      <==        Little Endian */
98                                                      /*  Hi...Lo                     Lo...Hi     */
99 /* 16-bit source, 16/32/64 destination */
100 
101 #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
102                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
103 
104 #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d))=0;\
105                                            ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
106                                            ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
107 
108 #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
109                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
110                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
111 
112 /* 32-bit source, 16/32/64 destination */
113 
114 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
115 
116 #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
117                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
118                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
119                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
120 
121 #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
122                                            ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
123                                            ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
124                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
125                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
126 
127 /* 64-bit source, 16/32/64 destination */
128 
129 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
130 
131 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
132 
133 #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
134                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
135                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
136                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
137                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
138                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
139                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
140                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
141 #else
142 /*
143  * Macros for little-endian machines
144  */
145 
146 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
147 
148 /* The hardware supports unaligned transfers, just do the little-endian move */
149 
150 /* 16-bit source, 16/32/64 destination */
151 
152 #define ACPI_MOVE_16_TO_16(d, s)        *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
153 #define ACPI_MOVE_16_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
154 #define ACPI_MOVE_16_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
155 
156 /* 32-bit source, 16/32/64 destination */
157 
158 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
159 #define ACPI_MOVE_32_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
160 #define ACPI_MOVE_32_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
161 
162 /* 64-bit source, 16/32/64 destination */
163 
164 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
165 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
166 #define ACPI_MOVE_64_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
167 
168 #else
169 /*
170  * The hardware does not support unaligned transfers. We must move the
171  * data one byte at a time. These macros work whether the source or
172  * the destination (or both) is/are unaligned. (Little-endian move)
173  */
174 
175 /* 16-bit source, 16/32/64 destination */
176 
177 #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
178                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
179 
180 #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
181 #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
182 
183 /* 32-bit source, 16/32/64 destination */
184 
185 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
186 
187 #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
188                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
189                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
190                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
191 
192 #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
193 
194 /* 64-bit source, 16/32/64 destination */
195 
196 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
197 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
198 #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
199                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
200                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
201                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
202                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
203                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
204                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
205                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
206 #endif
207 #endif
208 
209 
210 /*
211  * Fast power-of-two math macros for non-optimized compilers
212  */
213 #define _ACPI_DIV(value, PowerOf2)      ((UINT32) ((value) >> (PowerOf2)))
214 #define _ACPI_MUL(value, PowerOf2)      ((UINT32) ((value) << (PowerOf2)))
215 #define _ACPI_MOD(value, Divisor)       ((UINT32) ((value) & ((Divisor) -1)))
216 
217 #define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
218 #define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
219 #define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
220 
221 #define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
222 #define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
223 #define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
224 
225 #define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
226 #define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
227 #define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
228 
229 #define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
230 #define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
231 #define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
232 
233 #define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
234 #define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
235 #define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
236 
237 /*
238  * Rounding macros (Power of two boundaries only)
239  */
240 #define ACPI_ROUND_DOWN(value, boundary)    (((ACPI_SIZE)(value)) & \
241                                                 (~(((ACPI_SIZE) boundary)-1)))
242 
243 #define ACPI_ROUND_UP(value, boundary)      ((((ACPI_SIZE)(value)) + \
244                                                 (((ACPI_SIZE) boundary)-1)) & \
245                                                 (~(((ACPI_SIZE) boundary)-1)))
246 
247 /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
248 
249 #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
250 #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
251 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
252 
253 #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
254 #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
255 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
256 
257 #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
258 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
259 
260 #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
261 
262 /* Generic (non-power-of-two) rounding */
263 
264 #define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
265 
266 #define ACPI_IS_MISALIGNED(value)           (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
267 
268 /*
269  * Bitmask creation
270  * Bit positions start at zero.
271  * MASK_BITS_ABOVE creates a mask starting AT the position and above
272  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
273  */
274 #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
275 #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((UINT32) (position)))
276 
277 /* Bitfields within ACPI registers */
278 
279 #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \
280     ((Val << Pos) & Mask)
281 
282 #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \
283     Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask)
284 
285 #define ACPI_INSERT_BITS(Target, Mask, Source) \
286     Target = ((Target & (~(Mask))) | (Source & Mask))
287 
288 /* Generic bitfield macros and masks */
289 
290 #define ACPI_GET_BITS(SourcePtr, Position, Mask) \
291     ((*SourcePtr >> Position) & Mask)
292 
293 #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \
294     (*TargetPtr |= ((Value & Mask) << Position))
295 
296 #define ACPI_1BIT_MASK      0x00000001
297 #define ACPI_2BIT_MASK      0x00000003
298 #define ACPI_3BIT_MASK      0x00000007
299 #define ACPI_4BIT_MASK      0x0000000F
300 #define ACPI_5BIT_MASK      0x0000001F
301 #define ACPI_6BIT_MASK      0x0000003F
302 #define ACPI_7BIT_MASK      0x0000007F
303 #define ACPI_8BIT_MASK      0x000000FF
304 #define ACPI_16BIT_MASK     0x0000FFFF
305 #define ACPI_24BIT_MASK     0x00FFFFFF
306 
307 /* Macros to extract flag bits from position zero */
308 
309 #define ACPI_GET_1BIT_FLAG(Value)                   ((Value) & ACPI_1BIT_MASK)
310 #define ACPI_GET_2BIT_FLAG(Value)                   ((Value) & ACPI_2BIT_MASK)
311 #define ACPI_GET_3BIT_FLAG(Value)                   ((Value) & ACPI_3BIT_MASK)
312 #define ACPI_GET_4BIT_FLAG(Value)                   ((Value) & ACPI_4BIT_MASK)
313 
314 /* Macros to extract flag bits from position one and above */
315 
316 #define ACPI_EXTRACT_1BIT_FLAG(Field, Position)     (ACPI_GET_1BIT_FLAG ((Field) >> Position))
317 #define ACPI_EXTRACT_2BIT_FLAG(Field, Position)     (ACPI_GET_2BIT_FLAG ((Field) >> Position))
318 #define ACPI_EXTRACT_3BIT_FLAG(Field, Position)     (ACPI_GET_3BIT_FLAG ((Field) >> Position))
319 #define ACPI_EXTRACT_4BIT_FLAG(Field, Position)     (ACPI_GET_4BIT_FLAG ((Field) >> Position))
320 
321 /* ACPI Pathname helpers */
322 
323 #define ACPI_IS_ROOT_PREFIX(c)      ((c) == (UINT8) 0x5C) /* Backslash */
324 #define ACPI_IS_PARENT_PREFIX(c)    ((c) == (UINT8) 0x5E) /* Carat */
325 #define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (UINT8) 0x2E) /* Period (dot) */
326 
327 /*
328  * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
329  * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
330  * appear. This macro is used to distinguish them.
331  *
332  * The "DescriptorType" field is the second field in both structures.
333  */
334 #define ACPI_GET_DESCRIPTOR_PTR(d)      (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer)
335 #define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p))
336 #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
337 #define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t))
338 
339 /*
340  * Macros for the master AML opcode table
341  */
342 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
343 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
344     {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
345 #else
346 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
347     {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
348 #endif
349 
350 #define ARG_TYPE_WIDTH                  5
351 #define ARG_1(x)                        ((UINT32)(x))
352 #define ARG_2(x)                        ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
353 #define ARG_3(x)                        ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
354 #define ARG_4(x)                        ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
355 #define ARG_5(x)                        ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
356 #define ARG_6(x)                        ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
357 
358 #define ARGI_LIST1(a)                   (ARG_1(a))
359 #define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
360 #define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
361 #define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
362 #define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
363 #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))
364 
365 #define ARGP_LIST1(a)                   (ARG_1(a))
366 #define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
367 #define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
368 #define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
369 #define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
370 #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))
371 
372 #define GET_CURRENT_ARG_TYPE(List)      (List & ((UINT32) 0x1F))
373 #define INCREMENT_ARG_LIST(List)        (List >>= ((UINT32) ARG_TYPE_WIDTH))
374 
375 /*
376  * Ascii error messages can be configured out
377  */
378 #ifndef ACPI_NO_ERROR_MESSAGES
379 /*
380  * Error reporting. Callers module and line number are inserted by AE_INFO,
381  * the plist contains a set of parens to allow variable-length lists.
382  * These macros are used for both the debug and non-debug versions of the code.
383  */
384 #define ACPI_ERROR_NAMESPACE(s, e)          AcpiUtNamespaceError (AE_INFO, s, e);
385 #define ACPI_ERROR_METHOD(s, n, p, e)       AcpiUtMethodError (AE_INFO, s, n, p, e);
386 #define ACPI_WARN_PREDEFINED(plist)         AcpiUtPredefinedWarning plist
387 #define ACPI_INFO_PREDEFINED(plist)         AcpiUtPredefinedInfo plist
388 #define ACPI_BIOS_ERROR_PREDEFINED(plist)   AcpiUtPredefinedBiosError plist
389 
390 #else
391 
392 /* No error messages */
393 
394 #define ACPI_ERROR_NAMESPACE(s, e)
395 #define ACPI_ERROR_METHOD(s, n, p, e)
396 #define ACPI_WARN_PREDEFINED(plist)
397 #define ACPI_INFO_PREDEFINED(plist)
398 #define ACPI_BIOS_ERROR_PREDEFINED(plist)
399 
400 #endif /* ACPI_NO_ERROR_MESSAGES */
401 
402 #if (!ACPI_REDUCED_HARDWARE)
403 #define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
404 #else
405 #define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
406 #endif
407 
408 
409 /*
410  * Some code only gets executed when the debugger is built in.
411  * Note that this is entirely independent of whether the
412  * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
413  */
414 #ifdef ACPI_DEBUGGER
415 #define ACPI_DEBUGGER_EXEC(a)           a
416 #else
417 #define ACPI_DEBUGGER_EXEC(a)
418 #endif
419 
420 
421 /*
422  * Macros used for ACPICA utilities only
423  */
424 
425 /* Generate a UUID */
426 
427 #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
428     (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
429     (b) & 0xFF, ((b) >> 8) & 0xFF, \
430     (c) & 0xFF, ((c) >> 8) & 0xFF, \
431     (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
432 
433 #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
434 
435 
436 #endif /* ACMACROS_H */
437