blob: ee5c0b98e53a052b1d1f62806c3de8cf462f2e76 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
Lv Zheng75c80442012-12-19 05:36:49 +00003 * Name: acenv.h - Host and compiler configuration
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 *****************************************************************************/
6
7/*
Bob Moorec8100dc2016-01-15 08:17:03 +08008 * Copyright (C) 2000 - 2016, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Lv Zheng0947c6d2012-12-20 01:07:15 +000047/*
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 */
Lv Zheng3e8214e2012-12-19 05:37:15 +000052
Bob Moore1685bd42008-12-31 03:03:29 +080053/* 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 * Configuration for ACPI tools and utilities
Bob Moore1685bd42008-12-31 03:03:29 +080066 *
67 *****************************************************************************/
68
Bob Moore95df7b52016-03-24 09:40:19 +080069/* 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
Lv Zheng556eae82016-08-04 16:44:24 +080081#define USE_NATIVE_ALLOCATE_ZEROED
Bob Moore95df7b52016-03-24 09:40:19 +080082#endif
83
Lv Zheng75c80442012-12-19 05:36:49 +000084/* iASL configuration */
Lv Zheng3e8214e2012-12-19 05:37:15 +000085
Robert Moore73459f72005-06-24 00:00:00 -040086#ifdef ACPI_ASL_COMPILER
Lv Zheng56324c12012-12-19 05:37:03 +000087#define ACPI_DEBUG_OUTPUT
Linus Torvalds1da177e2005-04-16 15:20:36 -070088#define ACPI_CONSTANT_EVAL_ONLY
Bob Moore83135242006-10-03 00:00:00 -040089#define ACPI_LARGE_NAMESPACE_NODE
Bob Moore793c2382006-03-31 00:00:00 -050090#define ACPI_DATA_TABLE_DISASSEMBLY
Lv Zheng2b876012015-04-13 11:48:58 +080091#define ACPI_32BIT_PHYSICAL_ADDRESS
Bob Moorecff94062015-08-25 10:30:11 +080092#define ACPI_DISASSEMBLER 1
Robert Moore73459f72005-06-24 00:00:00 -040093#endif
94
Lv Zheng75c80442012-12-19 05:36:49 +000095/* acpi_exec configuration. Multithreaded with full AML debugger */
Lv Zheng3e8214e2012-12-19 05:37:15 +000096
Bob Mooreb229cf92006-04-21 17:15:00 -040097#ifdef ACPI_EXEC_APP
Bob Mooreb229cf92006-04-21 17:15:00 -040098#define ACPI_APPLICATION
Lv Zheng56324c12012-12-19 05:37:03 +000099#define ACPI_FULL_DEBUG
Bob Mooreb229cf92006-04-21 17:15:00 -0400100#define ACPI_MUTEX_DEBUG
101#define ACPI_DBG_TRACK_ALLOCATIONS
102#endif
103
Lv Zhengafbdc6a2014-07-08 10:06:31 +0800104/* acpi_help configuration. Error messages disabled. */
105
Lv Zheng56324c12012-12-19 05:37:03 +0000106#ifdef ACPI_HELP_APP
Lv Zheng56324c12012-12-19 05:37:03 +0000107#define ACPI_NO_ERROR_MESSAGES
108#endif
109
Lv Zhengafbdc6a2014-07-08 10:06:31 +0800110/* acpi_names configuration. Debug output enabled. */
111
112#ifdef ACPI_NAMES_APP
113#define ACPI_DEBUG_OUTPUT
114#endif
115
116/* acpi_exec/acpi_names/Example configuration. Native RSDP used. */
117
118#if (defined ACPI_EXEC_APP) || \
119 (defined ACPI_EXAMPLE_APP) || \
120 (defined ACPI_NAMES_APP)
121#define ACPI_USE_NATIVE_RSDP_POINTER
122#endif
123
Bob Moore10ac2182015-08-25 10:29:17 +0800124/* acpi_dump configuration. Native mapping used if provided by the host */
Lv Zhengafbdc6a2014-07-08 10:06:31 +0800125
126#ifdef ACPI_DUMP_APP
127#define ACPI_USE_NATIVE_MEMORY_MAPPING
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
Bob Moore95df7b52016-03-24 09:40:19 +0800137/* Linkable ACPICA library. Two versions, one with full debug. */
Lv Zheng56324c12012-12-19 05:37:03 +0000138
139#ifdef ACPI_LIBRARY
140#define ACPI_USE_LOCAL_CACHE
Bob Moore95df7b52016-03-24 09:40:19 +0800141#define ACPI_DEBUGGER 1
142#define ACPI_DISASSEMBLER 1
143
144#ifdef _DEBUG
145#define ACPI_DEBUG_OUTPUT
146#endif
Lv Zheng56324c12012-12-19 05:37:03 +0000147#endif
148
Lv Zheng75c80442012-12-19 05:36:49 +0000149/* Common for all ACPICA applications */
Lv Zheng3e8214e2012-12-19 05:37:15 +0000150
Robert Moore73459f72005-06-24 00:00:00 -0400151#ifdef ACPI_APPLICATION
Robert Moore73459f72005-06-24 00:00:00 -0400152#define ACPI_USE_LOCAL_CACHE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#endif
154
Bob Moorecff94062015-08-25 10:30:11 +0800155/* Common debug/disassembler support */
Lv Zheng3e8214e2012-12-19 05:37:15 +0000156
Bob Mooreb229cf92006-04-21 17:15:00 -0400157#ifdef ACPI_FULL_DEBUG
Bob Mooreb229cf92006-04-21 17:15:00 -0400158#define ACPI_DEBUG_OUTPUT
Bob Moorecff94062015-08-25 10:30:11 +0800159#define ACPI_DEBUGGER 1
160#define ACPI_DISASSEMBLER 1
Bob Mooreb229cf92006-04-21 17:15:00 -0400161#endif
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164/*! [Begin] no source code translation */
165
Lv Zheng0947c6d2012-12-20 01:07:15 +0000166/******************************************************************************
167 *
168 * Host configuration files. The compiler configuration files are included
169 * by the host files.
170 *
171 *****************************************************************************/
Lv Zheng3e8214e2012-12-19 05:37:15 +0000172
Bob Moorea0a3f6c2007-03-27 20:25:46 -0400173#if defined(_LINUX) || defined(__linux__)
David Howellsa1ce3922012-10-02 18:01:25 +0100174#include <acpi/platform/aclinux.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Lv Zhenga4fb6142013-10-31 09:31:06 +0800176#elif defined(_APPLE) || defined(__APPLE__)
177#include "acmacosx.h"
178
Bob Mooref38a4372015-05-21 10:30:03 +0800179#elif defined(__DragonFly__)
180#include "acdragonfly.h"
181
Bob Moore793c2382006-03-31 00:00:00 -0500182#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183#include "acfreebsd.h"
184
185#elif defined(__NetBSD__)
186#include "acnetbsd.h"
187
Lv Zheng0947c6d2012-12-20 01:07:15 +0000188#elif defined(__sun)
189#include "acsolaris.h"
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191#elif defined(MODESTO)
192#include "acmodesto.h"
193
194#elif defined(NETWARE)
195#include "acnetware.h"
196
Lv Zheng0947c6d2012-12-20 01:07:15 +0000197#elif defined(_CYGWIN)
198#include "accygwin.h"
199
200#elif defined(WIN32)
201#include "acwin.h"
202
203#elif defined(WIN64)
204#include "acwin64.h"
205
206#elif defined(_WRS_LIB_BUILD)
207#include "acvxworks.h"
208
209#elif defined(__OS2__)
210#include "acos2.h"
211
212#elif defined(_AED_EFI)
213#include "acefi.h"
214
Lv Zhengafbdc6a2014-07-08 10:06:31 +0800215#elif defined(_GNU_EFI)
216#include "acefi.h"
217
Lv Zheng0947c6d2012-12-20 01:07:15 +0000218#elif defined(__HAIKU__)
219#include "achaiku.h"
Bob Mooreb8e4d892006-01-27 16:43:00 -0500220
Will Miles53c78d72016-03-24 09:40:26 +0800221#elif defined(__QNX__)
222#include "acqnx.h"
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#else
225
Lv Zheng0947c6d2012-12-20 01:07:15 +0000226/* Unknown environment */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Lv Zheng0947c6d2012-12-20 01:07:15 +0000228#error Unknown target environment
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229#endif
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231/*! [End] no source code translation !*/
232
Bob Moore1685bd42008-12-31 03:03:29 +0800233/******************************************************************************
234 *
Lv Zheng0947c6d2012-12-20 01:07:15 +0000235 * Setup defaults for the required symbols that were not defined in one of
236 * the host/compiler files above.
Bob Moore1685bd42008-12-31 03:03:29 +0800237 *
238 *****************************************************************************/
239
Lv Zheng0947c6d2012-12-20 01:07:15 +0000240/* 64-bit data types */
241
242#ifndef COMPILER_DEPENDENT_INT64
243#define COMPILER_DEPENDENT_INT64 long long
244#endif
245
246#ifndef COMPILER_DEPENDENT_UINT64
247#define COMPILER_DEPENDENT_UINT64 unsigned long long
248#endif
249
Lv Zheng75c80442012-12-19 05:36:49 +0000250/* Type of mutex supported by host. Default is binary semaphores. */
Bob Moore1685bd42008-12-31 03:03:29 +0800251#ifndef ACPI_MUTEX_TYPE
252#define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
253#endif
254
Lv Zheng0947c6d2012-12-20 01:07:15 +0000255/* Global Lock acquire/release */
256
257#ifndef ACPI_ACQUIRE_GLOBAL_LOCK
258#define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acquired) acquired = 1
259#endif
260
261#ifndef ACPI_RELEASE_GLOBAL_LOCK
262#define ACPI_RELEASE_GLOBAL_LOCK(Glptr, pending) pending = 0
263#endif
264
265/* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
266
267#ifndef ACPI_FLUSH_CPU_CACHE
268#define ACPI_FLUSH_CPU_CACHE()
269#endif
270
Lin Ming8f40f172010-09-15 13:36:55 +0800271/* "inline" keywords - configurable since inline is not standardized */
272
273#ifndef ACPI_INLINE
274#define ACPI_INLINE
275#endif
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277/*
Lv Zheng0947c6d2012-12-20 01:07:15 +0000278 * Configurable calling conventions:
279 *
280 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
281 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
282 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
283 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
284 */
285#ifndef ACPI_SYSTEM_XFACE
286#define ACPI_SYSTEM_XFACE
287#endif
288
289#ifndef ACPI_EXTERNAL_XFACE
290#define ACPI_EXTERNAL_XFACE
291#endif
292
293#ifndef ACPI_INTERNAL_XFACE
294#define ACPI_INTERNAL_XFACE
295#endif
296
297#ifndef ACPI_INTERNAL_VAR_XFACE
298#define ACPI_INTERNAL_VAR_XFACE
299#endif
300
301/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 * Debugger threading model
303 * Use single threaded if the entire subsystem is contained in an application
304 * Use multiple threaded when the subsystem is running in the kernel.
305 *
306 * By default the model is single threaded if ACPI_APPLICATION is set,
307 * multi-threaded if ACPI_APPLICATION is not set.
308 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309#ifndef DEBUGGER_THREADING
Bob Moorecd64bbf2015-10-19 10:24:45 +0800310#if !defined (ACPI_APPLICATION) || defined (ACPI_EXEC_APP)
311#define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313#else
Bob Moorecd64bbf2015-10-19 10:24:45 +0800314#define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#endif
Len Brown4be44fc2005-08-05 00:44:28 -0400316#endif /* !DEBUGGER_THREADING */
Robert Moore44f6c012005-04-18 22:49:35 -0400317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318/******************************************************************************
319 *
320 * C library configuration
321 *
322 *****************************************************************************/
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324/*
Lv Zheng0947c6d2012-12-20 01:07:15 +0000325 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
326 * Otherwise, local versions of string/memory functions will be used.
327 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
Lv Zhengda24f312016-08-04 16:44:44 +0800328 * the standard header files may be used. Defining this implies that
329 * ACPI_USE_SYSTEM_CLIBRARY has been defined.
Lv Zheng0947c6d2012-12-20 01:07:15 +0000330 *
Bob Moore10ac2182015-08-25 10:29:17 +0800331 * 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.
Lv Zheng0947c6d2012-12-20 01:07:15 +0000333 *
334 * It may be necessary to tailor these include files to the target
335 * generation environment.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 */
Lv Zheng0947c6d2012-12-20 01:07:15 +0000337
338/* Use the standard C library headers. We want to keep these to a minimum. */
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#ifdef ACPI_USE_STANDARD_HEADERS
Lv Zheng3e8214e2012-12-19 05:37:15 +0000341
Lv Zheng75c80442012-12-19 05:36:49 +0000342/* Use the standard headers from the standard locations */
Lv Zheng3e8214e2012-12-19 05:37:15 +0000343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344#include <stdlib.h>
345#include <string.h>
346#include <ctype.h>
347
Len Brown4be44fc2005-08-05 00:44:28 -0400348#endif /* ACPI_USE_STANDARD_HEADERS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Lv Zheng71487f3f2014-01-08 13:45:02 +0800350#ifndef ACPI_FILE
351#ifdef ACPI_APPLICATION
352#include <stdio.h>
353#define ACPI_FILE FILE *
Lv Zheng2e70da42014-07-08 10:07:06 +0800354#define ACPI_FILE_OUT stdout
355#define ACPI_FILE_ERR stderr
Lv Zheng71487f3f2014-01-08 13:45:02 +0800356#else
357#define ACPI_FILE void *
Lv Zheng2e70da42014-07-08 10:07:06 +0800358#define ACPI_FILE_OUT NULL
359#define ACPI_FILE_ERR NULL
Lv Zheng71487f3f2014-01-08 13:45:02 +0800360#endif /* ACPI_APPLICATION */
361#endif /* ACPI_FILE */
362
Lv Zheng2368b1a2016-08-04 16:43:19 +0800363#ifndef ACPI_INIT_FUNCTION
364#define ACPI_INIT_FUNCTION
365#endif
366
Len Brown4be44fc2005-08-05 00:44:28 -0400367#endif /* __ACENV_H__ */