Loading...
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: aclinux.h - OS specific defines, etc. for Linux
5 *
6 * Copyright (C) 2000 - 2019, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef __ACLINUX_H__
11#define __ACLINUX_H__
12
13#ifdef __KERNEL__
14
15/* ACPICA external files should not include ACPICA headers directly. */
16
17#if !defined(BUILDING_ACPICA) && !defined(_LINUX_ACPI_H)
18#error "Please don't include <acpi/acpi.h> directly, include <linux/acpi.h> instead."
19#endif
20
21#endif
22
23/* Common (in-kernel/user-space) ACPICA configuration */
24
25#define ACPI_USE_SYSTEM_CLIBRARY
26#define ACPI_USE_DO_WHILE_0
27#define ACPI_IGNORE_PACKAGE_RESOLUTION_ERRORS
28
29#ifdef __KERNEL__
30
31#define ACPI_USE_SYSTEM_INTTYPES
32#define ACPI_USE_GPE_POLLING
33
34/* Kernel specific ACPICA configuration */
35
36#ifdef CONFIG_PCI
37#define ACPI_PCI_CONFIGURED
38#endif
39
40#ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
41#define ACPI_REDUCED_HARDWARE 1
42#endif
43
44#ifdef CONFIG_ACPI_DEBUGGER
45#define ACPI_DEBUGGER
46#endif
47
48#ifdef CONFIG_ACPI_DEBUG
49#define ACPI_MUTEX_DEBUG
50#endif
51
52#include <linux/string.h>
53#include <linux/kernel.h>
54#include <linux/ctype.h>
55#include <linux/sched.h>
56#include <linux/atomic.h>
57#include <linux/math64.h>
58#include <linux/slab.h>
59#include <linux/spinlock_types.h>
60#ifdef EXPORT_ACPI_INTERFACES
61#include <linux/export.h>
62#endif
63#ifdef CONFIG_ACPI
64#include <asm/acenv.h>
65#endif
66
67#define ACPI_INIT_FUNCTION __init
68
69/* Use a specific bugging default separate from ACPICA */
70
71#undef ACPI_DEBUG_DEFAULT
72#define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR)
73
74#ifndef CONFIG_ACPI
75
76/* External globals for __KERNEL__, stubs is needed */
77
78#define ACPI_GLOBAL(t,a)
79#define ACPI_INIT_GLOBAL(t,a,b)
80
81/* Generating stubs for configurable ACPICA macros */
82
83#define ACPI_NO_MEM_ALLOCATIONS
84
85/* Generating stubs for configurable ACPICA functions */
86
87#define ACPI_NO_ERROR_MESSAGES
88#undef ACPI_DEBUG_OUTPUT
89
90/* External interface for __KERNEL__, stub is needed */
91
92#define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
93 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
94#define ACPI_EXTERNAL_RETURN_OK(prototype) \
95 static ACPI_INLINE prototype {return(AE_OK);}
96#define ACPI_EXTERNAL_RETURN_VOID(prototype) \
97 static ACPI_INLINE prototype {return;}
98#define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
99 static ACPI_INLINE prototype {return(0);}
100#define ACPI_EXTERNAL_RETURN_PTR(prototype) \
101 static ACPI_INLINE prototype {return(NULL);}
102
103#endif /* CONFIG_ACPI */
104
105/* Host-dependent types and defines for in-kernel ACPICA */
106
107#define ACPI_MACHINE_WIDTH BITS_PER_LONG
108#define ACPI_USE_NATIVE_MATH64
109#define ACPI_EXPORT_SYMBOL(symbol) EXPORT_SYMBOL(symbol);
110#define strtoul simple_strtoul
111
112#define acpi_cache_t struct kmem_cache
113#define acpi_spinlock spinlock_t *
114#define acpi_raw_spinlock raw_spinlock_t *
115#define acpi_cpu_flags unsigned long
116
117/* Use native linux version of acpi_os_allocate_zeroed */
118
119#define USE_NATIVE_ALLOCATE_ZEROED
120
121/*
122 * Overrides for in-kernel ACPICA
123 */
124#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
125#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
126#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
127#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
128#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
129#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
130#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
131#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
132#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_raw_lock
133#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_raw_lock
134#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_raw_lock
135#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_raw_lock
136
137/*
138 * OSL interfaces used by debugger/disassembler
139 */
140#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
141#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
142#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize_debugger
143#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate_debugger
144
145/*
146 * OSL interfaces used by utilities
147 */
148#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
149#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
150#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
151#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
152#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
153#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
154#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
155
156#define ACPI_MSG_ERROR KERN_ERR "ACPI Error: "
157#define ACPI_MSG_EXCEPTION KERN_ERR "ACPI Exception: "
158#define ACPI_MSG_WARNING KERN_WARNING "ACPI Warning: "
159#define ACPI_MSG_INFO KERN_INFO "ACPI: "
160
161#define ACPI_MSG_BIOS_ERROR KERN_ERR "ACPI BIOS Error (bug): "
162#define ACPI_MSG_BIOS_WARNING KERN_WARNING "ACPI BIOS Warning (bug): "
163
164/*
165 * Linux wants to use designated initializers for function pointer structs.
166 */
167#define ACPI_STRUCT_INIT(field, value) .field = value
168
169#else /* !__KERNEL__ */
170
171#define ACPI_USE_STANDARD_HEADERS
172
173#ifdef ACPI_USE_STANDARD_HEADERS
174#include <unistd.h>
175#endif
176
177/* Define/disable kernel-specific declarators */
178
179#ifndef __init
180#define __init
181#endif
182#ifndef __iomem
183#define __iomem
184#endif
185
186/* Host-dependent types and defines for user-space ACPICA */
187
188#define ACPI_FLUSH_CPU_CACHE()
189#define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
190
191#if defined(__ia64__) || (defined(__x86_64__) && !defined(__ILP32__)) ||\
192 defined(__aarch64__) || defined(__PPC64__) ||\
193 defined(__s390x__)
194#define ACPI_MACHINE_WIDTH 64
195#define COMPILER_DEPENDENT_INT64 long
196#define COMPILER_DEPENDENT_UINT64 unsigned long
197#else
198#define ACPI_MACHINE_WIDTH 32
199#define COMPILER_DEPENDENT_INT64 long long
200#define COMPILER_DEPENDENT_UINT64 unsigned long long
201#define ACPI_USE_NATIVE_DIVIDE
202#define ACPI_USE_NATIVE_MATH64
203#endif
204
205#ifndef __cdecl
206#define __cdecl
207#endif
208
209#endif /* __KERNEL__ */
210
211#endif /* __ACLINUX_H__ */
1/******************************************************************************
2 *
3 * Name: aclinux.h - OS specific defines, etc. for Linux
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2014, 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/* Common (in-kernel/user-space) ACPICA configuration */
48
49#define ACPI_USE_SYSTEM_CLIBRARY
50#define ACPI_USE_DO_WHILE_0
51#define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
52
53#ifdef __KERNEL__
54
55#define ACPI_USE_SYSTEM_INTTYPES
56
57/* Compile for reduced hardware mode only with this kernel config */
58
59#ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
60#define ACPI_REDUCED_HARDWARE 1
61#endif
62
63#include <linux/string.h>
64#include <linux/kernel.h>
65#include <linux/ctype.h>
66#include <linux/sched.h>
67#include <linux/atomic.h>
68#include <linux/math64.h>
69#include <linux/slab.h>
70#include <linux/spinlock_types.h>
71#ifdef EXPORT_ACPI_INTERFACES
72#include <linux/export.h>
73#endif
74#include <asm/acpi.h>
75
76/* Host-dependent types and defines for in-kernel ACPICA */
77
78#define ACPI_MACHINE_WIDTH BITS_PER_LONG
79#define ACPI_EXPORT_SYMBOL(symbol) EXPORT_SYMBOL(symbol);
80#define strtoul simple_strtoul
81
82#define acpi_cache_t struct kmem_cache
83#define acpi_spinlock spinlock_t *
84#define acpi_cpu_flags unsigned long
85
86#else /* !__KERNEL__ */
87
88#include <stdarg.h>
89#include <string.h>
90#include <stdlib.h>
91#include <ctype.h>
92#include <unistd.h>
93
94/* Disable kernel specific declarators */
95
96#ifndef __init
97#define __init
98#endif
99
100#ifndef __iomem
101#define __iomem
102#endif
103
104/* Host-dependent types and defines for user-space ACPICA */
105
106#define ACPI_FLUSH_CPU_CACHE()
107#define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
108
109#if defined(__ia64__) || defined(__x86_64__) || defined(__aarch64__)
110#define ACPI_MACHINE_WIDTH 64
111#define COMPILER_DEPENDENT_INT64 long
112#define COMPILER_DEPENDENT_UINT64 unsigned long
113#else
114#define ACPI_MACHINE_WIDTH 32
115#define COMPILER_DEPENDENT_INT64 long long
116#define COMPILER_DEPENDENT_UINT64 unsigned long long
117#define ACPI_USE_NATIVE_DIVIDE
118#endif
119
120#ifndef __cdecl
121#define __cdecl
122#endif
123
124#endif /* __KERNEL__ */
125
126/* Linux uses GCC */
127
128#include <acpi/platform/acgcc.h>
129
130#ifdef __KERNEL__
131
132/*
133 * FIXME: Inclusion of actypes.h
134 * Linux kernel need this before defining inline OSL interfaces as
135 * actypes.h need to be included to find ACPICA type definitions.
136 * Since from ACPICA's perspective, the actypes.h should be included after
137 * acenv.h (aclinux.h), this leads to a inclusion mis-ordering issue.
138 */
139#include <acpi/actypes.h>
140
141/*
142 * Overrides for in-kernel ACPICA
143 */
144acpi_status __init acpi_os_initialize(void);
145#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
146
147acpi_status acpi_os_terminate(void);
148#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
149
150/*
151 * Memory allocation/deallocation
152 */
153
154/*
155 * The irqs_disabled() check is for resume from RAM.
156 * Interrupts are off during resume, just like they are for boot.
157 * However, boot has (system_state != SYSTEM_RUNNING)
158 * to quiet __might_sleep() in kmalloc() and resume does not.
159 */
160static inline void *acpi_os_allocate(acpi_size size)
161{
162 return kmalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
163}
164
165#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
166
167/* Use native linux version of acpi_os_allocate_zeroed */
168
169static inline void *acpi_os_allocate_zeroed(acpi_size size)
170{
171 return kzalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
172}
173
174#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
175#define USE_NATIVE_ALLOCATE_ZEROED
176
177static inline void acpi_os_free(void *memory)
178{
179 kfree(memory);
180}
181
182#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
183
184static inline void *acpi_os_acquire_object(acpi_cache_t * cache)
185{
186 return kmem_cache_zalloc(cache,
187 irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
188}
189
190#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
191
192static inline acpi_thread_id acpi_os_get_thread_id(void)
193{
194 return (acpi_thread_id) (unsigned long)current;
195}
196
197#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
198
199#ifndef CONFIG_PREEMPT
200
201/*
202 * Used within ACPICA to show where it is safe to preempt execution
203 * when CONFIG_PREEMPT=n
204 */
205#define ACPI_PREEMPTION_POINT() \
206 do { \
207 if (!irqs_disabled()) \
208 cond_resched(); \
209 } while (0)
210
211#endif
212
213/*
214 * When lockdep is enabled, the spin_lock_init() macro stringifies it's
215 * argument and uses that as a name for the lock in debugging.
216 * By executing spin_lock_init() in a macro the key changes from "lock" for
217 * all locks to the name of the argument of acpi_os_create_lock(), which
218 * prevents lockdep from reporting false positives for ACPICA locks.
219 */
220#define acpi_os_create_lock(__handle) \
221 ({ \
222 spinlock_t *lock = ACPI_ALLOCATE(sizeof(*lock)); \
223 if (lock) { \
224 *(__handle) = lock; \
225 spin_lock_init(*(__handle)); \
226 } \
227 lock ? AE_OK : AE_NO_MEMORY; \
228 })
229#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
230
231void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_size length);
232#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
233
234void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
235#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
236
237/*
238 * OSL interfaces used by debugger/disassembler
239 */
240#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
241#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
242
243/*
244 * OSL interfaces used by utilities
245 */
246#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
247#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
248#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
249#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
250#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
251#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
252#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
253#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
254
255/*
256 * OSL interfaces added by Linux
257 */
258void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
259
260#endif /* __KERNEL__ */
261
262#endif /* __ACLINUX_H__ */