1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
3  *
4  * Name: acmacros.h - C macros for the entire subsystem.
5  *
6  * Copyright (C) 2000 - 2023, Intel Corp.
7  *
8  *****************************************************************************/
9 
10 #ifndef __ACMACROS_H__
11 #define __ACMACROS_H__
12 
13 /*
14  * Extract data using a pointer. Any more than a byte and we
15  * get into potential alignment issues -- see the STORE macros below.
16  * Use with care.
17  */
18 #define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (u8, (ptr))
19 #define ACPI_CAST16(ptr)                ACPI_CAST_PTR (u16, (ptr))
20 #define ACPI_CAST32(ptr)                ACPI_CAST_PTR (u32, (ptr))
21 #define ACPI_CAST64(ptr)                ACPI_CAST_PTR (u64, (ptr))
22 #define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
23 #define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
24 #define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
25 #define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
26 #define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (u8) (val))
27 #define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (u16) (val))
28 #define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (u32) (val))
29 #define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (u64) (val))
30 
31 /*
32  * printf() format helper. This macro is a workaround for the difficulties
33  * with emitting 64-bit integers and 64-bit pointers with the same code
34  * for both 32-bit and 64-bit hosts.
35  */
36 #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
37 
38 /*
39  * Macros for moving data around to/from buffers that are possibly unaligned.
40  * If the hardware supports the transfer of unaligned data, just do the store.
41  * Otherwise, we have to move one byte at a time.
42  */
43 #ifdef ACPI_BIG_ENDIAN
44 /*
45  * Macros for big-endian machines
46  */
47 
48 /* These macros reverse the bytes during the move, converting little-endian to big endian */
49 
50 	 /* Big Endian      <==        Little Endian */
51 	 /*  Hi...Lo                     Lo...Hi     */
52 /* 16-bit source, 16/32/64 destination */
53 
54 #define ACPI_MOVE_16_TO_16(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
55 			  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
56 
57 #define ACPI_MOVE_16_TO_32(d, s)        {(*(u32 *)(void *)(d))=0;\
58 					  ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
59 					  ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
60 
61 #define ACPI_MOVE_16_TO_64(d, s)        {(*(u64 *)(void *)(d))=0;\
62 							   ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
63 							   ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
64 
65 /* 32-bit source, 16/32/64 destination */
66 
67 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
68 
69 #define ACPI_MOVE_32_TO_32(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
70 									  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
71 									  ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
72 									  ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
73 
74 #define ACPI_MOVE_32_TO_64(d, s)        {(*(u64 *)(void *)(d))=0;\
75 										   ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
76 										   ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
77 										   ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
78 										   ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
79 
80 /* 64-bit source, 16/32/64 destination */
81 
82 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
83 
84 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)	/* Truncate to 32 */
85 
86 #define ACPI_MOVE_64_TO_64(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
87 										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
88 										 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
89 										 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
90 										 ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
91 										 ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
92 										 ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
93 										 ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
94 #else
95 /*
96  * Macros for little-endian machines
97  */
98 
99 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
100 
101 /* The hardware supports unaligned transfers, just do the little-endian move */
102 
103 /* 16-bit source, 16/32/64 destination */
104 
105 #define ACPI_MOVE_16_TO_16(d, s)        *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
106 #define ACPI_MOVE_16_TO_32(d, s)        *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
107 #define ACPI_MOVE_16_TO_64(d, s)        *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
108 
109 /* 32-bit source, 16/32/64 destination */
110 
111 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
112 #define ACPI_MOVE_32_TO_32(d, s)        *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
113 #define ACPI_MOVE_32_TO_64(d, s)        *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
114 
115 /* 64-bit source, 16/32/64 destination */
116 
117 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
118 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)	/* Truncate to 32 */
119 #define ACPI_MOVE_64_TO_64(d, s)        *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
120 
121 #else
122 /*
123  * The hardware does not support unaligned transfers. We must move the
124  * data one byte at a time. These macros work whether the source or
125  * the destination (or both) is/are unaligned. (Little-endian move)
126  */
127 
128 /* 16-bit source, 16/32/64 destination */
129 
130 #define ACPI_MOVE_16_TO_16(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
131 										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
132 
133 #define ACPI_MOVE_16_TO_32(d, s)        {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
134 #define ACPI_MOVE_16_TO_64(d, s)        {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
135 
136 /* 32-bit source, 16/32/64 destination */
137 
138 #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
139 
140 #define ACPI_MOVE_32_TO_32(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
141 										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
142 										 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
143 										 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
144 
145 #define ACPI_MOVE_32_TO_64(d, s)        {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
146 
147 /* 64-bit source, 16/32/64 destination */
148 
149 #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
150 #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)	/* Truncate to 32 */
151 #define ACPI_MOVE_64_TO_64(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
152 										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
153 										 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
154 										 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
155 										 ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
156 										 ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
157 										 ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
158 										 ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
159 #endif
160 #endif
161 
162 /*
163  * Fast power-of-two math macros for non-optimized compilers
164  */
165 #define _ACPI_DIV(value, power_of2)     ((u32) ((value) >> (power_of2)))
166 #define _ACPI_MUL(value, power_of2)     ((u32) ((value) << (power_of2)))
167 #define _ACPI_MOD(value, divisor)       ((u32) ((value) & ((divisor) -1)))
168 
169 #define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
170 #define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
171 #define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
172 
173 #define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
174 #define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
175 #define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
176 
177 #define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
178 #define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
179 #define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
180 
181 #define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
182 #define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
183 #define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
184 
185 #define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
186 #define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
187 #define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
188 
189 /* Test for ASCII character */
190 
191 #define ACPI_IS_ASCII(c)                ((c) < 0x80)
192 
193 /* Signed integers */
194 
195 #define ACPI_SIGN_POSITIVE              0
196 #define ACPI_SIGN_NEGATIVE              1
197 
198 /*
199  * Rounding macros (Power of two boundaries only)
200  */
201 #define ACPI_ROUND_DOWN(value, boundary)    (((acpi_size)(value)) & \
202 												(~(((acpi_size) boundary)-1)))
203 
204 #define ACPI_ROUND_UP(value, boundary)      ((((acpi_size)(value)) + \
205 												(((acpi_size) boundary)-1)) & \
206 												(~(((acpi_size) boundary)-1)))
207 
208 /* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
209 
210 #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
211 #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
212 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(acpi_size))
213 
214 #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
215 #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
216 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(acpi_size))
217 
218 #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
219 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
220 
221 #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
222 
223 /* Generic (non-power-of-two) rounding */
224 
225 #define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
226 
227 #define ACPI_IS_MISALIGNED(value)           (((acpi_size) value) & (sizeof(acpi_size)-1))
228 
229 /* Generic bit manipulation */
230 
231 #ifndef ACPI_USE_NATIVE_BIT_FINDER
232 
233 #define __ACPI_FIND_LAST_BIT_2(a, r)        ((((u8)  (a)) & 0x02) ? (r)+1 : (r))
234 #define __ACPI_FIND_LAST_BIT_4(a, r)        ((((u8)  (a)) & 0x0C) ? \
235 											 __ACPI_FIND_LAST_BIT_2  ((a)>>2,  (r)+2) : \
236 											 __ACPI_FIND_LAST_BIT_2  ((a), (r)))
237 #define __ACPI_FIND_LAST_BIT_8(a, r)        ((((u8)  (a)) & 0xF0) ? \
238 											 __ACPI_FIND_LAST_BIT_4  ((a)>>4,  (r)+4) : \
239 											 __ACPI_FIND_LAST_BIT_4  ((a), (r)))
240 #define __ACPI_FIND_LAST_BIT_16(a, r)       ((((u16) (a)) & 0xFF00) ? \
241 											 __ACPI_FIND_LAST_BIT_8  ((a)>>8,  (r)+8) : \
242 											 __ACPI_FIND_LAST_BIT_8  ((a), (r)))
243 #define __ACPI_FIND_LAST_BIT_32(a, r)       ((((u32) (a)) & 0xFFFF0000) ? \
244 											 __ACPI_FIND_LAST_BIT_16 ((a)>>16, (r)+16) : \
245 											 __ACPI_FIND_LAST_BIT_16 ((a), (r)))
246 #define __ACPI_FIND_LAST_BIT_64(a, r)       ((((u64) (a)) & 0xFFFFFFFF00000000) ? \
247 											 __ACPI_FIND_LAST_BIT_32 ((a)>>32, (r)+32) : \
248 											 __ACPI_FIND_LAST_BIT_32 ((a), (r)))
249 
250 #define ACPI_FIND_LAST_BIT_8(a)             ((a) ? __ACPI_FIND_LAST_BIT_8 (a, 1) : 0)
251 #define ACPI_FIND_LAST_BIT_16(a)            ((a) ? __ACPI_FIND_LAST_BIT_16 (a, 1) : 0)
252 #define ACPI_FIND_LAST_BIT_32(a)            ((a) ? __ACPI_FIND_LAST_BIT_32 (a, 1) : 0)
253 #define ACPI_FIND_LAST_BIT_64(a)            ((a) ? __ACPI_FIND_LAST_BIT_64 (a, 1) : 0)
254 
255 #define __ACPI_FIND_FIRST_BIT_2(a, r)       ((((u8) (a)) & 0x01) ? (r) : (r)+1)
256 #define __ACPI_FIND_FIRST_BIT_4(a, r)       ((((u8) (a)) & 0x03) ? \
257 											 __ACPI_FIND_FIRST_BIT_2  ((a), (r)) : \
258 											 __ACPI_FIND_FIRST_BIT_2  ((a)>>2, (r)+2))
259 #define __ACPI_FIND_FIRST_BIT_8(a, r)       ((((u8) (a)) & 0x0F) ? \
260 											 __ACPI_FIND_FIRST_BIT_4  ((a), (r)) : \
261 											 __ACPI_FIND_FIRST_BIT_4  ((a)>>4, (r)+4))
262 #define __ACPI_FIND_FIRST_BIT_16(a, r)      ((((u16) (a)) & 0x00FF) ? \
263 											 __ACPI_FIND_FIRST_BIT_8  ((a), (r)) : \
264 											 __ACPI_FIND_FIRST_BIT_8  ((a)>>8, (r)+8))
265 #define __ACPI_FIND_FIRST_BIT_32(a, r)      ((((u32) (a)) & 0x0000FFFF) ? \
266 											 __ACPI_FIND_FIRST_BIT_16 ((a), (r)) : \
267 											 __ACPI_FIND_FIRST_BIT_16 ((a)>>16, (r)+16))
268 #define __ACPI_FIND_FIRST_BIT_64(a, r)      ((((u64) (a)) & 0x00000000FFFFFFFF) ? \
269 											 __ACPI_FIND_FIRST_BIT_32 ((a), (r)) : \
270 											 __ACPI_FIND_FIRST_BIT_32 ((a)>>32, (r)+32))
271 
272 #define ACPI_FIND_FIRST_BIT_8(a)            ((a) ? __ACPI_FIND_FIRST_BIT_8 (a, 1) : 0)
273 #define ACPI_FIND_FIRST_BIT_16(a)           ((a) ? __ACPI_FIND_FIRST_BIT_16 (a, 1) : 0)
274 #define ACPI_FIND_FIRST_BIT_32(a)           ((a) ? __ACPI_FIND_FIRST_BIT_32 (a, 1) : 0)
275 #define ACPI_FIND_FIRST_BIT_64(a)           ((a) ? __ACPI_FIND_FIRST_BIT_64 (a, 1) : 0)
276 
277 #endif				/* ACPI_USE_NATIVE_BIT_FINDER */
278 
279 /* Generic (power-of-two) rounding */
280 
281 #define ACPI_ROUND_UP_POWER_OF_TWO_8(a)     ((u8) \
282 											(((u16) 1) <<  ACPI_FIND_LAST_BIT_8  ((a)  - 1)))
283 #define ACPI_ROUND_DOWN_POWER_OF_TWO_8(a)   ((u8) \
284 											(((u16) 1) << (ACPI_FIND_LAST_BIT_8  ((a)) - 1)))
285 #define ACPI_ROUND_UP_POWER_OF_TWO_16(a)    ((u16) \
286 											(((u32) 1) <<  ACPI_FIND_LAST_BIT_16 ((a)  - 1)))
287 #define ACPI_ROUND_DOWN_POWER_OF_TWO_16(a)  ((u16) \
288 											(((u32) 1) << (ACPI_FIND_LAST_BIT_16 ((a)) - 1)))
289 #define ACPI_ROUND_UP_POWER_OF_TWO_32(a)    ((u32) \
290 											(((u64) 1) <<  ACPI_FIND_LAST_BIT_32 ((a)  - 1)))
291 #define ACPI_ROUND_DOWN_POWER_OF_TWO_32(a)  ((u32) \
292 											(((u64) 1) << (ACPI_FIND_LAST_BIT_32 ((a)) - 1)))
293 #define ACPI_IS_ALIGNED(a, s)               (((a) & ((s) - 1)) == 0)
294 #define ACPI_IS_POWER_OF_TWO(a)             ACPI_IS_ALIGNED(a, a)
295 
296 /*
297  * Bitmask creation
298  * Bit positions start at zero.
299  * MASK_BITS_ABOVE creates a mask starting AT the position and above
300  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
301  * MASK_BITS_ABOVE/BELOW accepts a bit offset to create a mask
302  * MASK_BITS_ABOVE/BELOW_32/64 accepts a bit width to create a mask
303  * Note: The ACPI_INTEGER_BIT_SIZE check is used to bypass compiler
304  * differences with the shift operator
305  */
306 #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((u32) (position))))
307 #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((u32) (position)))
308 #define ACPI_MASK_BITS_ABOVE_32(width)      ((u32) ACPI_MASK_BITS_ABOVE(width))
309 #define ACPI_MASK_BITS_BELOW_32(width)      ((u32) ACPI_MASK_BITS_BELOW(width))
310 #define ACPI_MASK_BITS_ABOVE_64(width)      ((width) == ACPI_INTEGER_BIT_SIZE ? \
311 												ACPI_UINT64_MAX : \
312 												ACPI_MASK_BITS_ABOVE(width))
313 #define ACPI_MASK_BITS_BELOW_64(width)      ((width) == ACPI_INTEGER_BIT_SIZE ? \
314 												(u64) 0 : \
315 												ACPI_MASK_BITS_BELOW(width))
316 
317 /* Bitfields within ACPI registers */
318 
319 #define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
320 	((val << pos) & mask)
321 
322 #define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \
323 	reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
324 
325 #define ACPI_INSERT_BITS(target, mask, source) \
326 	target = ((target & (~(mask))) | (source & mask))
327 
328 /* Generic bitfield macros and masks */
329 
330 #define ACPI_GET_BITS(source_ptr, position, mask) \
331 	((*(source_ptr) >> (position)) & (mask))
332 
333 #define ACPI_SET_BITS(target_ptr, position, mask, value) \
334 	(*(target_ptr) |= (((value) & (mask)) << (position)))
335 
336 #define ACPI_1BIT_MASK      0x00000001
337 #define ACPI_2BIT_MASK      0x00000003
338 #define ACPI_3BIT_MASK      0x00000007
339 #define ACPI_4BIT_MASK      0x0000000F
340 #define ACPI_5BIT_MASK      0x0000001F
341 #define ACPI_6BIT_MASK      0x0000003F
342 #define ACPI_7BIT_MASK      0x0000007F
343 #define ACPI_8BIT_MASK      0x000000FF
344 #define ACPI_16BIT_MASK     0x0000FFFF
345 #define ACPI_24BIT_MASK     0x00FFFFFF
346 
347 /* Macros to extract flag bits from position zero */
348 
349 #define ACPI_GET_1BIT_FLAG(value)                   ((value) & ACPI_1BIT_MASK)
350 #define ACPI_GET_2BIT_FLAG(value)                   ((value) & ACPI_2BIT_MASK)
351 #define ACPI_GET_3BIT_FLAG(value)                   ((value) & ACPI_3BIT_MASK)
352 #define ACPI_GET_4BIT_FLAG(value)                   ((value) & ACPI_4BIT_MASK)
353 
354 /* Macros to extract flag bits from position one and above */
355 
356 #define ACPI_EXTRACT_1BIT_FLAG(field, position)     (ACPI_GET_1BIT_FLAG ((field) >> position))
357 #define ACPI_EXTRACT_2BIT_FLAG(field, position)     (ACPI_GET_2BIT_FLAG ((field) >> position))
358 #define ACPI_EXTRACT_3BIT_FLAG(field, position)     (ACPI_GET_3BIT_FLAG ((field) >> position))
359 #define ACPI_EXTRACT_4BIT_FLAG(field, position)     (ACPI_GET_4BIT_FLAG ((field) >> position))
360 
361 /* ACPI Pathname helpers */
362 
363 #define ACPI_IS_ROOT_PREFIX(c)      ((c) == (u8) 0x5C)	/* Backslash */
364 #define ACPI_IS_PARENT_PREFIX(c)    ((c) == (u8) 0x5E)	/* Carat */
365 #define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (u8) 0x2E)	/* Period (dot) */
366 
367 /*
368  * An object of type struct acpi_namespace_node can appear in some contexts
369  * where a pointer to an object of type union acpi_operand_object can also
370  * appear. This macro is used to distinguish them.
371  *
372  * The "DescriptorType" field is the second field in both structures.
373  */
374 #define ACPI_GET_DESCRIPTOR_PTR(d)      (((union acpi_descriptor *)(void *)(d))->common.common_pointer)
375 #define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((union acpi_descriptor *)(void *)(d))->common.common_pointer = (p))
376 #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
377 #define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = (t))
378 
379 /*
380  * Macros for the master AML opcode table
381  */
382 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
383 #define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
384 	{name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
385 #else
386 #define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
387 	{(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
388 #endif
389 
390 #define ARG_TYPE_WIDTH                  5
391 #define ARG_1(x)                        ((u32)(x))
392 #define ARG_2(x)                        ((u32)(x) << (1 * ARG_TYPE_WIDTH))
393 #define ARG_3(x)                        ((u32)(x) << (2 * ARG_TYPE_WIDTH))
394 #define ARG_4(x)                        ((u32)(x) << (3 * ARG_TYPE_WIDTH))
395 #define ARG_5(x)                        ((u32)(x) << (4 * ARG_TYPE_WIDTH))
396 #define ARG_6(x)                        ((u32)(x) << (5 * ARG_TYPE_WIDTH))
397 
398 #define ARGI_LIST1(a)                   (ARG_1(a))
399 #define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
400 #define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
401 #define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
402 #define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
403 #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))
404 
405 #define ARGP_LIST1(a)                   (ARG_1(a))
406 #define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
407 #define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
408 #define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
409 #define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
410 #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))
411 
412 #define GET_CURRENT_ARG_TYPE(list)      (list & ((u32) 0x1F))
413 #define INCREMENT_ARG_LIST(list)        (list >>= ((u32) ARG_TYPE_WIDTH))
414 
415 /*
416  * Ascii error messages can be configured out
417  */
418 #ifndef ACPI_NO_ERROR_MESSAGES
419 /*
420  * Error reporting. The callers module and line number are inserted by AE_INFO,
421  * the plist contains a set of parens to allow variable-length lists.
422  * These macros are used for both the debug and non-debug versions of the code.
423  */
424 #define ACPI_ERROR_NAMESPACE(s, p, e)       acpi_ut_prefixed_namespace_error (AE_INFO, s, p, e);
425 #define ACPI_ERROR_METHOD(s, n, p, e)       acpi_ut_method_error (AE_INFO, s, n, p, e);
426 #define ACPI_WARN_PREDEFINED(plist)         acpi_ut_predefined_warning plist
427 #define ACPI_INFO_PREDEFINED(plist)         acpi_ut_predefined_info plist
428 #define ACPI_BIOS_ERROR_PREDEFINED(plist)   acpi_ut_predefined_bios_error plist
429 #define ACPI_ERROR_ONLY(s)                  s
430 
431 #else
432 
433 /* No error messages */
434 
435 #define ACPI_ERROR_NAMESPACE(s, p, e)
436 #define ACPI_ERROR_METHOD(s, n, p, e)
437 #define ACPI_WARN_PREDEFINED(plist)
438 #define ACPI_INFO_PREDEFINED(plist)
439 #define ACPI_BIOS_ERROR_PREDEFINED(plist)
440 #define ACPI_ERROR_ONLY(s)
441 
442 #endif				/* ACPI_NO_ERROR_MESSAGES */
443 
444 #if (!ACPI_REDUCED_HARDWARE)
445 #define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
446 #else
447 #define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
448 #endif
449 
450 /*
451  * Macros used for ACPICA utilities only
452  */
453 
454 /* Generate a UUID */
455 
456 #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
457 	(a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
458 	(b) & 0xFF, ((b) >> 8) & 0xFF, \
459 	(c) & 0xFF, ((c) >> 8) & 0xFF, \
460 	(d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
461 
462 #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
463 
464 /*
465  * Macros used for the ASL-/ASL+ converter utility
466  */
467 #ifdef ACPI_ASL_COMPILER
468 
469 #define ASL_CV_LABEL_FILENODE(a)         cv_label_file_node(a);
470 #define ASL_CV_CAPTURE_COMMENTS_ONLY(a)   cv_capture_comments_only (a);
471 #define ASL_CV_CAPTURE_COMMENTS(a)       cv_capture_comments (a);
472 #define ASL_CV_TRANSFER_COMMENTS(a)      cv_transfer_comments (a);
473 #define ASL_CV_CLOSE_PAREN(a,b)          cv_close_paren_write_comment(a,b);
474 #define ASL_CV_CLOSE_BRACE(a,b)          cv_close_brace_write_comment(a,b);
475 #define ASL_CV_SWITCH_FILES(a,b)         cv_switch_files(a,b);
476 #define ASL_CV_CLEAR_OP_COMMENTS(a)       cv_clear_op_comments(a);
477 #define ASL_CV_PRINT_ONE_COMMENT(a,b,c,d) cv_print_one_comment_type (a,b,c,d);
478 #define ASL_CV_PRINT_ONE_COMMENT_LIST(a,b) cv_print_one_comment_list (a,b);
479 #define ASL_CV_FILE_HAS_SWITCHED(a)       cv_file_has_switched(a)
480 #define ASL_CV_INIT_FILETREE(a,b)      cv_init_file_tree(a,b);
481 
482 #else
483 
484 #define ASL_CV_LABEL_FILENODE(a)
485 #define ASL_CV_CAPTURE_COMMENTS_ONLY(a)
486 #define ASL_CV_CAPTURE_COMMENTS(a)
487 #define ASL_CV_TRANSFER_COMMENTS(a)
488 #define ASL_CV_CLOSE_PAREN(a,b)          acpi_os_printf (")");
489 #define ASL_CV_CLOSE_BRACE(a,b)          acpi_os_printf ("}");
490 #define ASL_CV_SWITCH_FILES(a,b)
491 #define ASL_CV_CLEAR_OP_COMMENTS(a)
492 #define ASL_CV_PRINT_ONE_COMMENT(a,b,c,d)
493 #define ASL_CV_PRINT_ONE_COMMENT_LIST(a,b)
494 #define ASL_CV_FILE_HAS_SWITCHED(a)       0
495 #define ASL_CV_INIT_FILETREE(a,b)
496 
497 #endif
498 
499 #endif				/* ACMACROS_H */
500