Loading...
1/******************************************************************************
2 *
3 * Name: acmacros.h - C macros for the entire subsystem.
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef __ACMACROS_H__
45#define __ACMACROS_H__
46
47/*
48 * Extract data using a pointer. Any more than a byte and we
49 * get into potential aligment issues -- see the STORE macros below.
50 * Use with care.
51 */
52#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)
60
61/*
62 * printf() format helpers
63 */
64
65/* Split 64-bit integer into two 32-bit values. Use with %8.8_x%8.8_x */
66
67#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
68
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/*
76 * 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
85/* These macros reverse the bytes during the move, converting little-endian to big endian */
86
87 /* Big Endian <== Little Endian */
88 /* Hi...Lo Lo...Hi */
89/* 16-bit source, 16/32/64 destination */
90
91#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
92 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
93
94#define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d))=0;\
95 ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
96 ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
97
98#define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
99 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
100 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
101
102/* 32-bit source, 16/32/64 destination */
103
104#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
105
106#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
107 (( 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];}
110
111#define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
112 ((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
119#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
120
121#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
122
123#define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
124 (( 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
136#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
137
138/* The hardware supports unaligned transfers, just do the little-endian move */
139
140/* 16-bit source, 16/32/64 destination */
141
142#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)
145
146/* 32-bit source, 16/32/64 destination */
147
148#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)
151
152/* 64-bit source, 16/32/64 destination */
153
154#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)
157
158#else
159/*
160 * 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
162 * the destination (or both) is/are unaligned. (Little-endian move)
163 */
164
165/* 16-bit source, 16/32/64 destination */
166
167#define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
168 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
169
170#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);}
172
173/* 32-bit source, 16/32/64 destination */
174
175#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
176
177#define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
178 (( 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
182#define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
183
184/* 64-bit source, 16/32/64 destination */
185
186#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
187#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];\
189 (( 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
201#if ACPI_MACHINE_WIDTH == 32
202#define ACPI_MOVE_SIZE_TO_16(d, s) ACPI_MOVE_32_TO_16(d, s)
203
204#elif ACPI_MACHINE_WIDTH == 64
205#define ACPI_MOVE_SIZE_TO_16(d, s) ACPI_MOVE_64_TO_16(d, s)
206
207#else
208#error unknown ACPI_MACHINE_WIDTH
209#endif
210
211/*
212 * Fast power-of-two math macros for non-optimized compilers
213 */
214#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)))
217
218#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)
221
222#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)
225
226#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)
229
230#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)
233
234#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)
237
238/*
239 * Rounding macros (Power of two boundaries only)
240 */
241#define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \
242 (~(((acpi_size) boundary)-1)))
243
244#define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \
245 (((acpi_size) boundary)-1)) & \
246 (~(((acpi_size) boundary)-1)))
247
248/* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
249
250#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))
253
254#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))
257
258#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)
262
263/* Generic (non-power-of-two) rounding */
264
265#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
266
267#define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1))
268
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 */
275#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((u32) (position))))
276#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((u32) (position)))
277
278/* 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
283#define ACPI_INSERT_BITS(target, mask, source) target = ((target & (~(mask))) | (source & mask))
284
285/*
286 * A struct acpi_namespace_node can appear in some contexts
287 * where a pointer to a union acpi_operand_object can also
288 * appear. This macro is used to distinguish them.
289 *
290 * The "Descriptor" field is the first field in both structures.
291 */
292#define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
293#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = t)
294
295/*
296 * Macros for the master AML opcode table
297 */
298#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}
301#else
302#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
303 {(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
304#endif
305
306#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))
315#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))
320
321#define ARGP_LIST1(a) (ARG_1(a))
322#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))
327
328#define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
329#define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
330
331/*
332 * Ascii error messages can be configured out
333 */
334#ifndef ACPI_NO_ERROR_MESSAGES
335
336/*
337 * 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.
340 */
341#define ACPI_ERROR_NAMESPACE(s, e) acpi_ut_namespace_error (AE_INFO, s, e);
342#define ACPI_ERROR_METHOD(s, n, p, e) acpi_ut_method_error (AE_INFO, s, n, p, e);
343#define ACPI_WARN_PREDEFINED(plist) acpi_ut_predefined_warning plist
344#define ACPI_INFO_PREDEFINED(plist) acpi_ut_predefined_info plist
345
346#else
347
348/* No error messages */
349
350#define ACPI_ERROR_NAMESPACE(s, e)
351#define ACPI_ERROR_METHOD(s, n, p, e)
352#define ACPI_WARN_PREDEFINED(plist)
353#define ACPI_INFO_PREDEFINED(plist)
354
355#endif /* ACPI_NO_ERROR_MESSAGES */
356
357/*
358 * Debug macros that are conditionally compiled
359 */
360#ifdef ACPI_DEBUG_OUTPUT
361
362/*
363 * Function entry tracing
364 */
365#ifdef CONFIG_ACPI_DEBUG_FUNC_TRACE
366
367#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \
368 acpi_ut_trace(ACPI_DEBUG_PARAMETERS)
369#define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \
370 acpi_ut_trace_ptr(ACPI_DEBUG_PARAMETERS, (void *)b)
371#define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \
372 acpi_ut_trace_u32(ACPI_DEBUG_PARAMETERS, (u32)b)
373#define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \
374 acpi_ut_trace_str(ACPI_DEBUG_PARAMETERS, (char *)b)
375
376#define ACPI_FUNCTION_ENTRY() acpi_ut_track_stack_ptr()
377
378/*
379 * Function exit tracing.
380 * WARNING: These macros include a return statement. This is usually considered
381 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
382 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
383 * so that "_AcpiFunctionName" is defined.
384 *
385 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining
386 * about these constructs.
387 */
388#ifdef ACPI_USE_DO_WHILE_0
389#define ACPI_DO_WHILE0(a) do a while(0)
390#else
391#define ACPI_DO_WHILE0(a) a
392#endif
393
394#define return_VOID ACPI_DO_WHILE0 ({ \
395 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
396 return;})
397/*
398 * There are two versions of most of the return macros. The default version is
399 * safer, since it avoids side-effects by guaranteeing that the argument will
400 * not be evaluated twice.
401 *
402 * A less-safe version of the macros is provided for optional use if the
403 * compiler uses excessive CPU stack (for example, this may happen in the
404 * debug case if code optimzation is disabled.)
405 */
406#ifndef ACPI_SIMPLE_RETURN_MACROS
407
408#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
409 register acpi_status _s = (s); \
410 acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, _s); \
411 return (_s); })
412#define return_PTR(s) ACPI_DO_WHILE0 ({ \
413 register void *_s = (void *) (s); \
414 acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) _s); \
415 return (_s); })
416#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
417 register u64 _s = (s); \
418 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, _s); \
419 return (_s); })
420#define return_UINT8(s) ACPI_DO_WHILE0 ({ \
421 register u8 _s = (u8) (s); \
422 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (u64) _s); \
423 return (_s); })
424#define return_UINT32(s) ACPI_DO_WHILE0 ({ \
425 register u32 _s = (u32) (s); \
426 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (u64) _s); \
427 return (_s); })
428#else /* Use original less-safe macros */
429
430#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
431 acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, (s)); \
432 return((s)); })
433#define return_PTR(s) ACPI_DO_WHILE0 ({ \
434 acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) (s)); \
435 return((s)); })
436#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
437 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (u64) (s)); \
438 return((s)); })
439#define return_UINT8(s) return_VALUE(s)
440#define return_UINT32(s) return_VALUE(s)
441
442#endif /* ACPI_SIMPLE_RETURN_MACROS */
443
444#else /* !CONFIG_ACPI_DEBUG_FUNC_TRACE */
445
446#define ACPI_FUNCTION_TRACE(a)
447#define ACPI_FUNCTION_TRACE_PTR(a,b)
448#define ACPI_FUNCTION_TRACE_U32(a,b)
449#define ACPI_FUNCTION_TRACE_STR(a,b)
450#define ACPI_FUNCTION_EXIT
451#define ACPI_FUNCTION_STATUS_EXIT(s)
452#define ACPI_FUNCTION_VALUE_EXIT(s)
453#define ACPI_FUNCTION_TRACE(a)
454#define ACPI_FUNCTION_ENTRY()
455
456#define return_VOID return
457#define return_ACPI_STATUS(s) return(s)
458#define return_VALUE(s) return(s)
459#define return_UINT8(s) return(s)
460#define return_UINT32(s) return(s)
461#define return_PTR(s) return(s)
462
463#endif /* CONFIG_ACPI_DEBUG_FUNC_TRACE */
464
465/* Conditional execution */
466
467#define ACPI_DEBUG_EXEC(a) a
468#define ACPI_NORMAL_EXEC(a)
469
470#define ACPI_DEBUG_DEFINE(a) a;
471#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
472#define _VERBOSE_STRUCTURES
473
474/* Stack and buffer dumping */
475
476#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
477#define ACPI_DUMP_OPERANDS(a, b, c) acpi_ex_dump_operands(a, b, c)
478
479#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
480#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
481#define ACPI_DUMP_RESOURCE_LIST(a) acpi_rs_dump_resource_list(a)
482#define ACPI_DUMP_BUFFER(a, b) acpi_ut_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
483
484#else
485/*
486 * This is the non-debug case -- make everything go away,
487 * leaving no executable debug code!
488 */
489#define ACPI_DEBUG_EXEC(a)
490#define ACPI_NORMAL_EXEC(a) a;
491
492#define ACPI_DEBUG_DEFINE(a) do { } while(0)
493#define ACPI_DEBUG_ONLY_MEMBERS(a) do { } while(0)
494#define ACPI_FUNCTION_TRACE(a) do { } while(0)
495#define ACPI_FUNCTION_TRACE_PTR(a, b) do { } while(0)
496#define ACPI_FUNCTION_TRACE_U32(a, b) do { } while(0)
497#define ACPI_FUNCTION_TRACE_STR(a, b) do { } while(0)
498#define ACPI_FUNCTION_EXIT do { } while(0)
499#define ACPI_FUNCTION_STATUS_EXIT(s) do { } while(0)
500#define ACPI_FUNCTION_VALUE_EXIT(s) do { } while(0)
501#define ACPI_FUNCTION_ENTRY() do { } while(0)
502#define ACPI_DUMP_STACK_ENTRY(a) do { } while(0)
503#define ACPI_DUMP_OPERANDS(a, b, c) do { } while(0)
504#define ACPI_DUMP_ENTRY(a, b) do { } while(0)
505#define ACPI_DUMP_TABLES(a, b) do { } while(0)
506#define ACPI_DUMP_PATHNAME(a, b, c, d) do { } while(0)
507#define ACPI_DUMP_RESOURCE_LIST(a) do { } while(0)
508#define ACPI_DUMP_BUFFER(a, b) do { } while(0)
509
510#define return_VOID return
511#define return_ACPI_STATUS(s) return(s)
512#define return_VALUE(s) return(s)
513#define return_UINT8(s) return(s)
514#define return_UINT32(s) return(s)
515#define return_PTR(s) return(s)
516
517#endif /* ACPI_DEBUG_OUTPUT */
518
519#if (!ACPI_REDUCED_HARDWARE)
520#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr
521#else
522#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL
523#endif
524
525/*
526 * Some code only gets executed when the debugger is built in.
527 * Note that this is entirely independent of whether the
528 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
529 */
530#ifdef ACPI_DEBUGGER
531#define ACPI_DEBUGGER_EXEC(a) a
532#else
533#define ACPI_DEBUGGER_EXEC(a)
534#endif
535
536#ifdef ACPI_DEBUG_OUTPUT
537/*
538 * 1) Set name to blanks
539 * 2) Copy the object name
540 */
541#define ACPI_ADD_OBJECT_NAME(a,b) ACPI_MEMSET (a->common.name, ' ', sizeof (a->common.name));\
542 ACPI_STRNCPY (a->common.name, acpi_gbl_ns_type_names[b], sizeof (a->common.name))
543#else
544
545#define ACPI_ADD_OBJECT_NAME(a,b)
546#endif
547
548/*
549 * Memory allocation tracking (DEBUG ONLY)
550 */
551#define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
552
553#ifndef ACPI_DBG_TRACK_ALLOCATIONS
554
555/* Memory allocation */
556
557#ifndef ACPI_ALLOCATE
558#define ACPI_ALLOCATE(a) acpi_ut_allocate((acpi_size)(a), ACPI_MEM_PARAMETERS)
559#endif
560#ifndef ACPI_ALLOCATE_ZEROED
561#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed((acpi_size)(a), ACPI_MEM_PARAMETERS)
562#endif
563#ifndef ACPI_FREE
564#define ACPI_FREE(a) acpio_os_free(a)
565#endif
566#define ACPI_MEM_TRACKING(a)
567
568#else
569
570/* Memory allocation */
571
572#define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track((acpi_size)(a), ACPI_MEM_PARAMETERS)
573#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track((acpi_size)(a), ACPI_MEM_PARAMETERS)
574#define ACPI_FREE(a) acpi_ut_free_and_track(a, ACPI_MEM_PARAMETERS)
575#define ACPI_MEM_TRACKING(a) a
576
577#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
578
579/* Preemption point */
580#ifndef ACPI_PREEMPTION_POINT
581#define ACPI_PREEMPTION_POINT() /* no preemption */
582#endif
583
584#endif /* ACMACROS_H */
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 */