1 /****************************************************************************** 2 * 3 * Name: aclinux.h - OS specific defines, etc. for Linux 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2020, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #ifndef __ACLINUX_H__ 153 #define __ACLINUX_H__ 154 155 #ifdef __KERNEL__ 156 157 /* ACPICA external files should not include ACPICA headers directly. */ 158 159 #if !defined(BUILDING_ACPICA) && !defined(_LINUX_ACPI_H) 160 #error "Please don't include <acpi/acpi.h> directly, include <linux/acpi.h> instead." 161 #endif 162 163 #endif 164 165 /* Common (in-kernel/user-space) ACPICA configuration */ 166 167 #define ACPI_USE_SYSTEM_CLIBRARY 168 #define ACPI_USE_DO_WHILE_0 169 #define ACPI_IGNORE_PACKAGE_RESOLUTION_ERRORS 170 171 172 #ifdef __KERNEL__ 173 174 #define ACPI_USE_SYSTEM_INTTYPES 175 #define ACPI_USE_GPE_POLLING 176 177 /* Kernel specific ACPICA configuration */ 178 179 #ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY 180 #define ACPI_REDUCED_HARDWARE 1 181 #endif 182 183 #ifdef CONFIG_ACPI_DEBUGGER 184 #define ACPI_DEBUGGER 185 #endif 186 187 #ifdef CONFIG_ACPI_DEBUG 188 #define ACPI_MUTEX_DEBUG 189 #endif 190 191 #include <linux/string.h> 192 #include <linux/kernel.h> 193 #include <linux/ctype.h> 194 #include <linux/sched.h> 195 #include <linux/atomic.h> 196 #include <linux/math64.h> 197 #include <linux/slab.h> 198 #include <linux/spinlock_types.h> 199 #ifdef EXPORT_ACPI_INTERFACES 200 #include <linux/export.h> 201 #endif 202 #ifdef CONFIG_ACPI 203 #include <asm/acenv.h> 204 #endif 205 206 #define ACPI_INIT_FUNCTION __init 207 208 /* Use a specific bugging default separate from ACPICA */ 209 210 #undef ACPI_DEBUG_DEFAULT 211 #define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR) 212 213 #ifndef CONFIG_ACPI 214 215 /* External globals for __KERNEL__, stubs is needed */ 216 217 #define ACPI_GLOBAL(t,a) 218 #define ACPI_INIT_GLOBAL(t,a,b) 219 220 /* Generating stubs for configurable ACPICA macros */ 221 222 #define ACPI_NO_MEM_ALLOCATIONS 223 224 /* Generating stubs for configurable ACPICA functions */ 225 226 #define ACPI_NO_ERROR_MESSAGES 227 #undef ACPI_DEBUG_OUTPUT 228 229 /* External interface for __KERNEL__, stub is needed */ 230 231 #define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \ 232 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);} 233 #define ACPI_EXTERNAL_RETURN_OK(Prototype) \ 234 static ACPI_INLINE Prototype {return(AE_OK);} 235 #define ACPI_EXTERNAL_RETURN_VOID(Prototype) \ 236 static ACPI_INLINE Prototype {return;} 237 #define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \ 238 static ACPI_INLINE Prototype {return(0);} 239 #define ACPI_EXTERNAL_RETURN_PTR(Prototype) \ 240 static ACPI_INLINE Prototype {return(NULL);} 241 242 #endif /* CONFIG_ACPI */ 243 244 /* Host-dependent types and defines for in-kernel ACPICA */ 245 246 #define ACPI_MACHINE_WIDTH BITS_PER_LONG 247 #define ACPI_USE_NATIVE_MATH64 248 #define ACPI_EXPORT_SYMBOL(symbol) EXPORT_SYMBOL(symbol); 249 #define strtoul simple_strtoul 250 251 #define ACPI_CACHE_T struct kmem_cache 252 #define ACPI_SPINLOCK spinlock_t * 253 #define ACPI_CPU_FLAGS unsigned long 254 255 /* Use native linux version of AcpiOsAllocateZeroed */ 256 257 #define USE_NATIVE_ALLOCATE_ZEROED 258 259 /* 260 * Overrides for in-kernel ACPICA 261 */ 262 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize 263 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate 264 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate 265 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed 266 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree 267 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject 268 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId 269 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock 270 271 /* 272 * OSL interfaces used by debugger/disassembler 273 */ 274 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable 275 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable 276 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitializeDebugger 277 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminateDebugger 278 279 /* 280 * OSL interfaces used by utilities 281 */ 282 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput 283 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName 284 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex 285 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress 286 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory 287 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename 288 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory 289 290 #define ACPI_MSG_ERROR KERN_ERR "ACPI Error: " 291 #define ACPI_MSG_EXCEPTION KERN_ERR "ACPI Exception: " 292 #define ACPI_MSG_WARNING KERN_WARNING "ACPI Warning: " 293 #define ACPI_MSG_INFO KERN_INFO "ACPI: " 294 295 #define ACPI_MSG_BIOS_ERROR KERN_ERR "ACPI BIOS Error (bug): " 296 #define ACPI_MSG_BIOS_WARNING KERN_WARNING "ACPI BIOS Warning (bug): " 297 298 /* 299 * Linux wants to use designated initializers for function pointer structs. 300 */ 301 #define ACPI_STRUCT_INIT(field, value) .field = value 302 303 #else /* !__KERNEL__ */ 304 305 #define ACPI_USE_STANDARD_HEADERS 306 307 #ifdef ACPI_USE_STANDARD_HEADERS 308 #include <unistd.h> 309 #endif 310 311 /* Define/disable kernel-specific declarators */ 312 313 #ifndef __init 314 #define __init 315 #endif 316 #ifndef __iomem 317 #define __iomem 318 #endif 319 320 /* Host-dependent types and defines for user-space ACPICA */ 321 322 #define ACPI_FLUSH_CPU_CACHE() 323 #define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread)) 324 325 #if defined(__ia64__) || (defined(__x86_64__) && !defined(__ILP32__)) ||\ 326 defined(__aarch64__) || defined(__PPC64__) ||\ 327 defined(__s390x__) ||\ 328 (defined(__riscv) && (defined(__LP64__) || defined(_LP64))) 329 #define ACPI_MACHINE_WIDTH 64 330 #define COMPILER_DEPENDENT_INT64 long 331 #define COMPILER_DEPENDENT_UINT64 unsigned long 332 #else 333 #define ACPI_MACHINE_WIDTH 32 334 #define COMPILER_DEPENDENT_INT64 long long 335 #define COMPILER_DEPENDENT_UINT64 unsigned long long 336 #define ACPI_USE_NATIVE_DIVIDE 337 #define ACPI_USE_NATIVE_MATH64 338 #endif 339 340 #ifndef __cdecl 341 #define __cdecl 342 #endif 343 344 #endif /* __KERNEL__ */ 345 346 #endif /* __ACLINUX_H__ */ 347