1 /******************************************************************************
3 * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These
4 * interfaces must be implemented by OSL to interface the
5 * ACPI components to the host operating system.
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #ifndef __ACPIOSXF_H__
119 #define __ACPIOSXF_H__
121 #include "platform/acenv.h"
125 /* Types for AcpiOsExecute */
129 OSL_GLOBAL_LOCK_HANDLER,
138 #define ACPI_NO_UNIT_LIMIT ((UINT32) -1)
139 #define ACPI_MUTEX_SEM 1
142 /* Functions for AcpiOsSignal */
144 #define ACPI_SIGNAL_FATAL 0
145 #define ACPI_SIGNAL_BREAKPOINT 1
147 typedef struct acpi_signal_fatal_info
153 } ACPI_SIGNAL_FATAL_INFO;
157 * OSL Initialization and shutdown primitives
159 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
165 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
173 * ACPI Table interfaces
175 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetRootPointer
176 ACPI_PHYSICAL_ADDRESS
177 AcpiOsGetRootPointer (
181 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPredefinedOverride
183 AcpiOsPredefinedOverride (
184 const ACPI_PREDEFINED_NAMES *InitVal,
185 ACPI_STRING *NewVal);
188 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTableOverride
190 AcpiOsTableOverride (
191 ACPI_TABLE_HEADER *ExistingTable,
192 ACPI_TABLE_HEADER **NewTable);
195 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPhysicalTableOverride
197 AcpiOsPhysicalTableOverride (
198 ACPI_TABLE_HEADER *ExistingTable,
199 ACPI_PHYSICAL_ADDRESS *NewAddress,
200 UINT32 *NewTableLength);
205 * Spinlock primitives
207 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
210 ACPI_SPINLOCK *OutHandle);
213 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteLock
216 ACPI_SPINLOCK Handle);
219 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireLock
222 ACPI_SPINLOCK Handle);
225 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReleaseLock
228 ACPI_SPINLOCK Handle,
229 ACPI_CPU_FLAGS Flags);
234 * Semaphore primitives
236 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateSemaphore
238 AcpiOsCreateSemaphore (
241 ACPI_SEMAPHORE *OutHandle);
244 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteSemaphore
246 AcpiOsDeleteSemaphore (
247 ACPI_SEMAPHORE Handle);
250 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWaitSemaphore
252 AcpiOsWaitSemaphore (
253 ACPI_SEMAPHORE Handle,
258 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSignalSemaphore
260 AcpiOsSignalSemaphore (
261 ACPI_SEMAPHORE Handle,
267 * Mutex primitives. May be configured to use semaphores instead via
268 * ACPI_MUTEX_TYPE (see platform/acenv.h)
270 #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
272 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateMutex
275 ACPI_MUTEX *OutHandle);
278 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteMutex
284 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireMutex
291 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReleaseMutex
301 * Memory allocation and mapping
303 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
309 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
311 AcpiOsAllocateZeroed (
315 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
321 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsMapMemory
324 ACPI_PHYSICAL_ADDRESS Where,
328 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsUnmapMemory
331 void *LogicalAddress,
335 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetPhysicalAddress
337 AcpiOsGetPhysicalAddress (
338 void *LogicalAddress,
339 ACPI_PHYSICAL_ADDRESS *PhysicalAddress);
344 * Memory/Object Cache
346 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateCache
352 ACPI_CACHE_T **ReturnCache);
355 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteCache
358 ACPI_CACHE_T *Cache);
361 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPurgeCache
364 ACPI_CACHE_T *Cache);
367 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
369 AcpiOsAcquireObject (
370 ACPI_CACHE_T *Cache);
373 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReleaseObject
375 AcpiOsReleaseObject (
384 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInstallInterruptHandler
386 AcpiOsInstallInterruptHandler (
387 UINT32 InterruptNumber,
388 ACPI_OSD_HANDLER ServiceRoutine,
392 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRemoveInterruptHandler
394 AcpiOsRemoveInterruptHandler (
395 UINT32 InterruptNumber,
396 ACPI_OSD_HANDLER ServiceRoutine);
401 * Threads and Scheduling
403 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
409 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsExecute
412 ACPI_EXECUTE_TYPE Type,
413 ACPI_OSD_EXEC_CALLBACK Function,
417 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWaitEventsComplete
419 AcpiOsWaitEventsComplete (
423 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSleep
426 UINT64 Milliseconds);
429 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsStall
432 UINT32 Microseconds);
437 * Platform and hardware-independent I/O interfaces
439 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadPort
442 ACPI_IO_ADDRESS Address,
447 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritePort
450 ACPI_IO_ADDRESS Address,
457 * Platform and hardware-independent physical memory interfaces
459 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadMemory
462 ACPI_PHYSICAL_ADDRESS Address,
467 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWriteMemory
470 ACPI_PHYSICAL_ADDRESS Address,
477 * Platform and hardware-independent PCI configuration space access
478 * Note: Can't use "Register" as a parameter, changed to "Reg" --
479 * certain compilers complain.
481 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadPciConfiguration
483 AcpiOsReadPciConfiguration (
490 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritePciConfiguration
492 AcpiOsWritePciConfiguration (
503 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
510 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
517 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTimer
523 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSignal
532 * Debug print routines
534 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPrintf
535 void ACPI_INTERNAL_VAR_XFACE
541 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsVprintf
548 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
550 AcpiOsRedirectOutput (
558 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetLine
568 * Obtain ACPI table(s)
570 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
572 AcpiOsGetTableByName (
575 ACPI_TABLE_HEADER **Table,
576 ACPI_PHYSICAL_ADDRESS *Address);
579 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
581 AcpiOsGetTableByIndex (
583 ACPI_TABLE_HEADER **Table,
585 ACPI_PHYSICAL_ADDRESS *Address);
588 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
590 AcpiOsGetTableByAddress (
591 ACPI_PHYSICAL_ADDRESS Address,
592 ACPI_TABLE_HEADER **Table);
597 * Directory manipulation
599 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
601 AcpiOsOpenDirectory (
604 char RequestedFileType);
607 /* RequesteFileType values */
609 #define REQUEST_FILE_ONLY 0
610 #define REQUEST_DIR_ONLY 1
613 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
615 AcpiOsGetNextFilename (
619 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
621 AcpiOsCloseDirectory (
627 * File I/O and related support
629 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenFile
636 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseFile
642 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadFile
651 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWriteFile
660 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetFileOffset
662 AcpiOsGetFileOffset (
666 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSetFileOffset
668 AcpiOsSetFileOffset (
675 #endif /* __ACPIOSXF_H__ */