acmacros.h 27 KB

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