167754Smsmith/******************************************************************************
267754Smsmith *
367754Smsmith * Name: acmacros.h - C macros for the entire subsystem.
467754Smsmith *
567754Smsmith *****************************************************************************/
667754Smsmith
7217365Sjkim/*
8306536Sjkim * Copyright (C) 2000 - 2016, Intel Corp.
970243Smsmith * All rights reserved.
1067754Smsmith *
11217365Sjkim * Redistribution and use in source and binary forms, with or without
12217365Sjkim * modification, are permitted provided that the following conditions
13217365Sjkim * are met:
14217365Sjkim * 1. Redistributions of source code must retain the above copyright
15217365Sjkim *    notice, this list of conditions, and the following disclaimer,
16217365Sjkim *    without modification.
17217365Sjkim * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18217365Sjkim *    substantially similar to the "NO WARRANTY" disclaimer below
19217365Sjkim *    ("Disclaimer") and any redistribution must be conditioned upon
20217365Sjkim *    including a substantially similar Disclaimer requirement for further
21217365Sjkim *    binary redistribution.
22217365Sjkim * 3. Neither the names of the above-listed copyright holders nor the names
23217365Sjkim *    of any contributors may be used to endorse or promote products derived
24217365Sjkim *    from this software without specific prior written permission.
2567754Smsmith *
26217365Sjkim * Alternatively, this software may be distributed under the terms of the
27217365Sjkim * GNU General Public License ("GPL") version 2 as published by the Free
28217365Sjkim * Software Foundation.
2967754Smsmith *
30217365Sjkim * NO WARRANTY
31217365Sjkim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32217365Sjkim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33217365Sjkim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34217365Sjkim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35217365Sjkim * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36217365Sjkim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37217365Sjkim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38217365Sjkim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39217365Sjkim * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40217365Sjkim * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41217365Sjkim * POSSIBILITY OF SUCH DAMAGES.
42217365Sjkim */
4367754Smsmith
4467754Smsmith#ifndef __ACMACROS_H__
4567754Smsmith#define __ACMACROS_H__
4667754Smsmith
4780062Smsmith
4867754Smsmith/*
49193267Sjkim * Extract data using a pointer. Any more than a byte and we
50167802Sjkim * get into potential aligment issues -- see the STORE macros below.
51167802Sjkim * Use with care.
52123315Snjl */
53243347Sjkim#define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (UINT8, (ptr))
54243347Sjkim#define ACPI_CAST16(ptr)                ACPI_CAST_PTR (UINT16, (ptr))
55243347Sjkim#define ACPI_CAST32(ptr)                ACPI_CAST_PTR (UINT32, (ptr))
56243347Sjkim#define ACPI_CAST64(ptr)                ACPI_CAST_PTR (UINT64, (ptr))
57243347Sjkim#define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
58243347Sjkim#define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
59243347Sjkim#define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
60243347Sjkim#define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
61243347Sjkim#define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (UINT8) (val))
62243347Sjkim#define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (UINT16) (val))
63243347Sjkim#define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (UINT32) (val))
64243347Sjkim#define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (UINT64) (val))
6567754Smsmith
66167802Sjkim/*
67281687Sjkim * printf() format helper. This macros is a workaround for the difficulties
68281075Sdim * with emitting 64-bit integers and 64-bit pointers with the same code
69281075Sdim * for both 32-bit and 64-bit hosts.
70167802Sjkim */
71193267Sjkim#define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
7291116Smsmith
73281075Sdim
7467754Smsmith/*
7567754Smsmith * Macros for moving data around to/from buffers that are possibly unaligned.
7667754Smsmith * If the hardware supports the transfer of unaligned data, just do the store.
7767754Smsmith * Otherwise, we have to move one byte at a time.
7867754Smsmith */
79117521Snjl#ifdef ACPI_BIG_ENDIAN
80117521Snjl/*
81117521Snjl * Macros for big-endian machines
82117521Snjl */
8367754Smsmith
84117521Snjl/* These macros reverse the bytes during the move, converting little-endian to big endian */
85117521Snjl
86117521Snjl                                                     /* Big Endian      <==        Little Endian */
87117521Snjl                                                     /*  Hi...Lo                     Lo...Hi     */
88117521Snjl/* 16-bit source, 16/32/64 destination */
89117521Snjl
90193267Sjkim#define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
91117521Snjl                                         ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
92117521Snjl
93193267Sjkim#define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d))=0;\
94117521Snjl                                           ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
95117521Snjl                                           ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
96117521Snjl
97193267Sjkim#define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
98117521Snjl                                           ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
99117521Snjl                                           ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
100117521Snjl
101117521Snjl/* 32-bit source, 16/32/64 destination */
102117521Snjl
103193267Sjkim#define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
104117521Snjl
105193267Sjkim#define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
106117521Snjl                                         ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
107117521Snjl                                         ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
108117521Snjl                                         ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
109117521Snjl
110193267Sjkim#define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
111117521Snjl                                           ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
112117521Snjl                                           ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
113117521Snjl                                           ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
114117521Snjl                                           ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
115117521Snjl
116117521Snjl/* 64-bit source, 16/32/64 destination */
117117521Snjl
118193267Sjkim#define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
119117521Snjl
120193267Sjkim#define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
121117521Snjl
122193267Sjkim#define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
123117521Snjl                                         ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
124117521Snjl                                         ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
125117521Snjl                                         ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
126117521Snjl                                         ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
127117521Snjl                                         ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
128117521Snjl                                         ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
129117521Snjl                                         ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
13067754Smsmith#else
13167754Smsmith/*
132117521Snjl * Macros for little-endian machines
133117521Snjl */
134117521Snjl
135151937Sjkim#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
136117521Snjl
137117521Snjl/* The hardware supports unaligned transfers, just do the little-endian move */
138117521Snjl
139117521Snjl/* 16-bit source, 16/32/64 destination */
140117521Snjl
141193267Sjkim#define ACPI_MOVE_16_TO_16(d, s)        *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
142193267Sjkim#define ACPI_MOVE_16_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
143193267Sjkim#define ACPI_MOVE_16_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
144117521Snjl
145117521Snjl/* 32-bit source, 16/32/64 destination */
146117521Snjl
147193267Sjkim#define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
148193267Sjkim#define ACPI_MOVE_32_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
149193267Sjkim#define ACPI_MOVE_32_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
150117521Snjl
151117521Snjl/* 64-bit source, 16/32/64 destination */
152117521Snjl
153193267Sjkim#define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
154193267Sjkim#define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
155193267Sjkim#define ACPI_MOVE_64_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
156117521Snjl
157117521Snjl#else
158117521Snjl/*
159193267Sjkim * The hardware does not support unaligned transfers. We must move the
160193267Sjkim * data one byte at a time. These macros work whether the source or
161193267Sjkim * the destination (or both) is/are unaligned. (Little-endian move)
16267754Smsmith */
16367754Smsmith
164117521Snjl/* 16-bit source, 16/32/64 destination */
16567754Smsmith
166193267Sjkim#define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
167117521Snjl                                         ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
16867754Smsmith
169193267Sjkim#define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
170193267Sjkim#define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
17167754Smsmith
172117521Snjl/* 32-bit source, 16/32/64 destination */
17377424Smsmith
174193267Sjkim#define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
175117521Snjl
176193267Sjkim#define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
177117521Snjl                                         ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
178117521Snjl                                         ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
179117521Snjl                                         ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
180117521Snjl
181193267Sjkim#define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
182117521Snjl
183117521Snjl/* 64-bit source, 16/32/64 destination */
184117521Snjl
185193267Sjkim#define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
186193267Sjkim#define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
187193267Sjkim#define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
188117521Snjl                                         ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
189117521Snjl                                         ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
190117521Snjl                                         ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
191117521Snjl                                         ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
192117521Snjl                                         ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
193117521Snjl                                         ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
194117521Snjl                                         ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
19567754Smsmith#endif
196117521Snjl#endif
19767754Smsmith
19867754Smsmith
19967754Smsmith/*
20067754Smsmith * Fast power-of-two math macros for non-optimized compilers
20167754Smsmith */
202193267Sjkim#define _ACPI_DIV(value, PowerOf2)      ((UINT32) ((value) >> (PowerOf2)))
203193267Sjkim#define _ACPI_MUL(value, PowerOf2)      ((UINT32) ((value) << (PowerOf2)))
204193267Sjkim#define _ACPI_MOD(value, Divisor)       ((UINT32) ((value) & ((Divisor) -1)))
20567754Smsmith
206193267Sjkim#define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
207193267Sjkim#define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
208193267Sjkim#define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
20967754Smsmith
210193267Sjkim#define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
211193267Sjkim#define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
212193267Sjkim#define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
21367754Smsmith
214193267Sjkim#define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
215193267Sjkim#define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
216193267Sjkim#define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
21767754Smsmith
218193267Sjkim#define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
219193267Sjkim#define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
220193267Sjkim#define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
22167754Smsmith
222193267Sjkim#define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
223193267Sjkim#define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
224193267Sjkim#define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
22567754Smsmith
226306536Sjkim/* Test for ASCII character */
227306536Sjkim
228306536Sjkim#define ACPI_IS_ASCII(c)                ((c) < 0x80)
229306536Sjkim
230306536Sjkim/* Signed integers */
231306536Sjkim
232306536Sjkim#define ACPI_SIGN_POSITIVE              0
233306536Sjkim#define ACPI_SIGN_NEGATIVE              1
234306536Sjkim
235306536Sjkim
23667754Smsmith/*
23767754Smsmith * Rounding macros (Power of two boundaries only)
23867754Smsmith */
239193267Sjkim#define ACPI_ROUND_DOWN(value, boundary)    (((ACPI_SIZE)(value)) & \
240193267Sjkim                                                (~(((ACPI_SIZE) boundary)-1)))
24167754Smsmith
242193267Sjkim#define ACPI_ROUND_UP(value, boundary)      ((((ACPI_SIZE)(value)) + \
243193267Sjkim                                                (((ACPI_SIZE) boundary)-1)) & \
244193267Sjkim                                                (~(((ACPI_SIZE) boundary)-1)))
24567754Smsmith
246193267Sjkim/* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
24767754Smsmith
248193267Sjkim#define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
249193267Sjkim#define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
250193267Sjkim#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
25167754Smsmith
252193267Sjkim#define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
253193267Sjkim#define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
254193267Sjkim#define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
25577424Smsmith
256167802Sjkim#define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
257167802Sjkim#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
25869450Smsmith
259167802Sjkim#define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
260167802Sjkim
26177424Smsmith/* Generic (non-power-of-two) rounding */
26277424Smsmith
263193267Sjkim#define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
26477424Smsmith
265193267Sjkim#define ACPI_IS_MISALIGNED(value)           (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
266167802Sjkim
26783174Smsmith/*
26877424Smsmith * Bitmask creation
26977424Smsmith * Bit positions start at zero.
27077424Smsmith * MASK_BITS_ABOVE creates a mask starting AT the position and above
27177424Smsmith * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
27277424Smsmith */
273202771Sjkim#define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
274202771Sjkim#define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((UINT32) (position)))
27577424Smsmith
27691116Smsmith/* Bitfields within ACPI registers */
27791116Smsmith
278239340Sjkim#define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \
279239340Sjkim    ((Val << Pos) & Mask)
28091116Smsmith
281239340Sjkim#define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \
282239340Sjkim    Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask)
283167802Sjkim
284239340Sjkim#define ACPI_INSERT_BITS(Target, Mask, Source) \
285239340Sjkim    Target = ((Target & (~(Mask))) | (Source & Mask))
286239340Sjkim
287239340Sjkim/* Generic bitfield macros and masks */
288239340Sjkim
289239340Sjkim#define ACPI_GET_BITS(SourcePtr, Position, Mask) \
290306536Sjkim    ((*(SourcePtr) >> (Position)) & (Mask))
291239340Sjkim
292239340Sjkim#define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \
293306536Sjkim    (*(TargetPtr) |= (((Value) & (Mask)) << (Position)))
294239340Sjkim
295239340Sjkim#define ACPI_1BIT_MASK      0x00000001
296239340Sjkim#define ACPI_2BIT_MASK      0x00000003
297239340Sjkim#define ACPI_3BIT_MASK      0x00000007
298239340Sjkim#define ACPI_4BIT_MASK      0x0000000F
299239340Sjkim#define ACPI_5BIT_MASK      0x0000001F
300239340Sjkim#define ACPI_6BIT_MASK      0x0000003F
301239340Sjkim#define ACPI_7BIT_MASK      0x0000007F
302239340Sjkim#define ACPI_8BIT_MASK      0x000000FF
303239340Sjkim#define ACPI_16BIT_MASK     0x0000FFFF
304239340Sjkim#define ACPI_24BIT_MASK     0x00FFFFFF
305239340Sjkim
306243347Sjkim/* Macros to extract flag bits from position zero */
307243347Sjkim
308243347Sjkim#define ACPI_GET_1BIT_FLAG(Value)                   ((Value) & ACPI_1BIT_MASK)
309243347Sjkim#define ACPI_GET_2BIT_FLAG(Value)                   ((Value) & ACPI_2BIT_MASK)
310243347Sjkim#define ACPI_GET_3BIT_FLAG(Value)                   ((Value) & ACPI_3BIT_MASK)
311243347Sjkim#define ACPI_GET_4BIT_FLAG(Value)                   ((Value) & ACPI_4BIT_MASK)
312243347Sjkim
313243347Sjkim/* Macros to extract flag bits from position one and above */
314243347Sjkim
315243347Sjkim#define ACPI_EXTRACT_1BIT_FLAG(Field, Position)     (ACPI_GET_1BIT_FLAG ((Field) >> Position))
316243347Sjkim#define ACPI_EXTRACT_2BIT_FLAG(Field, Position)     (ACPI_GET_2BIT_FLAG ((Field) >> Position))
317243347Sjkim#define ACPI_EXTRACT_3BIT_FLAG(Field, Position)     (ACPI_GET_3BIT_FLAG ((Field) >> Position))
318243347Sjkim#define ACPI_EXTRACT_4BIT_FLAG(Field, Position)     (ACPI_GET_4BIT_FLAG ((Field) >> Position))
319243347Sjkim
320245582Sjkim/* ACPI Pathname helpers */
321245582Sjkim
322245582Sjkim#define ACPI_IS_ROOT_PREFIX(c)      ((c) == (UINT8) 0x5C) /* Backslash */
323245582Sjkim#define ACPI_IS_PARENT_PREFIX(c)    ((c) == (UINT8) 0x5E) /* Carat */
324245582Sjkim#define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (UINT8) 0x2E) /* Period (dot) */
325245582Sjkim
32667754Smsmith/*
327238381Sjkim * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
328238381Sjkim * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
329193267Sjkim * appear. This macro is used to distinguish them.
33067754Smsmith *
331246040Sjkim * The "DescriptorType" field is the second field in both structures.
33267754Smsmith */
333246040Sjkim#define ACPI_GET_DESCRIPTOR_PTR(d)      (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer)
334246040Sjkim#define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p))
335167802Sjkim#define ACPI_GET_DESCRIPTOR_TYPE(d)     (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
336246040Sjkim#define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t))
33767754Smsmith
33867754Smsmith/*
33967754Smsmith * Macros for the master AML opcode table
34067754Smsmith */
341193267Sjkim#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
342193267Sjkim#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
343193267Sjkim    {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
34467754Smsmith#else
345193267Sjkim#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
346193267Sjkim    {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
34767754Smsmith#endif
34867754Smsmith
34967754Smsmith#define ARG_TYPE_WIDTH                  5
35067754Smsmith#define ARG_1(x)                        ((UINT32)(x))
35167754Smsmith#define ARG_2(x)                        ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
35267754Smsmith#define ARG_3(x)                        ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
35367754Smsmith#define ARG_4(x)                        ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
35467754Smsmith#define ARG_5(x)                        ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
35567754Smsmith#define ARG_6(x)                        ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
35667754Smsmith
35767754Smsmith#define ARGI_LIST1(a)                   (ARG_1(a))
358193267Sjkim#define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
359193267Sjkim#define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
360193267Sjkim#define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
361193267Sjkim#define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
362193267Sjkim#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))
36367754Smsmith
36467754Smsmith#define ARGP_LIST1(a)                   (ARG_1(a))
365193267Sjkim#define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
366193267Sjkim#define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
367193267Sjkim#define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
368193267Sjkim#define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
369193267Sjkim#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))
37067754Smsmith
37167754Smsmith#define GET_CURRENT_ARG_TYPE(List)      (List & ((UINT32) 0x1F))
37267754Smsmith#define INCREMENT_ARG_LIST(List)        (List >>= ((UINT32) ARG_TYPE_WIDTH))
37367754Smsmith
37467754Smsmith/*
375167802Sjkim * Ascii error messages can be configured out
37667754Smsmith */
377167802Sjkim#ifndef ACPI_NO_ERROR_MESSAGES
378167802Sjkim/*
379167802Sjkim * Error reporting. Callers module and line number are inserted by AE_INFO,
380167802Sjkim * the plist contains a set of parens to allow variable-length lists.
381167802Sjkim * These macros are used for both the debug and non-debug versions of the code.
382167802Sjkim */
383249663Sjkim#define ACPI_ERROR_NAMESPACE(s, e)          AcpiUtNamespaceError (AE_INFO, s, e);
384249663Sjkim#define ACPI_ERROR_METHOD(s, n, p, e)       AcpiUtMethodError (AE_INFO, s, n, p, e);
385249663Sjkim#define ACPI_WARN_PREDEFINED(plist)         AcpiUtPredefinedWarning plist
386249663Sjkim#define ACPI_INFO_PREDEFINED(plist)         AcpiUtPredefinedInfo plist
387249663Sjkim#define ACPI_BIOS_ERROR_PREDEFINED(plist)   AcpiUtPredefinedBiosError plist
38867754Smsmith
38967754Smsmith#else
39067754Smsmith
391167802Sjkim/* No error messages */
39267754Smsmith
393193267Sjkim#define ACPI_ERROR_NAMESPACE(s, e)
394193267Sjkim#define ACPI_ERROR_METHOD(s, n, p, e)
395197104Sjkim#define ACPI_WARN_PREDEFINED(plist)
396199337Sjkim#define ACPI_INFO_PREDEFINED(plist)
397249663Sjkim#define ACPI_BIOS_ERROR_PREDEFINED(plist)
39867754Smsmith
399193267Sjkim#endif /* ACPI_NO_ERROR_MESSAGES */
400193267Sjkim
401231844Sjkim#if (!ACPI_REDUCED_HARDWARE)
402231844Sjkim#define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
403231844Sjkim#else
404231844Sjkim#define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
405231844Sjkim#endif
406231844Sjkim
407231844Sjkim
40867754Smsmith/*
409193267Sjkim * Macros used for ACPICA utilities only
410193267Sjkim */
411193267Sjkim
412193267Sjkim/* Generate a UUID */
413193267Sjkim
414193267Sjkim#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
415193267Sjkim    (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
416193267Sjkim    (b) & 0xFF, ((b) >> 8) & 0xFF, \
417193267Sjkim    (c) & 0xFF, ((c) >> 8) & 0xFF, \
418193267Sjkim    (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
419193267Sjkim
420193267Sjkim#define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
421193267Sjkim
422193267Sjkim
42367754Smsmith#endif /* ACMACROS_H */
424