drivers/bus/acpi/acpica/include/platform/aclinux.h

   1 /******************************************************************************
   2  *
   3  * Name: aclinux.h - OS specific defines, etc. for Linux
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2019, 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 #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 /* Use native linux version of AcpiOsAllocateZeroed */
 148
 149 #define USE_NATIVE_ALLOCATE_ZEROED
 150
 151 /*
 152  * Overrides for in-kernel ACPICA
 153  */
 154 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
 155 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
 156 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
 157 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
 158 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
 159 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
 160 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
 161 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
 162
 163 /*
 164  * OSL interfaces used by debugger/disassembler
 165  */
 166 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
 167 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
 168 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitializeDebugger
 169 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminateDebugger
 170
 171 /*
 172  * OSL interfaces used by utilities
 173  */
 174 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
 175 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
 176 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
 177 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
 178 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
 179 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
 180 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
 181
 182 #define ACPI_MSG_ERROR          KERN_ERR "ACPI Error: "
 183 #define ACPI_MSG_EXCEPTION      KERN_ERR "ACPI Exception: "
 184 #define ACPI_MSG_WARNING        KERN_WARNING "ACPI Warning: "
 185 #define ACPI_MSG_INFO           KERN_INFO "ACPI: "
 186
 187 #define ACPI_MSG_BIOS_ERROR     KERN_ERR "ACPI BIOS Error (bug): "
 188 #define ACPI_MSG_BIOS_WARNING   KERN_WARNING "ACPI BIOS Warning (bug): "
 189
 190 /*
 191  * Linux wants to use designated initializers for function pointer structs.
 192  */
 193 #define ACPI_STRUCT_INIT(field, value)  .field = value
 194
 195 #else /* !__KERNEL__ */
 196
 197 #define ACPI_USE_STANDARD_HEADERS
 198
 199 #ifdef ACPI_USE_STANDARD_HEADERS
 200 #include <unistd.h>
 201 #endif
 202
 203 /* Define/disable kernel-specific declarators */
 204
 205 #ifndef __init
 206 #define __init
 207 #endif
 208 #ifndef __iomem
 209 #define __iomem
 210 #endif
 211
 212 /* Host-dependent types and defines for user-space ACPICA */
 213
 214 #define ACPI_FLUSH_CPU_CACHE()
 215 #define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread))
 216
 217 #if defined(__ia64__)    || (defined(__x86_64__) && !defined(__ILP32__)) ||\
 218     defined(__aarch64__) || defined(__PPC64__) ||\
 219     defined(__s390x__)
 220 #define ACPI_MACHINE_WIDTH          64
 221 #define COMPILER_DEPENDENT_INT64    long
 222 #define COMPILER_DEPENDENT_UINT64   unsigned long
 223 #else
 224 #define ACPI_MACHINE_WIDTH          32
 225 #define COMPILER_DEPENDENT_INT64    long long
 226 #define COMPILER_DEPENDENT_UINT64   unsigned long long
 227 #define ACPI_USE_NATIVE_DIVIDE
 228 #define ACPI_USE_NATIVE_MATH64
 229 #endif
 230
 231 #ifndef __cdecl
 232 #define __cdecl
 233 #endif
 234
 235 #endif /* __KERNEL__ */
 236
 237 #endif /* __ACLINUX_H__ */