acenv.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. /******************************************************************************
  2. *
  3. * Name: acenv.h - Generation environment specific items
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2005, 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 __ACENV_H__
  43. #define __ACENV_H__
  44. /*
  45. * Configuration for ACPI tools and utilities
  46. */
  47. #ifdef _ACPI_DUMP_APP
  48. #ifndef MSDOS
  49. #define ACPI_DEBUG_OUTPUT
  50. #endif
  51. #define ACPI_APPLICATION
  52. #define ACPI_DISASSEMBLER
  53. #define ACPI_NO_METHOD_EXECUTION
  54. #define ACPI_USE_SYSTEM_CLIBRARY
  55. #define ACPI_ENABLE_OBJECT_CACHE
  56. #endif
  57. #ifdef _ACPI_EXEC_APP
  58. #undef DEBUGGER_THREADING
  59. #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
  60. #define ACPI_DEBUG_OUTPUT
  61. #define ACPI_APPLICATION
  62. #define ACPI_DEBUGGER
  63. #define ACPI_DISASSEMBLER
  64. #define ACPI_USE_SYSTEM_CLIBRARY
  65. #define ACPI_ENABLE_OBJECT_CACHE
  66. #endif
  67. #ifdef _ACPI_ASL_COMPILER
  68. #define ACPI_DEBUG_OUTPUT
  69. #define ACPI_APPLICATION
  70. #define ACPI_DISASSEMBLER
  71. #define ACPI_CONSTANT_EVAL_ONLY
  72. #define ACPI_USE_SYSTEM_CLIBRARY
  73. #define ACPI_ENABLE_OBJECT_CACHE
  74. #endif
  75. /*
  76. * Environment configuration. The purpose of this file is to interface to the
  77. * local generation environment.
  78. *
  79. * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
  80. * Otherwise, local versions of string/memory functions will be used.
  81. * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
  82. * the standard header files may be used.
  83. *
  84. * The ACPI subsystem only uses low level C library functions that do not call
  85. * operating system services and may therefore be inlined in the code.
  86. *
  87. * It may be necessary to tailor these include files to the target
  88. * generation environment.
  89. *
  90. *
  91. * Functions and constants used from each header:
  92. *
  93. * string.h: memcpy
  94. * memset
  95. * strcat
  96. * strcmp
  97. * strcpy
  98. * strlen
  99. * strncmp
  100. * strncat
  101. * strncpy
  102. *
  103. * stdlib.h: strtoul
  104. *
  105. * stdarg.h: va_list
  106. * va_arg
  107. * va_start
  108. * va_end
  109. *
  110. */
  111. /*! [Begin] no source code translation */
  112. #if defined(__linux__)
  113. #include "aclinux.h"
  114. #elif defined(_AED_EFI)
  115. #include "acefi.h"
  116. #elif defined(WIN32)
  117. #include "acwin.h"
  118. #elif defined(WIN64)
  119. #include "acwin64.h"
  120. #elif defined(MSDOS) /* Must appear after WIN32 and WIN64 check */
  121. #include "acdos16.h"
  122. #elif defined(__FreeBSD__)
  123. #include "acfreebsd.h"
  124. #elif defined(__NetBSD__)
  125. #include "acnetbsd.h"
  126. #elif defined(MODESTO)
  127. #include "acmodesto.h"
  128. #elif defined(NETWARE)
  129. #include "acnetware.h"
  130. #else
  131. /* All other environments */
  132. #define ACPI_USE_STANDARD_HEADERS
  133. #define COMPILER_DEPENDENT_INT64 long long
  134. #define COMPILER_DEPENDENT_UINT64 unsigned long long
  135. /*
  136. * This macro is used to tag functions as "printf-like" because
  137. * some compilers can catch printf format string problems. MSVC
  138. * doesn't, so this is proprocessed away.
  139. */
  140. #define ACPI_PRINTF_LIKE_FUNC
  141. #endif
  142. /*
  143. * Memory allocation tracking. Used only if
  144. * 1) This is the debug version
  145. * 2) This is NOT a 16-bit version of the code (not enough real-mode memory)
  146. */
  147. #ifdef ACPI_DEBUG_OUTPUT
  148. #if ACPI_MACHINE_WIDTH != 16
  149. #define ACPI_DBG_TRACK_ALLOCATIONS
  150. #endif
  151. #endif
  152. /*! [End] no source code translation !*/
  153. /*
  154. * Debugger threading model
  155. * Use single threaded if the entire subsystem is contained in an application
  156. * Use multiple threaded when the subsystem is running in the kernel.
  157. *
  158. * By default the model is single threaded if ACPI_APPLICATION is set,
  159. * multi-threaded if ACPI_APPLICATION is not set.
  160. */
  161. #define DEBUGGER_SINGLE_THREADED 0
  162. #define DEBUGGER_MULTI_THREADED 1
  163. #ifndef DEBUGGER_THREADING
  164. #ifdef ACPI_APPLICATION
  165. #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
  166. #else
  167. #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
  168. #endif
  169. #endif /* !DEBUGGER_THREADING */
  170. /******************************************************************************
  171. *
  172. * C library configuration
  173. *
  174. *****************************************************************************/
  175. #ifdef ACPI_USE_SYSTEM_CLIBRARY
  176. /*
  177. * Use the standard C library headers.
  178. * We want to keep these to a minimum.
  179. */
  180. #ifdef ACPI_USE_STANDARD_HEADERS
  181. /*
  182. * Use the standard headers from the standard locations
  183. */
  184. #include <stdarg.h>
  185. #include <stdlib.h>
  186. #include <string.h>
  187. #include <ctype.h>
  188. #endif /* ACPI_USE_STANDARD_HEADERS */
  189. /*
  190. * We will be linking to the standard Clib functions
  191. */
  192. #define ACPI_STRSTR(s1,s2) strstr((s1), (s2))
  193. #define ACPI_STRCHR(s1,c) strchr((s1), (c))
  194. #ifdef ACPI_FUTURE_USAGE
  195. #define ACPI_STRUPR(s) (void) acpi_ut_strupr ((s))
  196. #endif
  197. #define ACPI_STRLEN(s) (acpi_size) strlen((s))
  198. #define ACPI_STRCPY(d,s) (void) strcpy((d), (s))
  199. #define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (acpi_size)(n))
  200. #define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (acpi_size)(n))
  201. #define ACPI_STRCMP(d,s) strcmp((d), (s))
  202. #define ACPI_STRCAT(d,s) (void) strcat((d), (s))
  203. #define ACPI_STRNCAT(d,s,n) strncat((d), (s), (acpi_size)(n))
  204. #define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (acpi_size)(n))
  205. #define ACPI_MEMCMP(s1,s2,n) memcmp((s1), (s2), (acpi_size)(n))
  206. #define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (acpi_size)(n))
  207. #define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (acpi_size)(n))
  208. #define ACPI_TOUPPER toupper
  209. #define ACPI_TOLOWER tolower
  210. #define ACPI_IS_XDIGIT isxdigit
  211. #define ACPI_IS_DIGIT isdigit
  212. #define ACPI_IS_SPACE isspace
  213. #define ACPI_IS_UPPER isupper
  214. #define ACPI_IS_PRINT isprint
  215. #define ACPI_IS_ALPHA isalpha
  216. #define ACPI_IS_ASCII isascii
  217. /******************************************************************************
  218. *
  219. * Not using native C library, use local implementations
  220. *
  221. *****************************************************************************/
  222. #else
  223. /*
  224. * Use local definitions of C library macros and functions
  225. * NOTE: The function implementations may not be as efficient
  226. * as an inline or assembly code implementation provided by a
  227. * native C library.
  228. */
  229. #ifndef va_arg
  230. #ifndef _VALIST
  231. #define _VALIST
  232. typedef char *va_list;
  233. #endif /* _VALIST */
  234. /*
  235. * Storage alignment properties
  236. */
  237. #define _AUPBND (sizeof (acpi_native_int) - 1)
  238. #define _ADNBND (sizeof (acpi_native_int) - 1)
  239. /*
  240. * Variable argument list macro definitions
  241. */
  242. #define _bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
  243. #define va_arg(ap, T) (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND))))
  244. #define va_end(ap) (void) 0
  245. #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND))))
  246. #endif /* va_arg */
  247. #define ACPI_STRSTR(s1,s2) acpi_ut_strstr ((s1), (s2))
  248. #define ACPI_STRCHR(s1,c) acpi_ut_strchr ((s1), (c))
  249. #ifdef ACPI_FUTURE_USAGE
  250. #define ACPI_STRUPR(s) (void) acpi_ut_strupr ((s))
  251. #endif
  252. #define ACPI_STRLEN(s) (acpi_size) acpi_ut_strlen ((s))
  253. #define ACPI_STRCPY(d,s) (void) acpi_ut_strcpy ((d), (s))
  254. #define ACPI_STRNCPY(d,s,n) (void) acpi_ut_strncpy ((d), (s), (acpi_size)(n))
  255. #define ACPI_STRNCMP(d,s,n) acpi_ut_strncmp ((d), (s), (acpi_size)(n))
  256. #define ACPI_STRCMP(d,s) acpi_ut_strcmp ((d), (s))
  257. #define ACPI_STRCAT(d,s) (void) acpi_ut_strcat ((d), (s))
  258. #define ACPI_STRNCAT(d,s,n) acpi_ut_strncat ((d), (s), (acpi_size)(n))
  259. #define ACPI_STRTOUL(d,s,n) acpi_ut_strtoul ((d), (s), (acpi_size)(n))
  260. #define ACPI_MEMCMP(s1,s2,n) acpi_ut_memcmp((s1), (s2), (acpi_size)(n))
  261. #define ACPI_MEMCPY(d,s,n) (void) acpi_ut_memcpy ((d), (s), (acpi_size)(n))
  262. #define ACPI_MEMSET(d,v,n) (void) acpi_ut_memset ((d), (v), (acpi_size)(n))
  263. #define ACPI_TOUPPER acpi_ut_to_upper
  264. #define ACPI_TOLOWER acpi_ut_to_lower
  265. #endif /* ACPI_USE_SYSTEM_CLIBRARY */
  266. /******************************************************************************
  267. *
  268. * Assembly code macros
  269. *
  270. *****************************************************************************/
  271. /*
  272. * Handle platform- and compiler-specific assembly language differences.
  273. * These should already have been defined by the platform includes above.
  274. *
  275. * Notes:
  276. * 1) Interrupt 3 is used to break into a debugger
  277. * 2) Interrupts are turned off during ACPI register setup
  278. */
  279. /* Unrecognized compiler, use defaults */
  280. #ifndef ACPI_ASM_MACROS
  281. /*
  282. * Calling conventions:
  283. *
  284. * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
  285. * ACPI_EXTERNAL_XFACE - External ACPI interfaces
  286. * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
  287. * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
  288. */
  289. #define ACPI_SYSTEM_XFACE
  290. #define ACPI_EXTERNAL_XFACE
  291. #define ACPI_INTERNAL_XFACE
  292. #define ACPI_INTERNAL_VAR_XFACE
  293. #define ACPI_ASM_MACROS
  294. #define BREAKPOINT3
  295. #define ACPI_DISABLE_IRQS()
  296. #define ACPI_ENABLE_IRQS()
  297. #define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acq)
  298. #define ACPI_RELEASE_GLOBAL_LOCK(Glptr, acq)
  299. #endif /* ACPI_ASM_MACROS */
  300. #ifdef ACPI_APPLICATION
  301. /* Don't want software interrupts within a ring3 application */
  302. #undef BREAKPOINT3
  303. #define BREAKPOINT3
  304. #endif
  305. /******************************************************************************
  306. *
  307. * Compiler-specific information is contained in the compiler-specific
  308. * headers.
  309. *
  310. *****************************************************************************/
  311. #endif /* __ACENV_H__ */