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