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