blob: 91ac7d7b4402a07bf9409cd2c7ef97fae9981e3b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acmacros.h - C macros for the entire subsystem.
4 *
5 *****************************************************************************/
6
7/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/*
Bob Moorec9bdd802008-08-04 09:54:17 +080048 * Extract data using a pointer. Any more than a byte and we
Bob Mooredefba1d2005-12-16 17:05:00 -050049 * get into potential aligment issues -- see the STORE macros below.
50 * Use with care.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 */
Bob Moorec51a4de2005-11-17 13:07:00 -050052#define ACPI_GET8(ptr) *ACPI_CAST_PTR (u8, ptr)
53#define ACPI_GET16(ptr) *ACPI_CAST_PTR (u16, ptr)
54#define ACPI_GET32(ptr) *ACPI_CAST_PTR (u32, ptr)
55#define ACPI_GET64(ptr) *ACPI_CAST_PTR (u64, ptr)
56#define ACPI_SET8(ptr) *ACPI_CAST_PTR (u8, ptr)
57#define ACPI_SET16(ptr) *ACPI_CAST_PTR (u16, ptr)
58#define ACPI_SET32(ptr) *ACPI_CAST_PTR (u32, ptr)
59#define ACPI_SET64(ptr) *ACPI_CAST_PTR (u64, ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Bob Mooredefba1d2005-12-16 17:05:00 -050061/*
Bob Moore78236652008-04-10 19:06:42 +040062 * printf() format helpers
63 */
64
65/* Split 64-bit integer into two 32-bit values. Use with %8.8_x%8.8_x */
66
Bob Moorec9bdd802008-08-04 09:54:17 +080067#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
Bob Moore78236652008-04-10 19:06:42 +040068
69#if ACPI_MACHINE_WIDTH == 64
70#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i)
71#else
72#define ACPI_FORMAT_NATIVE_UINT(i) 0, (i)
73#endif
74
75/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 * Macros for moving data around to/from buffers that are possibly unaligned.
77 * If the hardware supports the transfer of unaligned data, just do the store.
78 * Otherwise, we have to move one byte at a time.
79 */
80#ifdef ACPI_BIG_ENDIAN
81/*
82 * Macros for big-endian machines
83 */
84
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/* These macros reverse the bytes during the move, converting little-endian to big endian */
86
Bob Moore78236652008-04-10 19:06:42 +040087 /* Big Endian <== Little Endian */
88 /* Hi...Lo Lo...Hi */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089/* 16-bit source, 16/32/64 destination */
90
Bob Moorec9bdd802008-08-04 09:54:17 +080091#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
Bob Moore78236652008-04-10 19:06:42 +040092 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Bob Moorec9bdd802008-08-04 09:54:17 +080094#define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d))=0;\
Bob Moore78236652008-04-10 19:06:42 +040095 ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
96 ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Bob Moorec9bdd802008-08-04 09:54:17 +080098#define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
Bob Moore78236652008-04-10 19:06:42 +040099 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
100 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/* 32-bit source, 16/32/64 destination */
103
Bob Moorec9bdd802008-08-04 09:54:17 +0800104#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Bob Moorec9bdd802008-08-04 09:54:17 +0800106#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
Bob Moore78236652008-04-10 19:06:42 +0400107 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
108 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
109 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Bob Moorec9bdd802008-08-04 09:54:17 +0800111#define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
113 ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
114 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
115 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
116
117/* 64-bit source, 16/32/64 destination */
118
Bob Moorec9bdd802008-08-04 09:54:17 +0800119#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Bob Moorec9bdd802008-08-04 09:54:17 +0800121#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Bob Moorec9bdd802008-08-04 09:54:17 +0800123#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
125 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
126 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
127 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
128 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
129 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
130 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
131#else
132/*
133 * Macros for little-endian machines
134 */
135
Bob Moore08978312005-10-21 00:00:00 -0400136#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138/* The hardware supports unaligned transfers, just do the little-endian move */
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140/* 16-bit source, 16/32/64 destination */
141
Bob Moorec9bdd802008-08-04 09:54:17 +0800142#define ACPI_MOVE_16_TO_16(d, s) *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
143#define ACPI_MOVE_16_TO_32(d, s) *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
144#define ACPI_MOVE_16_TO_64(d, s) *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146/* 32-bit source, 16/32/64 destination */
147
Bob Moorec9bdd802008-08-04 09:54:17 +0800148#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
149#define ACPI_MOVE_32_TO_32(d, s) *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
150#define ACPI_MOVE_32_TO_64(d, s) *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152/* 64-bit source, 16/32/64 destination */
153
Bob Moorec9bdd802008-08-04 09:54:17 +0800154#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
155#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
156#define ACPI_MOVE_64_TO_64(d, s) *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158#else
159/*
Bob Moorec9bdd802008-08-04 09:54:17 +0800160 * The hardware does not support unaligned transfers. We must move the
161 * data one byte at a time. These macros work whether the source or
Bob Moore50df4d82008-12-31 03:01:23 +0800162 * the destination (or both) is/are unaligned. (Little-endian move)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 */
164
165/* 16-bit source, 16/32/64 destination */
166
Bob Moorec9bdd802008-08-04 09:54:17 +0800167#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
169
Bob Moorec9bdd802008-08-04 09:54:17 +0800170#define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
171#define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173/* 32-bit source, 16/32/64 destination */
174
Bob Moorec9bdd802008-08-04 09:54:17 +0800175#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Bob Moorec9bdd802008-08-04 09:54:17 +0800177#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
179 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
180 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
181
Bob Moorec9bdd802008-08-04 09:54:17 +0800182#define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184/* 64-bit source, 16/32/64 destination */
185
Bob Moorec9bdd802008-08-04 09:54:17 +0800186#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
187#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
188#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
190 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
191 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
192 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
193 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
194 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
195 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
196#endif
197#endif
198
199/* Macros based on machine integer width */
200
Bob Moore59fa8502007-02-02 19:48:23 +0300201#if ACPI_MACHINE_WIDTH == 32
Bob Moorec9bdd802008-08-04 09:54:17 +0800202#define ACPI_MOVE_SIZE_TO_16(d, s) ACPI_MOVE_32_TO_16(d, s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204#elif ACPI_MACHINE_WIDTH == 64
Bob Moorec9bdd802008-08-04 09:54:17 +0800205#define ACPI_MOVE_SIZE_TO_16(d, s) ACPI_MOVE_64_TO_16(d, s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207#else
208#error unknown ACPI_MACHINE_WIDTH
209#endif
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211/*
212 * Fast power-of-two math macros for non-optimized compilers
213 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800214#define _ACPI_DIV(value, power_of2) ((u32) ((value) >> (power_of2)))
215#define _ACPI_MUL(value, power_of2) ((u32) ((value) << (power_of2)))
216#define _ACPI_MOD(value, divisor) ((u32) ((value) & ((divisor) -1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Bob Moorec9bdd802008-08-04 09:54:17 +0800218#define ACPI_DIV_2(a) _ACPI_DIV(a, 1)
219#define ACPI_MUL_2(a) _ACPI_MUL(a, 1)
220#define ACPI_MOD_2(a) _ACPI_MOD(a, 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Bob Moorec9bdd802008-08-04 09:54:17 +0800222#define ACPI_DIV_4(a) _ACPI_DIV(a, 2)
223#define ACPI_MUL_4(a) _ACPI_MUL(a, 2)
224#define ACPI_MOD_4(a) _ACPI_MOD(a, 4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Bob Moorec9bdd802008-08-04 09:54:17 +0800226#define ACPI_DIV_8(a) _ACPI_DIV(a, 3)
227#define ACPI_MUL_8(a) _ACPI_MUL(a, 3)
228#define ACPI_MOD_8(a) _ACPI_MOD(a, 8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Bob Moorec9bdd802008-08-04 09:54:17 +0800230#define ACPI_DIV_16(a) _ACPI_DIV(a, 4)
231#define ACPI_MUL_16(a) _ACPI_MUL(a, 4)
232#define ACPI_MOD_16(a) _ACPI_MOD(a, 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Bob Moorec9bdd802008-08-04 09:54:17 +0800234#define ACPI_DIV_32(a) _ACPI_DIV(a, 5)
235#define ACPI_MUL_32(a) _ACPI_MUL(a, 5)
236#define ACPI_MOD_32(a) _ACPI_MOD(a, 32)
Bob Moore28f55eb2005-12-02 18:27:00 -0500237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238/*
239 * Rounding macros (Power of two boundaries only)
240 */
Bob Moore67a119f2008-06-10 13:42:13 +0800241#define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \
242 (~(((acpi_size) boundary)-1)))
Bob Mooreb8e4d892006-01-27 16:43:00 -0500243
Bob Moore67a119f2008-06-10 13:42:13 +0800244#define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \
245 (((acpi_size) boundary)-1)) & \
246 (~(((acpi_size) boundary)-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Bob Moore67a119f2008-06-10 13:42:13 +0800248/* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Bob Moorec9bdd802008-08-04 09:54:17 +0800250#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4)
251#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8)
252#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(acpi_size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Bob Moorec9bdd802008-08-04 09:54:17 +0800254#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4)
255#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8)
256#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(acpi_size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Bob Mooreea936b72006-02-17 00:00:00 -0500258#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7)
259#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a))
260
261#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263/* Generic (non-power-of-two) rounding */
264
Bob Moorec9bdd802008-08-04 09:54:17 +0800265#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
Bob Mooreea936b72006-02-17 00:00:00 -0500266
Bob Moorec9bdd802008-08-04 09:54:17 +0800267#define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269/*
270 * Bitmask creation
271 * Bit positions start at zero.
272 * MASK_BITS_ABOVE creates a mask starting AT the position and above
273 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
274 */
Bob Mooreea936b72006-02-17 00:00:00 -0500275#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((u32) (position))))
276#define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((u32) (position)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278/* Bitfields within ACPI registers */
279
280#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) ((val << pos) & mask)
281#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
282
Bob Moore967440e32006-06-23 17:04:00 -0400283#define ACPI_INSERT_BITS(target, mask, source) target = ((target & (~(mask))) | (source & mask))
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/*
Frederik Schwarzer0211a9c2008-12-29 22:14:56 +0100286 * A struct acpi_namespace_node can appear in some contexts
287 * where a pointer to a union acpi_operand_object can also
Bob Moorec9bdd802008-08-04 09:54:17 +0800288 * appear. This macro is used to distinguish them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 *
290 * The "Descriptor" field is the first field in both structures.
291 */
Bob Moore616861242006-03-17 16:44:00 -0500292#define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
Bob Moorec9bdd802008-08-04 09:54:17 +0800293#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = t)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295/*
296 * Macros for the master AML opcode table
297 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800298#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
299#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
300 {name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301#else
Bob Moorec9bdd802008-08-04 09:54:17 +0800302#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
303 {(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304#endif
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306#define ARG_TYPE_WIDTH 5
307#define ARG_1(x) ((u32)(x))
308#define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH))
309#define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH))
310#define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH))
311#define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH))
312#define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH))
313
314#define ARGI_LIST1(a) (ARG_1(a))
Bob Moorec9bdd802008-08-04 09:54:17 +0800315#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a))
316#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
317#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
318#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
319#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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
321#define ARGP_LIST1(a) (ARG_1(a))
Bob Moorec9bdd802008-08-04 09:54:17 +0800322#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b))
323#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
324#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
325#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
326#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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328#define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
329#define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
330
Bob Moore4a90c7e2006-01-13 16:22:00 -0500331/*
332 * Ascii error messages can be configured out
333 */
334#ifndef ACPI_NO_ERROR_MESSAGES
Bob Moore4a90c7e2006-01-13 16:22:00 -0500335
336/*
Bob Mooreb8e4d892006-01-27 16:43:00 -0500337 * Error reporting. Callers module and line number are inserted by AE_INFO,
338 * the plist contains a set of parens to allow variable-length lists.
339 * These macros are used for both the debug and non-debug versions of the code.
Bob Moore4a90c7e2006-01-13 16:22:00 -0500340 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800341#define ACPI_ERROR_NAMESPACE(s, e) acpi_ns_report_error (AE_INFO, s, e);
342#define ACPI_ERROR_METHOD(s, n, p, e) acpi_ns_report_method_error (AE_INFO, s, n, p, e);
Bob Moore4a90c7e2006-01-13 16:22:00 -0500343
Bob Moore4a90c7e2006-01-13 16:22:00 -0500344#else
345
346/* No error messages */
347
Bob Moorec9bdd802008-08-04 09:54:17 +0800348#define ACPI_ERROR_NAMESPACE(s, e)
349#define ACPI_ERROR_METHOD(s, n, p, e)
Bob Moore50df4d82008-12-31 03:01:23 +0800350#endif /* ACPI_NO_ERROR_MESSAGES */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352/*
353 * Debug macros that are conditionally compiled
354 */
355#ifdef ACPI_DEBUG_OUTPUT
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357/*
Robert Mooref9f46012005-07-08 00:00:00 -0400358 * Function entry tracing
359 */
Len Brown4e83dd92007-11-23 18:33:11 -0500360#ifdef CONFIG_ACPI_DEBUG_FUNC_TRACE
Thomas Renninger798d91032007-05-31 17:20:39 +0200361
Robert Mooref9f46012005-07-08 00:00:00 -0400362#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \
Bob Moore616861242006-03-17 16:44:00 -0500363 acpi_ut_trace(ACPI_DEBUG_PARAMETERS)
Bob Moorec9bdd802008-08-04 09:54:17 +0800364#define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \
365 acpi_ut_trace_ptr(ACPI_DEBUG_PARAMETERS, (void *)b)
366#define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \
367 acpi_ut_trace_u32(ACPI_DEBUG_PARAMETERS, (u32)b)
368#define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \
369 acpi_ut_trace_str(ACPI_DEBUG_PARAMETERS, (char *)b)
Robert Mooref9f46012005-07-08 00:00:00 -0400370
371#define ACPI_FUNCTION_ENTRY() acpi_ut_track_stack_ptr()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373/*
374 * Function exit tracing.
Bob Moorec9bdd802008-08-04 09:54:17 +0800375 * WARNING: These macros include a return statement. This is usually considered
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
377 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
Bob Mooreb229cf92006-04-21 17:15:00 -0400378 * so that "_AcpiFunctionName" is defined.
Bob Moore50eca3e2005-09-30 19:03:00 -0400379 *
380 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining
381 * about these constructs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 */
383#ifdef ACPI_USE_DO_WHILE_0
384#define ACPI_DO_WHILE0(a) do a while(0)
385#else
386#define ACPI_DO_WHILE0(a) a
387#endif
388
Bob Moore50eca3e2005-09-30 19:03:00 -0400389#define return_VOID ACPI_DO_WHILE0 ({ \
390 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
391 return;})
392/*
393 * There are two versions of most of the return macros. The default version is
394 * safer, since it avoids side-effects by guaranteeing that the argument will
395 * not be evaluated twice.
396 *
397 * A less-safe version of the macros is provided for optional use if the
398 * compiler uses excessive CPU stack (for example, this may happen in the
399 * debug case if code optimzation is disabled.)
400 */
401#ifndef ACPI_SIMPLE_RETURN_MACROS
402
403#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
404 register acpi_status _s = (s); \
405 acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, _s); \
406 return (_s); })
407#define return_PTR(s) ACPI_DO_WHILE0 ({ \
408 register void *_s = (void *) (s); \
409 acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) _s); \
410 return (_s); })
411#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
412 register acpi_integer _s = (s); \
413 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, _s); \
414 return (_s); })
415#define return_UINT8(s) ACPI_DO_WHILE0 ({ \
416 register u8 _s = (u8) (s); \
Bob Moore08978312005-10-21 00:00:00 -0400417 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) _s); \
Bob Moore50eca3e2005-09-30 19:03:00 -0400418 return (_s); })
419#define return_UINT32(s) ACPI_DO_WHILE0 ({ \
420 register u32 _s = (u32) (s); \
Bob Moore08978312005-10-21 00:00:00 -0400421 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) _s); \
Bob Moore50eca3e2005-09-30 19:03:00 -0400422 return (_s); })
423#else /* Use original less-safe macros */
424
425#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
426 acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, (s)); \
427 return((s)); })
428#define return_PTR(s) ACPI_DO_WHILE0 ({ \
429 acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) (s)); \
430 return((s)); })
431#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
432 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) (s)); \
433 return((s)); })
434#define return_UINT8(s) return_VALUE(s)
435#define return_UINT32(s) return_VALUE(s)
436
437#endif /* ACPI_SIMPLE_RETURN_MACROS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Len Brown4e83dd92007-11-23 18:33:11 -0500439#else /* !CONFIG_ACPI_DEBUG_FUNC_TRACE */
Thomas Renninger798d91032007-05-31 17:20:39 +0200440
441#define ACPI_FUNCTION_TRACE(a)
442#define ACPI_FUNCTION_TRACE_PTR(a,b)
443#define ACPI_FUNCTION_TRACE_U32(a,b)
444#define ACPI_FUNCTION_TRACE_STR(a,b)
445#define ACPI_FUNCTION_EXIT
446#define ACPI_FUNCTION_STATUS_EXIT(s)
447#define ACPI_FUNCTION_VALUE_EXIT(s)
448#define ACPI_FUNCTION_TRACE(a)
449#define ACPI_FUNCTION_ENTRY()
450
451#define return_VOID return
452#define return_ACPI_STATUS(s) return(s)
453#define return_VALUE(s) return(s)
454#define return_UINT8(s) return(s)
455#define return_UINT32(s) return(s)
456#define return_PTR(s) return(s)
457
Len Brown4e83dd92007-11-23 18:33:11 -0500458#endif /* CONFIG_ACPI_DEBUG_FUNC_TRACE */
Thomas Renninger798d91032007-05-31 17:20:39 +0200459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460/* Conditional execution */
461
462#define ACPI_DEBUG_EXEC(a) a
463#define ACPI_NORMAL_EXEC(a)
464
465#define ACPI_DEBUG_DEFINE(a) a;
466#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
467#define _VERBOSE_STRUCTURES
468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469/* Stack and buffer dumping */
470
Bob Moorec9bdd802008-08-04 09:54:17 +0800471#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
472#define ACPI_DUMP_OPERANDS(a, b, c) acpi_ex_dump_operands(a, b, c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Bob Moorec9bdd802008-08-04 09:54:17 +0800474#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
475#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476#define ACPI_DUMP_RESOURCE_LIST(a) acpi_rs_dump_resource_list(a)
Bob Moorec9bdd802008-08-04 09:54:17 +0800477#define ACPI_DUMP_BUFFER(a, b) acpi_ut_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479#else
480/*
481 * This is the non-debug case -- make everything go away,
482 * leaving no executable debug code!
483 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484#define ACPI_DEBUG_EXEC(a)
485#define ACPI_NORMAL_EXEC(a) a;
486
Dave Jones4ebf83c2007-07-09 11:33:14 -0700487#define ACPI_DEBUG_DEFINE(a) do { } while(0)
488#define ACPI_DEBUG_ONLY_MEMBERS(a) do { } while(0)
Dave Jones4ebf83c2007-07-09 11:33:14 -0700489#define ACPI_FUNCTION_TRACE(a) do { } while(0)
Bob Moorec9bdd802008-08-04 09:54:17 +0800490#define ACPI_FUNCTION_TRACE_PTR(a, b) do { } while(0)
491#define ACPI_FUNCTION_TRACE_U32(a, b) do { } while(0)
492#define ACPI_FUNCTION_TRACE_STR(a, b) do { } while(0)
Dave Jones4ebf83c2007-07-09 11:33:14 -0700493#define ACPI_FUNCTION_EXIT do { } while(0)
494#define ACPI_FUNCTION_STATUS_EXIT(s) do { } while(0)
495#define ACPI_FUNCTION_VALUE_EXIT(s) do { } while(0)
496#define ACPI_FUNCTION_ENTRY() do { } while(0)
497#define ACPI_DUMP_STACK_ENTRY(a) do { } while(0)
Bob Moorec9bdd802008-08-04 09:54:17 +0800498#define ACPI_DUMP_OPERANDS(a, b, c) do { } while(0)
499#define ACPI_DUMP_ENTRY(a, b) do { } while(0)
500#define ACPI_DUMP_TABLES(a, b) do { } while(0)
501#define ACPI_DUMP_PATHNAME(a, b, c, d) do { } while(0)
Dave Jones4ebf83c2007-07-09 11:33:14 -0700502#define ACPI_DUMP_RESOURCE_LIST(a) do { } while(0)
Bob Moorec9bdd802008-08-04 09:54:17 +0800503#define ACPI_DUMP_BUFFER(a, b) do { } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
505#define return_VOID return
506#define return_ACPI_STATUS(s) return(s)
507#define return_VALUE(s) return(s)
Bob Moore50eca3e2005-09-30 19:03:00 -0400508#define return_UINT8(s) return(s)
509#define return_UINT32(s) return(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510#define return_PTR(s) return(s)
511
Bob Moore50df4d82008-12-31 03:01:23 +0800512#endif /* ACPI_DEBUG_OUTPUT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514/*
515 * Some code only gets executed when the debugger is built in.
516 * Note that this is entirely independent of whether the
517 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
518 */
519#ifdef ACPI_DEBUGGER
520#define ACPI_DEBUGGER_EXEC(a) a
521#else
522#define ACPI_DEBUGGER_EXEC(a)
523#endif
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525#ifdef ACPI_DEBUG_OUTPUT
526/*
527 * 1) Set name to blanks
528 * 2) Copy the object name
529 */
530#define ACPI_ADD_OBJECT_NAME(a,b) ACPI_MEMSET (a->common.name, ' ', sizeof (a->common.name));\
531 ACPI_STRNCPY (a->common.name, acpi_gbl_ns_type_names[b], sizeof (a->common.name))
532#else
533
534#define ACPI_ADD_OBJECT_NAME(a,b)
535#endif
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/*
538 * Memory allocation tracking (DEBUG ONLY)
539 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800540#define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542#ifndef ACPI_DBG_TRACK_ALLOCATIONS
543
544/* Memory allocation */
545
Len Browne21c1ca2006-07-10 01:35:51 -0400546#ifndef ACPI_ALLOCATE
Bob Moorec9bdd802008-08-04 09:54:17 +0800547#define ACPI_ALLOCATE(a) acpi_ut_allocate((acpi_size)(a), ACPI_MEM_PARAMETERS)
Len Browne21c1ca2006-07-10 01:35:51 -0400548#endif
549#ifndef ACPI_ALLOCATE_ZEROED
Bob Moorec9bdd802008-08-04 09:54:17 +0800550#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed((acpi_size)(a), ACPI_MEM_PARAMETERS)
Len Browne21c1ca2006-07-10 01:35:51 -0400551#endif
552#ifndef ACPI_FREE
553#define ACPI_FREE(a) acpio_os_free(a)
554#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555#define ACPI_MEM_TRACKING(a)
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557#else
558
559/* Memory allocation */
560
Bob Moorec9bdd802008-08-04 09:54:17 +0800561#define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track((acpi_size)(a), ACPI_MEM_PARAMETERS)
562#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track((acpi_size)(a), ACPI_MEM_PARAMETERS)
563#define ACPI_FREE(a) acpi_ut_free_and_track(a, ACPI_MEM_PARAMETERS)
Bob Moore616861242006-03-17 16:44:00 -0500564#define ACPI_MEM_TRACKING(a) a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Len Brown4be44fc2005-08-05 00:44:28 -0400566#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Alexey Starikovskiy8bd108d2008-09-25 21:40:30 +0400568/* Preemption point */
569#ifndef ACPI_PREEMPTION_POINT
570#define ACPI_PREEMPTION_POINT() /* no preemption */
571#endif
572
Len Brown4be44fc2005-08-05 00:44:28 -0400573#endif /* ACMACROS_H */