1 /****************************************************************************** 2 * 3 * Name: acmacros.h - C macros for the entire subsystem. 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2007, R. Byron Moore 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 * Data manipulation macros 49 */ 50 #define ACPI_LOWORD(l) ((u16)(u32)(l)) 51 #define ACPI_HIWORD(l) ((u16)((((u32)(l)) >> 16) & 0xFFFF)) 52 #define ACPI_LOBYTE(l) ((u8)(u16)(l)) 53 #define ACPI_HIBYTE(l) ((u8)((((u16)(l)) >> 8) & 0xFF)) 54 55 #define ACPI_SET_BIT(target,bit) ((target) |= (bit)) 56 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit)) 57 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b)) 58 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b)) 59 60 /* Size calculation */ 61 62 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0])) 63 64 #ifdef ACPI_NO_INTEGER64_SUPPORT 65 /* 66 * acpi_integer is 32-bits, no 64-bit support on this platform 67 */ 68 #define ACPI_LODWORD(l) ((u32)(l)) 69 #define ACPI_HIDWORD(l) ((u32)(0)) 70 71 #else 72 73 /* 74 * Full 64-bit address/integer on both 32-bit and 64-bit platforms 75 */ 76 #define ACPI_LODWORD(l) ((u32)(u64)(l)) 77 #define ACPI_HIDWORD(l) ((u32)(((*(struct uint64_struct *)(void *)(&l))).hi)) 78 #endif 79 80 /* 81 * printf() format helpers 82 */ 83 84 /* Split 64-bit integer into two 32-bit values. Use with %8.8_x%8.8_x */ 85 86 #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i),ACPI_LODWORD(i) 87 88 /* 89 * Extract data using a pointer. Any more than a byte and we 90 * get into potential aligment issues -- see the STORE macros below. 91 * Use with care. 92 */ 93 #define ACPI_GET8(ptr) *ACPI_CAST_PTR (u8, ptr) 94 #define ACPI_GET16(ptr) *ACPI_CAST_PTR (u16, ptr) 95 #define ACPI_GET32(ptr) *ACPI_CAST_PTR (u32, ptr) 96 #define ACPI_GET64(ptr) *ACPI_CAST_PTR (u64, ptr) 97 #define ACPI_SET8(ptr) *ACPI_CAST_PTR (u8, ptr) 98 #define ACPI_SET16(ptr) *ACPI_CAST_PTR (u16, ptr) 99 #define ACPI_SET32(ptr) *ACPI_CAST_PTR (u32, ptr) 100 #define ACPI_SET64(ptr) *ACPI_CAST_PTR (u64, ptr) 101 102 /* 103 * Pointer manipulation 104 */ 105 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p)) 106 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p)) 107 #define ACPI_ADD_PTR(t,a,b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8,(a)) + (acpi_native_uint)(b))) 108 #define ACPI_PTR_DIFF(a,b) (acpi_native_uint) (ACPI_CAST_PTR (u8,(a)) - ACPI_CAST_PTR (u8,(b))) 109 110 /* Pointer/Integer type conversions */ 111 112 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void,(void *) NULL,(acpi_native_uint) i) 113 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p,(void *) NULL) 114 #define ACPI_OFFSET(d,f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f),(void *) NULL) 115 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i) 116 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i) 117 118 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 119 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32,(a)) == *ACPI_CAST_PTR (u32,(b))) 120 #else 121 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char,(a)), ACPI_CAST_PTR (char,(b)), ACPI_NAME_SIZE)) 122 #endif 123 124 /* 125 * Algorithm to obtain access bit or byte width. 126 * Can be used with access_width of struct acpi_generic_address and access_size of 127 * struct acpi_resource_generic_register. 128 */ 129 #define ACPI_ACCESS_BIT_WIDTH(size) (1 << ((size) + 2)) 130 #define ACPI_ACCESS_BYTE_WIDTH(size) (1 << ((size) - 1)) 131 132 /* 133 * Macros for moving data around to/from buffers that are possibly unaligned. 134 * If the hardware supports the transfer of unaligned data, just do the store. 135 * Otherwise, we have to move one byte at a time. 136 */ 137 #ifdef ACPI_BIG_ENDIAN 138 /* 139 * Macros for big-endian machines 140 */ 141 142 /* This macro sets a buffer index, starting from the end of the buffer */ 143 144 #define ACPI_BUFFER_INDEX(buf_len,buf_offset,byte_gran) ((buf_len) - (((buf_offset)+1) * (byte_gran))) 145 146 /* These macros reverse the bytes during the move, converting little-endian to big endian */ 147 148 /* Big Endian <== Little Endian */ 149 /* Hi...Lo Lo...Hi */ 150 /* 16-bit source, 16/32/64 destination */ 151 152 #define ACPI_MOVE_16_TO_16(d,s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\ 153 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];} 154 155 #define ACPI_MOVE_16_TO_32(d,s) {(*(u32 *)(void *)(d))=0;\ 156 ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\ 157 ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];} 158 159 #define ACPI_MOVE_16_TO_64(d,s) {(*(u64 *)(void *)(d))=0;\ 160 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\ 161 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];} 162 163 /* 32-bit source, 16/32/64 destination */ 164 165 #define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 166 167 #define ACPI_MOVE_32_TO_32(d,s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\ 168 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\ 169 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\ 170 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];} 171 172 #define ACPI_MOVE_32_TO_64(d,s) {(*(u64 *)(void *)(d))=0;\ 173 ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\ 174 ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\ 175 ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\ 176 ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];} 177 178 /* 64-bit source, 16/32/64 destination */ 179 180 #define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 181 182 #define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 183 184 #define ACPI_MOVE_64_TO_64(d,s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\ 185 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\ 186 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\ 187 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\ 188 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\ 189 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\ 190 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\ 191 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];} 192 #else 193 /* 194 * Macros for little-endian machines 195 */ 196 197 /* This macro sets a buffer index, starting from the beginning of the buffer */ 198 199 #define ACPI_BUFFER_INDEX(buf_len,buf_offset,byte_gran) (buf_offset) 200 201 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 202 203 /* The hardware supports unaligned transfers, just do the little-endian move */ 204 205 /* 16-bit source, 16/32/64 destination */ 206 207 #define ACPI_MOVE_16_TO_16(d,s) *(u16 *)(void *)(d) = *(u16 *)(void *)(s) 208 #define ACPI_MOVE_16_TO_32(d,s) *(u32 *)(void *)(d) = *(u16 *)(void *)(s) 209 #define ACPI_MOVE_16_TO_64(d,s) *(u64 *)(void *)(d) = *(u16 *)(void *)(s) 210 211 /* 32-bit source, 16/32/64 destination */ 212 213 #define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 214 #define ACPI_MOVE_32_TO_32(d,s) *(u32 *)(void *)(d) = *(u32 *)(void *)(s) 215 #define ACPI_MOVE_32_TO_64(d,s) *(u64 *)(void *)(d) = *(u32 *)(void *)(s) 216 217 /* 64-bit source, 16/32/64 destination */ 218 219 #define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 220 #define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 221 #define ACPI_MOVE_64_TO_64(d,s) *(u64 *)(void *)(d) = *(u64 *)(void *)(s) 222 223 #else 224 /* 225 * The hardware does not support unaligned transfers. We must move the 226 * data one byte at a time. These macros work whether the source or 227 * the destination (or both) is/are unaligned. (Little-endian move) 228 */ 229 230 /* 16-bit source, 16/32/64 destination */ 231 232 #define ACPI_MOVE_16_TO_16(d,s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\ 233 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];} 234 235 #define ACPI_MOVE_16_TO_32(d,s) {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);} 236 #define ACPI_MOVE_16_TO_64(d,s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);} 237 238 /* 32-bit source, 16/32/64 destination */ 239 240 #define ACPI_MOVE_32_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 241 242 #define ACPI_MOVE_32_TO_32(d,s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\ 243 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\ 244 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\ 245 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];} 246 247 #define ACPI_MOVE_32_TO_64(d,s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d,s);} 248 249 /* 64-bit source, 16/32/64 destination */ 250 251 #define ACPI_MOVE_64_TO_16(d,s) ACPI_MOVE_16_TO_16(d,s) /* Truncate to 16 */ 252 #define ACPI_MOVE_64_TO_32(d,s) ACPI_MOVE_32_TO_32(d,s) /* Truncate to 32 */ 253 #define ACPI_MOVE_64_TO_64(d,s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\ 254 (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\ 255 (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\ 256 (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\ 257 (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\ 258 (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\ 259 (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\ 260 (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];} 261 #endif 262 #endif 263 264 /* Macros based on machine integer width */ 265 266 #if ACPI_MACHINE_WIDTH == 32 267 #define ACPI_MOVE_SIZE_TO_16(d,s) ACPI_MOVE_32_TO_16(d,s) 268 269 #elif ACPI_MACHINE_WIDTH == 64 270 #define ACPI_MOVE_SIZE_TO_16(d,s) ACPI_MOVE_64_TO_16(d,s) 271 272 #else 273 #error unknown ACPI_MACHINE_WIDTH 274 #endif 275 276 /* 277 * Fast power-of-two math macros for non-optimized compilers 278 */ 279 #define _ACPI_DIV(value,power_of2) ((u32) ((value) >> (power_of2))) 280 #define _ACPI_MUL(value,power_of2) ((u32) ((value) << (power_of2))) 281 #define _ACPI_MOD(value,divisor) ((u32) ((value) & ((divisor) -1))) 282 283 #define ACPI_DIV_2(a) _ACPI_DIV(a,1) 284 #define ACPI_MUL_2(a) _ACPI_MUL(a,1) 285 #define ACPI_MOD_2(a) _ACPI_MOD(a,2) 286 287 #define ACPI_DIV_4(a) _ACPI_DIV(a,2) 288 #define ACPI_MUL_4(a) _ACPI_MUL(a,2) 289 #define ACPI_MOD_4(a) _ACPI_MOD(a,4) 290 291 #define ACPI_DIV_8(a) _ACPI_DIV(a,3) 292 #define ACPI_MUL_8(a) _ACPI_MUL(a,3) 293 #define ACPI_MOD_8(a) _ACPI_MOD(a,8) 294 295 #define ACPI_DIV_16(a) _ACPI_DIV(a,4) 296 #define ACPI_MUL_16(a) _ACPI_MUL(a,4) 297 #define ACPI_MOD_16(a) _ACPI_MOD(a,16) 298 299 #define ACPI_DIV_32(a) _ACPI_DIV(a,5) 300 #define ACPI_MUL_32(a) _ACPI_MUL(a,5) 301 #define ACPI_MOD_32(a) _ACPI_MOD(a,32) 302 303 /* 304 * Rounding macros (Power of two boundaries only) 305 */ 306 #define ACPI_ROUND_DOWN(value,boundary) (((acpi_native_uint)(value)) & \ 307 (~(((acpi_native_uint) boundary)-1))) 308 309 #define ACPI_ROUND_UP(value,boundary) ((((acpi_native_uint)(value)) + \ 310 (((acpi_native_uint) boundary)-1)) & \ 311 (~(((acpi_native_uint) boundary)-1))) 312 313 /* Note: sizeof(acpi_native_uint) evaluates to either 2, 4, or 8 */ 314 315 #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a,4) 316 #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a,8) 317 #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a,sizeof(acpi_native_uint)) 318 319 #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a,4) 320 #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a,8) 321 #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a,sizeof(acpi_native_uint)) 322 323 #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) 324 #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) 325 326 #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) 327 328 /* Generic (non-power-of-two) rounding */ 329 330 #define ACPI_ROUND_UP_TO(value,boundary) (((value) + ((boundary)-1)) / (boundary)) 331 332 #define ACPI_IS_MISALIGNED(value) (((acpi_native_uint)value) & (sizeof(acpi_native_uint)-1)) 333 334 /* 335 * Bitmask creation 336 * Bit positions start at zero. 337 * MASK_BITS_ABOVE creates a mask starting AT the position and above 338 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position 339 */ 340 #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_INTEGER_MAX) << ((u32) (position)))) 341 #define ACPI_MASK_BITS_BELOW(position) ((ACPI_INTEGER_MAX) << ((u32) (position))) 342 343 #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) 344 345 /* Bitfields within ACPI registers */ 346 347 #define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) ((val << pos) & mask) 348 #define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask) 349 350 #define ACPI_INSERT_BITS(target, mask, source) target = ((target & (~(mask))) | (source & mask)) 351 352 /* Generate a UUID */ 353 354 #define ACPI_INIT_UUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \ 355 (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ 356 (b) & 0xFF, ((b) >> 8) & 0xFF, \ 357 (c) & 0xFF, ((c) >> 8) & 0xFF, \ 358 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) 359 360 /* 361 * An struct acpi_namespace_node * can appear in some contexts, 362 * where a pointer to an union acpi_operand_object can also 363 * appear. This macro is used to distinguish them. 364 * 365 * The "Descriptor" field is the first field in both structures. 366 */ 367 #define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type) 368 #define ACPI_SET_DESCRIPTOR_TYPE(d,t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = t) 369 370 /* Macro to test the object type */ 371 372 #define ACPI_GET_OBJECT_TYPE(d) (((union acpi_operand_object *)(void *)(d))->common.type) 373 374 /* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */ 375 376 #define ACPI_IS_SINGLE_TABLE(x) (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0) 377 378 /* 379 * Macros for the master AML opcode table 380 */ 381 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) 382 #define ACPI_OP(name,Pargs,Iargs,obj_type,class,type,flags) {name,(u32)(Pargs),(u32)(Iargs),(u32)(flags),obj_type,class,type} 383 #else 384 #define ACPI_OP(name,Pargs,Iargs,obj_type,class,type,flags) {(u32)(Pargs),(u32)(Iargs),(u32)(flags),obj_type,class,type} 385 #endif 386 387 #ifdef ACPI_DISASSEMBLER 388 #define ACPI_DISASM_ONLY_MEMBERS(a) a; 389 #else 390 #define ACPI_DISASM_ONLY_MEMBERS(a) 391 #endif 392 393 #define ARG_TYPE_WIDTH 5 394 #define ARG_1(x) ((u32)(x)) 395 #define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH)) 396 #define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH)) 397 #define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH)) 398 #define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH)) 399 #define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH)) 400 401 #define ARGI_LIST1(a) (ARG_1(a)) 402 #define ARGI_LIST2(a,b) (ARG_1(b)|ARG_2(a)) 403 #define ARGI_LIST3(a,b,c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) 404 #define ARGI_LIST4(a,b,c,d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) 405 #define ARGI_LIST5(a,b,c,d,e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) 406 #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)) 407 408 #define ARGP_LIST1(a) (ARG_1(a)) 409 #define ARGP_LIST2(a,b) (ARG_1(a)|ARG_2(b)) 410 #define ARGP_LIST3(a,b,c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) 411 #define ARGP_LIST4(a,b,c,d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) 412 #define ARGP_LIST5(a,b,c,d,e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) 413 #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)) 414 415 #define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F)) 416 #define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH)) 417 418 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES) 419 /* 420 * Module name is include in both debug and non-debug versions primarily for 421 * error messages. The __FILE__ macro is not very useful for this, because it 422 * often includes the entire pathname to the module 423 */ 424 #define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name; 425 #else 426 #define ACPI_MODULE_NAME(name) 427 #endif 428 429 /* 430 * Ascii error messages can be configured out 431 */ 432 #ifndef ACPI_NO_ERROR_MESSAGES 433 #define AE_INFO _acpi_module_name, __LINE__ 434 435 /* 436 * Error reporting. Callers module and line number are inserted by AE_INFO, 437 * the plist contains a set of parens to allow variable-length lists. 438 * These macros are used for both the debug and non-debug versions of the code. 439 */ 440 #define ACPI_INFO(plist) acpi_ut_info plist 441 #define ACPI_WARNING(plist) acpi_ut_warning plist 442 #define ACPI_ERROR(plist) acpi_ut_error plist 443 #define ACPI_ERROR_NAMESPACE(s,e) acpi_ns_report_error (AE_INFO, s, e); 444 #define ACPI_ERROR_METHOD(s,n,p,e) acpi_ns_report_method_error (AE_INFO, s, n, p, e); 445 446 #else 447 448 /* No error messages */ 449 450 #define ACPI_INFO(plist) 451 #define ACPI_WARNING(plist) 452 #define ACPI_ERROR(plist) 453 #define ACPI_ERROR_NAMESPACE(s,e) 454 #define ACPI_ERROR_METHOD(s,n,p,e) 455 #endif 456 457 /* 458 * Debug macros that are conditionally compiled 459 */ 460 #ifdef ACPI_DEBUG_OUTPUT 461 462 /* 463 * Common parameters used for debug output functions: 464 * line number, function name, module(file) name, component ID 465 */ 466 #define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT 467 468 /* 469 * Function entry tracing 470 */ 471 472 /* 473 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header, 474 * define it now. This is the case where there the compiler does not support 475 * a __FUNCTION__ macro or equivalent. We save the function name on the 476 * local stack. 477 */ 478 #ifndef ACPI_GET_FUNCTION_NAME 479 #define ACPI_GET_FUNCTION_NAME _acpi_function_name 480 /* 481 * The Name parameter should be the procedure name as a quoted string. 482 * This is declared as a local string ("MyFunctionName") so that it can 483 * be also used by the function exit macros below. 484 * Note: (const char) is used to be compatible with the debug interfaces 485 * and macros such as __FUNCTION__. 486 */ 487 #define ACPI_FUNCTION_NAME(name) const char *_acpi_function_name = #name; 488 489 #else 490 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */ 491 492 #define ACPI_FUNCTION_NAME(name) 493 #endif 494 495 #ifdef CONFIG_ACPI_DEBUG_FUNC_TRACE 496 497 #define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \ 498 acpi_ut_trace(ACPI_DEBUG_PARAMETERS) 499 #define ACPI_FUNCTION_TRACE_PTR(a,b) ACPI_FUNCTION_NAME(a) \ 500 acpi_ut_trace_ptr(ACPI_DEBUG_PARAMETERS,(void *)b) 501 #define ACPI_FUNCTION_TRACE_U32(a,b) ACPI_FUNCTION_NAME(a) \ 502 acpi_ut_trace_u32(ACPI_DEBUG_PARAMETERS,(u32)b) 503 #define ACPI_FUNCTION_TRACE_STR(a,b) ACPI_FUNCTION_NAME(a) \ 504 acpi_ut_trace_str(ACPI_DEBUG_PARAMETERS,(char *)b) 505 506 #define ACPI_FUNCTION_ENTRY() acpi_ut_track_stack_ptr() 507 508 /* 509 * Function exit tracing. 510 * WARNING: These macros include a return statement. This is usually considered 511 * bad form, but having a separate exit macro is very ugly and difficult to maintain. 512 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros 513 * so that "_AcpiFunctionName" is defined. 514 * 515 * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining 516 * about these constructs. 517 */ 518 #ifdef ACPI_USE_DO_WHILE_0 519 #define ACPI_DO_WHILE0(a) do a while(0) 520 #else 521 #define ACPI_DO_WHILE0(a) a 522 #endif 523 524 #define return_VOID ACPI_DO_WHILE0 ({ \ 525 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \ 526 return;}) 527 /* 528 * There are two versions of most of the return macros. The default version is 529 * safer, since it avoids side-effects by guaranteeing that the argument will 530 * not be evaluated twice. 531 * 532 * A less-safe version of the macros is provided for optional use if the 533 * compiler uses excessive CPU stack (for example, this may happen in the 534 * debug case if code optimzation is disabled.) 535 */ 536 #ifndef ACPI_SIMPLE_RETURN_MACROS 537 538 #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 539 register acpi_status _s = (s); \ 540 acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, _s); \ 541 return (_s); }) 542 #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 543 register void *_s = (void *) (s); \ 544 acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) _s); \ 545 return (_s); }) 546 #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 547 register acpi_integer _s = (s); \ 548 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, _s); \ 549 return (_s); }) 550 #define return_UINT8(s) ACPI_DO_WHILE0 ({ \ 551 register u8 _s = (u8) (s); \ 552 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) _s); \ 553 return (_s); }) 554 #define return_UINT32(s) ACPI_DO_WHILE0 ({ \ 555 register u32 _s = (u32) (s); \ 556 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) _s); \ 557 return (_s); }) 558 #else /* Use original less-safe macros */ 559 560 #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \ 561 acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, (s)); \ 562 return((s)); }) 563 #define return_PTR(s) ACPI_DO_WHILE0 ({ \ 564 acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) (s)); \ 565 return((s)); }) 566 #define return_VALUE(s) ACPI_DO_WHILE0 ({ \ 567 acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (acpi_integer) (s)); \ 568 return((s)); }) 569 #define return_UINT8(s) return_VALUE(s) 570 #define return_UINT32(s) return_VALUE(s) 571 572 #endif /* ACPI_SIMPLE_RETURN_MACROS */ 573 574 #else /* !CONFIG_ACPI_DEBUG_FUNC_TRACE */ 575 576 #define ACPI_FUNCTION_TRACE(a) 577 #define ACPI_FUNCTION_TRACE_PTR(a,b) 578 #define ACPI_FUNCTION_TRACE_U32(a,b) 579 #define ACPI_FUNCTION_TRACE_STR(a,b) 580 #define ACPI_FUNCTION_EXIT 581 #define ACPI_FUNCTION_STATUS_EXIT(s) 582 #define ACPI_FUNCTION_VALUE_EXIT(s) 583 #define ACPI_FUNCTION_TRACE(a) 584 #define ACPI_FUNCTION_ENTRY() 585 586 #define return_VOID return 587 #define return_ACPI_STATUS(s) return(s) 588 #define return_VALUE(s) return(s) 589 #define return_UINT8(s) return(s) 590 #define return_UINT32(s) return(s) 591 #define return_PTR(s) return(s) 592 593 #endif /* CONFIG_ACPI_DEBUG_FUNC_TRACE */ 594 595 /* Conditional execution */ 596 597 #define ACPI_DEBUG_EXEC(a) a 598 #define ACPI_NORMAL_EXEC(a) 599 600 #define ACPI_DEBUG_DEFINE(a) a; 601 #define ACPI_DEBUG_ONLY_MEMBERS(a) a; 602 #define _VERBOSE_STRUCTURES 603 604 /* 605 * Master debug print macros 606 * Print iff: 607 * 1) Debug print for the current component is enabled 608 * 2) Debug error level or trace level for the print statement is enabled 609 */ 610 #define ACPI_DEBUG_PRINT(plist) acpi_ut_debug_print plist 611 #define ACPI_DEBUG_PRINT_RAW(plist) acpi_ut_debug_print_raw plist 612 613 #else 614 /* 615 * This is the non-debug case -- make everything go away, 616 * leaving no executable debug code! 617 */ 618 #define ACPI_DEBUG_EXEC(a) 619 #define ACPI_NORMAL_EXEC(a) a; 620 621 #define ACPI_DEBUG_DEFINE(a) do { } while(0) 622 #define ACPI_DEBUG_ONLY_MEMBERS(a) do { } while(0) 623 #define ACPI_FUNCTION_NAME(a) do { } while(0) 624 #define ACPI_FUNCTION_TRACE(a) do { } while(0) 625 #define ACPI_FUNCTION_TRACE_PTR(a,b) do { } while(0) 626 #define ACPI_FUNCTION_TRACE_U32(a,b) do { } while(0) 627 #define ACPI_FUNCTION_TRACE_STR(a,b) do { } while(0) 628 #define ACPI_FUNCTION_EXIT do { } while(0) 629 #define ACPI_FUNCTION_STATUS_EXIT(s) do { } while(0) 630 #define ACPI_FUNCTION_VALUE_EXIT(s) do { } while(0) 631 #define ACPI_FUNCTION_ENTRY() do { } while(0) 632 #define ACPI_DEBUG_PRINT(pl) do { } while(0) 633 #define ACPI_DEBUG_PRINT_RAW(pl) do { } while(0) 634 635 #define return_VOID return 636 #define return_ACPI_STATUS(s) return(s) 637 #define return_VALUE(s) return(s) 638 #define return_UINT8(s) return(s) 639 #define return_UINT32(s) return(s) 640 #define return_PTR(s) return(s) 641 642 #endif 643 644 #endif /* ACMACROS_H */ 645