include/acpi/platform/aclinux.h

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