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