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/*
49 * Extract data using a pointer. Any more than a byte and we
50 * get into potential aligment issues -- see the STORE macros below.
51 * Use with care.
52 */
53#define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr)
54#define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr)
55#define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr)
56#define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr)
57#define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr)
58#define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr)
59#define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr)
60#define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr)
61
62/*
63 * printf() format helpers
64 */
65
66/* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */
67
68#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
69
70#if ACPI_MACHINE_WIDTH == 64
71#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i)
72#else
73#define ACPI_FORMAT_NATIVE_UINT(i) 0, (i)
74#endif
75
76
77/*
78 * Macros for moving data around to/from buffers that are possibly unaligned.
79 * If the hardware supports the transfer of unaligned data, just do the store.
80 * Otherwise, we have to move one byte at a time.
81 */
82#ifdef ACPI_BIG_ENDIAN
83/*
84 * Macros for big-endian machines
85 */
86
87/* These macros reverse the bytes during the move, converting little-endian to big endian */
88
89 /* Big Endian <== Little Endian */
90 /* Hi...Lo Lo...Hi */
91/* 16-bit source, 16/32/64 destination */
92
93#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
94 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
95
96#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\
97 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
98 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
99
100#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\
101 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
102 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
103
104/* 32-bit source, 16/32/64 destination */
105
106#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
107
108#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
109 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
110 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
111 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
112
113#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\
114 ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
115 ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
116 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
117 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
118
119/* 64-bit source, 16/32/64 destination */
120
121#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
122
123#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
124
125#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
126 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
127 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
128 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
129 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
130 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
131 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
132 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
133#else
134/*
135 * Macros for little-endian machines
136 */
137
138#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
139
140/* The hardware supports unaligned transfers, just do the little-endian move */
141
142/* 16-bit source, 16/32/64 destination */
143
144#define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
145#define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
146#define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
147
148/* 32-bit source, 16/32/64 destination */
149
150#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
151#define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
152#define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
153
154/* 64-bit source, 16/32/64 destination */
155
156#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
157#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
158#define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
159
160#else
161/*
162 * The hardware does not support unaligned transfers. We must move the
163 * data one byte at a time. These macros work whether the source or
164 * the destination (or both) is/are unaligned. (Little-endian move)
165 */
166
167/* 16-bit source, 16/32/64 destination */
168
169#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
170 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
171
172#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
173#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
174
175/* 32-bit source, 16/32/64 destination */
176
177#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
178
179#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
180 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
181 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
182 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
183
184#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
185
186/* 64-bit source, 16/32/64 destination */
187
188#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
189#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
190#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
191 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
192 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
193 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
194 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
195 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
196 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
197 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
198#endif
199#endif
200
201
202/*
203 * Fast power-of-two math macros for non-optimized compilers
204 */
205#define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2)))
206#define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2)))
207#define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1)))
208
209#define ACPI_DIV_2(a) _ACPI_DIV(a, 1)
210#define ACPI_MUL_2(a) _ACPI_MUL(a, 1)
211#define ACPI_MOD_2(a) _ACPI_MOD(a, 2)
212
213#define ACPI_DIV_4(a) _ACPI_DIV(a, 2)
214#define ACPI_MUL_4(a) _ACPI_MUL(a, 2)
215#define ACPI_MOD_4(a) _ACPI_MOD(a, 4)
216
217#define ACPI_DIV_8(a) _ACPI_DIV(a, 3)
218#define ACPI_MUL_8(a) _ACPI_MUL(a, 3)
219#define ACPI_MOD_8(a) _ACPI_MOD(a, 8)
220
221#define ACPI_DIV_16(a) _ACPI_DIV(a, 4)
222#define ACPI_MUL_16(a) _ACPI_MUL(a, 4)
223#define ACPI_MOD_16(a) _ACPI_MOD(a, 16)
224
225#define ACPI_DIV_32(a) _ACPI_DIV(a, 5)
226#define ACPI_MUL_32(a) _ACPI_MUL(a, 5)
227#define ACPI_MOD_32(a) _ACPI_MOD(a, 32)
228
229/*
230 * Rounding macros (Power of two boundaries only)
231 */
232#define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \
233 (~(((ACPI_SIZE) boundary)-1)))
234
235#define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \
236 (((ACPI_SIZE) boundary)-1)) & \
237 (~(((ACPI_SIZE) boundary)-1)))
238
239/* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
240
241#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4)
242#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8)
243#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
244
245#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4)
246#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8)
247#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
248
249#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7)
250#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a))
251
252#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
253
254/* Generic (non-power-of-two) rounding */
255
256#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
257
258#define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
259
260/*
261 * Bitmask creation
262 * Bit positions start at zero.
263 * MASK_BITS_ABOVE creates a mask starting AT the position and above
264 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
265 */
266#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
267#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position)))
268
269/* Bitfields within ACPI registers */
270
| 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/*
49 * Extract data using a pointer. Any more than a byte and we
50 * get into potential aligment issues -- see the STORE macros below.
51 * Use with care.
52 */
53#define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr)
54#define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr)
55#define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr)
56#define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr)
57#define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr)
58#define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr)
59#define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr)
60#define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr)
61
62/*
63 * printf() format helpers
64 */
65
66/* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */
67
68#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
69
70#if ACPI_MACHINE_WIDTH == 64
71#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i)
72#else
73#define ACPI_FORMAT_NATIVE_UINT(i) 0, (i)
74#endif
75
76
77/*
78 * Macros for moving data around to/from buffers that are possibly unaligned.
79 * If the hardware supports the transfer of unaligned data, just do the store.
80 * Otherwise, we have to move one byte at a time.
81 */
82#ifdef ACPI_BIG_ENDIAN
83/*
84 * Macros for big-endian machines
85 */
86
87/* These macros reverse the bytes during the move, converting little-endian to big endian */
88
89 /* Big Endian <== Little Endian */
90 /* Hi...Lo Lo...Hi */
91/* 16-bit source, 16/32/64 destination */
92
93#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
94 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
95
96#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\
97 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
98 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
99
100#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\
101 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
102 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
103
104/* 32-bit source, 16/32/64 destination */
105
106#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
107
108#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
109 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
110 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
111 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
112
113#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\
114 ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
115 ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
116 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
117 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
118
119/* 64-bit source, 16/32/64 destination */
120
121#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
122
123#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
124
125#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
126 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
127 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
128 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
129 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
130 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
131 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
132 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
133#else
134/*
135 * Macros for little-endian machines
136 */
137
138#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
139
140/* The hardware supports unaligned transfers, just do the little-endian move */
141
142/* 16-bit source, 16/32/64 destination */
143
144#define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
145#define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
146#define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
147
148/* 32-bit source, 16/32/64 destination */
149
150#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
151#define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
152#define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
153
154/* 64-bit source, 16/32/64 destination */
155
156#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
157#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
158#define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
159
160#else
161/*
162 * The hardware does not support unaligned transfers. We must move the
163 * data one byte at a time. These macros work whether the source or
164 * the destination (or both) is/are unaligned. (Little-endian move)
165 */
166
167/* 16-bit source, 16/32/64 destination */
168
169#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
170 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
171
172#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
173#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
174
175/* 32-bit source, 16/32/64 destination */
176
177#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
178
179#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
180 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
181 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
182 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
183
184#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
185
186/* 64-bit source, 16/32/64 destination */
187
188#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
189#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
190#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
191 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
192 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
193 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
194 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
195 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
196 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
197 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
198#endif
199#endif
200
201
202/*
203 * Fast power-of-two math macros for non-optimized compilers
204 */
205#define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2)))
206#define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2)))
207#define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1)))
208
209#define ACPI_DIV_2(a) _ACPI_DIV(a, 1)
210#define ACPI_MUL_2(a) _ACPI_MUL(a, 1)
211#define ACPI_MOD_2(a) _ACPI_MOD(a, 2)
212
213#define ACPI_DIV_4(a) _ACPI_DIV(a, 2)
214#define ACPI_MUL_4(a) _ACPI_MUL(a, 2)
215#define ACPI_MOD_4(a) _ACPI_MOD(a, 4)
216
217#define ACPI_DIV_8(a) _ACPI_DIV(a, 3)
218#define ACPI_MUL_8(a) _ACPI_MUL(a, 3)
219#define ACPI_MOD_8(a) _ACPI_MOD(a, 8)
220
221#define ACPI_DIV_16(a) _ACPI_DIV(a, 4)
222#define ACPI_MUL_16(a) _ACPI_MUL(a, 4)
223#define ACPI_MOD_16(a) _ACPI_MOD(a, 16)
224
225#define ACPI_DIV_32(a) _ACPI_DIV(a, 5)
226#define ACPI_MUL_32(a) _ACPI_MUL(a, 5)
227#define ACPI_MOD_32(a) _ACPI_MOD(a, 32)
228
229/*
230 * Rounding macros (Power of two boundaries only)
231 */
232#define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \
233 (~(((ACPI_SIZE) boundary)-1)))
234
235#define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \
236 (((ACPI_SIZE) boundary)-1)) & \
237 (~(((ACPI_SIZE) boundary)-1)))
238
239/* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
240
241#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4)
242#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8)
243#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
244
245#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4)
246#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8)
247#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
248
249#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7)
250#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a))
251
252#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
253
254/* Generic (non-power-of-two) rounding */
255
256#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
257
258#define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
259
260/*
261 * Bitmask creation
262 * Bit positions start at zero.
263 * MASK_BITS_ABOVE creates a mask starting AT the position and above
264 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
265 */
266#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
267#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position)))
268
269/* Bitfields within ACPI registers */
270
|
276/*
277 * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
278 * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
279 * appear. This macro is used to distinguish them.
280 *
281 * The "Descriptor" field is the first field in both structures.
282 */
283#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
284#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t)
285
286/*
287 * Macros for the master AML opcode table
288 */
289#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
290#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
291 {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
292#else
293#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
294 {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
295#endif
296
297#define ARG_TYPE_WIDTH 5
298#define ARG_1(x) ((UINT32)(x))
299#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
300#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
301#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
302#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
303#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
304
305#define ARGI_LIST1(a) (ARG_1(a))
306#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a))
307#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
308#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
309#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
310#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))
311
312#define ARGP_LIST1(a) (ARG_1(a))
313#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b))
314#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
315#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
316#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
317#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))
318
319#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F))
320#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH))
321
322/*
323 * Ascii error messages can be configured out
324 */
325#ifndef ACPI_NO_ERROR_MESSAGES
326/*
327 * Error reporting. Callers module and line number are inserted by AE_INFO,
328 * the plist contains a set of parens to allow variable-length lists.
329 * These macros are used for both the debug and non-debug versions of the code.
330 */
331#define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e);
332#define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e);
333#define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist
334#define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist
335
336#else
337
338/* No error messages */
339
340#define ACPI_ERROR_NAMESPACE(s, e)
341#define ACPI_ERROR_METHOD(s, n, p, e)
342#define ACPI_WARN_PREDEFINED(plist)
343#define ACPI_INFO_PREDEFINED(plist)
344
345#endif /* ACPI_NO_ERROR_MESSAGES */
346
347/*
348 * Debug macros that are conditionally compiled
349 */
350#ifdef ACPI_DEBUG_OUTPUT
351/*
352 * Function entry tracing
353 */
354#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \
355 AcpiUtTrace(ACPI_DEBUG_PARAMETERS)
356#define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \
357 AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b)
358#define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \
359 AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b)
360#define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \
361 AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b)
362
363#define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr()
364
365/*
366 * Function exit tracing.
367 * WARNING: These macros include a return statement. This is usually considered
368 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
369 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
370 * so that "_AcpiFunctionName" is defined.
371 *
372 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining
373 * about these constructs.
374 */
375#ifdef ACPI_USE_DO_WHILE_0
376#define ACPI_DO_WHILE0(a) do a while(0)
377#else
378#define ACPI_DO_WHILE0(a) a
379#endif
380
381#define return_VOID ACPI_DO_WHILE0 ({ \
382 AcpiUtExit (ACPI_DEBUG_PARAMETERS); \
383 return;})
384/*
385 * There are two versions of most of the return macros. The default version is
386 * safer, since it avoids side-effects by guaranteeing that the argument will
387 * not be evaluated twice.
388 *
389 * A less-safe version of the macros is provided for optional use if the
390 * compiler uses excessive CPU stack (for example, this may happen in the
391 * debug case if code optimzation is disabled.)
392 */
393#ifndef ACPI_SIMPLE_RETURN_MACROS
394
395#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
396 register ACPI_STATUS _s = (s); \
397 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \
398 return (_s); })
399#define return_PTR(s) ACPI_DO_WHILE0 ({ \
400 register void *_s = (void *) (s); \
401 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \
402 return (_s); })
403#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
404 register UINT64 _s = (s); \
405 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \
406 return (_s); })
407#define return_UINT8(s) ACPI_DO_WHILE0 ({ \
408 register UINT8 _s = (UINT8) (s); \
409 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \
410 return (_s); })
411#define return_UINT32(s) ACPI_DO_WHILE0 ({ \
412 register UINT32 _s = (UINT32) (s); \
413 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \
414 return (_s); })
415#else /* Use original less-safe macros */
416
417#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
418 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \
419 return((s)); })
420#define return_PTR(s) ACPI_DO_WHILE0 ({ \
421 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \
422 return((s)); })
423#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
424 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) (s)); \
425 return((s)); })
426#define return_UINT8(s) return_VALUE(s)
427#define return_UINT32(s) return_VALUE(s)
428
429#endif /* ACPI_SIMPLE_RETURN_MACROS */
430
431/* Conditional execution */
432
433#define ACPI_DEBUG_EXEC(a) a
434#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
435#define _VERBOSE_STRUCTURES
436
437
438/* Various object display routines for debug */
439
440#define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0)
441#define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c)
442#define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b)
443#define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d)
444#define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
445
446#else
447/*
448 * This is the non-debug case -- make everything go away,
449 * leaving no executable debug code!
450 */
451#define ACPI_DEBUG_EXEC(a)
452#define ACPI_DEBUG_ONLY_MEMBERS(a)
453#define ACPI_FUNCTION_TRACE(a)
454#define ACPI_FUNCTION_TRACE_PTR(a, b)
455#define ACPI_FUNCTION_TRACE_U32(a, b)
456#define ACPI_FUNCTION_TRACE_STR(a, b)
457#define ACPI_FUNCTION_EXIT
458#define ACPI_FUNCTION_STATUS_EXIT(s)
459#define ACPI_FUNCTION_VALUE_EXIT(s)
460#define ACPI_FUNCTION_ENTRY()
461#define ACPI_DUMP_STACK_ENTRY(a)
462#define ACPI_DUMP_OPERANDS(a, b, c)
463#define ACPI_DUMP_ENTRY(a, b)
464#define ACPI_DUMP_TABLES(a, b)
465#define ACPI_DUMP_PATHNAME(a, b, c, d)
466#define ACPI_DUMP_BUFFER(a, b)
467#define ACPI_DEBUG_PRINT(pl)
468#define ACPI_DEBUG_PRINT_RAW(pl)
469
470#define return_VOID return
471#define return_ACPI_STATUS(s) return(s)
472#define return_VALUE(s) return(s)
473#define return_UINT8(s) return(s)
474#define return_UINT32(s) return(s)
475#define return_PTR(s) return(s)
476
477#endif /* ACPI_DEBUG_OUTPUT */
478
479
480#if (!ACPI_REDUCED_HARDWARE)
481#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr
482#else
483#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL
484#endif
485
486
487/*
488 * Some code only gets executed when the debugger is built in.
489 * Note that this is entirely independent of whether the
490 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
491 */
492#ifdef ACPI_DEBUGGER
493#define ACPI_DEBUGGER_EXEC(a) a
494#else
495#define ACPI_DEBUGGER_EXEC(a)
496#endif
497
498
499/*
500 * Memory allocation tracking (DEBUG ONLY)
501 */
502#define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__
503
504#ifndef ACPI_DBG_TRACK_ALLOCATIONS
505
506/* Memory allocation */
507
508#define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
509#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
510#define ACPI_FREE(a) AcpiOsFree(a)
511#define ACPI_MEM_TRACKING(a)
512
513#else
514
515/* Memory allocation */
516
517#define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
518#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
519#define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS)
520#define ACPI_MEM_TRACKING(a) a
521
522#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
523
524
525/*
526 * Macros used for ACPICA utilities only
527 */
528
529/* Generate a UUID */
530
531#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
532 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
533 (b) & 0xFF, ((b) >> 8) & 0xFF, \
534 (c) & 0xFF, ((c) >> 8) & 0xFF, \
535 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
536
537#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7'))
538
539
540#endif /* ACMACROS_H */
| 299/*
300 * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
301 * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
302 * appear. This macro is used to distinguish them.
303 *
304 * The "Descriptor" field is the first field in both structures.
305 */
306#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
307#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t)
308
309/*
310 * Macros for the master AML opcode table
311 */
312#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
313#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
314 {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
315#else
316#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
317 {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
318#endif
319
320#define ARG_TYPE_WIDTH 5
321#define ARG_1(x) ((UINT32)(x))
322#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
323#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
324#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
325#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
326#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
327
328#define ARGI_LIST1(a) (ARG_1(a))
329#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a))
330#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
331#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
332#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
333#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))
334
335#define ARGP_LIST1(a) (ARG_1(a))
336#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b))
337#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
338#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
339#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
340#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))
341
342#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F))
343#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH))
344
345/*
346 * Ascii error messages can be configured out
347 */
348#ifndef ACPI_NO_ERROR_MESSAGES
349/*
350 * Error reporting. Callers module and line number are inserted by AE_INFO,
351 * the plist contains a set of parens to allow variable-length lists.
352 * These macros are used for both the debug and non-debug versions of the code.
353 */
354#define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e);
355#define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e);
356#define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist
357#define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist
358
359#else
360
361/* No error messages */
362
363#define ACPI_ERROR_NAMESPACE(s, e)
364#define ACPI_ERROR_METHOD(s, n, p, e)
365#define ACPI_WARN_PREDEFINED(plist)
366#define ACPI_INFO_PREDEFINED(plist)
367
368#endif /* ACPI_NO_ERROR_MESSAGES */
369
370/*
371 * Debug macros that are conditionally compiled
372 */
373#ifdef ACPI_DEBUG_OUTPUT
374/*
375 * Function entry tracing
376 */
377#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \
378 AcpiUtTrace(ACPI_DEBUG_PARAMETERS)
379#define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \
380 AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b)
381#define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \
382 AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b)
383#define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \
384 AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b)
385
386#define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr()
387
388/*
389 * Function exit tracing.
390 * WARNING: These macros include a return statement. This is usually considered
391 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
392 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
393 * so that "_AcpiFunctionName" is defined.
394 *
395 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining
396 * about these constructs.
397 */
398#ifdef ACPI_USE_DO_WHILE_0
399#define ACPI_DO_WHILE0(a) do a while(0)
400#else
401#define ACPI_DO_WHILE0(a) a
402#endif
403
404#define return_VOID ACPI_DO_WHILE0 ({ \
405 AcpiUtExit (ACPI_DEBUG_PARAMETERS); \
406 return;})
407/*
408 * There are two versions of most of the return macros. The default version is
409 * safer, since it avoids side-effects by guaranteeing that the argument will
410 * not be evaluated twice.
411 *
412 * A less-safe version of the macros is provided for optional use if the
413 * compiler uses excessive CPU stack (for example, this may happen in the
414 * debug case if code optimzation is disabled.)
415 */
416#ifndef ACPI_SIMPLE_RETURN_MACROS
417
418#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
419 register ACPI_STATUS _s = (s); \
420 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \
421 return (_s); })
422#define return_PTR(s) ACPI_DO_WHILE0 ({ \
423 register void *_s = (void *) (s); \
424 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \
425 return (_s); })
426#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
427 register UINT64 _s = (s); \
428 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \
429 return (_s); })
430#define return_UINT8(s) ACPI_DO_WHILE0 ({ \
431 register UINT8 _s = (UINT8) (s); \
432 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \
433 return (_s); })
434#define return_UINT32(s) ACPI_DO_WHILE0 ({ \
435 register UINT32 _s = (UINT32) (s); \
436 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \
437 return (_s); })
438#else /* Use original less-safe macros */
439
440#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
441 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \
442 return((s)); })
443#define return_PTR(s) ACPI_DO_WHILE0 ({ \
444 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \
445 return((s)); })
446#define return_VALUE(s) ACPI_DO_WHILE0 ({ \
447 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) (s)); \
448 return((s)); })
449#define return_UINT8(s) return_VALUE(s)
450#define return_UINT32(s) return_VALUE(s)
451
452#endif /* ACPI_SIMPLE_RETURN_MACROS */
453
454/* Conditional execution */
455
456#define ACPI_DEBUG_EXEC(a) a
457#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
458#define _VERBOSE_STRUCTURES
459
460
461/* Various object display routines for debug */
462
463#define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0)
464#define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c)
465#define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b)
466#define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d)
467#define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
468
469#else
470/*
471 * This is the non-debug case -- make everything go away,
472 * leaving no executable debug code!
473 */
474#define ACPI_DEBUG_EXEC(a)
475#define ACPI_DEBUG_ONLY_MEMBERS(a)
476#define ACPI_FUNCTION_TRACE(a)
477#define ACPI_FUNCTION_TRACE_PTR(a, b)
478#define ACPI_FUNCTION_TRACE_U32(a, b)
479#define ACPI_FUNCTION_TRACE_STR(a, b)
480#define ACPI_FUNCTION_EXIT
481#define ACPI_FUNCTION_STATUS_EXIT(s)
482#define ACPI_FUNCTION_VALUE_EXIT(s)
483#define ACPI_FUNCTION_ENTRY()
484#define ACPI_DUMP_STACK_ENTRY(a)
485#define ACPI_DUMP_OPERANDS(a, b, c)
486#define ACPI_DUMP_ENTRY(a, b)
487#define ACPI_DUMP_TABLES(a, b)
488#define ACPI_DUMP_PATHNAME(a, b, c, d)
489#define ACPI_DUMP_BUFFER(a, b)
490#define ACPI_DEBUG_PRINT(pl)
491#define ACPI_DEBUG_PRINT_RAW(pl)
492
493#define return_VOID return
494#define return_ACPI_STATUS(s) return(s)
495#define return_VALUE(s) return(s)
496#define return_UINT8(s) return(s)
497#define return_UINT32(s) return(s)
498#define return_PTR(s) return(s)
499
500#endif /* ACPI_DEBUG_OUTPUT */
501
502
503#if (!ACPI_REDUCED_HARDWARE)
504#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr
505#else
506#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL
507#endif
508
509
510/*
511 * Some code only gets executed when the debugger is built in.
512 * Note that this is entirely independent of whether the
513 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
514 */
515#ifdef ACPI_DEBUGGER
516#define ACPI_DEBUGGER_EXEC(a) a
517#else
518#define ACPI_DEBUGGER_EXEC(a)
519#endif
520
521
522/*
523 * Memory allocation tracking (DEBUG ONLY)
524 */
525#define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__
526
527#ifndef ACPI_DBG_TRACK_ALLOCATIONS
528
529/* Memory allocation */
530
531#define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
532#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
533#define ACPI_FREE(a) AcpiOsFree(a)
534#define ACPI_MEM_TRACKING(a)
535
536#else
537
538/* Memory allocation */
539
540#define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
541#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
542#define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS)
543#define ACPI_MEM_TRACKING(a) a
544
545#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
546
547
548/*
549 * Macros used for ACPICA utilities only
550 */
551
552/* Generate a UUID */
553
554#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
555 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
556 (b) & 0xFF, ((b) >> 8) & 0xFF, \
557 (c) & 0xFF, ((c) >> 8) & 0xFF, \
558 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
559
560#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7'))
561
562
563#endif /* ACMACROS_H */
|