1433d6423SLionel Sambuc /****************************************************************************** 2433d6423SLionel Sambuc * 3433d6423SLionel Sambuc * Name: acmacros.h - C macros for the entire subsystem. 4433d6423SLionel Sambuc * 5433d6423SLionel Sambuc *****************************************************************************/ 6433d6423SLionel Sambuc 7*29492bb7SDavid van Moolenbroek /* 8*29492bb7SDavid van Moolenbroek * Copyright (C) 2000 - 2014, Intel Corp. 9433d6423SLionel Sambuc * All rights reserved. 10433d6423SLionel Sambuc * 11*29492bb7SDavid van Moolenbroek * Redistribution and use in source and binary forms, with or without 12*29492bb7SDavid van Moolenbroek * modification, are permitted provided that the following conditions 13*29492bb7SDavid van Moolenbroek * are met: 14*29492bb7SDavid van Moolenbroek * 1. Redistributions of source code must retain the above copyright 15*29492bb7SDavid van Moolenbroek * notice, this list of conditions, and the following disclaimer, 16*29492bb7SDavid van Moolenbroek * without modification. 17*29492bb7SDavid van Moolenbroek * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18*29492bb7SDavid van Moolenbroek * substantially similar to the "NO WARRANTY" disclaimer below 19*29492bb7SDavid van Moolenbroek * ("Disclaimer") and any redistribution must be conditioned upon 20*29492bb7SDavid van Moolenbroek * including a substantially similar Disclaimer requirement for further 21*29492bb7SDavid van Moolenbroek * binary redistribution. 22*29492bb7SDavid van Moolenbroek * 3. Neither the names of the above-listed copyright holders nor the names 23*29492bb7SDavid van Moolenbroek * of any contributors may be used to endorse or promote products derived 24*29492bb7SDavid van Moolenbroek * from this software without specific prior written permission. 25433d6423SLionel Sambuc * 26*29492bb7SDavid van Moolenbroek * Alternatively, this software may be distributed under the terms of the 27*29492bb7SDavid van Moolenbroek * GNU General Public License ("GPL") version 2 as published by the Free 28*29492bb7SDavid van Moolenbroek * Software Foundation. 29433d6423SLionel Sambuc * 30*29492bb7SDavid van Moolenbroek * NO WARRANTY 31*29492bb7SDavid van Moolenbroek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32*29492bb7SDavid van Moolenbroek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33*29492bb7SDavid van Moolenbroek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34*29492bb7SDavid van Moolenbroek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35*29492bb7SDavid van Moolenbroek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36*29492bb7SDavid van Moolenbroek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37*29492bb7SDavid van Moolenbroek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38*29492bb7SDavid van Moolenbroek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39*29492bb7SDavid van Moolenbroek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40*29492bb7SDavid van Moolenbroek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41*29492bb7SDavid van Moolenbroek * POSSIBILITY OF SUCH DAMAGES. 42*29492bb7SDavid van Moolenbroek */ 43433d6423SLionel Sambuc 44433d6423SLionel Sambuc #ifndef __ACMACROS_H__ 45433d6423SLionel Sambuc #define __ACMACROS_H__ 46433d6423SLionel Sambuc 47433d6423SLionel Sambuc 48433d6423SLionel Sambuc /* 49433d6423SLionel Sambuc * Extract data using a pointer. Any more than a byte and we 50433d6423SLionel Sambuc * get into potential aligment issues -- see the STORE macros below. 51433d6423SLionel Sambuc * Use with care. 52433d6423SLionel Sambuc */ 53*29492bb7SDavid van Moolenbroek #define ACPI_CAST8(ptr) ACPI_CAST_PTR (UINT8, (ptr)) 54*29492bb7SDavid van Moolenbroek #define ACPI_CAST16(ptr) ACPI_CAST_PTR (UINT16, (ptr)) 55*29492bb7SDavid van Moolenbroek #define ACPI_CAST32(ptr) ACPI_CAST_PTR (UINT32, (ptr)) 56*29492bb7SDavid van Moolenbroek #define ACPI_CAST64(ptr) ACPI_CAST_PTR (UINT64, (ptr)) 57*29492bb7SDavid van Moolenbroek #define ACPI_GET8(ptr) (*ACPI_CAST8 (ptr)) 58*29492bb7SDavid van Moolenbroek #define ACPI_GET16(ptr) (*ACPI_CAST16 (ptr)) 59*29492bb7SDavid van Moolenbroek #define ACPI_GET32(ptr) (*ACPI_CAST32 (ptr)) 60*29492bb7SDavid van Moolenbroek #define ACPI_GET64(ptr) (*ACPI_CAST64 (ptr)) 61*29492bb7SDavid van Moolenbroek #define ACPI_SET8(ptr, val) (*ACPI_CAST8 (ptr) = (UINT8) (val)) 62*29492bb7SDavid van Moolenbroek #define ACPI_SET16(ptr, val) (*ACPI_CAST16 (ptr) = (UINT16) (val)) 63*29492bb7SDavid van Moolenbroek #define ACPI_SET32(ptr, val) (*ACPI_CAST32 (ptr) = (UINT32) (val)) 64*29492bb7SDavid van Moolenbroek #define ACPI_SET64(ptr, val) (*ACPI_CAST64 (ptr) = (UINT64) (val)) 65433d6423SLionel Sambuc 66433d6423SLionel Sambuc /* 67*29492bb7SDavid van Moolenbroek * printf() format helpers. These macros are workarounds for the difficulties 68*29492bb7SDavid van Moolenbroek * with emitting 64-bit integers and 64-bit pointers with the same code 69*29492bb7SDavid van Moolenbroek * for both 32-bit and 64-bit hosts. 70433d6423SLionel Sambuc */ 71433d6423SLionel Sambuc #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 72433d6423SLionel Sambuc 73433d6423SLionel Sambuc #if ACPI_MACHINE_WIDTH == 64 74433d6423SLionel Sambuc #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 75*29492bb7SDavid van Moolenbroek #define ACPI_FORMAT_TO_UINT(i) ACPI_FORMAT_UINT64(i) 76*29492bb7SDavid van Moolenbroek #define ACPI_PRINTF_UINT "0x%8.8X%8.8X" 77*29492bb7SDavid van Moolenbroek 78433d6423SLionel Sambuc #else 79*29492bb7SDavid van Moolenbroek #define ACPI_FORMAT_NATIVE_UINT(i) 0, (UINT32) (i) 80*29492bb7SDavid van Moolenbroek #define ACPI_FORMAT_TO_UINT(i) (UINT32) (i) 81*29492bb7SDavid van Moolenbroek #define ACPI_PRINTF_UINT "0x%8.8X" 82433d6423SLionel Sambuc #endif 83433d6423SLionel Sambuc 84433d6423SLionel Sambuc 85433d6423SLionel Sambuc /* 86433d6423SLionel Sambuc * Macros for moving data around to/from buffers that are possibly unaligned. 87433d6423SLionel Sambuc * If the hardware supports the transfer of unaligned data, just do the store. 88433d6423SLionel Sambuc * Otherwise, we have to move one byte at a time. 89433d6423SLionel Sambuc */ 90433d6423SLionel Sambuc #ifdef ACPI_BIG_ENDIAN 91433d6423SLionel Sambuc /* 92433d6423SLionel Sambuc * Macros for big-endian machines 93433d6423SLionel Sambuc */ 94433d6423SLionel Sambuc 95433d6423SLionel Sambuc /* These macros reverse the bytes during the move, converting little-endian to big endian */ 96433d6423SLionel Sambuc 97433d6423SLionel Sambuc /* Big Endian <== Little Endian */ 98433d6423SLionel Sambuc /* Hi...Lo Lo...Hi */ 99433d6423SLionel Sambuc /* 16-bit source, 16/32/64 destination */ 100433d6423SLionel Sambuc 101433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 102433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 103433d6423SLionel Sambuc 104433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 105433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 106433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 107433d6423SLionel Sambuc 108433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 109433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 110433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 111433d6423SLionel Sambuc 112433d6423SLionel Sambuc /* 32-bit source, 16/32/64 destination */ 113433d6423SLionel Sambuc 114433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 115433d6423SLionel Sambuc 116433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 117433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 118433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 119433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 120433d6423SLionel Sambuc 121433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 122433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 123433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 124433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 125433d6423SLionel Sambuc ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 126433d6423SLionel Sambuc 127433d6423SLionel Sambuc /* 64-bit source, 16/32/64 destination */ 128433d6423SLionel Sambuc 129433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 130433d6423SLionel Sambuc 131433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 132433d6423SLionel Sambuc 133433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 134433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 135433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 136433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 137433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 138433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 139433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 140433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 141433d6423SLionel Sambuc #else 142433d6423SLionel Sambuc /* 143433d6423SLionel Sambuc * Macros for little-endian machines 144433d6423SLionel Sambuc */ 145433d6423SLionel Sambuc 146433d6423SLionel Sambuc #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 147433d6423SLionel Sambuc 148433d6423SLionel Sambuc /* The hardware supports unaligned transfers, just do the little-endian move */ 149433d6423SLionel Sambuc 150433d6423SLionel Sambuc /* 16-bit source, 16/32/64 destination */ 151433d6423SLionel Sambuc 152433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 153433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 154433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 155433d6423SLionel Sambuc 156433d6423SLionel Sambuc /* 32-bit source, 16/32/64 destination */ 157433d6423SLionel Sambuc 158433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 159433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 160433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 161433d6423SLionel Sambuc 162433d6423SLionel Sambuc /* 64-bit source, 16/32/64 destination */ 163433d6423SLionel Sambuc 164433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 165433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 166433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 167433d6423SLionel Sambuc 168433d6423SLionel Sambuc #else 169433d6423SLionel Sambuc /* 170433d6423SLionel Sambuc * The hardware does not support unaligned transfers. We must move the 171433d6423SLionel Sambuc * data one byte at a time. These macros work whether the source or 172433d6423SLionel Sambuc * the destination (or both) is/are unaligned. (Little-endian move) 173433d6423SLionel Sambuc */ 174433d6423SLionel Sambuc 175433d6423SLionel Sambuc /* 16-bit source, 16/32/64 destination */ 176433d6423SLionel Sambuc 177433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 178433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 179433d6423SLionel Sambuc 180433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 181433d6423SLionel Sambuc #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 182433d6423SLionel Sambuc 183433d6423SLionel Sambuc /* 32-bit source, 16/32/64 destination */ 184433d6423SLionel Sambuc 185433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 186433d6423SLionel Sambuc 187433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 188433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 189433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 190433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 191433d6423SLionel Sambuc 192433d6423SLionel Sambuc #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 193433d6423SLionel Sambuc 194433d6423SLionel Sambuc /* 64-bit source, 16/32/64 destination */ 195433d6423SLionel Sambuc 196433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 197433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 198433d6423SLionel Sambuc #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 199433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 200433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 201433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 202433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 203433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 204433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 205433d6423SLionel Sambuc (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 206433d6423SLionel Sambuc #endif 207433d6423SLionel Sambuc #endif 208433d6423SLionel Sambuc 209433d6423SLionel Sambuc 210433d6423SLionel Sambuc /* 211433d6423SLionel Sambuc * Fast power-of-two math macros for non-optimized compilers 212433d6423SLionel Sambuc */ 213433d6423SLionel Sambuc #define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 214433d6423SLionel Sambuc #define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 215433d6423SLionel Sambuc #define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 216433d6423SLionel Sambuc 217433d6423SLionel Sambuc #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 218433d6423SLionel Sambuc #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 219433d6423SLionel Sambuc #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 220433d6423SLionel Sambuc 221433d6423SLionel Sambuc #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 222433d6423SLionel Sambuc #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 223433d6423SLionel Sambuc #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 224433d6423SLionel Sambuc 225433d6423SLionel Sambuc #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 226433d6423SLionel Sambuc #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 227433d6423SLionel Sambuc #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 228433d6423SLionel Sambuc 229433d6423SLionel Sambuc #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 230433d6423SLionel Sambuc #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 231433d6423SLionel Sambuc #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 232433d6423SLionel Sambuc 233433d6423SLionel Sambuc #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 234433d6423SLionel Sambuc #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 235433d6423SLionel Sambuc #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 236433d6423SLionel Sambuc 237433d6423SLionel Sambuc /* 238433d6423SLionel Sambuc * Rounding macros (Power of two boundaries only) 239433d6423SLionel Sambuc */ 240433d6423SLionel Sambuc #define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 241433d6423SLionel Sambuc (~(((ACPI_SIZE) boundary)-1))) 242433d6423SLionel Sambuc 243433d6423SLionel Sambuc #define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 244433d6423SLionel Sambuc (((ACPI_SIZE) boundary)-1)) & \ 245433d6423SLionel Sambuc (~(((ACPI_SIZE) boundary)-1))) 246433d6423SLionel Sambuc 247433d6423SLionel Sambuc /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 248433d6423SLionel Sambuc 249433d6423SLionel Sambuc #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 250433d6423SLionel Sambuc #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 251433d6423SLionel Sambuc #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 252433d6423SLionel Sambuc 253433d6423SLionel Sambuc #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 254433d6423SLionel Sambuc #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 255433d6423SLionel Sambuc #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 256433d6423SLionel Sambuc 257433d6423SLionel Sambuc #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 258433d6423SLionel Sambuc #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 259433d6423SLionel Sambuc 260433d6423SLionel Sambuc #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 261433d6423SLionel Sambuc 262433d6423SLionel Sambuc /* Generic (non-power-of-two) rounding */ 263433d6423SLionel Sambuc 264433d6423SLionel Sambuc #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 265433d6423SLionel Sambuc 266433d6423SLionel Sambuc #define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 267433d6423SLionel Sambuc 268433d6423SLionel Sambuc /* 269433d6423SLionel Sambuc * Bitmask creation 270433d6423SLionel Sambuc * Bit positions start at zero. 271433d6423SLionel Sambuc * MASK_BITS_ABOVE creates a mask starting AT the position and above 272433d6423SLionel Sambuc * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 273433d6423SLionel Sambuc */ 274433d6423SLionel Sambuc #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position)))) 275433d6423SLionel Sambuc #define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position))) 276433d6423SLionel Sambuc 277433d6423SLionel Sambuc /* Bitfields within ACPI registers */ 278433d6423SLionel Sambuc 279*29492bb7SDavid van Moolenbroek #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \ 280*29492bb7SDavid van Moolenbroek ((Val << Pos) & Mask) 281433d6423SLionel Sambuc 282*29492bb7SDavid van Moolenbroek #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \ 283*29492bb7SDavid van Moolenbroek Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 284*29492bb7SDavid van Moolenbroek 285*29492bb7SDavid van Moolenbroek #define ACPI_INSERT_BITS(Target, Mask, Source) \ 286*29492bb7SDavid van Moolenbroek Target = ((Target & (~(Mask))) | (Source & Mask)) 287*29492bb7SDavid van Moolenbroek 288*29492bb7SDavid van Moolenbroek /* Generic bitfield macros and masks */ 289*29492bb7SDavid van Moolenbroek 290*29492bb7SDavid van Moolenbroek #define ACPI_GET_BITS(SourcePtr, Position, Mask) \ 291*29492bb7SDavid van Moolenbroek ((*SourcePtr >> Position) & Mask) 292*29492bb7SDavid van Moolenbroek 293*29492bb7SDavid van Moolenbroek #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \ 294*29492bb7SDavid van Moolenbroek (*TargetPtr |= ((Value & Mask) << Position)) 295*29492bb7SDavid van Moolenbroek 296*29492bb7SDavid van Moolenbroek #define ACPI_1BIT_MASK 0x00000001 297*29492bb7SDavid van Moolenbroek #define ACPI_2BIT_MASK 0x00000003 298*29492bb7SDavid van Moolenbroek #define ACPI_3BIT_MASK 0x00000007 299*29492bb7SDavid van Moolenbroek #define ACPI_4BIT_MASK 0x0000000F 300*29492bb7SDavid van Moolenbroek #define ACPI_5BIT_MASK 0x0000001F 301*29492bb7SDavid van Moolenbroek #define ACPI_6BIT_MASK 0x0000003F 302*29492bb7SDavid van Moolenbroek #define ACPI_7BIT_MASK 0x0000007F 303*29492bb7SDavid van Moolenbroek #define ACPI_8BIT_MASK 0x000000FF 304*29492bb7SDavid van Moolenbroek #define ACPI_16BIT_MASK 0x0000FFFF 305*29492bb7SDavid van Moolenbroek #define ACPI_24BIT_MASK 0x00FFFFFF 306*29492bb7SDavid van Moolenbroek 307*29492bb7SDavid van Moolenbroek /* Macros to extract flag bits from position zero */ 308*29492bb7SDavid van Moolenbroek 309*29492bb7SDavid van Moolenbroek #define ACPI_GET_1BIT_FLAG(Value) ((Value) & ACPI_1BIT_MASK) 310*29492bb7SDavid van Moolenbroek #define ACPI_GET_2BIT_FLAG(Value) ((Value) & ACPI_2BIT_MASK) 311*29492bb7SDavid van Moolenbroek #define ACPI_GET_3BIT_FLAG(Value) ((Value) & ACPI_3BIT_MASK) 312*29492bb7SDavid van Moolenbroek #define ACPI_GET_4BIT_FLAG(Value) ((Value) & ACPI_4BIT_MASK) 313*29492bb7SDavid van Moolenbroek 314*29492bb7SDavid van Moolenbroek /* Macros to extract flag bits from position one and above */ 315*29492bb7SDavid van Moolenbroek 316*29492bb7SDavid van Moolenbroek #define ACPI_EXTRACT_1BIT_FLAG(Field, Position) (ACPI_GET_1BIT_FLAG ((Field) >> Position)) 317*29492bb7SDavid van Moolenbroek #define ACPI_EXTRACT_2BIT_FLAG(Field, Position) (ACPI_GET_2BIT_FLAG ((Field) >> Position)) 318*29492bb7SDavid van Moolenbroek #define ACPI_EXTRACT_3BIT_FLAG(Field, Position) (ACPI_GET_3BIT_FLAG ((Field) >> Position)) 319*29492bb7SDavid van Moolenbroek #define ACPI_EXTRACT_4BIT_FLAG(Field, Position) (ACPI_GET_4BIT_FLAG ((Field) >> Position)) 320*29492bb7SDavid van Moolenbroek 321*29492bb7SDavid van Moolenbroek /* ACPI Pathname helpers */ 322*29492bb7SDavid van Moolenbroek 323*29492bb7SDavid van Moolenbroek #define ACPI_IS_ROOT_PREFIX(c) ((c) == (UINT8) 0x5C) /* Backslash */ 324*29492bb7SDavid van Moolenbroek #define ACPI_IS_PARENT_PREFIX(c) ((c) == (UINT8) 0x5E) /* Carat */ 325*29492bb7SDavid van Moolenbroek #define ACPI_IS_PATH_SEPARATOR(c) ((c) == (UINT8) 0x2E) /* Period (dot) */ 326433d6423SLionel Sambuc 327433d6423SLionel Sambuc /* 328*29492bb7SDavid van Moolenbroek * An object of type ACPI_NAMESPACE_NODE can appear in some contexts 329*29492bb7SDavid van Moolenbroek * where a pointer to an object of type ACPI_OPERAND_OBJECT can also 330433d6423SLionel Sambuc * appear. This macro is used to distinguish them. 331433d6423SLionel Sambuc * 332*29492bb7SDavid van Moolenbroek * The "DescriptorType" field is the second field in both structures. 333433d6423SLionel Sambuc */ 334*29492bb7SDavid van Moolenbroek #define ACPI_GET_DESCRIPTOR_PTR(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer) 335*29492bb7SDavid van Moolenbroek #define ACPI_SET_DESCRIPTOR_PTR(d, p) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p)) 336433d6423SLionel Sambuc #define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 337*29492bb7SDavid van Moolenbroek #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t)) 338433d6423SLionel Sambuc 339433d6423SLionel Sambuc /* 340433d6423SLionel Sambuc * Macros for the master AML opcode table 341433d6423SLionel Sambuc */ 342433d6423SLionel Sambuc #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 343433d6423SLionel Sambuc #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 344433d6423SLionel Sambuc {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 345433d6423SLionel Sambuc #else 346433d6423SLionel Sambuc #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 347433d6423SLionel Sambuc {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 348433d6423SLionel Sambuc #endif 349433d6423SLionel Sambuc 350433d6423SLionel Sambuc #define ARG_TYPE_WIDTH 5 351433d6423SLionel Sambuc #define ARG_1(x) ((UINT32)(x)) 352433d6423SLionel Sambuc #define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 353433d6423SLionel Sambuc #define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 354433d6423SLionel Sambuc #define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 355433d6423SLionel Sambuc #define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 356433d6423SLionel Sambuc #define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 357433d6423SLionel Sambuc 358433d6423SLionel Sambuc #define ARGI_LIST1(a) (ARG_1(a)) 359433d6423SLionel Sambuc #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 360433d6423SLionel Sambuc #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 361433d6423SLionel Sambuc #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 362433d6423SLionel Sambuc #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 363433d6423SLionel Sambuc #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)) 364433d6423SLionel Sambuc 365433d6423SLionel Sambuc #define ARGP_LIST1(a) (ARG_1(a)) 366433d6423SLionel Sambuc #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 367433d6423SLionel Sambuc #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 368433d6423SLionel Sambuc #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 369433d6423SLionel Sambuc #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 370433d6423SLionel Sambuc #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)) 371433d6423SLionel Sambuc 372433d6423SLionel Sambuc #define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 373433d6423SLionel Sambuc #define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 374433d6423SLionel Sambuc 375433d6423SLionel Sambuc /* 376433d6423SLionel Sambuc * Ascii error messages can be configured out 377433d6423SLionel Sambuc */ 378433d6423SLionel Sambuc #ifndef ACPI_NO_ERROR_MESSAGES 379433d6423SLionel Sambuc /* 380433d6423SLionel Sambuc * Error reporting. Callers module and line number are inserted by AE_INFO, 381433d6423SLionel Sambuc * the plist contains a set of parens to allow variable-length lists. 382433d6423SLionel Sambuc * These macros are used for both the debug and non-debug versions of the code. 383433d6423SLionel Sambuc */ 384*29492bb7SDavid van Moolenbroek #define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e); 385*29492bb7SDavid van Moolenbroek #define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e); 386433d6423SLionel Sambuc #define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 387433d6423SLionel Sambuc #define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist 388*29492bb7SDavid van Moolenbroek #define ACPI_BIOS_ERROR_PREDEFINED(plist) AcpiUtPredefinedBiosError plist 389433d6423SLionel Sambuc 390433d6423SLionel Sambuc #else 391433d6423SLionel Sambuc 392433d6423SLionel Sambuc /* No error messages */ 393433d6423SLionel Sambuc 394433d6423SLionel Sambuc #define ACPI_ERROR_NAMESPACE(s, e) 395433d6423SLionel Sambuc #define ACPI_ERROR_METHOD(s, n, p, e) 396433d6423SLionel Sambuc #define ACPI_WARN_PREDEFINED(plist) 397433d6423SLionel Sambuc #define ACPI_INFO_PREDEFINED(plist) 398*29492bb7SDavid van Moolenbroek #define ACPI_BIOS_ERROR_PREDEFINED(plist) 399433d6423SLionel Sambuc 400433d6423SLionel Sambuc #endif /* ACPI_NO_ERROR_MESSAGES */ 401433d6423SLionel Sambuc 402*29492bb7SDavid van Moolenbroek #if (!ACPI_REDUCED_HARDWARE) 403*29492bb7SDavid van Moolenbroek #define ACPI_HW_OPTIONAL_FUNCTION(addr) addr 404433d6423SLionel Sambuc #else 405*29492bb7SDavid van Moolenbroek #define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL 406433d6423SLionel Sambuc #endif 407433d6423SLionel Sambuc 408433d6423SLionel Sambuc 409433d6423SLionel Sambuc /* 410433d6423SLionel Sambuc * Some code only gets executed when the debugger is built in. 411433d6423SLionel Sambuc * Note that this is entirely independent of whether the 412433d6423SLionel Sambuc * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 413433d6423SLionel Sambuc */ 414433d6423SLionel Sambuc #ifdef ACPI_DEBUGGER 415433d6423SLionel Sambuc #define ACPI_DEBUGGER_EXEC(a) a 416433d6423SLionel Sambuc #else 417433d6423SLionel Sambuc #define ACPI_DEBUGGER_EXEC(a) 418433d6423SLionel Sambuc #endif 419433d6423SLionel Sambuc 420433d6423SLionel Sambuc 421433d6423SLionel Sambuc /* 422433d6423SLionel Sambuc * Macros used for ACPICA utilities only 423433d6423SLionel Sambuc */ 424433d6423SLionel Sambuc 425433d6423SLionel Sambuc /* Generate a UUID */ 426433d6423SLionel Sambuc 427433d6423SLionel Sambuc #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 428433d6423SLionel Sambuc (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 429433d6423SLionel Sambuc (b) & 0xFF, ((b) >> 8) & 0xFF, \ 430433d6423SLionel Sambuc (c) & 0xFF, ((c) >> 8) & 0xFF, \ 431433d6423SLionel Sambuc (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 432433d6423SLionel Sambuc 433433d6423SLionel Sambuc #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 434433d6423SLionel Sambuc 435433d6423SLionel Sambuc 436433d6423SLionel Sambuc #endif /* ACMACROS_H */ 437