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