acmacros.h revision 197104
117721Speter/****************************************************************************** 217721Speter * 317721Speter * Name: acmacros.h - C macros for the entire subsystem. 417721Speter * 517721Speter *****************************************************************************/ 617721Speter 717721Speter/****************************************************************************** 817721Speter * 917721Speter * 1. Copyright Notice 1017721Speter * 1117721Speter * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp. 1217721Speter * All rights reserved. 1317721Speter * 1417721Speter * 2. License 1517721Speter * 1617721Speter * 2.1. This is your license from Intel Corp. under its intellectual property 1717721Speter * rights. You may have additional license terms from the party that provided 1817721Speter * you this software, covering your right to use that party's intellectual 1917721Speter * property rights. 2017721Speter * 2117721Speter * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2217721Speter * copy of the source code appearing in this file ("Covered Code") an 2317721Speter * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2417721Speter * base code distributed originally by Intel ("Original Intel Code") to copy, 2517721Speter * make derivatives, distribute, use and display any portion of the Covered 2617721Speter * Code in any form, with the right to sublicense such rights; and 2717721Speter * 2817721Speter * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 2917721Speter * license (with the right to sublicense), under only those claims of Intel 3017721Speter * patents that are infringed by the Original Intel Code, to make, use, sell, 3117721Speter * offer to sell, and import the Covered Code and derivative works thereof 3217721Speter * solely to the minimum extent necessary to exercise the above copyright 3317721Speter * license, and in no event shall the patent license extend to any additions 3417721Speter * to or modifications of the Original Intel Code. No other license or right 3517721Speter * is granted directly or by implication, estoppel or otherwise; 3617721Speter * 3717721Speter * The above copyright and patent license is granted only if the following 3817721Speter * conditions are met: 3917721Speter * 4017721Speter * 3. Conditions 4117721Speter * 4217721Speter * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4317721Speter * Redistribution of source code of any substantial portion of the Covered 4417721Speter * Code or modification with rights to further distribute source must include 4517721Speter * the above Copyright Notice, the above License, this list of Conditions, 4617721Speter * and the following Disclaimer and Export Compliance provision. In addition, 4717721Speter * Licensee must cause all Covered Code to which Licensee contributes to 4817721Speter * contain a file documenting the changes Licensee made to create that Covered 4917721Speter * Code and the date of any change. Licensee must include in that file the 5017721Speter * documentation of any changes made by any predecessor Licensee. Licensee 5117721Speter * must include a prominent statement that the modification is derived, 5217721Speter * directly or indirectly, from Original Intel Code. 5317721Speter * 5417721Speter * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5517721Speter * Redistribution of source code of any substantial portion of the Covered 5617721Speter * Code or modification without rights to further distribute source must 5717721Speter * include the following Disclaimer and Export Compliance provision in the 5817721Speter * documentation and/or other materials provided with distribution. In 5917721Speter * addition, Licensee may not authorize further sublicense of source of any 6017721Speter * portion of the Covered Code, and must include terms to the effect that the 6117721Speter * license from Licensee to its licensee is limited to the intellectual 6217721Speter * property embodied in the software Licensee provides to its licensee, and 6317721Speter * not to intellectual property embodied in modifications its licensee may 6417721Speter * make. 6517721Speter * 6617721Speter * 3.3. Redistribution of Executable. Redistribution in executable form of any 6717721Speter * substantial portion of the Covered Code or modification must reproduce the 6817721Speter * above Copyright Notice, and the following Disclaimer and Export Compliance 6917721Speter * provision in the documentation and/or other materials provided with the 7017721Speter * distribution. 7117721Speter * 7217721Speter * 3.4. Intel retains all right, title, and interest in and to the Original 7317721Speter * Intel Code. 7417721Speter * 7517721Speter * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7617721Speter * Intel shall be used in advertising or otherwise to promote the sale, use or 7717721Speter * other dealings in products derived from or relating to the Covered Code 7817721Speter * without prior written authorization from Intel. 7917721Speter * 8017721Speter * 4. Disclaimer and Export Compliance 8117721Speter * 8217721Speter * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8317721Speter * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8417721Speter * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8517721Speter * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8617721Speter * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8717721Speter * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8817721Speter * PARTICULAR PURPOSE. 8917721Speter * 9017721Speter * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9117721Speter * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9217721Speter * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9317721Speter * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9417721Speter * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9517721Speter * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9617721Speter * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9717721Speter * LIMITED REMEDY. 9817721Speter * 9917721Speter * 4.3. Licensee shall not export, either directly or indirectly, any of this 10017721Speter * software or system incorporating such software without first obtaining any 10117721Speter * required license or other approval from the U. S. Department of Commerce or 10217721Speter * any other agency or department of the United States Government. In the 10317721Speter * event Licensee exports any such software from the United States or 10417721Speter * re-exports any such software from a foreign destination, Licensee shall 10517721Speter * ensure that the distribution and export/re-export of the software is in 10617721Speter * compliance with all laws, regulations, orders, or other restrictions of the 10717721Speter * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10817721Speter * any of its subsidiaries will export/re-export any technical data, process, 10917721Speter * software, or service, directly or indirectly, to any country for which the 11017721Speter * United States government or any agency thereof requires an export license, 11117721Speter * other governmental approval, or letter of assurance, without first obtaining 11217721Speter * such license, approval or letter. 11317721Speter * 11417721Speter *****************************************************************************/ 11517721Speter 11617721Speter#ifndef __ACMACROS_H__ 11717721Speter#define __ACMACROS_H__ 11817721Speter 11917721Speter 12017721Speter/* 12117721Speter * Extract data using a pointer. Any more than a byte and we 12217721Speter * get into potential aligment issues -- see the STORE macros below. 12317721Speter * Use with care. 12417721Speter */ 12517721Speter#define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 12617721Speter#define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 12717721Speter#define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 12817721Speter#define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 12917721Speter#define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 13017721Speter#define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 13117721Speter#define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 13217721Speter#define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 13317721Speter 13417721Speter/* 13517721Speter * printf() format helpers 13617721Speter */ 13717721Speter 13817721Speter/* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */ 13917721Speter 14017721Speter#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 14117721Speter 14217721Speter#if ACPI_MACHINE_WIDTH == 64 14317721Speter#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 14417721Speter#else 14517721Speter#define ACPI_FORMAT_NATIVE_UINT(i) 0, (i) 14617721Speter#endif 14717721Speter 14817721Speter 14917721Speter/* 15017721Speter * Macros for moving data around to/from buffers that are possibly unaligned. 15117721Speter * If the hardware supports the transfer of unaligned data, just do the store. 15217721Speter * Otherwise, we have to move one byte at a time. 15317721Speter */ 15417721Speter#ifdef ACPI_BIG_ENDIAN 15517721Speter/* 15617721Speter * Macros for big-endian machines 15717721Speter */ 15817721Speter 15917721Speter/* These macros reverse the bytes during the move, converting little-endian to big endian */ 16017721Speter 16117721Speter /* Big Endian <== Little Endian */ 16217721Speter /* Hi...Lo Lo...Hi */ 16317721Speter/* 16-bit source, 16/32/64 destination */ 16417721Speter 16517721Speter#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 16617721Speter (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 16717721Speter 16817721Speter#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 16917721Speter ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 17017721Speter ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 17117721Speter 17217721Speter#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 17317721Speter ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 17417721Speter ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 17517721Speter 17617721Speter/* 32-bit source, 16/32/64 destination */ 17717721Speter 17817721Speter#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 17917721Speter 18017721Speter#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 18117721Speter (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 18217721Speter (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 18317721Speter (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 18417721Speter 18517721Speter#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 18617721Speter ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 18717721Speter ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 18817721Speter ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 18917721Speter ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 19017721Speter 19117721Speter/* 64-bit source, 16/32/64 destination */ 19217721Speter 19317721Speter#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 19417721Speter 19517721Speter#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 19617721Speter 19717721Speter#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 19817721Speter (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 19917721Speter (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 20017721Speter (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 20117721Speter (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 20217721Speter (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 20317721Speter (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 20417721Speter (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 20517721Speter#else 20617721Speter/* 20717721Speter * Macros for little-endian machines 20817721Speter */ 20917721Speter 21017721Speter#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 21117721Speter 21217721Speter/* The hardware supports unaligned transfers, just do the little-endian move */ 21317721Speter 21417721Speter/* 16-bit source, 16/32/64 destination */ 21517721Speter 21617721Speter#define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 21717721Speter#define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 21817721Speter#define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 21917721Speter 22017721Speter/* 32-bit source, 16/32/64 destination */ 22117721Speter 22217721Speter#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 22317721Speter#define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 22417721Speter#define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 22517721Speter 22617721Speter/* 64-bit source, 16/32/64 destination */ 22717721Speter 22817721Speter#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 22917721Speter#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 23017721Speter#define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 23117721Speter 23217721Speter#else 23317721Speter/* 23417721Speter * The hardware does not support unaligned transfers. We must move the 23517721Speter * data one byte at a time. These macros work whether the source or 23617721Speter * the destination (or both) is/are unaligned. (Little-endian move) 23717721Speter */ 23817721Speter 23917721Speter/* 16-bit source, 16/32/64 destination */ 24017721Speter 24117721Speter#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 24217721Speter (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 24317721Speter 24417721Speter#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 24517721Speter#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 24617721Speter 24717721Speter/* 32-bit source, 16/32/64 destination */ 24817721Speter 24917721Speter#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 25017721Speter 25117721Speter#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 25217721Speter (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 25317721Speter (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 25417721Speter (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 25517721Speter 25617721Speter#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 25717721Speter 25817721Speter/* 64-bit source, 16/32/64 destination */ 25917721Speter 26017721Speter#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 26117721Speter#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 26217721Speter#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 26317721Speter (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 26417721Speter (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 26517721Speter (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 26617721Speter (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 26717721Speter (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 26817721Speter (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 26917721Speter (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 27017721Speter#endif 27117721Speter#endif 27217721Speter 27317721Speter 27417721Speter/* 27517721Speter * Fast power-of-two math macros for non-optimized compilers 27617721Speter */ 27717721Speter#define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 27817721Speter#define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 27917721Speter#define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 28017721Speter 28117721Speter#define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 28217721Speter#define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 28317721Speter#define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 28417721Speter 28517721Speter#define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 28617721Speter#define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 28717721Speter#define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 28817721Speter 28917721Speter#define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 29017721Speter#define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 29117721Speter#define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 29217721Speter 29317721Speter#define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 29417721Speter#define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 29517721Speter#define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 29617721Speter 29717721Speter#define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 29817721Speter#define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 29917721Speter#define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 30017721Speter 30117721Speter/* 30217721Speter * Rounding macros (Power of two boundaries only) 30317721Speter */ 30417721Speter#define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 30517721Speter (~(((ACPI_SIZE) boundary)-1))) 30617721Speter 30717721Speter#define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 30817721Speter (((ACPI_SIZE) boundary)-1)) & \ 30917721Speter (~(((ACPI_SIZE) boundary)-1))) 31017721Speter 31117721Speter/* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 31217721Speter 31317721Speter#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 31417721Speter#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 31517721Speter#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 31617721Speter 31717721Speter#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 31817721Speter#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 31917721Speter#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 32017721Speter 32117721Speter#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 32217721Speter#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 32317721Speter 32417721Speter#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 32517721Speter 32617721Speter/* Generic (non-power-of-two) rounding */ 32717721Speter 32817721Speter#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 32917721Speter 33017721Speter#define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 33117721Speter 33217721Speter/* 33317721Speter * Bitmask creation 33417721Speter * Bit positions start at zero. 33517721Speter * MASK_BITS_ABOVE creates a mask starting AT the position and above 33617721Speter * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 33717721Speter */ 33817721Speter#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((UINT32) (position)))) 33917721Speter#define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((UINT32) (position))) 34017721Speter 34117721Speter/* Bitfields within ACPI registers */ 34217721Speter 34317721Speter#define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 34417721Speter#define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 34517721Speter 34617721Speter#define ACPI_INSERT_BITS(Target, Mask, Source) Target = ((Target & (~(Mask))) | (Source & Mask)) 34717721Speter 34817721Speter/* 34917721Speter * An ACPI_NAMESPACE_NODE can appear in some contexts 35017721Speter * where a pointer to an ACPI_OPERAND_OBJECT can also 35117721Speter * appear. This macro is used to distinguish them. 35217721Speter * 35317721Speter * The "Descriptor" field is the first field in both structures. 35417721Speter */ 35517721Speter#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 35617721Speter#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t) 35717721Speter 35817721Speter/* 35917721Speter * Macros for the master AML opcode table 36017721Speter */ 36117721Speter#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 36217721Speter#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 36317721Speter {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 36417721Speter#else 36517721Speter#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 36617721Speter {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 36717721Speter#endif 36817721Speter 36917721Speter#define ARG_TYPE_WIDTH 5 37017721Speter#define ARG_1(x) ((UINT32)(x)) 37117721Speter#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 37217721Speter#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 37317721Speter#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 37417721Speter#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 37517721Speter#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 37617721Speter 37717721Speter#define ARGI_LIST1(a) (ARG_1(a)) 37817721Speter#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 37917721Speter#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 38017721Speter#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 38117721Speter#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 38217721Speter#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)) 38317721Speter 38417721Speter#define ARGP_LIST1(a) (ARG_1(a)) 38517721Speter#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 38617721Speter#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 38717721Speter#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 38817721Speter#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 38917721Speter#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)) 39017721Speter 39117721Speter#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 39217721Speter#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 39317721Speter 39417721Speter/* 39517721Speter * Ascii error messages can be configured out 39617721Speter */ 39717721Speter#ifndef ACPI_NO_ERROR_MESSAGES 39817721Speter/* 39917721Speter * Error reporting. Callers module and line number are inserted by AE_INFO, 40017721Speter * the plist contains a set of parens to allow variable-length lists. 40117721Speter * These macros are used for both the debug and non-debug versions of the code. 40217721Speter */ 40317721Speter#define ACPI_ERROR_NAMESPACE(s, e) AcpiNsReportError (AE_INFO, s, e); 40417721Speter#define ACPI_ERROR_METHOD(s, n, p, e) AcpiNsReportMethodError (AE_INFO, s, n, p, e); 40517721Speter#define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 40617721Speter 40717721Speter#else 40817721Speter 40917721Speter/* No error messages */ 41017721Speter 41117721Speter#define ACPI_ERROR_NAMESPACE(s, e) 41217721Speter#define ACPI_ERROR_METHOD(s, n, p, e) 41317721Speter#define ACPI_WARN_PREDEFINED(plist) 41417721Speter 41517721Speter#endif /* ACPI_NO_ERROR_MESSAGES */ 41617721Speter 41717721Speter/* 41817721Speter * Debug macros that are conditionally compiled 41917721Speter */ 42017721Speter#ifdef ACPI_DEBUG_OUTPUT 42117721Speter/* 42217721Speter * Function entry tracing 42317721Speter */ 42417721Speter#define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 42517721Speter AcpiUtTrace(ACPI_DEBUG_PARAMETERS) 42617721Speter#define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \ 42717721Speter AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b) 42817721Speter#define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \ 42917721Speter AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b) 43017721Speter#define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \ 43117721Speter AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b) 43217721Speter 43317721Speter#define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 43417721Speter 43517721Speter/* 43617721Speter * Function exit tracing. 43717721Speter * WARNING: These macros include a return statement. This is usually considered 43817721Speter * bad form, but having a separate exit macro is very ugly and difficult to maintain. 43917721Speter * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 44017721Speter * so that "_AcpiFunctionName" is defined. 44117721Speter * 44217721Speter * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining 44317721Speter * about these constructs. 44417721Speter */ 44517721Speter#ifdef ACPI_USE_DO_WHILE_0 44617721Speter#define ACPI_DO_WHILE0(a) do a while(0) 44717721Speter#else 44817721Speter#define ACPI_DO_WHILE0(a) a 44917721Speter#endif 45017721Speter 45117721Speter#define return_VOID ACPI_DO_WHILE0 ({ \ 45217721Speter AcpiUtExit (ACPI_DEBUG_PARAMETERS); \ 45317721Speter return;}) 45417721Speter/* 45517721Speter * There are two versions of most of the return macros. The default version is 45617721Speter * safer, since it avoids side-effects by guaranteeing that the argument will 45717721Speter * not be evaluated twice. 45817721Speter * 45917721Speter * A less-safe version of the macros is provided for optional use if the 46017721Speter * compiler uses excessive CPU stack (for example, this may happen in the 46117721Speter * debug case if code optimzation is disabled.) 46217721Speter */ 46317721Speter#ifndef ACPI_SIMPLE_RETURN_MACROS 46417721Speter 46517721Speter#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 46617721Speter register ACPI_STATUS _s = (s); \ 46717721Speter AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \ 46817721Speter return (_s); }) 46917721Speter#define return_PTR(s) ACPI_DO_WHILE0 ({ \ 47017721Speter register void *_s = (void *) (s); \ 47117721Speter AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \ 47217721Speter return (_s); }) 47317721Speter#define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 47417721Speter register ACPI_INTEGER _s = (s); \ 47517721Speter AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \ 47617721Speter return (_s); }) 47717721Speter#define return_UINT8(s) ACPI_DO_WHILE0 ({ \ 47817721Speter register UINT8 _s = (UINT8) (s); \ 47917721Speter AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) _s); \ 48017721Speter return (_s); }) 48117721Speter#define return_UINT32(s) ACPI_DO_WHILE0 ({ \ 48217721Speter register UINT32 _s = (UINT32) (s); \ 48317721Speter AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) _s); \ 48417721Speter return (_s); }) 48517721Speter#else /* Use original less-safe macros */ 48617721Speter 48717721Speter#define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 48817721Speter AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \ 48917721Speter return((s)); }) 49017721Speter#define return_PTR(s) ACPI_DO_WHILE0 ({ \ 49117721Speter AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \ 49217721Speter return((s)); }) 49317721Speter#define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 49417721Speter AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (ACPI_INTEGER) (s)); \ 49517721Speter return((s)); }) 49617721Speter#define return_UINT8(s) return_VALUE(s) 49717721Speter#define return_UINT32(s) return_VALUE(s) 49817721Speter 49917721Speter#endif /* ACPI_SIMPLE_RETURN_MACROS */ 50017721Speter 50117721Speter 50217721Speter/* Conditional execution */ 50317721Speter 50417721Speter#define ACPI_DEBUG_EXEC(a) a 50517721Speter#define ACPI_DEBUG_ONLY_MEMBERS(a) a; 50617721Speter#define _VERBOSE_STRUCTURES 50717721Speter 50817721Speter 50917721Speter/* Various object display routines for debug */ 51017721Speter 51117721Speter#define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0) 51217721Speter#define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c) 51317721Speter#define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b) 51417721Speter#define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d) 51517721Speter#define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT) 51617721Speter 51717721Speter#else 51817721Speter/* 51917721Speter * This is the non-debug case -- make everything go away, 52017721Speter * leaving no executable debug code! 52117721Speter */ 52217721Speter#define ACPI_DEBUG_EXEC(a) 52317721Speter#define ACPI_DEBUG_ONLY_MEMBERS(a) 52417721Speter#define ACPI_FUNCTION_TRACE(a) 52517721Speter#define ACPI_FUNCTION_TRACE_PTR(a, b) 52617721Speter#define ACPI_FUNCTION_TRACE_U32(a, b) 52717721Speter#define ACPI_FUNCTION_TRACE_STR(a, b) 52817721Speter#define ACPI_FUNCTION_EXIT 52917721Speter#define ACPI_FUNCTION_STATUS_EXIT(s) 53017721Speter#define ACPI_FUNCTION_VALUE_EXIT(s) 53117721Speter#define ACPI_FUNCTION_ENTRY() 53217721Speter#define ACPI_DUMP_STACK_ENTRY(a) 53317721Speter#define ACPI_DUMP_OPERANDS(a, b, c) 53417721Speter#define ACPI_DUMP_ENTRY(a, b) 53517721Speter#define ACPI_DUMP_TABLES(a, b) 53617721Speter#define ACPI_DUMP_PATHNAME(a, b, c, d) 53717721Speter#define ACPI_DUMP_BUFFER(a, b) 53817721Speter#define ACPI_DEBUG_PRINT(pl) 53917721Speter#define ACPI_DEBUG_PRINT_RAW(pl) 54017721Speter 54117721Speter#define return_VOID return 54217721Speter#define return_ACPI_STATUS(s) return(s) 54317721Speter#define return_VALUE(s) return(s) 54417721Speter#define return_UINT8(s) return(s) 54517721Speter#define return_UINT32(s) return(s) 54617721Speter#define return_PTR(s) return(s) 54717721Speter 54817721Speter#endif /* ACPI_DEBUG_OUTPUT */ 54917721Speter 55017721Speter/* 55117721Speter * Some code only gets executed when the debugger is built in. 55217721Speter * Note that this is entirely independent of whether the 55317721Speter * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 55417721Speter */ 55517721Speter#ifdef ACPI_DEBUGGER 55617721Speter#define ACPI_DEBUGGER_EXEC(a) a 55717721Speter#else 55817721Speter#define ACPI_DEBUGGER_EXEC(a) 55917721Speter#endif 56017721Speter 56117721Speter 562/* 563 * Memory allocation tracking (DEBUG ONLY) 564 */ 565#define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 566 567#ifndef ACPI_DBG_TRACK_ALLOCATIONS 568 569/* Memory allocation */ 570 571#define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 572#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 573#define ACPI_FREE(a) AcpiOsFree(a) 574#define ACPI_MEM_TRACKING(a) 575 576#else 577 578/* Memory allocation */ 579 580#define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 581#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 582#define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS) 583#define ACPI_MEM_TRACKING(a) a 584 585#endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 586 587 588/* 589 * Macros used for ACPICA utilities only 590 */ 591 592/* Generate a UUID */ 593 594#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 595 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 596 (b) & 0xFF, ((b) >> 8) & 0xFF, \ 597 (c) & 0xFF, ((c) >> 8) & 0xFF, \ 598 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 599 600#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 601 602 603#endif /* ACMACROS_H */ 604