include/acpi/acmacros.h

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