167754Smsmith/****************************************************************************** 267754Smsmith * 367754Smsmith * Name: acmacros.h - C macros for the entire subsystem. 467754Smsmith * 567754Smsmith *****************************************************************************/ 667754Smsmith 7217365Sjkim/* 8245582Sjkim * Copyright (C) 2000 - 2013, Intel Corp. 970243Smsmith * All rights reserved. 1067754Smsmith * 11217365Sjkim * Redistribution and use in source and binary forms, with or without 12217365Sjkim * modification, are permitted provided that the following conditions 13217365Sjkim * are met: 14217365Sjkim * 1. Redistributions of source code must retain the above copyright 15217365Sjkim * notice, this list of conditions, and the following disclaimer, 16217365Sjkim * without modification. 17217365Sjkim * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18217365Sjkim * substantially similar to the "NO WARRANTY" disclaimer below 19217365Sjkim * ("Disclaimer") and any redistribution must be conditioned upon 20217365Sjkim * including a substantially similar Disclaimer requirement for further 21217365Sjkim * binary redistribution. 22217365Sjkim * 3. Neither the names of the above-listed copyright holders nor the names 23217365Sjkim * of any contributors may be used to endorse or promote products derived 24217365Sjkim * from this software without specific prior written permission. 2567754Smsmith * 26217365Sjkim * Alternatively, this software may be distributed under the terms of the 27217365Sjkim * GNU General Public License ("GPL") version 2 as published by the Free 28217365Sjkim * Software Foundation. 2967754Smsmith * 30217365Sjkim * NO WARRANTY 31217365Sjkim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32217365Sjkim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33217365Sjkim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34217365Sjkim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35217365Sjkim * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36217365Sjkim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37217365Sjkim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38217365Sjkim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39217365Sjkim * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40217365Sjkim * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41217365Sjkim * POSSIBILITY OF SUCH DAMAGES. 42217365Sjkim */ 4367754Smsmith 4467754Smsmith#ifndef __ACMACROS_H__ 4567754Smsmith#define __ACMACROS_H__ 4667754Smsmith 4780062Smsmith 4867754Smsmith/* 49193267Sjkim * Extract data using a pointer. Any more than a byte and we 50167802Sjkim * get into potential aligment issues -- see the STORE macros below. 51167802Sjkim * Use with care. 52123315Snjl */ 53243347Sjkim#define ACPI_CAST8(ptr) ACPI_CAST_PTR (UINT8, (ptr)) 54243347Sjkim#define ACPI_CAST16(ptr) ACPI_CAST_PTR (UINT16, (ptr)) 55243347Sjkim#define ACPI_CAST32(ptr) ACPI_CAST_PTR (UINT32, (ptr)) 56243347Sjkim#define ACPI_CAST64(ptr) ACPI_CAST_PTR (UINT64, (ptr)) 57243347Sjkim#define ACPI_GET8(ptr) (*ACPI_CAST8 (ptr)) 58243347Sjkim#define ACPI_GET16(ptr) (*ACPI_CAST16 (ptr)) 59243347Sjkim#define ACPI_GET32(ptr) (*ACPI_CAST32 (ptr)) 60243347Sjkim#define ACPI_GET64(ptr) (*ACPI_CAST64 (ptr)) 61243347Sjkim#define ACPI_SET8(ptr, val) (*ACPI_CAST8 (ptr) = (UINT8) (val)) 62243347Sjkim#define ACPI_SET16(ptr, val) (*ACPI_CAST16 (ptr) = (UINT16) (val)) 63243347Sjkim#define ACPI_SET32(ptr, val) (*ACPI_CAST32 (ptr) = (UINT32) (val)) 64243347Sjkim#define ACPI_SET64(ptr, val) (*ACPI_CAST64 (ptr) = (UINT64) (val)) 6567754Smsmith 66167802Sjkim/* 67193267Sjkim * printf() format helpers 68167802Sjkim */ 6967754Smsmith 70193267Sjkim/* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */ 7177424Smsmith 72193267Sjkim#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 7391116Smsmith 74193267Sjkim#if ACPI_MACHINE_WIDTH == 64 75193267Sjkim#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 7691116Smsmith#else 77193267Sjkim#define ACPI_FORMAT_NATIVE_UINT(i) 0, (i) 7891116Smsmith#endif 7991116Smsmith 80193267Sjkim 8167754Smsmith/* 8267754Smsmith * Macros for moving data around to/from buffers that are possibly unaligned. 8367754Smsmith * If the hardware supports the transfer of unaligned data, just do the store. 8467754Smsmith * Otherwise, we have to move one byte at a time. 8567754Smsmith */ 86117521Snjl#ifdef ACPI_BIG_ENDIAN 87117521Snjl/* 88117521Snjl * Macros for big-endian machines 89117521Snjl */ 9067754Smsmith 91117521Snjl/* These macros reverse the bytes during the move, converting little-endian to big endian */ 92117521Snjl 93117521Snjl /* Big Endian <== Little Endian */ 94117521Snjl /* Hi...Lo Lo...Hi */ 95117521Snjl/* 16-bit source, 16/32/64 destination */ 96117521Snjl 97193267Sjkim#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\ 98117521Snjl (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];} 99117521Snjl 100193267Sjkim#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 101117521Snjl ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 102117521Snjl ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 103117521Snjl 104193267Sjkim#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 105117521Snjl ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 106117521Snjl ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 107117521Snjl 108117521Snjl/* 32-bit source, 16/32/64 destination */ 109117521Snjl 110193267Sjkim#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 111117521Snjl 112193267Sjkim#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\ 113117521Snjl (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\ 114117521Snjl (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\ 115117521Snjl (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];} 116117521Snjl 117193267Sjkim#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 118117521Snjl ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 119117521Snjl ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 120117521Snjl ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 121117521Snjl ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 122117521Snjl 123117521Snjl/* 64-bit source, 16/32/64 destination */ 124117521Snjl 125193267Sjkim#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 126117521Snjl 127193267Sjkim#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 128117521Snjl 129193267Sjkim#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\ 130117521Snjl (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\ 131117521Snjl (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\ 132117521Snjl (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\ 133117521Snjl (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\ 134117521Snjl (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\ 135117521Snjl (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\ 136117521Snjl (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];} 13767754Smsmith#else 13867754Smsmith/* 139117521Snjl * Macros for little-endian machines 140117521Snjl */ 141117521Snjl 142151937Sjkim#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 143117521Snjl 144117521Snjl/* The hardware supports unaligned transfers, just do the little-endian move */ 145117521Snjl 146117521Snjl/* 16-bit source, 16/32/64 destination */ 147117521Snjl 148193267Sjkim#define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s) 149193267Sjkim#define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s) 150193267Sjkim#define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s) 151117521Snjl 152117521Snjl/* 32-bit source, 16/32/64 destination */ 153117521Snjl 154193267Sjkim#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 155193267Sjkim#define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s) 156193267Sjkim#define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s) 157117521Snjl 158117521Snjl/* 64-bit source, 16/32/64 destination */ 159117521Snjl 160193267Sjkim#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 161193267Sjkim#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 162193267Sjkim#define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s) 163117521Snjl 164117521Snjl#else 165117521Snjl/* 166193267Sjkim * The hardware does not support unaligned transfers. We must move the 167193267Sjkim * data one byte at a time. These macros work whether the source or 168193267Sjkim * the destination (or both) is/are unaligned. (Little-endian move) 16967754Smsmith */ 17067754Smsmith 171117521Snjl/* 16-bit source, 16/32/64 destination */ 17267754Smsmith 173193267Sjkim#define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 174117521Snjl (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];} 17567754Smsmith 176193267Sjkim#define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 177193267Sjkim#define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 17867754Smsmith 179117521Snjl/* 32-bit source, 16/32/64 destination */ 18077424Smsmith 181193267Sjkim#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 182117521Snjl 183193267Sjkim#define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 184117521Snjl (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 185117521Snjl (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 186117521Snjl (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];} 187117521Snjl 188193267Sjkim#define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 189117521Snjl 190117521Snjl/* 64-bit source, 16/32/64 destination */ 191117521Snjl 192193267Sjkim#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 193193267Sjkim#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 194193267Sjkim#define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\ 195117521Snjl (( UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\ 196117521Snjl (( UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\ 197117521Snjl (( UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\ 198117521Snjl (( UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\ 199117521Snjl (( UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\ 200117521Snjl (( UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\ 201117521Snjl (( UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];} 20267754Smsmith#endif 203117521Snjl#endif 20467754Smsmith 20567754Smsmith 20667754Smsmith/* 20767754Smsmith * Fast power-of-two math macros for non-optimized compilers 20867754Smsmith */ 209193267Sjkim#define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 210193267Sjkim#define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 211193267Sjkim#define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 21267754Smsmith 213193267Sjkim#define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 214193267Sjkim#define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 215193267Sjkim#define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 21667754Smsmith 217193267Sjkim#define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 218193267Sjkim#define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 219193267Sjkim#define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 22067754Smsmith 221193267Sjkim#define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 222193267Sjkim#define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 223193267Sjkim#define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 22467754Smsmith 225193267Sjkim#define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 226193267Sjkim#define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 227193267Sjkim#define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 22867754Smsmith 229193267Sjkim#define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 230193267Sjkim#define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 231193267Sjkim#define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 23267754Smsmith 23367754Smsmith/* 23467754Smsmith * Rounding macros (Power of two boundaries only) 23567754Smsmith */ 236193267Sjkim#define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 237193267Sjkim (~(((ACPI_SIZE) boundary)-1))) 23867754Smsmith 239193267Sjkim#define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 240193267Sjkim (((ACPI_SIZE) boundary)-1)) & \ 241193267Sjkim (~(((ACPI_SIZE) boundary)-1))) 24267754Smsmith 243193267Sjkim/* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 24467754Smsmith 245193267Sjkim#define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 246193267Sjkim#define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 247193267Sjkim#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 24867754Smsmith 249193267Sjkim#define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 250193267Sjkim#define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 251193267Sjkim#define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 25277424Smsmith 253167802Sjkim#define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 254167802Sjkim#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 25569450Smsmith 256167802Sjkim#define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 257167802Sjkim 25877424Smsmith/* Generic (non-power-of-two) rounding */ 25977424Smsmith 260193267Sjkim#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 26177424Smsmith 262193267Sjkim#define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 263167802Sjkim 26483174Smsmith/* 26577424Smsmith * Bitmask creation 26677424Smsmith * Bit positions start at zero. 26777424Smsmith * MASK_BITS_ABOVE creates a mask starting AT the position and above 26877424Smsmith * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 26977424Smsmith */ 270202771Sjkim#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position)))) 271202771Sjkim#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position))) 27277424Smsmith 27391116Smsmith/* Bitfields within ACPI registers */ 27491116Smsmith 275239340Sjkim#define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \ 276239340Sjkim ((Val << Pos) & Mask) 27791116Smsmith 278239340Sjkim#define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \ 279239340Sjkim Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 280167802Sjkim 281239340Sjkim#define ACPI_INSERT_BITS(Target, Mask, Source) \ 282239340Sjkim Target = ((Target & (~(Mask))) | (Source & Mask)) 283239340Sjkim 284239340Sjkim/* Generic bitfield macros and masks */ 285239340Sjkim 286239340Sjkim#define ACPI_GET_BITS(SourcePtr, Position, Mask) \ 287239340Sjkim ((*SourcePtr >> Position) & Mask) 288239340Sjkim 289239340Sjkim#define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \ 290239340Sjkim (*TargetPtr |= ((Value & Mask) << Position)) 291239340Sjkim 292239340Sjkim#define ACPI_1BIT_MASK 0x00000001 293239340Sjkim#define ACPI_2BIT_MASK 0x00000003 294239340Sjkim#define ACPI_3BIT_MASK 0x00000007 295239340Sjkim#define ACPI_4BIT_MASK 0x0000000F 296239340Sjkim#define ACPI_5BIT_MASK 0x0000001F 297239340Sjkim#define ACPI_6BIT_MASK 0x0000003F 298239340Sjkim#define ACPI_7BIT_MASK 0x0000007F 299239340Sjkim#define ACPI_8BIT_MASK 0x000000FF 300239340Sjkim#define ACPI_16BIT_MASK 0x0000FFFF 301239340Sjkim#define ACPI_24BIT_MASK 0x00FFFFFF 302239340Sjkim 303243347Sjkim/* Macros to extract flag bits from position zero */ 304243347Sjkim 305243347Sjkim#define ACPI_GET_1BIT_FLAG(Value) ((Value) & ACPI_1BIT_MASK) 306243347Sjkim#define ACPI_GET_2BIT_FLAG(Value) ((Value) & ACPI_2BIT_MASK) 307243347Sjkim#define ACPI_GET_3BIT_FLAG(Value) ((Value) & ACPI_3BIT_MASK) 308243347Sjkim#define ACPI_GET_4BIT_FLAG(Value) ((Value) & ACPI_4BIT_MASK) 309243347Sjkim 310243347Sjkim/* Macros to extract flag bits from position one and above */ 311243347Sjkim 312243347Sjkim#define ACPI_EXTRACT_1BIT_FLAG(Field, Position) (ACPI_GET_1BIT_FLAG ((Field) >> Position)) 313243347Sjkim#define ACPI_EXTRACT_2BIT_FLAG(Field, Position) (ACPI_GET_2BIT_FLAG ((Field) >> Position)) 314243347Sjkim#define ACPI_EXTRACT_3BIT_FLAG(Field, Position) (ACPI_GET_3BIT_FLAG ((Field) >> Position)) 315243347Sjkim#define ACPI_EXTRACT_4BIT_FLAG(Field, Position) (ACPI_GET_4BIT_FLAG ((Field) >> Position)) 316243347Sjkim 317245582Sjkim/* ACPI Pathname helpers */ 318245582Sjkim 319245582Sjkim#define ACPI_IS_ROOT_PREFIX(c) ((c) == (UINT8) 0x5C) /* Backslash */ 320245582Sjkim#define ACPI_IS_PARENT_PREFIX(c) ((c) == (UINT8) 0x5E) /* Carat */ 321245582Sjkim#define ACPI_IS_PATH_SEPARATOR(c) ((c) == (UINT8) 0x2E) /* Period (dot) */ 322245582Sjkim 32367754Smsmith/* 324238381Sjkim * An object of type ACPI_NAMESPACE_NODE can appear in some contexts 325238381Sjkim * where a pointer to an object of type ACPI_OPERAND_OBJECT can also 326193267Sjkim * appear. This macro is used to distinguish them. 32767754Smsmith * 328246040Sjkim * The "DescriptorType" field is the second field in both structures. 32967754Smsmith */ 330246040Sjkim#define ACPI_GET_DESCRIPTOR_PTR(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer) 331246040Sjkim#define ACPI_SET_DESCRIPTOR_PTR(d, p) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p)) 332167802Sjkim#define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 333246040Sjkim#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t)) 33467754Smsmith 33567754Smsmith/* 33667754Smsmith * Macros for the master AML opcode table 33767754Smsmith */ 338193267Sjkim#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 339193267Sjkim#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 340193267Sjkim {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 34167754Smsmith#else 342193267Sjkim#define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 343193267Sjkim {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 34467754Smsmith#endif 34567754Smsmith 34667754Smsmith#define ARG_TYPE_WIDTH 5 34767754Smsmith#define ARG_1(x) ((UINT32)(x)) 34867754Smsmith#define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 34967754Smsmith#define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 35067754Smsmith#define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 35167754Smsmith#define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 35267754Smsmith#define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 35367754Smsmith 35467754Smsmith#define ARGI_LIST1(a) (ARG_1(a)) 355193267Sjkim#define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 356193267Sjkim#define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 357193267Sjkim#define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 358193267Sjkim#define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 359193267Sjkim#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)) 36067754Smsmith 36167754Smsmith#define ARGP_LIST1(a) (ARG_1(a)) 362193267Sjkim#define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 363193267Sjkim#define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 364193267Sjkim#define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 365193267Sjkim#define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 366193267Sjkim#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)) 36767754Smsmith 36867754Smsmith#define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 36967754Smsmith#define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 37067754Smsmith 37167754Smsmith/* 372167802Sjkim * Ascii error messages can be configured out 37367754Smsmith */ 374167802Sjkim#ifndef ACPI_NO_ERROR_MESSAGES 375167802Sjkim/* 376167802Sjkim * Error reporting. Callers module and line number are inserted by AE_INFO, 377167802Sjkim * the plist contains a set of parens to allow variable-length lists. 378167802Sjkim * These macros are used for both the debug and non-debug versions of the code. 379167802Sjkim */ 380249663Sjkim#define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e); 381249663Sjkim#define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e); 382249663Sjkim#define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 383249663Sjkim#define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist 384249663Sjkim#define ACPI_BIOS_ERROR_PREDEFINED(plist) AcpiUtPredefinedBiosError plist 38567754Smsmith 38667754Smsmith#else 38767754Smsmith 388167802Sjkim/* No error messages */ 38967754Smsmith 390193267Sjkim#define ACPI_ERROR_NAMESPACE(s, e) 391193267Sjkim#define ACPI_ERROR_METHOD(s, n, p, e) 392197104Sjkim#define ACPI_WARN_PREDEFINED(plist) 393199337Sjkim#define ACPI_INFO_PREDEFINED(plist) 394249663Sjkim#define ACPI_BIOS_ERROR_PREDEFINED(plist) 39567754Smsmith 396193267Sjkim#endif /* ACPI_NO_ERROR_MESSAGES */ 397193267Sjkim 398231844Sjkim#if (!ACPI_REDUCED_HARDWARE) 399231844Sjkim#define ACPI_HW_OPTIONAL_FUNCTION(addr) addr 400231844Sjkim#else 401231844Sjkim#define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL 402231844Sjkim#endif 403231844Sjkim 404231844Sjkim 40567754Smsmith/* 40667754Smsmith * Some code only gets executed when the debugger is built in. 40767754Smsmith * Note that this is entirely independent of whether the 408102550Siwasaki * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 40967754Smsmith */ 410102550Siwasaki#ifdef ACPI_DEBUGGER 41191116Smsmith#define ACPI_DEBUGGER_EXEC(a) a 41267754Smsmith#else 41391116Smsmith#define ACPI_DEBUGGER_EXEC(a) 41467754Smsmith#endif 41567754Smsmith 41667754Smsmith 41767754Smsmith/* 418193267Sjkim * Memory allocation tracking (DEBUG ONLY) 41967754Smsmith */ 420193267Sjkim#define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 42167754Smsmith 42280062Smsmith#ifndef ACPI_DBG_TRACK_ALLOCATIONS 42377424Smsmith 42480062Smsmith/* Memory allocation */ 42577424Smsmith 426193267Sjkim#define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 427193267Sjkim#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 428167802Sjkim#define ACPI_FREE(a) AcpiOsFree(a) 42982367Smsmith#define ACPI_MEM_TRACKING(a) 43080062Smsmith 43177424Smsmith#else 43277424Smsmith 43380062Smsmith/* Memory allocation */ 43480062Smsmith 435193267Sjkim#define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 436193267Sjkim#define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 437193267Sjkim#define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS) 438167802Sjkim#define ACPI_MEM_TRACKING(a) a 43980062Smsmith 44080062Smsmith#endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 44177424Smsmith 442193267Sjkim 443193267Sjkim/* 444193267Sjkim * Macros used for ACPICA utilities only 445193267Sjkim */ 446193267Sjkim 447193267Sjkim/* Generate a UUID */ 448193267Sjkim 449193267Sjkim#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 450193267Sjkim (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 451193267Sjkim (b) & 0xFF, ((b) >> 8) & 0xFF, \ 452193267Sjkim (c) & 0xFF, ((c) >> 8) & 0xFF, \ 453193267Sjkim (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 454193267Sjkim 455193267Sjkim#define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 456193267Sjkim 457193267Sjkim 45867754Smsmith#endif /* ACMACROS_H */ 459