acenv.h 12 KB

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