ia64/xen-unstable

view xen/include/acpi/acmacros.h @ 19836:d9890e67d2b7

tools: add SHAREDIR to buildmakevars2file

c/s 19818 dropped SHAREDIR from xen/util/path.py, which broke the "xm
new" command. This patch adds SHAREDIR back to the new
buildmakevars2file-closure function.

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