Create a branch for network fixes.
[reactos.git] / drivers / bus / acpi / include / acmacros.h
1 /******************************************************************************
2 *
3 * Name: acmacros.h - C macros for the entire subsystem.
4 * $Revision: 1.4 $
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 #ifdef __GNUC__
190 #define ACPI_PCI_DEVICE_MASK (UINT64) 0x0000FFFF00000000ULL
191 #define ACPI_PCI_FUNCTION_MASK (UINT64) 0x00000000FFFF0000ULL
192 #define ACPI_PCI_REGISTER_MASK (UINT64) 0x000000000000FFFFULL
193 #else
194 #define ACPI_PCI_DEVICE_MASK (UINT64) 0x0000FFFF00000000
195 #define ACPI_PCI_FUNCTION_MASK (UINT64) 0x00000000FFFF0000
196 #define ACPI_PCI_REGISTER_MASK (UINT64) 0x000000000000FFFF
197 #endif
198
199 #define ACPI_PCI_FUNCTION(a) (u32) ((((a) & ACPI_PCI_FUNCTION_MASK) >> 16))
200 #define ACPI_PCI_DEVICE(a) (u32) ((((a) & ACPI_PCI_DEVICE_MASK) >> 32))
201
202 #ifndef _IA16
203 #define ACPI_PCI_REGISTER(a) (u32) (((a) & ACPI_PCI_REGISTER_MASK))
204 #define ACPI_PCI_DEVFUN(a) (u32) ((ACPI_PCI_DEVICE(a) << 16) | ACPI_PCI_FUNCTION(a))
205
206 #else
207 #define ACPI_PCI_REGISTER(a) (u32) (((a) & 0x0000FFFF))
208 #define ACPI_PCI_DEVFUN(a) (u32) ((((a) & 0xFFFF0000) >> 16))
209
210 #endif
211
212 /*
213 * An ACPI_HANDLE (which is actually an ACPI_NAMESPACE_NODE *) can appear in some contexts,
214 * such as on ap_obj_stack, where a pointer to an ACPI_OPERAND_OBJECT can also
215 * appear. This macro is used to distinguish them.
216 *
217 * The Data_type field is the first field in both structures.
218 */
219
220 #define VALID_DESCRIPTOR_TYPE(d,t) (((ACPI_NAMESPACE_NODE *)d)->data_type == t)
221
222
223 /* Macro to test the object type */
224
225 #define IS_THIS_OBJECT_TYPE(d,t) (((ACPI_OPERAND_OBJECT *)d)->common.type == (u8)t)
226
227 /* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */
228
229 #define IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0)
230
231 /*
232 * Macro to check if a pointer is within an ACPI table.
233 * Parameter (a) is the pointer to check. Parameter (b) must be defined
234 * as a pointer to an ACPI_TABLE_HEADER. (b+1) then points past the header,
235 * and ((u8 *)b+b->Length) points one byte past the end of the table.
236 */
237
238 #ifndef _IA16
239 #define IS_IN_ACPI_TABLE(a,b) (((u8 *)(a) >= (u8 *)(b + 1)) &&\
240 ((u8 *)(a) < ((u8 *)b + b->length)))
241
242 #else
243 #define IS_IN_ACPI_TABLE(a,b) (_segment)(a) == (_segment)(b) &&\
244 (((u8 *)(a) >= (u8 *)(b + 1)) &&\
245 ((u8 *)(a) < ((u8 *)b + b->length)))
246 #endif
247
248 /*
249 * Macros for the master AML opcode table
250 */
251
252 #ifdef ACPI_DEBUG
253 #define OP_INFO_ENTRY(flags,name,Pargs,Iargs) {flags,Pargs,Iargs,name}
254 #else
255 #define OP_INFO_ENTRY(flags,name,Pargs,Iargs) {flags,Pargs,Iargs}
256 #endif
257
258 #define ARG_TYPE_WIDTH 5
259 #define ARG_1(x) ((u32)(x))
260 #define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH))
261 #define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH))
262 #define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH))
263 #define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH))
264 #define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH))
265
266 #define ARGI_LIST1(a) (ARG_1(a))
267 #define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a))
268 #define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
269 #define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
270 #define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
271 #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))
272
273 #define ARGP_LIST1(a) (ARG_1(a))
274 #define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b))
275 #define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
276 #define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
277 #define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
278 #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))
279
280 #define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
281 #define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
282
283
284 /*
285 * Reporting macros that are never compiled out
286 */
287
288 #define PARAM_LIST(pl) pl
289
290 /*
291 * Error reporting. These versions add callers module and line#. Since
292 * _THIS_MODULE gets compiled out when ACPI_DEBUG isn't defined, only
293 * use it in debug mode.
294 */
295
296 #ifdef ACPI_DEBUG
297
298 #define REPORT_INFO(fp) {_report_info(_THIS_MODULE,__LINE__,_COMPONENT); \
299 debug_print_raw PARAM_LIST(fp);}
300 #define REPORT_ERROR(fp) {_report_error(_THIS_MODULE,__LINE__,_COMPONENT); \
301 debug_print_raw PARAM_LIST(fp);}
302 #define REPORT_WARNING(fp) {_report_warning(_THIS_MODULE,__LINE__,_COMPONENT); \
303 debug_print_raw PARAM_LIST(fp);}
304
305 #else
306
307 #define REPORT_INFO(fp) {_report_info("ACPI",__LINE__,_COMPONENT); \
308 debug_print_raw PARAM_LIST(fp);}
309 #define REPORT_ERROR(fp) {_report_error("ACPI",__LINE__,_COMPONENT); \
310 debug_print_raw PARAM_LIST(fp);}
311 #define REPORT_WARNING(fp) {_report_warning("ACPI",__LINE__,_COMPONENT); \
312 debug_print_raw PARAM_LIST(fp);}
313
314 #endif
315
316 /* Error reporting. These versions pass thru the module and line# */
317
318 #define _REPORT_INFO(a,b,c,fp) {_report_info(a,b,c); \
319 debug_print_raw PARAM_LIST(fp);}
320 #define _REPORT_ERROR(a,b,c,fp) {_report_error(a,b,c); \
321 debug_print_raw PARAM_LIST(fp);}
322 #define _REPORT_WARNING(a,b,c,fp) {_report_warning(a,b,c); \
323 debug_print_raw PARAM_LIST(fp);}
324
325 /* Buffer dump macros */
326
327 #define DUMP_BUFFER(a,b) acpi_cm_dump_buffer((u8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT)
328
329 /*
330 * Debug macros that are conditionally compiled
331 */
332
333 #ifdef ACPI_DEBUG
334
335 #define MODULE_NAME(name) static char *_THIS_MODULE = name;
336
337 /*
338 * Function entry tracing.
339 * The first parameter should be the procedure name as a quoted string. This is declared
340 * as a local string ("_Proc_name) so that it can be also used by the function exit macros below.
341 */
342
343 #define FUNCTION_TRACE(a) char * _proc_name = a;\
344 function_trace(_THIS_MODULE,__LINE__,_COMPONENT,a)
345 #define FUNCTION_TRACE_PTR(a,b) char * _proc_name = a;\
346 function_trace_ptr(_THIS_MODULE,__LINE__,_COMPONENT,a,(void *)b)
347 #define FUNCTION_TRACE_U32(a,b) char * _proc_name = a;\
348 function_trace_u32(_THIS_MODULE,__LINE__,_COMPONENT,a,(u32)b)
349 #define FUNCTION_TRACE_STR(a,b) char * _proc_name = a;\
350 function_trace_str(_THIS_MODULE,__LINE__,_COMPONENT,a,(NATIVE_CHAR *)b)
351 /*
352 * Function exit tracing.
353 * WARNING: These macros include a return statement. This is usually considered
354 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
355 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
356 * so that "_Proc_name" is defined.
357 */
358 #define return_VOID {function_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name);return;}
359 #define return_ACPI_STATUS(s) {function_status_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name,s);return(s);}
360 #define return_VALUE(s) {function_value_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name,(ACPI_INTEGER)s);return(s);}
361 #define return_PTR(s) {function_ptr_exit(_THIS_MODULE,__LINE__,_COMPONENT,_proc_name,(u8 *)s);return(s);}
362
363
364 /* Conditional execution */
365
366 #define DEBUG_EXEC(a) a
367 #define NORMAL_EXEC(a)
368
369 #define DEBUG_DEFINE(a) a;
370 #define DEBUG_ONLY_MEMBERS(a) a;
371 #define _OPCODE_NAMES
372 #define _VERBOSE_STRUCTURES
373
374
375 /* Stack and buffer dumping */
376
377 #define DUMP_STACK_ENTRY(a) acpi_aml_dump_operand(a)
378 #define DUMP_OPERANDS(a,b,c,d,e) acpi_aml_dump_operands(a,b,c,d,e,_THIS_MODULE,__LINE__)
379
380
381 #define DUMP_ENTRY(a,b) acpi_ns_dump_entry (a,b)
382 #define DUMP_TABLES(a,b) acpi_ns_dump_tables(a,b)
383 #define DUMP_PATHNAME(a,b,c,d) acpi_ns_dump_pathname(a,b,c,d)
384 #define DUMP_RESOURCE_LIST(a) acpi_rs_dump_resource_list(a)
385 #define BREAK_MSG(a) acpi_os_breakpoint (a)
386
387 /*
388 * Generate INT3 on ACPI_ERROR (Debug only!)
389 */
390
391 #define ERROR_BREAK
392 #ifdef ERROR_BREAK
393 #define BREAK_ON_ERROR(lvl) if ((lvl)&ACPI_ERROR) acpi_os_breakpoint("Fatal error encountered\n")
394 #else
395 #define BREAK_ON_ERROR(lvl)
396 #endif
397
398 /*
399 * Master debug print macros
400 * Print iff:
401 * 1) Debug print for the current component is enabled
402 * 2) Debug error level or trace level for the print statement is enabled
403 *
404 */
405
406 #define TEST_DEBUG_SWITCH(lvl) if (((lvl) & acpi_dbg_level) && (_COMPONENT & acpi_dbg_layer))
407
408 #define DEBUG_PRINT(lvl,fp) TEST_DEBUG_SWITCH(lvl) {\
409 debug_print_prefix (_THIS_MODULE,__LINE__);\
410 debug_print_raw PARAM_LIST(fp);\
411 BREAK_ON_ERROR(lvl);}
412
413 #define DEBUG_PRINT_RAW(lvl,fp) TEST_DEBUG_SWITCH(lvl) {\
414 debug_print_raw PARAM_LIST(fp);}
415
416
417 /* Assert macros */
418
419 #define ACPI_ASSERT(exp) if(!(exp)) \
420 acpi_os_dbg_assert(#exp, __FILE__, __LINE__, "Failed Assertion")
421
422 #define DEBUG_ASSERT(msg, exp) if(!(exp)) \
423 acpi_os_dbg_assert(#exp, __FILE__, __LINE__, msg)
424
425
426 #else
427 /*
428 * This is the non-debug case -- make everything go away,
429 * leaving no executable debug code!
430 */
431
432 #define MODULE_NAME(name)
433 #define _THIS_MODULE ""
434
435 #define DEBUG_EXEC(a)
436 #define NORMAL_EXEC(a) a;
437
438 #define DEBUG_DEFINE(a)
439 #define DEBUG_ONLY_MEMBERS(a)
440 #define FUNCTION_TRACE(a)
441 #define FUNCTION_TRACE_PTR(a,b)
442 #define FUNCTION_TRACE_U32(a,b)
443 #define FUNCTION_TRACE_STR(a,b)
444 #define FUNCTION_EXIT
445 #define FUNCTION_STATUS_EXIT(s)
446 #define FUNCTION_VALUE_EXIT(s)
447 #define DUMP_STACK_ENTRY(a)
448 #define DUMP_OPERANDS(a,b,c,d,e)
449 #define DUMP_ENTRY(a,b)
450 #define DUMP_TABLES(a,b)
451 #define DUMP_PATHNAME(a,b,c,d)
452 #define DUMP_RESOURCE_LIST(a)
453 #define DEBUG_PRINT(l,f)
454 #define DEBUG_PRINT_RAW(l,f)
455 #define BREAK_MSG(a)
456
457 #define return_VOID return
458 #define return_ACPI_STATUS(s) return(s)
459 #define return_VALUE(s) return(s)
460 #define return_PTR(s) return(s)
461
462 #define ACPI_ASSERT(exp)
463 #define DEBUG_ASSERT(msg, exp)
464
465 #endif
466
467 /*
468 * Some code only gets executed when the debugger is built in.
469 * Note that this is entirely independent of whether the
470 * DEBUG_PRINT stuff (set by ACPI_DEBUG) is on, or not.
471 */
472 #ifdef ENABLE_DEBUGGER
473 #define DEBUGGER_EXEC(a) a
474 #else
475 #define DEBUGGER_EXEC(a)
476 #endif
477
478
479 /*
480 * For 16-bit code, we want to shrink some things even though
481 * we are using ACPI_DEBUG to get the debug output
482 */
483 #ifdef _IA16
484 #undef DEBUG_ONLY_MEMBERS
485 #undef _VERBOSE_STRUCTURES
486 #define DEBUG_ONLY_MEMBERS(a)
487 #endif
488
489
490 #ifdef ACPI_DEBUG
491
492 /*
493 * 1) Set name to blanks
494 * 2) Copy the object name
495 */
496
497 #define ADD_OBJECT_NAME(a,b) MEMSET (a->common.name, ' ', sizeof (a->common.name));\
498 STRNCPY (a->common.name, acpi_gbl_ns_type_names[b], sizeof (a->common.name))
499
500 #else
501
502 #define ADD_OBJECT_NAME(a,b)
503
504 #endif
505
506
507 #endif /* ACMACROS_H */