Ported ACPI CA (from the nice guys at Intel) to ReactOS (ACPI bus driver).
[reactos.git] / reactos / drivers / bus / acpi / include / acmacros.h
1 /******************************************************************************
2 *
3 * Name: acmacros.h - C macros for the entire subsystem.
4 * $Revision: 1.1 $
5 *
6 *****************************************************************************/
7
8 /*
9 * Copyright (C) 2000, 2001 R. Byron Moore
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 */
25
26 #ifndef __ACMACROS_H__
27 #define __ACMACROS_H__
28
29 /*
30 * Data manipulation macros
31 */
32
33 #ifndef LODWORD
34 #define LODWORD(l) ((u32)(UINT64)(l))
35 #endif
36
37 #ifndef HIDWORD
38 #define HIDWORD(l) ((u32)((((UINT64)(l)) >> 32) & 0xFFFFFFFF))
39 #endif
40
41 #ifndef LOWORD
42 #define LOWORD(l) ((u16)(NATIVE_UINT)(l))
43 #endif
44
45 #ifndef HIWORD
46 #define HIWORD(l) ((u16)((((NATIVE_UINT)(l)) >> 16) & 0xFFFF))
47 #endif
48
49 #ifndef LOBYTE
50 #define LOBYTE(l) ((u8)(u16)(l))
51 #endif
52
53 #ifndef HIBYTE
54 #define HIBYTE(l) ((u8)((((u16)(l)) >> 8) & 0xFF))
55 #endif
56
57 #define BIT0(x) ((((x) & 0x01) > 0) ? 1 : 0)
58 #define BIT1(x) ((((x) & 0x02) > 0) ? 1 : 0)
59 #define BIT2(x) ((((x) & 0x04) > 0) ? 1 : 0)
60
61 #define BIT3(x) ((((x) & 0x08) > 0) ? 1 : 0)
62 #define BIT4(x) ((((x) & 0x10) > 0) ? 1 : 0)
63 #define BIT5(x) ((((x) & 0x20) > 0) ? 1 : 0)
64 #define BIT6(x) ((((x) & 0x40) > 0) ? 1 : 0)
65 #define BIT7(x) ((((x) & 0x80) > 0) ? 1 : 0)
66
67 #define LOW_BASE(w) ((u16) ((w) & 0x0000FFFF))
68 #define MID_BASE(b) ((u8) (((b) & 0x00FF0000) >> 16))
69 #define HI_BASE(b) ((u8) (((b) & 0xFF000000) >> 24))
70 #define LOW_LIMIT(w) ((u16) ((w) & 0x0000FFFF))
71 #define HI_LIMIT(b) ((u8) (((b) & 0x00FF0000) >> 16))
72
73
74 #ifdef _IA16
75 /*
76 * For 16-bit addresses, we have to assume that the upper 32 bits
77 * are zero.
78 */
79 #define ACPI_GET_ADDRESS(a) ((a).lo)
80 #define ACPI_STORE_ADDRESS(a,b) {(a).hi=0;(a).lo=(b);}
81 #define ACPI_VALID_ADDRESS(a) ((a).hi | (a).lo)
82
83 #else
84 /*
85 * Full 64-bit address on 32-bit and 64-bit platforms
86 */
87 #define ACPI_GET_ADDRESS(a) (a)
88 #define ACPI_STORE_ADDRESS(a,b) ((a)=(b))
89 #define ACPI_VALID_ADDRESS(a) (a)
90 #endif
91 /*
92 * Extract a byte of data using a pointer. Any more than a byte and we
93 * get into potential aligment issues -- see the STORE macros below
94 */
95 #define GET8(addr) (*(u8*)(addr))
96
97
98 /*
99 * Macros for moving data around to/from buffers that are possibly unaligned.
100 * If the hardware supports the transfer of unaligned data, just do the store.
101 * Otherwise, we have to move one byte at a time.
102 */
103
104 #ifdef _HW_ALIGNMENT_SUPPORT
105
106 /* The hardware supports unaligned transfers, just do the move */
107
108 #define MOVE_UNALIGNED16_TO_16(d,s) *(u16*)(d) = *(u16*)(s)
109 #define MOVE_UNALIGNED32_TO_32(d,s) *(u32*)(d) = *(u32*)(s)
110 #define MOVE_UNALIGNED16_TO_32(d,s) *(u32*)(d) = *(u16*)(s)
111
112 #else
113 /*
114 * The hardware does not support unaligned transfers. We must move the
115 * data one byte at a time. These macros work whether the source or
116 * the destination (or both) is/are unaligned.
117 */
118
119 #define MOVE_UNALIGNED16_TO_16(d,s) {((u8 *)(d))[0] = ((u8 *)(s))[0];\
120 ((u8 *)(d))[1] = ((u8 *)(s))[1];}
121
122 #define MOVE_UNALIGNED32_TO_32(d,s) {((u8 *)(d))[0] = ((u8 *)(s))[0];\
123 ((u8 *)(d))[1] = ((u8 *)(s))[1];\
124 ((u8 *)(d))[2] = ((u8 *)(s))[2];\
125 ((u8 *)(d))[3] = ((u8 *)(s))[3];}
126
127 #define MOVE_UNALIGNED16_TO_32(d,s) {(*(u32*)(d)) = 0; MOVE_UNALIGNED16_TO_16(d,s);}
128
129 #endif
130
131
132 /*
133 * Fast power-of-two math macros for non-optimized compilers
134 */
135
136 #define _DIV(value,power_of2) ((u32) ((value) >> (power_of2)))
137 #define _MUL(value,power_of2) ((u32) ((value) << (power_of2)))
138 #define _MOD(value,divisor) ((u32) ((value) & ((divisor) -1)))
139
140 #define DIV_2(a) _DIV(a,1)
141 #define MUL_2(a) _MUL(a,1)
142 #define MOD_2(a) _MOD(a,2)
143
144 #define DIV_4(a) _DIV(a,2)
145 #define MUL_4(a) _MUL(a,2)
146 #define MOD_4(a) _MOD(a,4)
147
148 #define DIV_8(a) _DIV(a,3)
149 #define MUL_8(a) _MUL(a,3)
150 #define MOD_8(a) _MOD(a,8)
151
152 #define DIV_16(a) _DIV(a,4)
153 #define MUL_16(a) _MUL(a,4)
154 #define MOD_16(a) _MOD(a,16)
155
156 /*
157 * Divide and Modulo
158 */
159 #define ACPI_DIVIDE(n,d) ((n) / (d))
160 #define ACPI_MODULO(n,d) ((n) % (d))
161
162 /*
163 * Rounding macros (Power of two boundaries only)
164 */
165
166 #define ROUND_DOWN(value,boundary) ((value) & (~((boundary)-1)))
167 #define ROUND_UP(value,boundary) (((value) + ((boundary)-1)) & (~((boundary)-1)))
168
169 #define ROUND_DOWN_TO_32_BITS(a) ROUND_DOWN(a,4)
170 #define ROUND_DOWN_TO_64_BITS(a) ROUND_DOWN(a,8)
171 #define ROUND_DOWN_TO_NATIVE_WORD(a) ROUND_DOWN(a,ALIGNED_ADDRESS_BOUNDARY)
172
173 #define ROUND_UP_TO_32_bITS(a) ROUND_UP(a,4)
174 #define ROUND_UP_TO_64_bITS(a) ROUND_UP(a,8)
175 #define ROUND_UP_TO_NATIVE_WORD(a) ROUND_UP(a,ALIGNED_ADDRESS_BOUNDARY)
176
177 #define ROUND_PTR_UP_TO_4(a,b) ((b *)(((NATIVE_UINT)(a) + 3) & ~3))
178 #define ROUND_PTR_UP_TO_8(a,b) ((b *)(((NATIVE_UINT)(a) + 7) & ~7))
179
180 #define ROUND_UP_TO_1_k(a) (((a) + 1023) >> 10)
181
182 #ifdef DEBUG_ASSERT
183 #undef DEBUG_ASSERT
184 #endif
185
186
187 /* Macros for GAS addressing */
188
189 #define ACPI_PCI_DEVICE_MASK (UINT64) 0x0000FFFF00000000
190 #define ACPI_PCI_FUNCTION_MASK (UINT64) 0x00000000FFFF0000
191 #define ACPI_PCI_REGISTER_MASK (UINT64) 0x000000000000FFFF
192
193 #define ACPI_PCI_FUNCTION(a) (u32) ((((a) & ACPI_PCI_FUNCTION_MASK) >> 16))
194 #define ACPI_PCI_DEVICE(a) (u32) ((((a) & ACPI_PCI_DEVICE_MASK) >> 32))
195
196 #ifndef _IA16
197 #define ACPI_PCI_REGISTER(a) (u32) (((a) & ACPI_PCI_REGISTER_MASK))
198 #define ACPI_PCI_DEVFUN(a) (u32) ((ACPI_PCI_DEVICE(a) << 16) | ACPI_PCI_FUNCTION(a))
199
200 #else
201 #define ACPI_PCI_REGISTER(a) (u32) (((a) & 0x0000FFFF))
202 #define ACPI_PCI_DEVFUN(a) (u32) ((((a) & 0xFFFF0000) >> 16))
203
204 #endif
205
206 /*
207 * An ACPI_HANDLE (which is actually an ACPI_NAMESPACE_NODE *) can appear in some contexts,
208 * such as on ap_obj_stack, where a pointer to an ACPI_OPERAND_OBJECT can also
209 * appear. This macro is used to distinguish them.
210 *
211 * The Data_type field is the first field in both structures.
212 */
213
214 #define VALID_DESCRIPTOR_TYPE(d,t) (((ACPI_NAMESPACE_NODE *)d)->data_type == t)
215
216
217 /* Macro to test the object type */
218
219 #define IS_THIS_OBJECT_TYPE(d,t) (((ACPI_OPERAND_OBJECT *)d)->common.type == (u8)t)
220
221 /* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */
222
223 #define IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0)
224
225 /*
226 * Macro to check if a pointer is within an ACPI table.
227 * Parameter (a) is the pointer to check. Parameter (b) must be defined
228 * as a pointer to an ACPI_TABLE_HEADER. (b+1) then points past the header,
229 * and ((u8 *)b+b->Length) points one byte past the end of the table.
230 */
231
232 #ifndef _IA16
233 #define IS_IN_ACPI_TABLE(a,b) (((u8 *)(a) >= (u8 *)(b + 1)) &&\
234 ((u8 *)(a) < ((u8 *)b + b->length)))
235
236 #else
237 #define IS_IN_ACPI_TABLE(a,b) (_segment)(a) == (_segment)(b) &&\
238 (((u8 *)(a) >= (u8 *)(b + 1)) &&\
239 ((u8 *)(a) < ((u8 *)b + b->length)))
240 #endif
241
242 /*
243 * Macros for the master AML opcode table
244 */
245
246 #ifdef ACPI_DEBUG
247 #define OP_INFO_ENTRY(flags,name,Pargs,Iargs) {flags,Pargs,Iargs,name}
248 #else
249 #define OP_INFO_ENTRY(flags,name,Pargs,Iargs) {flags,Pargs,Iargs}
250 #endif
251
252 #define ARG_TYPE_WIDTH 5
253 #define ARG_1(x) ((u32)(x))
254 #define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH))
255 #define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH))
256 #define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH))
257 #define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH))
258 #define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH))
259
260 #define ARGI_LIST1(a) (ARG_1(a))
261 #define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a))
262 #define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
263 #define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
264 #define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
265 #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))
266
267 #define ARGP_LIST1(a) (ARG_1(a))
268 #define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b))
269 #define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
270 #define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
271 #define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
272 #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))
273
274 #define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
275 #define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
276
277
278 /*
279 * Reporting macros that are never compiled out
280 */
281
282 #define PARAM_LIST(pl) pl
283
284 /*
285 * Error reporting. These versions add callers module and line#. Since
286 * _THIS_MODULE gets compiled out when ACPI_DEBUG isn't defined, only
287 * use it in debug mode.
288 */
289
290 #ifdef ACPI_DEBUG
291
292 #define REPORT_INFO(fp) {_report_info(_THIS_MODULE,__LINE__,_COMPONENT); \
293 debug_print_raw PARAM_LIST(fp);}
294 #define REPORT_ERROR(fp) {_report_error(_THIS_MODULE,__LINE__,_COMPONENT); \
295 debug_print_raw PARAM_LIST(fp);}
296 #define REPORT_WARNING(fp) {_report_warning(_THIS_MODULE,__LINE__,_COMPONENT); \
297 debug_print_raw PARAM_LIST(fp);}
298
299 #else
300
301 #define REPORT_INFO(fp) {_report_info("ACPI",__LINE__,_COMPONENT); \
302 debug_print_raw PARAM_LIST(fp);}
303 #define REPORT_ERROR(fp) {_report_error("ACPI",__LINE__,_COMPONENT); \
304 debug_print_raw PARAM_LIST(fp);}
305 #define REPORT_WARNING(fp) {_report_warning("ACPI",__LINE__,_COMPONENT); \
306 debug_print_raw PARAM_LIST(fp);}
307
308 #endif
309
310 /* Error reporting. These versions pass thru the module and line# */
311
312 #define _REPORT_INFO(a,b,c,fp) {_report_info(a,b,c); \
313 debug_print_raw PARAM_LIST(fp);}
314 #define _REPORT_ERROR(a,b,c,fp) {_report_error(a,b,c); \
315 debug_print_raw PARAM_LIST(fp);}
316 #define _REPORT_WARNING(a,b,c,fp) {_report_warning(a,b,c); \
317 debug_print_raw PARAM_LIST(fp);}
318
319 /* Buffer dump macros */
320
321 #define DUMP_BUFFER(a,b) acpi_cm_dump_buffer((u8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT)
322
323 /*
324 * Debug macros that are conditionally compiled
325 */
326
327 #ifdef ACPI_DEBUG
328
329 #define MODULE_NAME(name) static char *_THIS_MODULE = name;
330
331 /*
332 * Function entry tracing.
333 * The first parameter should be the procedure name as a quoted string. This is declared
334 * as a local string ("_Proc_name) so that it can be also used by the function exit macros below.
335 */
336
337 #define FUNCTION_TRACE(a) char * _proc_name = a;\
338 function_trace(_THIS_MODULE,__LINE__,_COMPONENT,a)
339 #define FUNCTION_TRACE_PTR(a,b) char * _proc_name = a;\
340 function_trace_ptr(_THIS_MODULE,__LINE__,_COMPONENT,a,(void *)b)
341 #define FUNCTION_TRACE_U32(a,b) char * _proc_name = a;\
342 function_trace_u32(_THIS_MODULE,__LINE__,_COMPONENT,a,(u32)b)
343 #define FUNCTION_TRACE_STR(a,b) char * _proc_name = a;\
344 function_trace_str(_THIS_MODULE,__LINE__,_COMPONENT,a,(NATIVE_CHAR *)b)
345 /*
346 * Function exit tracing.
347 * WARNING: These macros include a return statement. This is usually considered
348 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
349 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
350 * so that "_Proc_name" is defined.
351 */
352 #define return_VOID {function_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name);return;}
353 #define return_ACPI_STATUS(s) {function_status_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name,s);return(s);}
354 #define return_VALUE(s) {function_value_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name,(ACPI_INTEGER)s);return(s);}
355 #define return_PTR(s) {function_ptr_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name,(u8 *)s);return(s);}
356
357
358 /* Conditional execution */
359
360 #define DEBUG_EXEC(a) a
361 #define NORMAL_EXEC(a)
362
363 #define DEBUG_DEFINE(a) a;
364 #define DEBUG_ONLY_MEMBERS(a) a;
365 #define _OPCODE_NAMES
366 #define _VERBOSE_STRUCTURES
367
368
369 /* Stack and buffer dumping */
370
371 #define DUMP_STACK_ENTRY(a) acpi_aml_dump_operand(a)
372 #define DUMP_OPERANDS(a,b,c,d,e) acpi_aml_dump_operands(a,b,c,d,e,_THIS_MODULE,__LINE__)
373
374
375 #define DUMP_ENTRY(a,b) acpi_ns_dump_entry (a,b)
376 #define DUMP_TABLES(a,b) acpi_ns_dump_tables(a,b)
377 #define DUMP_PATHNAME(a,b,c,d) acpi_ns_dump_pathname(a,b,c,d)
378 #define DUMP_RESOURCE_LIST(a) acpi_rs_dump_resource_list(a)
379 #define BREAK_MSG(a) acpi_os_breakpoint (a)
380
381 /*
382 * Generate INT3 on ACPI_ERROR (Debug only!)
383 */
384
385 #define ERROR_BREAK
386 #ifdef ERROR_BREAK
387 #define BREAK_ON_ERROR(lvl) if ((lvl)&ACPI_ERROR) acpi_os_breakpoint("Fatal error encountered\n")
388 #else
389 #define BREAK_ON_ERROR(lvl)
390 #endif
391
392 /*
393 * Master debug print macros
394 * Print iff:
395 * 1) Debug print for the current component is enabled
396 * 2) Debug error level or trace level for the print statement is enabled
397 *
398 */
399
400 #define TEST_DEBUG_SWITCH(lvl) if (((lvl) & acpi_dbg_level) && (_COMPONENT & acpi_dbg_layer))
401
402 #define DEBUG_PRINT(lvl,fp) TEST_DEBUG_SWITCH(lvl) {\
403 debug_print_prefix (_THIS_MODULE,__LINE__);\
404 debug_print_raw PARAM_LIST(fp);\
405 BREAK_ON_ERROR(lvl);}
406
407 #define DEBUG_PRINT_RAW(lvl,fp) TEST_DEBUG_SWITCH(lvl) {\
408 debug_print_raw PARAM_LIST(fp);}
409
410
411 /* Assert macros */
412
413 #define ACPI_ASSERT(exp) if(!(exp)) \
414 acpi_os_dbg_assert(#exp, __FILE__, __LINE__, "Failed Assertion")
415
416 #define DEBUG_ASSERT(msg, exp) if(!(exp)) \
417 acpi_os_dbg_assert(#exp, __FILE__, __LINE__, msg)
418
419
420 #else
421 /*
422 * This is the non-debug case -- make everything go away,
423 * leaving no executable debug code!
424 */
425
426 #define MODULE_NAME(name)
427 #define _THIS_MODULE ""
428
429 #define DEBUG_EXEC(a)
430 #define NORMAL_EXEC(a) a;
431
432 #define DEBUG_DEFINE(a)
433 #define DEBUG_ONLY_MEMBERS(a)
434 #define FUNCTION_TRACE(a)
435 #define FUNCTION_TRACE_PTR(a,b)
436 #define FUNCTION_TRACE_U32(a,b)
437 #define FUNCTION_TRACE_STR(a,b)
438 #define FUNCTION_EXIT
439 #define FUNCTION_STATUS_EXIT(s)
440 #define FUNCTION_VALUE_EXIT(s)
441 #define DUMP_STACK_ENTRY(a)
442 #define DUMP_OPERANDS(a,b,c,d,e)
443 #define DUMP_ENTRY(a,b)
444 #define DUMP_TABLES(a,b)
445 #define DUMP_PATHNAME(a,b,c,d)
446 #define DUMP_RESOURCE_LIST(a)
447 #define DEBUG_PRINT(l,f)
448 #define DEBUG_PRINT_RAW(l,f)
449 #define BREAK_MSG(a)
450
451 #define return_VOID return
452 #define return_ACPI_STATUS(s) return(s)
453 #define return_VALUE(s) return(s)
454 #define return_PTR(s) return(s)
455
456 #define ACPI_ASSERT(exp)
457 #define DEBUG_ASSERT(msg, exp)
458
459 #endif
460
461 /*
462 * Some code only gets executed when the debugger is built in.
463 * Note that this is entirely independent of whether the
464 * DEBUG_PRINT stuff (set by ACPI_DEBUG) is on, or not.
465 */
466 #ifdef ENABLE_DEBUGGER
467 #define DEBUGGER_EXEC(a) a
468 #else
469 #define DEBUGGER_EXEC(a)
470 #endif
471
472
473 /*
474 * For 16-bit code, we want to shrink some things even though
475 * we are using ACPI_DEBUG to get the debug output
476 */
477 #ifdef _IA16
478 #undef DEBUG_ONLY_MEMBERS
479 #undef _VERBOSE_STRUCTURES
480 #define DEBUG_ONLY_MEMBERS(a)
481 #endif
482
483
484 #ifdef ACPI_DEBUG
485
486 /*
487 * 1) Set name to blanks
488 * 2) Copy the object name
489 */
490
491 #define ADD_OBJECT_NAME(a,b) MEMSET (a->common.name, ' ', sizeof (a->common.name));\
492 STRNCPY (a->common.name, acpi_gbl_ns_type_names[b], sizeof (a->common.name))
493
494 #else
495
496 #define ADD_OBJECT_NAME(a,b)
497
498 #endif
499
500
501 #endif /* ACMACROS_H */