17c478bd9Sstevel@tonic-gate /****************************************************************************** 27c478bd9Sstevel@tonic-gate * 37c478bd9Sstevel@tonic-gate * Name: acmacros.h - C macros for the entire subsystem. 4*db2bae30SDana Myers * $Revision: 1.199 $ 57c478bd9Sstevel@tonic-gate * 67c478bd9Sstevel@tonic-gate *****************************************************************************/ 77c478bd9Sstevel@tonic-gate 87c478bd9Sstevel@tonic-gate /****************************************************************************** 97c478bd9Sstevel@tonic-gate * 107c478bd9Sstevel@tonic-gate * 1. Copyright Notice 117c478bd9Sstevel@tonic-gate * 12*db2bae30SDana Myers * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp. 137c478bd9Sstevel@tonic-gate * All rights reserved. 147c478bd9Sstevel@tonic-gate * 157c478bd9Sstevel@tonic-gate * 2. License 167c478bd9Sstevel@tonic-gate * 177c478bd9Sstevel@tonic-gate * 2.1. This is your license from Intel Corp. under its intellectual property 187c478bd9Sstevel@tonic-gate * rights. You may have additional license terms from the party that provided 197c478bd9Sstevel@tonic-gate * you this software, covering your right to use that party's intellectual 207c478bd9Sstevel@tonic-gate * property rights. 217c478bd9Sstevel@tonic-gate * 227c478bd9Sstevel@tonic-gate * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 237c478bd9Sstevel@tonic-gate * copy of the source code appearing in this file ("Covered Code") an 247c478bd9Sstevel@tonic-gate * irrevocable, perpetual, worldwide license under Intel's copyrights in the 257c478bd9Sstevel@tonic-gate * base code distributed originally by Intel ("Original Intel Code") to copy, 267c478bd9Sstevel@tonic-gate * make derivatives, distribute, use and display any portion of the Covered 277c478bd9Sstevel@tonic-gate * Code in any form, with the right to sublicense such rights; and 287c478bd9Sstevel@tonic-gate * 297c478bd9Sstevel@tonic-gate * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 307c478bd9Sstevel@tonic-gate * license (with the right to sublicense), under only those claims of Intel 317c478bd9Sstevel@tonic-gate * patents that are infringed by the Original Intel Code, to make, use, sell, 327c478bd9Sstevel@tonic-gate * offer to sell, and import the Covered Code and derivative works thereof 337c478bd9Sstevel@tonic-gate * solely to the minimum extent necessary to exercise the above copyright 347c478bd9Sstevel@tonic-gate * license, and in no event shall the patent license extend to any additions 357c478bd9Sstevel@tonic-gate * to or modifications of the Original Intel Code. No other license or right 367c478bd9Sstevel@tonic-gate * is granted directly or by implication, estoppel or otherwise; 377c478bd9Sstevel@tonic-gate * 387c478bd9Sstevel@tonic-gate * The above copyright and patent license is granted only if the following 397c478bd9Sstevel@tonic-gate * conditions are met: 407c478bd9Sstevel@tonic-gate * 417c478bd9Sstevel@tonic-gate * 3. Conditions 427c478bd9Sstevel@tonic-gate * 437c478bd9Sstevel@tonic-gate * 3.1. Redistribution of Source with Rights to Further Distribute Source. 447c478bd9Sstevel@tonic-gate * Redistribution of source code of any substantial portion of the Covered 457c478bd9Sstevel@tonic-gate * Code or modification with rights to further distribute source must include 467c478bd9Sstevel@tonic-gate * the above Copyright Notice, the above License, this list of Conditions, 477c478bd9Sstevel@tonic-gate * and the following Disclaimer and Export Compliance provision. In addition, 487c478bd9Sstevel@tonic-gate * Licensee must cause all Covered Code to which Licensee contributes to 497c478bd9Sstevel@tonic-gate * contain a file documenting the changes Licensee made to create that Covered 507c478bd9Sstevel@tonic-gate * Code and the date of any change. Licensee must include in that file the 517c478bd9Sstevel@tonic-gate * documentation of any changes made by any predecessor Licensee. Licensee 527c478bd9Sstevel@tonic-gate * must include a prominent statement that the modification is derived, 537c478bd9Sstevel@tonic-gate * directly or indirectly, from Original Intel Code. 547c478bd9Sstevel@tonic-gate * 557c478bd9Sstevel@tonic-gate * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 567c478bd9Sstevel@tonic-gate * Redistribution of source code of any substantial portion of the Covered 577c478bd9Sstevel@tonic-gate * Code or modification without rights to further distribute source must 587c478bd9Sstevel@tonic-gate * include the following Disclaimer and Export Compliance provision in the 597c478bd9Sstevel@tonic-gate * documentation and/or other materials provided with distribution. In 607c478bd9Sstevel@tonic-gate * addition, Licensee may not authorize further sublicense of source of any 617c478bd9Sstevel@tonic-gate * portion of the Covered Code, and must include terms to the effect that the 627c478bd9Sstevel@tonic-gate * license from Licensee to its licensee is limited to the intellectual 637c478bd9Sstevel@tonic-gate * property embodied in the software Licensee provides to its licensee, and 647c478bd9Sstevel@tonic-gate * not to intellectual property embodied in modifications its licensee may 657c478bd9Sstevel@tonic-gate * make. 667c478bd9Sstevel@tonic-gate * 677c478bd9Sstevel@tonic-gate * 3.3. Redistribution of Executable. Redistribution in executable form of any 687c478bd9Sstevel@tonic-gate * substantial portion of the Covered Code or modification must reproduce the 697c478bd9Sstevel@tonic-gate * above Copyright Notice, and the following Disclaimer and Export Compliance 707c478bd9Sstevel@tonic-gate * provision in the documentation and/or other materials provided with the 717c478bd9Sstevel@tonic-gate * distribution. 727c478bd9Sstevel@tonic-gate * 737c478bd9Sstevel@tonic-gate * 3.4. Intel retains all right, title, and interest in and to the Original 747c478bd9Sstevel@tonic-gate * Intel Code. 757c478bd9Sstevel@tonic-gate * 767c478bd9Sstevel@tonic-gate * 3.5. Neither the name Intel nor any other trademark owned or controlled by 777c478bd9Sstevel@tonic-gate * Intel shall be used in advertising or otherwise to promote the sale, use or 787c478bd9Sstevel@tonic-gate * other dealings in products derived from or relating to the Covered Code 797c478bd9Sstevel@tonic-gate * without prior written authorization from Intel. 807c478bd9Sstevel@tonic-gate * 817c478bd9Sstevel@tonic-gate * 4. Disclaimer and Export Compliance 827c478bd9Sstevel@tonic-gate * 837c478bd9Sstevel@tonic-gate * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 847c478bd9Sstevel@tonic-gate * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 857c478bd9Sstevel@tonic-gate * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 867c478bd9Sstevel@tonic-gate * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 877c478bd9Sstevel@tonic-gate * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 887c478bd9Sstevel@tonic-gate * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 897c478bd9Sstevel@tonic-gate * PARTICULAR PURPOSE. 907c478bd9Sstevel@tonic-gate * 917c478bd9Sstevel@tonic-gate * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 927c478bd9Sstevel@tonic-gate * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 937c478bd9Sstevel@tonic-gate * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 947c478bd9Sstevel@tonic-gate * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 957c478bd9Sstevel@tonic-gate * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 967c478bd9Sstevel@tonic-gate * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 977c478bd9Sstevel@tonic-gate * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 987c478bd9Sstevel@tonic-gate * LIMITED REMEDY. 997c478bd9Sstevel@tonic-gate * 1007c478bd9Sstevel@tonic-gate * 4.3. Licensee shall not export, either directly or indirectly, any of this 1017c478bd9Sstevel@tonic-gate * software or system incorporating such software without first obtaining any 1027c478bd9Sstevel@tonic-gate * required license or other approval from the U. S. Department of Commerce or 1037c478bd9Sstevel@tonic-gate * any other agency or department of the United States Government. In the 1047c478bd9Sstevel@tonic-gate * event Licensee exports any such software from the United States or 1057c478bd9Sstevel@tonic-gate * re-exports any such software from a foreign destination, Licensee shall 1067c478bd9Sstevel@tonic-gate * ensure that the distribution and export/re-export of the software is in 1077c478bd9Sstevel@tonic-gate * compliance with all laws, regulations, orders, or other restrictions of the 1087c478bd9Sstevel@tonic-gate * U.S. Export Administration Regulations. Licensee agrees that neither it nor 1097c478bd9Sstevel@tonic-gate * any of its subsidiaries will export/re-export any technical data, process, 1107c478bd9Sstevel@tonic-gate * software, or service, directly or indirectly, to any country for which the 1117c478bd9Sstevel@tonic-gate * United States government or any agency thereof requires an export license, 1127c478bd9Sstevel@tonic-gate * other governmental approval, or letter of assurance, without first obtaining 1137c478bd9Sstevel@tonic-gate * such license, approval or letter. 1147c478bd9Sstevel@tonic-gate * 1157c478bd9Sstevel@tonic-gate *****************************************************************************/ 1167c478bd9Sstevel@tonic-gate 1177c478bd9Sstevel@tonic-gate #ifndef __ACMACROS_H__ 1187c478bd9Sstevel@tonic-gate #define __ACMACROS_H__ 1197c478bd9Sstevel@tonic-gate 1207c478bd9Sstevel@tonic-gate 1217c478bd9Sstevel@tonic-gate /* 1227c478bd9Sstevel@tonic-gate * Data manipulation macros 1237c478bd9Sstevel@tonic-gate */ 1247c478bd9Sstevel@tonic-gate #define ACPI_LOWORD(l) ((UINT16)(UINT32)(l)) 1257c478bd9Sstevel@tonic-gate #define ACPI_HIWORD(l) ((UINT16)((((UINT32)(l)) >> 16) & 0xFFFF)) 1267c478bd9Sstevel@tonic-gate #define ACPI_LOBYTE(l) ((UINT8)(UINT16)(l)) 1277c478bd9Sstevel@tonic-gate #define ACPI_HIBYTE(l) ((UINT8)((((UINT16)(l)) >> 8) & 0xFF)) 1287c478bd9Sstevel@tonic-gate 1297c478bd9Sstevel@tonic-gate #define ACPI_SET_BIT(target,bit) ((target) |= (bit)) 1307c478bd9Sstevel@tonic-gate #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit)) 1317c478bd9Sstevel@tonic-gate #define ACPI_MIN(a,b) (((a)<(b))?(a):(b)) 132*db2bae30SDana Myers #define ACPI_MAX(a,b) (((a)>(b))?(a):(b)) 1337c478bd9Sstevel@tonic-gate 13427f7c583Smyers /* Size calculation */ 13527f7c583Smyers 13627f7c583Smyers #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0])) 13727f7c583Smyers 1387c478bd9Sstevel@tonic-gate 1397c478bd9Sstevel@tonic-gate /* 140*db2bae30SDana Myers * Extract data using a pointer. Any more than a byte and we 14130082d0cSmyers * get into potential aligment issues -- see the STORE macros below. 14230082d0cSmyers * Use with care. 1437c478bd9Sstevel@tonic-gate */ 14430082d0cSmyers #define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 14530082d0cSmyers #define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 14630082d0cSmyers #define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 14730082d0cSmyers #define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 14830082d0cSmyers #define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 14930082d0cSmyers #define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 15030082d0cSmyers #define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 15130082d0cSmyers #define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 1527c478bd9Sstevel@tonic-gate 15330082d0cSmyers /* 15430082d0cSmyers * Pointer manipulation 15530082d0cSmyers */ 15630082d0cSmyers #define ACPI_CAST_PTR(t, p) ((t *) (ACPI_UINTPTR_T) (p)) 15730082d0cSmyers #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (ACPI_UINTPTR_T) (p)) 158*db2bae30SDana Myers #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b))) 159*db2bae30SDana Myers #define ACPI_PTR_DIFF(a, b) (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b))) 1607c478bd9Sstevel@tonic-gate 1617c478bd9Sstevel@tonic-gate /* Pointer/Integer type conversions */ 1627c478bd9Sstevel@tonic-gate 163*db2bae30SDana Myers #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i) 164*db2bae30SDana Myers #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL) 165*db2bae30SDana Myers #define ACPI_OFFSET(d, f) (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL) 1667c478bd9Sstevel@tonic-gate #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i) 1677c478bd9Sstevel@tonic-gate #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i) 1687c478bd9Sstevel@tonic-gate 16927f7c583Smyers #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 170*db2bae30SDana Myers #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b))) 17127f7c583Smyers #else 172*db2bae30SDana Myers #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE)) 17327f7c583Smyers #endif 17427f7c583Smyers 175*db2bae30SDana Myers /* 176*db2bae30SDana Myers * Full 64-bit integer must be available on both 32-bit and 64-bit platforms 177*db2bae30SDana Myers */ 178*db2bae30SDana Myers typedef struct acpi_integer_overlay 179*db2bae30SDana Myers { 180*db2bae30SDana Myers UINT32 LoDword; 181*db2bae30SDana Myers UINT32 HiDword; 182*db2bae30SDana Myers 183*db2bae30SDana Myers } ACPI_INTEGER_OVERLAY; 184*db2bae30SDana Myers 185*db2bae30SDana Myers #define ACPI_LODWORD(Integer) (ACPI_CAST_PTR (ACPI_INTEGER_OVERLAY, &Integer)->LoDword) 186*db2bae30SDana Myers #define ACPI_HIDWORD(Integer) (ACPI_CAST_PTR (ACPI_INTEGER_OVERLAY, &Integer)->HiDword) 187*db2bae30SDana Myers 188*db2bae30SDana Myers /* 189*db2bae30SDana Myers * printf() format helpers 190*db2bae30SDana Myers */ 191*db2bae30SDana Myers 192*db2bae30SDana Myers /* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */ 193*db2bae30SDana Myers 194*db2bae30SDana Myers #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 195*db2bae30SDana Myers 196*db2bae30SDana Myers #if ACPI_MACHINE_WIDTH == 64 197*db2bae30SDana Myers #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 198*db2bae30SDana Myers #else 199*db2bae30SDana Myers #define ACPI_FORMAT_NATIVE_UINT(i) 0, (i) 200*db2bae30SDana Myers #endif 201*db2bae30SDana Myers 202*db2bae30SDana Myers 2037c478bd9Sstevel@tonic-gate /* 2047c478bd9Sstevel@tonic-gate * Macros for moving data around to/from buffers that are possibly unaligned. 2057c478bd9Sstevel@tonic-gate * If the hardware supports the transfer of unaligned data, just do the store. 2067c478bd9Sstevel@tonic-gate * Otherwise, we have to move one byte at a time. 2077c478bd9Sstevel@tonic-gate */ 2087c478bd9Sstevel@tonic-gate #ifdef ACPI_BIG_ENDIAN 2097c478bd9Sstevel@tonic-gate /* 2107c478bd9Sstevel@tonic-gate * Macros for big-endian machines 2117c478bd9Sstevel@tonic-gate */ 2127c478bd9Sstevel@tonic-gate 2137c478bd9Sstevel@tonic-gate /* These macros reverse the bytes during the move, converting little-endian to big endian */ 2147c478bd9Sstevel@tonic-gate 2157c478bd9Sstevel@tonic-gate /* Big Endian <== Little Endian */ 2167c478bd9Sstevel@tonic-gate /* Hi...Lo Lo...Hi */ 2177c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */ 2187c478bd9Sstevel@tonic-gate 219*db2bae30SDana Myers #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 2207c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 2217c478bd9Sstevel@tonic-gate 222*db2bae30SDana Myers #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 2237c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 2247c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 2257c478bd9Sstevel@tonic-gate 226*db2bae30SDana Myers #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 2277c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 2287c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 2297c478bd9Sstevel@tonic-gate 2307c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */ 2317c478bd9Sstevel@tonic-gate 232*db2bae30SDana Myers #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 2337c478bd9Sstevel@tonic-gate 234*db2bae30SDana Myers #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 2357c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 2367c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 2377c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 2387c478bd9Sstevel@tonic-gate 239*db2bae30SDana Myers #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 2407c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 2417c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 2427c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 2437c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 2447c478bd9Sstevel@tonic-gate 2457c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */ 2467c478bd9Sstevel@tonic-gate 247*db2bae30SDana Myers #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 2487c478bd9Sstevel@tonic-gate 249*db2bae30SDana Myers #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 2507c478bd9Sstevel@tonic-gate 251*db2bae30SDana Myers #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 2527c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 2537c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 2547c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 2557c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 2567c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 2577c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 2587c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 2597c478bd9Sstevel@tonic-gate #else 2607c478bd9Sstevel@tonic-gate /* 2617c478bd9Sstevel@tonic-gate * Macros for little-endian machines 2627c478bd9Sstevel@tonic-gate */ 2637c478bd9Sstevel@tonic-gate 26430082d0cSmyers #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 2657c478bd9Sstevel@tonic-gate 2667c478bd9Sstevel@tonic-gate /* The hardware supports unaligned transfers, just do the little-endian move */ 2677c478bd9Sstevel@tonic-gate 2687c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */ 2697c478bd9Sstevel@tonic-gate 270*db2bae30SDana Myers #define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 271*db2bae30SDana Myers #define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 272*db2bae30SDana Myers #define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 2737c478bd9Sstevel@tonic-gate 2747c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */ 2757c478bd9Sstevel@tonic-gate 276*db2bae30SDana Myers #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 277*db2bae30SDana Myers #define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 278*db2bae30SDana Myers #define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 2797c478bd9Sstevel@tonic-gate 2807c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */ 2817c478bd9Sstevel@tonic-gate 282*db2bae30SDana Myers #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 283*db2bae30SDana Myers #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 284*db2bae30SDana Myers #define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 2857c478bd9Sstevel@tonic-gate 2867c478bd9Sstevel@tonic-gate #else 2877c478bd9Sstevel@tonic-gate /* 288*db2bae30SDana Myers * The hardware does not support unaligned transfers. We must move the 289*db2bae30SDana Myers * data one byte at a time. These macros work whether the source or 2907c478bd9Sstevel@tonic-gate * the destination (or both) is/are unaligned. (Little-endian move) 2917c478bd9Sstevel@tonic-gate */ 2927c478bd9Sstevel@tonic-gate 2937c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */ 2947c478bd9Sstevel@tonic-gate 295*db2bae30SDana Myers #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 2967c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 2977c478bd9Sstevel@tonic-gate 298*db2bae30SDana Myers #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 299*db2bae30SDana Myers #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 3007c478bd9Sstevel@tonic-gate 3017c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */ 3027c478bd9Sstevel@tonic-gate 303*db2bae30SDana Myers #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 3047c478bd9Sstevel@tonic-gate 305*db2bae30SDana Myers #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 3067c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 3077c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 3087c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 3097c478bd9Sstevel@tonic-gate 310*db2bae30SDana Myers #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 3117c478bd9Sstevel@tonic-gate 3127c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */ 3137c478bd9Sstevel@tonic-gate 314*db2bae30SDana Myers #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 315*db2bae30SDana Myers #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 316*db2bae30SDana Myers #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 3177c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 3187c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 3197c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 3207c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 3217c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 3227c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 3237c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 3247c478bd9Sstevel@tonic-gate #endif 3257c478bd9Sstevel@tonic-gate #endif 3267c478bd9Sstevel@tonic-gate 3277c478bd9Sstevel@tonic-gate 3287c478bd9Sstevel@tonic-gate /* 3297c478bd9Sstevel@tonic-gate * Fast power-of-two math macros for non-optimized compilers 3307c478bd9Sstevel@tonic-gate */ 331*db2bae30SDana Myers #define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 332*db2bae30SDana Myers #define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 333*db2bae30SDana Myers #define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 3347c478bd9Sstevel@tonic-gate 335*db2bae30SDana Myers #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 336*db2bae30SDana Myers #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 337*db2bae30SDana Myers #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 3387c478bd9Sstevel@tonic-gate 339*db2bae30SDana Myers #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 340*db2bae30SDana Myers #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 341*db2bae30SDana Myers #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 3427c478bd9Sstevel@tonic-gate 343*db2bae30SDana Myers #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 344*db2bae30SDana Myers #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 345*db2bae30SDana Myers #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 3467c478bd9Sstevel@tonic-gate 347*db2bae30SDana Myers #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 348*db2bae30SDana Myers #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 349*db2bae30SDana Myers #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 3507c478bd9Sstevel@tonic-gate 351*db2bae30SDana Myers #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 352*db2bae30SDana Myers #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 353*db2bae30SDana Myers #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 3547c478bd9Sstevel@tonic-gate 3557c478bd9Sstevel@tonic-gate /* 3567c478bd9Sstevel@tonic-gate * Rounding macros (Power of two boundaries only) 3577c478bd9Sstevel@tonic-gate */ 358*db2bae30SDana Myers #define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 359*db2bae30SDana Myers (~(((ACPI_SIZE) boundary)-1))) 3607c478bd9Sstevel@tonic-gate 361*db2bae30SDana Myers #define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 362*db2bae30SDana Myers (((ACPI_SIZE) boundary)-1)) & \ 363*db2bae30SDana Myers (~(((ACPI_SIZE) boundary)-1))) 3647c478bd9Sstevel@tonic-gate 365*db2bae30SDana Myers /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 3667c478bd9Sstevel@tonic-gate 367*db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 368*db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 369*db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 3707c478bd9Sstevel@tonic-gate 371*db2bae30SDana Myers #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 372*db2bae30SDana Myers #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 373*db2bae30SDana Myers #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 3747c478bd9Sstevel@tonic-gate 37530082d0cSmyers #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 37630082d0cSmyers #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 37730082d0cSmyers 37830082d0cSmyers #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 3797c478bd9Sstevel@tonic-gate 3807c478bd9Sstevel@tonic-gate /* Generic (non-power-of-two) rounding */ 3817c478bd9Sstevel@tonic-gate 382*db2bae30SDana Myers #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 38330082d0cSmyers 384*db2bae30SDana Myers #define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 3857c478bd9Sstevel@tonic-gate 3867c478bd9Sstevel@tonic-gate /* 3877c478bd9Sstevel@tonic-gate * Bitmask creation 3887c478bd9Sstevel@tonic-gate * Bit positions start at zero. 3897c478bd9Sstevel@tonic-gate * MASK_BITS_ABOVE creates a mask starting AT the position and above 3907c478bd9Sstevel@tonic-gate * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 3917c478bd9Sstevel@tonic-gate */ 39230082d0cSmyers #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((UINT32) (position)))) 39330082d0cSmyers #define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((UINT32) (position))) 3947c478bd9Sstevel@tonic-gate 3957c478bd9Sstevel@tonic-gate /* Bitfields within ACPI registers */ 3967c478bd9Sstevel@tonic-gate 3977c478bd9Sstevel@tonic-gate #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 3987c478bd9Sstevel@tonic-gate #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 3997c478bd9Sstevel@tonic-gate 40027f7c583Smyers #define ACPI_INSERT_BITS(Target, Mask, Source) Target = ((Target & (~(Mask))) | (Source & Mask)) 40127f7c583Smyers 4027c478bd9Sstevel@tonic-gate /* 403*db2bae30SDana Myers * An ACPI_NAMESPACE_NODE can appear in some contexts 404*db2bae30SDana Myers * where a pointer to an ACPI_OPERAND_OBJECT can also 405*db2bae30SDana Myers * appear. This macro is used to distinguish them. 4067c478bd9Sstevel@tonic-gate * 4077c478bd9Sstevel@tonic-gate * The "Descriptor" field is the first field in both structures. 4087c478bd9Sstevel@tonic-gate */ 40927f7c583Smyers #define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 410*db2bae30SDana Myers #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t) 4117c478bd9Sstevel@tonic-gate 4127c478bd9Sstevel@tonic-gate /* Macro to test the object type */ 4137c478bd9Sstevel@tonic-gate 4147c478bd9Sstevel@tonic-gate #define ACPI_GET_OBJECT_TYPE(d) (((ACPI_OPERAND_OBJECT *)(void *)(d))->Common.Type) 4157c478bd9Sstevel@tonic-gate 4167c478bd9Sstevel@tonic-gate /* 4177c478bd9Sstevel@tonic-gate * Macros for the master AML opcode table 4187c478bd9Sstevel@tonic-gate */ 419*db2bae30SDana Myers #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 420*db2bae30SDana Myers #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 421*db2bae30SDana Myers {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 4227c478bd9Sstevel@tonic-gate #else 423*db2bae30SDana Myers #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 424*db2bae30SDana Myers {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 4257c478bd9Sstevel@tonic-gate #endif 4267c478bd9Sstevel@tonic-gate 4277c478bd9Sstevel@tonic-gate #ifdef ACPI_DISASSEMBLER 4287c478bd9Sstevel@tonic-gate #define ACPI_DISASM_ONLY_MEMBERS(a) a; 4297c478bd9Sstevel@tonic-gate #else 4307c478bd9Sstevel@tonic-gate #define ACPI_DISASM_ONLY_MEMBERS(a) 4317c478bd9Sstevel@tonic-gate #endif 4327c478bd9Sstevel@tonic-gate 4337c478bd9Sstevel@tonic-gate #define ARG_TYPE_WIDTH 5 4347c478bd9Sstevel@tonic-gate #define ARG_1(x) ((UINT32)(x)) 4357c478bd9Sstevel@tonic-gate #define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 4367c478bd9Sstevel@tonic-gate #define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 4377c478bd9Sstevel@tonic-gate #define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 4387c478bd9Sstevel@tonic-gate #define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 4397c478bd9Sstevel@tonic-gate #define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 4407c478bd9Sstevel@tonic-gate 4417c478bd9Sstevel@tonic-gate #define ARGI_LIST1(a) (ARG_1(a)) 442*db2bae30SDana Myers #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 443*db2bae30SDana Myers #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 444*db2bae30SDana Myers #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 445*db2bae30SDana Myers #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 446*db2bae30SDana Myers #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)) 4477c478bd9Sstevel@tonic-gate 4487c478bd9Sstevel@tonic-gate #define ARGP_LIST1(a) (ARG_1(a)) 449*db2bae30SDana Myers #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 450*db2bae30SDana Myers #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 451*db2bae30SDana Myers #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 452*db2bae30SDana Myers #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 453*db2bae30SDana Myers #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)) 4547c478bd9Sstevel@tonic-gate 4557c478bd9Sstevel@tonic-gate #define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 4567c478bd9Sstevel@tonic-gate #define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 4577c478bd9Sstevel@tonic-gate 4587c478bd9Sstevel@tonic-gate 45930082d0cSmyers #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES) 4607c478bd9Sstevel@tonic-gate /* 46130082d0cSmyers * Module name is include in both debug and non-debug versions primarily for 46230082d0cSmyers * error messages. The __FILE__ macro is not very useful for this, because it 46330082d0cSmyers * often includes the entire pathname to the module 4647c478bd9Sstevel@tonic-gate */ 465*db2bae30SDana Myers #define ACPI_MODULE_NAME(Name) static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name; 46630082d0cSmyers #else 46730082d0cSmyers #define ACPI_MODULE_NAME(Name) 46830082d0cSmyers #endif 4697c478bd9Sstevel@tonic-gate 4707c478bd9Sstevel@tonic-gate /* 47130082d0cSmyers * Ascii error messages can be configured out 4727c478bd9Sstevel@tonic-gate */ 47330082d0cSmyers #ifndef ACPI_NO_ERROR_MESSAGES 47430082d0cSmyers #define AE_INFO _AcpiModuleName, __LINE__ 4757c478bd9Sstevel@tonic-gate 47630082d0cSmyers /* 47730082d0cSmyers * Error reporting. Callers module and line number are inserted by AE_INFO, 47830082d0cSmyers * the plist contains a set of parens to allow variable-length lists. 47930082d0cSmyers * These macros are used for both the debug and non-debug versions of the code. 48030082d0cSmyers */ 48130082d0cSmyers #define ACPI_INFO(plist) AcpiUtInfo plist 48230082d0cSmyers #define ACPI_WARNING(plist) AcpiUtWarning plist 48330082d0cSmyers #define ACPI_EXCEPTION(plist) AcpiUtException plist 48430082d0cSmyers #define ACPI_ERROR(plist) AcpiUtError plist 485*db2bae30SDana Myers #define ACPI_ERROR_NAMESPACE(s, e) AcpiNsReportError (AE_INFO, s, e); 486*db2bae30SDana Myers #define ACPI_ERROR_METHOD(s, n, p, e) AcpiNsReportMethodError (AE_INFO, s, n, p, e); 48730082d0cSmyers 4887c478bd9Sstevel@tonic-gate #else 4897c478bd9Sstevel@tonic-gate 49030082d0cSmyers /* No error messages */ 4917c478bd9Sstevel@tonic-gate 49230082d0cSmyers #define ACPI_INFO(plist) 49330082d0cSmyers #define ACPI_WARNING(plist) 49430082d0cSmyers #define ACPI_EXCEPTION(plist) 49530082d0cSmyers #define ACPI_ERROR(plist) 496*db2bae30SDana Myers #define ACPI_ERROR_NAMESPACE(s, e) 497*db2bae30SDana Myers #define ACPI_ERROR_METHOD(s, n, p, e) 4987c478bd9Sstevel@tonic-gate #endif 4997c478bd9Sstevel@tonic-gate 5007c478bd9Sstevel@tonic-gate /* 5017c478bd9Sstevel@tonic-gate * Debug macros that are conditionally compiled 5027c478bd9Sstevel@tonic-gate */ 5037c478bd9Sstevel@tonic-gate #ifdef ACPI_DEBUG_OUTPUT 5047c478bd9Sstevel@tonic-gate 505450d6964Smyers /* 506450d6964Smyers * Common parameters used for debug output functions: 507450d6964Smyers * line number, function name, module(file) name, component ID 508450d6964Smyers */ 509450d6964Smyers #define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT 5107c478bd9Sstevel@tonic-gate 5117c478bd9Sstevel@tonic-gate /* 512450d6964Smyers * Function entry tracing 5137c478bd9Sstevel@tonic-gate */ 514450d6964Smyers 515450d6964Smyers /* 516450d6964Smyers * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header, 517450d6964Smyers * define it now. This is the case where there the compiler does not support 518*db2bae30SDana Myers * a __FUNCTION__ macro or equivalent. 519450d6964Smyers */ 520450d6964Smyers #ifndef ACPI_GET_FUNCTION_NAME 521450d6964Smyers #define ACPI_GET_FUNCTION_NAME _AcpiFunctionName 522450d6964Smyers /* 523450d6964Smyers * The Name parameter should be the procedure name as a quoted string. 524*db2bae30SDana Myers * The function name is also used by the function exit macros below. 525186507a7Smyers * Note: (const char) is used to be compatible with the debug interfaces 526186507a7Smyers * and macros such as __FUNCTION__. 527450d6964Smyers */ 528*db2bae30SDana Myers #define ACPI_FUNCTION_NAME(Name) static const char _AcpiFunctionName[] = #Name; 529450d6964Smyers 530450d6964Smyers #else 531450d6964Smyers /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */ 532450d6964Smyers 533450d6964Smyers #define ACPI_FUNCTION_NAME(Name) 534450d6964Smyers #endif 535450d6964Smyers 536450d6964Smyers #define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 537450d6964Smyers AcpiUtTrace(ACPI_DEBUG_PARAMETERS) 538*db2bae30SDana Myers #define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \ 539*db2bae30SDana Myers AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b) 540*db2bae30SDana Myers #define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \ 541*db2bae30SDana Myers AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b) 542*db2bae30SDana Myers #define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \ 543*db2bae30SDana Myers AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b) 544450d6964Smyers 545450d6964Smyers #define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 5467c478bd9Sstevel@tonic-gate 5477c478bd9Sstevel@tonic-gate /* 5487c478bd9Sstevel@tonic-gate * Function exit tracing. 549*db2bae30SDana Myers * WARNING: These macros include a return statement. This is usually considered 5507c478bd9Sstevel@tonic-gate * bad form, but having a separate exit macro is very ugly and difficult to maintain. 5517c478bd9Sstevel@tonic-gate * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 552450d6964Smyers * so that "_AcpiFunctionName" is defined. 553186507a7Smyers * 554186507a7Smyers * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining 555186507a7Smyers * about these constructs. 5567c478bd9Sstevel@tonic-gate */ 5577c478bd9Sstevel@tonic-gate #ifdef ACPI_USE_DO_WHILE_0 5587c478bd9Sstevel@tonic-gate #define ACPI_DO_WHILE0(a) do a while(0) 5597c478bd9Sstevel@tonic-gate #else 5607c478bd9Sstevel@tonic-gate #define ACPI_DO_WHILE0(a) a 5617c478bd9Sstevel@tonic-gate #endif 5627c478bd9Sstevel@tonic-gate 563186507a7Smyers #define return_VOID ACPI_DO_WHILE0 ({ \ 564186507a7Smyers AcpiUtExit (ACPI_DEBUG_PARAMETERS); \ 565186507a7Smyers return;}) 566186507a7Smyers /* 567186507a7Smyers * There are two versions of most of the return macros. The default version is 568186507a7Smyers * safer, since it avoids side-effects by guaranteeing that the argument will 569186507a7Smyers * not be evaluated twice. 57030082d0cSmyers * 571186507a7Smyers * A less-safe version of the macros is provided for optional use if the 572186507a7Smyers * compiler uses excessive CPU stack (for example, this may happen in the 573186507a7Smyers * debug case if code optimzation is disabled.) 574186507a7Smyers */ 575186507a7Smyers #ifndef ACPI_SIMPLE_RETURN_MACROS 576186507a7Smyers 577186507a7Smyers #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 578186507a7Smyers register ACPI_STATUS _s = (s); \ 579186507a7Smyers AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \ 580186507a7Smyers return (_s); }) 581186507a7Smyers #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 582186507a7Smyers register void *_s = (void *) (s); \ 583186507a7Smyers AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \ 584186507a7Smyers return (_s); }) 585186507a7Smyers #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 586186507a7Smyers register ACPI_INTEGER _s = (s); \ 587186507a7Smyers AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \ 588186507a7Smyers return (_s); }) 589186507a7Smyers #define return_UINT8(s) ACPI_DO_WHILE0 ({ \ 590186507a7Smyers register UINT8 _s = (UINT8) (s); \ 59130082d0cSmyers AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) _s); \ 592186507a7Smyers return (_s); }) 593186507a7Smyers #define return_UINT32(s) ACPI_DO_WHILE0 ({ \ 594186507a7Smyers register UINT32 _s = (UINT32) (s); \ 59530082d0cSmyers AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) _s); \ 596186507a7Smyers return (_s); }) 597186507a7Smyers #else /* Use original less-safe macros */ 598186507a7Smyers 599186507a7Smyers #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 600186507a7Smyers AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \ 601186507a7Smyers return((s)); }) 602186507a7Smyers #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 603186507a7Smyers AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \ 604186507a7Smyers return((s)); }) 605186507a7Smyers #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 606186507a7Smyers AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) (s)); \ 607186507a7Smyers return((s)); }) 608186507a7Smyers #define return_UINT8(s) return_VALUE(s) 609186507a7Smyers #define return_UINT32(s) return_VALUE(s) 610186507a7Smyers 611186507a7Smyers #endif /* ACPI_SIMPLE_RETURN_MACROS */ 612186507a7Smyers 6137c478bd9Sstevel@tonic-gate 6147c478bd9Sstevel@tonic-gate /* Conditional execution */ 6157c478bd9Sstevel@tonic-gate 6167c478bd9Sstevel@tonic-gate #define ACPI_DEBUG_EXEC(a) a 6177c478bd9Sstevel@tonic-gate #define ACPI_DEBUG_ONLY_MEMBERS(a) a; 6187c478bd9Sstevel@tonic-gate #define _VERBOSE_STRUCTURES 6197c478bd9Sstevel@tonic-gate 6207c478bd9Sstevel@tonic-gate 621*db2bae30SDana Myers /* Various object display routines for debug */ 6227c478bd9Sstevel@tonic-gate 623*db2bae30SDana Myers #define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0) 624*db2bae30SDana Myers #define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c) 625*db2bae30SDana Myers #define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b) 626*db2bae30SDana Myers #define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d) 627*db2bae30SDana Myers #define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT) 6287c478bd9Sstevel@tonic-gate 6297c478bd9Sstevel@tonic-gate /* 6307c478bd9Sstevel@tonic-gate * Master debug print macros 6317c478bd9Sstevel@tonic-gate * Print iff: 6327c478bd9Sstevel@tonic-gate * 1) Debug print for the current component is enabled 6337c478bd9Sstevel@tonic-gate * 2) Debug error level or trace level for the print statement is enabled 6347c478bd9Sstevel@tonic-gate */ 63530082d0cSmyers #define ACPI_DEBUG_PRINT(plist) AcpiUtDebugPrint plist 63630082d0cSmyers #define ACPI_DEBUG_PRINT_RAW(plist) AcpiUtDebugPrintRaw plist 6377c478bd9Sstevel@tonic-gate 6387c478bd9Sstevel@tonic-gate 6397c478bd9Sstevel@tonic-gate #else 6407c478bd9Sstevel@tonic-gate /* 6417c478bd9Sstevel@tonic-gate * This is the non-debug case -- make everything go away, 6427c478bd9Sstevel@tonic-gate * leaving no executable debug code! 6437c478bd9Sstevel@tonic-gate */ 6447c478bd9Sstevel@tonic-gate #define ACPI_DEBUG_EXEC(a) 6457c478bd9Sstevel@tonic-gate #define ACPI_DEBUG_ONLY_MEMBERS(a) 6467c478bd9Sstevel@tonic-gate #define ACPI_FUNCTION_NAME(a) 6477c478bd9Sstevel@tonic-gate #define ACPI_FUNCTION_TRACE(a) 648*db2bae30SDana Myers #define ACPI_FUNCTION_TRACE_PTR(a, b) 649*db2bae30SDana Myers #define ACPI_FUNCTION_TRACE_U32(a, b) 650*db2bae30SDana Myers #define ACPI_FUNCTION_TRACE_STR(a, b) 6517c478bd9Sstevel@tonic-gate #define ACPI_FUNCTION_EXIT 6527c478bd9Sstevel@tonic-gate #define ACPI_FUNCTION_STATUS_EXIT(s) 6537c478bd9Sstevel@tonic-gate #define ACPI_FUNCTION_VALUE_EXIT(s) 6547c478bd9Sstevel@tonic-gate #define ACPI_FUNCTION_ENTRY() 6557c478bd9Sstevel@tonic-gate #define ACPI_DUMP_STACK_ENTRY(a) 656*db2bae30SDana Myers #define ACPI_DUMP_OPERANDS(a, b, c) 657*db2bae30SDana Myers #define ACPI_DUMP_ENTRY(a, b) 658*db2bae30SDana Myers #define ACPI_DUMP_TABLES(a, b) 659*db2bae30SDana Myers #define ACPI_DUMP_PATHNAME(a, b, c, d) 660*db2bae30SDana Myers #define ACPI_DUMP_BUFFER(a, b) 6617c478bd9Sstevel@tonic-gate #define ACPI_DEBUG_PRINT(pl) 6627c478bd9Sstevel@tonic-gate #define ACPI_DEBUG_PRINT_RAW(pl) 6637c478bd9Sstevel@tonic-gate 6647c478bd9Sstevel@tonic-gate #define return_VOID return 6657c478bd9Sstevel@tonic-gate #define return_ACPI_STATUS(s) return(s) 6667c478bd9Sstevel@tonic-gate #define return_VALUE(s) return(s) 667186507a7Smyers #define return_UINT8(s) return(s) 668186507a7Smyers #define return_UINT32(s) return(s) 6697c478bd9Sstevel@tonic-gate #define return_PTR(s) return(s) 6707c478bd9Sstevel@tonic-gate 6717c478bd9Sstevel@tonic-gate #endif 6727c478bd9Sstevel@tonic-gate 6737c478bd9Sstevel@tonic-gate /* 6747c478bd9Sstevel@tonic-gate * Some code only gets executed when the debugger is built in. 6757c478bd9Sstevel@tonic-gate * Note that this is entirely independent of whether the 6767c478bd9Sstevel@tonic-gate * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 6777c478bd9Sstevel@tonic-gate */ 6787c478bd9Sstevel@tonic-gate #ifdef ACPI_DEBUGGER 6797c478bd9Sstevel@tonic-gate #define ACPI_DEBUGGER_EXEC(a) a 6807c478bd9Sstevel@tonic-gate #else 6817c478bd9Sstevel@tonic-gate #define ACPI_DEBUGGER_EXEC(a) 6827c478bd9Sstevel@tonic-gate #endif 6837c478bd9Sstevel@tonic-gate 6847c478bd9Sstevel@tonic-gate 6857c478bd9Sstevel@tonic-gate /* 6867c478bd9Sstevel@tonic-gate * Memory allocation tracking (DEBUG ONLY) 6877c478bd9Sstevel@tonic-gate */ 688*db2bae30SDana Myers #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 689*db2bae30SDana Myers 6907c478bd9Sstevel@tonic-gate #ifndef ACPI_DBG_TRACK_ALLOCATIONS 6917c478bd9Sstevel@tonic-gate 6927c478bd9Sstevel@tonic-gate /* Memory allocation */ 6937c478bd9Sstevel@tonic-gate 694*db2bae30SDana Myers #define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 695*db2bae30SDana Myers #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 69627f7c583Smyers #define ACPI_FREE(a) AcpiOsFree(a) 6977c478bd9Sstevel@tonic-gate #define ACPI_MEM_TRACKING(a) 6987c478bd9Sstevel@tonic-gate 6997c478bd9Sstevel@tonic-gate #else 7007c478bd9Sstevel@tonic-gate 7017c478bd9Sstevel@tonic-gate /* Memory allocation */ 7027c478bd9Sstevel@tonic-gate 703*db2bae30SDana Myers #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 704*db2bae30SDana Myers #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 705*db2bae30SDana Myers #define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS) 70627f7c583Smyers #define ACPI_MEM_TRACKING(a) a 7077c478bd9Sstevel@tonic-gate 7087c478bd9Sstevel@tonic-gate #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 7097c478bd9Sstevel@tonic-gate 710*db2bae30SDana Myers 711*db2bae30SDana Myers /* 712*db2bae30SDana Myers * Macros used for ACPICA utilities only 713*db2bae30SDana Myers */ 714*db2bae30SDana Myers 715*db2bae30SDana Myers /* Generate a UUID */ 716*db2bae30SDana Myers 717*db2bae30SDana Myers #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 718*db2bae30SDana Myers (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 719*db2bae30SDana Myers (b) & 0xFF, ((b) >> 8) & 0xFF, \ 720*db2bae30SDana Myers (c) & 0xFF, ((c) >> 8) & 0xFF, \ 721*db2bae30SDana Myers (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 722*db2bae30SDana Myers 723*db2bae30SDana Myers #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 724*db2bae30SDana Myers 725*db2bae30SDana Myers 7267c478bd9Sstevel@tonic-gate #endif /* ACMACROS_H */ 727