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