blob: 53666bd9193d5c566d264275ea7ba38518317ccc [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/*
Bob Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, 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 */
Lv Zheng57bf6ae2012-12-19 05:38:24 +000052#define ACPI_CAST8(ptr) ACPI_CAST_PTR (u8, (ptr))
53#define ACPI_CAST16(ptr) ACPI_CAST_PTR (u16, (ptr))
54#define ACPI_CAST32(ptr) ACPI_CAST_PTR (u32, (ptr))
55#define ACPI_CAST64(ptr) ACPI_CAST_PTR (u64, (ptr))
56#define ACPI_GET8(ptr) (*ACPI_CAST8 (ptr))
57#define ACPI_GET16(ptr) (*ACPI_CAST16 (ptr))
58#define ACPI_GET32(ptr) (*ACPI_CAST32 (ptr))
59#define ACPI_GET64(ptr) (*ACPI_CAST64 (ptr))
60#define ACPI_SET8(ptr, val) (*ACPI_CAST8 (ptr) = (u8) (val))
61#define ACPI_SET16(ptr, val) (*ACPI_CAST16 (ptr) = (u16) (val))
62#define ACPI_SET32(ptr, val) (*ACPI_CAST32 (ptr) = (u32) (val))
63#define ACPI_SET64(ptr, val) (*ACPI_CAST64 (ptr) = (u64) (val))
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Bob Mooredefba1d2005-12-16 17:05:00 -050065/*
Bob Moore78236652008-04-10 19:06:42 +040066 * printf() format helpers
67 */
68
Bob Mooreba494be2012-07-12 09:40:10 +080069/* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */
Bob Moore78236652008-04-10 19:06:42 +040070
Bob Moorec9bdd802008-08-04 09:54:17 +080071#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
Bob Moore78236652008-04-10 19:06:42 +040072
73#if ACPI_MACHINE_WIDTH == 64
74#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i)
75#else
76#define ACPI_FORMAT_NATIVE_UINT(i) 0, (i)
77#endif
78
79/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 * Macros for moving data around to/from buffers that are possibly unaligned.
81 * If the hardware supports the transfer of unaligned data, just do the store.
82 * Otherwise, we have to move one byte at a time.
83 */
84#ifdef ACPI_BIG_ENDIAN
85/*
86 * Macros for big-endian machines
87 */
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089/* These macros reverse the bytes during the move, converting little-endian to big endian */
90
Lv Zheng86ff0e52012-10-31 02:25:52 +000091 /* Big Endian <== Little Endian */
92 /* Hi...Lo Lo...Hi */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/* 16-bit source, 16/32/64 destination */
94
Bob Moorec9bdd802008-08-04 09:54:17 +080095#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
Lv Zheng86ff0e52012-10-31 02:25:52 +000096 (( u8 *)(void *)(d))[1] = ((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_32(d, s) {(*(u32 *)(void *)(d))=0;\
Lv Zheng86ff0e52012-10-31 02:25:52 +000099 ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
100 ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Bob Moorec9bdd802008-08-04 09:54:17 +0800102#define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
Lv Zheng86ff0e52012-10-31 02:25:52 +0000103 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
104 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106/* 32-bit source, 16/32/64 destination */
107
Bob Moorec9bdd802008-08-04 09:54:17 +0800108#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 -0700109
Bob Moorec9bdd802008-08-04 09:54:17 +0800110#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
Lv Zheng86ff0e52012-10-31 02:25:52 +0000111 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
112 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
113 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Bob Moorec9bdd802008-08-04 09:54:17 +0800115#define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
117 ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
118 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
119 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
120
121/* 64-bit source, 16/32/64 destination */
122
Bob Moorec9bdd802008-08-04 09:54:17 +0800123#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 -0700124
Bob Moorec9bdd802008-08-04 09:54:17 +0800125#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 -0700126
Bob Moorec9bdd802008-08-04 09:54:17 +0800127#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
129 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
130 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
131 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
132 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
133 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
134 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
135#else
136/*
137 * Macros for little-endian machines
138 */
139
Bob Moore08978312005-10-21 00:00:00 -0400140#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142/* The hardware supports unaligned transfers, just do the little-endian move */
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144/* 16-bit source, 16/32/64 destination */
145
Bob Moorec9bdd802008-08-04 09:54:17 +0800146#define ACPI_MOVE_16_TO_16(d, s) *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
147#define ACPI_MOVE_16_TO_32(d, s) *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
148#define ACPI_MOVE_16_TO_64(d, s) *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150/* 32-bit source, 16/32/64 destination */
151
Bob Moorec9bdd802008-08-04 09:54:17 +0800152#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
153#define ACPI_MOVE_32_TO_32(d, s) *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
154#define ACPI_MOVE_32_TO_64(d, s) *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156/* 64-bit source, 16/32/64 destination */
157
Bob Moorec9bdd802008-08-04 09:54:17 +0800158#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
159#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
160#define ACPI_MOVE_64_TO_64(d, s) *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162#else
163/*
Bob Moorec9bdd802008-08-04 09:54:17 +0800164 * The hardware does not support unaligned transfers. We must move the
165 * data one byte at a time. These macros work whether the source or
Bob Moore50df4d82008-12-31 03:01:23 +0800166 * the destination (or both) is/are unaligned. (Little-endian move)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 */
168
169/* 16-bit source, 16/32/64 destination */
170
Bob Moorec9bdd802008-08-04 09:54:17 +0800171#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
173
Bob Moorec9bdd802008-08-04 09:54:17 +0800174#define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
175#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 -0700176
177/* 32-bit source, 16/32/64 destination */
178
Bob Moorec9bdd802008-08-04 09:54:17 +0800179#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 -0700180
Bob Moorec9bdd802008-08-04 09:54:17 +0800181#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
183 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
184 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
185
Bob Moorec9bdd802008-08-04 09:54:17 +0800186#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 -0700187
188/* 64-bit source, 16/32/64 destination */
189
Bob Moorec9bdd802008-08-04 09:54:17 +0800190#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
191#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
192#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
194 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
195 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
196 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
197 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
198 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
199 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
200#endif
201#endif
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203/*
204 * Fast power-of-two math macros for non-optimized compilers
205 */
Lv Zheng86ff0e52012-10-31 02:25:52 +0000206#define _ACPI_DIV(value, power_of2) ((u32) ((value) >> (power_of2)))
207#define _ACPI_MUL(value, power_of2) ((u32) ((value) << (power_of2)))
208#define _ACPI_MOD(value, divisor) ((u32) ((value) & ((divisor) -1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Bob Moorec9bdd802008-08-04 09:54:17 +0800210#define ACPI_DIV_2(a) _ACPI_DIV(a, 1)
211#define ACPI_MUL_2(a) _ACPI_MUL(a, 1)
212#define ACPI_MOD_2(a) _ACPI_MOD(a, 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Bob Moorec9bdd802008-08-04 09:54:17 +0800214#define ACPI_DIV_4(a) _ACPI_DIV(a, 2)
215#define ACPI_MUL_4(a) _ACPI_MUL(a, 2)
216#define ACPI_MOD_4(a) _ACPI_MOD(a, 4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Bob Moorec9bdd802008-08-04 09:54:17 +0800218#define ACPI_DIV_8(a) _ACPI_DIV(a, 3)
219#define ACPI_MUL_8(a) _ACPI_MUL(a, 3)
220#define ACPI_MOD_8(a) _ACPI_MOD(a, 8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Bob Moorec9bdd802008-08-04 09:54:17 +0800222#define ACPI_DIV_16(a) _ACPI_DIV(a, 4)
223#define ACPI_MUL_16(a) _ACPI_MUL(a, 4)
224#define ACPI_MOD_16(a) _ACPI_MOD(a, 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Bob Moorec9bdd802008-08-04 09:54:17 +0800226#define ACPI_DIV_32(a) _ACPI_DIV(a, 5)
227#define ACPI_MUL_32(a) _ACPI_MUL(a, 5)
228#define ACPI_MOD_32(a) _ACPI_MOD(a, 32)
Bob Moore28f55eb2005-12-02 18:27:00 -0500229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230/*
231 * Rounding macros (Power of two boundaries only)
232 */
Lv Zheng86ff0e52012-10-31 02:25:52 +0000233#define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \
234 (~(((acpi_size) boundary)-1)))
Bob Mooreb8e4d892006-01-27 16:43:00 -0500235
Lv Zheng86ff0e52012-10-31 02:25:52 +0000236#define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \
237 (((acpi_size) boundary)-1)) & \
238 (~(((acpi_size) boundary)-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Bob Moore67a119f2008-06-10 13:42:13 +0800240/* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Bob Moorec9bdd802008-08-04 09:54:17 +0800242#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4)
243#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8)
244#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(acpi_size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Bob Moorec9bdd802008-08-04 09:54:17 +0800246#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4)
247#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8)
248#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(acpi_size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Bob Mooreea936b72006-02-17 00:00:00 -0500250#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7)
251#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a))
252
253#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255/* Generic (non-power-of-two) rounding */
256
Bob Moorec9bdd802008-08-04 09:54:17 +0800257#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
Bob Mooreea936b72006-02-17 00:00:00 -0500258
Lv Zheng86ff0e52012-10-31 02:25:52 +0000259#define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261/*
262 * Bitmask creation
263 * Bit positions start at zero.
264 * MASK_BITS_ABOVE creates a mask starting AT the position and above
265 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
266 */
Bob Moore5df7e6c2010-01-21 10:06:32 +0800267#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((u32) (position))))
268#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((u32) (position)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270/* Bitfields within ACPI registers */
271
Bob Moorebe030a52012-08-17 13:07:54 +0800272#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
273 ((val << pos) & mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Bob Moorebe030a52012-08-17 13:07:54 +0800275#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \
276 reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
277
278#define ACPI_INSERT_BITS(target, mask, source) \
279 target = ((target & (~(mask))) | (source & mask))
280
281/* Generic bitfield macros and masks */
282
283#define ACPI_GET_BITS(source_ptr, position, mask) \
284 ((*source_ptr >> position) & mask)
285
286#define ACPI_SET_BITS(target_ptr, position, mask, value) \
287 (*target_ptr |= ((value & mask) << position))
288
289#define ACPI_1BIT_MASK 0x00000001
290#define ACPI_2BIT_MASK 0x00000003
291#define ACPI_3BIT_MASK 0x00000007
292#define ACPI_4BIT_MASK 0x0000000F
293#define ACPI_5BIT_MASK 0x0000001F
294#define ACPI_6BIT_MASK 0x0000003F
295#define ACPI_7BIT_MASK 0x0000007F
296#define ACPI_8BIT_MASK 0x000000FF
297#define ACPI_16BIT_MASK 0x0000FFFF
298#define ACPI_24BIT_MASK 0x00FFFFFF
Bob Moore967440e32006-06-23 17:04:00 -0400299
Bob Moore2f3faab2012-12-19 05:38:18 +0000300/* Macros to extract flag bits from position zero */
301
302#define ACPI_GET_1BIT_FLAG(value) ((value) & ACPI_1BIT_MASK)
303#define ACPI_GET_2BIT_FLAG(value) ((value) & ACPI_2BIT_MASK)
304#define ACPI_GET_3BIT_FLAG(value) ((value) & ACPI_3BIT_MASK)
305#define ACPI_GET_4BIT_FLAG(value) ((value) & ACPI_4BIT_MASK)
306
307/* Macros to extract flag bits from position one and above */
308
309#define ACPI_EXTRACT_1BIT_FLAG(field, position) (ACPI_GET_1BIT_FLAG ((field) >> position))
310#define ACPI_EXTRACT_2BIT_FLAG(field, position) (ACPI_GET_2BIT_FLAG ((field) >> position))
311#define ACPI_EXTRACT_3BIT_FLAG(field, position) (ACPI_GET_3BIT_FLAG ((field) >> position))
312#define ACPI_EXTRACT_4BIT_FLAG(field, position) (ACPI_GET_4BIT_FLAG ((field) >> position))
313
Bob Moore04a81dc2012-12-31 00:05:17 +0000314/* ACPI Pathname helpers */
315
316#define ACPI_IS_ROOT_PREFIX(c) ((c) == (u8) 0x5C) /* Backslash */
317#define ACPI_IS_PARENT_PREFIX(c) ((c) == (u8) 0x5E) /* Carat */
318#define ACPI_IS_PATH_SEPARATOR(c) ((c) == (u8) 0x2E) /* Period (dot) */
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/*
Bob Moorecf489582012-07-16 09:52:27 +0800321 * An object of type struct acpi_namespace_node can appear in some contexts
322 * where a pointer to an object of type union acpi_operand_object can also
Bob Moorec9bdd802008-08-04 09:54:17 +0800323 * appear. This macro is used to distinguish them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 *
Jung-uk Kim1af89272013-03-08 09:21:54 +0000325 * The "DescriptorType" field is the second field in both structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 */
Jung-uk Kim1af89272013-03-08 09:21:54 +0000327#define ACPI_GET_DESCRIPTOR_PTR(d) (((union acpi_descriptor *)(void *)(d))->common.common_pointer)
Bob Mooref1778eb2013-03-08 09:22:03 +0000328#define ACPI_SET_DESCRIPTOR_PTR(d, p) (((union acpi_descriptor *)(void *)(d))->common.common_pointer = (p))
Bob Moore616861242006-03-17 16:44:00 -0500329#define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
Bob Mooref1778eb2013-03-08 09:22:03 +0000330#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = (t))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332/*
333 * Macros for the master AML opcode table
334 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800335#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
336#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
337 {name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338#else
Bob Moorec9bdd802008-08-04 09:54:17 +0800339#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
340 {(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341#endif
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343#define ARG_TYPE_WIDTH 5
344#define ARG_1(x) ((u32)(x))
345#define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH))
346#define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH))
347#define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH))
348#define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH))
349#define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH))
350
351#define ARGI_LIST1(a) (ARG_1(a))
Bob Moorec9bdd802008-08-04 09:54:17 +0800352#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a))
353#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
354#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
355#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
356#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 -0700357
358#define ARGP_LIST1(a) (ARG_1(a))
Bob Moorec9bdd802008-08-04 09:54:17 +0800359#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b))
360#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
361#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
362#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
363#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 -0700364
365#define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
366#define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
367
Bob Moore4a90c7e2006-01-13 16:22:00 -0500368/*
369 * Ascii error messages can be configured out
370 */
371#ifndef ACPI_NO_ERROR_MESSAGES
Bob Moore4a90c7e2006-01-13 16:22:00 -0500372/*
Bob Mooreb8e4d892006-01-27 16:43:00 -0500373 * Error reporting. Callers module and line number are inserted by AE_INFO,
374 * the plist contains a set of parens to allow variable-length lists.
375 * These macros are used for both the debug and non-debug versions of the code.
Bob Moore4a90c7e2006-01-13 16:22:00 -0500376 */
Bob Moorecc84e262010-09-15 14:09:14 +0800377#define ACPI_ERROR_NAMESPACE(s, e) acpi_ut_namespace_error (AE_INFO, s, e);
378#define ACPI_ERROR_METHOD(s, n, p, e) acpi_ut_method_error (AE_INFO, s, n, p, e);
Bob Moore0444e8f2009-06-24 13:38:02 +0800379#define ACPI_WARN_PREDEFINED(plist) acpi_ut_predefined_warning plist
Bob Moore7df200c2009-11-12 09:18:45 +0800380#define ACPI_INFO_PREDEFINED(plist) acpi_ut_predefined_info plist
Bob Moore4a90c7e2006-01-13 16:22:00 -0500381
Bob Moore4a90c7e2006-01-13 16:22:00 -0500382#else
383
384/* No error messages */
385
Bob Moorec9bdd802008-08-04 09:54:17 +0800386#define ACPI_ERROR_NAMESPACE(s, e)
387#define ACPI_ERROR_METHOD(s, n, p, e)
Bob Moore0444e8f2009-06-24 13:38:02 +0800388#define ACPI_WARN_PREDEFINED(plist)
Bob Moore7df200c2009-11-12 09:18:45 +0800389#define ACPI_INFO_PREDEFINED(plist)
390
Lv Zheng86ff0e52012-10-31 02:25:52 +0000391#endif /* ACPI_NO_ERROR_MESSAGES */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Bob Moore72a88872012-02-14 18:57:13 +0800393#if (!ACPI_REDUCED_HARDWARE)
394#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr
395#else
396#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL
397#endif
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399/*
400 * Some code only gets executed when the debugger is built in.
401 * Note that this is entirely independent of whether the
402 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
403 */
404#ifdef ACPI_DEBUGGER
405#define ACPI_DEBUGGER_EXEC(a) a
406#else
407#define ACPI_DEBUGGER_EXEC(a)
408#endif
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410/*
411 * Memory allocation tracking (DEBUG ONLY)
412 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800413#define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415#ifndef ACPI_DBG_TRACK_ALLOCATIONS
416
417/* Memory allocation */
418
Len Browne21c1ca2006-07-10 01:35:51 -0400419#ifndef ACPI_ALLOCATE
Lv Zheng86ff0e52012-10-31 02:25:52 +0000420#define ACPI_ALLOCATE(a) acpi_ut_allocate((acpi_size) (a), ACPI_MEM_PARAMETERS)
Len Browne21c1ca2006-07-10 01:35:51 -0400421#endif
422#ifndef ACPI_ALLOCATE_ZEROED
Lv Zheng86ff0e52012-10-31 02:25:52 +0000423#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed((acpi_size) (a), ACPI_MEM_PARAMETERS)
Len Browne21c1ca2006-07-10 01:35:51 -0400424#endif
425#ifndef ACPI_FREE
Lv Zheng86ff0e52012-10-31 02:25:52 +0000426#define ACPI_FREE(a) acpi_os_free(a)
Len Browne21c1ca2006-07-10 01:35:51 -0400427#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428#define ACPI_MEM_TRACKING(a)
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430#else
431
432/* Memory allocation */
433
Lv Zheng86ff0e52012-10-31 02:25:52 +0000434#define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track((acpi_size) (a), ACPI_MEM_PARAMETERS)
435#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track((acpi_size) (a), ACPI_MEM_PARAMETERS)
Bob Moorec9bdd802008-08-04 09:54:17 +0800436#define ACPI_FREE(a) acpi_ut_free_and_track(a, ACPI_MEM_PARAMETERS)
Bob Moore616861242006-03-17 16:44:00 -0500437#define ACPI_MEM_TRACKING(a) a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Len Brown4be44fc2005-08-05 00:44:28 -0400439#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
Lv Zheng86ff0e52012-10-31 02:25:52 +0000441/*
442 * Macros used for ACPICA utilities only
443 */
444
445/* Generate a UUID */
446
447#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
448 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
449 (b) & 0xFF, ((b) >> 8) & 0xFF, \
450 (c) & 0xFF, ((c) >> 8) & 0xFF, \
451 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
452
453#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7'))
Alexey Starikovskiy8bd108d2008-09-25 21:40:30 +0400454
Len Brown4be44fc2005-08-05 00:44:28 -0400455#endif /* ACMACROS_H */