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