xref: /openbmc/linux/include/acpi/platform/aclinux.h (revision 4f3db074)
1 /******************************************************************************
2  *
3  * Name: aclinux.h - OS specific defines, etc. for Linux
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 __ACLINUX_H__
45 #define __ACLINUX_H__
46 
47 #ifdef __KERNEL__
48 
49 /* ACPICA external files should not include ACPICA headers directly. */
50 
51 #if !defined(BUILDING_ACPICA) && !defined(_LINUX_ACPI_H)
52 #error "Please don't include <acpi/acpi.h> directly, include <linux/acpi.h> instead."
53 #endif
54 
55 #endif
56 
57 /* Common (in-kernel/user-space) ACPICA configuration */
58 
59 #define ACPI_USE_SYSTEM_CLIBRARY
60 #define ACPI_USE_DO_WHILE_0
61 
62 #ifdef __KERNEL__
63 
64 #define ACPI_USE_SYSTEM_INTTYPES
65 
66 /* Compile for reduced hardware mode only with this kernel config */
67 
68 #ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
69 #define ACPI_REDUCED_HARDWARE 1
70 #endif
71 
72 #include <linux/string.h>
73 #include <linux/kernel.h>
74 #include <linux/ctype.h>
75 #include <linux/sched.h>
76 #include <linux/atomic.h>
77 #include <linux/math64.h>
78 #include <linux/slab.h>
79 #include <linux/spinlock_types.h>
80 #ifdef EXPORT_ACPI_INTERFACES
81 #include <linux/export.h>
82 #endif
83 #ifdef CONFIG_ACPI
84 #include <asm/acenv.h>
85 #endif
86 
87 #ifndef CONFIG_ACPI
88 
89 /* External globals for __KERNEL__, stubs is needed */
90 
91 #define ACPI_GLOBAL(t,a)
92 #define ACPI_INIT_GLOBAL(t,a,b)
93 
94 /* Generating stubs for configurable ACPICA macros */
95 
96 #define ACPI_NO_MEM_ALLOCATIONS
97 
98 /* Generating stubs for configurable ACPICA functions */
99 
100 #define ACPI_NO_ERROR_MESSAGES
101 #undef ACPI_DEBUG_OUTPUT
102 
103 /* External interface for __KERNEL__, stub is needed */
104 
105 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
106 	static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
107 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
108 	static ACPI_INLINE prototype {return(AE_OK);}
109 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
110 	static ACPI_INLINE prototype {return;}
111 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
112 	static ACPI_INLINE prototype {return(0);}
113 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
114 	static ACPI_INLINE prototype {return(NULL);}
115 
116 #endif				/* CONFIG_ACPI */
117 
118 /* Host-dependent types and defines for in-kernel ACPICA */
119 
120 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
121 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
122 #define strtoul                     simple_strtoul
123 
124 #define acpi_cache_t                        struct kmem_cache
125 #define acpi_spinlock                       spinlock_t *
126 #define acpi_cpu_flags                      unsigned long
127 
128 /* Use native linux version of acpi_os_allocate_zeroed */
129 
130 #define USE_NATIVE_ALLOCATE_ZEROED
131 
132 /*
133  * Overrides for in-kernel ACPICA
134  */
135 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
136 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
137 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
138 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
139 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
140 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
141 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
142 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
143 
144 /*
145  * OSL interfaces used by debugger/disassembler
146  */
147 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
148 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
149 
150 /*
151  * OSL interfaces used by utilities
152  */
153 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
154 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
155 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
156 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
157 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
158 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
159 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
160 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
161 
162 #else				/* !__KERNEL__ */
163 
164 #include <stdarg.h>
165 #include <string.h>
166 #include <stdlib.h>
167 #include <ctype.h>
168 #include <unistd.h>
169 
170 /* Define/disable kernel-specific declarators */
171 
172 #ifndef __init
173 #define __init
174 #endif
175 
176 /* Host-dependent types and defines for user-space ACPICA */
177 
178 #define ACPI_FLUSH_CPU_CACHE()
179 #define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
180 
181 #if defined(__ia64__)    || defined(__x86_64__) ||\
182 	defined(__aarch64__) || defined(__PPC64__)
183 #define ACPI_MACHINE_WIDTH          64
184 #define COMPILER_DEPENDENT_INT64    long
185 #define COMPILER_DEPENDENT_UINT64   unsigned long
186 #else
187 #define ACPI_MACHINE_WIDTH          32
188 #define COMPILER_DEPENDENT_INT64    long long
189 #define COMPILER_DEPENDENT_UINT64   unsigned long long
190 #define ACPI_USE_NATIVE_DIVIDE
191 #endif
192 
193 #ifndef __cdecl
194 #define __cdecl
195 #endif
196 
197 #endif				/* __KERNEL__ */
198 
199 /* Linux uses GCC */
200 
201 #include <acpi/platform/acgcc.h>
202 
203 #endif				/* __ACLINUX_H__ */
204