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 - 2014, 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 /* Common (in-kernel/user-space) ACPICA configuration */
  48
  49 #define ACPI_USE_SYSTEM_CLIBRARY
  50 #define ACPI_USE_DO_WHILE_0
  51 #define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
  52
  53 #ifdef __KERNEL__
  54
  55 #define ACPI_USE_SYSTEM_INTTYPES
  56
  57 /* Compile for reduced hardware mode only with this kernel config */
  58
  59 #ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
  60 #define ACPI_REDUCED_HARDWARE 1
  61 #endif
  62
  63 #include <linux/string.h>
  64 #include <linux/kernel.h>
  65 #include <linux/ctype.h>
  66 #include <linux/sched.h>
  67 #include <linux/atomic.h>
  68 #include <linux/math64.h>
  69 #include <linux/slab.h>
  70 #include <linux/spinlock_types.h>
  71 #ifdef EXPORT_ACPI_INTERFACES
  72 #include <linux/export.h>
  73 #endif
  74 #include <asm/acpi.h>
  75
  76 /* Host-dependent types and defines for in-kernel ACPICA */
  77
  78 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
  79 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
  80 #define strtoul                     simple_strtoul
  81
  82 #define acpi_cache_t                        struct kmem_cache
  83 #define acpi_spinlock                       spinlock_t *
  84 #define acpi_cpu_flags                      unsigned long
  85
  86 #else                           /* !__KERNEL__ */
  87
  88 #include <stdarg.h>
  89 #include <string.h>
  90 #include <stdlib.h>
  91 #include <ctype.h>
  92 #include <unistd.h>
  93
  94 /* Define/disable kernel-specific declarators */
  95
  96 #ifndef __init
  97 #define __init
  98 #endif
  99
 100 #ifndef __iomem
 101 #define __iomem
 102 #endif
 103
 104 /* Host-dependent types and defines for user-space ACPICA */
 105
 106 #define ACPI_FLUSH_CPU_CACHE()
 107 #define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
 108
 109 #if defined(__ia64__)    || defined(__x86_64__) ||\
 110         defined(__aarch64__) || defined(__PPC64__)
 111 #define ACPI_MACHINE_WIDTH          64
 112 #define COMPILER_DEPENDENT_INT64    long
 113 #define COMPILER_DEPENDENT_UINT64   unsigned long
 114 #else
 115 #define ACPI_MACHINE_WIDTH          32
 116 #define COMPILER_DEPENDENT_INT64    long long
 117 #define COMPILER_DEPENDENT_UINT64   unsigned long long
 118 #define ACPI_USE_NATIVE_DIVIDE
 119 #endif
 120
 121 #ifndef __cdecl
 122 #define __cdecl
 123 #endif
 124
 125 #endif                          /* __KERNEL__ */
 126
 127 /* Linux uses GCC */
 128
 129 #include <acpi/platform/acgcc.h>
 130
 131 #ifdef __KERNEL__
 132
 133 /*
 134  * FIXME: Inclusion of actypes.h
 135  * Linux kernel need this before defining inline OSL interfaces as
 136  * actypes.h need to be included to find ACPICA type definitions.
 137  * Since from ACPICA's perspective, the actypes.h should be included after
 138  * acenv.h (aclinux.h), this leads to a inclusion mis-ordering issue.
 139  */
 140 #include <acpi/actypes.h>
 141
 142 /*
 143  * Overrides for in-kernel ACPICA
 144  */
 145 acpi_status __init acpi_os_initialize(void);
 146 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
 147
 148 acpi_status acpi_os_terminate(void);
 149 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
 150
 151 /*
 152  * Memory allocation/deallocation
 153  */
 154
 155 /*
 156  * The irqs_disabled() check is for resume from RAM.
 157  * Interrupts are off during resume, just like they are for boot.
 158  * However, boot has  (system_state != SYSTEM_RUNNING)
 159  * to quiet __might_sleep() in kmalloc() and resume does not.
 160  */
 161 static inline void *acpi_os_allocate(acpi_size size)
 162 {
 163         return kmalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
 164 }
 165
 166 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
 167
 168 /* Use native linux version of acpi_os_allocate_zeroed */
 169
 170 static inline void *acpi_os_allocate_zeroed(acpi_size size)
 171 {
 172         return kzalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
 173 }
 174
 175 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
 176 #define USE_NATIVE_ALLOCATE_ZEROED
 177
 178 static inline void acpi_os_free(void *memory)
 179 {
 180         kfree(memory);
 181 }
 182
 183 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
 184
 185 static inline void *acpi_os_acquire_object(acpi_cache_t * cache)
 186 {
 187         return kmem_cache_zalloc(cache,
 188                                  irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
 189 }
 190
 191 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
 192
 193 static inline acpi_thread_id acpi_os_get_thread_id(void)
 194 {
 195         return (acpi_thread_id) (unsigned long)current;
 196 }
 197
 198 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
 199
 200 #ifndef CONFIG_PREEMPT
 201
 202 /*
 203  * Used within ACPICA to show where it is safe to preempt execution
 204  * when CONFIG_PREEMPT=n
 205  */
 206 #define ACPI_PREEMPTION_POINT() \
 207         do { \
 208                 if (!irqs_disabled()) \
 209                         cond_resched(); \
 210         } while (0)
 211
 212 #endif
 213
 214 /*
 215  * When lockdep is enabled, the spin_lock_init() macro stringifies it's
 216  * argument and uses that as a name for the lock in debugging.
 217  * By executing spin_lock_init() in a macro the key changes from "lock" for
 218  * all locks to the name of the argument of acpi_os_create_lock(), which
 219  * prevents lockdep from reporting false positives for ACPICA locks.
 220  */
 221 #define acpi_os_create_lock(__handle) \
 222         ({ \
 223                 spinlock_t *lock = ACPI_ALLOCATE(sizeof(*lock)); \
 224                 if (lock) { \
 225                         *(__handle) = lock; \
 226                         spin_lock_init(*(__handle)); \
 227                 } \
 228                 lock ? AE_OK : AE_NO_MEMORY; \
 229         })
 230 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
 231
 232 void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_size length);
 233 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
 234
 235 void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
 236 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
 237
 238 /*
 239  * OSL interfaces used by debugger/disassembler
 240  */
 241 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
 242 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
 243
 244 /*
 245  * OSL interfaces used by utilities
 246  */
 247 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
 248 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
 249 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
 250 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
 251 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
 252 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
 253 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
 254 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
 255
 256 /*
 257  * OSL interfaces added by Linux
 258  */
 259 void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
 260
 261 #endif                          /* __KERNEL__ */
 262
 263 #endif                          /* __ACLINUX_H__ */