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