1/******************************************************************************
2 *
3 * Name: acmacros.h - C macros for the entire subsystem.
| 1/******************************************************************************
2 *
3 * Name: acmacros.h - C macros for the entire subsystem.
|
4 * $Revision: 97 $
| 4 * $Revision: 100 $
|
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#ifndef __ACMACROS_H__
118#define __ACMACROS_H__
119
120
121/*
122 * Data manipulation macros
123 */
124
125#ifndef LOWORD
126#define LOWORD(l) ((UINT16)(NATIVE_UINT)(l))
127#endif
128
129#ifndef HIWORD
130#define HIWORD(l) ((UINT16)((((NATIVE_UINT)(l)) >> 16) & 0xFFFF))
131#endif
132
133#ifndef LOBYTE
134#define LOBYTE(l) ((UINT8)(UINT16)(l))
135#endif
136
137#ifndef HIBYTE
138#define HIBYTE(l) ((UINT8)((((UINT16)(l)) >> 8) & 0xFF))
139#endif
140
141#define BIT0(x) ((((x) & 0x01) > 0) ? 1 : 0)
142#define BIT1(x) ((((x) & 0x02) > 0) ? 1 : 0)
143#define BIT2(x) ((((x) & 0x04) > 0) ? 1 : 0)
144
145#define BIT3(x) ((((x) & 0x08) > 0) ? 1 : 0)
146#define BIT4(x) ((((x) & 0x10) > 0) ? 1 : 0)
147#define BIT5(x) ((((x) & 0x20) > 0) ? 1 : 0)
148#define BIT6(x) ((((x) & 0x40) > 0) ? 1 : 0)
149#define BIT7(x) ((((x) & 0x80) > 0) ? 1 : 0)
150
151#define LOW_BASE(w) ((UINT16) ((w) & 0x0000FFFF))
152#define MID_BASE(b) ((UINT8) (((b) & 0x00FF0000) >> 16))
153#define HI_BASE(b) ((UINT8) (((b) & 0xFF000000) >> 24))
154#define LOW_LIMIT(w) ((UINT16) ((w) & 0x0000FFFF))
155#define HI_LIMIT(b) ((UINT8) (((b) & 0x00FF0000) >> 16))
156
157
158#ifdef _IA16
159/*
160 * For 16-bit addresses, we have to assume that the upper 32 bits
161 * are zero.
162 */
163#ifndef LODWORD
164#define LODWORD(l) (l)
165#endif
166
167#ifndef HIDWORD
168#define HIDWORD(l) (0)
169#endif
170
171#define ACPI_GET_ADDRESS(a) ((a).Lo)
172#define ACPI_STORE_ADDRESS(a,b) {(a).Hi=0;(a).Lo=(b);}
173#define ACPI_VALID_ADDRESS(a) ((a).Hi | (a).Lo)
174
175#else
176#ifdef ACPI_NO_INTEGER64_SUPPORT
177/*
178 * ACPI_INTEGER is 32-bits, no 64-bit support on this platform
179 */
180#ifndef LODWORD
181#define LODWORD(l) ((UINT32)(l))
182#endif
183
184#ifndef HIDWORD
185#define HIDWORD(l) (0)
186#endif
187
188#define ACPI_GET_ADDRESS(a) (a)
189#define ACPI_STORE_ADDRESS(a,b) ((a)=(b))
190#define ACPI_VALID_ADDRESS(a) (a)
191
192#else
193
194/*
195 * Full 64-bit address/integer on both 32-bit and 64-bit platforms
196 */
197#ifndef LODWORD
198#define LODWORD(l) ((UINT32)(UINT64)(l))
199#endif
200
201#ifndef HIDWORD
202#define HIDWORD(l) ((UINT32)(((*(UINT64_STRUCT *)(&l))).Hi))
203#endif
204
205#define ACPI_GET_ADDRESS(a) (a)
206#define ACPI_STORE_ADDRESS(a,b) ((a)=(b))
207#define ACPI_VALID_ADDRESS(a) (a)
208#endif
209#endif
210
211 /*
212 * Extract a byte of data using a pointer. Any more than a byte and we
213 * get into potential aligment issues -- see the STORE macros below
214 */
215#define GET8(addr) (*(UINT8*)(addr))
216
217/* Pointer arithmetic */
218
219
220#define POINTER_ADD(t,a,b) (t *) ((NATIVE_UINT)(a) + (NATIVE_UINT)(b))
221#define POINTER_DIFF(a,b) ((UINT32) ((NATIVE_UINT)(a) - (NATIVE_UINT)(b)))
222
223/*
224 * Macros for moving data around to/from buffers that are possibly unaligned.
225 * If the hardware supports the transfer of unaligned data, just do the store.
226 * Otherwise, we have to move one byte at a time.
227 */
228
229#ifdef _HW_ALIGNMENT_SUPPORT
230
231/* The hardware supports unaligned transfers, just do the move */
232
233#define MOVE_UNALIGNED16_TO_16(d,s) *(UINT16*)(d) = *(UINT16*)(s)
234#define MOVE_UNALIGNED32_TO_32(d,s) *(UINT32*)(d) = *(UINT32*)(s)
235#define MOVE_UNALIGNED16_TO_32(d,s) *(UINT32*)(d) = *(UINT16*)(s)
236#define MOVE_UNALIGNED64_TO_64(d,s) *(UINT64*)(d) = *(UINT64*)(s)
237
238#else
239/*
240 * The hardware does not support unaligned transfers. We must move the
241 * data one byte at a time. These macros work whether the source or
242 * the destination (or both) is/are unaligned.
243 */
244
245#define MOVE_UNALIGNED16_TO_16(d,s) {((UINT8 *)(d))[0] = ((UINT8 *)(s))[0];\
246 ((UINT8 *)(d))[1] = ((UINT8 *)(s))[1];}
247
248#define MOVE_UNALIGNED32_TO_32(d,s) {((UINT8 *)(d))[0] = ((UINT8 *)(s))[0];\
249 ((UINT8 *)(d))[1] = ((UINT8 *)(s))[1];\
250 ((UINT8 *)(d))[2] = ((UINT8 *)(s))[2];\
251 ((UINT8 *)(d))[3] = ((UINT8 *)(s))[3];}
252
253#define MOVE_UNALIGNED16_TO_32(d,s) {(*(UINT32*)(d)) = 0; MOVE_UNALIGNED16_TO_16(d,s);}
254
255#define MOVE_UNALIGNED64_TO_64(d,s) {((UINT8 *)(d))[0] = ((UINT8 *)(s))[0];\
256 ((UINT8 *)(d))[1] = ((UINT8 *)(s))[1];\
257 ((UINT8 *)(d))[2] = ((UINT8 *)(s))[2];\
258 ((UINT8 *)(d))[3] = ((UINT8 *)(s))[3];\
259 ((UINT8 *)(d))[4] = ((UINT8 *)(s))[4];\
260 ((UINT8 *)(d))[5] = ((UINT8 *)(s))[5];\
261 ((UINT8 *)(d))[6] = ((UINT8 *)(s))[6];\
262 ((UINT8 *)(d))[7] = ((UINT8 *)(s))[7];}
263
264#endif
265
266
267/*
268 * Fast power-of-two math macros for non-optimized compilers
269 */
270
271#define _DIV(value,PowerOf2) ((UINT32) ((value) >> (PowerOf2)))
272#define _MUL(value,PowerOf2) ((UINT32) ((value) << (PowerOf2)))
273#define _MOD(value,Divisor) ((UINT32) ((value) & ((Divisor) -1)))
274
275#define DIV_2(a) _DIV(a,1)
276#define MUL_2(a) _MUL(a,1)
277#define MOD_2(a) _MOD(a,2)
278
279#define DIV_4(a) _DIV(a,2)
280#define MUL_4(a) _MUL(a,2)
281#define MOD_4(a) _MOD(a,4)
282
283#define DIV_8(a) _DIV(a,3)
284#define MUL_8(a) _MUL(a,3)
285#define MOD_8(a) _MOD(a,8)
286
287#define DIV_16(a) _DIV(a,4)
288#define MUL_16(a) _MUL(a,4)
289#define MOD_16(a) _MOD(a,16)
290
291
292/*
293 * Rounding macros (Power of two boundaries only)
294 */
295#define ROUND_DOWN(value,boundary) ((value) & (~((boundary)-1)))
296#define ROUND_UP(value,boundary) (((value) + ((boundary)-1)) & (~((boundary)-1)))
297
298#define ROUND_DOWN_TO_32_BITS(a) ROUND_DOWN(a,4)
299#define ROUND_DOWN_TO_64_BITS(a) ROUND_DOWN(a,8)
300#define ROUND_DOWN_TO_NATIVE_WORD(a) ROUND_DOWN(a,ALIGNED_ADDRESS_BOUNDARY)
301
302#define ROUND_UP_TO_32BITS(a) ROUND_UP(a,4)
303#define ROUND_UP_TO_64BITS(a) ROUND_UP(a,8)
304#define ROUND_UP_TO_NATIVE_WORD(a) ROUND_UP(a,ALIGNED_ADDRESS_BOUNDARY)
305
306#define ROUND_PTR_UP_TO_4(a,b) ((b *)(((NATIVE_UINT)(a) + 3) & ~3))
307#define ROUND_PTR_UP_TO_8(a,b) ((b *)(((NATIVE_UINT)(a) + 7) & ~7))
308
309#define ROUND_BITS_UP_TO_BYTES(a) DIV_8((a) + 7)
310#define ROUND_BITS_DOWN_TO_BYTES(a) DIV_8((a))
311
312#define ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
313
314/* Generic (non-power-of-two) rounding */
315
316#define ROUND_UP_TO(value,boundary) (((value) + ((boundary)-1)) / (boundary))
317
318/*
319 * Bitmask creation
320 * Bit positions start at zero.
321 * MASK_BITS_ABOVE creates a mask starting AT the position and above
322 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
323 */
| 5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#ifndef __ACMACROS_H__
118#define __ACMACROS_H__
119
120
121/*
122 * Data manipulation macros
123 */
124
125#ifndef LOWORD
126#define LOWORD(l) ((UINT16)(NATIVE_UINT)(l))
127#endif
128
129#ifndef HIWORD
130#define HIWORD(l) ((UINT16)((((NATIVE_UINT)(l)) >> 16) & 0xFFFF))
131#endif
132
133#ifndef LOBYTE
134#define LOBYTE(l) ((UINT8)(UINT16)(l))
135#endif
136
137#ifndef HIBYTE
138#define HIBYTE(l) ((UINT8)((((UINT16)(l)) >> 8) & 0xFF))
139#endif
140
141#define BIT0(x) ((((x) & 0x01) > 0) ? 1 : 0)
142#define BIT1(x) ((((x) & 0x02) > 0) ? 1 : 0)
143#define BIT2(x) ((((x) & 0x04) > 0) ? 1 : 0)
144
145#define BIT3(x) ((((x) & 0x08) > 0) ? 1 : 0)
146#define BIT4(x) ((((x) & 0x10) > 0) ? 1 : 0)
147#define BIT5(x) ((((x) & 0x20) > 0) ? 1 : 0)
148#define BIT6(x) ((((x) & 0x40) > 0) ? 1 : 0)
149#define BIT7(x) ((((x) & 0x80) > 0) ? 1 : 0)
150
151#define LOW_BASE(w) ((UINT16) ((w) & 0x0000FFFF))
152#define MID_BASE(b) ((UINT8) (((b) & 0x00FF0000) >> 16))
153#define HI_BASE(b) ((UINT8) (((b) & 0xFF000000) >> 24))
154#define LOW_LIMIT(w) ((UINT16) ((w) & 0x0000FFFF))
155#define HI_LIMIT(b) ((UINT8) (((b) & 0x00FF0000) >> 16))
156
157
158#ifdef _IA16
159/*
160 * For 16-bit addresses, we have to assume that the upper 32 bits
161 * are zero.
162 */
163#ifndef LODWORD
164#define LODWORD(l) (l)
165#endif
166
167#ifndef HIDWORD
168#define HIDWORD(l) (0)
169#endif
170
171#define ACPI_GET_ADDRESS(a) ((a).Lo)
172#define ACPI_STORE_ADDRESS(a,b) {(a).Hi=0;(a).Lo=(b);}
173#define ACPI_VALID_ADDRESS(a) ((a).Hi | (a).Lo)
174
175#else
176#ifdef ACPI_NO_INTEGER64_SUPPORT
177/*
178 * ACPI_INTEGER is 32-bits, no 64-bit support on this platform
179 */
180#ifndef LODWORD
181#define LODWORD(l) ((UINT32)(l))
182#endif
183
184#ifndef HIDWORD
185#define HIDWORD(l) (0)
186#endif
187
188#define ACPI_GET_ADDRESS(a) (a)
189#define ACPI_STORE_ADDRESS(a,b) ((a)=(b))
190#define ACPI_VALID_ADDRESS(a) (a)
191
192#else
193
194/*
195 * Full 64-bit address/integer on both 32-bit and 64-bit platforms
196 */
197#ifndef LODWORD
198#define LODWORD(l) ((UINT32)(UINT64)(l))
199#endif
200
201#ifndef HIDWORD
202#define HIDWORD(l) ((UINT32)(((*(UINT64_STRUCT *)(&l))).Hi))
203#endif
204
205#define ACPI_GET_ADDRESS(a) (a)
206#define ACPI_STORE_ADDRESS(a,b) ((a)=(b))
207#define ACPI_VALID_ADDRESS(a) (a)
208#endif
209#endif
210
211 /*
212 * Extract a byte of data using a pointer. Any more than a byte and we
213 * get into potential aligment issues -- see the STORE macros below
214 */
215#define GET8(addr) (*(UINT8*)(addr))
216
217/* Pointer arithmetic */
218
219
220#define POINTER_ADD(t,a,b) (t *) ((NATIVE_UINT)(a) + (NATIVE_UINT)(b))
221#define POINTER_DIFF(a,b) ((UINT32) ((NATIVE_UINT)(a) - (NATIVE_UINT)(b)))
222
223/*
224 * Macros for moving data around to/from buffers that are possibly unaligned.
225 * If the hardware supports the transfer of unaligned data, just do the store.
226 * Otherwise, we have to move one byte at a time.
227 */
228
229#ifdef _HW_ALIGNMENT_SUPPORT
230
231/* The hardware supports unaligned transfers, just do the move */
232
233#define MOVE_UNALIGNED16_TO_16(d,s) *(UINT16*)(d) = *(UINT16*)(s)
234#define MOVE_UNALIGNED32_TO_32(d,s) *(UINT32*)(d) = *(UINT32*)(s)
235#define MOVE_UNALIGNED16_TO_32(d,s) *(UINT32*)(d) = *(UINT16*)(s)
236#define MOVE_UNALIGNED64_TO_64(d,s) *(UINT64*)(d) = *(UINT64*)(s)
237
238#else
239/*
240 * The hardware does not support unaligned transfers. We must move the
241 * data one byte at a time. These macros work whether the source or
242 * the destination (or both) is/are unaligned.
243 */
244
245#define MOVE_UNALIGNED16_TO_16(d,s) {((UINT8 *)(d))[0] = ((UINT8 *)(s))[0];\
246 ((UINT8 *)(d))[1] = ((UINT8 *)(s))[1];}
247
248#define MOVE_UNALIGNED32_TO_32(d,s) {((UINT8 *)(d))[0] = ((UINT8 *)(s))[0];\
249 ((UINT8 *)(d))[1] = ((UINT8 *)(s))[1];\
250 ((UINT8 *)(d))[2] = ((UINT8 *)(s))[2];\
251 ((UINT8 *)(d))[3] = ((UINT8 *)(s))[3];}
252
253#define MOVE_UNALIGNED16_TO_32(d,s) {(*(UINT32*)(d)) = 0; MOVE_UNALIGNED16_TO_16(d,s);}
254
255#define MOVE_UNALIGNED64_TO_64(d,s) {((UINT8 *)(d))[0] = ((UINT8 *)(s))[0];\
256 ((UINT8 *)(d))[1] = ((UINT8 *)(s))[1];\
257 ((UINT8 *)(d))[2] = ((UINT8 *)(s))[2];\
258 ((UINT8 *)(d))[3] = ((UINT8 *)(s))[3];\
259 ((UINT8 *)(d))[4] = ((UINT8 *)(s))[4];\
260 ((UINT8 *)(d))[5] = ((UINT8 *)(s))[5];\
261 ((UINT8 *)(d))[6] = ((UINT8 *)(s))[6];\
262 ((UINT8 *)(d))[7] = ((UINT8 *)(s))[7];}
263
264#endif
265
266
267/*
268 * Fast power-of-two math macros for non-optimized compilers
269 */
270
271#define _DIV(value,PowerOf2) ((UINT32) ((value) >> (PowerOf2)))
272#define _MUL(value,PowerOf2) ((UINT32) ((value) << (PowerOf2)))
273#define _MOD(value,Divisor) ((UINT32) ((value) & ((Divisor) -1)))
274
275#define DIV_2(a) _DIV(a,1)
276#define MUL_2(a) _MUL(a,1)
277#define MOD_2(a) _MOD(a,2)
278
279#define DIV_4(a) _DIV(a,2)
280#define MUL_4(a) _MUL(a,2)
281#define MOD_4(a) _MOD(a,4)
282
283#define DIV_8(a) _DIV(a,3)
284#define MUL_8(a) _MUL(a,3)
285#define MOD_8(a) _MOD(a,8)
286
287#define DIV_16(a) _DIV(a,4)
288#define MUL_16(a) _MUL(a,4)
289#define MOD_16(a) _MOD(a,16)
290
291
292/*
293 * Rounding macros (Power of two boundaries only)
294 */
295#define ROUND_DOWN(value,boundary) ((value) & (~((boundary)-1)))
296#define ROUND_UP(value,boundary) (((value) + ((boundary)-1)) & (~((boundary)-1)))
297
298#define ROUND_DOWN_TO_32_BITS(a) ROUND_DOWN(a,4)
299#define ROUND_DOWN_TO_64_BITS(a) ROUND_DOWN(a,8)
300#define ROUND_DOWN_TO_NATIVE_WORD(a) ROUND_DOWN(a,ALIGNED_ADDRESS_BOUNDARY)
301
302#define ROUND_UP_TO_32BITS(a) ROUND_UP(a,4)
303#define ROUND_UP_TO_64BITS(a) ROUND_UP(a,8)
304#define ROUND_UP_TO_NATIVE_WORD(a) ROUND_UP(a,ALIGNED_ADDRESS_BOUNDARY)
305
306#define ROUND_PTR_UP_TO_4(a,b) ((b *)(((NATIVE_UINT)(a) + 3) & ~3))
307#define ROUND_PTR_UP_TO_8(a,b) ((b *)(((NATIVE_UINT)(a) + 7) & ~7))
308
309#define ROUND_BITS_UP_TO_BYTES(a) DIV_8((a) + 7)
310#define ROUND_BITS_DOWN_TO_BYTES(a) DIV_8((a))
311
312#define ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
313
314/* Generic (non-power-of-two) rounding */
315
316#define ROUND_UP_TO(value,boundary) (((value) + ((boundary)-1)) / (boundary))
317
318/*
319 * Bitmask creation
320 * Bit positions start at zero.
321 * MASK_BITS_ABOVE creates a mask starting AT the position and above
322 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
323 */
|
324#define MASK_BITS_ABOVE(position) (~(((UINT32)(-1)) << ((UINT32) (position))))
325#define MASK_BITS_BELOW(position) (((UINT32)(-1)) << ((UINT32) (position)))
| 324#define MASK_BITS_ABOVE(position) (~(((ACPI_INTEGER)(-1)) << ((UINT32) (position))))
325#define MASK_BITS_BELOW(position) (((ACPI_INTEGER)(-1)) << ((UINT32) (position)))
|
326
327
328/* Macros for GAS addressing */
329
330#ifndef _IA16
331
332#define ACPI_PCI_DEVICE_MASK (UINT64) 0x0000FFFF00000000
333#define ACPI_PCI_FUNCTION_MASK (UINT64) 0x00000000FFFF0000
334#define ACPI_PCI_REGISTER_MASK (UINT64) 0x000000000000FFFF
335
336#define ACPI_PCI_FUNCTION(a) (UINT16) ((((a) & ACPI_PCI_FUNCTION_MASK) >> 16))
337#define ACPI_PCI_DEVICE(a) (UINT16) ((((a) & ACPI_PCI_DEVICE_MASK) >> 32))
338#define ACPI_PCI_REGISTER(a) (UINT16) (((a) & ACPI_PCI_REGISTER_MASK))
339
340#else
341
342/* No support for GAS and PCI IDs in 16-bit mode */
343
344#define ACPI_PCI_FUNCTION(a) (UINT16) ((a) & 0xFFFF0000)
345#define ACPI_PCI_DEVICE(a) (UINT16) ((a) & 0x0000FFFF)
346#define ACPI_PCI_REGISTER(a) (UINT16) ((a) & 0x0000FFFF)
347
348#endif
349
350/*
| 326
327
328/* Macros for GAS addressing */
329
330#ifndef _IA16
331
332#define ACPI_PCI_DEVICE_MASK (UINT64) 0x0000FFFF00000000
333#define ACPI_PCI_FUNCTION_MASK (UINT64) 0x00000000FFFF0000
334#define ACPI_PCI_REGISTER_MASK (UINT64) 0x000000000000FFFF
335
336#define ACPI_PCI_FUNCTION(a) (UINT16) ((((a) & ACPI_PCI_FUNCTION_MASK) >> 16))
337#define ACPI_PCI_DEVICE(a) (UINT16) ((((a) & ACPI_PCI_DEVICE_MASK) >> 32))
338#define ACPI_PCI_REGISTER(a) (UINT16) (((a) & ACPI_PCI_REGISTER_MASK))
339
340#else
341
342/* No support for GAS and PCI IDs in 16-bit mode */
343
344#define ACPI_PCI_FUNCTION(a) (UINT16) ((a) & 0xFFFF0000)
345#define ACPI_PCI_DEVICE(a) (UINT16) ((a) & 0x0000FFFF)
346#define ACPI_PCI_REGISTER(a) (UINT16) ((a) & 0x0000FFFF)
347
348#endif
349
350/*
|
351 * An ACPI_HANDLE (which is actually an ACPI_NAMESPACE_NODE *) can appear in some contexts,
352 * such as on apObjStack, where a pointer to an ACPI_OPERAND_OBJECT can also
| 351 * An ACPI_NAMESPACE_NODE * can appear in some contexts,
352 * where a pointer to an ACPI_OPERAND_OBJECT can also
|
353 * appear. This macro is used to distinguish them.
354 *
355 * The DataType field is the first field in both structures.
356 */
357#define VALID_DESCRIPTOR_TYPE(d,t) (((ACPI_NAMESPACE_NODE *)d)->DataType == t)
358
359
360/* Macro to test the object type */
361
362#define IS_THIS_OBJECT_TYPE(d,t) (((ACPI_OPERAND_OBJECT *)d)->Common.Type == (UINT8)t)
363
364/* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */
365
366#define IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0)
367
368/*
369 * Macro to check if a pointer is within an ACPI table.
370 * Parameter (a) is the pointer to check. Parameter (b) must be defined
371 * as a pointer to an ACPI_TABLE_HEADER. (b+1) then points past the header,
372 * and ((UINT8 *)b+b->Length) points one byte past the end of the table.
373 */
374#ifndef _IA16
375#define IS_IN_ACPI_TABLE(a,b) (((UINT8 *)(a) >= (UINT8 *)(b + 1)) &&\
376 ((UINT8 *)(a) < ((UINT8 *)b + b->Length)))
377
378#else
379#define IS_IN_ACPI_TABLE(a,b) (_segment)(a) == (_segment)(b) &&\
380 (((UINT8 *)(a) >= (UINT8 *)(b + 1)) &&\
381 ((UINT8 *)(a) < ((UINT8 *)b + b->Length)))
382#endif
383
384/*
385 * Macros for the master AML opcode table
386 */
387#ifdef ACPI_DEBUG
| 353 * appear. This macro is used to distinguish them.
354 *
355 * The DataType field is the first field in both structures.
356 */
357#define VALID_DESCRIPTOR_TYPE(d,t) (((ACPI_NAMESPACE_NODE *)d)->DataType == t)
358
359
360/* Macro to test the object type */
361
362#define IS_THIS_OBJECT_TYPE(d,t) (((ACPI_OPERAND_OBJECT *)d)->Common.Type == (UINT8)t)
363
364/* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */
365
366#define IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0)
367
368/*
369 * Macro to check if a pointer is within an ACPI table.
370 * Parameter (a) is the pointer to check. Parameter (b) must be defined
371 * as a pointer to an ACPI_TABLE_HEADER. (b+1) then points past the header,
372 * and ((UINT8 *)b+b->Length) points one byte past the end of the table.
373 */
374#ifndef _IA16
375#define IS_IN_ACPI_TABLE(a,b) (((UINT8 *)(a) >= (UINT8 *)(b + 1)) &&\
376 ((UINT8 *)(a) < ((UINT8 *)b + b->Length)))
377
378#else
379#define IS_IN_ACPI_TABLE(a,b) (_segment)(a) == (_segment)(b) &&\
380 (((UINT8 *)(a) >= (UINT8 *)(b + 1)) &&\
381 ((UINT8 *)(a) < ((UINT8 *)b + b->Length)))
382#endif
383
384/*
385 * Macros for the master AML opcode table
386 */
387#ifdef ACPI_DEBUG
|
388#define ACPI_OP(Name,PArgs,IArgs,Class,Type,Flags) {PArgs,IArgs,Flags,Class,Type,Name}
| 388#define ACPI_OP(Name,PArgs,IArgs,ObjType,Class,Type,Flags) {Name,PArgs,IArgs,Flags,ObjType,Class,Type}
|
389#else
| 389#else
|
390#define ACPI_OP(Name,PArgs,IArgs,Class,Type,Flags) {PArgs,IArgs,Flags,Class,Type}
| 390#define ACPI_OP(Name,PArgs,IArgs,ObjType,Class,Type,Flags) {PArgs,IArgs,Flags,ObjType,Class,Type}
|
391#endif
392
393#define ARG_TYPE_WIDTH 5
394#define ARG_1(x) ((UINT32)(x))
395#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
396#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
397#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
398#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
399#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
400
401#define ARGI_LIST1(a) (ARG_1(a))
402#define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a))
403#define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
404#define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
405#define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
406#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))
407
408#define ARGP_LIST1(a) (ARG_1(a))
409#define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b))
410#define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
411#define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
412#define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
413#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))
414
415#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F))
416#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH))
417
418
419/*
420 * Build a GAS structure from earlier ACPI table entries (V1.0 and 0.71 extensions)
421 *
422 * 1) Address space
423 * 2) Length in bytes -- convert to length in bits
424 * 3) Bit offset is zero
425 * 4) Reserved field is zero
426 * 5) Expand address to 64 bits
427 */
428#define ASL_BUILD_GAS_FROM_ENTRY(a,b,c,d) {a.AddressSpaceId = (UINT8) d;\
429 a.RegisterBitWidth = (UINT8) MUL_8 (b);\
430 a.RegisterBitOffset = 0;\
431 a.Reserved = 0;\
432 ACPI_STORE_ADDRESS (a.Address,c);}
433
434/* ACPI V1.0 entries -- address space is always I/O */
435
436#define ASL_BUILD_GAS_FROM_V1_ENTRY(a,b,c) ASL_BUILD_GAS_FROM_ENTRY(a,b,c,ACPI_ADR_SPACE_SYSTEM_IO)
437
438
439/*
440 * Reporting macros that are never compiled out
441 */
442
443#define PARAM_LIST(pl) pl
444
445/*
446 * Error reporting. These versions add callers module and line#. Since
447 * _THIS_MODULE gets compiled out when ACPI_DEBUG isn't defined, only
448 * use it in debug mode.
449 */
450
451#ifdef ACPI_DEBUG
452
453#define REPORT_INFO(fp) {AcpiUtReportInfo(_THIS_MODULE,__LINE__,_COMPONENT); \
454 AcpiOsPrintf PARAM_LIST(fp);}
455#define REPORT_ERROR(fp) {AcpiUtReportError(_THIS_MODULE,__LINE__,_COMPONENT); \
456 AcpiOsPrintf PARAM_LIST(fp);}
457#define REPORT_WARNING(fp) {AcpiUtReportWarning(_THIS_MODULE,__LINE__,_COMPONENT); \
458 AcpiOsPrintf PARAM_LIST(fp);}
459
460#else
461
462#define REPORT_INFO(fp) {AcpiUtReportInfo("ACPI",__LINE__,_COMPONENT); \
463 AcpiOsPrintf PARAM_LIST(fp);}
464#define REPORT_ERROR(fp) {AcpiUtReportError("ACPI",__LINE__,_COMPONENT); \
465 AcpiOsPrintf PARAM_LIST(fp);}
466#define REPORT_WARNING(fp) {AcpiUtReportWarning("ACPI",__LINE__,_COMPONENT); \
467 AcpiOsPrintf PARAM_LIST(fp);}
468
469#endif
470
471/* Error reporting. These versions pass thru the module and line# */
472
473#define _REPORT_INFO(a,b,c,fp) {AcpiUtReportInfo(a,b,c); \
474 AcpiOsPrintf PARAM_LIST(fp);}
475#define _REPORT_ERROR(a,b,c,fp) {AcpiUtReportError(a,b,c); \
476 AcpiOsPrintf PARAM_LIST(fp);}
477#define _REPORT_WARNING(a,b,c,fp) {AcpiUtReportWarning(a,b,c); \
478 AcpiOsPrintf PARAM_LIST(fp);}
479
480/*
481 * Debug macros that are conditionally compiled
482 */
483
484#ifdef ACPI_DEBUG
485
486#define MODULE_NAME(name) static char *_THIS_MODULE = name;
487
488/*
489 * Function entry tracing.
490 * The first parameter should be the procedure name as a quoted string. This is declared
491 * as a local string ("_ProcName) so that it can be also used by the function exit macros below.
492 */
493
494#define PROC_NAME(a) ACPI_DEBUG_PRINT_INFO _Dbg; \
495 _Dbg.ComponentId = _COMPONENT; \
496 _Dbg.ProcName = a; \
497 _Dbg.ModuleName = _THIS_MODULE;
498
499#define FUNCTION_TRACE(a) PROC_NAME(a)\
500 AcpiUtTrace(__LINE__,&_Dbg)
501#define FUNCTION_TRACE_PTR(a,b) PROC_NAME(a)\
502 AcpiUtTracePtr(__LINE__,&_Dbg,(void *)b)
503#define FUNCTION_TRACE_U32(a,b) PROC_NAME(a)\
504 AcpiUtTraceU32(__LINE__,&_Dbg,(UINT32)b)
505#define FUNCTION_TRACE_STR(a,b) PROC_NAME(a)\
506 AcpiUtTraceStr(__LINE__,&_Dbg,(NATIVE_CHAR *)b)
507
508#define FUNCTION_ENTRY() AcpiUtTrackStackPtr()
509
510/*
511 * Function exit tracing.
512 * WARNING: These macros include a return statement. This is usually considered
513 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
514 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
515 * so that "_ProcName" is defined.
516 */
517#define return_VOID {AcpiUtExit(__LINE__,&_Dbg);return;}
518#define return_ACPI_STATUS(s) {AcpiUtStatusExit(__LINE__,&_Dbg,s);return(s);}
519#define return_VALUE(s) {AcpiUtValueExit(__LINE__,&_Dbg,s);return(s);}
520#define return_PTR(s) {AcpiUtPtrExit(__LINE__,&_Dbg,(UINT8 *)s);return(s);}
521
522
523/* Conditional execution */
524
525#define DEBUG_EXEC(a) a
526#define NORMAL_EXEC(a)
527
528#define DEBUG_DEFINE(a) a;
529#define DEBUG_ONLY_MEMBERS(a) a;
530#define _OPCODE_NAMES
531#define _VERBOSE_STRUCTURES
532
533
534/* Stack and buffer dumping */
535
536#define DUMP_STACK_ENTRY(a) AcpiExDumpOperand(a)
537#define DUMP_OPERANDS(a,b,c,d,e) AcpiExDumpOperands(a,b,c,d,e,_THIS_MODULE,__LINE__)
538
539
540#define DUMP_ENTRY(a,b) AcpiNsDumpEntry (a,b)
541#define DUMP_TABLES(a,b) AcpiNsDumpTables(a,b)
542#define DUMP_PATHNAME(a,b,c,d) AcpiNsDumpPathname(a,b,c,d)
543#define DUMP_RESOURCE_LIST(a) AcpiRsDumpResourceList(a)
544#define DUMP_BUFFER(a,b) AcpiUtDumpBuffer((UINT8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT)
545#define BREAK_MSG(a) AcpiOsSignal (ACPI_SIGNAL_BREAKPOINT,(a))
546
547
548/*
549 * Generate INT3 on ACPI_ERROR (Debug only!)
550 */
551
552#define ERROR_BREAK
553#ifdef ERROR_BREAK
554#define BREAK_ON_ERROR(lvl) if ((lvl)&ACPI_ERROR) AcpiOsSignal(ACPI_SIGNAL_BREAKPOINT,"Fatal error encountered\n")
555#else
556#define BREAK_ON_ERROR(lvl)
557#endif
558
559/*
560 * Master debug print macros
561 * Print iff:
562 * 1) Debug print for the current component is enabled
563 * 2) Debug error level or trace level for the print statement is enabled
564 */
565
566#define ACPI_DEBUG_PRINT(pl) AcpiUtDebugPrint PARAM_LIST(pl)
567#define ACPI_DEBUG_PRINT_RAW(pl) AcpiUtDebugPrintRaw PARAM_LIST(pl)
568
569
570#else
571/*
572 * This is the non-debug case -- make everything go away,
573 * leaving no executable debug code!
574 */
575
576#define MODULE_NAME(name)
577#define _THIS_MODULE ""
578
579#define DEBUG_EXEC(a)
580#define NORMAL_EXEC(a) a;
581
582#define DEBUG_DEFINE(a)
583#define DEBUG_ONLY_MEMBERS(a)
584#define PROC_NAME(a)
585#define FUNCTION_TRACE(a)
586#define FUNCTION_TRACE_PTR(a,b)
587#define FUNCTION_TRACE_U32(a,b)
588#define FUNCTION_TRACE_STR(a,b)
589#define FUNCTION_EXIT
590#define FUNCTION_STATUS_EXIT(s)
591#define FUNCTION_VALUE_EXIT(s)
592#define FUNCTION_ENTRY()
593#define DUMP_STACK_ENTRY(a)
594#define DUMP_OPERANDS(a,b,c,d,e)
595#define DUMP_ENTRY(a,b)
596#define DUMP_TABLES(a,b)
597#define DUMP_PATHNAME(a,b,c,d)
598#define DUMP_RESOURCE_LIST(a)
599#define DUMP_BUFFER(a,b)
600#define ACPI_DEBUG_PRINT(pl)
601#define ACPI_DEBUG_PRINT_RAW(pl)
602#define BREAK_MSG(a)
603
604#define return_VOID return
605#define return_ACPI_STATUS(s) return(s)
606#define return_VALUE(s) return(s)
607#define return_PTR(s) return(s)
608
609#endif
610
611/*
612 * Some code only gets executed when the debugger is built in.
613 * Note that this is entirely independent of whether the
614 * DEBUG_PRINT stuff (set by ACPI_DEBUG) is on, or not.
615 */
616#ifdef ENABLE_DEBUGGER
617#define DEBUGGER_EXEC(a) a
618#else
619#define DEBUGGER_EXEC(a)
620#endif
621
622
623/*
624 * For 16-bit code, we want to shrink some things even though
625 * we are using ACPI_DEBUG to get the debug output
626 */
627#ifdef _IA16
628#undef DEBUG_ONLY_MEMBERS
629#undef _VERBOSE_STRUCTURES
630#define DEBUG_ONLY_MEMBERS(a)
631#endif
632
633
634#ifdef ACPI_DEBUG
635/*
636 * 1) Set name to blanks
637 * 2) Copy the object name
638 */
639#define ADD_OBJECT_NAME(a,b) MEMSET (a->Common.Name, ' ', sizeof (a->Common.Name));\
640 STRNCPY (a->Common.Name, AcpiGbl_NsTypeNames[b], sizeof (a->Common.Name))
641#else
642
643#define ADD_OBJECT_NAME(a,b)
644#endif
645
646
647/*
648 * Memory allocation tracking (DEBUG ONLY)
649 */
650
651#ifndef ACPI_DBG_TRACK_ALLOCATIONS
652
653/* Memory allocation */
654
655#define ACPI_MEM_ALLOCATE(a) AcpiOsAllocate(a)
656#define ACPI_MEM_CALLOCATE(a) AcpiOsCallocate(a)
657#define ACPI_MEM_FREE(a) AcpiOsFree(a)
658#define ACPI_MEM_TRACKING(a)
659
660
661#else
662
663/* Memory allocation */
664
665#define ACPI_MEM_ALLOCATE(a) AcpiUtAllocate(a,_COMPONENT,_THIS_MODULE,__LINE__)
666#define ACPI_MEM_CALLOCATE(a) AcpiUtCallocate(a, _COMPONENT,_THIS_MODULE,__LINE__)
667#define ACPI_MEM_FREE(a) AcpiUtFree(a,_COMPONENT,_THIS_MODULE,__LINE__)
668#define ACPI_MEM_TRACKING(a) a
669
670#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
671
672
673#define ACPI_GET_STACK_POINTER _asm {mov eax, ebx}
674
675#endif /* ACMACROS_H */
| 391#endif
392
393#define ARG_TYPE_WIDTH 5
394#define ARG_1(x) ((UINT32)(x))
395#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
396#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
397#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
398#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
399#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
400
401#define ARGI_LIST1(a) (ARG_1(a))
402#define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a))
403#define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
404#define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
405#define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
406#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))
407
408#define ARGP_LIST1(a) (ARG_1(a))
409#define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b))
410#define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
411#define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
412#define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
413#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))
414
415#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F))
416#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH))
417
418
419/*
420 * Build a GAS structure from earlier ACPI table entries (V1.0 and 0.71 extensions)
421 *
422 * 1) Address space
423 * 2) Length in bytes -- convert to length in bits
424 * 3) Bit offset is zero
425 * 4) Reserved field is zero
426 * 5) Expand address to 64 bits
427 */
428#define ASL_BUILD_GAS_FROM_ENTRY(a,b,c,d) {a.AddressSpaceId = (UINT8) d;\
429 a.RegisterBitWidth = (UINT8) MUL_8 (b);\
430 a.RegisterBitOffset = 0;\
431 a.Reserved = 0;\
432 ACPI_STORE_ADDRESS (a.Address,c);}
433
434/* ACPI V1.0 entries -- address space is always I/O */
435
436#define ASL_BUILD_GAS_FROM_V1_ENTRY(a,b,c) ASL_BUILD_GAS_FROM_ENTRY(a,b,c,ACPI_ADR_SPACE_SYSTEM_IO)
437
438
439/*
440 * Reporting macros that are never compiled out
441 */
442
443#define PARAM_LIST(pl) pl
444
445/*
446 * Error reporting. These versions add callers module and line#. Since
447 * _THIS_MODULE gets compiled out when ACPI_DEBUG isn't defined, only
448 * use it in debug mode.
449 */
450
451#ifdef ACPI_DEBUG
452
453#define REPORT_INFO(fp) {AcpiUtReportInfo(_THIS_MODULE,__LINE__,_COMPONENT); \
454 AcpiOsPrintf PARAM_LIST(fp);}
455#define REPORT_ERROR(fp) {AcpiUtReportError(_THIS_MODULE,__LINE__,_COMPONENT); \
456 AcpiOsPrintf PARAM_LIST(fp);}
457#define REPORT_WARNING(fp) {AcpiUtReportWarning(_THIS_MODULE,__LINE__,_COMPONENT); \
458 AcpiOsPrintf PARAM_LIST(fp);}
459
460#else
461
462#define REPORT_INFO(fp) {AcpiUtReportInfo("ACPI",__LINE__,_COMPONENT); \
463 AcpiOsPrintf PARAM_LIST(fp);}
464#define REPORT_ERROR(fp) {AcpiUtReportError("ACPI",__LINE__,_COMPONENT); \
465 AcpiOsPrintf PARAM_LIST(fp);}
466#define REPORT_WARNING(fp) {AcpiUtReportWarning("ACPI",__LINE__,_COMPONENT); \
467 AcpiOsPrintf PARAM_LIST(fp);}
468
469#endif
470
471/* Error reporting. These versions pass thru the module and line# */
472
473#define _REPORT_INFO(a,b,c,fp) {AcpiUtReportInfo(a,b,c); \
474 AcpiOsPrintf PARAM_LIST(fp);}
475#define _REPORT_ERROR(a,b,c,fp) {AcpiUtReportError(a,b,c); \
476 AcpiOsPrintf PARAM_LIST(fp);}
477#define _REPORT_WARNING(a,b,c,fp) {AcpiUtReportWarning(a,b,c); \
478 AcpiOsPrintf PARAM_LIST(fp);}
479
480/*
481 * Debug macros that are conditionally compiled
482 */
483
484#ifdef ACPI_DEBUG
485
486#define MODULE_NAME(name) static char *_THIS_MODULE = name;
487
488/*
489 * Function entry tracing.
490 * The first parameter should be the procedure name as a quoted string. This is declared
491 * as a local string ("_ProcName) so that it can be also used by the function exit macros below.
492 */
493
494#define PROC_NAME(a) ACPI_DEBUG_PRINT_INFO _Dbg; \
495 _Dbg.ComponentId = _COMPONENT; \
496 _Dbg.ProcName = a; \
497 _Dbg.ModuleName = _THIS_MODULE;
498
499#define FUNCTION_TRACE(a) PROC_NAME(a)\
500 AcpiUtTrace(__LINE__,&_Dbg)
501#define FUNCTION_TRACE_PTR(a,b) PROC_NAME(a)\
502 AcpiUtTracePtr(__LINE__,&_Dbg,(void *)b)
503#define FUNCTION_TRACE_U32(a,b) PROC_NAME(a)\
504 AcpiUtTraceU32(__LINE__,&_Dbg,(UINT32)b)
505#define FUNCTION_TRACE_STR(a,b) PROC_NAME(a)\
506 AcpiUtTraceStr(__LINE__,&_Dbg,(NATIVE_CHAR *)b)
507
508#define FUNCTION_ENTRY() AcpiUtTrackStackPtr()
509
510/*
511 * Function exit tracing.
512 * WARNING: These macros include a return statement. This is usually considered
513 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
514 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
515 * so that "_ProcName" is defined.
516 */
517#define return_VOID {AcpiUtExit(__LINE__,&_Dbg);return;}
518#define return_ACPI_STATUS(s) {AcpiUtStatusExit(__LINE__,&_Dbg,s);return(s);}
519#define return_VALUE(s) {AcpiUtValueExit(__LINE__,&_Dbg,s);return(s);}
520#define return_PTR(s) {AcpiUtPtrExit(__LINE__,&_Dbg,(UINT8 *)s);return(s);}
521
522
523/* Conditional execution */
524
525#define DEBUG_EXEC(a) a
526#define NORMAL_EXEC(a)
527
528#define DEBUG_DEFINE(a) a;
529#define DEBUG_ONLY_MEMBERS(a) a;
530#define _OPCODE_NAMES
531#define _VERBOSE_STRUCTURES
532
533
534/* Stack and buffer dumping */
535
536#define DUMP_STACK_ENTRY(a) AcpiExDumpOperand(a)
537#define DUMP_OPERANDS(a,b,c,d,e) AcpiExDumpOperands(a,b,c,d,e,_THIS_MODULE,__LINE__)
538
539
540#define DUMP_ENTRY(a,b) AcpiNsDumpEntry (a,b)
541#define DUMP_TABLES(a,b) AcpiNsDumpTables(a,b)
542#define DUMP_PATHNAME(a,b,c,d) AcpiNsDumpPathname(a,b,c,d)
543#define DUMP_RESOURCE_LIST(a) AcpiRsDumpResourceList(a)
544#define DUMP_BUFFER(a,b) AcpiUtDumpBuffer((UINT8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT)
545#define BREAK_MSG(a) AcpiOsSignal (ACPI_SIGNAL_BREAKPOINT,(a))
546
547
548/*
549 * Generate INT3 on ACPI_ERROR (Debug only!)
550 */
551
552#define ERROR_BREAK
553#ifdef ERROR_BREAK
554#define BREAK_ON_ERROR(lvl) if ((lvl)&ACPI_ERROR) AcpiOsSignal(ACPI_SIGNAL_BREAKPOINT,"Fatal error encountered\n")
555#else
556#define BREAK_ON_ERROR(lvl)
557#endif
558
559/*
560 * Master debug print macros
561 * Print iff:
562 * 1) Debug print for the current component is enabled
563 * 2) Debug error level or trace level for the print statement is enabled
564 */
565
566#define ACPI_DEBUG_PRINT(pl) AcpiUtDebugPrint PARAM_LIST(pl)
567#define ACPI_DEBUG_PRINT_RAW(pl) AcpiUtDebugPrintRaw PARAM_LIST(pl)
568
569
570#else
571/*
572 * This is the non-debug case -- make everything go away,
573 * leaving no executable debug code!
574 */
575
576#define MODULE_NAME(name)
577#define _THIS_MODULE ""
578
579#define DEBUG_EXEC(a)
580#define NORMAL_EXEC(a) a;
581
582#define DEBUG_DEFINE(a)
583#define DEBUG_ONLY_MEMBERS(a)
584#define PROC_NAME(a)
585#define FUNCTION_TRACE(a)
586#define FUNCTION_TRACE_PTR(a,b)
587#define FUNCTION_TRACE_U32(a,b)
588#define FUNCTION_TRACE_STR(a,b)
589#define FUNCTION_EXIT
590#define FUNCTION_STATUS_EXIT(s)
591#define FUNCTION_VALUE_EXIT(s)
592#define FUNCTION_ENTRY()
593#define DUMP_STACK_ENTRY(a)
594#define DUMP_OPERANDS(a,b,c,d,e)
595#define DUMP_ENTRY(a,b)
596#define DUMP_TABLES(a,b)
597#define DUMP_PATHNAME(a,b,c,d)
598#define DUMP_RESOURCE_LIST(a)
599#define DUMP_BUFFER(a,b)
600#define ACPI_DEBUG_PRINT(pl)
601#define ACPI_DEBUG_PRINT_RAW(pl)
602#define BREAK_MSG(a)
603
604#define return_VOID return
605#define return_ACPI_STATUS(s) return(s)
606#define return_VALUE(s) return(s)
607#define return_PTR(s) return(s)
608
609#endif
610
611/*
612 * Some code only gets executed when the debugger is built in.
613 * Note that this is entirely independent of whether the
614 * DEBUG_PRINT stuff (set by ACPI_DEBUG) is on, or not.
615 */
616#ifdef ENABLE_DEBUGGER
617#define DEBUGGER_EXEC(a) a
618#else
619#define DEBUGGER_EXEC(a)
620#endif
621
622
623/*
624 * For 16-bit code, we want to shrink some things even though
625 * we are using ACPI_DEBUG to get the debug output
626 */
627#ifdef _IA16
628#undef DEBUG_ONLY_MEMBERS
629#undef _VERBOSE_STRUCTURES
630#define DEBUG_ONLY_MEMBERS(a)
631#endif
632
633
634#ifdef ACPI_DEBUG
635/*
636 * 1) Set name to blanks
637 * 2) Copy the object name
638 */
639#define ADD_OBJECT_NAME(a,b) MEMSET (a->Common.Name, ' ', sizeof (a->Common.Name));\
640 STRNCPY (a->Common.Name, AcpiGbl_NsTypeNames[b], sizeof (a->Common.Name))
641#else
642
643#define ADD_OBJECT_NAME(a,b)
644#endif
645
646
647/*
648 * Memory allocation tracking (DEBUG ONLY)
649 */
650
651#ifndef ACPI_DBG_TRACK_ALLOCATIONS
652
653/* Memory allocation */
654
655#define ACPI_MEM_ALLOCATE(a) AcpiOsAllocate(a)
656#define ACPI_MEM_CALLOCATE(a) AcpiOsCallocate(a)
657#define ACPI_MEM_FREE(a) AcpiOsFree(a)
658#define ACPI_MEM_TRACKING(a)
659
660
661#else
662
663/* Memory allocation */
664
665#define ACPI_MEM_ALLOCATE(a) AcpiUtAllocate(a,_COMPONENT,_THIS_MODULE,__LINE__)
666#define ACPI_MEM_CALLOCATE(a) AcpiUtCallocate(a, _COMPONENT,_THIS_MODULE,__LINE__)
667#define ACPI_MEM_FREE(a) AcpiUtFree(a,_COMPONENT,_THIS_MODULE,__LINE__)
668#define ACPI_MEM_TRACKING(a) a
669
670#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
671
672
673#define ACPI_GET_STACK_POINTER _asm {mov eax, ebx}
674
675#endif /* ACMACROS_H */
|