ReactOS Development > Doxygen
acmacros.h
Go to the documentation of this file.
00001 /****************************************************************************** 00002 * 00003 * Name: acmacros.h - C macros for the entire subsystem. 00004 * 00005 *****************************************************************************/ 00006 00007 /****************************************************************************** 00008 * 00009 * 1. Copyright Notice 00010 * 00011 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp. 00012 * All rights reserved. 00013 * 00014 * 2. License 00015 * 00016 * 2.1. This is your license from Intel Corp. under its intellectual property 00017 * rights. You may have additional license terms from the party that provided 00018 * you this software, covering your right to use that party's intellectual 00019 * property rights. 00020 * 00021 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 00022 * copy of the source code appearing in this file ("Covered Code") an 00023 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 00024 * base code distributed originally by Intel ("Original Intel Code") to copy, 00025 * make derivatives, distribute, use and display any portion of the Covered 00026 * Code in any form, with the right to sublicense such rights; and 00027 * 00028 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 00029 * license (with the right to sublicense), under only those claims of Intel 00030 * patents that are infringed by the Original Intel Code, to make, use, sell, 00031 * offer to sell, and import the Covered Code and derivative works thereof 00032 * solely to the minimum extent necessary to exercise the above copyright 00033 * license, and in no event shall the patent license extend to any additions 00034 * to or modifications of the Original Intel Code. No other license or right 00035 * is granted directly or by implication, estoppel or otherwise; 00036 * 00037 * The above copyright and patent license is granted only if the following 00038 * conditions are met: 00039 * 00040 * 3. Conditions 00041 * 00042 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 00043 * Redistribution of source code of any substantial portion of the Covered 00044 * Code or modification with rights to further distribute source must include 00045 * the above Copyright Notice, the above License, this list of Conditions, 00046 * and the following Disclaimer and Export Compliance provision. In addition, 00047 * Licensee must cause all Covered Code to which Licensee contributes to 00048 * contain a file documenting the changes Licensee made to create that Covered 00049 * Code and the date of any change. Licensee must include in that file the 00050 * documentation of any changes made by any predecessor Licensee. Licensee 00051 * must include a prominent statement that the modification is derived, 00052 * directly or indirectly, from Original Intel Code. 00053 * 00054 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 00055 * Redistribution of source code of any substantial portion of the Covered 00056 * Code or modification without rights to further distribute source must 00057 * include the following Disclaimer and Export Compliance provision in the 00058 * documentation and/or other materials provided with distribution. In 00059 * addition, Licensee may not authorize further sublicense of source of any 00060 * portion of the Covered Code, and must include terms to the effect that the 00061 * license from Licensee to its licensee is limited to the intellectual 00062 * property embodied in the software Licensee provides to its licensee, and 00063 * not to intellectual property embodied in modifications its licensee may 00064 * make. 00065 * 00066 * 3.3. Redistribution of Executable. Redistribution in executable form of any 00067 * substantial portion of the Covered Code or modification must reproduce the 00068 * above Copyright Notice, and the following Disclaimer and Export Compliance 00069 * provision in the documentation and/or other materials provided with the 00070 * distribution. 00071 * 00072 * 3.4. Intel retains all right, title, and interest in and to the Original 00073 * Intel Code. 00074 * 00075 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 00076 * Intel shall be used in advertising or otherwise to promote the sale, use or 00077 * other dealings in products derived from or relating to the Covered Code 00078 * without prior written authorization from Intel. 00079 * 00080 * 4. Disclaimer and Export Compliance 00081 * 00082 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 00083 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 00084 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 00085 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 00086 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 00087 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 00088 * PARTICULAR PURPOSE. 00089 * 00090 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 00091 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 00092 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 00093 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 00094 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 00095 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 00096 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 00097 * LIMITED REMEDY. 00098 * 00099 * 4.3. Licensee shall not export, either directly or indirectly, any of this 00100 * software or system incorporating such software without first obtaining any 00101 * required license or other approval from the U. S. Department of Commerce or 00102 * any other agency or department of the United States Government. In the 00103 * event Licensee exports any such software from the United States or 00104 * re-exports any such software from a foreign destination, Licensee shall 00105 * ensure that the distribution and export/re-export of the software is in 00106 * compliance with all laws, regulations, orders, or other restrictions of the 00107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 00108 * any of its subsidiaries will export/re-export any technical data, process, 00109 * software, or service, directly or indirectly, to any country for which the 00110 * United States government or any agency thereof requires an export license, 00111 * other governmental approval, or letter of assurance, without first obtaining 00112 * such license, approval or letter. 00113 * 00114 *****************************************************************************/ 00115 00116 #ifndef __ACMACROS_H__ 00117 #define __ACMACROS_H__ 00118 00119 00120 /* 00121 * Extract data using a pointer. Any more than a byte and we 00122 * get into potential aligment issues -- see the STORE macros below. 00123 * Use with care. 00124 */ 00125 #define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 00126 #define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 00127 #define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 00128 #define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 00129 #define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 00130 #define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 00131 #define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 00132 #define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 00133 00134 /* 00135 * printf() format helpers 00136 */ 00137 00138 /* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */ 00139 00140 #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 00141 00142 #if ACPI_MACHINE_WIDTH == 64 00143 #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 00144 #else 00145 #define ACPI_FORMAT_NATIVE_UINT(i) 0, (i) 00146 #endif 00147 00148 00149 /* 00150 * Macros for moving data around to/from buffers that are possibly unaligned. 00151 * If the hardware supports the transfer of unaligned data, just do the store. 00152 * Otherwise, we have to move one byte at a time. 00153 */ 00154 #ifdef ACPI_BIG_ENDIAN 00155 /* 00156 * Macros for big-endian machines 00157 */ 00158 00159 /* These macros reverse the bytes during the move, converting little-endian to big endian */ 00160 00161 /* Big Endian <== Little Endian */ 00162 /* Hi...Lo Lo...Hi */ 00163 /* 16-bit source, 16/32/64 destination */ 00164 00165 #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 00166 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 00167 00168 #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 00169 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 00170 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 00171 00172 #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 00173 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 00174 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 00175 00176 /* 32-bit source, 16/32/64 destination */ 00177 00178 #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 00179 00180 #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 00181 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 00182 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 00183 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 00184 00185 #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 00186 ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 00187 ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 00188 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 00189 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 00190 00191 /* 64-bit source, 16/32/64 destination */ 00192 00193 #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 00194 00195 #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 00196 00197 #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 00198 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 00199 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 00200 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 00201 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 00202 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 00203 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 00204 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 00205 #else 00206 /* 00207 * Macros for little-endian machines 00208 */ 00209 00210 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 00211 00212 /* The hardware supports unaligned transfers, just do the little-endian move */ 00213 00214 /* 16-bit source, 16/32/64 destination */ 00215 00216 #define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 00217 #define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 00218 #define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 00219 00220 /* 32-bit source, 16/32/64 destination */ 00221 00222 #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 00223 #define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 00224 #define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 00225 00226 /* 64-bit source, 16/32/64 destination */ 00227 00228 #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 00229 #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 00230 #define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 00231 00232 #else 00233 /* 00234 * The hardware does not support unaligned transfers. We must move the 00235 * data one byte at a time. These macros work whether the source or 00236 * the destination (or both) is/are unaligned. (Little-endian move) 00237 */ 00238 00239 /* 16-bit source, 16/32/64 destination */ 00240 00241 #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 00242 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 00243 00244 #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 00245 #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 00246 00247 /* 32-bit source, 16/32/64 destination */ 00248 00249 #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 00250 00251 #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 00252 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 00253 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 00254 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 00255 00256 #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 00257 00258 /* 64-bit source, 16/32/64 destination */ 00259 00260 #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 00261 #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 00262 #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 00263 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 00264 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 00265 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 00266 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 00267 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 00268 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 00269 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 00270 #endif 00271 #endif 00272 00273 00274 /* 00275 * Fast power-of-two math macros for non-optimized compilers 00276 */ 00277 #define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 00278 #define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 00279 #define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 00280 00281 #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 00282 #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 00283 #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 00284 00285 #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 00286 #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 00287 #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 00288 00289 #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 00290 #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 00291 #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 00292 00293 #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 00294 #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 00295 #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 00296 00297 #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 00298 #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 00299 #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 00300 00301 /* 00302 * Rounding macros (Power of two boundaries only) 00303 */ 00304 #define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 00305 (~(((ACPI_SIZE) boundary)-1))) 00306 00307 #define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 00308 (((ACPI_SIZE) boundary)-1)) & \ 00309 (~(((ACPI_SIZE) boundary)-1))) 00310 00311 /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 00312 00313 #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 00314 #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 00315 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 00316 00317 #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 00318 #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 00319 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 00320 00321 #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 00322 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 00323 00324 #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 00325 00326 /* Generic (non-power-of-two) rounding */ 00327 00328 #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 00329 00330 #define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 00331 00332 /* 00333 * Bitmask creation 00334 * Bit positions start at zero. 00335 * MASK_BITS_ABOVE creates a mask starting AT the position and above 00336 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 00337 */ 00338 #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position)))) 00339 #define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position))) 00340 00341 /* Bitfields within ACPI registers */ 00342 00343 #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 00344 #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 00345 00346 #define ACPI_INSERT_BITS(Target, Mask, Source) Target = ((Target & (~(Mask))) | (Source & Mask)) 00347 00348 /* 00349 * An ACPI_NAMESPACE_NODE can appear in some contexts 00350 * where a pointer to an ACPI_OPERAND_OBJECT can also 00351 * appear. This macro is used to distinguish them. 00352 * 00353 * The "Descriptor" field is the first field in both structures. 00354 */ 00355 #define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 00356 #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t) 00357 00358 /* 00359 * Macros for the master AML opcode table 00360 */ 00361 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 00362 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 00363 {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 00364 #else 00365 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 00366 {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 00367 #endif 00368 00369 #define ARG_TYPE_WIDTH 5 00370 #define ARG_1(x) ((UINT32)(x)) 00371 #define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 00372 #define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 00373 #define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 00374 #define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 00375 #define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 00376 00377 #define ARGI_LIST1(a) (ARG_1(a)) 00378 #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 00379 #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 00380 #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 00381 #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 00382 #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)) 00383 00384 #define ARGP_LIST1(a) (ARG_1(a)) 00385 #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 00386 #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 00387 #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 00388 #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 00389 #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)) 00390 00391 #define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 00392 #define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 00393 00394 /* 00395 * Ascii error messages can be configured out 00396 */ 00397 #ifndef ACPI_NO_ERROR_MESSAGES 00398 /* 00399 * Error reporting. Callers module and line number are inserted by AE_INFO, 00400 * the plist contains a set of parens to allow variable-length lists. 00401 * These macros are used for both the debug and non-debug versions of the code. 00402 */ 00403 #define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e); 00404 #define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e); 00405 #define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 00406 #define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist 00407 00408 #else 00409 00410 /* No error messages */ 00411 00412 #define ACPI_ERROR_NAMESPACE(s, e) 00413 #define ACPI_ERROR_METHOD(s, n, p, e) 00414 #define ACPI_WARN_PREDEFINED(plist) 00415 #define ACPI_INFO_PREDEFINED(plist) 00416 00417 #endif /* ACPI_NO_ERROR_MESSAGES */ 00418 00419 /* 00420 * Debug macros that are conditionally compiled 00421 */ 00422 #ifdef ACPI_DEBUG_OUTPUT 00423 /* 00424 * Function entry tracing 00425 */ 00426 #define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 00427 AcpiUtTrace(ACPI_DEBUG_PARAMETERS) 00428 #define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \ 00429 AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b) 00430 #define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \ 00431 AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b) 00432 #define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \ 00433 AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b) 00434 00435 #define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 00436 00437 /* 00438 * Function exit tracing. 00439 * WARNING: These macros include a return statement. This is usually considered 00440 * bad form, but having a separate exit macro is very ugly and difficult to maintain. 00441 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 00442 * so that "_AcpiFunctionName" is defined. 00443 * 00444 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining 00445 * about these constructs. 00446 */ 00447 #ifdef ACPI_USE_DO_WHILE_0 00448 #define ACPI_DO_WHILE0(a) do a while(0) 00449 #else 00450 #define ACPI_DO_WHILE0(a) a 00451 #endif 00452 00453 #define return_VOID ACPI_DO_WHILE0 ({ \ 00454 AcpiUtExit (ACPI_DEBUG_PARAMETERS); \ 00455 return;}) 00456 /* 00457 * There are two versions of most of the return macros. The default version is 00458 * safer, since it avoids side-effects by guaranteeing that the argument will 00459 * not be evaluated twice. 00460 * 00461 * A less-safe version of the macros is provided for optional use if the 00462 * compiler uses excessive CPU stack (for example, this may happen in the 00463 * debug case if code optimzation is disabled.) 00464 */ 00465 #ifndef ACPI_SIMPLE_RETURN_MACROS 00466 00467 #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 00468 register ACPI_STATUS _s = (s); \ 00469 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \ 00470 return (_s); }) 00471 #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 00472 register void *_s = (void *) (s); \ 00473 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \ 00474 return (_s); }) 00475 #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 00476 register UINT64 _s = (s); \ 00477 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \ 00478 return (_s); }) 00479 #define return_UINT8(s) ACPI_DO_WHILE0 ({ \ 00480 register UINT8 _s = (UINT8) (s); \ 00481 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \ 00482 return (_s); }) 00483 #define return_UINT32(s) ACPI_DO_WHILE0 ({ \ 00484 register UINT32 _s = (UINT32) (s); \ 00485 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \ 00486 return (_s); }) 00487 #else /* Use original less-safe macros */ 00488 00489 #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 00490 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \ 00491 return((s)); }) 00492 #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 00493 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \ 00494 return((s)); }) 00495 #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 00496 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) (s)); \ 00497 return((s)); }) 00498 #define return_UINT8(s) return_VALUE(s) 00499 #define return_UINT32(s) return_VALUE(s) 00500 00501 #endif /* ACPI_SIMPLE_RETURN_MACROS */ 00502 00503 00504 /* Conditional execution */ 00505 00506 #define ACPI_DEBUG_EXEC(a) a 00507 #define ACPI_DEBUG_ONLY_MEMBERS(a) a; 00508 #define _VERBOSE_STRUCTURES 00509 00510 00511 /* Various object display routines for debug */ 00512 00513 #define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0) 00514 #define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c) 00515 #define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b) 00516 #define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d) 00517 #define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT) 00518 00519 #else 00520 /* 00521 * This is the non-debug case -- make everything go away, 00522 * leaving no executable debug code! 00523 */ 00524 #define ACPI_DEBUG_EXEC(a) 00525 #define ACPI_DEBUG_ONLY_MEMBERS(a) 00526 #define ACPI_FUNCTION_TRACE(a) 00527 #define ACPI_FUNCTION_TRACE_PTR(a, b) 00528 #define ACPI_FUNCTION_TRACE_U32(a, b) 00529 #define ACPI_FUNCTION_TRACE_STR(a, b) 00530 #define ACPI_FUNCTION_EXIT 00531 #define ACPI_FUNCTION_STATUS_EXIT(s) 00532 #define ACPI_FUNCTION_VALUE_EXIT(s) 00533 #define ACPI_FUNCTION_ENTRY() 00534 #define ACPI_DUMP_STACK_ENTRY(a) 00535 #define ACPI_DUMP_OPERANDS(a, b, c) 00536 #define ACPI_DUMP_ENTRY(a, b) 00537 #define ACPI_DUMP_TABLES(a, b) 00538 #define ACPI_DUMP_PATHNAME(a, b, c, d) 00539 #define ACPI_DUMP_BUFFER(a, b) 00540 #define ACPI_DEBUG_PRINT(pl) 00541 #define ACPI_DEBUG_PRINT_RAW(pl) 00542 00543 #define return_VOID return 00544 #define return_ACPI_STATUS(s) return(s) 00545 #define return_VALUE(s) return(s) 00546 #define return_UINT8(s) return(s) 00547 #define return_UINT32(s) return(s) 00548 #define return_PTR(s) return(s) 00549 00550 #endif /* ACPI_DEBUG_OUTPUT */ 00551 00552 /* 00553 * Some code only gets executed when the debugger is built in. 00554 * Note that this is entirely independent of whether the 00555 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 00556 */ 00557 #ifdef ACPI_DEBUGGER 00558 #define ACPI_DEBUGGER_EXEC(a) a 00559 #else 00560 #define ACPI_DEBUGGER_EXEC(a) 00561 #endif 00562 00563 00564 /* 00565 * Memory allocation tracking (DEBUG ONLY) 00566 */ 00567 #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 00568 00569 #ifndef ACPI_DBG_TRACK_ALLOCATIONS 00570 00571 /* Memory allocation */ 00572 00573 #define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 00574 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 00575 #define ACPI_FREE(a) AcpiOsFree(a) 00576 #define ACPI_MEM_TRACKING(a) 00577 00578 #else 00579 00580 /* Memory allocation */ 00581 00582 #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 00583 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 00584 #define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS) 00585 #define ACPI_MEM_TRACKING(a) a 00586 00587 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 00588 00589 00590 /* 00591 * Macros used for ACPICA utilities only 00592 */ 00593 00594 /* Generate a UUID */ 00595 00596 #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 00597 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 00598 (b) & 0xFF, ((b) >> 8) & 0xFF, \ 00599 (c) & 0xFF, ((c) >> 8) & 0xFF, \ 00600 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 00601 00602 #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 00603 00604 00605 #endif /* ACMACROS_H */
Generated on Sun May 27 2012 04:27:18 for ReactOS by
1.7.6.1
