acmacros.h revision 102550
1/****************************************************************************** 2 * 3 * Name: acmacros.h - C macros for the entire subsystem. 4 * $Revision: 128 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, 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) + (NATIVE_UINT)(b)) 179#define ACPI_PTR_DIFF(a,b) (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,(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_UNALIGNED32_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 _HW_ALIGNMENT_SUPPORT 207 208/* The hardware supports unaligned transfers, just do the move */ 209 210#define ACPI_MOVE_UNALIGNED16_TO_16(d,s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 211#define ACPI_MOVE_UNALIGNED32_TO_32(d,s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 212#define ACPI_MOVE_UNALIGNED16_TO_32(d,s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 213#define ACPI_MOVE_UNALIGNED64_TO_64(d,s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 214 215#else 216/* 217 * The hardware does not support unaligned transfers. We must move the 218 * data one byte at a time. These macros work whether the source or 219 * the destination (or both) is/are unaligned. 220 */ 221 222#define ACPI_MOVE_UNALIGNED16_TO_16(d,s) {((UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 223 ((UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 224 225#define ACPI_MOVE_UNALIGNED32_TO_32(d,s) {((UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 226 ((UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 227 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 228 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 229 230#define ACPI_MOVE_UNALIGNED16_TO_32(d,s) {(*(UINT32*)(void *)(d)) = 0; ACPI_MOVE_UNALIGNED16_TO_16(d,s);} 231 232#define ACPI_MOVE_UNALIGNED64_TO_64(d,s) {((UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 233 ((UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 234 ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 235 ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 236 ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 237 ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 238 ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 239 ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 240 241#endif 242 243 244/* 245 * Fast power-of-two math macros for non-optimized compilers 246 */ 247 248#define _ACPI_DIV(value,PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 249#define _ACPI_MUL(value,PowerOf2) ((UINT32) ((value) << (PowerOf2))) 250#define _ACPI_MOD(value,Divisor) ((UINT32) ((value) & ((Divisor) -1))) 251 252#define ACPI_DIV_2(a) _ACPI_DIV(a,1) 253#define ACPI_MUL_2(a) _ACPI_MUL(a,1) 254#define ACPI_MOD_2(a) _ACPI_MOD(a,2) 255 256#define ACPI_DIV_4(a) _ACPI_DIV(a,2) 257#define ACPI_MUL_4(a) _ACPI_MUL(a,2) 258#define ACPI_MOD_4(a) _ACPI_MOD(a,4) 259 260#define ACPI_DIV_8(a) _ACPI_DIV(a,3) 261#define ACPI_MUL_8(a) _ACPI_MUL(a,3) 262#define ACPI_MOD_8(a) _ACPI_MOD(a,8) 263 264#define ACPI_DIV_16(a) _ACPI_DIV(a,4) 265#define ACPI_MUL_16(a) _ACPI_MUL(a,4) 266#define ACPI_MOD_16(a) _ACPI_MOD(a,16) 267 268 269/* 270 * Rounding macros (Power of two boundaries only) 271 */ 272#define ACPI_ROUND_DOWN(value,boundary) (((NATIVE_UINT)(value)) & (~(((NATIVE_UINT) boundary)-1))) 273#define ACPI_ROUND_UP(value,boundary) ((((NATIVE_UINT)(value)) + (((NATIVE_UINT) boundary)-1)) & (~(((NATIVE_UINT) boundary)-1))) 274 275#define ACPI_ROUND_DOWN_TO_32_BITS(a) ACPI_ROUND_DOWN(a,4) 276#define ACPI_ROUND_DOWN_TO_64_BITS(a) ACPI_ROUND_DOWN(a,8) 277#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a,ALIGNED_ADDRESS_BOUNDARY) 278 279#define ACPI_ROUND_UP_TO_32BITS(a) ACPI_ROUND_UP(a,4) 280#define ACPI_ROUND_UP_TO_64BITS(a) ACPI_ROUND_UP(a,8) 281#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a,ALIGNED_ADDRESS_BOUNDARY) 282 283 284#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 285#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 286 287#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 288 289/* Generic (non-power-of-two) rounding */ 290 291#define ACPI_ROUND_UP_TO(value,boundary) (((value) + ((boundary)-1)) / (boundary)) 292 293/* 294 * Bitmask creation 295 * Bit positions start at zero. 296 * MASK_BITS_ABOVE creates a mask starting AT the position and above 297 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 298 */ 299#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((UINT32) (position)))) 300#define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((UINT32) (position))) 301 302#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 303 304/* Macros for GAS addressing */ 305 306#if ACPI_MACHINE_WIDTH != 16 307 308#define ACPI_PCI_DEVICE_MASK (UINT64) 0x0000FFFF00000000 309#define ACPI_PCI_FUNCTION_MASK (UINT64) 0x00000000FFFF0000 310#define ACPI_PCI_REGISTER_MASK (UINT64) 0x000000000000FFFF 311 312/* 313 * Obsolete 314 */ 315 316/* 317#define ACPI_PCI_FUNCTION(a) (UINT16) ((((UINT64)((UINT64)(a) & ACPI_PCI_FUNCTION_MASK)) >> 16)) 318#define ACPI_PCI_DEVICE(a) (UINT16) ((((UINT64)((UINT64)(a) & ACPI_PCI_DEVICE_MASK)) >> 32)) 319#define ACPI_PCI_REGISTER(a) (UINT16) (((UINT64)((UINT64)(a) & ACPI_PCI_REGISTER_MASK))) 320*/ 321 322 323#define ACPI_PCI_DEVICE(a) (UINT16) ((ACPI_HIDWORD ((a))) & 0x0000FFFF) 324#define ACPI_PCI_FUNCTION(a) (UINT16) ((ACPI_LODWORD ((a))) >> 16) 325#define ACPI_PCI_REGISTER(a) (UINT16) ((ACPI_LODWORD ((a))) & 0x0000FFFF) 326 327#else 328 329/* No support for GAS and PCI IDs in 16-bit mode */ 330 331#define ACPI_PCI_FUNCTION(a) (UINT16) ((a) & 0xFFFF0000) 332#define ACPI_PCI_DEVICE(a) (UINT16) ((a) & 0x0000FFFF) 333#define ACPI_PCI_REGISTER(a) (UINT16) ((a) & 0x0000FFFF) 334 335#endif 336 337 338/* Bitfields within ACPI registers */ 339 340#define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 341#define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 342 343/* 344 * An ACPI_NAMESPACE_NODE * can appear in some contexts, 345 * where a pointer to an ACPI_OPERAND_OBJECT can also 346 * appear. This macro is used to distinguish them. 347 * 348 * The "Descriptor" field is the first field in both structures. 349 */ 350#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->DescriptorId) 351#define ACPI_SET_DESCRIPTOR_TYPE(d,t) (((ACPI_DESCRIPTOR *)(void *)(d))->DescriptorId = t) 352 353 354/* Macro to test the object type */ 355 356#define ACPI_GET_OBJECT_TYPE(d) (((ACPI_OPERAND_OBJECT *)(void *)(d))->Common.Type) 357 358/* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */ 359 360#define ACPI_IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0) 361 362/* 363 * Macro to check if a pointer is within an ACPI table. 364 * Parameter (a) is the pointer to check. Parameter (b) must be defined 365 * as a pointer to an ACPI_TABLE_HEADER. (b+1) then points past the header, 366 * and ((UINT8 *)b+b->Length) points one byte past the end of the table. 367 */ 368#if ACPI_MACHINE_WIDTH != 16 369#define ACPI_IS_IN_ACPI_TABLE(a,b) (((UINT8 *)(a) >= (UINT8 *)(b + 1)) &&\ 370 ((UINT8 *)(a) < ((UINT8 *)b + b->Length))) 371 372#else 373#define ACPI_IS_IN_ACPI_TABLE(a,b) (_segment)(a) == (_segment)(b) &&\ 374 (((UINT8 *)(a) >= (UINT8 *)(b + 1)) &&\ 375 ((UINT8 *)(a) < ((UINT8 *)b + b->Length))) 376#endif 377 378/* 379 * Macros for the master AML opcode table 380 */ 381#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 382#define ACPI_OP(Name,PArgs,IArgs,ObjType,Class,Type,Flags) {Name,PArgs,IArgs,Flags,ObjType,Class,Type} 383#else 384#define ACPI_OP(Name,PArgs,IArgs,ObjType,Class,Type,Flags) {PArgs,IArgs,Flags,ObjType,Class,Type} 385#endif 386 387#ifdef ACPI_DISASSEMBLER 388#define ACPI_DISASM_ONLY_MEMBERS(a) a; 389#else 390#define ACPI_DISASM_ONLY_MEMBERS(a) 391#endif 392 393#define ARG_TYPE_WIDTH 5 394#define ARG_1(x) ((UINT32)(x)) 395#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 396#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 397#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 398#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 399#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 400 401#define ARGI_LIST1(a) (ARG_1(a)) 402#define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a)) 403#define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 404#define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 405#define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 406#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)) 407 408#define ARGP_LIST1(a) (ARG_1(a)) 409#define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b)) 410#define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 411#define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 412#define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 413#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)) 414 415#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 416#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 417 418 419/* 420 * Build a GAS structure from earlier ACPI table entries (V1.0 and 0.71 extensions) 421 * 422 * 1) Address space 423 * 2) Length in bytes -- convert to length in bits 424 * 3) Bit offset is zero 425 * 4) Reserved field is zero 426 * 5) Expand address to 64 bits 427 */ 428#define ASL_BUILD_GAS_FROM_ENTRY(a,b,c,d) {a.AddressSpaceId = (UINT8) d;\ 429 a.RegisterBitWidth = (UINT8) ACPI_MUL_8 (b);\ 430 a.RegisterBitOffset = 0;\ 431 a.Reserved = 0;\ 432 ACPI_STORE_ADDRESS (a.Address,(ACPI_PHYSICAL_ADDRESS) c);} 433 434/* ACPI V1.0 entries -- address space is always I/O */ 435 436#define ASL_BUILD_GAS_FROM_V1_ENTRY(a,b,c) ASL_BUILD_GAS_FROM_ENTRY(a,b,c,ACPI_ADR_SPACE_SYSTEM_IO) 437 438 439/* 440 * Reporting macros that are never compiled out 441 */ 442 443#define ACPI_PARAM_LIST(pl) pl 444 445/* 446 * Error reporting. These versions add callers module and line#. Since 447 * _THIS_MODULE gets compiled out when ACPI_DEBUG_OUTPUT isn't defined, only 448 * use it in debug mode. 449 */ 450 451#ifdef ACPI_DEBUG_OUTPUT 452 453#define ACPI_REPORT_INFO(fp) {AcpiUtReportInfo(_THIS_MODULE,__LINE__,_COMPONENT); \ 454 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 455#define ACPI_REPORT_ERROR(fp) {AcpiUtReportError(_THIS_MODULE,__LINE__,_COMPONENT); \ 456 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 457#define ACPI_REPORT_WARNING(fp) {AcpiUtReportWarning(_THIS_MODULE,__LINE__,_COMPONENT); \ 458 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 459 460#else 461 462#define ACPI_REPORT_INFO(fp) {AcpiUtReportInfo("ACPI",__LINE__,_COMPONENT); \ 463 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 464#define ACPI_REPORT_ERROR(fp) {AcpiUtReportError("ACPI",__LINE__,_COMPONENT); \ 465 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 466#define ACPI_REPORT_WARNING(fp) {AcpiUtReportWarning("ACPI",__LINE__,_COMPONENT); \ 467 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 468 469#endif 470 471/* Error reporting. These versions pass thru the module and line# */ 472 473#define _ACPI_REPORT_INFO(a,b,c,fp) {AcpiUtReportInfo(a,b,c); \ 474 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 475#define _ACPI_REPORT_ERROR(a,b,c,fp) {AcpiUtReportError(a,b,c); \ 476 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 477#define _ACPI_REPORT_WARNING(a,b,c,fp) {AcpiUtReportWarning(a,b,c); \ 478 AcpiOsPrintf ACPI_PARAM_LIST(fp);} 479 480/* 481 * Debug macros that are conditionally compiled 482 */ 483 484#ifdef ACPI_DEBUG_OUTPUT 485 486#define ACPI_MODULE_NAME(name) static char *_THIS_MODULE = name; 487 488/* 489 * Function entry tracing. 490 * The first parameter should be the procedure name as a quoted string. This is declared 491 * as a local string ("_ProcName) so that it can be also used by the function exit macros below. 492 */ 493 494#define ACPI_FUNCTION_NAME(a) ACPI_DEBUG_PRINT_INFO _Dbg; \ 495 _Dbg.ComponentId = _COMPONENT; \ 496 _Dbg.ProcName = a; \ 497 _Dbg.ModuleName = _THIS_MODULE; 498 499#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a)\ 500 AcpiUtTrace(__LINE__,&_Dbg) 501#define ACPI_FUNCTION_TRACE_PTR(a,b) ACPI_FUNCTION_NAME(a)\ 502 AcpiUtTracePtr(__LINE__,&_Dbg,(void *)b) 503#define ACPI_FUNCTION_TRACE_U32(a,b) ACPI_FUNCTION_NAME(a)\ 504 AcpiUtTraceU32(__LINE__,&_Dbg,(UINT32)b) 505#define ACPI_FUNCTION_TRACE_STR(a,b) ACPI_FUNCTION_NAME(a)\ 506 AcpiUtTraceStr(__LINE__,&_Dbg,(NATIVE_CHAR *)b) 507 508#define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 509 510/* 511 * Function exit tracing. 512 * WARNING: These macros include a return statement. This is usually considered 513 * bad form, but having a separate exit macro is very ugly and difficult to maintain. 514 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 515 * so that "_ProcName" is defined. 516 */ 517#ifdef ACPI_USE_DO_WHILE_0 518#define ACPI_DO_WHILE0(a) do a while(0) 519#else 520#define ACPI_DO_WHILE0(a) a 521#endif 522 523#define return_VOID ACPI_DO_WHILE0 ({AcpiUtExit(__LINE__,&_Dbg);return;}) 524#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({AcpiUtStatusExit(__LINE__,&_Dbg,(s));return((s));}) 525#define return_VALUE(s) ACPI_DO_WHILE0 ({AcpiUtValueExit(__LINE__,&_Dbg,(ACPI_INTEGER)(s));return((s));}) 526#define return_PTR(s) ACPI_DO_WHILE0 ({AcpiUtPtrExit(__LINE__,&_Dbg,(UINT8 *)(s));return((s));}) 527 528/* Conditional execution */ 529 530#define ACPI_DEBUG_EXEC(a) a 531#define ACPI_NORMAL_EXEC(a) 532 533#define ACPI_DEBUG_DEFINE(a) a; 534#define ACPI_DEBUG_ONLY_MEMBERS(a) a; 535#define _VERBOSE_STRUCTURES 536 537 538/* Stack and buffer dumping */ 539 540#define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand(a) 541#define ACPI_DUMP_OPERANDS(a,b,c,d,e) AcpiExDumpOperands(a,b,c,d,e,_THIS_MODULE,__LINE__) 542 543 544#define ACPI_DUMP_ENTRY(a,b) AcpiNsDumpEntry (a,b) 545#define ACPI_DUMP_TABLES(a,b) AcpiNsDumpTables(a,b) 546#define ACPI_DUMP_PATHNAME(a,b,c,d) (void) AcpiNsDumpPathname(a,b,c,d) 547#define ACPI_DUMP_RESOURCE_LIST(a) AcpiRsDumpResourceList(a) 548#define ACPI_DUMP_BUFFER(a,b) AcpiUtDumpBuffer((UINT8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT) 549#define ACPI_BREAK_MSG(a) AcpiOsSignal (ACPI_SIGNAL_BREAKPOINT,(a)) 550 551 552/* 553 * Generate INT3 on ACPI_ERROR (Debug only!) 554 */ 555 556#define ACPI_ERROR_BREAK 557#ifdef ACPI_ERROR_BREAK 558#define ACPI_BREAK_ON_ERROR(lvl) if ((lvl)&ACPI_ERROR) \ 559 AcpiOsSignal(ACPI_SIGNAL_BREAKPOINT,"Fatal error encountered\n") 560#else 561#define ACPI_BREAK_ON_ERROR(lvl) 562#endif 563 564/* 565 * Master debug print macros 566 * Print iff: 567 * 1) Debug print for the current component is enabled 568 * 2) Debug error level or trace level for the print statement is enabled 569 */ 570 571#define ACPI_DEBUG_PRINT(pl) AcpiUtDebugPrint ACPI_PARAM_LIST(pl) 572#define ACPI_DEBUG_PRINT_RAW(pl) AcpiUtDebugPrintRaw ACPI_PARAM_LIST(pl) 573 574 575#else 576/* 577 * This is the non-debug case -- make everything go away, 578 * leaving no executable debug code! 579 */ 580 581#define ACPI_MODULE_NAME(name) 582#define _THIS_MODULE "" 583 584#define ACPI_DEBUG_EXEC(a) 585#define ACPI_NORMAL_EXEC(a) a; 586 587#define ACPI_DEBUG_DEFINE(a) 588#define ACPI_DEBUG_ONLY_MEMBERS(a) 589#define ACPI_FUNCTION_NAME(a) 590#define ACPI_FUNCTION_TRACE(a) 591#define ACPI_FUNCTION_TRACE_PTR(a,b) 592#define ACPI_FUNCTION_TRACE_U32(a,b) 593#define ACPI_FUNCTION_TRACE_STR(a,b) 594#define ACPI_FUNCTION_EXIT 595#define ACPI_FUNCTION_STATUS_EXIT(s) 596#define ACPI_FUNCTION_VALUE_EXIT(s) 597#define ACPI_FUNCTION_ENTRY() 598#define ACPI_DUMP_STACK_ENTRY(a) 599#define ACPI_DUMP_OPERANDS(a,b,c,d,e) 600#define ACPI_DUMP_ENTRY(a,b) 601#define ACPI_DUMP_TABLES(a,b) 602#define ACPI_DUMP_PATHNAME(a,b,c,d) 603#define ACPI_DUMP_RESOURCE_LIST(a) 604#define ACPI_DUMP_BUFFER(a,b) 605#define ACPI_DEBUG_PRINT(pl) 606#define ACPI_DEBUG_PRINT_RAW(pl) 607#define ACPI_BREAK_MSG(a) 608 609#define return_VOID return 610#define return_ACPI_STATUS(s) return(s) 611#define return_VALUE(s) return(s) 612#define return_PTR(s) return(s) 613 614#endif 615 616/* 617 * Some code only gets executed when the debugger is built in. 618 * Note that this is entirely independent of whether the 619 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 620 */ 621#ifdef ACPI_DEBUGGER 622#define ACPI_DEBUGGER_EXEC(a) a 623#else 624#define ACPI_DEBUGGER_EXEC(a) 625#endif 626 627 628/* 629 * For 16-bit code, we want to shrink some things even though 630 * we are using ACPI_DEBUG_OUTPUT to get the debug output 631 */ 632#if ACPI_MACHINE_WIDTH == 16 633#undef ACPI_DEBUG_ONLY_MEMBERS 634#undef _VERBOSE_STRUCTURES 635#define ACPI_DEBUG_ONLY_MEMBERS(a) 636#endif 637 638 639#ifdef ACPI_DEBUG_OUTPUT 640/* 641 * 1) Set name to blanks 642 * 2) Copy the object name 643 */ 644#define ACPI_ADD_OBJECT_NAME(a,b) ACPI_MEMSET (a->Common.Name, ' ', sizeof (a->Common.Name));\ 645 ACPI_STRNCPY (a->Common.Name, AcpiGbl_NsTypeNames[b], sizeof (a->Common.Name)) 646#else 647 648#define ACPI_ADD_OBJECT_NAME(a,b) 649#endif 650 651 652/* 653 * Memory allocation tracking (DEBUG ONLY) 654 */ 655 656#ifndef ACPI_DBG_TRACK_ALLOCATIONS 657 658/* Memory allocation */ 659 660#define ACPI_MEM_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE)(a),_COMPONENT,_THIS_MODULE,__LINE__) 661#define ACPI_MEM_CALLOCATE(a) AcpiUtCallocate((ACPI_SIZE)(a), _COMPONENT,_THIS_MODULE,__LINE__) 662#define ACPI_MEM_FREE(a) AcpiOsFree(a) 663#define ACPI_MEM_TRACKING(a) 664 665 666#else 667 668/* Memory allocation */ 669 670#define ACPI_MEM_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE)(a),_COMPONENT,_THIS_MODULE,__LINE__) 671#define ACPI_MEM_CALLOCATE(a) AcpiUtCallocateAndTrack((ACPI_SIZE)(a), _COMPONENT,_THIS_MODULE,__LINE__) 672#define ACPI_MEM_FREE(a) AcpiUtFreeAndTrack(a,_COMPONENT,_THIS_MODULE,__LINE__) 673#define ACPI_MEM_TRACKING(a) a 674 675#endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 676 677 678#define ACPI_GET_STACK_POINTER _asm {mov eax, ebx} 679 680#endif /* ACMACROS_H */ 681