acmacros.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
  1. /******************************************************************************
  2. *
  3. * Name: acmacros.h - C macros for the entire subsystem.
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2012, Intel Corp.
  8. * All rights reserved.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions, and the following disclaimer,
  15. * without modification.
  16. * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  17. * substantially similar to the "NO WARRANTY" disclaimer below
  18. * ("Disclaimer") and any redistribution must be conditioned upon
  19. * including a substantially similar Disclaimer requirement for further
  20. * binary redistribution.
  21. * 3. Neither the names of the above-listed copyright holders nor the names
  22. * of any contributors may be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * Alternatively, this software may be distributed under the terms of the
  26. * GNU General Public License ("GPL") version 2 as published by the Free
  27. * Software Foundation.
  28. *
  29. * NO WARRANTY
  30. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  33. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34. * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  38. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  39. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40. * POSSIBILITY OF SUCH DAMAGES.
  41. */
  42. #ifndef __ACMACROS_H__
  43. #define __ACMACROS_H__
  44. /*
  45. * Extract data using a pointer. Any more than a byte and we
  46. * get into potential aligment issues -- see the STORE macros below.
  47. * Use with care.
  48. */
  49. #define ACPI_GET8(ptr) *ACPI_CAST_PTR (u8, ptr)
  50. #define ACPI_GET16(ptr) *ACPI_CAST_PTR (u16, ptr)
  51. #define ACPI_GET32(ptr) *ACPI_CAST_PTR (u32, ptr)
  52. #define ACPI_GET64(ptr) *ACPI_CAST_PTR (u64, ptr)
  53. #define ACPI_SET8(ptr) *ACPI_CAST_PTR (u8, ptr)
  54. #define ACPI_SET16(ptr) *ACPI_CAST_PTR (u16, ptr)
  55. #define ACPI_SET32(ptr) *ACPI_CAST_PTR (u32, ptr)
  56. #define ACPI_SET64(ptr) *ACPI_CAST_PTR (u64, ptr)
  57. /*
  58. * printf() format helpers
  59. */
  60. /* Split 64-bit integer into two 32-bit values. Use with %8.8X%8.8X */
  61. #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
  62. #if ACPI_MACHINE_WIDTH == 64
  63. #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i)
  64. #else
  65. #define ACPI_FORMAT_NATIVE_UINT(i) 0, (i)
  66. #endif
  67. /*
  68. * Macros for moving data around to/from buffers that are possibly unaligned.
  69. * If the hardware supports the transfer of unaligned data, just do the store.
  70. * Otherwise, we have to move one byte at a time.
  71. */
  72. #ifdef ACPI_BIG_ENDIAN
  73. /*
  74. * Macros for big-endian machines
  75. */
  76. /* These macros reverse the bytes during the move, converting little-endian to big endian */
  77. /* Big Endian <== Little Endian */
  78. /* Hi...Lo Lo...Hi */
  79. /* 16-bit source, 16/32/64 destination */
  80. #define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
  81. (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
  82. #define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d))=0;\
  83. ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
  84. ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
  85. #define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
  86. ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
  87. ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
  88. /* 32-bit source, 16/32/64 destination */
  89. #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
  90. #define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
  91. (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
  92. (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
  93. (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
  94. #define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\
  95. ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
  96. ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
  97. ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
  98. ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
  99. /* 64-bit source, 16/32/64 destination */
  100. #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
  101. #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
  102. #define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
  103. (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
  104. (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
  105. (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
  106. (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
  107. (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
  108. (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
  109. (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
  110. #else
  111. /*
  112. * Macros for little-endian machines
  113. */
  114. #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
  115. /* The hardware supports unaligned transfers, just do the little-endian move */
  116. /* 16-bit source, 16/32/64 destination */
  117. #define ACPI_MOVE_16_TO_16(d, s) *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
  118. #define ACPI_MOVE_16_TO_32(d, s) *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
  119. #define ACPI_MOVE_16_TO_64(d, s) *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
  120. /* 32-bit source, 16/32/64 destination */
  121. #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
  122. #define ACPI_MOVE_32_TO_32(d, s) *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
  123. #define ACPI_MOVE_32_TO_64(d, s) *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
  124. /* 64-bit source, 16/32/64 destination */
  125. #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
  126. #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
  127. #define ACPI_MOVE_64_TO_64(d, s) *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
  128. #else
  129. /*
  130. * The hardware does not support unaligned transfers. We must move the
  131. * data one byte at a time. These macros work whether the source or
  132. * the destination (or both) is/are unaligned. (Little-endian move)
  133. */
  134. /* 16-bit source, 16/32/64 destination */
  135. #define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
  136. (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
  137. #define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
  138. #define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
  139. /* 32-bit source, 16/32/64 destination */
  140. #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
  141. #define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
  142. (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
  143. (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
  144. (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
  145. #define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
  146. /* 64-bit source, 16/32/64 destination */
  147. #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
  148. #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
  149. #define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
  150. (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
  151. (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
  152. (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
  153. (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
  154. (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
  155. (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
  156. (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
  157. #endif
  158. #endif
  159. /*
  160. * Fast power-of-two math macros for non-optimized compilers
  161. */
  162. #define _ACPI_DIV(value, power_of2) ((u32) ((value) >> (power_of2)))
  163. #define _ACPI_MUL(value, power_of2) ((u32) ((value) << (power_of2)))
  164. #define _ACPI_MOD(value, divisor) ((u32) ((value) & ((divisor) -1)))
  165. #define ACPI_DIV_2(a) _ACPI_DIV(a, 1)
  166. #define ACPI_MUL_2(a) _ACPI_MUL(a, 1)
  167. #define ACPI_MOD_2(a) _ACPI_MOD(a, 2)
  168. #define ACPI_DIV_4(a) _ACPI_DIV(a, 2)
  169. #define ACPI_MUL_4(a) _ACPI_MUL(a, 2)
  170. #define ACPI_MOD_4(a) _ACPI_MOD(a, 4)
  171. #define ACPI_DIV_8(a) _ACPI_DIV(a, 3)
  172. #define ACPI_MUL_8(a) _ACPI_MUL(a, 3)
  173. #define ACPI_MOD_8(a) _ACPI_MOD(a, 8)
  174. #define ACPI_DIV_16(a) _ACPI_DIV(a, 4)
  175. #define ACPI_MUL_16(a) _ACPI_MUL(a, 4)
  176. #define ACPI_MOD_16(a) _ACPI_MOD(a, 16)
  177. #define ACPI_DIV_32(a) _ACPI_DIV(a, 5)
  178. #define ACPI_MUL_32(a) _ACPI_MUL(a, 5)
  179. #define ACPI_MOD_32(a) _ACPI_MOD(a, 32)
  180. /*
  181. * Rounding macros (Power of two boundaries only)
  182. */
  183. #define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \
  184. (~(((acpi_size) boundary)-1)))
  185. #define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \
  186. (((acpi_size) boundary)-1)) & \
  187. (~(((acpi_size) boundary)-1)))
  188. /* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
  189. #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4)
  190. #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8)
  191. #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(acpi_size))
  192. #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4)
  193. #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8)
  194. #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(acpi_size))
  195. #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7)
  196. #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a))
  197. #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10)
  198. /* Generic (non-power-of-two) rounding */
  199. #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
  200. #define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1))
  201. /*
  202. * Bitmask creation
  203. * Bit positions start at zero.
  204. * MASK_BITS_ABOVE creates a mask starting AT the position and above
  205. * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
  206. */
  207. #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((u32) (position))))
  208. #define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((u32) (position)))
  209. /* Bitfields within ACPI registers */
  210. #define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
  211. ((val << pos) & mask)
  212. #define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \
  213. reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
  214. #define ACPI_INSERT_BITS(target, mask, source) \
  215. target = ((target & (~(mask))) | (source & mask))
  216. /* Generic bitfield macros and masks */
  217. #define ACPI_GET_BITS(source_ptr, position, mask) \
  218. ((*source_ptr >> position) & mask)
  219. #define ACPI_SET_BITS(target_ptr, position, mask, value) \
  220. (*target_ptr |= ((value & mask) << position))
  221. #define ACPI_1BIT_MASK 0x00000001
  222. #define ACPI_2BIT_MASK 0x00000003
  223. #define ACPI_3BIT_MASK 0x00000007
  224. #define ACPI_4BIT_MASK 0x0000000F
  225. #define ACPI_5BIT_MASK 0x0000001F
  226. #define ACPI_6BIT_MASK 0x0000003F
  227. #define ACPI_7BIT_MASK 0x0000007F
  228. #define ACPI_8BIT_MASK 0x000000FF
  229. #define ACPI_16BIT_MASK 0x0000FFFF
  230. #define ACPI_24BIT_MASK 0x00FFFFFF
  231. /*
  232. * An object of type struct acpi_namespace_node can appear in some contexts
  233. * where a pointer to an object of type union acpi_operand_object can also
  234. * appear. This macro is used to distinguish them.
  235. *
  236. * The "Descriptor" field is the first field in both structures.
  237. */
  238. #define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
  239. #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = t)
  240. /*
  241. * Macros for the master AML opcode table
  242. */
  243. #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
  244. #define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
  245. {name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
  246. #else
  247. #define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
  248. {(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
  249. #endif
  250. #define ARG_TYPE_WIDTH 5
  251. #define ARG_1(x) ((u32)(x))
  252. #define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH))
  253. #define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH))
  254. #define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH))
  255. #define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH))
  256. #define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH))
  257. #define ARGI_LIST1(a) (ARG_1(a))
  258. #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a))
  259. #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a))
  260. #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
  261. #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
  262. #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))
  263. #define ARGP_LIST1(a) (ARG_1(a))
  264. #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b))
  265. #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c))
  266. #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
  267. #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
  268. #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))
  269. #define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
  270. #define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
  271. /*
  272. * Ascii error messages can be configured out
  273. */
  274. #ifndef ACPI_NO_ERROR_MESSAGES
  275. /*
  276. * Error reporting. Callers module and line number are inserted by AE_INFO,
  277. * the plist contains a set of parens to allow variable-length lists.
  278. * These macros are used for both the debug and non-debug versions of the code.
  279. */
  280. #define ACPI_ERROR_NAMESPACE(s, e) acpi_ut_namespace_error (AE_INFO, s, e);
  281. #define ACPI_ERROR_METHOD(s, n, p, e) acpi_ut_method_error (AE_INFO, s, n, p, e);
  282. #define ACPI_WARN_PREDEFINED(plist) acpi_ut_predefined_warning plist
  283. #define ACPI_INFO_PREDEFINED(plist) acpi_ut_predefined_info plist
  284. #else
  285. /* No error messages */
  286. #define ACPI_ERROR_NAMESPACE(s, e)
  287. #define ACPI_ERROR_METHOD(s, n, p, e)
  288. #define ACPI_WARN_PREDEFINED(plist)
  289. #define ACPI_INFO_PREDEFINED(plist)
  290. #endif /* ACPI_NO_ERROR_MESSAGES */
  291. /*
  292. * Debug macros that are conditionally compiled
  293. */
  294. #ifdef ACPI_DEBUG_OUTPUT
  295. /*
  296. * Function entry tracing
  297. */
  298. #define ACPI_FUNCTION_TRACE(a) ACPI_FUNCTION_NAME(a) \
  299. acpi_ut_trace(ACPI_DEBUG_PARAMETERS)
  300. #define ACPI_FUNCTION_TRACE_PTR(a, b) ACPI_FUNCTION_NAME(a) \
  301. acpi_ut_trace_ptr(ACPI_DEBUG_PARAMETERS, (void *)b)
  302. #define ACPI_FUNCTION_TRACE_U32(a, b) ACPI_FUNCTION_NAME(a) \
  303. acpi_ut_trace_u32(ACPI_DEBUG_PARAMETERS, (u32)b)
  304. #define ACPI_FUNCTION_TRACE_STR(a, b) ACPI_FUNCTION_NAME(a) \
  305. acpi_ut_trace_str(ACPI_DEBUG_PARAMETERS, (char *)b)
  306. #define ACPI_FUNCTION_ENTRY() acpi_ut_track_stack_ptr()
  307. /*
  308. * Function exit tracing.
  309. * WARNING: These macros include a return statement. This is usually considered
  310. * bad form, but having a separate exit macro is very ugly and difficult to maintain.
  311. * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
  312. * so that "_AcpiFunctionName" is defined.
  313. *
  314. * Note: the DO_WHILE0 macro is used to prevent some compilers from complaining
  315. * about these constructs.
  316. */
  317. #ifdef ACPI_USE_DO_WHILE_0
  318. #define ACPI_DO_WHILE0(a) do a while(0)
  319. #else
  320. #define ACPI_DO_WHILE0(a) a
  321. #endif
  322. #define return_VOID ACPI_DO_WHILE0 ({ \
  323. acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
  324. return;})
  325. /*
  326. * There are two versions of most of the return macros. The default version is
  327. * safer, since it avoids side-effects by guaranteeing that the argument will
  328. * not be evaluated twice.
  329. *
  330. * A less-safe version of the macros is provided for optional use if the
  331. * compiler uses excessive CPU stack (for example, this may happen in the
  332. * debug case if code optimzation is disabled.)
  333. */
  334. #ifndef ACPI_SIMPLE_RETURN_MACROS
  335. #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
  336. register acpi_status _s = (s); \
  337. acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, _s); \
  338. return (_s); })
  339. #define return_PTR(s) ACPI_DO_WHILE0 ({ \
  340. register void *_s = (void *) (s); \
  341. acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) _s); \
  342. return (_s); })
  343. #define return_VALUE(s) ACPI_DO_WHILE0 ({ \
  344. register u64 _s = (s); \
  345. acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, _s); \
  346. return (_s); })
  347. #define return_UINT8(s) ACPI_DO_WHILE0 ({ \
  348. register u8 _s = (u8) (s); \
  349. acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (u64) _s); \
  350. return (_s); })
  351. #define return_UINT32(s) ACPI_DO_WHILE0 ({ \
  352. register u32 _s = (u32) (s); \
  353. acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (u64) _s); \
  354. return (_s); })
  355. #else /* Use original less-safe macros */
  356. #define return_ACPI_STATUS(s) ACPI_DO_WHILE0 ({ \
  357. acpi_ut_status_exit (ACPI_DEBUG_PARAMETERS, (s)); \
  358. return((s)); })
  359. #define return_PTR(s) ACPI_DO_WHILE0 ({ \
  360. acpi_ut_ptr_exit (ACPI_DEBUG_PARAMETERS, (u8 *) (s)); \
  361. return((s)); })
  362. #define return_VALUE(s) ACPI_DO_WHILE0 ({ \
  363. acpi_ut_value_exit (ACPI_DEBUG_PARAMETERS, (u64) (s)); \
  364. return((s)); })
  365. #define return_UINT8(s) return_VALUE(s)
  366. #define return_UINT32(s) return_VALUE(s)
  367. #endif /* ACPI_SIMPLE_RETURN_MACROS */
  368. /* Conditional execution */
  369. #define ACPI_DEBUG_EXEC(a) a
  370. #define ACPI_DEBUG_ONLY_MEMBERS(a) a;
  371. #define _VERBOSE_STRUCTURES
  372. /* Various object display routines for debug */
  373. #define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
  374. #define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
  375. #define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
  376. #define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
  377. #define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
  378. #else
  379. /*
  380. * This is the non-debug case -- make everything go away,
  381. * leaving no executable debug code!
  382. */
  383. #define ACPI_DEBUG_EXEC(a)
  384. #define ACPI_DEBUG_ONLY_MEMBERS(a)
  385. #define ACPI_FUNCTION_TRACE(a)
  386. #define ACPI_FUNCTION_TRACE_PTR(a, b)
  387. #define ACPI_FUNCTION_TRACE_U32(a, b)
  388. #define ACPI_FUNCTION_TRACE_STR(a, b)
  389. #define ACPI_FUNCTION_EXIT
  390. #define ACPI_FUNCTION_STATUS_EXIT(s)
  391. #define ACPI_FUNCTION_VALUE_EXIT(s)
  392. #define ACPI_FUNCTION_ENTRY()
  393. #define ACPI_DUMP_STACK_ENTRY(a)
  394. #define ACPI_DUMP_OPERANDS(a, b, c)
  395. #define ACPI_DUMP_ENTRY(a, b)
  396. #define ACPI_DUMP_TABLES(a, b)
  397. #define ACPI_DUMP_PATHNAME(a, b, c, d)
  398. #define ACPI_DUMP_BUFFER(a, b)
  399. #define ACPI_DEBUG_PRINT(pl)
  400. #define ACPI_DEBUG_PRINT_RAW(pl)
  401. #define return_VOID return
  402. #define return_ACPI_STATUS(s) return(s)
  403. #define return_VALUE(s) return(s)
  404. #define return_UINT8(s) return(s)
  405. #define return_UINT32(s) return(s)
  406. #define return_PTR(s) return(s)
  407. #endif /* ACPI_DEBUG_OUTPUT */
  408. #if (!ACPI_REDUCED_HARDWARE)
  409. #define ACPI_HW_OPTIONAL_FUNCTION(addr) addr
  410. #else
  411. #define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL
  412. #endif
  413. /*
  414. * Some code only gets executed when the debugger is built in.
  415. * Note that this is entirely independent of whether the
  416. * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
  417. */
  418. #ifdef ACPI_DEBUGGER
  419. #define ACPI_DEBUGGER_EXEC(a) a
  420. #else
  421. #define ACPI_DEBUGGER_EXEC(a)
  422. #endif
  423. /*
  424. * Memory allocation tracking (DEBUG ONLY)
  425. */
  426. #define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
  427. #ifndef ACPI_DBG_TRACK_ALLOCATIONS
  428. /* Memory allocation */
  429. #ifndef ACPI_ALLOCATE
  430. #define ACPI_ALLOCATE(a) acpi_ut_allocate((acpi_size) (a), ACPI_MEM_PARAMETERS)
  431. #endif
  432. #ifndef ACPI_ALLOCATE_ZEROED
  433. #define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed((acpi_size) (a), ACPI_MEM_PARAMETERS)
  434. #endif
  435. #ifndef ACPI_FREE
  436. #define ACPI_FREE(a) acpi_os_free(a)
  437. #endif
  438. #define ACPI_MEM_TRACKING(a)
  439. #else
  440. /* Memory allocation */
  441. #define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track((acpi_size) (a), ACPI_MEM_PARAMETERS)
  442. #define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track((acpi_size) (a), ACPI_MEM_PARAMETERS)
  443. #define ACPI_FREE(a) acpi_ut_free_and_track(a, ACPI_MEM_PARAMETERS)
  444. #define ACPI_MEM_TRACKING(a) a
  445. #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
  446. /*
  447. * Macros used for ACPICA utilities only
  448. */
  449. /* Generate a UUID */
  450. #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
  451. (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
  452. (b) & 0xFF, ((b) >> 8) & 0xFF, \
  453. (c) & 0xFF, ((c) >> 8) & 0xFF, \
  454. (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
  455. #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7'))
  456. #endif /* ACMACROS_H */