ACPICA: Add ACPI_MAX macro
[sfrench/cifs-2.6.git] / include / acpi / acmacros.h
1 /******************************************************************************
2  *
3  * Name: acmacros.h - C macros for the entire subsystem.
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, R. Byron Moore
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  * Data manipulation macros
49  */
50 #define ACPI_LOWORD(l)                  ((u16)(u32)(l))
51 #define ACPI_HIWORD(l)                  ((u16)((((u32)(l)) >> 16) & 0xFFFF))
52 #define ACPI_LOBYTE(l)                  ((u8)(u16)(l))
53 #define ACPI_HIBYTE(l)                  ((u8)((((u16)(l)) >> 8) & 0xFF))
54
55 #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
56 #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
57 #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
58 #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
59
60 /* Size calculation */
61
62 #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
63
64 #if ACPI_MACHINE_WIDTH == 16
65
66 /*
67  * For 16-bit addresses, we have to assume that the upper 32 bits
68  * (out of 64) are zero.
69  */
70 #define ACPI_LODWORD(l)                 ((u32)(l))
71 #define ACPI_HIDWORD(l)                 ((u32)(0))
72
73 #define ACPI_GET_ADDRESS(a)             ((a).lo)
74 #define ACPI_STORE_ADDRESS(a,b)         {(a).hi=0;(a).lo=(u32)(b);}
75 #define ACPI_VALID_ADDRESS(a)           ((a).hi | (a).lo)
76
77 #else
78 #ifdef ACPI_NO_INTEGER64_SUPPORT
79 /*
80  * acpi_integer is 32-bits, no 64-bit support on this platform
81  */
82 #define ACPI_LODWORD(l)                 ((u32)(l))
83 #define ACPI_HIDWORD(l)                 ((u32)(0))
84
85 #define ACPI_GET_ADDRESS(a)             (a)
86 #define ACPI_STORE_ADDRESS(a,b)         ((a)=(b))
87 #define ACPI_VALID_ADDRESS(a)           (a)
88
89 #else
90
91 /*
92  * Full 64-bit address/integer on both 32-bit and 64-bit platforms
93  */
94 #define ACPI_LODWORD(l)                 ((u32)(u64)(l))
95 #define ACPI_HIDWORD(l)                 ((u32)(((*(struct uint64_struct *)(void *)(&l))).hi))
96
97 #define ACPI_GET_ADDRESS(a)             (a)
98 #define ACPI_STORE_ADDRESS(a,b)         ((a)=(acpi_physical_address)(b))
99 #define ACPI_VALID_ADDRESS(a)           (a)
100 #endif
101 #endif
102
103 /*
104  * printf() format helpers
105  */
106
107 /* Split 64-bit integer into two 32-bit values. Use with %8.8_x%8.8_x */
108
109 #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i),ACPI_LODWORD(i)
110
111 /*
112  * Extract data using a pointer.  Any more than a byte and we
113  * get into potential aligment issues -- see the STORE macros below.
114  * Use with care.
115  */
116 #define ACPI_GET8(ptr)                  *ACPI_CAST_PTR (u8, ptr)
117 #define ACPI_GET16(ptr)                 *ACPI_CAST_PTR (u16, ptr)
118 #define ACPI_GET32(ptr)                 *ACPI_CAST_PTR (u32, ptr)
119 #define ACPI_GET64(ptr)                 *ACPI_CAST_PTR (u64, ptr)
120 #define ACPI_SET8(ptr)                  *ACPI_CAST_PTR (u8, ptr)
121 #define ACPI_SET16(ptr)                 *ACPI_CAST_PTR (u16, ptr)
122 #define ACPI_SET32(ptr)                 *ACPI_CAST_PTR (u32, ptr)
123 #define ACPI_SET64(ptr)                 *ACPI_CAST_PTR (u64, ptr)
124
125 /*
126  * Pointer manipulation
127  */
128 #define ACPI_CAST_PTR(t, p)             ((t *) (acpi_uintptr_t) (p))
129 #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (acpi_uintptr_t) (p))
130 #define ACPI_ADD_PTR(t,a,b)             ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8,(a)) + (acpi_native_uint)(b)))
131 #define ACPI_PTR_DIFF(a,b)              (acpi_native_uint) (ACPI_CAST_PTR (u8,(a)) - ACPI_CAST_PTR (u8,(b)))
132
133 /* Pointer/Integer type conversions */
134
135 #define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void,(void *) NULL,(acpi_native_uint) i)
136 #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p,(void *) NULL)
137 #define ACPI_OFFSET(d,f)                (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f),(void *) NULL)
138
139 #if ACPI_MACHINE_WIDTH == 16
140 #define ACPI_STORE_POINTER(d,s)         ACPI_MOVE_32_TO_32(d,s)
141 #define ACPI_PHYSADDR_TO_PTR(i)         (void *)(i)
142 #define ACPI_PTR_TO_PHYSADDR(i)         (u32) ACPI_CAST_PTR (u8,(i))
143 #else
144 #define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
145 #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
146 #endif
147
148 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
149 #define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (u32,(a)) == *ACPI_CAST_PTR (u32,(b)))
150 #else
151 #define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char,(a)), ACPI_CAST_PTR (char,(b)), ACPI_NAME_SIZE))
152 #endif
153
154 /*
155  * Macros for moving data around to/from buffers that are possibly unaligned.
156  * If the hardware supports the transfer of unaligned data, just do the store.
157  * Otherwise, we have to move one byte at a time.
158  */
159 #ifdef ACPI_BIG_ENDIAN
160 /*
161  * Macros for big-endian machines
162  */
163
164 /* This macro sets a buffer index, starting from the end of the buffer */
165
166 #define ACPI_BUFFER_INDEX(buf_len,buf_offset,byte_gran) ((buf_len) - (((buf_offset)+1) * (byte_gran)))
167
168 /* These macros reverse the bytes during the move, converting little-endian to big endian */
169
170          /* Big Endian      <==        Little Endian */
171          /*  Hi...Lo                     Lo...Hi     */
172 /* 16-bit source, 16/32/64 destination */
173
174 #define ACPI_MOVE_16_TO_16(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
175                           ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
176
177 #define ACPI_MOVE_16_TO_32(d,s)         {(*(u32 *)(void *)(d))=0;\
178                                           ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
179                                           ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
180
181 #define ACPI_MOVE_16_TO_64(d,s)         {(*(u64 *)(void *)(d))=0;\
182                                                            ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
183                                                            ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
184
185 /* 32-bit source, 16/32/64 destination */
186
187 #define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
188
189 #define ACPI_MOVE_32_TO_32(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
190                                                                           ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
191                                                                           ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
192                                                                           ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
193
194 #define ACPI_MOVE_32_TO_64(d,s)         {(*(u64 *)(void *)(d))=0;\
195                                                                                    ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
196                                                                                    ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
197                                                                                    ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
198                                                                                    ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
199
200 /* 64-bit source, 16/32/64 destination */
201
202 #define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
203
204 #define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */
205
206 #define ACPI_MOVE_64_TO_64(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
207                                                                                  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
208                                                                                  ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
209                                                                                  ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
210                                                                                  ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
211                                                                                  ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
212                                                                                  ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
213                                                                                  ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
214 #else
215 /*
216  * Macros for little-endian machines
217  */
218
219 /* This macro sets a buffer index, starting from the beginning of the buffer */
220
221 #define ACPI_BUFFER_INDEX(buf_len,buf_offset,byte_gran) (buf_offset)
222
223 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
224
225 /* The hardware supports unaligned transfers, just do the little-endian move */
226
227 #if ACPI_MACHINE_WIDTH == 16
228
229 /* No 64-bit integers */
230 /* 16-bit source, 16/32/64 destination */
231
232 #define ACPI_MOVE_16_TO_16(d,s)         *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
233 #define ACPI_MOVE_16_TO_32(d,s)         *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
234 #define ACPI_MOVE_16_TO_64(d,s)         ACPI_MOVE_16_TO_32(d,s)
235
236 /* 32-bit source, 16/32/64 destination */
237
238 #define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
239 #define ACPI_MOVE_32_TO_32(d,s)         *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
240 #define ACPI_MOVE_32_TO_64(d,s)         ACPI_MOVE_32_TO_32(d,s)
241
242 /* 64-bit source, 16/32/64 destination */
243
244 #define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
245 #define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */
246 #define ACPI_MOVE_64_TO_64(d,s)         ACPI_MOVE_32_TO_32(d,s)
247
248 #else
249 /* 16-bit source, 16/32/64 destination */
250
251 #define ACPI_MOVE_16_TO_16(d,s)         *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
252 #define ACPI_MOVE_16_TO_32(d,s)         *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
253 #define ACPI_MOVE_16_TO_64(d,s)         *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
254
255 /* 32-bit source, 16/32/64 destination */
256
257 #define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
258 #define ACPI_MOVE_32_TO_32(d,s)         *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
259 #define ACPI_MOVE_32_TO_64(d,s)         *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
260
261 /* 64-bit source, 16/32/64 destination */
262
263 #define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
264 #define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */
265 #define ACPI_MOVE_64_TO_64(d,s)         *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
266 #endif
267
268 #else
269 /*
270  * The hardware does not support unaligned transfers.  We must move the
271  * data one byte at a time.  These macros work whether the source or
272  * the destination (or both) is/are unaligned.  (Little-endian move)
273  */
274
275 /* 16-bit source, 16/32/64 destination */
276
277 #define ACPI_MOVE_16_TO_16(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
278                                                                                  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
279
280 #define ACPI_MOVE_16_TO_32(d,s)         {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);}
281 #define ACPI_MOVE_16_TO_64(d,s)         {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);}
282
283 /* 32-bit source, 16/32/64 destination */
284
285 #define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
286
287 #define ACPI_MOVE_32_TO_32(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
288                                                                                  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
289                                                                                  ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
290                                                                                  ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
291
292 #define ACPI_MOVE_32_TO_64(d,s)         {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d,s);}
293
294 /* 64-bit source, 16/32/64 destination */
295
296 #define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */
297 #define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */
298 #define ACPI_MOVE_64_TO_64(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
299                                                                                  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
300                                                                                  ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
301                                                                                  ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
302                                                                                  ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
303                                                                                  ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
304                                                                                  ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
305                                                                                  ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
306 #endif
307 #endif
308
309 /* Macros based on machine integer width */
310
311 #if ACPI_MACHINE_WIDTH == 16
312 #define ACPI_MOVE_SIZE_TO_16(d,s)       ACPI_MOVE_16_TO_16(d,s)
313
314 #elif ACPI_MACHINE_WIDTH == 32
315 #define ACPI_MOVE_SIZE_TO_16(d,s)       ACPI_MOVE_32_TO_16(d,s)
316
317 #elif ACPI_MACHINE_WIDTH == 64
318 #define ACPI_MOVE_SIZE_TO_16(d,s)       ACPI_MOVE_64_TO_16(d,s)
319
320 #else
321 #error unknown ACPI_MACHINE_WIDTH
322 #endif
323
324 /*
325  * Fast power-of-two math macros for non-optimized compilers
326  */
327 #define _ACPI_DIV(value,power_of2)      ((u32) ((value) >> (power_of2)))
328 #define _ACPI_MUL(value,power_of2)      ((u32) ((value) << (power_of2)))
329 #define _ACPI_MOD(value,divisor)        ((u32) ((value) & ((divisor) -1)))
330
331 #define ACPI_DIV_2(a)                   _ACPI_DIV(a,1)
332 #define ACPI_MUL_2(a)                   _ACPI_MUL(a,1)
333 #define ACPI_MOD_2(a)                   _ACPI_MOD(a,2)
334
335 #define ACPI_DIV_4(a)                   _ACPI_DIV(a,2)
336 #define ACPI_MUL_4(a)                   _ACPI_MUL(a,2)
337 #define ACPI_MOD_4(a)                   _ACPI_MOD(a,4)
338
339 #define ACPI_DIV_8(a)                   _ACPI_DIV(a,3)
340 #define ACPI_MUL_8(a)                   _ACPI_MUL(a,3)
341 #define ACPI_MOD_8(a)                   _ACPI_MOD(a,8)
342
343 #define ACPI_DIV_16(a)                  _ACPI_DIV(a,4)
344 #define ACPI_MUL_16(a)                  _ACPI_MUL(a,4)
345 #define ACPI_MOD_16(a)                  _ACPI_MOD(a,16)
346
347 #define ACPI_DIV_32(a)                  _ACPI_DIV(a,5)
348 #define ACPI_MUL_32(a)                  _ACPI_MUL(a,5)
349 #define ACPI_MOD_32(a)                  _ACPI_MOD(a,32)
350
351 /*
352  * Rounding macros (Power of two boundaries only)
353  */
354 #define ACPI_ROUND_DOWN(value,boundary)     (((acpi_native_uint)(value)) & \
355                                                                                                 (~(((acpi_native_uint) boundary)-1)))
356
357 #define ACPI_ROUND_UP(value,boundary)       ((((acpi_native_uint)(value)) + \
358                                                                                                 (((acpi_native_uint) boundary)-1)) & \
359                                                                                                 (~(((acpi_native_uint) boundary)-1)))
360
361 /* Note: sizeof(acpi_native_uint) evaluates to either 2, 4, or 8 */
362
363 #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a,4)
364 #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a,8)
365 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a,sizeof(acpi_native_uint))
366
367 #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a,4)
368 #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a,8)
369 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a,sizeof(acpi_native_uint))
370
371 #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
372 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
373
374 #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
375
376 /* Generic (non-power-of-two) rounding */
377
378 #define ACPI_ROUND_UP_TO(value,boundary)    (((value) + ((boundary)-1)) / (boundary))
379
380 #define ACPI_IS_MISALIGNED(value)           (((acpi_native_uint)value) & (sizeof(acpi_native_uint)-1))
381
382 /*
383  * Bitmask creation
384  * Bit positions start at zero.
385  * MASK_BITS_ABOVE creates a mask starting AT the position and above
386  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
387  */
388 #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_INTEGER_MAX) << ((u32) (position))))
389 #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_INTEGER_MAX) << ((u32) (position)))
390
391 #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
392
393 /* Bitfields within ACPI registers */
394
395 #define ACPI_REGISTER_PREPARE_BITS(val, pos, mask)      ((val << pos) & mask)
396 #define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val)  reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
397
398 #define ACPI_INSERT_BITS(target, mask, source)          target = ((target & (~(mask))) | (source & mask))
399
400 /* Generate a UUID */
401
402 #define ACPI_INIT_UUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
403         (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
404         (b) & 0xFF, ((b) >> 8) & 0xFF, \
405         (c) & 0xFF, ((c) >> 8) & 0xFF, \
406         (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
407
408 /*
409  * An struct acpi_namespace_node * can appear in some contexts,
410  * where a pointer to an union acpi_operand_object    can also
411  * appear.  This macro is used to distinguish them.
412  *
413  * The "Descriptor" field is the first field in both structures.
414  */
415 #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
416 #define ACPI_SET_DESCRIPTOR_TYPE(d,t)   (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = t)
417
418 /* Macro to test the object type */
419
420 #define ACPI_GET_OBJECT_TYPE(d)         (((union acpi_operand_object *)(void *)(d))->common.type)
421
422 /* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */
423
424 #define ACPI_IS_SINGLE_TABLE(x)         (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0)
425
426 /*
427  * Macros for the master AML opcode table
428  */
429 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
430 #define ACPI_OP(name,Pargs,Iargs,obj_type,class,type,flags)    {name,(u32)(Pargs),(u32)(Iargs),(u32)(flags),obj_type,class,type}
431 #else
432 #define ACPI_OP(name,Pargs,Iargs,obj_type,class,type,flags)    {(u32)(Pargs),(u32)(Iargs),(u32)(flags),obj_type,class,type}
433 #endif
434
435 #ifdef ACPI_DISASSEMBLER
436 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
437 #else
438 #define ACPI_DISASM_ONLY_MEMBERS(a)
439 #endif
440
441 #define ARG_TYPE_WIDTH                  5
442 #define ARG_1(x)                        ((u32)(x))
443 #define ARG_2(x)                        ((u32)(x) << (1 * ARG_TYPE_WIDTH))
444 #define ARG_3(x)                        ((u32)(x) << (2 * ARG_TYPE_WIDTH))
445 #define ARG_4(x)                        ((u32)(x) << (3 * ARG_TYPE_WIDTH))
446 #define ARG_5(x)                        ((u32)(x) << (4 * ARG_TYPE_WIDTH))
447 #define ARG_6(x)                        ((u32)(x) << (5 * ARG_TYPE_WIDTH))
448
449 #define ARGI_LIST1(a)                   (ARG_1(a))
450 #define ARGI_LIST2(a,b)                 (ARG_1(b)|ARG_2(a))
451 #define ARGI_LIST3(a,b,c)               (ARG_1(c)|ARG_2(b)|ARG_3(a))
452 #define ARGI_LIST4(a,b,c,d)             (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
453 #define ARGI_LIST5(a,b,c,d,e)           (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
454 #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))
455
456 #define ARGP_LIST1(a)                   (ARG_1(a))
457 #define ARGP_LIST2(a,b)                 (ARG_1(a)|ARG_2(b))
458 #define ARGP_LIST3(a,b,c)               (ARG_1(a)|ARG_2(b)|ARG_3(c))
459 #define ARGP_LIST4(a,b,c,d)             (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
460 #define ARGP_LIST5(a,b,c,d,e)           (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
461 #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))
462
463 #define GET_CURRENT_ARG_TYPE(list)      (list & ((u32) 0x1F))
464 #define INCREMENT_ARG_LIST(list)        (list >>= ((u32) ARG_TYPE_WIDTH))
465
466 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
467 /*
468  * Module name is include in both debug and non-debug versions primarily for
469  * error messages. The __FILE__ macro is not very useful for this, because it
470  * often includes the entire pathname to the module
471  */
472 #define ACPI_MODULE_NAME(name)          static char ACPI_UNUSED_VAR *_acpi_module_name = name;
473 #else
474 #define ACPI_MODULE_NAME(name)
475 #endif
476
477 /*
478  * Ascii error messages can be configured out
479  */
480 #ifndef ACPI_NO_ERROR_MESSAGES
481 #define AE_INFO                         _acpi_module_name, __LINE__
482
483 /*
484  * Error reporting. Callers module and line number are inserted by AE_INFO,
485  * the plist contains a set of parens to allow variable-length lists.
486  * These macros are used for both the debug and non-debug versions of the code.
487  */
488 #define ACPI_INFO(plist)                acpi_ut_info plist
489 #define ACPI_WARNING(plist)             acpi_ut_warning plist
490 #define ACPI_EXCEPTION(plist)           acpi_ut_exception plist
491 #define ACPI_ERROR(plist)               acpi_ut_error plist
492 #define ACPI_ERROR_NAMESPACE(s,e)       acpi_ns_report_error (AE_INFO, s, e);
493 #define ACPI_ERROR_METHOD(s,n,p,e)      acpi_ns_report_method_error (AE_INFO, s, n, p, e);
494
495 #else
496
497 /* No error messages */
498
499 #define ACPI_INFO(plist)
500 #define ACPI_WARNING(plist)
501 #define ACPI_EXCEPTION(plist)
502 #define ACPI_ERROR(plist)
503 #define ACPI_ERROR_NAMESPACE(s,e)
504 #define ACPI_ERROR_METHOD(s,n,p,e)
505 #endif
506
507 /*
508  * Debug macros that are conditionally compiled
509  */
510 #ifdef ACPI_DEBUG_OUTPUT
511
512 /*
513  * Common parameters used for debug output functions:
514  * line number, function name, module(file) name, component ID
515  */
516 #define ACPI_DEBUG_PARAMETERS           __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
517
518 /*
519  * Function entry tracing
520  */
521
522 /*
523  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
524  * define it now. This is the case where there the compiler does not support
525  * a __FUNCTION__ macro or equivalent. We save the function name on the
526  * local stack.
527  */
528 #ifndef ACPI_GET_FUNCTION_NAME
529 #define ACPI_GET_FUNCTION_NAME          _acpi_function_name
530 /*
531  * The Name parameter should be the procedure name as a quoted string.
532  * This is declared as a local string ("MyFunctionName") so that it can
533  * be also used by the function exit macros below.
534  * Note: (const char) is used to be compatible with the debug interfaces
535  * and macros such as __FUNCTION__.
536  */
537 #define ACPI_FUNCTION_NAME(name)        const char *_acpi_function_name = #name;
538
539 #else
540 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
541
542 #define ACPI_FUNCTION_NAME(name)
543 #endif
544
545 #define ACPI_FUNCTION_TRACE(a)          ACPI_FUNCTION_NAME(a) \
546                           acpi_ut_trace(ACPI_DEBUG_PARAMETERS)
547 #define ACPI_FUNCTION_TRACE_PTR(a,b)    ACPI_FUNCTION_NAME(a) \
548                                            acpi_ut_trace_ptr(ACPI_DEBUG_PARAMETERS,(void *)b)
549 #define ACPI_FUNCTION_TRACE_U32(a,b)    ACPI_FUNCTION_NAME(a) \
550                                                          acpi_ut_trace_u32(ACPI_DEBUG_PARAMETERS,(u32)b)
551 #define ACPI_FUNCTION_TRACE_STR(a,b)    ACPI_FUNCTION_NAME(a) \
552                                                                           acpi_ut_trace_str(ACPI_DEBUG_PARAMETERS,(char *)b)
553
554 #define ACPI_FUNCTION_ENTRY()           acpi_ut_track_stack_ptr()
555
556 /*
557  * Function exit tracing.
558  * WARNING: These macros include a return statement.  This is usually considered
559  * bad form, but having a separate exit macro is very ugly and difficult to maintain.
560  * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
561  * so that "_AcpiFunctionName" is defined.
562  *
563  * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining
564  * about these constructs.
565  */
566 #ifdef ACPI_USE_DO_WHILE_0
567 #define ACPI_DO_WHILE0(a)               do a while(0)
568 #else
569 #define ACPI_DO_WHILE0(a)               a
570 #endif
571
572 #define return_VOID                     ACPI_DO_WHILE0 ({ \
573                                                                                         acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
574                                                                                         return;})
575 /*
576  * There are two versions of most of the return macros. The default version is
577  * safer, since it avoids side-effects by guaranteeing that the argument will
578  * not be evaluated twice.
579  *
580  * A less-safe version of the macros is provided for optional use if the
581  * compiler uses excessive CPU stack (for example, this may happen in the
582  * debug case if code optimzation is disabled.)
583  */
584 #ifndef ACPI_SIMPLE_RETURN_MACROS
585
586 #define return_ACPI_STATUS(s)           ACPI_DO_WHILE0 ({ \
587                                                                                         register acpi_status _s = (s); \
588                                                                                         acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, _s); \
589                                                                                         return (_s); })
590 #define return_PTR(s)                   ACPI_DO_WHILE0 ({ \
591                                                                                         register void *_s = (void *) (s); \
592                                                                                         acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) _s); \
593                                                                                         return (_s); })
594 #define return_VALUE(s)                 ACPI_DO_WHILE0 ({ \
595                                                                                         register acpi_integer _s = (s); \
596                                                                                         acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, _s); \
597                                                                                         return (_s); })
598 #define return_UINT8(s)                 ACPI_DO_WHILE0 ({ \
599                                                                                         register u8 _s = (u8) (s); \
600                                                                                         acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) _s); \
601                                                                                         return (_s); })
602 #define return_UINT32(s)                ACPI_DO_WHILE0 ({ \
603                                                                                         register u32 _s = (u32) (s); \
604                                                                                         acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) _s); \
605                                                                                         return (_s); })
606 #else                           /* Use original less-safe macros */
607
608 #define return_ACPI_STATUS(s)           ACPI_DO_WHILE0 ({ \
609                                                                                         acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, (s)); \
610                                                                                         return((s)); })
611 #define return_PTR(s)                   ACPI_DO_WHILE0 ({ \
612                                                                                         acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) (s)); \
613                                                                                         return((s)); })
614 #define return_VALUE(s)                 ACPI_DO_WHILE0 ({ \
615                                                                                         acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) (s)); \
616                                                                                         return((s)); })
617 #define return_UINT8(s)                 return_VALUE(s)
618 #define return_UINT32(s)                return_VALUE(s)
619
620 #endif                          /* ACPI_SIMPLE_RETURN_MACROS */
621
622 /* Conditional execution */
623
624 #define ACPI_DEBUG_EXEC(a)              a
625 #define ACPI_NORMAL_EXEC(a)
626
627 #define ACPI_DEBUG_DEFINE(a)            a;
628 #define ACPI_DEBUG_ONLY_MEMBERS(a)      a;
629 #define _VERBOSE_STRUCTURES
630
631 /* Stack and buffer dumping */
632
633 #define ACPI_DUMP_STACK_ENTRY(a)        acpi_ex_dump_operand((a),0)
634 #define ACPI_DUMP_OPERANDS(a,b,c,d,e)   acpi_ex_dump_operands(a,b,c,d,e,_acpi_module_name,__LINE__)
635
636 #define ACPI_DUMP_ENTRY(a,b)            acpi_ns_dump_entry (a,b)
637 #define ACPI_DUMP_PATHNAME(a,b,c,d)     acpi_ns_dump_pathname(a,b,c,d)
638 #define ACPI_DUMP_RESOURCE_LIST(a)      acpi_rs_dump_resource_list(a)
639 #define ACPI_DUMP_BUFFER(a,b)           acpi_ut_dump_buffer((u8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT)
640
641 /*
642  * Master debug print macros
643  * Print iff:
644  *    1) Debug print for the current component is enabled
645  *    2) Debug error level or trace level for the print statement is enabled
646  */
647 #define ACPI_DEBUG_PRINT(plist)         acpi_ut_debug_print plist
648 #define ACPI_DEBUG_PRINT_RAW(plist)     acpi_ut_debug_print_raw plist
649
650 #else
651 /*
652  * This is the non-debug case -- make everything go away,
653  * leaving no executable debug code!
654  */
655 #define ACPI_DEBUG_EXEC(a)
656 #define ACPI_NORMAL_EXEC(a)             a;
657
658 #define ACPI_DEBUG_DEFINE(a)
659 #define ACPI_DEBUG_ONLY_MEMBERS(a)
660 #define ACPI_FUNCTION_NAME(a)
661 #define ACPI_FUNCTION_TRACE(a)
662 #define ACPI_FUNCTION_TRACE_PTR(a,b)
663 #define ACPI_FUNCTION_TRACE_U32(a,b)
664 #define ACPI_FUNCTION_TRACE_STR(a,b)
665 #define ACPI_FUNCTION_EXIT
666 #define ACPI_FUNCTION_STATUS_EXIT(s)
667 #define ACPI_FUNCTION_VALUE_EXIT(s)
668 #define ACPI_FUNCTION_ENTRY()
669 #define ACPI_DUMP_STACK_ENTRY(a)
670 #define ACPI_DUMP_OPERANDS(a,b,c,d,e)
671 #define ACPI_DUMP_ENTRY(a,b)
672 #define ACPI_DUMP_TABLES(a,b)
673 #define ACPI_DUMP_PATHNAME(a,b,c,d)
674 #define ACPI_DUMP_RESOURCE_LIST(a)
675 #define ACPI_DUMP_BUFFER(a,b)
676 #define ACPI_DEBUG_PRINT(pl)
677 #define ACPI_DEBUG_PRINT_RAW(pl)
678
679 #define return_VOID                     return
680 #define return_ACPI_STATUS(s)           return(s)
681 #define return_VALUE(s)                 return(s)
682 #define return_UINT8(s)                 return(s)
683 #define return_UINT32(s)                return(s)
684 #define return_PTR(s)                   return(s)
685
686 #endif
687
688 /*
689  * Some code only gets executed when the debugger is built in.
690  * Note that this is entirely independent of whether the
691  * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
692  */
693 #ifdef ACPI_DEBUGGER
694 #define ACPI_DEBUGGER_EXEC(a)           a
695 #else
696 #define ACPI_DEBUGGER_EXEC(a)
697 #endif
698
699 /*
700  * For 16-bit code, we want to shrink some things even though
701  * we are using ACPI_DEBUG_OUTPUT to get the debug output
702  */
703 #if ACPI_MACHINE_WIDTH == 16
704 #undef ACPI_DEBUG_ONLY_MEMBERS
705 #undef _VERBOSE_STRUCTURES
706 #define ACPI_DEBUG_ONLY_MEMBERS(a)
707 #endif
708
709 #ifdef ACPI_DEBUG_OUTPUT
710 /*
711  * 1) Set name to blanks
712  * 2) Copy the object name
713  */
714 #define ACPI_ADD_OBJECT_NAME(a,b)       ACPI_MEMSET (a->common.name, ' ', sizeof (a->common.name));\
715                                                                                 ACPI_STRNCPY (a->common.name, acpi_gbl_ns_type_names[b], sizeof (a->common.name))
716 #else
717
718 #define ACPI_ADD_OBJECT_NAME(a,b)
719 #endif
720
721 /*
722  * Memory allocation tracking (DEBUG ONLY)
723  */
724 #ifndef ACPI_DBG_TRACK_ALLOCATIONS
725
726 /* Memory allocation */
727
728 #ifndef ACPI_ALLOCATE
729 #define ACPI_ALLOCATE(a)            acpi_ut_allocate((acpi_size)(a),_COMPONENT,_acpi_module_name,__LINE__)
730 #endif
731 #ifndef ACPI_ALLOCATE_ZEROED
732 #define ACPI_ALLOCATE_ZEROED(a)     acpi_ut_allocate_zeroed((acpi_size)(a), _COMPONENT,_acpi_module_name,__LINE__)
733 #endif
734 #ifndef ACPI_FREE
735 #define ACPI_FREE(a)                acpio_os_free(a)
736 #endif
737 #define ACPI_MEM_TRACKING(a)
738
739 #else
740
741 /* Memory allocation */
742
743 #define ACPI_ALLOCATE(a)            acpi_ut_allocate_and_track((acpi_size)(a),_COMPONENT,_acpi_module_name,__LINE__)
744 #define ACPI_ALLOCATE_ZEROED(a)     acpi_ut_allocate_zeroed_and_track((acpi_size)(a), _COMPONENT,_acpi_module_name,__LINE__)
745 #define ACPI_FREE(a)                acpi_ut_free_and_track(a,_COMPONENT,_acpi_module_name,__LINE__)
746 #define ACPI_MEM_TRACKING(a)        a
747
748 #endif                          /* ACPI_DBG_TRACK_ALLOCATIONS */
749
750 #endif                          /* ACMACROS_H */