blob: 19d40c6c1f326c73fef7906c8478a5f4f6a18c26 [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/*
David E. Box82a80942015-02-05 15:20:45 +08008 * Copyright (C) 2000 - 2015, 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/*
Lv Zheng1d0a0b22015-04-13 11:48:52 +080066 * printf() format helper. This macros is a workaround for the difficulties
Bob Moorec03775c2014-02-08 09:42:01 +080067 * with emitting 64-bit integers and 64-bit pointers with the same code
68 * for both 32-bit and 64-bit hosts.
Bob Moore78236652008-04-10 19:06:42 +040069 */
Bob Moorec9bdd802008-08-04 09:54:17 +080070#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
Bob Moore78236652008-04-10 19:06:42 +040071
Bob Moore78236652008-04-10 19:06:42 +040072/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * Macros for moving data around to/from buffers that are possibly unaligned.
74 * If the hardware supports the transfer of unaligned data, just do the store.
75 * Otherwise, we have to move one byte at a time.
76 */
77#ifdef ACPI_BIG_ENDIAN
78/*
79 * Macros for big-endian machines
80 */
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082/* These macros reverse the bytes during the move, converting little-endian to big endian */
83
Lv Zheng86ff0e52012-10-31 02:25:52 +000084 /* Big Endian <== Little Endian */
85 /* Hi...Lo Lo...Hi */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/* 16-bit source, 16/32/64 destination */
87
Bob Moorec9bdd802008-08-04 09:54:17 +080088#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
Lv Zheng86ff0e52012-10-31 02:25:52 +000089 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Bob Moorec9bdd802008-08-04 09:54:17 +080091#define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d))=0;\
Lv Zheng86ff0e52012-10-31 02:25:52 +000092 ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
93 ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Bob Moorec9bdd802008-08-04 09:54:17 +080095#define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
Lv Zheng86ff0e52012-10-31 02:25:52 +000096 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
97 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/* 32-bit source, 16/32/64 destination */
100
Bob Moorec9bdd802008-08-04 09:54:17 +0800101#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 -0700102
Bob Moorec9bdd802008-08-04 09:54:17 +0800103#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
Lv Zheng86ff0e52012-10-31 02:25:52 +0000104 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
105 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
106 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Bob Moorec9bdd802008-08-04 09:54:17 +0800108#define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
110 ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
111 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
112 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
113
114/* 64-bit source, 16/32/64 destination */
115
Bob Moorec9bdd802008-08-04 09:54:17 +0800116#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 -0700117
Bob Moorec9bdd802008-08-04 09:54:17 +0800118#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 -0700119
Bob Moorec9bdd802008-08-04 09:54:17 +0800120#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
122 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
123 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
124 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
125 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
126 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
127 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
128#else
129/*
130 * Macros for little-endian machines
131 */
132
Bob Moore08978312005-10-21 00:00:00 -0400133#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135/* The hardware supports unaligned transfers, just do the little-endian move */
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137/* 16-bit source, 16/32/64 destination */
138
Bob Moorec9bdd802008-08-04 09:54:17 +0800139#define ACPI_MOVE_16_TO_16(d, s) *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
140#define ACPI_MOVE_16_TO_32(d, s) *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
141#define ACPI_MOVE_16_TO_64(d, s) *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143/* 32-bit source, 16/32/64 destination */
144
Bob Moorec9bdd802008-08-04 09:54:17 +0800145#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
146#define ACPI_MOVE_32_TO_32(d, s) *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
147#define ACPI_MOVE_32_TO_64(d, s) *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149/* 64-bit source, 16/32/64 destination */
150
Bob Moorec9bdd802008-08-04 09:54:17 +0800151#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
152#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
153#define ACPI_MOVE_64_TO_64(d, s) *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155#else
156/*
Bob Moorec9bdd802008-08-04 09:54:17 +0800157 * The hardware does not support unaligned transfers. We must move the
158 * data one byte at a time. These macros work whether the source or
Bob Moore50df4d82008-12-31 03:01:23 +0800159 * the destination (or both) is/are unaligned. (Little-endian move)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 */
161
162/* 16-bit source, 16/32/64 destination */
163
Bob Moorec9bdd802008-08-04 09:54:17 +0800164#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
166
Bob Moorec9bdd802008-08-04 09:54:17 +0800167#define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
168#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 -0700169
170/* 32-bit source, 16/32/64 destination */
171
Bob Moorec9bdd802008-08-04 09:54:17 +0800172#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 -0700173
Bob Moorec9bdd802008-08-04 09:54:17 +0800174#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
176 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
177 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
178
Bob Moorec9bdd802008-08-04 09:54:17 +0800179#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 -0700180
181/* 64-bit source, 16/32/64 destination */
182
Bob Moorec9bdd802008-08-04 09:54:17 +0800183#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
184#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
185#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
187 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
188 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
189 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
190 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
191 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
192 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
193#endif
194#endif
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196/*
197 * Fast power-of-two math macros for non-optimized compilers
198 */
Lv Zheng86ff0e52012-10-31 02:25:52 +0000199#define _ACPI_DIV(value, power_of2) ((u32) ((value) >> (power_of2)))
200#define _ACPI_MUL(value, power_of2) ((u32) ((value) << (power_of2)))
201#define _ACPI_MOD(value, divisor) ((u32) ((value) & ((divisor) -1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Bob Moorec9bdd802008-08-04 09:54:17 +0800203#define ACPI_DIV_2(a) _ACPI_DIV(a, 1)
204#define ACPI_MUL_2(a) _ACPI_MUL(a, 1)
205#define ACPI_MOD_2(a) _ACPI_MOD(a, 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Bob Moorec9bdd802008-08-04 09:54:17 +0800207#define ACPI_DIV_4(a) _ACPI_DIV(a, 2)
208#define ACPI_MUL_4(a) _ACPI_MUL(a, 2)
209#define ACPI_MOD_4(a) _ACPI_MOD(a, 4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Bob Moorec9bdd802008-08-04 09:54:17 +0800211#define ACPI_DIV_8(a) _ACPI_DIV(a, 3)
212#define ACPI_MUL_8(a) _ACPI_MUL(a, 3)
213#define ACPI_MOD_8(a) _ACPI_MOD(a, 8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Bob Moorec9bdd802008-08-04 09:54:17 +0800215#define ACPI_DIV_16(a) _ACPI_DIV(a, 4)
216#define ACPI_MUL_16(a) _ACPI_MUL(a, 4)
217#define ACPI_MOD_16(a) _ACPI_MOD(a, 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Bob Moorec9bdd802008-08-04 09:54:17 +0800219#define ACPI_DIV_32(a) _ACPI_DIV(a, 5)
220#define ACPI_MUL_32(a) _ACPI_MUL(a, 5)
221#define ACPI_MOD_32(a) _ACPI_MOD(a, 32)
Bob Moore28f55eb2005-12-02 18:27:00 -0500222
Bob Moore27629192015-07-23 12:53:49 +0800223/* Test for ASCII character */
224
225#define ACPI_IS_ASCII(c) ((c) < 0x80)
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/*
228 * Rounding macros (Power of two boundaries only)
229 */
Lv Zheng86ff0e52012-10-31 02:25:52 +0000230#define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \
231 (~(((acpi_size) boundary)-1)))
Bob Mooreb8e4d892006-01-27 16:43:00 -0500232
Lv Zheng86ff0e52012-10-31 02:25:52 +0000233#define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \
234 (((acpi_size) boundary)-1)) & \
235 (~(((acpi_size) boundary)-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Bob Moore67a119f2008-06-10 13:42:13 +0800237/* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Bob Moorec9bdd802008-08-04 09:54:17 +0800239#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4)
240#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8)
241#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(acpi_size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Bob Moorec9bdd802008-08-04 09:54:17 +0800243#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4)
244#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8)
245#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(acpi_size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Bob Mooreea936b72006-02-17 00:00:00 -0500247#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7)
248#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a))
249
250#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252/* Generic (non-power-of-two) rounding */
253
Bob Moorec9bdd802008-08-04 09:54:17 +0800254#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
Bob Mooreea936b72006-02-17 00:00:00 -0500255
Lv Zheng86ff0e52012-10-31 02:25:52 +0000256#define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258/*
259 * Bitmask creation
260 * Bit positions start at zero.
261 * MASK_BITS_ABOVE creates a mask starting AT the position and above
262 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
263 */
Bob Moore5df7e6c2010-01-21 10:06:32 +0800264#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((u32) (position))))
265#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((u32) (position)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267/* Bitfields within ACPI registers */
268
Bob Moorebe030a52012-08-17 13:07:54 +0800269#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
270 ((val << pos) & mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Bob Moorebe030a52012-08-17 13:07:54 +0800272#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \
273 reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
274
275#define ACPI_INSERT_BITS(target, mask, source) \
276 target = ((target & (~(mask))) | (source & mask))
277
278/* Generic bitfield macros and masks */
279
280#define ACPI_GET_BITS(source_ptr, position, mask) \
281 ((*source_ptr >> position) & mask)
282
283#define ACPI_SET_BITS(target_ptr, position, mask, value) \
284 (*target_ptr |= ((value & mask) << position))
285
286#define ACPI_1BIT_MASK 0x00000001
287#define ACPI_2BIT_MASK 0x00000003
288#define ACPI_3BIT_MASK 0x00000007
289#define ACPI_4BIT_MASK 0x0000000F
290#define ACPI_5BIT_MASK 0x0000001F
291#define ACPI_6BIT_MASK 0x0000003F
292#define ACPI_7BIT_MASK 0x0000007F
293#define ACPI_8BIT_MASK 0x000000FF
294#define ACPI_16BIT_MASK 0x0000FFFF
295#define ACPI_24BIT_MASK 0x00FFFFFF
Bob Moore967440e32006-06-23 17:04:00 -0400296
Bob Moore2f3faab2012-12-19 05:38:18 +0000297/* Macros to extract flag bits from position zero */
298
299#define ACPI_GET_1BIT_FLAG(value) ((value) & ACPI_1BIT_MASK)
300#define ACPI_GET_2BIT_FLAG(value) ((value) & ACPI_2BIT_MASK)
301#define ACPI_GET_3BIT_FLAG(value) ((value) & ACPI_3BIT_MASK)
302#define ACPI_GET_4BIT_FLAG(value) ((value) & ACPI_4BIT_MASK)
303
304/* Macros to extract flag bits from position one and above */
305
306#define ACPI_EXTRACT_1BIT_FLAG(field, position) (ACPI_GET_1BIT_FLAG ((field) >> position))
307#define ACPI_EXTRACT_2BIT_FLAG(field, position) (ACPI_GET_2BIT_FLAG ((field) >> position))
308#define ACPI_EXTRACT_3BIT_FLAG(field, position) (ACPI_GET_3BIT_FLAG ((field) >> position))
309#define ACPI_EXTRACT_4BIT_FLAG(field, position) (ACPI_GET_4BIT_FLAG ((field) >> position))
310
Bob Moore04a81dc2012-12-31 00:05:17 +0000311/* ACPI Pathname helpers */
312
313#define ACPI_IS_ROOT_PREFIX(c) ((c) == (u8) 0x5C) /* Backslash */
314#define ACPI_IS_PARENT_PREFIX(c) ((c) == (u8) 0x5E) /* Carat */
315#define ACPI_IS_PATH_SEPARATOR(c) ((c) == (u8) 0x2E) /* Period (dot) */
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317/*
Bob Moorecf489582012-07-16 09:52:27 +0800318 * An object of type struct acpi_namespace_node can appear in some contexts
319 * where a pointer to an object of type union acpi_operand_object can also
Bob Moorec9bdd802008-08-04 09:54:17 +0800320 * appear. This macro is used to distinguish them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 *
Jung-uk Kim1af89272013-03-08 09:21:54 +0000322 * The "DescriptorType" field is the second field in both structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 */
Jung-uk Kim1af89272013-03-08 09:21:54 +0000324#define ACPI_GET_DESCRIPTOR_PTR(d) (((union acpi_descriptor *)(void *)(d))->common.common_pointer)
Bob Mooref1778eb2013-03-08 09:22:03 +0000325#define ACPI_SET_DESCRIPTOR_PTR(d, p) (((union acpi_descriptor *)(void *)(d))->common.common_pointer = (p))
Bob Moore616861242006-03-17 16:44:00 -0500326#define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
Bob Mooref1778eb2013-03-08 09:22:03 +0000327#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = (t))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329/*
330 * Macros for the master AML opcode table
331 */
Bob Moorec9bdd802008-08-04 09:54:17 +0800332#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
333#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
334 {name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335#else
Bob Moorec9bdd802008-08-04 09:54:17 +0800336#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
337 {(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338#endif
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#define ARG_TYPE_WIDTH 5
341#define ARG_1(x) ((u32)(x))
342#define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH))
343#define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH))
344#define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH))
345#define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH))
346#define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH))
347
348#define ARGI_LIST1(a) (ARG_1(a))
Bob Moorec9bdd802008-08-04 09:54:17 +0800349#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a))
350#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
351#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
352#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
353#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 -0700354
355#define ARGP_LIST1(a) (ARG_1(a))
Bob Moorec9bdd802008-08-04 09:54:17 +0800356#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b))
357#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
358#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
359#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
360#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 -0700361
362#define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
363#define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
364
Bob Moore4a90c7e2006-01-13 16:22:00 -0500365/*
366 * Ascii error messages can be configured out
367 */
368#ifndef ACPI_NO_ERROR_MESSAGES
Bob Moore4a90c7e2006-01-13 16:22:00 -0500369/*
Bob Mooreb8e4d892006-01-27 16:43:00 -0500370 * Error reporting. Callers module and line number are inserted by AE_INFO,
371 * the plist contains a set of parens to allow variable-length lists.
372 * These macros are used for both the debug and non-debug versions of the code.
Bob Moore4a90c7e2006-01-13 16:22:00 -0500373 */
Bob Mooree1405ca2013-05-30 09:59:21 +0800374#define ACPI_ERROR_NAMESPACE(s, e) acpi_ut_namespace_error (AE_INFO, s, e);
375#define ACPI_ERROR_METHOD(s, n, p, e) acpi_ut_method_error (AE_INFO, s, n, p, e);
376#define ACPI_WARN_PREDEFINED(plist) acpi_ut_predefined_warning plist
377#define ACPI_INFO_PREDEFINED(plist) acpi_ut_predefined_info plist
378#define ACPI_BIOS_ERROR_PREDEFINED(plist) acpi_ut_predefined_bios_error plist
Bob Moore4a90c7e2006-01-13 16:22:00 -0500379
Bob Moore4a90c7e2006-01-13 16:22:00 -0500380#else
381
382/* No error messages */
383
Bob Moorec9bdd802008-08-04 09:54:17 +0800384#define ACPI_ERROR_NAMESPACE(s, e)
385#define ACPI_ERROR_METHOD(s, n, p, e)
Bob Moore0444e8f2009-06-24 13:38:02 +0800386#define ACPI_WARN_PREDEFINED(plist)
Bob Moore7df200c2009-11-12 09:18:45 +0800387#define ACPI_INFO_PREDEFINED(plist)
Bob Mooree1405ca2013-05-30 09:59:21 +0800388#define ACPI_BIOS_ERROR_PREDEFINED(plist)
Bob Moore7df200c2009-11-12 09:18:45 +0800389
Lv Zheng86ff0e52012-10-31 02:25:52 +0000390#endif /* ACPI_NO_ERROR_MESSAGES */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Bob Moore72a88872012-02-14 18:57:13 +0800392#if (!ACPI_REDUCED_HARDWARE)
393#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr
394#else
395#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL
396#endif
397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398/*
399 * Some code only gets executed when the debugger is built in.
400 * Note that this is entirely independent of whether the
401 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
402 */
403#ifdef ACPI_DEBUGGER
404#define ACPI_DEBUGGER_EXEC(a) a
405#else
406#define ACPI_DEBUGGER_EXEC(a)
407#endif
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/*
Lv Zheng86ff0e52012-10-31 02:25:52 +0000410 * Macros used for ACPICA utilities only
411 */
412
413/* Generate a UUID */
414
415#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
416 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
417 (b) & 0xFF, ((b) >> 8) & 0xFF, \
418 (c) & 0xFF, ((c) >> 8) & 0xFF, \
419 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
420
421#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7'))
Alexey Starikovskiy8bd108d2008-09-25 21:40:30 +0400422
Len Brown4be44fc2005-08-05 00:44:28 -0400423#endif /* ACMACROS_H */