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