1a9f12690SJung-uk Kim /******************************************************************************
2a9f12690SJung-uk Kim  *
3a9f12690SJung-uk Kim  * Name: acmacros.h - C macros for the entire subsystem.
4a9f12690SJung-uk Kim  *
5a9f12690SJung-uk Kim  *****************************************************************************/
6a9f12690SJung-uk Kim 
7d244b227SJung-uk Kim /*
8313a0c13SJung-uk Kim  * Copyright (C) 2000 - 2014, Intel Corp.
9a9f12690SJung-uk Kim  * All rights reserved.
10a9f12690SJung-uk Kim  *
11d244b227SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
12d244b227SJung-uk Kim  * modification, are permitted provided that the following conditions
13d244b227SJung-uk Kim  * are met:
14d244b227SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
15d244b227SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
16d244b227SJung-uk Kim  *    without modification.
17d244b227SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18d244b227SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
19d244b227SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
20d244b227SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
21d244b227SJung-uk Kim  *    binary redistribution.
22d244b227SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
23d244b227SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
24d244b227SJung-uk Kim  *    from this software without specific prior written permission.
25a9f12690SJung-uk Kim  *
26d244b227SJung-uk Kim  * Alternatively, this software may be distributed under the terms of the
27d244b227SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
28d244b227SJung-uk Kim  * Software Foundation.
29a9f12690SJung-uk Kim  *
30d244b227SJung-uk Kim  * NO WARRANTY
31d244b227SJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32d244b227SJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33d244b227SJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34d244b227SJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35d244b227SJung-uk Kim  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36d244b227SJung-uk Kim  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37d244b227SJung-uk Kim  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38d244b227SJung-uk Kim  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39d244b227SJung-uk Kim  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40d244b227SJung-uk Kim  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41d244b227SJung-uk Kim  * POSSIBILITY OF SUCH DAMAGES.
42d244b227SJung-uk Kim  */
43a9f12690SJung-uk Kim 
44a9f12690SJung-uk Kim #ifndef __ACMACROS_H__
45a9f12690SJung-uk Kim #define __ACMACROS_H__
46a9f12690SJung-uk Kim 
47a9f12690SJung-uk Kim 
48a9f12690SJung-uk Kim /*
49a9f12690SJung-uk Kim  * Extract data using a pointer. Any more than a byte and we
50a9f12690SJung-uk Kim  * get into potential aligment issues -- see the STORE macros below.
51a9f12690SJung-uk Kim  * Use with care.
52a9f12690SJung-uk Kim  */
53ed17e06eSJung-uk Kim #define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (UINT8, (ptr))
54ed17e06eSJung-uk Kim #define ACPI_CAST16(ptr)                ACPI_CAST_PTR (UINT16, (ptr))
55ed17e06eSJung-uk Kim #define ACPI_CAST32(ptr)                ACPI_CAST_PTR (UINT32, (ptr))
56ed17e06eSJung-uk Kim #define ACPI_CAST64(ptr)                ACPI_CAST_PTR (UINT64, (ptr))
57ed17e06eSJung-uk Kim #define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
58ed17e06eSJung-uk Kim #define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
59ed17e06eSJung-uk Kim #define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
60ed17e06eSJung-uk Kim #define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
61ed17e06eSJung-uk Kim #define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (UINT8) (val))
62ed17e06eSJung-uk Kim #define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (UINT16) (val))
63ed17e06eSJung-uk Kim #define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (UINT32) (val))
64ed17e06eSJung-uk Kim #define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (UINT64) (val))
65a9f12690SJung-uk Kim 
66a9f12690SJung-uk Kim /*
67313a0c13SJung-uk Kim  * printf() format helpers. These macros are workarounds for the difficulties
68313a0c13SJung-uk Kim  * with emitting 64-bit integers and 64-bit pointers with the same code
69313a0c13SJung-uk Kim  * for both 32-bit and 64-bit hosts.
70a9f12690SJung-uk Kim  */
71a9f12690SJung-uk Kim #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
72a9f12690SJung-uk Kim 
73a9f12690SJung-uk Kim #if ACPI_MACHINE_WIDTH == 64
74a9f12690SJung-uk Kim #define ACPI_FORMAT_NATIVE_UINT(i)      ACPI_FORMAT_UINT64(i)
75313a0c13SJung-uk Kim #define ACPI_FORMAT_TO_UINT(i)          ACPI_FORMAT_UINT64(i)
76313a0c13SJung-uk Kim #define ACPI_PRINTF_UINT                 "0x%8.8X%8.8X"
77313a0c13SJung-uk Kim 
78a9f12690SJung-uk Kim #else
79313a0c13SJung-uk Kim #define ACPI_FORMAT_NATIVE_UINT(i)      0, (UINT32) (i)
80313a0c13SJung-uk Kim #define ACPI_FORMAT_TO_UINT(i)          (UINT32) (i)
81313a0c13SJung-uk Kim #define ACPI_PRINTF_UINT                 "0x%8.8X"
82a9f12690SJung-uk Kim #endif
83a9f12690SJung-uk Kim 
84a9f12690SJung-uk Kim 
85a9f12690SJung-uk Kim /*
86a9f12690SJung-uk Kim  * Macros for moving data around to/from buffers that are possibly unaligned.
87a9f12690SJung-uk Kim  * If the hardware supports the transfer of unaligned data, just do the store.
88a9f12690SJung-uk Kim  * Otherwise, we have to move one byte at a time.
89a9f12690SJung-uk Kim  */
90a9f12690SJung-uk Kim #ifdef ACPI_BIG_ENDIAN
91a9f12690SJung-uk Kim /*
92a9f12690SJung-uk Kim  * Macros for big-endian machines
93a9f12690SJung-uk Kim  */
94a9f12690SJung-uk Kim 
95a9f12690SJung-uk Kim /* These macros reverse the bytes during the move, converting little-endian to big endian */
96a9f12690SJung-uk Kim 
97a9f12690SJung-uk Kim                                                      /* Big Endian      <==        Little Endian */
98a9f12690SJung-uk Kim                                                      /*  Hi...Lo                     Lo...Hi     */
99a9f12690SJung-uk Kim /* 16-bit source, 16/32/64 destination */
100a9f12690SJung-uk Kim 
101a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
102a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
103a9f12690SJung-uk Kim 
104a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d))=0;\
105a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
106a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
107a9f12690SJung-uk Kim 
108a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
109a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
110a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
111a9f12690SJung-uk Kim 
112a9f12690SJung-uk Kim /* 32-bit source, 16/32/64 destination */
113a9f12690SJung-uk Kim 
114a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
115a9f12690SJung-uk Kim 
116a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
117a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
118a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
119a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
120a9f12690SJung-uk Kim 
121a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
122a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
123a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
124a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
125a9f12690SJung-uk Kim                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
126a9f12690SJung-uk Kim 
127a9f12690SJung-uk Kim /* 64-bit source, 16/32/64 destination */
128a9f12690SJung-uk Kim 
129a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
130a9f12690SJung-uk Kim 
131a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
132a9f12690SJung-uk Kim 
133a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
134a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
135a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
136a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
137a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
138a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
139a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
140a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
141a9f12690SJung-uk Kim #else
142a9f12690SJung-uk Kim /*
143a9f12690SJung-uk Kim  * Macros for little-endian machines
144a9f12690SJung-uk Kim  */
145a9f12690SJung-uk Kim 
146a9f12690SJung-uk Kim #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
147a9f12690SJung-uk Kim 
148a9f12690SJung-uk Kim /* The hardware supports unaligned transfers, just do the little-endian move */
149a9f12690SJung-uk Kim 
150a9f12690SJung-uk Kim /* 16-bit source, 16/32/64 destination */
151a9f12690SJung-uk Kim 
152a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_16(d, s)        *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
153a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
154a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
155a9f12690SJung-uk Kim 
156a9f12690SJung-uk Kim /* 32-bit source, 16/32/64 destination */
157a9f12690SJung-uk Kim 
158a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
159a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
160a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
161a9f12690SJung-uk Kim 
162a9f12690SJung-uk Kim /* 64-bit source, 16/32/64 destination */
163a9f12690SJung-uk Kim 
164a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
165a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
166a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
167a9f12690SJung-uk Kim 
168a9f12690SJung-uk Kim #else
169a9f12690SJung-uk Kim /*
170a9f12690SJung-uk Kim  * The hardware does not support unaligned transfers. We must move the
171a9f12690SJung-uk Kim  * data one byte at a time. These macros work whether the source or
172a9f12690SJung-uk Kim  * the destination (or both) is/are unaligned. (Little-endian move)
173a9f12690SJung-uk Kim  */
174a9f12690SJung-uk Kim 
175a9f12690SJung-uk Kim /* 16-bit source, 16/32/64 destination */
176a9f12690SJung-uk Kim 
177a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
178a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
179a9f12690SJung-uk Kim 
180a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
181a9f12690SJung-uk Kim #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
182a9f12690SJung-uk Kim 
183a9f12690SJung-uk Kim /* 32-bit source, 16/32/64 destination */
184a9f12690SJung-uk Kim 
185a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
186a9f12690SJung-uk Kim 
187a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
188a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
189a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
190a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
191a9f12690SJung-uk Kim 
192a9f12690SJung-uk Kim #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
193a9f12690SJung-uk Kim 
194a9f12690SJung-uk Kim /* 64-bit source, 16/32/64 destination */
195a9f12690SJung-uk Kim 
196a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
197a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
198a9f12690SJung-uk Kim #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
199a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
200a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
201a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
202a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
203a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
204a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
205a9f12690SJung-uk Kim                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
206a9f12690SJung-uk Kim #endif
207a9f12690SJung-uk Kim #endif
208a9f12690SJung-uk Kim 
209a9f12690SJung-uk Kim 
210a9f12690SJung-uk Kim /*
211a9f12690SJung-uk Kim  * Fast power-of-two math macros for non-optimized compilers
212a9f12690SJung-uk Kim  */
213a9f12690SJung-uk Kim #define _ACPI_DIV(value, PowerOf2)      ((UINT32) ((value) >> (PowerOf2)))
214a9f12690SJung-uk Kim #define _ACPI_MUL(value, PowerOf2)      ((UINT32) ((value) << (PowerOf2)))
215a9f12690SJung-uk Kim #define _ACPI_MOD(value, Divisor)       ((UINT32) ((value) & ((Divisor) -1)))
216a9f12690SJung-uk Kim 
217a9f12690SJung-uk Kim #define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
218a9f12690SJung-uk Kim #define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
219a9f12690SJung-uk Kim #define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
220a9f12690SJung-uk Kim 
221a9f12690SJung-uk Kim #define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
222a9f12690SJung-uk Kim #define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
223a9f12690SJung-uk Kim #define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
224a9f12690SJung-uk Kim 
225a9f12690SJung-uk Kim #define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
226a9f12690SJung-uk Kim #define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
227a9f12690SJung-uk Kim #define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
228a9f12690SJung-uk Kim 
229a9f12690SJung-uk Kim #define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
230a9f12690SJung-uk Kim #define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
231a9f12690SJung-uk Kim #define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
232a9f12690SJung-uk Kim 
233a9f12690SJung-uk Kim #define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
234a9f12690SJung-uk Kim #define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
235a9f12690SJung-uk Kim #define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
236a9f12690SJung-uk Kim 
237a9f12690SJung-uk Kim /*
238a9f12690SJung-uk Kim  * Rounding macros (Power of two boundaries only)
239a9f12690SJung-uk Kim  */
240a9f12690SJung-uk Kim #define ACPI_ROUND_DOWN(value, boundary)    (((ACPI_SIZE)(value)) & \
241a9f12690SJung-uk Kim                                                 (~(((ACPI_SIZE) boundary)-1)))
242a9f12690SJung-uk Kim 
243a9f12690SJung-uk Kim #define ACPI_ROUND_UP(value, boundary)      ((((ACPI_SIZE)(value)) + \
244a9f12690SJung-uk Kim                                                 (((ACPI_SIZE) boundary)-1)) & \
245a9f12690SJung-uk Kim                                                 (~(((ACPI_SIZE) boundary)-1)))
246a9f12690SJung-uk Kim 
247a9f12690SJung-uk Kim /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
248a9f12690SJung-uk Kim 
249a9f12690SJung-uk Kim #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
250a9f12690SJung-uk Kim #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
251a9f12690SJung-uk Kim #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
252a9f12690SJung-uk Kim 
253a9f12690SJung-uk Kim #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
254a9f12690SJung-uk Kim #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
255a9f12690SJung-uk Kim #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
256a9f12690SJung-uk Kim 
257a9f12690SJung-uk Kim #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
258a9f12690SJung-uk Kim #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
259a9f12690SJung-uk Kim 
260a9f12690SJung-uk Kim #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
261a9f12690SJung-uk Kim 
262a9f12690SJung-uk Kim /* Generic (non-power-of-two) rounding */
263a9f12690SJung-uk Kim 
264a9f12690SJung-uk Kim #define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
265a9f12690SJung-uk Kim 
266a9f12690SJung-uk Kim #define ACPI_IS_MISALIGNED(value)           (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
267a9f12690SJung-uk Kim 
268a9f12690SJung-uk Kim /*
269a9f12690SJung-uk Kim  * Bitmask creation
270a9f12690SJung-uk Kim  * Bit positions start at zero.
271a9f12690SJung-uk Kim  * MASK_BITS_ABOVE creates a mask starting AT the position and above
272a9f12690SJung-uk Kim  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
273a9f12690SJung-uk Kim  */
2749a179dd8SJung-uk Kim #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
2759a179dd8SJung-uk Kim #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((UINT32) (position)))
276a9f12690SJung-uk Kim 
277a9f12690SJung-uk Kim /* Bitfields within ACPI registers */
278a9f12690SJung-uk Kim 
2791df130f1SJung-uk Kim #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \
2801df130f1SJung-uk Kim     ((Val << Pos) & Mask)
281a9f12690SJung-uk Kim 
2821df130f1SJung-uk Kim #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \
2831df130f1SJung-uk Kim     Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask)
2841df130f1SJung-uk Kim 
2851df130f1SJung-uk Kim #define ACPI_INSERT_BITS(Target, Mask, Source) \
2861df130f1SJung-uk Kim     Target = ((Target & (~(Mask))) | (Source & Mask))
2871df130f1SJung-uk Kim 
2881df130f1SJung-uk Kim /* Generic bitfield macros and masks */
2891df130f1SJung-uk Kim 
2901df130f1SJung-uk Kim #define ACPI_GET_BITS(SourcePtr, Position, Mask) \
2911df130f1SJung-uk Kim     ((*SourcePtr >> Position) & Mask)
2921df130f1SJung-uk Kim 
2931df130f1SJung-uk Kim #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \
2941df130f1SJung-uk Kim     (*TargetPtr |= ((Value & Mask) << Position))
2951df130f1SJung-uk Kim 
2961df130f1SJung-uk Kim #define ACPI_1BIT_MASK      0x00000001
2971df130f1SJung-uk Kim #define ACPI_2BIT_MASK      0x00000003
2981df130f1SJung-uk Kim #define ACPI_3BIT_MASK      0x00000007
2991df130f1SJung-uk Kim #define ACPI_4BIT_MASK      0x0000000F
3001df130f1SJung-uk Kim #define ACPI_5BIT_MASK      0x0000001F
3011df130f1SJung-uk Kim #define ACPI_6BIT_MASK      0x0000003F
3021df130f1SJung-uk Kim #define ACPI_7BIT_MASK      0x0000007F
3031df130f1SJung-uk Kim #define ACPI_8BIT_MASK      0x000000FF
3041df130f1SJung-uk Kim #define ACPI_16BIT_MASK     0x0000FFFF
3051df130f1SJung-uk Kim #define ACPI_24BIT_MASK     0x00FFFFFF
306a9f12690SJung-uk Kim 
307ed17e06eSJung-uk Kim /* Macros to extract flag bits from position zero */
308ed17e06eSJung-uk Kim 
309ed17e06eSJung-uk Kim #define ACPI_GET_1BIT_FLAG(Value)                   ((Value) & ACPI_1BIT_MASK)
310ed17e06eSJung-uk Kim #define ACPI_GET_2BIT_FLAG(Value)                   ((Value) & ACPI_2BIT_MASK)
311ed17e06eSJung-uk Kim #define ACPI_GET_3BIT_FLAG(Value)                   ((Value) & ACPI_3BIT_MASK)
312ed17e06eSJung-uk Kim #define ACPI_GET_4BIT_FLAG(Value)                   ((Value) & ACPI_4BIT_MASK)
313ed17e06eSJung-uk Kim 
314ed17e06eSJung-uk Kim /* Macros to extract flag bits from position one and above */
315ed17e06eSJung-uk Kim 
316ed17e06eSJung-uk Kim #define ACPI_EXTRACT_1BIT_FLAG(Field, Position)     (ACPI_GET_1BIT_FLAG ((Field) >> Position))
317ed17e06eSJung-uk Kim #define ACPI_EXTRACT_2BIT_FLAG(Field, Position)     (ACPI_GET_2BIT_FLAG ((Field) >> Position))
318ed17e06eSJung-uk Kim #define ACPI_EXTRACT_3BIT_FLAG(Field, Position)     (ACPI_GET_3BIT_FLAG ((Field) >> Position))
319ed17e06eSJung-uk Kim #define ACPI_EXTRACT_4BIT_FLAG(Field, Position)     (ACPI_GET_4BIT_FLAG ((Field) >> Position))
320ed17e06eSJung-uk Kim 
321efcc2a30SJung-uk Kim /* ACPI Pathname helpers */
322efcc2a30SJung-uk Kim 
323efcc2a30SJung-uk Kim #define ACPI_IS_ROOT_PREFIX(c)      ((c) == (UINT8) 0x5C) /* Backslash */
324efcc2a30SJung-uk Kim #define ACPI_IS_PARENT_PREFIX(c)    ((c) == (UINT8) 0x5E) /* Carat */
325efcc2a30SJung-uk Kim #define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (UINT8) 0x2E) /* Period (dot) */
326efcc2a30SJung-uk Kim 
327a9f12690SJung-uk Kim /*
328e8241eabSJung-uk Kim  * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
329e8241eabSJung-uk Kim  * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
330a9f12690SJung-uk Kim  * appear. This macro is used to distinguish them.
331a9f12690SJung-uk Kim  *
3326f4860fcSJung-uk Kim  * The "DescriptorType" field is the second field in both structures.
333a9f12690SJung-uk Kim  */
3346f4860fcSJung-uk Kim #define ACPI_GET_DESCRIPTOR_PTR(d)      (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer)
3356f4860fcSJung-uk Kim #define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p))
336a9f12690SJung-uk Kim #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
3376f4860fcSJung-uk Kim #define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t))
338a9f12690SJung-uk Kim 
339a9f12690SJung-uk Kim /*
340a9f12690SJung-uk Kim  * Macros for the master AML opcode table
341a9f12690SJung-uk Kim  */
342a9f12690SJung-uk Kim #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
343a9f12690SJung-uk Kim #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
344a9f12690SJung-uk Kim     {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
345a9f12690SJung-uk Kim #else
346a9f12690SJung-uk Kim #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
347a9f12690SJung-uk Kim     {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
348a9f12690SJung-uk Kim #endif
349a9f12690SJung-uk Kim 
350a9f12690SJung-uk Kim #define ARG_TYPE_WIDTH                  5
351a9f12690SJung-uk Kim #define ARG_1(x)                        ((UINT32)(x))
352a9f12690SJung-uk Kim #define ARG_2(x)                        ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
353a9f12690SJung-uk Kim #define ARG_3(x)                        ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
354a9f12690SJung-uk Kim #define ARG_4(x)                        ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
355a9f12690SJung-uk Kim #define ARG_5(x)                        ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
356a9f12690SJung-uk Kim #define ARG_6(x)                        ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
357a9f12690SJung-uk Kim 
358a9f12690SJung-uk Kim #define ARGI_LIST1(a)                   (ARG_1(a))
359a9f12690SJung-uk Kim #define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
360a9f12690SJung-uk Kim #define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
361a9f12690SJung-uk Kim #define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
362a9f12690SJung-uk Kim #define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
363a9f12690SJung-uk Kim #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))
364a9f12690SJung-uk Kim 
365a9f12690SJung-uk Kim #define ARGP_LIST1(a)                   (ARG_1(a))
366a9f12690SJung-uk Kim #define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
367a9f12690SJung-uk Kim #define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
368a9f12690SJung-uk Kim #define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
369a9f12690SJung-uk Kim #define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
370a9f12690SJung-uk Kim #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))
371a9f12690SJung-uk Kim 
372a9f12690SJung-uk Kim #define GET_CURRENT_ARG_TYPE(List)      (List & ((UINT32) 0x1F))
373a9f12690SJung-uk Kim #define INCREMENT_ARG_LIST(List)        (List >>= ((UINT32) ARG_TYPE_WIDTH))
374a9f12690SJung-uk Kim 
375a9f12690SJung-uk Kim /*
376a9f12690SJung-uk Kim  * Ascii error messages can be configured out
377a9f12690SJung-uk Kim  */
378a9f12690SJung-uk Kim #ifndef ACPI_NO_ERROR_MESSAGES
379a9f12690SJung-uk Kim /*
380a9f12690SJung-uk Kim  * Error reporting. Callers module and line number are inserted by AE_INFO,
381a9f12690SJung-uk Kim  * the plist contains a set of parens to allow variable-length lists.
382a9f12690SJung-uk Kim  * These macros are used for both the debug and non-debug versions of the code.
383a9f12690SJung-uk Kim  */
38442fecd12SJung-uk Kim #define ACPI_ERROR_NAMESPACE(s, e)          AcpiUtNamespaceError (AE_INFO, s, e);
38542fecd12SJung-uk Kim #define ACPI_ERROR_METHOD(s, n, p, e)       AcpiUtMethodError (AE_INFO, s, n, p, e);
386d6dd1baeSJung-uk Kim #define ACPI_WARN_PREDEFINED(plist)         AcpiUtPredefinedWarning plist
3872272d050SJung-uk Kim #define ACPI_INFO_PREDEFINED(plist)         AcpiUtPredefinedInfo plist
388895f26a9SJung-uk Kim #define ACPI_BIOS_ERROR_PREDEFINED(plist)   AcpiUtPredefinedBiosError plist
389a9f12690SJung-uk Kim 
390a9f12690SJung-uk Kim #else
391a9f12690SJung-uk Kim 
392a9f12690SJung-uk Kim /* No error messages */
393a9f12690SJung-uk Kim 
394a9f12690SJung-uk Kim #define ACPI_ERROR_NAMESPACE(s, e)
395a9f12690SJung-uk Kim #define ACPI_ERROR_METHOD(s, n, p, e)
396d6dd1baeSJung-uk Kim #define ACPI_WARN_PREDEFINED(plist)
3972272d050SJung-uk Kim #define ACPI_INFO_PREDEFINED(plist)
398895f26a9SJung-uk Kim #define ACPI_BIOS_ERROR_PREDEFINED(plist)
399a9f12690SJung-uk Kim 
400a9f12690SJung-uk Kim #endif /* ACPI_NO_ERROR_MESSAGES */
401a9f12690SJung-uk Kim 
402a159c266SJung-uk Kim #if (!ACPI_REDUCED_HARDWARE)
403a159c266SJung-uk Kim #define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
404a159c266SJung-uk Kim #else
405a159c266SJung-uk Kim #define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
406a159c266SJung-uk Kim #endif
407a159c266SJung-uk Kim 
408a159c266SJung-uk Kim 
409a9f12690SJung-uk Kim /*
410a9f12690SJung-uk Kim  * Some code only gets executed when the debugger is built in.
411a9f12690SJung-uk Kim  * Note that this is entirely independent of whether the
412a9f12690SJung-uk Kim  * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
413a9f12690SJung-uk Kim  */
414a9f12690SJung-uk Kim #ifdef ACPI_DEBUGGER
415a9f12690SJung-uk Kim #define ACPI_DEBUGGER_EXEC(a)           a
416a9f12690SJung-uk Kim #else
417a9f12690SJung-uk Kim #define ACPI_DEBUGGER_EXEC(a)
418a9f12690SJung-uk Kim #endif
419a9f12690SJung-uk Kim 
420a9f12690SJung-uk Kim 
421a9f12690SJung-uk Kim /*
422a9f12690SJung-uk Kim  * Macros used for ACPICA utilities only
423a9f12690SJung-uk Kim  */
424a9f12690SJung-uk Kim 
425a9f12690SJung-uk Kim /* Generate a UUID */
426a9f12690SJung-uk Kim 
427a9f12690SJung-uk Kim #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
428a9f12690SJung-uk Kim     (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
429a9f12690SJung-uk Kim     (b) & 0xFF, ((b) >> 8) & 0xFF, \
430a9f12690SJung-uk Kim     (c) & 0xFF, ((c) >> 8) & 0xFF, \
431a9f12690SJung-uk Kim     (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
432a9f12690SJung-uk Kim 
433a9f12690SJung-uk Kim #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
434a9f12690SJung-uk Kim 
435a9f12690SJung-uk Kim 
436a9f12690SJung-uk Kim #endif /* ACMACROS_H */
437