acmacros.h revision 1.3.2.2
1 1.3.2.2 bouyer /****************************************************************************** 2 1.3.2.2 bouyer * 3 1.3.2.2 bouyer * Name: acmacros.h - C macros for the entire subsystem. 4 1.3.2.2 bouyer * 5 1.3.2.2 bouyer *****************************************************************************/ 6 1.3.2.2 bouyer 7 1.3.2.2 bouyer /* 8 1.3.2.2 bouyer * Copyright (C) 2000 - 2011, Intel Corp. 9 1.3.2.2 bouyer * All rights reserved. 10 1.3.2.2 bouyer * 11 1.3.2.2 bouyer * Redistribution and use in source and binary forms, with or without 12 1.3.2.2 bouyer * modification, are permitted provided that the following conditions 13 1.3.2.2 bouyer * are met: 14 1.3.2.2 bouyer * 1. Redistributions of source code must retain the above copyright 15 1.3.2.2 bouyer * notice, this list of conditions, and the following disclaimer, 16 1.3.2.2 bouyer * without modification. 17 1.3.2.2 bouyer * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 1.3.2.2 bouyer * substantially similar to the "NO WARRANTY" disclaimer below 19 1.3.2.2 bouyer * ("Disclaimer") and any redistribution must be conditioned upon 20 1.3.2.2 bouyer * including a substantially similar Disclaimer requirement for further 21 1.3.2.2 bouyer * binary redistribution. 22 1.3.2.2 bouyer * 3. Neither the names of the above-listed copyright holders nor the names 23 1.3.2.2 bouyer * of any contributors may be used to endorse or promote products derived 24 1.3.2.2 bouyer * from this software without specific prior written permission. 25 1.3.2.2 bouyer * 26 1.3.2.2 bouyer * Alternatively, this software may be distributed under the terms of the 27 1.3.2.2 bouyer * GNU General Public License ("GPL") version 2 as published by the Free 28 1.3.2.2 bouyer * Software Foundation. 29 1.3.2.2 bouyer * 30 1.3.2.2 bouyer * NO WARRANTY 31 1.3.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 1.3.2.2 bouyer * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 1.3.2.2 bouyer * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 1.3.2.2 bouyer * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 1.3.2.2 bouyer * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 1.3.2.2 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 1.3.2.2 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 1.3.2.2 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 1.3.2.2 bouyer * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 1.3.2.2 bouyer * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 1.3.2.2 bouyer * POSSIBILITY OF SUCH DAMAGES. 42 1.3.2.2 bouyer */ 43 1.3.2.2 bouyer 44 1.3.2.2 bouyer #ifndef __ACMACROS_H__ 45 1.3.2.2 bouyer #define __ACMACROS_H__ 46 1.3.2.2 bouyer 47 1.3.2.2 bouyer 48 1.3.2.2 bouyer /* 49 1.3.2.2 bouyer * Extract data using a pointer. Any more than a byte and we 50 1.3.2.2 bouyer * get into potential aligment issues -- see the STORE macros below. 51 1.3.2.2 bouyer * Use with care. 52 1.3.2.2 bouyer */ 53 1.3.2.2 bouyer #define ACPI_GET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 54 1.3.2.2 bouyer #define ACPI_GET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 55 1.3.2.2 bouyer #define ACPI_GET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 56 1.3.2.2 bouyer #define ACPI_GET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 57 1.3.2.2 bouyer #define ACPI_SET8(ptr) *ACPI_CAST_PTR (UINT8, ptr) 58 1.3.2.2 bouyer #define ACPI_SET16(ptr) *ACPI_CAST_PTR (UINT16, ptr) 59 1.3.2.2 bouyer #define ACPI_SET32(ptr) *ACPI_CAST_PTR (UINT32, ptr) 60 1.3.2.2 bouyer #define ACPI_SET64(ptr) *ACPI_CAST_PTR (UINT64, ptr) 61 1.3.2.2 bouyer 62 1.3.2.2 bouyer /* 63 1.3.2.2 bouyer * printf() format helpers 64 1.3.2.2 bouyer */ 65 1.3.2.2 bouyer 66 1.3.2.2 bouyer /* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */ 67 1.3.2.2 bouyer 68 1.3.2.2 bouyer #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) 69 1.3.2.2 bouyer 70 1.3.2.2 bouyer #if ACPI_MACHINE_WIDTH == 64 71 1.3.2.2 bouyer #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) 72 1.3.2.2 bouyer #else 73 1.3.2.2 bouyer #define ACPI_FORMAT_NATIVE_UINT(i) 0, (i) 74 1.3.2.2 bouyer #endif 75 1.3.2.2 bouyer 76 1.3.2.2 bouyer 77 1.3.2.2 bouyer /* 78 1.3.2.2 bouyer * Macros for moving data around to/from buffers that are possibly unaligned. 79 1.3.2.2 bouyer * If the hardware supports the transfer of unaligned data, just do the store. 80 1.3.2.2 bouyer * Otherwise, we have to move one byte at a time. 81 1.3.2.2 bouyer */ 82 1.3.2.2 bouyer #ifdef ACPI_BIG_ENDIAN 83 1.3.2.2 bouyer /* 84 1.3.2.2 bouyer * Macros for big-endian machines 85 1.3.2.2 bouyer */ 86 1.3.2.2 bouyer 87 1.3.2.2 bouyer /* These macros reverse the bytes during the move, converting little-endian to big endian */ 88 1.3.2.2 bouyer 89 1.3.2.2 bouyer /* Big Endian <== Little Endian */ 90 1.3.2.2 bouyer /* Hi...Lo Lo...Hi */ 91 1.3.2.2 bouyer /* 16-bit source, 16/32/64 destination */ 92 1.3.2.2 bouyer 93 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[1];\ 94 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[0];} 95 1.3.2.2 bouyer 96 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d))=0;\ 97 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[1];\ 98 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[0];} 99 1.3.2.2 bouyer 100 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 101 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[1];\ 102 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[0];} 103 1.3.2.2 bouyer 104 1.3.2.2 bouyer /* 32-bit source, 16/32/64 destination */ 105 1.3.2.2 bouyer 106 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 107 1.3.2.2 bouyer 108 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[3];\ 109 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[2];\ 110 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[1];\ 111 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[0];} 112 1.3.2.2 bouyer 113 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d))=0;\ 114 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[4] = ((const UINT8 *)(const void *)(s))[3];\ 115 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[5] = ((const UINT8 *)(const void *)(s))[2];\ 116 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[1];\ 117 1.3.2.2 bouyer ((UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[0];} 118 1.3.2.2 bouyer 119 1.3.2.2 bouyer /* 64-bit source, 16/32/64 destination */ 120 1.3.2.2 bouyer 121 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 122 1.3.2.2 bouyer 123 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 124 1.3.2.2 bouyer 125 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[7];\ 126 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[6];\ 127 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[5];\ 128 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[4];\ 129 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[4] = ((const UINT8 *)(const void *)(s))[3];\ 130 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[5] = ((const UINT8 *)(const void *)(s))[2];\ 131 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[1];\ 132 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[0];} 133 1.3.2.2 bouyer #else 134 1.3.2.2 bouyer /* 135 1.3.2.2 bouyer * Macros for little-endian machines 136 1.3.2.2 bouyer */ 137 1.3.2.2 bouyer 138 1.3.2.2 bouyer #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 139 1.3.2.2 bouyer 140 1.3.2.2 bouyer /* The hardware supports unaligned transfers, just do the little-endian move */ 141 1.3.2.2 bouyer 142 1.3.2.2 bouyer /* 16-bit source, 16/32/64 destination */ 143 1.3.2.2 bouyer 144 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_16(d, s) *(UINT16 *)(void *)(d) = *(const UINT16 *)(const void *)(s) 145 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_32(d, s) *(UINT32 *)(void *)(d) = *(const UINT16 *)(const void *)(s) 146 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_64(d, s) *(UINT64 *)(void *)(d) = *(const UINT16 *)(const void *)(s) 147 1.3.2.2 bouyer 148 1.3.2.2 bouyer /* 32-bit source, 16/32/64 destination */ 149 1.3.2.2 bouyer 150 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 151 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_32(d, s) *(UINT32 *)(void *)(d) = *(const UINT32 *)(const void *)(s) 152 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_64(d, s) *(UINT64 *)(void *)(d) = *(const UINT32 *)(const void *)(s) 153 1.3.2.2 bouyer 154 1.3.2.2 bouyer /* 64-bit source, 16/32/64 destination */ 155 1.3.2.2 bouyer 156 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 157 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 158 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_64(d, s) *(UINT64 *)(void *)(d) = *(const UINT64 *)(const void *)(s) 159 1.3.2.2 bouyer 160 1.3.2.2 bouyer #else 161 1.3.2.2 bouyer /* 162 1.3.2.2 bouyer * The hardware does not support unaligned transfers. We must move the 163 1.3.2.2 bouyer * data one byte at a time. These macros work whether the source or 164 1.3.2.2 bouyer * the destination (or both) is/are unaligned. (Little-endian move) 165 1.3.2.2 bouyer */ 166 1.3.2.2 bouyer 167 1.3.2.2 bouyer /* 16-bit source, 16/32/64 destination */ 168 1.3.2.2 bouyer 169 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_16(d, s) {(( UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[0];\ 170 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[1];} 171 1.3.2.2 bouyer 172 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_32(d, s) {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 173 1.3.2.2 bouyer #define ACPI_MOVE_16_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} 174 1.3.2.2 bouyer 175 1.3.2.2 bouyer /* 32-bit source, 16/32/64 destination */ 176 1.3.2.2 bouyer 177 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 178 1.3.2.2 bouyer 179 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_32(d, s) {(( UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[0];\ 180 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[1];\ 181 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[2];\ 182 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[3];} 183 1.3.2.2 bouyer 184 1.3.2.2 bouyer #define ACPI_MOVE_32_TO_64(d, s) {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} 185 1.3.2.2 bouyer 186 1.3.2.2 bouyer /* 64-bit source, 16/32/64 destination */ 187 1.3.2.2 bouyer 188 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ 189 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ 190 1.3.2.2 bouyer #define ACPI_MOVE_64_TO_64(d, s) {(( UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[0];\ 191 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[1];\ 192 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[2];\ 193 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[3];\ 194 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[4] = ((const UINT8 *)(const void *)(s))[4];\ 195 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[5] = ((const UINT8 *)(const void *)(s))[5];\ 196 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[6];\ 197 1.3.2.2 bouyer (( UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[7];} 198 1.3.2.2 bouyer #endif 199 1.3.2.2 bouyer #endif 200 1.3.2.2 bouyer 201 1.3.2.2 bouyer 202 1.3.2.2 bouyer /* 203 1.3.2.2 bouyer * Fast power-of-two math macros for non-optimized compilers 204 1.3.2.2 bouyer */ 205 1.3.2.2 bouyer #define _ACPI_DIV(value, PowerOf2) ((UINT32) ((value) >> (PowerOf2))) 206 1.3.2.2 bouyer #define _ACPI_MUL(value, PowerOf2) ((UINT32) ((value) << (PowerOf2))) 207 1.3.2.2 bouyer #define _ACPI_MOD(value, Divisor) ((UINT32) ((value) & ((Divisor) -1))) 208 1.3.2.2 bouyer 209 1.3.2.2 bouyer #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) 210 1.3.2.2 bouyer #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) 211 1.3.2.2 bouyer #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) 212 1.3.2.2 bouyer 213 1.3.2.2 bouyer #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) 214 1.3.2.2 bouyer #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) 215 1.3.2.2 bouyer #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) 216 1.3.2.2 bouyer 217 1.3.2.2 bouyer #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) 218 1.3.2.2 bouyer #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) 219 1.3.2.2 bouyer #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) 220 1.3.2.2 bouyer 221 1.3.2.2 bouyer #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) 222 1.3.2.2 bouyer #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) 223 1.3.2.2 bouyer #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) 224 1.3.2.2 bouyer 225 1.3.2.2 bouyer #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) 226 1.3.2.2 bouyer #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) 227 1.3.2.2 bouyer #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) 228 1.3.2.2 bouyer 229 1.3.2.2 bouyer /* 230 1.3.2.2 bouyer * Rounding macros (Power of two boundaries only) 231 1.3.2.2 bouyer */ 232 1.3.2.2 bouyer #define ACPI_ROUND_DOWN(value, boundary) (((ACPI_SIZE)(value)) & \ 233 1.3.2.2 bouyer (~(((ACPI_SIZE) boundary)-1))) 234 1.3.2.2 bouyer 235 1.3.2.2 bouyer #define ACPI_ROUND_UP(value, boundary) ((((ACPI_SIZE)(value)) + \ 236 1.3.2.2 bouyer (((ACPI_SIZE) boundary)-1)) & \ 237 1.3.2.2 bouyer (~(((ACPI_SIZE) boundary)-1))) 238 1.3.2.2 bouyer 239 1.3.2.2 bouyer /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */ 240 1.3.2.2 bouyer 241 1.3.2.2 bouyer #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) 242 1.3.2.2 bouyer #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) 243 1.3.2.2 bouyer #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE)) 244 1.3.2.2 bouyer 245 1.3.2.2 bouyer #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) 246 1.3.2.2 bouyer #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) 247 1.3.2.2 bouyer #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(ACPI_SIZE)) 248 1.3.2.2 bouyer 249 1.3.2.2 bouyer #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 250 1.3.2.2 bouyer #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 251 1.3.2.2 bouyer 252 1.3.2.2 bouyer #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 253 1.3.2.2 bouyer 254 1.3.2.2 bouyer /* Generic (non-power-of-two) rounding */ 255 1.3.2.2 bouyer 256 1.3.2.2 bouyer #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) 257 1.3.2.2 bouyer 258 1.3.2.2 bouyer #define ACPI_IS_MISALIGNED(value) (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1)) 259 1.3.2.2 bouyer 260 1.3.2.2 bouyer /* 261 1.3.2.2 bouyer * Bitmask creation 262 1.3.2.2 bouyer * Bit positions start at zero. 263 1.3.2.2 bouyer * MASK_BITS_ABOVE creates a mask starting AT the position and above 264 1.3.2.2 bouyer * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 265 1.3.2.2 bouyer */ 266 1.3.2.2 bouyer #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((UINT32) (position)))) 267 1.3.2.2 bouyer #define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((UINT32) (position))) 268 1.3.2.2 bouyer 269 1.3.2.2 bouyer /* Bitfields within ACPI registers */ 270 1.3.2.2 bouyer 271 1.3.2.2 bouyer #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) ((Val << Pos) & Mask) 272 1.3.2.2 bouyer #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) 273 1.3.2.2 bouyer 274 1.3.2.2 bouyer #define ACPI_INSERT_BITS(Target, Mask, Source) Target = ((Target & (~(Mask))) | (Source & Mask)) 275 1.3.2.2 bouyer 276 1.3.2.2 bouyer /* 277 1.3.2.2 bouyer * An ACPI_NAMESPACE_NODE can appear in some contexts 278 1.3.2.2 bouyer * where a pointer to an ACPI_OPERAND_OBJECT can also 279 1.3.2.2 bouyer * appear. This macro is used to distinguish them. 280 1.3.2.2 bouyer * 281 1.3.2.2 bouyer * The "Descriptor" field is the first field in both structures. 282 1.3.2.2 bouyer */ 283 1.3.2.2 bouyer #define ACPI_GET_DESCRIPTOR_TYPE(d) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType) 284 1.3.2.2 bouyer #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = t) 285 1.3.2.2 bouyer 286 1.3.2.2 bouyer /* 287 1.3.2.2 bouyer * Macros for the master AML opcode table 288 1.3.2.2 bouyer */ 289 1.3.2.2 bouyer #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 290 1.3.2.2 bouyer #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 291 1.3.2.2 bouyer {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 292 1.3.2.2 bouyer #else 293 1.3.2.2 bouyer #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \ 294 1.3.2.2 bouyer {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type} 295 1.3.2.2 bouyer #endif 296 1.3.2.2 bouyer 297 1.3.2.2 bouyer #define ARG_TYPE_WIDTH 5 298 1.3.2.2 bouyer #define ARG_1(x) ((UINT32)(x)) 299 1.3.2.2 bouyer #define ARG_2(x) ((UINT32)(x) << (1 * ARG_TYPE_WIDTH)) 300 1.3.2.2 bouyer #define ARG_3(x) ((UINT32)(x) << (2 * ARG_TYPE_WIDTH)) 301 1.3.2.2 bouyer #define ARG_4(x) ((UINT32)(x) << (3 * ARG_TYPE_WIDTH)) 302 1.3.2.2 bouyer #define ARG_5(x) ((UINT32)(x) << (4 * ARG_TYPE_WIDTH)) 303 1.3.2.2 bouyer #define ARG_6(x) ((UINT32)(x) << (5 * ARG_TYPE_WIDTH)) 304 1.3.2.2 bouyer 305 1.3.2.2 bouyer #define ARGI_LIST1(a) (ARG_1(a)) 306 1.3.2.2 bouyer #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) 307 1.3.2.2 bouyer #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 308 1.3.2.2 bouyer #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 309 1.3.2.2 bouyer #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 310 1.3.2.2 bouyer #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)) 311 1.3.2.2 bouyer 312 1.3.2.2 bouyer #define ARGP_LIST1(a) (ARG_1(a)) 313 1.3.2.2 bouyer #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) 314 1.3.2.2 bouyer #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 315 1.3.2.2 bouyer #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 316 1.3.2.2 bouyer #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 317 1.3.2.2 bouyer #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)) 318 1.3.2.2 bouyer 319 1.3.2.2 bouyer #define GET_CURRENT_ARG_TYPE(List) (List & ((UINT32) 0x1F)) 320 1.3.2.2 bouyer #define INCREMENT_ARG_LIST(List) (List >>= ((UINT32) ARG_TYPE_WIDTH)) 321 1.3.2.2 bouyer 322 1.3.2.2 bouyer /* 323 1.3.2.2 bouyer * Ascii error messages can be configured out 324 1.3.2.2 bouyer */ 325 1.3.2.2 bouyer #ifndef ACPI_NO_ERROR_MESSAGES 326 1.3.2.2 bouyer /* 327 1.3.2.2 bouyer * Error reporting. Callers module and line number are inserted by AE_INFO, 328 1.3.2.2 bouyer * the plist contains a set of parens to allow variable-length lists. 329 1.3.2.2 bouyer * These macros are used for both the debug and non-debug versions of the code. 330 1.3.2.2 bouyer */ 331 1.3.2.2 bouyer #define ACPI_ERROR_NAMESPACE(s, e) AcpiUtNamespaceError (AE_INFO, s, e); 332 1.3.2.2 bouyer #define ACPI_ERROR_METHOD(s, n, p, e) AcpiUtMethodError (AE_INFO, s, n, p, e); 333 1.3.2.2 bouyer #define ACPI_WARN_PREDEFINED(plist) AcpiUtPredefinedWarning plist 334 1.3.2.2 bouyer #define ACPI_INFO_PREDEFINED(plist) AcpiUtPredefinedInfo plist 335 1.3.2.2 bouyer 336 1.3.2.2 bouyer #else 337 1.3.2.2 bouyer 338 1.3.2.2 bouyer /* No error messages */ 339 1.3.2.2 bouyer 340 1.3.2.2 bouyer #define ACPI_ERROR_NAMESPACE(s, e) 341 1.3.2.2 bouyer #define ACPI_ERROR_METHOD(s, n, p, e) 342 1.3.2.2 bouyer #define ACPI_WARN_PREDEFINED(plist) 343 1.3.2.2 bouyer #define ACPI_INFO_PREDEFINED(plist) 344 1.3.2.2 bouyer 345 1.3.2.2 bouyer #endif /* ACPI_NO_ERROR_MESSAGES */ 346 1.3.2.2 bouyer 347 1.3.2.2 bouyer /* 348 1.3.2.2 bouyer * Debug macros that are conditionally compiled 349 1.3.2.2 bouyer */ 350 1.3.2.2 bouyer #ifdef ACPI_DEBUG_OUTPUT 351 1.3.2.2 bouyer /* 352 1.3.2.2 bouyer * Function entry tracing 353 1.3.2.2 bouyer */ 354 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 355 1.3.2.2 bouyer AcpiUtTrace(ACPI_DEBUG_PARAMETERS) 356 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \ 357 1.3.2.2 bouyer AcpiUtTracePtr(ACPI_DEBUG_PARAMETERS, (void *)b) 358 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \ 359 1.3.2.2 bouyer AcpiUtTraceU32(ACPI_DEBUG_PARAMETERS, (UINT32)b) 360 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \ 361 1.3.2.2 bouyer AcpiUtTraceStr(ACPI_DEBUG_PARAMETERS, (char *)b) 362 1.3.2.2 bouyer 363 1.3.2.2 bouyer #define ACPI_FUNCTION_ENTRY() AcpiUtTrackStackPtr() 364 1.3.2.2 bouyer 365 1.3.2.2 bouyer /* 366 1.3.2.2 bouyer * Function exit tracing. 367 1.3.2.2 bouyer * WARNING: These macros include a return statement. This is usually considered 368 1.3.2.2 bouyer * bad form, but having a separate exit macro is very ugly and difficult to maintain. 369 1.3.2.2 bouyer * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 370 1.3.2.2 bouyer * so that "_AcpiFunctionName" is defined. 371 1.3.2.2 bouyer * 372 1.3.2.2 bouyer * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining 373 1.3.2.2 bouyer * about these constructs. 374 1.3.2.2 bouyer */ 375 1.3.2.2 bouyer #ifdef ACPI_USE_DO_WHILE_0 376 1.3.2.2 bouyer #define ACPI_DO_WHILE0(a) do a while(0) 377 1.3.2.2 bouyer #else 378 1.3.2.2 bouyer #define ACPI_DO_WHILE0(a) a 379 1.3.2.2 bouyer #endif 380 1.3.2.2 bouyer 381 1.3.2.2 bouyer #define return_VOID ACPI_DO_WHILE0 ({ \ 382 1.3.2.2 bouyer AcpiUtExit (ACPI_DEBUG_PARAMETERS); \ 383 1.3.2.2 bouyer return;}) 384 1.3.2.2 bouyer /* 385 1.3.2.2 bouyer * There are two versions of most of the return macros. The default version is 386 1.3.2.2 bouyer * safer, since it avoids side-effects by guaranteeing that the argument will 387 1.3.2.2 bouyer * not be evaluated twice. 388 1.3.2.2 bouyer * 389 1.3.2.2 bouyer * A less-safe version of the macros is provided for optional use if the 390 1.3.2.2 bouyer * compiler uses excessive CPU stack (for example, this may happen in the 391 1.3.2.2 bouyer * debug case if code optimzation is disabled.) 392 1.3.2.2 bouyer */ 393 1.3.2.2 bouyer #ifndef ACPI_SIMPLE_RETURN_MACROS 394 1.3.2.2 bouyer 395 1.3.2.2 bouyer #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 396 1.3.2.2 bouyer register ACPI_STATUS _s = (s); \ 397 1.3.2.2 bouyer AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, _s); \ 398 1.3.2.2 bouyer return (_s); }) 399 1.3.2.2 bouyer #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 400 1.3.2.2 bouyer register void *_s = (void *) (s); \ 401 1.3.2.2 bouyer AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) _s); \ 402 1.3.2.2 bouyer return (_s); }) 403 1.3.2.2 bouyer #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 404 1.3.2.2 bouyer register UINT64 _s = (s); \ 405 1.3.2.2 bouyer AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, _s); \ 406 1.3.2.2 bouyer return (_s); }) 407 1.3.2.2 bouyer #define return_UINT8(s) ACPI_DO_WHILE0 ({ \ 408 1.3.2.2 bouyer register UINT8 _s = (UINT8) (s); \ 409 1.3.2.2 bouyer AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \ 410 1.3.2.2 bouyer return (_s); }) 411 1.3.2.2 bouyer #define return_UINT32(s) ACPI_DO_WHILE0 ({ \ 412 1.3.2.2 bouyer register UINT32 _s = (UINT32) (s); \ 413 1.3.2.2 bouyer AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) _s); \ 414 1.3.2.2 bouyer return (_s); }) 415 1.3.2.2 bouyer #else /* Use original less-safe macros */ 416 1.3.2.2 bouyer 417 1.3.2.2 bouyer #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 418 1.3.2.2 bouyer AcpiUtStatusExit (ACPI_DEBUG_PARAMETERS, (s)); \ 419 1.3.2.2 bouyer return((s)); }) 420 1.3.2.2 bouyer #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 421 1.3.2.2 bouyer AcpiUtPtrExit (ACPI_DEBUG_PARAMETERS, (UINT8 *) (s)); \ 422 1.3.2.2 bouyer return((s)); }) 423 1.3.2.2 bouyer #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 424 1.3.2.2 bouyer AcpiUtValueExit (ACPI_DEBUG_PARAMETERS, (UINT64) (s)); \ 425 1.3.2.2 bouyer return((s)); }) 426 1.3.2.2 bouyer #define return_UINT8(s) return_VALUE(s) 427 1.3.2.2 bouyer #define return_UINT32(s) return_VALUE(s) 428 1.3.2.2 bouyer 429 1.3.2.2 bouyer #endif /* ACPI_SIMPLE_RETURN_MACROS */ 430 1.3.2.2 bouyer 431 1.3.2.2 bouyer 432 1.3.2.2 bouyer /* Conditional execution */ 433 1.3.2.2 bouyer 434 1.3.2.2 bouyer #define ACPI_DEBUG_EXEC(a) a 435 1.3.2.2 bouyer #define ACPI_DEBUG_ONLY_MEMBERS(a) a; 436 1.3.2.2 bouyer #define _VERBOSE_STRUCTURES 437 1.3.2.2 bouyer 438 1.3.2.2 bouyer 439 1.3.2.2 bouyer /* Various object display routines for debug */ 440 1.3.2.2 bouyer 441 1.3.2.2 bouyer #define ACPI_DUMP_STACK_ENTRY(a) AcpiExDumpOperand((a), 0) 442 1.3.2.2 bouyer #define ACPI_DUMP_OPERANDS(a, b ,c) AcpiExDumpOperands(a, b, c) 443 1.3.2.2 bouyer #define ACPI_DUMP_ENTRY(a, b) AcpiNsDumpEntry (a, b) 444 1.3.2.2 bouyer #define ACPI_DUMP_PATHNAME(a, b, c, d) AcpiNsDumpPathname(a, b, c, d) 445 1.3.2.2 bouyer #define ACPI_DUMP_BUFFER(a, b) AcpiUtDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT) 446 1.3.2.2 bouyer 447 1.3.2.2 bouyer #else 448 1.3.2.2 bouyer /* 449 1.3.2.2 bouyer * This is the non-debug case -- make everything go away, 450 1.3.2.2 bouyer * leaving no executable debug code! 451 1.3.2.2 bouyer */ 452 1.3.2.2 bouyer #define ACPI_DEBUG_EXEC(a) 453 1.3.2.2 bouyer #define ACPI_DEBUG_ONLY_MEMBERS(a) 454 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE(a) 455 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE_PTR(a, b) 456 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE_U32(a, b) 457 1.3.2.2 bouyer #define ACPI_FUNCTION_TRACE_STR(a, b) 458 1.3.2.2 bouyer #define ACPI_FUNCTION_EXIT 459 1.3.2.2 bouyer #define ACPI_FUNCTION_STATUS_EXIT(s) 460 1.3.2.2 bouyer #define ACPI_FUNCTION_VALUE_EXIT(s) 461 1.3.2.2 bouyer #define ACPI_FUNCTION_ENTRY() 462 1.3.2.2 bouyer #define ACPI_DUMP_STACK_ENTRY(a) 463 1.3.2.2 bouyer #define ACPI_DUMP_OPERANDS(a, b, c) 464 1.3.2.2 bouyer #define ACPI_DUMP_ENTRY(a, b) 465 1.3.2.2 bouyer #define ACPI_DUMP_TABLES(a, b) 466 1.3.2.2 bouyer #define ACPI_DUMP_PATHNAME(a, b, c, d) 467 1.3.2.2 bouyer #define ACPI_DUMP_BUFFER(a, b) 468 1.3.2.2 bouyer #define ACPI_DEBUG_PRINT(pl) 469 1.3.2.2 bouyer #define ACPI_DEBUG_PRINT_RAW(pl) 470 1.3.2.2 bouyer 471 1.3.2.2 bouyer #define return_VOID return 472 1.3.2.2 bouyer #define return_ACPI_STATUS(s) return(s) 473 1.3.2.2 bouyer #define return_VALUE(s) return(s) 474 1.3.2.2 bouyer #define return_UINT8(s) return(s) 475 1.3.2.2 bouyer #define return_UINT32(s) return(s) 476 1.3.2.2 bouyer #define return_PTR(s) return(s) 477 1.3.2.2 bouyer 478 1.3.2.2 bouyer #endif /* ACPI_DEBUG_OUTPUT */ 479 1.3.2.2 bouyer 480 1.3.2.2 bouyer /* 481 1.3.2.2 bouyer * Some code only gets executed when the debugger is built in. 482 1.3.2.2 bouyer * Note that this is entirely independent of whether the 483 1.3.2.2 bouyer * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. 484 1.3.2.2 bouyer */ 485 1.3.2.2 bouyer #ifdef ACPI_DEBUGGER 486 1.3.2.2 bouyer #define ACPI_DEBUGGER_EXEC(a) a 487 1.3.2.2 bouyer #else 488 1.3.2.2 bouyer #define ACPI_DEBUGGER_EXEC(a) 489 1.3.2.2 bouyer #endif 490 1.3.2.2 bouyer 491 1.3.2.2 bouyer 492 1.3.2.2 bouyer /* 493 1.3.2.2 bouyer * Memory allocation tracking (DEBUG ONLY) 494 1.3.2.2 bouyer */ 495 1.3.2.2 bouyer #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 496 1.3.2.2 bouyer 497 1.3.2.2 bouyer #ifndef ACPI_DBG_TRACK_ALLOCATIONS 498 1.3.2.2 bouyer 499 1.3.2.2 bouyer /* Memory allocation */ 500 1.3.2.2 bouyer 501 1.3.2.2 bouyer #define ACPI_ALLOCATE(a) AcpiUtAllocate((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 502 1.3.2.2 bouyer #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroed((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 503 1.3.2.2 bouyer #define ACPI_FREE(a) AcpiOsFree(a) 504 1.3.2.2 bouyer #define ACPI_MEM_TRACKING(a) 505 1.3.2.2 bouyer 506 1.3.2.2 bouyer #else 507 1.3.2.2 bouyer 508 1.3.2.2 bouyer /* Memory allocation */ 509 1.3.2.2 bouyer 510 1.3.2.2 bouyer #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 511 1.3.2.2 bouyer #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 512 1.3.2.2 bouyer #define ACPI_FREE(a) AcpiUtFreeAndTrack(a, ACPI_MEM_PARAMETERS) 513 1.3.2.2 bouyer #define ACPI_MEM_TRACKING(a) a 514 1.3.2.2 bouyer 515 1.3.2.2 bouyer #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 516 1.3.2.2 bouyer 517 1.3.2.2 bouyer 518 1.3.2.2 bouyer /* 519 1.3.2.2 bouyer * Macros used for ACPICA utilities only 520 1.3.2.2 bouyer */ 521 1.3.2.2 bouyer 522 1.3.2.2 bouyer /* Generate a UUID */ 523 1.3.2.2 bouyer 524 1.3.2.2 bouyer #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 525 1.3.2.2 bouyer (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 526 1.3.2.2 bouyer (b) & 0xFF, ((b) >> 8) & 0xFF, \ 527 1.3.2.2 bouyer (c) & 0xFF, ((c) >> 8) & 0xFF, \ 528 1.3.2.2 bouyer (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 529 1.3.2.2 bouyer 530 1.3.2.2 bouyer #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 531 1.3.2.2 bouyer 532 1.3.2.2 bouyer 533 1.3.2.2 bouyer #endif /* ACMACROS_H */ 534
Indexes created Thu Oct 02 14:10:14 GMT 2025