acmacros.h revision 117521
1/****************************************************************************** 2 * 3 * Name: acmacros.h - C macros for the entire subsystem. 4 * $Revision: 145 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 125#define ACPI_LOWORD(l) ((UINT16)(UINT32)(l)) 126#define ACPI_HIWORD(l) ((UINT16)((((UINT32)(l)) >> 16) & 0xFFFF)) 127#define ACPI_LOBYTE(l) ((UINT8)(UINT16)(l)) 128#define ACPI_HIBYTE(l) ((UINT8)((((UINT16)(l)) >> 8) & 0xFF)) 129 130 131#if ACPI_MACHINE_WIDTH == 16 132 133/* 134 * For 16-bit addresses, we have to assume that the upper 32 bits 135 * are zero. 136 */ 137#define ACPI_LODWORD(l) ((UINT32)(l)) 138#define ACPI_HIDWORD(l) ((UINT32)(0)) 139 140#define ACPI_GET_ADDRESS(a) ((a).Lo) 141#define ACPI_STORE_ADDRESS(a,b) {(a).Hi=0;(a).Lo=(UINT32)(b);} 142#define ACPI_VALID_ADDRESS(a) ((a).Hi | (a).Lo) 143 144#else 145#ifdef ACPI_NO_INTEGER64_SUPPORT 146/* 147 * ACPI_INTEGER is 32-bits, no 64-bit support on this platform 148 */ 149#define ACPI_LODWORD(l) ((UINT32)(l)) 150#define ACPI_HIDWORD(l) ((UINT32)(0)) 151 152#define ACPI_GET_ADDRESS(a) (a) 153#define ACPI_STORE_ADDRESS(a,b) ((a)=(b)) 154#define ACPI_VALID_ADDRESS(a) (a) 155 156#else 157 158/* 159 * Full 64-bit address/integer on both 32-bit and 64-bit platforms 160 */ 161#define ACPI_LODWORD(l) ((UINT32)(UINT64)(l)) 162#define ACPI_HIDWORD(l) ((UINT32)(((*(UINT64_STRUCT *)(void *)(&l))).Hi)) 163 164#define ACPI_GET_ADDRESS(a) (a) 165#define ACPI_STORE_ADDRESS(a,b) ((a)=(ACPI_PHYSICAL_ADDRESS)(b)) 166#define ACPI_VALID_ADDRESS(a) (a) 167#endif 168#endif 169 170 /* 171 * Extract a byte of data using a pointer. Any more than a byte and we 172 * get into potential aligment issues -- see the STORE macros below 173 */ 174#define ACPI_GET8(addr) (*(UINT8*)(addr)) 175 176/* Pointer arithmetic */ 177 178#define ACPI_PTR_ADD(t,a,b) (t *) (void *)((char *)(a) + (ACPI_NATIVE_UINT)(b)) 179#define ACPI_PTR_DIFF(a,b) (ACPI_NATIVE_UINT) ((char *)(a) - (char *)(b)) 180 181/* Pointer/Integer type conversions */ 182 183#define ACPI_TO_POINTER(i) ACPI_PTR_ADD (void, (void *) NULL,(ACPI_NATIVE_UINT)i) 184#define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p,(void *) NULL) 185#define ACPI_OFFSET(d,f) (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f),(void *) NULL) 186#define ACPI_FADT_OFFSET(f) ACPI_OFFSET (FADT_DESCRIPTOR, f) 187 188#define ACPI_CAST_PTR(t, p) ((t *)(void *)(p)) 189#define ACPI_CAST_INDIRECT_PTR(t, p) ((t **)(void *)(p)) 190 191#if ACPI_MACHINE_WIDTH == 16 192#define ACPI_STORE_POINTER(d,s) ACPI_MOVE_32_TO_32(d,s) 193#define ACPI_PHYSADDR_TO_PTR(i) (void *)(i) 194#define ACPI_PTR_TO_PHYSADDR(i) (UINT32) (char *)(i) 195#else 196#define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i) 197#define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i) 198#endif 199 200/* 201 * Macros for moving data around to/from buffers that are possibly unaligned. 202 * If the hardware supports the transfer of unaligned data, just do the store. 203 * Otherwise, we have to move one byte at a time. 204 */ 205 206#ifdef ACPI_BIG_ENDIAN 207/* 208 * Macros for big-endian machines 209 */ 210 211/* This macro sets a buffer index, starting from the end of the buffer */ 212 213#define ACPI_BUFFER_INDEX(BufLen,BufOffset,ByteGran) ((BufLen) - (((BufOffset)+1) * (ByteGran))) 214 215/* These macros reverse the bytes during the move, converting little-endian to big endian */ 216 217 /* Big Endian <== Little Endian */ 218 /* Hi...Lo Lo...Hi */ 219/* 16-bit source, 16/32/64 destination */ 220 221#define ACPI_MOVE_16_TO_16(d,s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 222 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 223 224#define ACPI_MOVE_16_TO_32(d,s) {(*(UINT32 *)(void *)(d))=0;\ 225 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 226 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 227 228#define ACPI_MOVE_16_TO_64(d,s) {(*(UINT64 *)(void *)(d))=0;\ 229 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 230 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 231 232/* 32-bit source, 16/32/64 destination */ 233 234#define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 235 236#define ACPI_MOVE_32_TO_32(d,s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 237 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 238 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 239 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 240 241#define ACPI_MOVE_32_TO_64(d,s) {(*(UINT64 *)(void *)(d))=0;\ 242 ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 243 ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 244 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 245 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 246 247/* 64-bit source, 16/32/64 destination */ 248 249#define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 250 251#define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 252 253#define ACPI_MOVE_64_TO_64(d,s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 254 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 255 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 256 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 257 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 258 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 259 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 260 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 261#else 262/* 263 * Macros for little-endian machines 264 */ 265 266/* This macro sets a buffer index, starting from the beginning of the buffer */ 267 268#define ACPI_BUFFER_INDEX(BufLen,BufOffset,ByteGran) (BufOffset) 269 270#ifdef ACPI_MISALIGNED_TRANSFERS 271 272/* The hardware supports unaligned transfers, just do the little-endian move */ 273 274#if ACPI_MACHINE_WIDTH == 16 275 276/* No 64-bit integers */ 277/* 16-bit source, 16/32/64 destination */ 278 279#define ACPI_MOVE_16_TO_16(d,s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 280#define ACPI_MOVE_16_TO_32(d,s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 281#define ACPI_MOVE_16_TO_64(d,s) ACPI_MOVE_16_TO_32(d,s) 282 283/* 32-bit source, 16/32/64 destination */ 284 285#define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 286#define ACPI_MOVE_32_TO_32(d,s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 287#define ACPI_MOVE_32_TO_64(d,s) ACPI_MOVE_32_TO_32(d,s) 288 289/* 64-bit source, 16/32/64 destination */ 290 291#define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 292#define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 293#define ACPI_MOVE_64_TO_64(d,s) ACPI_MOVE_32_TO_32(d,s) 294 295#else 296/* 16-bit source, 16/32/64 destination */ 297 298#define ACPI_MOVE_16_TO_16(d,s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 299#define ACPI_MOVE_16_TO_32(d,s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 300#define ACPI_MOVE_16_TO_64(d,s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 301 302/* 32-bit source, 16/32/64 destination */ 303 304#define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 305#define ACPI_MOVE_32_TO_32(d,s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 306#define ACPI_MOVE_32_TO_64(d,s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 307 308/* 64-bit source, 16/32/64 destination */ 309 310#define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 311#define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 312#define ACPI_MOVE_64_TO_64(d,s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 313#endif 314 315#else 316/* 317 * The hardware does not support unaligned transfers. We must move the 318 * data one byte at a time. These macros work whether the source or 319 * the destination (or both) is/are unaligned. (Little-endian move) 320 */ 321 322/* 16-bit source, 16/32/64 destination */ 323 324#define ACPI_MOVE_16_TO_16(d,s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 325 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 326 327#define ACPI_MOVE_16_TO_32(d,s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);} 328#define ACPI_MOVE_16_TO_64(d,s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);} 329 330/* 32-bit source, 16/32/64 destination */ 331 332#define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 333 334#define ACPI_MOVE_32_TO_32(d,s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 335 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 336 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 337 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 338 339#define ACPI_MOVE_32_TO_64(d,s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d,s);} 340 341/* 64-bit source, 16/32/64 destination */ 342 343#define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 344#define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 345#define ACPI_MOVE_64_TO_64(d,s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 346 (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 347 (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 348 (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 349 (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 350 (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 351 (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 352 (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 353#endif 354#endif 355 356/* Macros based on machine integer width */ 357 358#if ACPI_MACHINE_WIDTH == 16 359#define ACPI_MOVE_SIZE_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) 360 361#elif ACPI_MACHINE_WIDTH == 32 362#define ACPI_MOVE_SIZE_TO_16(d,s) ACPI_MOVE_32_TO_16(d,s) 363 364#elif ACPI_MACHINE_WIDTH == 64 365#define ACPI_MOVE_SIZE_TO_16(d,s) ACPI_MOVE_64_TO_16(d,s) 366 367#else 368#error unknown ACPI_MACHINE_WIDTH 369#endif 370 371 372/* 373 * Fast power-of-two math macros for non-optimized compilers 374 */ 375 376#define _ACPI_DIV(value,PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 377#define _ACPI_MUL(value,PowerOf2) ((UINT32) ((value) << (PowerOf2))) 378#define _ACPI_MOD(value,Divisor) ((UINT32) ((value) & ((Divisor) -1))) 379 380#define ACPI_DIV_2(a) _ACPI_DIV(a,1) 381#define ACPI_MUL_2(a) _ACPI_MUL(a,1) 382#define ACPI_MOD_2(a) _ACPI_MOD(a,2) 383 384#define ACPI_DIV_4(a) _ACPI_DIV(a,2) 385#define ACPI_MUL_4(a) _ACPI_MUL(a,2) 386#define ACPI_MOD_4(a) _ACPI_MOD(a,4) 387 388#define ACPI_DIV_8(a) _ACPI_DIV(a,3) 389#define ACPI_MUL_8(a) _ACPI_MUL(a,3) 390#define ACPI_MOD_8(a) _ACPI_MOD(a,8) 391 392#define ACPI_DIV_16(a) _ACPI_DIV(a,4) 393#define ACPI_MUL_16(a) _ACPI_MUL(a,4) 394#define ACPI_MOD_16(a) _ACPI_MOD(a,16) 395 396 397/* 398 * Rounding macros (Power of two boundaries only) 399 */ 400#define ACPI_ROUND_DOWN(value,boundary) (((ACPI_NATIVE_UINT)(value)) & (~(((ACPI_NATIVE_UINT) boundary)-1))) 401#define ACPI_ROUND_UP(value,boundary) ((((ACPI_NATIVE_UINT)(value)) + (((ACPI_NATIVE_UINT) boundary)-1)) & (~(((ACPI_NATIVE_UINT) boundary)-1))) 402 403#define ACPI_ROUND_DOWN_TO_32_BITS(a) ACPI_ROUND_DOWN(a,4) 404#define ACPI_ROUND_DOWN_TO_64_BITS(a) ACPI_ROUND_DOWN(a,8) 405#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a,ALIGNED_ADDRESS_BOUNDARY) 406 407#define ACPI_ROUND_UP_TO_32BITS(a) ACPI_ROUND_UP(a,4) 408#define ACPI_ROUND_UP_TO_64BITS(a) ACPI_ROUND_UP(a,8) 409#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a,ALIGNED_ADDRESS_BOUNDARY) 410 411 412#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 413#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 414 415#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 416 417/* Generic (non-power-of-two) rounding */ 418 419#define ACPI_ROUND_UP_TO(value,boundary) (((value) + ((boundary)-1)) / (boundary)) 420 421/* 422 * Bitmask creation 423 * Bit positions start at zero. 424 * MASK_BITS_ABOVE creates a mask starting AT the position and above 425 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 426 */ 427#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((UINT32) (position)))) 428#define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((UINT32) (position))) 429 430#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 431 432/* Macros for GAS addressing */ 433 434#if ACPI_MACHINE_WIDTH != 16 435 436#define ACPI_PCI_DEVICE(a) (UINT16) ((ACPI_HIDWORD ((a))) & 0x0000FFFF) 437#define ACPI_PCI_FUNCTION(a) (UINT16) ((ACPI_LODWORD ((a))) >> 16) 438#define ACPI_PCI_REGISTER(a) (UINT16) ((ACPI_LODWORD ((a))) & 0x0000FFFF) 439 440#else 441 442/* No support for GAS and PCI IDs in 16-bit mode */ 443 444#define ACPI_PCI_FUNCTION(a) (UINT16) ((a) & 0xFFFF0000) 445#define ACPI_PCI_DEVICE(a) (UINT16) ((a) & 0x0000FFFF) 446#define ACPI_PCI_REGISTER(a) (UINT16) ((a) & 0x0000FFFF) 447 448#endif 449 450 451/* Bitfields within ACPI registers */ 452 453#define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 454#define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 455 456/* 457 * An ACPI_NAMESPACE_NODE * can appear in some contexts, 458 * where a pointer to an ACPI_OPERAND_OBJECT can also 459 * appear. This macro is used to distinguish them. 460 * 461 * The "Descriptor" field is the first field in both structures. 462 */ 463#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->DescriptorId) 464#define ACPI_SET_DESCRIPTOR_TYPE(d,t) (((ACPI_DESCRIPTOR *)(void *)(d))->DescriptorId = t) 465 466 467/* Macro to test the object type */ 468 469#define ACPI_GET_OBJECT_TYPE(d) (((ACPI_OPERAND_OBJECT *)(void *)(d))->Common.Type) 470 471/* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */ 472 473#define ACPI_IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0) 474 475/* 476 * Macros for the master AML opcode table 477 */ 478#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 479#define ACPI_OP(Name,PArgs,IArgs,ObjType,Class,Type,Flags) {Name,(UINT32)(PArgs),(UINT32)(IArgs),(UINT32)(Flags),ObjType,Class,Type} 480#else 481#define ACPI_OP(Name,PArgs,IArgs,ObjType,Class,Type,Flags) {(UINT32)(PArgs),(UINT32)(IArgs),(UINT32)(Flags),ObjType,Class,Type} 482#endif 483 484#ifdef ACPI_DISASSEMBLER 485#define ACPI_DISASM_ONLY_MEMBERS(a) a; 486#else 487#define ACPI_DISASM_ONLY_MEMBERS(a) 488#endif 489 490#define ARG_TYPE_WIDTH 5 491#define ARG_1(x) ((UINT32)(x)) 492#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 493#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 494#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 495#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 496#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 497 498#define ARGI_LIST1(a) (ARG_1(a)) 499#define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a)) 500#define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 501#define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 502#define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 503#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)) 504 505#define ARGP_LIST1(a) (ARG_1(a)) 506#define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b)) 507#define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 508#define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 509#define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 510#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)) 511 512#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 513#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 514 515 516/* 517 * Reporting macros that are never compiled out 518 */ 519 520#define ACPI_PARAM_LIST(pl) pl 521 522/* 523 * Error reporting. These versions add callers module and line#. Since 524 * _THIS_MODULE gets compiled out when ACPI_DEBUG_OUTPUT isn't defined, only 525 * use it in debug mode. 526 */ 527 528#ifdef ACPI_DEBUG_OUTPUT 529 530#define ACPI_REPORT_INFO(fp) {AcpiUtReportInfo(_THIS_MODULE,__LINE__,_COMPONENT); \ 531 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 532#define ACPI_REPORT_ERROR(fp) {AcpiUtReportError(_THIS_MODULE,__LINE__,_COMPONENT); \ 533 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 534#define ACPI_REPORT_WARNING(fp) {AcpiUtReportWarning(_THIS_MODULE,__LINE__,_COMPONENT); \ 535 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 536#define ACPI_REPORT_NSERROR(s,e) AcpiNsReportError(_THIS_MODULE,__LINE__,_COMPONENT, s, e); 537 538#define ACPI_REPORT_METHOD_ERROR(s,n,p,e) AcpiNsReportMethodError(_THIS_MODULE,__LINE__,_COMPONENT, s, n, p, e); 539 540#else 541 542#define ACPI_REPORT_INFO(fp) {AcpiUtReportInfo("ACPI",__LINE__,_COMPONENT); \ 543 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 544#define ACPI_REPORT_ERROR(fp) {AcpiUtReportError("ACPI",__LINE__,_COMPONENT); \ 545 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 546#define ACPI_REPORT_WARNING(fp) {AcpiUtReportWarning("ACPI",__LINE__,_COMPONENT); \ 547 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 548#define ACPI_REPORT_NSERROR(s,e) AcpiNsReportError("ACPI",__LINE__,_COMPONENT, s, e); 549 550#define ACPI_REPORT_METHOD_ERROR(s,n,p,e) AcpiNsReportMethodError("ACPI",__LINE__,_COMPONENT, s, n, p, e); 551 552#endif 553 554/* Error reporting. These versions pass thru the module and line# */ 555 556#define _ACPI_REPORT_INFO(a,b,c,fp) {AcpiUtReportInfo(a,b,c); \ 557 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 558#define _ACPI_REPORT_ERROR(a,b,c,fp) {AcpiUtReportError(a,b,c); \ 559 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 560#define _ACPI_REPORT_WARNING(a,b,c,fp) {AcpiUtReportWarning(a,b,c); \ 561 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 562 563/* 564 * Debug macros that are conditionally compiled 565 */ 566 567#ifdef ACPI_DEBUG_OUTPUT 568 569#define ACPI_MODULE_NAME(name) static char ACPI_UNUSED_VAR *_THIS_MODULE = name; 570 571/* 572 * Function entry tracing. 573 * The first parameter should be the procedure name as a quoted string. This is declared 574 * as a local string ("_ProcName) so that it can be also used by the function exit macros below. 575 */ 576 577#define ACPI_FUNCTION_NAME(a) ACPI_DEBUG_PRINT_INFO _Dbg; \ 578 _Dbg.ComponentId = _COMPONENT; \ 579 _Dbg.ProcName = a; \ 580 _Dbg.ModuleName = _THIS_MODULE; 581 582#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 583 AcpiUtTrace(__LINE__,&_Dbg) 584#define ACPI_FUNCTION_TRACE_PTR(a,b) ACPI_FUNCTION_NAME(a) \ 585 AcpiUtTracePtr(__LINE__,&_Dbg,(void *)b) 586#define ACPI_FUNCTION_TRACE_U32(a,b) ACPI_FUNCTION_NAME(a) \ 587 AcpiUtTraceU32(__LINE__,&_Dbg,(UINT32)b) 588#define ACPI_FUNCTION_TRACE_STR(a,b) ACPI_FUNCTION_NAME(a) \ 589 AcpiUtTraceStr(__LINE__,&_Dbg,(char *)b) 590 591#define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 592 593/* 594 * Function exit tracing. 595 * WARNING: These macros include a return statement. This is usually considered 596 * bad form, but having a separate exit macro is very ugly and difficult to maintain. 597 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 598 * so that "_ProcName" is defined. 599 */ 600#ifdef ACPI_USE_DO_WHILE_0 601#define ACPI_DO_WHILE0(a) do a while(0) 602#else 603#define ACPI_DO_WHILE0(a) a 604#endif 605 606#define return_VOID ACPI_DO_WHILE0 ({AcpiUtExit(__LINE__,&_Dbg);return;}) 607#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({AcpiUtStatusExit(__LINE__,&_Dbg,(s));return((s));}) 608#define return_VALUE(s) ACPI_DO_WHILE0 ({AcpiUtValueExit(__LINE__,&_Dbg,(ACPI_INTEGER)(s));return((s));}) 609#define return_PTR(s) ACPI_DO_WHILE0 ({AcpiUtPtrExit(__LINE__,&_Dbg,(UINT8 *)(s));return((s));}) 610 611/* Conditional execution */ 612 613#define ACPI_DEBUG_EXEC(a) a 614#define ACPI_NORMAL_EXEC(a) 615 616#define ACPI_DEBUG_DEFINE(a) a; 617#define ACPI_DEBUG_ONLY_MEMBERS(a) a; 618#define _VERBOSE_STRUCTURES 619 620 621/* Stack and buffer dumping */ 622 623#define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand(a) 624#define ACPI_DUMP_OPERANDS(a,b,c,d,e) AcpiExDumpOperands(a,b,c,d,e,_THIS_MODULE,__LINE__) 625 626 627#define ACPI_DUMP_ENTRY(a,b) AcpiNsDumpEntry (a,b) 628#define ACPI_DUMP_TABLES(a,b) AcpiNsDumpTables(a,b) 629#define ACPI_DUMP_PATHNAME(a,b,c,d) AcpiNsDumpPathname(a,b,c,d) 630#define ACPI_DUMP_RESOURCE_LIST(a) AcpiRsDumpResourceList(a) 631#define ACPI_DUMP_BUFFER(a,b) AcpiUtDumpBuffer((UINT8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT) 632#define ACPI_BREAK_MSG(a) AcpiOsSignal (ACPI_SIGNAL_BREAKPOINT,(a)) 633 634 635/* 636 * Generate INT3 on ACPI_ERROR (Debug only!) 637 */ 638 639#define ACPI_ERROR_BREAK 640#ifdef ACPI_ERROR_BREAK 641#define ACPI_BREAK_ON_ERROR(lvl) if ((lvl)&ACPI_ERROR) \ 642 AcpiOsSignal(ACPI_SIGNAL_BREAKPOINT,"Fatal error encountered\n") 643#else 644#define ACPI_BREAK_ON_ERROR(lvl) 645#endif 646 647/* 648 * Master debug print macros 649 * Print iff: 650 * 1) Debug print for the current component is enabled 651 * 2) Debug error level or trace level for the print statement is enabled 652 */ 653 654#define ACPI_DEBUG_PRINT(pl) AcpiUtDebugPrint ACPI_PARAM_LIST(pl) 655#define ACPI_DEBUG_PRINT_RAW(pl) AcpiUtDebugPrintRaw ACPI_PARAM_LIST(pl) 656 657 658#else 659/* 660 * This is the non-debug case -- make everything go away, 661 * leaving no executable debug code! 662 */ 663 664#define ACPI_MODULE_NAME(name) 665#define _THIS_MODULE "" 666 667#define ACPI_DEBUG_EXEC(a) 668#define ACPI_NORMAL_EXEC(a) a; 669 670#define ACPI_DEBUG_DEFINE(a) 671#define ACPI_DEBUG_ONLY_MEMBERS(a) 672#define ACPI_FUNCTION_NAME(a) 673#define ACPI_FUNCTION_TRACE(a) 674#define ACPI_FUNCTION_TRACE_PTR(a,b) 675#define ACPI_FUNCTION_TRACE_U32(a,b) 676#define ACPI_FUNCTION_TRACE_STR(a,b) 677#define ACPI_FUNCTION_EXIT 678#define ACPI_FUNCTION_STATUS_EXIT(s) 679#define ACPI_FUNCTION_VALUE_EXIT(s) 680#define ACPI_FUNCTION_ENTRY() 681#define ACPI_DUMP_STACK_ENTRY(a) 682#define ACPI_DUMP_OPERANDS(a,b,c,d,e) 683#define ACPI_DUMP_ENTRY(a,b) 684#define ACPI_DUMP_TABLES(a,b) 685#define ACPI_DUMP_PATHNAME(a,b,c,d) 686#define ACPI_DUMP_RESOURCE_LIST(a) 687#define ACPI_DUMP_BUFFER(a,b) 688#define ACPI_DEBUG_PRINT(pl) 689#define ACPI_DEBUG_PRINT_RAW(pl) 690#define ACPI_BREAK_MSG(a) 691 692#define return_VOID return 693#define return_ACPI_STATUS(s) return(s) 694#define return_VALUE(s) return(s) 695#define return_PTR(s) return(s) 696 697#endif 698 699/* 700 * Some code only gets executed when the debugger is built in. 701 * Note that this is entirely independent of whether the 702 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 703 */ 704#ifdef ACPI_DEBUGGER 705#define ACPI_DEBUGGER_EXEC(a) a 706#else 707#define ACPI_DEBUGGER_EXEC(a) 708#endif 709 710 711/* 712 * For 16-bit code, we want to shrink some things even though 713 * we are using ACPI_DEBUG_OUTPUT to get the debug output 714 */ 715#if ACPI_MACHINE_WIDTH == 16 716#undef ACPI_DEBUG_ONLY_MEMBERS 717#undef _VERBOSE_STRUCTURES 718#define ACPI_DEBUG_ONLY_MEMBERS(a) 719#endif 720 721 722#ifdef ACPI_DEBUG_OUTPUT 723/* 724 * 1) Set name to blanks 725 * 2) Copy the object name 726 */ 727#define ACPI_ADD_OBJECT_NAME(a,b) ACPI_MEMSET (a->Common.Name, ' ', sizeof (a->Common.Name));\ 728 ACPI_STRNCPY (a->Common.Name, AcpiGbl_NsTypeNames[b], sizeof (a->Common.Name)) 729#else 730 731#define ACPI_ADD_OBJECT_NAME(a,b) 732#endif 733 734 735/* 736 * Memory allocation tracking (DEBUG ONLY) 737 */ 738 739#ifndef ACPI_DBG_TRACK_ALLOCATIONS 740 741/* Memory allocation */ 742 743#define ACPI_MEM_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE)(a),_COMPONENT,_THIS_MODULE,__LINE__) 744#define ACPI_MEM_CALLOCATE(a) AcpiUtCallocate((ACPI_SIZE)(a), _COMPONENT,_THIS_MODULE,__LINE__) 745#define ACPI_MEM_FREE(a) AcpiOsFree(a) 746#define ACPI_MEM_TRACKING(a) 747 748 749#else 750 751/* Memory allocation */ 752 753#define ACPI_MEM_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE)(a),_COMPONENT,_THIS_MODULE,__LINE__) 754#define ACPI_MEM_CALLOCATE(a) AcpiUtCallocateAndTrack((ACPI_SIZE)(a), _COMPONENT,_THIS_MODULE,__LINE__) 755#define ACPI_MEM_FREE(a) AcpiUtFreeAndTrack(a,_COMPONENT,_THIS_MODULE,__LINE__) 756#define ACPI_MEM_TRACKING(a) a 757 758#endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 759 760 761#define ACPI_GET_STACK_POINTER _asm {mov eax, ebx} 762 763#endif /* ACMACROS_H */ 764