]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/acpi/platform/acenv.h
1 /******************************************************************************
3 * Name: acenv.h - Generation environment specific items
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
48 * Configuration for ACPI tools and utilities
52 #define ACPI_USE_LOCAL_CACHE
57 #define ACPI_DEBUG_OUTPUT
59 #define ACPI_APPLICATION
60 #define ACPI_DISASSEMBLER
61 #define ACPI_NO_METHOD_EXECUTION
65 #undef DEBUGGER_THREADING
66 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
67 #define ACPI_DEBUG_OUTPUT
68 #define ACPI_APPLICATION
70 #define ACPI_DISASSEMBLER
73 #ifdef ACPI_ASL_COMPILER
74 #define ACPI_DEBUG_OUTPUT
75 #define ACPI_APPLICATION
76 #define ACPI_DISASSEMBLER
77 #define ACPI_CONSTANT_EVAL_ONLY
80 #ifdef ACPI_APPLICATION
81 #define ACPI_USE_SYSTEM_CLIBRARY
82 #define ACPI_USE_LOCAL_CACHE
86 * Environment configuration. The purpose of this file is to interface to the
87 * local generation environment.
89 * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
90 * Otherwise, local versions of string/memory functions will be used.
91 * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
92 * the standard header files may be used.
94 * The ACPI subsystem only uses low level C library functions that do not call
95 * operating system services and may therefore be inlined in the code.
97 * It may be necessary to tailor these include files to the target
98 * generation environment.
101 * Functions and constants used from each header:
122 /*! [Begin] no source code translation */
124 #if defined(__linux__)
127 #elif defined(_AED_EFI)
136 #elif defined(MSDOS) /* Must appear after WIN32 and WIN64 check */
139 #elif defined(__FreeBSD__)
140 #include "acfreebsd.h"
142 #elif defined(__NetBSD__)
143 #include "acnetbsd.h"
145 #elif defined(MODESTO)
146 #include "acmodesto.h"
148 #elif defined(NETWARE)
149 #include "acnetware.h"
153 /* All other environments */
155 #define ACPI_USE_STANDARD_HEADERS
157 #define COMPILER_DEPENDENT_INT64 long long
158 #define COMPILER_DEPENDENT_UINT64 unsigned long long
161 * This macro is used to tag functions as "printf-like" because
162 * some compilers can catch printf format string problems. MSVC
163 * doesn't, so this is proprocessed away.
165 #define ACPI_PRINTF_LIKE_FUNC
170 * Memory allocation tracking. Used only if
171 * 1) This is the debug version
172 * 2) This is NOT a 16-bit version of the code (not enough real-mode memory)
174 #ifdef ACPI_DEBUG_OUTPUT
175 #if ACPI_MACHINE_WIDTH != 16
176 #define ACPI_DBG_TRACK_ALLOCATIONS
180 /*! [End] no source code translation !*/
183 * Debugger threading model
184 * Use single threaded if the entire subsystem is contained in an application
185 * Use multiple threaded when the subsystem is running in the kernel.
187 * By default the model is single threaded if ACPI_APPLICATION is set,
188 * multi-threaded if ACPI_APPLICATION is not set.
190 #define DEBUGGER_SINGLE_THREADED 0
191 #define DEBUGGER_MULTI_THREADED 1
193 #ifndef DEBUGGER_THREADING
194 #ifdef ACPI_APPLICATION
195 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
198 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
200 #endif /* !DEBUGGER_THREADING */
202 /******************************************************************************
204 * C library configuration
206 *****************************************************************************/
208 #ifdef ACPI_USE_SYSTEM_CLIBRARY
210 * Use the standard C library headers.
211 * We want to keep these to a minimum.
213 #ifdef ACPI_USE_STANDARD_HEADERS
215 * Use the standard headers from the standard locations
222 #endif /* ACPI_USE_STANDARD_HEADERS */
225 * We will be linking to the standard Clib functions
227 #define ACPI_STRSTR(s1,s2) strstr((s1), (s2))
228 #define ACPI_STRCHR(s1,c) strchr((s1), (c))
229 #define ACPI_STRLEN(s) (acpi_size) strlen((s))
230 #define ACPI_STRCPY(d,s) (void) strcpy((d), (s))
231 #define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (acpi_size)(n))
232 #define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (acpi_size)(n))
233 #define ACPI_STRCMP(d,s) strcmp((d), (s))
234 #define ACPI_STRCAT(d,s) (void) strcat((d), (s))
235 #define ACPI_STRNCAT(d,s,n) strncat((d), (s), (acpi_size)(n))
236 #define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (acpi_size)(n))
237 #define ACPI_MEMCMP(s1,s2,n) memcmp((s1), (s2), (acpi_size)(n))
238 #define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (acpi_size)(n))
239 #define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (acpi_size)(n))
241 #define ACPI_TOUPPER(i) toupper((int) (i))
242 #define ACPI_TOLOWER(i) tolower((int) (i))
243 #define ACPI_IS_XDIGIT(i) isxdigit((int) (i))
244 #define ACPI_IS_DIGIT(i) isdigit((int) (i))
245 #define ACPI_IS_SPACE(i) isspace((int) (i))
246 #define ACPI_IS_UPPER(i) isupper((int) (i))
247 #define ACPI_IS_PRINT(i) isprint((int) (i))
248 #define ACPI_IS_ALPHA(i) isalpha((int) (i))
249 #define ACPI_IS_ASCII(i) isascii((int) (i))
253 /******************************************************************************
255 * Not using native C library, use local implementations
257 *****************************************************************************/
260 * Use local definitions of C library macros and functions
261 * NOTE: The function implementations may not be as efficient
262 * as an inline or assembly code implementation provided by a
270 typedef char *va_list;
274 * Storage alignment properties
276 #define _AUPBND (sizeof (acpi_native_int) - 1)
277 #define _ADNBND (sizeof (acpi_native_int) - 1)
280 * Variable argument list macro definitions
282 #define _bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
283 #define va_arg(ap, T) (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND))))
284 #define va_end(ap) (void) 0
285 #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND))))
289 #define ACPI_STRSTR(s1,s2) acpi_ut_strstr ((s1), (s2))
290 #define ACPI_STRCHR(s1,c) acpi_ut_strchr ((s1), (c))
291 #define ACPI_STRLEN(s) (acpi_size) acpi_ut_strlen ((s))
292 #define ACPI_STRCPY(d,s) (void) acpi_ut_strcpy ((d), (s))
293 #define ACPI_STRNCPY(d,s,n) (void) acpi_ut_strncpy ((d), (s), (acpi_size)(n))
294 #define ACPI_STRNCMP(d,s,n) acpi_ut_strncmp ((d), (s), (acpi_size)(n))
295 #define ACPI_STRCMP(d,s) acpi_ut_strcmp ((d), (s))
296 #define ACPI_STRCAT(d,s) (void) acpi_ut_strcat ((d), (s))
297 #define ACPI_STRNCAT(d,s,n) acpi_ut_strncat ((d), (s), (acpi_size)(n))
298 #define ACPI_STRTOUL(d,s,n) acpi_ut_strtoul ((d), (s), (acpi_size)(n))
299 #define ACPI_MEMCMP(s1,s2,n) acpi_ut_memcmp((s1), (s2), (acpi_size)(n))
300 #define ACPI_MEMCPY(d,s,n) (void) acpi_ut_memcpy ((d), (s), (acpi_size)(n))
301 #define ACPI_MEMSET(d,v,n) (void) acpi_ut_memset ((d), (v), (acpi_size)(n))
302 #define ACPI_TOUPPER acpi_ut_to_upper
303 #define ACPI_TOLOWER acpi_ut_to_lower
305 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
307 /******************************************************************************
309 * Assembly code macros
311 *****************************************************************************/
314 * Handle platform- and compiler-specific assembly language differences.
315 * These should already have been defined by the platform includes above.
318 * 1) Interrupt 3 is used to break into a debugger
319 * 2) Interrupts are turned off during ACPI register setup
322 /* Unrecognized compiler, use defaults */
324 #ifndef ACPI_ASM_MACROS
327 * Calling conventions:
329 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
330 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
331 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
332 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
334 #define ACPI_SYSTEM_XFACE
335 #define ACPI_EXTERNAL_XFACE
336 #define ACPI_INTERNAL_XFACE
337 #define ACPI_INTERNAL_VAR_XFACE
339 #define ACPI_ASM_MACROS
341 #define ACPI_DISABLE_IRQS()
342 #define ACPI_ENABLE_IRQS()
343 #define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acq)
344 #define ACPI_RELEASE_GLOBAL_LOCK(Glptr, acq)
346 #endif /* ACPI_ASM_MACROS */
348 #ifdef ACPI_APPLICATION
350 /* Don't want software interrupts within a ring3 application */
356 /******************************************************************************
358 * Compiler-specific information is contained in the compiler-specific
361 *****************************************************************************/
362 #endif /* __ACENV_H__ */