asm-generic: make get_user() clear the destination on errors
[linux-2.6-block.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 - 2016, 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/* Common application configuration. All single threaded except for acpi_exec. */
70
71#if (defined ACPI_ASL_COMPILER) || \
72 (defined ACPI_BIN_APP) || \
73 (defined ACPI_DUMP_APP) || \
74 (defined ACPI_HELP_APP) || \
75 (defined ACPI_NAMES_APP) || \
76 (defined ACPI_SRC_APP) || \
77 (defined ACPI_XTRACT_APP) || \
78 (defined ACPI_EXAMPLE_APP)
79#define ACPI_APPLICATION
80#define ACPI_SINGLE_THREADED
81#endif
82
83/* iASL configuration */
84
85#ifdef ACPI_ASL_COMPILER
86#define ACPI_DEBUG_OUTPUT
87#define ACPI_CONSTANT_EVAL_ONLY
88#define ACPI_LARGE_NAMESPACE_NODE
89#define ACPI_DATA_TABLE_DISASSEMBLY
90#define ACPI_32BIT_PHYSICAL_ADDRESS
91#define ACPI_DISASSEMBLER 1
92#endif
93
94/* acpi_exec configuration. Multithreaded with full AML debugger */
95
96#ifdef ACPI_EXEC_APP
97#define ACPI_APPLICATION
98#define ACPI_FULL_DEBUG
99#define ACPI_MUTEX_DEBUG
100#define ACPI_DBG_TRACK_ALLOCATIONS
101#endif
102
103/* acpi_help configuration. Error messages disabled. */
104
105#ifdef ACPI_HELP_APP
106#define ACPI_NO_ERROR_MESSAGES
107#endif
108
109/* acpi_names configuration. Debug output enabled. */
110
111#ifdef ACPI_NAMES_APP
112#define ACPI_DEBUG_OUTPUT
113#endif
114
115/* acpi_exec/acpi_names/Example configuration. Native RSDP used. */
116
117#if (defined ACPI_EXEC_APP) || \
118 (defined ACPI_EXAMPLE_APP) || \
119 (defined ACPI_NAMES_APP)
120#define ACPI_USE_NATIVE_RSDP_POINTER
121#endif
122
123/* acpi_dump configuration. Native mapping used if provided by the host */
124
125#ifdef ACPI_DUMP_APP
126#define ACPI_USE_NATIVE_MEMORY_MAPPING
127#define USE_NATIVE_ALLOCATE_ZEROED
128#endif
129
130/* acpi_names/Example configuration. Hardware disabled */
131
132#if (defined ACPI_EXAMPLE_APP) || \
133 (defined ACPI_NAMES_APP)
134#define ACPI_REDUCED_HARDWARE 1
135#endif
136
137/* Linkable ACPICA library. Two versions, one with full debug. */
138
139#ifdef ACPI_LIBRARY
140#define ACPI_USE_LOCAL_CACHE
141#define ACPI_DEBUGGER 1
142#define ACPI_DISASSEMBLER 1
143
144#ifdef _DEBUG
145#define ACPI_DEBUG_OUTPUT
146#endif
147#endif
148
149/* Common for all ACPICA applications */
150
151#ifdef ACPI_APPLICATION
152#define ACPI_USE_SYSTEM_CLIBRARY
153#define ACPI_USE_LOCAL_CACHE
154#endif
155
156/* Common debug/disassembler support */
157
158#ifdef ACPI_FULL_DEBUG
159#define ACPI_DEBUG_OUTPUT
160#define ACPI_DEBUGGER 1
161#define ACPI_DISASSEMBLER 1
162#endif
163
164
165/*! [Begin] no source code translation */
166
167/******************************************************************************
168 *
169 * Host configuration files. The compiler configuration files are included
170 * by the host files.
171 *
172 *****************************************************************************/
173
174#if defined(_LINUX) || defined(__linux__)
175#include <acpi/platform/aclinux.h>
176
177#elif defined(_APPLE) || defined(__APPLE__)
178#include "acmacosx.h"
179
180#elif defined(__DragonFly__)
181#include "acdragonfly.h"
182
183#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
184#include "acfreebsd.h"
185
186#elif defined(__NetBSD__)
187#include "acnetbsd.h"
188
189#elif defined(__sun)
190#include "acsolaris.h"
191
192#elif defined(MODESTO)
193#include "acmodesto.h"
194
195#elif defined(NETWARE)
196#include "acnetware.h"
197
198#elif defined(_CYGWIN)
199#include "accygwin.h"
200
201#elif defined(WIN32)
202#include "acwin.h"
203
204#elif defined(WIN64)
205#include "acwin64.h"
206
207#elif defined(_WRS_LIB_BUILD)
208#include "acvxworks.h"
209
210#elif defined(__OS2__)
211#include "acos2.h"
212
213#elif defined(_AED_EFI)
214#include "acefi.h"
215
216#elif defined(_GNU_EFI)
217#include "acefi.h"
218
219#elif defined(__HAIKU__)
220#include "achaiku.h"
221
222#elif defined(__QNX__)
223#include "acqnx.h"
224
225#else
226
227/* Unknown environment */
228
229#error Unknown target environment
230#endif
231
232/*! [End] no source code translation !*/
233
234/******************************************************************************
235 *
236 * Setup defaults for the required symbols that were not defined in one of
237 * the host/compiler files above.
238 *
239 *****************************************************************************/
240
241/* 64-bit data types */
242
243#ifndef COMPILER_DEPENDENT_INT64
244#define COMPILER_DEPENDENT_INT64 long long
245#endif
246
247#ifndef COMPILER_DEPENDENT_UINT64
248#define COMPILER_DEPENDENT_UINT64 unsigned long long
249#endif
250
251/* Type of mutex supported by host. Default is binary semaphores. */
252#ifndef ACPI_MUTEX_TYPE
253#define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
254#endif
255
256/* Global Lock acquire/release */
257
258#ifndef ACPI_ACQUIRE_GLOBAL_LOCK
259#define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acquired) acquired = 1
260#endif
261
262#ifndef ACPI_RELEASE_GLOBAL_LOCK
263#define ACPI_RELEASE_GLOBAL_LOCK(Glptr, pending) pending = 0
264#endif
265
266/* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
267
268#ifndef ACPI_FLUSH_CPU_CACHE
269#define ACPI_FLUSH_CPU_CACHE()
270#endif
271
272/* "inline" keywords - configurable since inline is not standardized */
273
274#ifndef ACPI_INLINE
275#define ACPI_INLINE
276#endif
277
278/*
279 * Configurable calling conventions:
280 *
281 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
282 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
283 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
284 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
285 */
286#ifndef ACPI_SYSTEM_XFACE
287#define ACPI_SYSTEM_XFACE
288#endif
289
290#ifndef ACPI_EXTERNAL_XFACE
291#define ACPI_EXTERNAL_XFACE
292#endif
293
294#ifndef ACPI_INTERNAL_XFACE
295#define ACPI_INTERNAL_XFACE
296#endif
297
298#ifndef ACPI_INTERNAL_VAR_XFACE
299#define ACPI_INTERNAL_VAR_XFACE
300#endif
301
302/*
303 * Debugger threading model
304 * Use single threaded if the entire subsystem is contained in an application
305 * Use multiple threaded when the subsystem is running in the kernel.
306 *
307 * By default the model is single threaded if ACPI_APPLICATION is set,
308 * multi-threaded if ACPI_APPLICATION is not set.
309 */
310#ifndef DEBUGGER_THREADING
311#if !defined (ACPI_APPLICATION) || defined (ACPI_EXEC_APP)
312#define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
313
314#else
315#define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
316#endif
317#endif /* !DEBUGGER_THREADING */
318
319/******************************************************************************
320 *
321 * C library configuration
322 *
323 *****************************************************************************/
324
325/*
326 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
327 * Otherwise, local versions of string/memory functions will be used.
328 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
329 * the standard header files may be used.
330 *
331 * The ACPICA subsystem only uses low level C library functions that do not
332 * call operating system services and may therefore be inlined in the code.
333 *
334 * It may be necessary to tailor these include files to the target
335 * generation environment.
336 */
337#ifdef ACPI_USE_SYSTEM_CLIBRARY
338
339/* Use the standard C library headers. We want to keep these to a minimum. */
340
341#ifdef ACPI_USE_STANDARD_HEADERS
342
343/* Use the standard headers from the standard locations */
344
345#include <stdarg.h>
346#include <stdlib.h>
347#include <string.h>
348#include <ctype.h>
349
350#endif /* ACPI_USE_STANDARD_HEADERS */
351
352/* We will be linking to the standard Clib functions */
353
354#else
355
356/******************************************************************************
357 *
358 * Not using native C library, use local implementations
359 *
360 *****************************************************************************/
361
362/*
363 * Use local definitions of C library macros and functions. These function
364 * implementations may not be as efficient as an inline or assembly code
365 * implementation provided by a native C library, but they are functionally
366 * equivalent.
367 */
368#ifndef va_arg
369
370#ifndef _VALIST
371#define _VALIST
372typedef char *va_list;
373#endif /* _VALIST */
374
375/* Storage alignment properties */
376
377#define _AUPBND (sizeof (acpi_native_int) - 1)
378#define _ADNBND (sizeof (acpi_native_int) - 1)
379
380/* Variable argument list macro definitions */
381
382#define _bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
383#define va_arg(ap, T) (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND))))
384#define va_end(ap) (ap = (va_list) NULL)
385#define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND))))
386
387#endif /* va_arg */
388
389/* Use the local (ACPICA) definitions of the clib functions */
390
391#endif /* ACPI_USE_SYSTEM_CLIBRARY */
392
393#ifndef ACPI_FILE
394#ifdef ACPI_APPLICATION
395#include <stdio.h>
396#define ACPI_FILE FILE *
397#define ACPI_FILE_OUT stdout
398#define ACPI_FILE_ERR stderr
399#else
400#define ACPI_FILE void *
401#define ACPI_FILE_OUT NULL
402#define ACPI_FILE_ERR NULL
403#endif /* ACPI_APPLICATION */
404#endif /* ACPI_FILE */
405
406#endif /* __ACENV_H__ */