xref: /openbmc/linux/include/acpi/platform/aclinux.h (revision f220d3eb)
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 - 2018, 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_ACPI_REDUCED_HARDWARE_ONLY
37 #define ACPI_REDUCED_HARDWARE 1
38 #endif
39 
40 #ifdef CONFIG_ACPI_DEBUGGER
41 #define ACPI_DEBUGGER
42 #endif
43 
44 #ifdef CONFIG_ACPI_DEBUG
45 #define ACPI_MUTEX_DEBUG
46 #endif
47 
48 #include <linux/string.h>
49 #include <linux/kernel.h>
50 #include <linux/ctype.h>
51 #include <linux/sched.h>
52 #include <linux/atomic.h>
53 #include <linux/math64.h>
54 #include <linux/slab.h>
55 #include <linux/spinlock_types.h>
56 #ifdef EXPORT_ACPI_INTERFACES
57 #include <linux/export.h>
58 #endif
59 #ifdef CONFIG_ACPI
60 #include <asm/acenv.h>
61 #endif
62 
63 #define ACPI_INIT_FUNCTION __init
64 
65 #ifndef CONFIG_ACPI
66 
67 /* External globals for __KERNEL__, stubs is needed */
68 
69 #define ACPI_GLOBAL(t,a)
70 #define ACPI_INIT_GLOBAL(t,a,b)
71 
72 /* Generating stubs for configurable ACPICA macros */
73 
74 #define ACPI_NO_MEM_ALLOCATIONS
75 
76 /* Generating stubs for configurable ACPICA functions */
77 
78 #define ACPI_NO_ERROR_MESSAGES
79 #undef ACPI_DEBUG_OUTPUT
80 
81 /* External interface for __KERNEL__, stub is needed */
82 
83 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
84 	static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
85 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
86 	static ACPI_INLINE prototype {return(AE_OK);}
87 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
88 	static ACPI_INLINE prototype {return;}
89 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
90 	static ACPI_INLINE prototype {return(0);}
91 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
92 	static ACPI_INLINE prototype {return(NULL);}
93 
94 #endif				/* CONFIG_ACPI */
95 
96 /* Host-dependent types and defines for in-kernel ACPICA */
97 
98 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
99 #define ACPI_USE_NATIVE_MATH64
100 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
101 #define strtoul                     simple_strtoul
102 
103 #define acpi_cache_t                        struct kmem_cache
104 #define acpi_spinlock                       spinlock_t *
105 #define acpi_raw_spinlock                   raw_spinlock_t *
106 #define acpi_cpu_flags                      unsigned long
107 
108 /* Use native linux version of acpi_os_allocate_zeroed */
109 
110 #define USE_NATIVE_ALLOCATE_ZEROED
111 
112 /*
113  * Overrides for in-kernel ACPICA
114  */
115 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
116 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
117 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
118 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
119 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
120 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
121 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
122 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
123 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_raw_lock
124 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_raw_lock
125 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_raw_lock
126 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_raw_lock
127 
128 /*
129  * OSL interfaces used by debugger/disassembler
130  */
131 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
132 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
133 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize_debugger
134 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate_debugger
135 
136 /*
137  * OSL interfaces used by utilities
138  */
139 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
140 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
141 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
142 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
143 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
144 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
145 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
146 
147 #define ACPI_MSG_ERROR          KERN_ERR "ACPI Error: "
148 #define ACPI_MSG_EXCEPTION      KERN_ERR "ACPI Exception: "
149 #define ACPI_MSG_WARNING        KERN_WARNING "ACPI Warning: "
150 #define ACPI_MSG_INFO           KERN_INFO "ACPI: "
151 
152 #define ACPI_MSG_BIOS_ERROR     KERN_ERR "ACPI BIOS Error (bug): "
153 #define ACPI_MSG_BIOS_WARNING   KERN_WARNING "ACPI BIOS Warning (bug): "
154 
155 /*
156  * Linux wants to use designated initializers for function pointer structs.
157  */
158 #define ACPI_STRUCT_INIT(field, value)	.field = value
159 
160 #else				/* !__KERNEL__ */
161 
162 #define ACPI_USE_STANDARD_HEADERS
163 
164 #ifdef ACPI_USE_STANDARD_HEADERS
165 #include <unistd.h>
166 #endif
167 
168 /* Define/disable kernel-specific declarators */
169 
170 #ifndef __init
171 #define __init
172 #endif
173 #ifndef __iomem
174 #define __iomem
175 #endif
176 
177 /* Host-dependent types and defines for user-space ACPICA */
178 
179 #define ACPI_FLUSH_CPU_CACHE()
180 #define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
181 
182 #if defined(__ia64__)    || (defined(__x86_64__) && !defined(__ILP32__)) ||\
183 	defined(__aarch64__) || defined(__PPC64__) ||\
184 	defined(__s390x__)
185 #define ACPI_MACHINE_WIDTH          64
186 #define COMPILER_DEPENDENT_INT64    long
187 #define COMPILER_DEPENDENT_UINT64   unsigned long
188 #else
189 #define ACPI_MACHINE_WIDTH          32
190 #define COMPILER_DEPENDENT_INT64    long long
191 #define COMPILER_DEPENDENT_UINT64   unsigned long long
192 #define ACPI_USE_NATIVE_DIVIDE
193 #define ACPI_USE_NATIVE_MATH64
194 #endif
195 
196 #ifndef __cdecl
197 #define __cdecl
198 #endif
199 
200 #endif				/* __KERNEL__ */
201 
202 #endif				/* __ACLINUX_H__ */
203