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 - 2016, 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 #ifndef CONFIG_ACPI
  96
  97 /* External globals for __KERNEL__, stubs is needed */
  98
  99 #define ACPI_GLOBAL(t,a)
 100 #define ACPI_INIT_GLOBAL(t,a,b)
 101
 102 /* Generating stubs for configurable ACPICA macros */
 103
 104 #define ACPI_NO_MEM_ALLOCATIONS
 105
 106 /* Generating stubs for configurable ACPICA functions */
 107
 108 #define ACPI_NO_ERROR_MESSAGES
 109 #undef ACPI_DEBUG_OUTPUT
 110
 111 /* External interface for __KERNEL__, stub is needed */
 112
 113 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
 114         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
 115 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
 116         static ACPI_INLINE prototype {return(AE_OK);}
 117 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
 118         static ACPI_INLINE prototype {return;}
 119 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
 120         static ACPI_INLINE prototype {return(0);}
 121 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
 122         static ACPI_INLINE prototype {return(NULL);}
 123
 124 #endif                          /* CONFIG_ACPI */
 125
 126 /* Host-dependent types and defines for in-kernel ACPICA */
 127
 128 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
 129 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
 130 #define strtoul                     simple_strtoul
 131
 132 #define acpi_cache_t                        struct kmem_cache
 133 #define acpi_spinlock                       spinlock_t *
 134 #define acpi_cpu_flags                      unsigned long
 135
 136 /* Use native linux version of acpi_os_allocate_zeroed */
 137
 138 #define USE_NATIVE_ALLOCATE_ZEROED
 139
 140 /*
 141  * Overrides for in-kernel ACPICA
 142  */
 143 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
 144 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
 145 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
 146 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
 147 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
 148 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
 149 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
 150 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
 151
 152 /*
 153  * OSL interfaces used by debugger/disassembler
 154  */
 155 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
 156 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
 157 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize_command_signals
 158 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate_command_signals
 159
 160 /*
 161  * OSL interfaces used by utilities
 162  */
 163 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
 164 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
 165 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
 166 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
 167 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
 168 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
 169 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
 170
 171 #else                           /* !__KERNEL__ */
 172
 173 #include <stdarg.h>
 174 #include <string.h>
 175 #include <stdlib.h>
 176 #include <ctype.h>
 177 #include <unistd.h>
 178
 179 /* Define/disable kernel-specific declarators */
 180
 181 #ifndef __init
 182 #define __init
 183 #endif
 184
 185 /* Host-dependent types and defines for user-space ACPICA */
 186
 187 #define ACPI_FLUSH_CPU_CACHE()
 188 #define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
 189
 190 #if defined(__ia64__)    || defined(__x86_64__) ||\
 191         defined(__aarch64__) || defined(__PPC64__)
 192 #define ACPI_MACHINE_WIDTH          64
 193 #define COMPILER_DEPENDENT_INT64    long
 194 #define COMPILER_DEPENDENT_UINT64   unsigned long
 195 #else
 196 #define ACPI_MACHINE_WIDTH          32
 197 #define COMPILER_DEPENDENT_INT64    long long
 198 #define COMPILER_DEPENDENT_UINT64   unsigned long long
 199 #define ACPI_USE_NATIVE_DIVIDE
 200 #endif
 201
 202 #ifndef __cdecl
 203 #define __cdecl
 204 #endif
 205
 206 #endif                          /* __KERNEL__ */
 207
 208 /* Linux uses GCC */
 209
 210 #include <acpi/platform/acgcc.h>
 211
 212 #endif                          /* __ACLINUX_H__ */