git.oblomov.eu Git - linux-2.6/blob - include/acpi/acmacros.h

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