ACPICA: Utilities: Cleanup to remove useless ACPI_PRINTF/FORMAT_xxx helpers.
[deliverable/linux.git] / include / acpi / platform / acenv.h
... / ...
CommitLineData
1/******************************************************************************
2 *
3 * Name: acenv.h - Host and compiler configuration
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, 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/*
48 * Environment configuration. The purpose of this file is to interface ACPICA
49 * to the local environment. This includes compiler-specific, OS-specific,
50 * and machine-specific configuration.
51 */
52
53/* Types for ACPI_MUTEX_TYPE */
54
55#define ACPI_BINARY_SEMAPHORE 0
56#define ACPI_OSL_MUTEX 1
57
58/* Types for DEBUGGER_THREADING */
59
60#define DEBUGGER_SINGLE_THREADED 0
61#define DEBUGGER_MULTI_THREADED 1
62
63/******************************************************************************
64 *
65 * Configuration for ACPI tools and utilities
66 *
67 *****************************************************************************/
68
69/* iASL configuration */
70
71#ifdef ACPI_ASL_COMPILER
72#define ACPI_APPLICATION
73#define ACPI_DISASSEMBLER
74#define ACPI_DEBUG_OUTPUT
75#define ACPI_CONSTANT_EVAL_ONLY
76#define ACPI_LARGE_NAMESPACE_NODE
77#define ACPI_DATA_TABLE_DISASSEMBLY
78#define ACPI_SINGLE_THREADED
79#endif
80
81/* acpi_exec configuration. Multithreaded with full AML debugger */
82
83#ifdef ACPI_EXEC_APP
84#define ACPI_APPLICATION
85#define ACPI_FULL_DEBUG
86#define ACPI_MUTEX_DEBUG
87#define ACPI_DBG_TRACK_ALLOCATIONS
88#endif
89
90/*
91 * acpi_bin/acpi_dump/acpi_help/acpi_names/acpi_src/acpi_xtract/Example configuration.
92 * All single threaded.
93 */
94#if (defined ACPI_BIN_APP) || \
95 (defined ACPI_DUMP_APP) || \
96 (defined ACPI_HELP_APP) || \
97 (defined ACPI_NAMES_APP) || \
98 (defined ACPI_SRC_APP) || \
99 (defined ACPI_XTRACT_APP) || \
100 (defined ACPI_EXAMPLE_APP)
101#define ACPI_APPLICATION
102#define ACPI_SINGLE_THREADED
103#endif
104
105/* acpi_help configuration. Error messages disabled. */
106
107#ifdef ACPI_HELP_APP
108#define ACPI_NO_ERROR_MESSAGES
109#endif
110
111/* acpi_names configuration. Debug output enabled. */
112
113#ifdef ACPI_NAMES_APP
114#define ACPI_DEBUG_OUTPUT
115#endif
116
117/* acpi_exec/acpi_names/Example configuration. Native RSDP used. */
118
119#if (defined ACPI_EXEC_APP) || \
120 (defined ACPI_EXAMPLE_APP) || \
121 (defined ACPI_NAMES_APP)
122#define ACPI_USE_NATIVE_RSDP_POINTER
123#endif
124
125/* acpi_dump configuration. Native mapping used if provied by OSPMs */
126
127#ifdef ACPI_DUMP_APP
128#define ACPI_USE_NATIVE_MEMORY_MAPPING
129#define USE_NATIVE_ALLOCATE_ZEROED
130#endif
131
132/* acpi_names/Example configuration. Hardware disabled */
133
134#if (defined ACPI_EXAMPLE_APP) || \
135 (defined ACPI_NAMES_APP)
136#define ACPI_REDUCED_HARDWARE 1
137#endif
138
139/* Linkable ACPICA library */
140
141#ifdef ACPI_LIBRARY
142#define ACPI_USE_LOCAL_CACHE
143#define ACPI_FUTURE_USAGE
144#endif
145
146/* Common for all ACPICA applications */
147
148#ifdef ACPI_APPLICATION
149#define ACPI_USE_SYSTEM_CLIBRARY
150#define ACPI_USE_LOCAL_CACHE
151#endif
152
153/* Common debug support */
154
155#ifdef ACPI_FULL_DEBUG
156#define ACPI_DEBUGGER
157#define ACPI_DEBUG_OUTPUT
158#define ACPI_DISASSEMBLER
159#endif
160
161
162/*! [Begin] no source code translation */
163
164/******************************************************************************
165 *
166 * Host configuration files. The compiler configuration files are included
167 * by the host files.
168 *
169 *****************************************************************************/
170
171#if defined(_LINUX) || defined(__linux__)
172#include <acpi/platform/aclinux.h>
173
174#elif defined(_APPLE) || defined(__APPLE__)
175#include "acmacosx.h"
176
177#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
178#include "acfreebsd.h"
179
180#elif defined(__NetBSD__)
181#include "acnetbsd.h"
182
183#elif defined(__sun)
184#include "acsolaris.h"
185
186#elif defined(MODESTO)
187#include "acmodesto.h"
188
189#elif defined(NETWARE)
190#include "acnetware.h"
191
192#elif defined(_CYGWIN)
193#include "accygwin.h"
194
195#elif defined(WIN32)
196#include "acwin.h"
197
198#elif defined(WIN64)
199#include "acwin64.h"
200
201#elif defined(_WRS_LIB_BUILD)
202#include "acvxworks.h"
203
204#elif defined(__OS2__)
205#include "acos2.h"
206
207#elif defined(_AED_EFI)
208#include "acefi.h"
209
210#elif defined(_GNU_EFI)
211#include "acefi.h"
212
213#elif defined(__HAIKU__)
214#include "achaiku.h"
215
216#else
217
218/* Unknown environment */
219
220#error Unknown target environment
221#endif
222
223/*! [End] no source code translation !*/
224
225/******************************************************************************
226 *
227 * Setup defaults for the required symbols that were not defined in one of
228 * the host/compiler files above.
229 *
230 *****************************************************************************/
231
232/* 64-bit data types */
233
234#ifndef COMPILER_DEPENDENT_INT64
235#define COMPILER_DEPENDENT_INT64 long long
236#endif
237
238#ifndef COMPILER_DEPENDENT_UINT64
239#define COMPILER_DEPENDENT_UINT64 unsigned long long
240#endif
241
242/* Type of mutex supported by host. Default is binary semaphores. */
243#ifndef ACPI_MUTEX_TYPE
244#define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
245#endif
246
247/* Global Lock acquire/release */
248
249#ifndef ACPI_ACQUIRE_GLOBAL_LOCK
250#define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acquired) acquired = 1
251#endif
252
253#ifndef ACPI_RELEASE_GLOBAL_LOCK
254#define ACPI_RELEASE_GLOBAL_LOCK(Glptr, pending) pending = 0
255#endif
256
257/* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
258
259#ifndef ACPI_FLUSH_CPU_CACHE
260#define ACPI_FLUSH_CPU_CACHE()
261#endif
262
263/* "inline" keywords - configurable since inline is not standardized */
264
265#ifndef ACPI_INLINE
266#define ACPI_INLINE
267#endif
268
269/*
270 * Configurable calling conventions:
271 *
272 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
273 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
274 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
275 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
276 */
277#ifndef ACPI_SYSTEM_XFACE
278#define ACPI_SYSTEM_XFACE
279#endif
280
281#ifndef ACPI_EXTERNAL_XFACE
282#define ACPI_EXTERNAL_XFACE
283#endif
284
285#ifndef ACPI_INTERNAL_XFACE
286#define ACPI_INTERNAL_XFACE
287#endif
288
289#ifndef ACPI_INTERNAL_VAR_XFACE
290#define ACPI_INTERNAL_VAR_XFACE
291#endif
292
293/*
294 * Debugger threading model
295 * Use single threaded if the entire subsystem is contained in an application
296 * Use multiple threaded when the subsystem is running in the kernel.
297 *
298 * By default the model is single threaded if ACPI_APPLICATION is set,
299 * multi-threaded if ACPI_APPLICATION is not set.
300 */
301#ifndef DEBUGGER_THREADING
302#ifdef ACPI_APPLICATION
303#define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
304
305#else
306#define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
307#endif
308#endif /* !DEBUGGER_THREADING */
309
310/******************************************************************************
311 *
312 * C library configuration
313 *
314 *****************************************************************************/
315
316/*
317 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
318 * Otherwise, local versions of string/memory functions will be used.
319 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
320 * the standard header files may be used.
321 *
322 * The ACPICA subsystem only uses low level C library functions that do not call
323 * operating system services and may therefore be inlined in the code.
324 *
325 * It may be necessary to tailor these include files to the target
326 * generation environment.
327 */
328#ifdef ACPI_USE_SYSTEM_CLIBRARY
329
330/* Use the standard C library headers. We want to keep these to a minimum. */
331
332#ifdef ACPI_USE_STANDARD_HEADERS
333
334/* Use the standard headers from the standard locations */
335
336#include <stdarg.h>
337#include <stdlib.h>
338#include <string.h>
339#include <ctype.h>
340
341#endif /* ACPI_USE_STANDARD_HEADERS */
342
343/* We will be linking to the standard Clib functions */
344
345#define ACPI_STRSTR(s1,s2) strstr((s1), (s2))
346#define ACPI_STRCHR(s1,c) strchr((s1), (c))
347#define ACPI_STRLEN(s) (acpi_size) strlen((s))
348#define ACPI_STRCPY(d,s) (void) strcpy((d), (s))
349#define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (acpi_size)(n))
350#define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (acpi_size)(n))
351#define ACPI_STRCMP(d,s) strcmp((d), (s))
352#define ACPI_STRCAT(d,s) (void) strcat((d), (s))
353#define ACPI_STRNCAT(d,s,n) strncat((d), (s), (acpi_size)(n))
354#define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (acpi_size)(n))
355#define ACPI_MEMCMP(s1,s2,n) memcmp((const char *)(s1), (const char *)(s2), (acpi_size)(n))
356#define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (acpi_size)(n))
357#define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (acpi_size)(n))
358
359#define ACPI_TOUPPER(i) toupper((int) (i))
360#define ACPI_TOLOWER(i) tolower((int) (i))
361#define ACPI_IS_XDIGIT(i) isxdigit((int) (i))
362#define ACPI_IS_DIGIT(i) isdigit((int) (i))
363#define ACPI_IS_SPACE(i) isspace((int) (i))
364#define ACPI_IS_UPPER(i) isupper((int) (i))
365#define ACPI_IS_PRINT(i) isprint((int) (i))
366#define ACPI_IS_ALPHA(i) isalpha((int) (i))
367
368#else
369
370/******************************************************************************
371 *
372 * Not using native C library, use local implementations
373 *
374 *****************************************************************************/
375
376/*
377 * Use local definitions of C library macros and functions. These function
378 * implementations may not be as efficient as an inline or assembly code
379 * implementation provided by a native C library, but they are functionally
380 * equivalent.
381 */
382#ifndef va_arg
383
384#ifndef _VALIST
385#define _VALIST
386typedef char *va_list;
387#endif /* _VALIST */
388
389/* Storage alignment properties */
390
391#define _AUPBND (sizeof (acpi_native_int) - 1)
392#define _ADNBND (sizeof (acpi_native_int) - 1)
393
394/* Variable argument list macro definitions */
395
396#define _bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
397#define va_arg(ap, T) (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND))))
398#define va_end(ap) (ap = (va_list) NULL)
399#define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND))))
400
401#endif /* va_arg */
402
403/* Use the local (ACPICA) definitions of the clib functions */
404
405#define ACPI_STRSTR(s1,s2) acpi_ut_strstr ((s1), (s2))
406#define ACPI_STRCHR(s1,c) acpi_ut_strchr ((s1), (c))
407#define ACPI_STRLEN(s) (acpi_size) acpi_ut_strlen ((s))
408#define ACPI_STRCPY(d,s) (void) acpi_ut_strcpy ((d), (s))
409#define ACPI_STRNCPY(d,s,n) (void) acpi_ut_strncpy ((d), (s), (acpi_size)(n))
410#define ACPI_STRNCMP(d,s,n) acpi_ut_strncmp ((d), (s), (acpi_size)(n))
411#define ACPI_STRCMP(d,s) acpi_ut_strcmp ((d), (s))
412#define ACPI_STRCAT(d,s) (void) acpi_ut_strcat ((d), (s))
413#define ACPI_STRNCAT(d,s,n) acpi_ut_strncat ((d), (s), (acpi_size)(n))
414#define ACPI_STRTOUL(d,s,n) acpi_ut_strtoul ((d), (s), (acpi_size)(n))
415#define ACPI_MEMCMP(s1,s2,n) acpi_ut_memcmp((const char *)(s1), (const char *)(s2), (acpi_size)(n))
416#define ACPI_MEMCPY(d,s,n) (void) acpi_ut_memcpy ((d), (s), (acpi_size)(n))
417#define ACPI_MEMSET(d,v,n) (void) acpi_ut_memset ((d), (v), (acpi_size)(n))
418#define ACPI_TOUPPER(c) acpi_ut_to_upper ((int) (c))
419#define ACPI_TOLOWER(c) acpi_ut_to_lower ((int) (c))
420
421#endif /* ACPI_USE_SYSTEM_CLIBRARY */
422
423#ifndef ACPI_FILE
424#ifdef ACPI_APPLICATION
425#include <stdio.h>
426#define ACPI_FILE FILE *
427#define ACPI_FILE_OUT stdout
428#define ACPI_FILE_ERR stderr
429#else
430#define ACPI_FILE void *
431#define ACPI_FILE_OUT NULL
432#define ACPI_FILE_ERR NULL
433#endif /* ACPI_APPLICATION */
434#endif /* ACPI_FILE */
435
436#endif /* __ACENV_H__ */
This page took 0.045193 seconds and 5 git commands to generate.