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