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