acmacros.h revision 300879
1203790Sfabient/****************************************************************************** 2233611Sfabient * 3203790Sfabient * Name: acmacros.h - C macros for the entire subsystem. 4203790Sfabient * 5203790Sfabient *****************************************************************************/ 6203790Sfabient 7203790Sfabient/* 8203790Sfabient * Copyright (C) 2000 - 2016, Intel Corp. 9203790Sfabient * All rights reserved. 10203790Sfabient * 11203790Sfabient * Redistribution and use in source and binary forms, with or without 12203790Sfabient * modification, are permitted provided that the following conditions 13203790Sfabient * are met: 14203790Sfabient * 1. Redistributions of source code must retain the above copyright 15203790Sfabient * notice, this list of conditions, and the following disclaimer, 16203790Sfabient * without modification. 17203790Sfabient * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18203790Sfabient * substantially similar to the "NO WARRANTY" disclaimer below 19203790Sfabient * ("Disclaimer") and any redistribution must be conditioned upon 20203790Sfabient * including a substantially similar Disclaimer requirement for further 21203790Sfabient * binary redistribution. 22203790Sfabient * 3. Neither the names of the above-listed copyright holders nor the names 23203790Sfabient * of any contributors may be used to endorse or promote products derived 24203790Sfabient * from this software without specific prior written permission. 25203790Sfabient * 26203790Sfabient * Alternatively, this software may be distributed under the terms of the 27203790Sfabient * GNU General Public License ("GPL") version 2 as published by the Free 28203790Sfabient * Software Foundation. 29203790Sfabient * 30203790Sfabient * NO WARRANTY 31203790Sfabient * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32203790Sfabient * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33203790Sfabient * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34203790Sfabient * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35203790Sfabient * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36203790Sfabient * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37203790Sfabient * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38203790Sfabient * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39203790Sfabient * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40203790Sfabient * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41203790Sfabient * POSSIBILITY OF SUCH DAMAGES. 42203790Sfabient */ 43203790Sfabient 44203790Sfabient#ifndef __ACMACROS_H__ 45203790Sfabient#define __ACMACROS_H__ 46203790Sfabient 47203790Sfabient 48203790Sfabient/* 49203790Sfabient * Extract data using a pointer. Any more than a byte and we 50203790Sfabient * get into potential aligment issues -- see the STORE macros below. 51203790Sfabient * Use with care. 52203790Sfabient */ 53203790Sfabient#define ACPI_CAST8(ptr) ACPI_CAST_PTR (UINT8, (ptr)) 54203790Sfabient#define ACPI_CAST16(ptr) ACPI_CAST_PTR (UINT16, (ptr)) 55203790Sfabient#define ACPI_CAST32(ptr) ACPI_CAST_PTR (UINT32, (ptr)) 56203790Sfabient#define ACPI_CAST64(ptr) ACPI_CAST_PTR (UINT64, (ptr)) 57203790Sfabient#define ACPI_GET8(ptr) (*ACPI_CAST8 (ptr)) 58203790Sfabient#define ACPI_GET16(ptr) (*ACPI_CAST16 (ptr)) 59203790Sfabient#define ACPI_GET32(ptr) (*ACPI_CAST32 (ptr)) 60203790Sfabient#define ACPI_GET64(ptr) (*ACPI_CAST64 (ptr)) 61233611Sfabient#define ACPI_SET8(ptr, val) (*ACPI_CAST8 (ptr) = (UINT8) (val)) 62203790Sfabient#define ACPI_SET16(ptr, val) (*ACPI_CAST16 (ptr) = (UINT16) (val)) 63203790Sfabient#define ACPI_SET32(ptr, val) (*ACPI_CAST32 (ptr) = (UINT32) (val)) 64203790Sfabient#define ACPI_SET64(ptr, val) (*ACPI_CAST64 (ptr) = (UINT64) (val)) 65203790Sfabient 66203790Sfabient/* 67203790Sfabient * printf() format helper. This macros is a workaround for the difficulties 68233611Sfabient * with emitting 64-bit integers and 64-bit pointers with the same code 69203790Sfabient * for both 32-bit and 64-bit hosts. 70203790Sfabient */ 71203790Sfabient#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 72233611Sfabient 73203790Sfabient 74203790Sfabient/* 75203790Sfabient * Macros for moving data around to/from buffers that are possibly unaligned. 76203790Sfabient * If the hardware supports the transfer of unaligned data, just do the store. 77203790Sfabient * Otherwise, we have to move one byte at a time. 78203790Sfabient */ 79203790Sfabient#ifdef ACPI_BIG_ENDIAN 80203790Sfabient/* 81203790Sfabient * Macros for big-endian machines 82203790Sfabient */ 83203790Sfabient 84203790Sfabient/* These macros reverse the bytes during the move, converting little-endian to big endian */ 85203790Sfabient 86203790Sfabient /* Big Endian <== Little Endian */ 87203790Sfabient /* Hi...Lo Lo...Hi */ 88203790Sfabient/* 16-bit source, 16/32/64 destination */ 89203790Sfabient 90203790Sfabient#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 91203790Sfabient (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 92203790Sfabient 93203790Sfabient#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 94203790Sfabient ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 95203790Sfabient ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 96203790Sfabient 97203790Sfabient#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 98233611Sfabient ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 99233611Sfabient ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 100233611Sfabient 101233611Sfabient/* 32-bit source, 16/32/64 destination */ 102233611Sfabient 103203790Sfabient#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 104203790Sfabient 105203790Sfabient#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 106203790Sfabient (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 107203790Sfabient (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 108203790Sfabient (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 109203790Sfabient 110203790Sfabient#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 111203790Sfabient ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 112203790Sfabient ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 113233611Sfabient ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 114233611Sfabient ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 115233611Sfabient 116233611Sfabient/* 64-bit source, 16/32/64 destination */ 117233611Sfabient 118233611Sfabient#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 119233611Sfabient 120233611Sfabient#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 121203790Sfabient 122203790Sfabient#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 123203790Sfabient (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 124203790Sfabient (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 125233611Sfabient (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 126203790Sfabient (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 127203790Sfabient (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 128241737Sed (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 129203790Sfabient (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 130233611Sfabient#else 131233611Sfabient/* 132203790Sfabient * Macros for little-endian machines 133207755Sfabient */ 134207755Sfabient 135207755Sfabient#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 136207755Sfabient 137207755Sfabient/* The hardware supports unaligned transfers, just do the little-endian move */ 138241737Sed 139241737Sed/* 16-bit source, 16/32/64 destination */ 140233611Sfabient 141207755Sfabient#define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 142203790Sfabient#define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 143203790Sfabient#define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 144203790Sfabient 145233611Sfabient/* 32-bit source, 16/32/64 destination */ 146203790Sfabient 147203790Sfabient#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 148203790Sfabient#define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 149203790Sfabient#define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 150203790Sfabient 151203790Sfabient/* 64-bit source, 16/32/64 destination */ 152203790Sfabient 153203790Sfabient#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 154203790Sfabient#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 155203790Sfabient#define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 156203790Sfabient 157203790Sfabient#else 158203790Sfabient/* 159203790Sfabient * The hardware does not support unaligned transfers. We must move the 160203790Sfabient * data one byte at a time. These macros work whether the source or 161203790Sfabient * the destination (or both) is/are unaligned. (Little-endian move) 162203790Sfabient */ 163203790Sfabient 164203790Sfabient/* 16-bit source, 16/32/64 destination */ 165203790Sfabient 166203790Sfabient#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 167203790Sfabient (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 168203790Sfabient 169203790Sfabient#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 170203790Sfabient#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 171203790Sfabient 172203790Sfabient/* 32-bit source, 16/32/64 destination */ 173203790Sfabient 174203790Sfabient#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 175203790Sfabient 176203790Sfabient#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 177203790Sfabient (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 178203790Sfabient (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 179203790Sfabient (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 180203790Sfabient 181203790Sfabient#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 182203790Sfabient 183203790Sfabient/* 64-bit source, 16/32/64 destination */ 184203790Sfabient 185203790Sfabient#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 186203790Sfabient#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 187203790Sfabient#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 188203790Sfabient (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 189203790Sfabient (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 190203790Sfabient (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 191203790Sfabient (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 192203790Sfabient (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 193203790Sfabient (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 194203790Sfabient (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 195203790Sfabient#endif 196203790Sfabient#endif 197203790Sfabient 198203790Sfabient 199203790Sfabient/* 200203790Sfabient * Fast power-of-two math macros for non-optimized compilers 201203790Sfabient */ 202203790Sfabient#define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 203203790Sfabient#define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 204203790Sfabient#define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 205203790Sfabient 206203790Sfabient#define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 207203790Sfabient#define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 208203790Sfabient#define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 209203790Sfabient 210203790Sfabient#define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 211203790Sfabient#define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 212203790Sfabient#define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 213203790Sfabient 214203790Sfabient#define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 215203790Sfabient#define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 216203790Sfabient#define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 217203790Sfabient 218203790Sfabient#define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 219203790Sfabient#define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 220203790Sfabient#define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 221203790Sfabient 222203790Sfabient#define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 223203790Sfabient#define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 224203790Sfabient#define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 225203790Sfabient 226203790Sfabient/* Test for ASCII character */ 227203790Sfabient 228203790Sfabient#define ACPI_IS_ASCII(c) ((c) < 0x80) 229203790Sfabient 230203790Sfabient/* Signed integers */ 231203790Sfabient 232203790Sfabient#define ACPI_SIGN_POSITIVE 0 233203790Sfabient#define ACPI_SIGN_NEGATIVE 1 234203790Sfabient 235203790Sfabient 236203790Sfabient/* 237203790Sfabient * Rounding macros (Power of two boundaries only) 238203790Sfabient */ 239203790Sfabient#define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 240203790Sfabient (~(((ACPI_SIZE) boundary)-1))) 241203790Sfabient 242203790Sfabient#define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 243203790Sfabient (((ACPI_SIZE) boundary)-1)) & \ 244203790Sfabient (~(((ACPI_SIZE) boundary)-1))) 245203790Sfabient 246203790Sfabient/* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 247203790Sfabient 248203790Sfabient#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 249203790Sfabient#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 250203790Sfabient#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 251203790Sfabient 252203790Sfabient#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 253203790Sfabient#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 254203790Sfabient#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 255203790Sfabient 256203790Sfabient#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 257203790Sfabient#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 258203790Sfabient 259203790Sfabient#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 260203790Sfabient 261203790Sfabient/* Generic (non-power-of-two) rounding */ 262203790Sfabient 263203790Sfabient#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 264203790Sfabient 265203790Sfabient#define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 266203790Sfabient 267203790Sfabient/* 268203790Sfabient * Bitmask creation 269233611Sfabient * Bit positions start at zero. 270233611Sfabient * MASK_BITS_ABOVE creates a mask starting AT the position and above 271203790Sfabient * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 272203790Sfabient */ 273203790Sfabient#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position)))) 274203790Sfabient#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position))) 275203790Sfabient 276203790Sfabient/* Bitfields within ACPI registers */ 277203790Sfabient 278203790Sfabient#define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \ 279233611Sfabient ((Val << Pos) & Mask) 280203790Sfabient 281203790Sfabient#define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \ 282203790Sfabient Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 283203790Sfabient 284203790Sfabient#define ACPI_INSERT_BITS(Target, Mask, Source) \ 285203790Sfabient Target = ((Target & (~(Mask))) | (Source & Mask)) 286203790Sfabient 287203790Sfabient/* Generic bitfield macros and masks */ 288203790Sfabient 289233611Sfabient#define ACPI_GET_BITS(SourcePtr, Position, Mask) \ 290203790Sfabient ((*(SourcePtr) >> (Position)) & (Mask)) 291203790Sfabient 292203790Sfabient#define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \ 293203790Sfabient (*(TargetPtr) |= (((Value) & (Mask)) << (Position))) 294203790Sfabient 295203790Sfabient#define ACPI_1BIT_MASK 0x00000001 296203790Sfabient#define ACPI_2BIT_MASK 0x00000003 297203790Sfabient#define ACPI_3BIT_MASK 0x00000007 298233611Sfabient#define ACPI_4BIT_MASK 0x0000000F 299203790Sfabient#define ACPI_5BIT_MASK 0x0000001F 300203790Sfabient#define ACPI_6BIT_MASK 0x0000003F 301203790Sfabient#define ACPI_7BIT_MASK 0x0000007F 302203790Sfabient#define ACPI_8BIT_MASK 0x000000FF 303203790Sfabient#define ACPI_16BIT_MASK 0x0000FFFF 304203790Sfabient#define ACPI_24BIT_MASK 0x00FFFFFF 305203790Sfabient 306203790Sfabient/* Macros to extract flag bits from position zero */ 307233611Sfabient 308233611Sfabient#define ACPI_GET_1BIT_FLAG(Value) ((Value) & ACPI_1BIT_MASK) 309233611Sfabient#define ACPI_GET_2BIT_FLAG(Value) ((Value) & ACPI_2BIT_MASK) 310233611Sfabient#define ACPI_GET_3BIT_FLAG(Value) ((Value) & ACPI_3BIT_MASK) 311203790Sfabient#define ACPI_GET_4BIT_FLAG(Value) ((Value) & ACPI_4BIT_MASK) 312203790Sfabient 313203790Sfabient/* Macros to extract flag bits from position one and above */ 314203790Sfabient 315203790Sfabient#define ACPI_EXTRACT_1BIT_FLAG(Field, Position) (ACPI_GET_1BIT_FLAG ((Field) >> Position)) 316203790Sfabient#define ACPI_EXTRACT_2BIT_FLAG(Field, Position) (ACPI_GET_2BIT_FLAG ((Field) >> Position)) 317203790Sfabient#define ACPI_EXTRACT_3BIT_FLAG(Field, Position) (ACPI_GET_3BIT_FLAG ((Field) >> Position)) 318203790Sfabient#define ACPI_EXTRACT_4BIT_FLAG(Field, Position) (ACPI_GET_4BIT_FLAG ((Field) >> Position)) 319233611Sfabient 320233611Sfabient/* ACPI Pathname helpers */ 321203790Sfabient 322203790Sfabient#define ACPI_IS_ROOT_PREFIX(c) ((c) == (UINT8) 0x5C) /* Backslash */ 323203790Sfabient#define ACPI_IS_PARENT_PREFIX(c) ((c) == (UINT8) 0x5E) /* Carat */ 324203790Sfabient#define ACPI_IS_PATH_SEPARATOR(c) ((c) == (UINT8) 0x2E) /* Period (dot) */ 325203790Sfabient 326203790Sfabient/* 327203790Sfabient * An object of type ACPI_NAMESPACE_NODE can appear in some contexts 328203790Sfabient * where a pointer to an object of type ACPI_OPERAND_OBJECT can also 329203790Sfabient * appear. This macro is used to distinguish them. 330203790Sfabient * 331203790Sfabient * The "DescriptorType" field is the second field in both structures. 332203790Sfabient */ 333203790Sfabient#define ACPI_GET_DESCRIPTOR_PTR(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer) 334203790Sfabient#define ACPI_SET_DESCRIPTOR_PTR(d, p) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p)) 335203790Sfabient#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 336203790Sfabient#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t)) 337203790Sfabient 338203790Sfabient/* 339203790Sfabient * Macros for the master AML opcode table 340203790Sfabient */ 341203790Sfabient#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 342203790Sfabient#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 343203790Sfabient {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 344203790Sfabient#else 345203790Sfabient#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 346203790Sfabient {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 347203790Sfabient#endif 348203790Sfabient 349203790Sfabient#define ARG_TYPE_WIDTH 5 350203790Sfabient#define ARG_1(x) ((UINT32)(x)) 351203790Sfabient#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 352203790Sfabient#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 353203790Sfabient#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 354233611Sfabient#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 355233611Sfabient#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 356203790Sfabient 357233611Sfabient#define ARGI_LIST1(a) (ARG_1(a)) 358203790Sfabient#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 359203790Sfabient#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 360203790Sfabient#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 361203790Sfabient#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 362203790Sfabient#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)) 363203790Sfabient 364203790Sfabient#define ARGP_LIST1(a) (ARG_1(a)) 365203790Sfabient#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 366207755Sfabient#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 367203790Sfabient#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 368207755Sfabient#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 369210766Sfabient#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)) 370203790Sfabient 371233611Sfabient#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 372203790Sfabient#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 373203790Sfabient 374203790Sfabient/* 375203790Sfabient * Ascii error messages can be configured out 376203790Sfabient */ 377203790Sfabient#ifndef ACPI_NO_ERROR_MESSAGES 378203790Sfabient/* 379203790Sfabient * Error reporting. Callers module and line number are inserted by AE_INFO, 380203790Sfabient * the plist contains a set of parens to allow variable-length lists. 381207755Sfabient * These macros are used for both the debug and non-debug versions of the code. 382207755Sfabient */ 383207755Sfabient#define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e); 384203790Sfabient#define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e); 385207755Sfabient#define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 386210766Sfabient#define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist 387210766Sfabient#define ACPI_BIOS_ERROR_PREDEFINED(plist) AcpiUtPredefinedBiosError plist 388233611Sfabient 389233611Sfabient#else 390210766Sfabient 391210766Sfabient/* No error messages */ 392233611Sfabient 393207755Sfabient#define ACPI_ERROR_NAMESPACE(s, e) 394207755Sfabient#define ACPI_ERROR_METHOD(s, n, p, e) 395207755Sfabient#define ACPI_WARN_PREDEFINED(plist) 396210766Sfabient#define ACPI_INFO_PREDEFINED(plist) 397207755Sfabient#define ACPI_BIOS_ERROR_PREDEFINED(plist) 398207755Sfabient 399203790Sfabient#endif /* ACPI_NO_ERROR_MESSAGES */ 400207755Sfabient 401203790Sfabient#if (!ACPI_REDUCED_HARDWARE) 402203790Sfabient#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr 403203790Sfabient#else 404203790Sfabient#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL 405203790Sfabient#endif 406203790Sfabient 407203790Sfabient 408203790Sfabient/* 409233611Sfabient * Macros used for ACPICA utilities only 410203790Sfabient */ 411206090Sfabient 412206090Sfabient/* Generate a UUID */ 413206090Sfabient 414203790Sfabient#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 415203790Sfabient (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 416203790Sfabient (b) & 0xFF, ((b) >> 8) & 0xFF, \ 417203790Sfabient (c) & 0xFF, ((c) >> 8) & 0xFF, \ 418233611Sfabient (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 419233611Sfabient 420203790Sfabient#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 421233611Sfabient 422203790Sfabient 423203790Sfabient#endif /* ACMACROS_H */ 424233611Sfabient