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