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