1 /****************************************************************************** 2 * 3 * Name: acmacros.h - C macros for the entire subsystem. 4 * $Revision: 1.199 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, 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 #define ACPI_LOWORD(l) ((UINT16)(UINT32)(l)) 125 #define ACPI_HIWORD(l) ((UINT16)((((UINT32)(l)) >> 16) & 0xFFFF)) 126 #define ACPI_LOBYTE(l) ((UINT8)(UINT16)(l)) 127 #define ACPI_HIBYTE(l) ((UINT8)((((UINT16)(l)) >> 8) & 0xFF)) 128 129 #define ACPI_SET_BIT(target,bit) ((target) |= (bit)) 130 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit)) 131 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b)) 132 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b)) 133 134 /* Size calculation */ 135 136 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0])) 137 138 139 /* 140 * Extract data using a pointer. Any more than a byte and we 141 * get into potential aligment issues -- see the STORE macros below. 142 * Use with care. 143 */ 144 #define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 145 #define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 146 #define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 147 #define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 148 #define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 149 #define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 150 #define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 151 #define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 152 153 /* 154 * Pointer manipulation 155 */ 156 #define ACPI_CAST_PTR(t, p) ((t *) (ACPI_UINTPTR_T) (p)) 157 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (ACPI_UINTPTR_T) (p)) 158 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b))) 159 #define ACPI_PTR_DIFF(a, b) (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b))) 160 161 /* Pointer/Integer type conversions */ 162 163 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i) 164 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL) 165 #define ACPI_OFFSET(d, f) (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL) 166 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i) 167 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i) 168 169 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 170 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b))) 171 #else 172 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE)) 173 #endif 174 175 /* 176 * Full 64-bit integer must be available on both 32-bit and 64-bit platforms 177 */ 178 typedef struct acpi_integer_overlay 179 { 180 UINT32 LoDword; 181 UINT32 HiDword; 182 183 } ACPI_INTEGER_OVERLAY; 184 185 #define ACPI_LODWORD(Integer) (ACPI_CAST_PTR (ACPI_INTEGER_OVERLAY, &Integer)->LoDword) 186 #define ACPI_HIDWORD(Integer) (ACPI_CAST_PTR (ACPI_INTEGER_OVERLAY, &Integer)->HiDword) 187 188 /* 189 * printf() format helpers 190 */ 191 192 /* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */ 193 194 #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 195 196 #if ACPI_MACHINE_WIDTH == 64 197 #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 198 #else 199 #define ACPI_FORMAT_NATIVE_UINT(i) 0, (i) 200 #endif 201 202 203 /* 204 * Macros for moving data around to/from buffers that are possibly unaligned. 205 * If the hardware supports the transfer of unaligned data, just do the store. 206 * Otherwise, we have to move one byte at a time. 207 */ 208 #ifdef ACPI_BIG_ENDIAN 209 /* 210 * Macros for big-endian machines 211 */ 212 213 /* These macros reverse the bytes during the move, converting little-endian to big endian */ 214 215 /* Big Endian <== Little Endian */ 216 /* Hi...Lo Lo...Hi */ 217 /* 16-bit source, 16/32/64 destination */ 218 219 #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 220 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 221 222 #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 223 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 224 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 225 226 #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 227 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 228 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 229 230 /* 32-bit source, 16/32/64 destination */ 231 232 #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 233 234 #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 235 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 236 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 237 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 238 239 #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 240 ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 241 ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 242 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 243 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 244 245 /* 64-bit source, 16/32/64 destination */ 246 247 #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 248 249 #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 250 251 #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 252 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 253 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 254 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 255 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 256 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 257 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 258 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 259 #else 260 /* 261 * Macros for little-endian machines 262 */ 263 264 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 265 266 /* The hardware supports unaligned transfers, just do the little-endian move */ 267 268 /* 16-bit source, 16/32/64 destination */ 269 270 #define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 271 #define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 272 #define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 273 274 /* 32-bit source, 16/32/64 destination */ 275 276 #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 277 #define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 278 #define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 279 280 /* 64-bit source, 16/32/64 destination */ 281 282 #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 283 #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 284 #define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 285 286 #else 287 /* 288 * The hardware does not support unaligned transfers. We must move the 289 * data one byte at a time. These macros work whether the source or 290 * the destination (or both) is/are unaligned. (Little-endian move) 291 */ 292 293 /* 16-bit source, 16/32/64 destination */ 294 295 #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 296 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 297 298 #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 299 #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 300 301 /* 32-bit source, 16/32/64 destination */ 302 303 #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 304 305 #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 306 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 307 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 308 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 309 310 #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 311 312 /* 64-bit source, 16/32/64 destination */ 313 314 #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 315 #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 316 #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 317 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 318 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 319 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 320 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 321 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 322 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 323 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 324 #endif 325 #endif 326 327 328 /* 329 * Fast power-of-two math macros for non-optimized compilers 330 */ 331 #define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 332 #define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 333 #define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 334 335 #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 336 #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 337 #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 338 339 #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 340 #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 341 #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 342 343 #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 344 #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 345 #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 346 347 #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 348 #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 349 #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 350 351 #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 352 #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 353 #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 354 355 /* 356 * Rounding macros (Power of two boundaries only) 357 */ 358 #define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 359 (~(((ACPI_SIZE) boundary)-1))) 360 361 #define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 362 (((ACPI_SIZE) boundary)-1)) & \ 363 (~(((ACPI_SIZE) boundary)-1))) 364 365 /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 366 367 #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 368 #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 369 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 370 371 #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 372 #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 373 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 374 375 #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 376 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 377 378 #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 379 380 /* Generic (non-power-of-two) rounding */ 381 382 #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 383 384 #define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 385 386 /* 387 * Bitmask creation 388 * Bit positions start at zero. 389 * MASK_BITS_ABOVE creates a mask starting AT the position and above 390 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 391 */ 392 #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((UINT32) (position)))) 393 #define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((UINT32) (position))) 394 395 /* Bitfields within ACPI registers */ 396 397 #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 398 #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 399 400 #define ACPI_INSERT_BITS(Target, Mask, Source) Target = ((Target & (~(Mask))) | (Source & Mask)) 401 402 /* 403 * An ACPI_NAMESPACE_NODE can appear in some contexts 404 * where a pointer to an ACPI_OPERAND_OBJECT can also 405 * appear. This macro is used to distinguish them. 406 * 407 * The "Descriptor" field is the first field in both structures. 408 */ 409 #define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 410 #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t) 411 412 /* Macro to test the object type */ 413 414 #define ACPI_GET_OBJECT_TYPE(d) (((ACPI_OPERAND_OBJECT *)(void *)(d))->Common.Type) 415 416 /* 417 * Macros for the master AML opcode table 418 */ 419 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 420 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 421 {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 422 #else 423 #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 424 {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 425 #endif 426 427 #ifdef ACPI_DISASSEMBLER 428 #define ACPI_DISASM_ONLY_MEMBERS(a) a; 429 #else 430 #define ACPI_DISASM_ONLY_MEMBERS(a) 431 #endif 432 433 #define ARG_TYPE_WIDTH 5 434 #define ARG_1(x) ((UINT32)(x)) 435 #define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 436 #define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 437 #define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 438 #define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 439 #define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 440 441 #define ARGI_LIST1(a) (ARG_1(a)) 442 #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 443 #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 444 #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 445 #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 446 #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)) 447 448 #define ARGP_LIST1(a) (ARG_1(a)) 449 #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 450 #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 451 #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 452 #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 453 #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)) 454 455 #define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 456 #define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 457 458 459 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES) 460 /* 461 * Module name is include in both debug and non-debug versions primarily for 462 * error messages. The __FILE__ macro is not very useful for this, because it 463 * often includes the entire pathname to the module 464 */ 465 #define ACPI_MODULE_NAME(Name) static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name; 466 #else 467 #define ACPI_MODULE_NAME(Name) 468 #endif 469 470 /* 471 * Ascii error messages can be configured out 472 */ 473 #ifndef ACPI_NO_ERROR_MESSAGES 474 #define AE_INFO _AcpiModuleName, __LINE__ 475 476 /* 477 * Error reporting. Callers module and line number are inserted by AE_INFO, 478 * the plist contains a set of parens to allow variable-length lists. 479 * These macros are used for both the debug and non-debug versions of the code. 480 */ 481 #define ACPI_INFO(plist) AcpiUtInfo plist 482 #define ACPI_WARNING(plist) AcpiUtWarning plist 483 #define ACPI_EXCEPTION(plist) AcpiUtException plist 484 #define ACPI_ERROR(plist) AcpiUtError plist 485 #define ACPI_ERROR_NAMESPACE(s, e) AcpiNsReportError (AE_INFO, s, e); 486 #define ACPI_ERROR_METHOD(s, n, p, e) AcpiNsReportMethodError (AE_INFO, s, n, p, e); 487 488 #else 489 490 /* No error messages */ 491 492 #define ACPI_INFO(plist) 493 #define ACPI_WARNING(plist) 494 #define ACPI_EXCEPTION(plist) 495 #define ACPI_ERROR(plist) 496 #define ACPI_ERROR_NAMESPACE(s, e) 497 #define ACPI_ERROR_METHOD(s, n, p, e) 498 #endif 499 500 /* 501 * Debug macros that are conditionally compiled 502 */ 503 #ifdef ACPI_DEBUG_OUTPUT 504 505 /* 506 * Common parameters used for debug output functions: 507 * line number, function name, module(file) name, component ID 508 */ 509 #define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT 510 511 /* 512 * Function entry tracing 513 */ 514 515 /* 516 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header, 517 * define it now. This is the case where there the compiler does not support 518 * a __FUNCTION__ macro or equivalent. 519 */ 520 #ifndef ACPI_GET_FUNCTION_NAME 521 #define ACPI_GET_FUNCTION_NAME _AcpiFunctionName 522 /* 523 * The Name parameter should be the procedure name as a quoted string. 524 * The function name is also used by the function exit macros below. 525 * Note: (const char) is used to be compatible with the debug interfaces 526 * and macros such as __FUNCTION__. 527 */ 528 #define ACPI_FUNCTION_NAME(Name) static const char _AcpiFunctionName[] = #Name; 529 530 #else 531 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */ 532 533 #define ACPI_FUNCTION_NAME(Name) 534 #endif 535 536 #define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 537 AcpiUtTrace(ACPI_DEBUG_PARAMETERS) 538 #define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \ 539 AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b) 540 #define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \ 541 AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b) 542 #define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \ 543 AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b) 544 545 #define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 546 547 /* 548 * Function exit tracing. 549 * WARNING: These macros include a return statement. This is usually considered 550 * bad form, but having a separate exit macro is very ugly and difficult to maintain. 551 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 552 * so that "_AcpiFunctionName" is defined. 553 * 554 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining 555 * about these constructs. 556 */ 557 #ifdef ACPI_USE_DO_WHILE_0 558 #define ACPI_DO_WHILE0(a) do a while(0) 559 #else 560 #define ACPI_DO_WHILE0(a) a 561 #endif 562 563 #define return_VOID ACPI_DO_WHILE0 ({ \ 564 AcpiUtExit (ACPI_DEBUG_PARAMETERS); \ 565 return;}) 566 /* 567 * There are two versions of most of the return macros. The default version is 568 * safer, since it avoids side-effects by guaranteeing that the argument will 569 * not be evaluated twice. 570 * 571 * A less-safe version of the macros is provided for optional use if the 572 * compiler uses excessive CPU stack (for example, this may happen in the 573 * debug case if code optimzation is disabled.) 574 */ 575 #ifndef ACPI_SIMPLE_RETURN_MACROS 576 577 #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 578 register ACPI_STATUS _s = (s); \ 579 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \ 580 return (_s); }) 581 #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 582 register void *_s = (void *) (s); \ 583 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \ 584 return (_s); }) 585 #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 586 register ACPI_INTEGER _s = (s); \ 587 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \ 588 return (_s); }) 589 #define return_UINT8(s) ACPI_DO_WHILE0 ({ \ 590 register UINT8 _s = (UINT8) (s); \ 591 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) _s); \ 592 return (_s); }) 593 #define return_UINT32(s) ACPI_DO_WHILE0 ({ \ 594 register UINT32 _s = (UINT32) (s); \ 595 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) _s); \ 596 return (_s); }) 597 #else /* Use original less-safe macros */ 598 599 #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 600 AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \ 601 return((s)); }) 602 #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 603 AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \ 604 return((s)); }) 605 #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 606 AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) (s)); \ 607 return((s)); }) 608 #define return_UINT8(s) return_VALUE(s) 609 #define return_UINT32(s) return_VALUE(s) 610 611 #endif /* ACPI_SIMPLE_RETURN_MACROS */ 612 613 614 /* Conditional execution */ 615 616 #define ACPI_DEBUG_EXEC(a) a 617 #define ACPI_DEBUG_ONLY_MEMBERS(a) a; 618 #define _VERBOSE_STRUCTURES 619 620 621 /* Various object display routines for debug */ 622 623 #define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0) 624 #define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c) 625 #define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b) 626 #define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d) 627 #define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT) 628 629 /* 630 * Master debug print macros 631 * Print iff: 632 * 1) Debug print for the current component is enabled 633 * 2) Debug error level or trace level for the print statement is enabled 634 */ 635 #define ACPI_DEBUG_PRINT(plist) AcpiUtDebugPrint plist 636 #define ACPI_DEBUG_PRINT_RAW(plist) AcpiUtDebugPrintRaw plist 637 638 639 #else 640 /* 641 * This is the non-debug case -- make everything go away, 642 * leaving no executable debug code! 643 */ 644 #define ACPI_DEBUG_EXEC(a) 645 #define ACPI_DEBUG_ONLY_MEMBERS(a) 646 #define ACPI_FUNCTION_NAME(a) 647 #define ACPI_FUNCTION_TRACE(a) 648 #define ACPI_FUNCTION_TRACE_PTR(a, b) 649 #define ACPI_FUNCTION_TRACE_U32(a, b) 650 #define ACPI_FUNCTION_TRACE_STR(a, b) 651 #define ACPI_FUNCTION_EXIT 652 #define ACPI_FUNCTION_STATUS_EXIT(s) 653 #define ACPI_FUNCTION_VALUE_EXIT(s) 654 #define ACPI_FUNCTION_ENTRY() 655 #define ACPI_DUMP_STACK_ENTRY(a) 656 #define ACPI_DUMP_OPERANDS(a, b, c) 657 #define ACPI_DUMP_ENTRY(a, b) 658 #define ACPI_DUMP_TABLES(a, b) 659 #define ACPI_DUMP_PATHNAME(a, b, c, d) 660 #define ACPI_DUMP_BUFFER(a, b) 661 #define ACPI_DEBUG_PRINT(pl) 662 #define ACPI_DEBUG_PRINT_RAW(pl) 663 664 #define return_VOID return 665 #define return_ACPI_STATUS(s) return(s) 666 #define return_VALUE(s) return(s) 667 #define return_UINT8(s) return(s) 668 #define return_UINT32(s) return(s) 669 #define return_PTR(s) return(s) 670 671 #endif 672 673 /* 674 * Some code only gets executed when the debugger is built in. 675 * Note that this is entirely independent of whether the 676 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 677 */ 678 #ifdef ACPI_DEBUGGER 679 #define ACPI_DEBUGGER_EXEC(a) a 680 #else 681 #define ACPI_DEBUGGER_EXEC(a) 682 #endif 683 684 685 /* 686 * Memory allocation tracking (DEBUG ONLY) 687 */ 688 #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 689 690 #ifndef ACPI_DBG_TRACK_ALLOCATIONS 691 692 /* Memory allocation */ 693 694 #define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 695 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 696 #define ACPI_FREE(a) AcpiOsFree(a) 697 #define ACPI_MEM_TRACKING(a) 698 699 #else 700 701 /* Memory allocation */ 702 703 #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 704 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 705 #define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS) 706 #define ACPI_MEM_TRACKING(a) a 707 708 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 709 710 711 /* 712 * Macros used for ACPICA utilities only 713 */ 714 715 /* Generate a UUID */ 716 717 #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 718 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 719 (b) & 0xFF, ((b) >> 8) & 0xFF, \ 720 (c) & 0xFF, ((c) >> 8) & 0xFF, \ 721 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 722 723 #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 724 725 726 #endif /* ACMACROS_H */ 727