17c478bd9Sstevel@tonic-gate /****************************************************************************** 27c478bd9Sstevel@tonic-gate * 37c478bd9Sstevel@tonic-gate * Name: acmacros.h - C macros for the entire subsystem. 47c478bd9Sstevel@tonic-gate * 57c478bd9Sstevel@tonic-gate *****************************************************************************/ 67c478bd9Sstevel@tonic-gate 7*35786f68SRobert Mustacchi /****************************************************************************** 8*35786f68SRobert Mustacchi * 9*35786f68SRobert Mustacchi * 1. Copyright Notice 10*35786f68SRobert Mustacchi * 11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp. 127c478bd9Sstevel@tonic-gate * All rights reserved. 137c478bd9Sstevel@tonic-gate * 14*35786f68SRobert Mustacchi * 2. License 15*35786f68SRobert Mustacchi * 16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property 17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided 18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual 19*35786f68SRobert Mustacchi * property rights. 20*35786f68SRobert Mustacchi * 21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an 23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy, 25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered 26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and 27*35786f68SRobert Mustacchi * 28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel 30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell, 31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof 32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright 33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions 34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right 35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise; 36*35786f68SRobert Mustacchi * 37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following 38*35786f68SRobert Mustacchi * conditions are met: 39*35786f68SRobert Mustacchi * 40*35786f68SRobert Mustacchi * 3. Conditions 41*35786f68SRobert Mustacchi * 42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered 44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include 45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions, 46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition, 47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to 48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered 49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the 50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee 51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived, 52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code. 53*35786f68SRobert Mustacchi * 54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered 56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must 57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the 58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In 59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any 60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the 61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual 62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and 63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may 64*35786f68SRobert Mustacchi * make. 65*35786f68SRobert Mustacchi * 66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any 67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the 68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance 69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the 70*35786f68SRobert Mustacchi * distribution. 71*35786f68SRobert Mustacchi * 72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original 73*35786f68SRobert Mustacchi * Intel Code. 74*35786f68SRobert Mustacchi * 75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or 77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code 78*35786f68SRobert Mustacchi * without prior written authorization from Intel. 79*35786f68SRobert Mustacchi * 80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance 81*35786f68SRobert Mustacchi * 82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE. 89*35786f68SRobert Mustacchi * 90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97*35786f68SRobert Mustacchi * LIMITED REMEDY. 98*35786f68SRobert Mustacchi * 99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this 100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any 101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or 102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the 103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or 104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall 105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in 106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the 107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process, 109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the 110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license, 111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining 112*35786f68SRobert Mustacchi * such license, approval or letter. 113*35786f68SRobert Mustacchi * 114*35786f68SRobert Mustacchi ***************************************************************************** 115*35786f68SRobert Mustacchi * 116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the 117*35786f68SRobert Mustacchi * following license: 118*35786f68SRobert Mustacchi * 11926f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without 12026f3cdf0SGordon Ross * modification, are permitted provided that the following conditions 12126f3cdf0SGordon Ross * are met: 12226f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright 12326f3cdf0SGordon Ross * notice, this list of conditions, and the following disclaimer, 12426f3cdf0SGordon Ross * without modification. 12526f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12626f3cdf0SGordon Ross * substantially similar to the "NO WARRANTY" disclaimer below 12726f3cdf0SGordon Ross * ("Disclaimer") and any redistribution must be conditioned upon 12826f3cdf0SGordon Ross * including a substantially similar Disclaimer requirement for further 12926f3cdf0SGordon Ross * binary redistribution. 13026f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names 13126f3cdf0SGordon Ross * of any contributors may be used to endorse or promote products derived 13226f3cdf0SGordon Ross * from this software without specific prior written permission. 1337c478bd9Sstevel@tonic-gate * 13426f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 13526f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 13726f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145*35786f68SRobert Mustacchi * 146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the 147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free 148*35786f68SRobert Mustacchi * Software Foundation. 149*35786f68SRobert Mustacchi * 150*35786f68SRobert Mustacchi *****************************************************************************/ 1517c478bd9Sstevel@tonic-gate 1527c478bd9Sstevel@tonic-gate #ifndef __ACMACROS_H__ 1537c478bd9Sstevel@tonic-gate #define __ACMACROS_H__ 1547c478bd9Sstevel@tonic-gate 1557c478bd9Sstevel@tonic-gate 1567c478bd9Sstevel@tonic-gate /* 157db2bae30SDana Myers * Extract data using a pointer. Any more than a byte and we 158*35786f68SRobert Mustacchi * get into potential alignment issues -- see the STORE macros below. 15930082d0cSmyers * Use with care. 1607c478bd9Sstevel@tonic-gate */ 1617b1019a6SJerry Jelinek #define ACPI_CAST8(ptr) ACPI_CAST_PTR (UINT8, (ptr)) 1627b1019a6SJerry Jelinek #define ACPI_CAST16(ptr) ACPI_CAST_PTR (UINT16, (ptr)) 1637b1019a6SJerry Jelinek #define ACPI_CAST32(ptr) ACPI_CAST_PTR (UINT32, (ptr)) 1647b1019a6SJerry Jelinek #define ACPI_CAST64(ptr) ACPI_CAST_PTR (UINT64, (ptr)) 1657b1019a6SJerry Jelinek #define ACPI_GET8(ptr) (*ACPI_CAST8 (ptr)) 1667b1019a6SJerry Jelinek #define ACPI_GET16(ptr) (*ACPI_CAST16 (ptr)) 1677b1019a6SJerry Jelinek #define ACPI_GET32(ptr) (*ACPI_CAST32 (ptr)) 1687b1019a6SJerry Jelinek #define ACPI_GET64(ptr) (*ACPI_CAST64 (ptr)) 1697b1019a6SJerry Jelinek #define ACPI_SET8(ptr, val) (*ACPI_CAST8 (ptr) = (UINT8) (val)) 1707b1019a6SJerry Jelinek #define ACPI_SET16(ptr, val) (*ACPI_CAST16 (ptr) = (UINT16) (val)) 1717b1019a6SJerry Jelinek #define ACPI_SET32(ptr, val) (*ACPI_CAST32 (ptr) = (UINT32) (val)) 1727b1019a6SJerry Jelinek #define ACPI_SET64(ptr, val) (*ACPI_CAST64 (ptr) = (UINT64) (val)) 1737c478bd9Sstevel@tonic-gate 174db2bae30SDana Myers /* 175*35786f68SRobert Mustacchi * printf() format helper. This macro is a workaround for the difficulties 1767b1019a6SJerry Jelinek * with emitting 64-bit integers and 64-bit pointers with the same code 1777b1019a6SJerry Jelinek * for both 32-bit and 64-bit hosts. 178db2bae30SDana Myers */ 179db2bae30SDana Myers #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 180db2bae30SDana Myers 181db2bae30SDana Myers 1827c478bd9Sstevel@tonic-gate /* 1837c478bd9Sstevel@tonic-gate * Macros for moving data around to/from buffers that are possibly unaligned. 1847c478bd9Sstevel@tonic-gate * If the hardware supports the transfer of unaligned data, just do the store. 1857c478bd9Sstevel@tonic-gate * Otherwise, we have to move one byte at a time. 1867c478bd9Sstevel@tonic-gate */ 1877c478bd9Sstevel@tonic-gate #ifdef ACPI_BIG_ENDIAN 1887c478bd9Sstevel@tonic-gate /* 1897c478bd9Sstevel@tonic-gate * Macros for big-endian machines 1907c478bd9Sstevel@tonic-gate */ 1917c478bd9Sstevel@tonic-gate 1927c478bd9Sstevel@tonic-gate /* These macros reverse the bytes during the move, converting little-endian to big endian */ 1937c478bd9Sstevel@tonic-gate 1947c478bd9Sstevel@tonic-gate /* Big Endian <== Little Endian */ 1957c478bd9Sstevel@tonic-gate /* Hi...Lo Lo...Hi */ 1967c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */ 1977c478bd9Sstevel@tonic-gate 198db2bae30SDana Myers #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 1997c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 2007c478bd9Sstevel@tonic-gate 201db2bae30SDana Myers #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 2027c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 2037c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 2047c478bd9Sstevel@tonic-gate 205db2bae30SDana Myers #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 2067c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 2077c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 2087c478bd9Sstevel@tonic-gate 2097c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */ 2107c478bd9Sstevel@tonic-gate 211db2bae30SDana Myers #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 2127c478bd9Sstevel@tonic-gate 213db2bae30SDana Myers #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 2147c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 2157c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 2167c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 2177c478bd9Sstevel@tonic-gate 218db2bae30SDana Myers #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 2197c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 2207c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 2217c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 2227c478bd9Sstevel@tonic-gate ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 2237c478bd9Sstevel@tonic-gate 2247c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */ 2257c478bd9Sstevel@tonic-gate 226db2bae30SDana Myers #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 2277c478bd9Sstevel@tonic-gate 228db2bae30SDana Myers #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 2297c478bd9Sstevel@tonic-gate 230db2bae30SDana Myers #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 2317c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 2327c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 2337c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 2347c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 2357c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 2367c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 2377c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 2387c478bd9Sstevel@tonic-gate #else 2397c478bd9Sstevel@tonic-gate /* 2407c478bd9Sstevel@tonic-gate * Macros for little-endian machines 2417c478bd9Sstevel@tonic-gate */ 2427c478bd9Sstevel@tonic-gate 24330082d0cSmyers #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 2447c478bd9Sstevel@tonic-gate 2457c478bd9Sstevel@tonic-gate /* The hardware supports unaligned transfers, just do the little-endian move */ 2467c478bd9Sstevel@tonic-gate 2477c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */ 2487c478bd9Sstevel@tonic-gate 249db2bae30SDana Myers #define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 250db2bae30SDana Myers #define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 251db2bae30SDana Myers #define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 2527c478bd9Sstevel@tonic-gate 2537c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */ 2547c478bd9Sstevel@tonic-gate 255db2bae30SDana Myers #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 256db2bae30SDana Myers #define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 257db2bae30SDana Myers #define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 2587c478bd9Sstevel@tonic-gate 2597c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */ 2607c478bd9Sstevel@tonic-gate 261db2bae30SDana Myers #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 262db2bae30SDana Myers #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 263db2bae30SDana Myers #define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 2647c478bd9Sstevel@tonic-gate 2657c478bd9Sstevel@tonic-gate #else 2667c478bd9Sstevel@tonic-gate /* 267db2bae30SDana Myers * The hardware does not support unaligned transfers. We must move the 268db2bae30SDana Myers * data one byte at a time. These macros work whether the source or 269aa2aa9a6SDana Myers * the destination (or both) is/are unaligned. (Little-endian move) 2707c478bd9Sstevel@tonic-gate */ 2717c478bd9Sstevel@tonic-gate 2727c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */ 2737c478bd9Sstevel@tonic-gate 274db2bae30SDana Myers #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 2757c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 2767c478bd9Sstevel@tonic-gate 277db2bae30SDana Myers #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 278db2bae30SDana Myers #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 2797c478bd9Sstevel@tonic-gate 2807c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */ 2817c478bd9Sstevel@tonic-gate 282db2bae30SDana Myers #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 2837c478bd9Sstevel@tonic-gate 284db2bae30SDana Myers #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 2857c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 2867c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 2877c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 2887c478bd9Sstevel@tonic-gate 289db2bae30SDana Myers #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 2907c478bd9Sstevel@tonic-gate 2917c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */ 2927c478bd9Sstevel@tonic-gate 293db2bae30SDana Myers #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 294db2bae30SDana Myers #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 295db2bae30SDana Myers #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 2967c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 2977c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 2987c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 2997c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 3007c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 3017c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 3027c478bd9Sstevel@tonic-gate (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 3037c478bd9Sstevel@tonic-gate #endif 3047c478bd9Sstevel@tonic-gate #endif 3057c478bd9Sstevel@tonic-gate 3067c478bd9Sstevel@tonic-gate 3077c478bd9Sstevel@tonic-gate /* 3087c478bd9Sstevel@tonic-gate * Fast power-of-two math macros for non-optimized compilers 3097c478bd9Sstevel@tonic-gate */ 310db2bae30SDana Myers #define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 311db2bae30SDana Myers #define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 312db2bae30SDana Myers #define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 3137c478bd9Sstevel@tonic-gate 314db2bae30SDana Myers #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 315db2bae30SDana Myers #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 316db2bae30SDana Myers #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 3177c478bd9Sstevel@tonic-gate 318db2bae30SDana Myers #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 319db2bae30SDana Myers #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 320db2bae30SDana Myers #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 3217c478bd9Sstevel@tonic-gate 322db2bae30SDana Myers #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 323db2bae30SDana Myers #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 324db2bae30SDana Myers #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 3257c478bd9Sstevel@tonic-gate 326db2bae30SDana Myers #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 327db2bae30SDana Myers #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 328db2bae30SDana Myers #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 3297c478bd9Sstevel@tonic-gate 330db2bae30SDana Myers #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 331db2bae30SDana Myers #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 332db2bae30SDana Myers #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 3337c478bd9Sstevel@tonic-gate 3347b1019a6SJerry Jelinek /* Test for ASCII character */ 3357b1019a6SJerry Jelinek 3367b1019a6SJerry Jelinek #define ACPI_IS_ASCII(c) ((c) < 0x80) 3377b1019a6SJerry Jelinek 3387b1019a6SJerry Jelinek /* Signed integers */ 3397b1019a6SJerry Jelinek 3407b1019a6SJerry Jelinek #define ACPI_SIGN_POSITIVE 0 3417b1019a6SJerry Jelinek #define ACPI_SIGN_NEGATIVE 1 3427b1019a6SJerry Jelinek 3437b1019a6SJerry Jelinek 3447c478bd9Sstevel@tonic-gate /* 3457c478bd9Sstevel@tonic-gate * Rounding macros (Power of two boundaries only) 3467c478bd9Sstevel@tonic-gate */ 347db2bae30SDana Myers #define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 348db2bae30SDana Myers (~(((ACPI_SIZE) boundary)-1))) 3497c478bd9Sstevel@tonic-gate 350db2bae30SDana Myers #define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 351db2bae30SDana Myers (((ACPI_SIZE) boundary)-1)) & \ 352db2bae30SDana Myers (~(((ACPI_SIZE) boundary)-1))) 3537c478bd9Sstevel@tonic-gate 354db2bae30SDana Myers /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 3557c478bd9Sstevel@tonic-gate 356db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 357db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 358db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 3597c478bd9Sstevel@tonic-gate 360db2bae30SDana Myers #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 361db2bae30SDana Myers #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 362db2bae30SDana Myers #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 3637c478bd9Sstevel@tonic-gate 36430082d0cSmyers #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 36530082d0cSmyers #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 36630082d0cSmyers 36730082d0cSmyers #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 3687c478bd9Sstevel@tonic-gate 3697c478bd9Sstevel@tonic-gate /* Generic (non-power-of-two) rounding */ 3707c478bd9Sstevel@tonic-gate 371db2bae30SDana Myers #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 37230082d0cSmyers 373db2bae30SDana Myers #define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 3747c478bd9Sstevel@tonic-gate 375*35786f68SRobert Mustacchi /* Generic bit manipulation */ 376*35786f68SRobert Mustacchi 377*35786f68SRobert Mustacchi #ifndef ACPI_USE_NATIVE_BIT_FINDER 378*35786f68SRobert Mustacchi 379*35786f68SRobert Mustacchi #define __ACPI_FIND_LAST_BIT_2(a, r) ((((UINT8) (a)) & 0x02) ? (r)+1 : (r)) 380*35786f68SRobert Mustacchi #define __ACPI_FIND_LAST_BIT_4(a, r) ((((UINT8) (a)) & 0x0C) ? \ 381*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_2 ((a)>>2, (r)+2) : \ 382*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_2 ((a), (r))) 383*35786f68SRobert Mustacchi #define __ACPI_FIND_LAST_BIT_8(a, r) ((((UINT8) (a)) & 0xF0) ? \ 384*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_4 ((a)>>4, (r)+4) : \ 385*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_4 ((a), (r))) 386*35786f68SRobert Mustacchi #define __ACPI_FIND_LAST_BIT_16(a, r) ((((UINT16) (a)) & 0xFF00) ? \ 387*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_8 ((a)>>8, (r)+8) : \ 388*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_8 ((a), (r))) 389*35786f68SRobert Mustacchi #define __ACPI_FIND_LAST_BIT_32(a, r) ((((UINT32) (a)) & 0xFFFF0000) ? \ 390*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_16 ((a)>>16, (r)+16) : \ 391*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_16 ((a), (r))) 392*35786f68SRobert Mustacchi #define __ACPI_FIND_LAST_BIT_64(a, r) ((((UINT64) (a)) & 0xFFFFFFFF00000000) ? \ 393*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_32 ((a)>>32, (r)+32) : \ 394*35786f68SRobert Mustacchi __ACPI_FIND_LAST_BIT_32 ((a), (r))) 395*35786f68SRobert Mustacchi 396*35786f68SRobert Mustacchi #define ACPI_FIND_LAST_BIT_8(a) ((a) ? __ACPI_FIND_LAST_BIT_8 (a, 1) : 0) 397*35786f68SRobert Mustacchi #define ACPI_FIND_LAST_BIT_16(a) ((a) ? __ACPI_FIND_LAST_BIT_16 (a, 1) : 0) 398*35786f68SRobert Mustacchi #define ACPI_FIND_LAST_BIT_32(a) ((a) ? __ACPI_FIND_LAST_BIT_32 (a, 1) : 0) 399*35786f68SRobert Mustacchi #define ACPI_FIND_LAST_BIT_64(a) ((a) ? __ACPI_FIND_LAST_BIT_64 (a, 1) : 0) 400*35786f68SRobert Mustacchi 401*35786f68SRobert Mustacchi #define __ACPI_FIND_FIRST_BIT_2(a, r) ((((UINT8) (a)) & 0x01) ? (r) : (r)+1) 402*35786f68SRobert Mustacchi #define __ACPI_FIND_FIRST_BIT_4(a, r) ((((UINT8) (a)) & 0x03) ? \ 403*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_2 ((a), (r)) : \ 404*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_2 ((a)>>2, (r)+2)) 405*35786f68SRobert Mustacchi #define __ACPI_FIND_FIRST_BIT_8(a, r) ((((UINT8) (a)) & 0x0F) ? \ 406*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_4 ((a), (r)) : \ 407*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_4 ((a)>>4, (r)+4)) 408*35786f68SRobert Mustacchi #define __ACPI_FIND_FIRST_BIT_16(a, r) ((((UINT16) (a)) & 0x00FF) ? \ 409*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_8 ((a), (r)) : \ 410*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_8 ((a)>>8, (r)+8)) 411*35786f68SRobert Mustacchi #define __ACPI_FIND_FIRST_BIT_32(a, r) ((((UINT32) (a)) & 0x0000FFFF) ? \ 412*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_16 ((a), (r)) : \ 413*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_16 ((a)>>16, (r)+16)) 414*35786f68SRobert Mustacchi #define __ACPI_FIND_FIRST_BIT_64(a, r) ((((UINT64) (a)) & 0x00000000FFFFFFFF) ? \ 415*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_32 ((a), (r)) : \ 416*35786f68SRobert Mustacchi __ACPI_FIND_FIRST_BIT_32 ((a)>>32, (r)+32)) 417*35786f68SRobert Mustacchi 418*35786f68SRobert Mustacchi #define ACPI_FIND_FIRST_BIT_8(a) ((a) ? __ACPI_FIND_FIRST_BIT_8 (a, 1) : 0) 419*35786f68SRobert Mustacchi #define ACPI_FIND_FIRST_BIT_16(a) ((a) ? __ACPI_FIND_FIRST_BIT_16 (a, 1) : 0) 420*35786f68SRobert Mustacchi #define ACPI_FIND_FIRST_BIT_32(a) ((a) ? __ACPI_FIND_FIRST_BIT_32 (a, 1) : 0) 421*35786f68SRobert Mustacchi #define ACPI_FIND_FIRST_BIT_64(a) ((a) ? __ACPI_FIND_FIRST_BIT_64 (a, 1) : 0) 422*35786f68SRobert Mustacchi 423*35786f68SRobert Mustacchi #endif /* ACPI_USE_NATIVE_BIT_FINDER */ 424*35786f68SRobert Mustacchi 425*35786f68SRobert Mustacchi /* Generic (power-of-two) rounding */ 426*35786f68SRobert Mustacchi 427*35786f68SRobert Mustacchi #define ACPI_ROUND_UP_POWER_OF_TWO_8(a) ((UINT8) \ 428*35786f68SRobert Mustacchi (((UINT16) 1) << ACPI_FIND_LAST_BIT_8 ((a) - 1))) 429*35786f68SRobert Mustacchi #define ACPI_ROUND_DOWN_POWER_OF_TWO_8(a) ((UINT8) \ 430*35786f68SRobert Mustacchi (((UINT16) 1) << (ACPI_FIND_LAST_BIT_8 ((a)) - 1))) 431*35786f68SRobert Mustacchi #define ACPI_ROUND_UP_POWER_OF_TWO_16(a) ((UINT16) \ 432*35786f68SRobert Mustacchi (((UINT32) 1) << ACPI_FIND_LAST_BIT_16 ((a) - 1))) 433*35786f68SRobert Mustacchi #define ACPI_ROUND_DOWN_POWER_OF_TWO_16(a) ((UINT16) \ 434*35786f68SRobert Mustacchi (((UINT32) 1) << (ACPI_FIND_LAST_BIT_16 ((a)) - 1))) 435*35786f68SRobert Mustacchi #define ACPI_ROUND_UP_POWER_OF_TWO_32(a) ((UINT32) \ 436*35786f68SRobert Mustacchi (((UINT64) 1) << ACPI_FIND_LAST_BIT_32 ((a) - 1))) 437*35786f68SRobert Mustacchi #define ACPI_ROUND_DOWN_POWER_OF_TWO_32(a) ((UINT32) \ 438*35786f68SRobert Mustacchi (((UINT64) 1) << (ACPI_FIND_LAST_BIT_32 ((a)) - 1))) 439*35786f68SRobert Mustacchi #define ACPI_IS_ALIGNED(a, s) (((a) & ((s) - 1)) == 0) 440*35786f68SRobert Mustacchi #define ACPI_IS_POWER_OF_TWO(a) ACPI_IS_ALIGNED(a, a) 441*35786f68SRobert Mustacchi 4427c478bd9Sstevel@tonic-gate /* 4437c478bd9Sstevel@tonic-gate * Bitmask creation 4447c478bd9Sstevel@tonic-gate * Bit positions start at zero. 4457c478bd9Sstevel@tonic-gate * MASK_BITS_ABOVE creates a mask starting AT the position and above 4467c478bd9Sstevel@tonic-gate * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 447*35786f68SRobert Mustacchi * MASK_BITS_ABOVE/BELOW accepts a bit offset to create a mask 448*35786f68SRobert Mustacchi * MASK_BITS_ABOVE/BELOW_32/64 accepts a bit width to create a mask 449*35786f68SRobert Mustacchi * Note: The ACPI_INTEGER_BIT_SIZE check is used to bypass compiler 450*35786f68SRobert Mustacchi * differences with the shift operator 4517c478bd9Sstevel@tonic-gate */ 45226f3cdf0SGordon Ross #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position)))) 45326f3cdf0SGordon Ross #define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position))) 454*35786f68SRobert Mustacchi #define ACPI_MASK_BITS_ABOVE_32(width) ((UINT32) ACPI_MASK_BITS_ABOVE(width)) 455*35786f68SRobert Mustacchi #define ACPI_MASK_BITS_BELOW_32(width) ((UINT32) ACPI_MASK_BITS_BELOW(width)) 456*35786f68SRobert Mustacchi #define ACPI_MASK_BITS_ABOVE_64(width) ((width) == ACPI_INTEGER_BIT_SIZE ? \ 457*35786f68SRobert Mustacchi ACPI_UINT64_MAX : \ 458*35786f68SRobert Mustacchi ACPI_MASK_BITS_ABOVE(width)) 459*35786f68SRobert Mustacchi #define ACPI_MASK_BITS_BELOW_64(width) ((width) == ACPI_INTEGER_BIT_SIZE ? \ 460*35786f68SRobert Mustacchi (UINT64) 0 : \ 461*35786f68SRobert Mustacchi ACPI_MASK_BITS_BELOW(width)) 4627c478bd9Sstevel@tonic-gate 4637c478bd9Sstevel@tonic-gate /* Bitfields within ACPI registers */ 4647c478bd9Sstevel@tonic-gate 4657b1019a6SJerry Jelinek #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \ 4667b1019a6SJerry Jelinek ((Val << Pos) & Mask) 4677b1019a6SJerry Jelinek 4687b1019a6SJerry Jelinek #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \ 4697b1019a6SJerry Jelinek Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 4707b1019a6SJerry Jelinek 4717b1019a6SJerry Jelinek #define ACPI_INSERT_BITS(Target, Mask, Source) \ 4727b1019a6SJerry Jelinek Target = ((Target & (~(Mask))) | (Source & Mask)) 4737b1019a6SJerry Jelinek 4747b1019a6SJerry Jelinek /* Generic bitfield macros and masks */ 4757b1019a6SJerry Jelinek 4767b1019a6SJerry Jelinek #define ACPI_GET_BITS(SourcePtr, Position, Mask) \ 4777b1019a6SJerry Jelinek ((*(SourcePtr) >> (Position)) & (Mask)) 4787c478bd9Sstevel@tonic-gate 4797b1019a6SJerry Jelinek #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \ 4807b1019a6SJerry Jelinek (*(TargetPtr) |= (((Value) & (Mask)) << (Position))) 4817b1019a6SJerry Jelinek 4827b1019a6SJerry Jelinek #define ACPI_1BIT_MASK 0x00000001 4837b1019a6SJerry Jelinek #define ACPI_2BIT_MASK 0x00000003 4847b1019a6SJerry Jelinek #define ACPI_3BIT_MASK 0x00000007 4857b1019a6SJerry Jelinek #define ACPI_4BIT_MASK 0x0000000F 4867b1019a6SJerry Jelinek #define ACPI_5BIT_MASK 0x0000001F 4877b1019a6SJerry Jelinek #define ACPI_6BIT_MASK 0x0000003F 4887b1019a6SJerry Jelinek #define ACPI_7BIT_MASK 0x0000007F 4897b1019a6SJerry Jelinek #define ACPI_8BIT_MASK 0x000000FF 4907b1019a6SJerry Jelinek #define ACPI_16BIT_MASK 0x0000FFFF 4917b1019a6SJerry Jelinek #define ACPI_24BIT_MASK 0x00FFFFFF 4927b1019a6SJerry Jelinek 4937b1019a6SJerry Jelinek /* Macros to extract flag bits from position zero */ 4947b1019a6SJerry Jelinek 4957b1019a6SJerry Jelinek #define ACPI_GET_1BIT_FLAG(Value) ((Value) & ACPI_1BIT_MASK) 4967b1019a6SJerry Jelinek #define ACPI_GET_2BIT_FLAG(Value) ((Value) & ACPI_2BIT_MASK) 4977b1019a6SJerry Jelinek #define ACPI_GET_3BIT_FLAG(Value) ((Value) & ACPI_3BIT_MASK) 4987b1019a6SJerry Jelinek #define ACPI_GET_4BIT_FLAG(Value) ((Value) & ACPI_4BIT_MASK) 4997b1019a6SJerry Jelinek 5007b1019a6SJerry Jelinek /* Macros to extract flag bits from position one and above */ 5017b1019a6SJerry Jelinek 5027b1019a6SJerry Jelinek #define ACPI_EXTRACT_1BIT_FLAG(Field, Position) (ACPI_GET_1BIT_FLAG ((Field) >> Position)) 5037b1019a6SJerry Jelinek #define ACPI_EXTRACT_2BIT_FLAG(Field, Position) (ACPI_GET_2BIT_FLAG ((Field) >> Position)) 5047b1019a6SJerry Jelinek #define ACPI_EXTRACT_3BIT_FLAG(Field, Position) (ACPI_GET_3BIT_FLAG ((Field) >> Position)) 5057b1019a6SJerry Jelinek #define ACPI_EXTRACT_4BIT_FLAG(Field, Position) (ACPI_GET_4BIT_FLAG ((Field) >> Position)) 5067b1019a6SJerry Jelinek 5077b1019a6SJerry Jelinek /* ACPI Pathname helpers */ 5087b1019a6SJerry Jelinek 5097b1019a6SJerry Jelinek #define ACPI_IS_ROOT_PREFIX(c) ((c) == (UINT8) 0x5C) /* Backslash */ 5107b1019a6SJerry Jelinek #define ACPI_IS_PARENT_PREFIX(c) ((c) == (UINT8) 0x5E) /* Carat */ 5117b1019a6SJerry Jelinek #define ACPI_IS_PATH_SEPARATOR(c) ((c) == (UINT8) 0x2E) /* Period (dot) */ 51227f7c583Smyers 5137c478bd9Sstevel@tonic-gate /* 5147b1019a6SJerry Jelinek * An object of type ACPI_NAMESPACE_NODE can appear in some contexts 5157b1019a6SJerry Jelinek * where a pointer to an object of type ACPI_OPERAND_OBJECT can also 516db2bae30SDana Myers * appear. This macro is used to distinguish them. 5177c478bd9Sstevel@tonic-gate * 5187b1019a6SJerry Jelinek * The "DescriptorType" field is the second field in both structures. 5197c478bd9Sstevel@tonic-gate */ 5207b1019a6SJerry Jelinek #define ACPI_GET_DESCRIPTOR_PTR(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer) 5217b1019a6SJerry Jelinek #define ACPI_SET_DESCRIPTOR_PTR(d, p) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p)) 52227f7c583Smyers #define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 5237b1019a6SJerry Jelinek #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t)) 5247c478bd9Sstevel@tonic-gate 5257c478bd9Sstevel@tonic-gate /* 5267c478bd9Sstevel@tonic-gate * Macros for the master AML opcode table 5277c478bd9Sstevel@tonic-gate */ 528db2bae30SDana Myers #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 529db2bae30SDana Myers #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 530db2bae30SDana Myers {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 5317c478bd9Sstevel@tonic-gate #else 532db2bae30SDana Myers #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 533db2bae30SDana Myers {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 5347c478bd9Sstevel@tonic-gate #endif 5357c478bd9Sstevel@tonic-gate 5367c478bd9Sstevel@tonic-gate #define ARG_TYPE_WIDTH 5 5377c478bd9Sstevel@tonic-gate #define ARG_1(x) ((UINT32)(x)) 5387c478bd9Sstevel@tonic-gate #define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 5397c478bd9Sstevel@tonic-gate #define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 5407c478bd9Sstevel@tonic-gate #define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 5417c478bd9Sstevel@tonic-gate #define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 5427c478bd9Sstevel@tonic-gate #define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 5437c478bd9Sstevel@tonic-gate 5447c478bd9Sstevel@tonic-gate #define ARGI_LIST1(a) (ARG_1(a)) 545db2bae30SDana Myers #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 546db2bae30SDana Myers #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 547db2bae30SDana Myers #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 548db2bae30SDana Myers #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 549db2bae30SDana 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)) 5507c478bd9Sstevel@tonic-gate 5517c478bd9Sstevel@tonic-gate #define ARGP_LIST1(a) (ARG_1(a)) 552db2bae30SDana Myers #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 553db2bae30SDana Myers #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 554db2bae30SDana Myers #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 555db2bae30SDana Myers #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 556db2bae30SDana 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)) 5577c478bd9Sstevel@tonic-gate 5587c478bd9Sstevel@tonic-gate #define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 5597c478bd9Sstevel@tonic-gate #define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 5607c478bd9Sstevel@tonic-gate 5617c478bd9Sstevel@tonic-gate /* 56230082d0cSmyers * Ascii error messages can be configured out 5637c478bd9Sstevel@tonic-gate */ 56430082d0cSmyers #ifndef ACPI_NO_ERROR_MESSAGES 56530082d0cSmyers /* 566*35786f68SRobert Mustacchi * Error reporting. The callers module and line number are inserted by AE_INFO, 56730082d0cSmyers * the plist contains a set of parens to allow variable-length lists. 56830082d0cSmyers * These macros are used for both the debug and non-debug versions of the code. 56930082d0cSmyers */ 570*35786f68SRobert Mustacchi #define ACPI_ERROR_NAMESPACE(s, p, e) AcpiUtPrefixedNamespaceError (AE_INFO, s, p, e); 5717b1019a6SJerry Jelinek #define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e); 5727b1019a6SJerry Jelinek #define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 5737b1019a6SJerry Jelinek #define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist 5747b1019a6SJerry Jelinek #define ACPI_BIOS_ERROR_PREDEFINED(plist) AcpiUtPredefinedBiosError plist 575*35786f68SRobert Mustacchi #define ACPI_ERROR_ONLY(s) s 57630082d0cSmyers 5777c478bd9Sstevel@tonic-gate #else 5787c478bd9Sstevel@tonic-gate 57930082d0cSmyers /* No error messages */ 5807c478bd9Sstevel@tonic-gate 581*35786f68SRobert Mustacchi #define ACPI_ERROR_NAMESPACE(s, p, e) 582db2bae30SDana Myers #define ACPI_ERROR_METHOD(s, n, p, e) 58357190917SDana Myers #define ACPI_WARN_PREDEFINED(plist) 58457190917SDana Myers #define ACPI_INFO_PREDEFINED(plist) 5857b1019a6SJerry Jelinek #define ACPI_BIOS_ERROR_PREDEFINED(plist) 586*35786f68SRobert Mustacchi #define ACPI_ERROR_ONLY(s) 587aa2aa9a6SDana Myers 588aa2aa9a6SDana Myers #endif /* ACPI_NO_ERROR_MESSAGES */ 5897c478bd9Sstevel@tonic-gate 5907b1019a6SJerry Jelinek #if (!ACPI_REDUCED_HARDWARE) 5917b1019a6SJerry Jelinek #define ACPI_HW_OPTIONAL_FUNCTION(addr) addr 5927c478bd9Sstevel@tonic-gate #else 5937b1019a6SJerry Jelinek #define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL 5947c478bd9Sstevel@tonic-gate #endif 5957c478bd9Sstevel@tonic-gate 596db2bae30SDana Myers 597db2bae30SDana Myers /* 598db2bae30SDana Myers * Macros used for ACPICA utilities only 599db2bae30SDana Myers */ 600db2bae30SDana Myers 601db2bae30SDana Myers /* Generate a UUID */ 602db2bae30SDana Myers 603db2bae30SDana Myers #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 604db2bae30SDana Myers (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 605db2bae30SDana Myers (b) & 0xFF, ((b) >> 8) & 0xFF, \ 606db2bae30SDana Myers (c) & 0xFF, ((c) >> 8) & 0xFF, \ 607db2bae30SDana Myers (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 608db2bae30SDana Myers 609db2bae30SDana Myers #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 610db2bae30SDana Myers 611db2bae30SDana Myers 612*35786f68SRobert Mustacchi /* 613*35786f68SRobert Mustacchi * Macors used for the ASL-/ASL+ converter utility 614*35786f68SRobert Mustacchi */ 615*35786f68SRobert Mustacchi #ifdef ACPI_ASL_COMPILER 616*35786f68SRobert Mustacchi 617*35786f68SRobert Mustacchi #define ASL_CV_LABEL_FILENODE(a) CvLabelFileNode(a); 618*35786f68SRobert Mustacchi #define ASL_CV_CAPTURE_COMMENTS_ONLY(a) CvCaptureCommentsOnly (a); 619*35786f68SRobert Mustacchi #define ASL_CV_CAPTURE_COMMENTS(a) CvCaptureComments (a); 620*35786f68SRobert Mustacchi #define ASL_CV_TRANSFER_COMMENTS(a) CvTransferComments (a); 621*35786f68SRobert Mustacchi #define ASL_CV_CLOSE_PAREN(a,b) CvCloseParenWriteComment(a,b); 622*35786f68SRobert Mustacchi #define ASL_CV_CLOSE_BRACE(a,b) CvCloseBraceWriteComment(a,b); 623*35786f68SRobert Mustacchi #define ASL_CV_SWITCH_FILES(a,b) CvSwitchFiles(a,b); 624*35786f68SRobert Mustacchi #define ASL_CV_CLEAR_OP_COMMENTS(a) CvClearOpComments(a); 625*35786f68SRobert Mustacchi #define ASL_CV_PRINT_ONE_COMMENT(a,b,c,d) CvPrintOneCommentType (a,b,c,d); 626*35786f68SRobert Mustacchi #define ASL_CV_PRINT_ONE_COMMENT_LIST(a,b) CvPrintOneCommentList (a,b); 627*35786f68SRobert Mustacchi #define ASL_CV_FILE_HAS_SWITCHED(a) CvFileHasSwitched(a) 628*35786f68SRobert Mustacchi #define ASL_CV_INIT_FILETREE(a,b,c) CvInitFileTree(a,b,c); 629*35786f68SRobert Mustacchi 630*35786f68SRobert Mustacchi #else 631*35786f68SRobert Mustacchi 632*35786f68SRobert Mustacchi #define ASL_CV_LABEL_FILENODE(a) 633*35786f68SRobert Mustacchi #define ASL_CV_CAPTURE_COMMENTS_ONLY(a) 634*35786f68SRobert Mustacchi #define ASL_CV_CAPTURE_COMMENTS(a) 635*35786f68SRobert Mustacchi #define ASL_CV_TRANSFER_COMMENTS(a) 636*35786f68SRobert Mustacchi #define ASL_CV_CLOSE_PAREN(a,b) AcpiOsPrintf (")"); 637*35786f68SRobert Mustacchi #define ASL_CV_CLOSE_BRACE(a,b) AcpiOsPrintf ("}"); 638*35786f68SRobert Mustacchi #define ASL_CV_SWITCH_FILES(a,b) 639*35786f68SRobert Mustacchi #define ASL_CV_CLEAR_OP_COMMENTS(a) 640*35786f68SRobert Mustacchi #define ASL_CV_PRINT_ONE_COMMENT(a,b,c,d) 641*35786f68SRobert Mustacchi #define ASL_CV_PRINT_ONE_COMMENT_LIST(a,b) 642*35786f68SRobert Mustacchi #define ASL_CV_FILE_HAS_SWITCHED(a) 0 643*35786f68SRobert Mustacchi #define ASL_CV_INIT_FILETREE(a,b,c) 644*35786f68SRobert Mustacchi 645*35786f68SRobert Mustacchi #endif 646*35786f68SRobert Mustacchi 6477c478bd9Sstevel@tonic-gate #endif /* ACMACROS_H */ 648