1/******************************************************************************
2 *
3 * Name: aclinux.h - OS specific defines, etc. for Linux
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2023, 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 MERCHANTABILITY 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#define ACPI_IGNORE_PACKAGE_RESOLUTION_ERRORS
62
63
64#ifdef __KERNEL__
65
66#define ACPI_USE_SYSTEM_INTTYPES
67#define ACPI_USE_GPE_POLLING
68
69/* Kernel specific ACPICA configuration */
70
71#ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
72#define ACPI_REDUCED_HARDWARE 1
73#endif
74
75#ifdef CONFIG_ACPI_DEBUGGER
76#define ACPI_DEBUGGER
77#endif
78
79#ifdef CONFIG_ACPI_DEBUG
80#define ACPI_MUTEX_DEBUG
81#endif
82
83#include <linux/string.h>
84#include <linux/kernel.h>
85#include <linux/ctype.h>
86#include <linux/sched.h>
87#include <linux/atomic.h>
88#include <linux/math64.h>
89#include <linux/slab.h>
90#include <linux/spinlock_types.h>
91#ifdef EXPORT_ACPI_INTERFACES
92#include <linux/export.h>
93#endif
94#ifdef CONFIG_ACPI
95#include <asm/acenv.h>
96#endif
97
98#define ACPI_INIT_FUNCTION __init
99
100/* Use a specific bugging default separate from ACPICA */
101
102#undef ACPI_DEBUG_DEFAULT
103#define ACPI_DEBUG_DEFAULT          (ACPI_LV_INFO | ACPI_LV_REPAIR)
104
105#ifndef CONFIG_ACPI
106
107/* External globals for __KERNEL__, stubs is needed */
108
109#define ACPI_GLOBAL(t,a)
110#define ACPI_INIT_GLOBAL(t,a,b)
111
112/* Generating stubs for configurable ACPICA macros */
113
114#define ACPI_NO_MEM_ALLOCATIONS
115
116/* Generating stubs for configurable ACPICA functions */
117
118#define ACPI_NO_ERROR_MESSAGES
119#undef ACPI_DEBUG_OUTPUT
120
121/* External interface for __KERNEL__, stub is needed */
122
123#define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \
124    static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
125#define ACPI_EXTERNAL_RETURN_OK(Prototype) \
126    static ACPI_INLINE Prototype {return(AE_OK);}
127#define ACPI_EXTERNAL_RETURN_VOID(Prototype) \
128    static ACPI_INLINE Prototype {return;}
129#define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \
130    static ACPI_INLINE Prototype {return(0);}
131#define ACPI_EXTERNAL_RETURN_PTR(Prototype) \
132    static ACPI_INLINE Prototype {return(NULL);}
133
134#endif /* CONFIG_ACPI */
135
136/* Host-dependent types and defines for in-kernel ACPICA */
137
138#define ACPI_MACHINE_WIDTH          BITS_PER_LONG
139#define ACPI_USE_NATIVE_MATH64
140#define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
141#define strtoul                     simple_strtoul
142
143#define ACPI_CACHE_T                struct kmem_cache
144#define ACPI_SPINLOCK               spinlock_t *
145#define ACPI_CPU_FLAGS              unsigned long
146
147#define ACPI_UINTPTR_T              uintptr_t
148
149#define ACPI_TO_INTEGER(p)          ((uintptr_t)(p))
150#define ACPI_OFFSET(d, f)           offsetof(d, f)
151
152/* Use native linux version of AcpiOsAllocateZeroed */
153
154#define USE_NATIVE_ALLOCATE_ZEROED
155
156/*
157 * Overrides for in-kernel ACPICA
158 */
159#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
160#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
161#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
162#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
163#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
164#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
165#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
166#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
167
168/*
169 * OSL interfaces used by debugger/disassembler
170 */
171#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
172#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
173#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitializeDebugger
174#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminateDebugger
175
176/*
177 * OSL interfaces used by utilities
178 */
179#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
180#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
181#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
182#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
183#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
184#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
185#define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
186
187#define ACPI_MSG_ERROR          KERN_ERR "ACPI Error: "
188#define ACPI_MSG_EXCEPTION      KERN_ERR "ACPI Exception: "
189#define ACPI_MSG_WARNING        KERN_WARNING "ACPI Warning: "
190#define ACPI_MSG_INFO           KERN_INFO "ACPI: "
191
192#define ACPI_MSG_BIOS_ERROR     KERN_ERR "ACPI BIOS Error (bug): "
193#define ACPI_MSG_BIOS_WARNING   KERN_WARNING "ACPI BIOS Warning (bug): "
194
195/*
196 * Linux wants to use designated initializers for function pointer structs.
197 */
198#define ACPI_STRUCT_INIT(field, value)  .field = value
199
200#else /* !__KERNEL__ */
201
202#define ACPI_USE_STANDARD_HEADERS
203
204#ifdef ACPI_USE_STANDARD_HEADERS
205#include <stddef.h>
206#include <unistd.h>
207#include <stdint.h>
208
209#define ACPI_OFFSET(d, f)   offsetof(d, f)
210#endif
211
212/* Define/disable kernel-specific declarators */
213
214#ifndef __init
215#define __init
216#endif
217#ifndef __iomem
218#define __iomem
219#endif
220
221/* Host-dependent types and defines for user-space ACPICA */
222
223#define ACPI_FLUSH_CPU_CACHE()
224#define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread))
225
226#if defined(__ia64__)    || (defined(__x86_64__) && !defined(__ILP32__)) ||\
227    defined(__aarch64__) || defined(__PPC64__) ||\
228    defined(__s390x__)   || defined(__loongarch__) ||\
229    (defined(__riscv) && (defined(__LP64__) || defined(_LP64)))
230#define ACPI_MACHINE_WIDTH          64
231#define COMPILER_DEPENDENT_INT64    long
232#define COMPILER_DEPENDENT_UINT64   unsigned long
233#else
234#define ACPI_MACHINE_WIDTH          32
235#define COMPILER_DEPENDENT_INT64    long long
236#define COMPILER_DEPENDENT_UINT64   unsigned long long
237#define ACPI_USE_NATIVE_DIVIDE
238#define ACPI_USE_NATIVE_MATH64
239#endif
240
241#ifndef __cdecl
242#define __cdecl
243#endif
244
245#endif /* __KERNEL__ */
246
247#endif /* __ACLINUX_H__ */
248