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