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
,
132 OSL_DEBUGGER_MAIN_THREAD
,
133 OSL_DEBUGGER_EXEC_THREAD
,
139 #define ACPI_NO_UNIT_LIMIT ((UINT32) -1)
140 #define ACPI_MUTEX_SEM 1
143 /* Functions for AcpiOsSignal */
145 #define ACPI_SIGNAL_FATAL 0
146 #define ACPI_SIGNAL_BREAKPOINT 1
148 typedef struct acpi_signal_fatal_info
154 } ACPI_SIGNAL_FATAL_INFO
;
158 * OSL Initialization and shutdown primitives
160 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
166 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
174 * ACPI Table interfaces
176 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetRootPointer
177 ACPI_PHYSICAL_ADDRESS
178 AcpiOsGetRootPointer (
182 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPredefinedOverride
184 AcpiOsPredefinedOverride (
185 const ACPI_PREDEFINED_NAMES
*InitVal
,
186 ACPI_STRING
*NewVal
);
189 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTableOverride
191 AcpiOsTableOverride (
192 ACPI_TABLE_HEADER
*ExistingTable
,
193 ACPI_TABLE_HEADER
**NewTable
);
196 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPhysicalTableOverride
198 AcpiOsPhysicalTableOverride (
199 ACPI_TABLE_HEADER
*ExistingTable
,
200 ACPI_PHYSICAL_ADDRESS
*NewAddress
,
201 UINT32
*NewTableLength
);
206 * Spinlock primitives
208 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
211 ACPI_SPINLOCK
*OutHandle
);
214 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteLock
217 ACPI_SPINLOCK Handle
);
220 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireLock
223 ACPI_SPINLOCK Handle
);
226 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReleaseLock
229 ACPI_SPINLOCK Handle
,
230 ACPI_CPU_FLAGS Flags
);
235 * Semaphore primitives
237 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateSemaphore
239 AcpiOsCreateSemaphore (
242 ACPI_SEMAPHORE
*OutHandle
);
245 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteSemaphore
247 AcpiOsDeleteSemaphore (
248 ACPI_SEMAPHORE Handle
);
251 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWaitSemaphore
253 AcpiOsWaitSemaphore (
254 ACPI_SEMAPHORE Handle
,
259 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSignalSemaphore
261 AcpiOsSignalSemaphore (
262 ACPI_SEMAPHORE Handle
,
268 * Mutex primitives. May be configured to use semaphores instead via
269 * ACPI_MUTEX_TYPE (see platform/acenv.h)
271 #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
273 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateMutex
276 ACPI_MUTEX
*OutHandle
);
279 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteMutex
285 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireMutex
292 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReleaseMutex
302 * Memory allocation and mapping
304 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
310 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
312 AcpiOsAllocateZeroed (
316 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
322 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsMapMemory
325 ACPI_PHYSICAL_ADDRESS Where
,
329 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsUnmapMemory
332 void *LogicalAddress
,
336 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetPhysicalAddress
338 AcpiOsGetPhysicalAddress (
339 void *LogicalAddress
,
340 ACPI_PHYSICAL_ADDRESS
*PhysicalAddress
);
345 * Memory/Object Cache
347 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateCache
353 ACPI_CACHE_T
**ReturnCache
);
356 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsDeleteCache
359 ACPI_CACHE_T
*Cache
);
362 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPurgeCache
365 ACPI_CACHE_T
*Cache
);
368 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
370 AcpiOsAcquireObject (
371 ACPI_CACHE_T
*Cache
);
374 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReleaseObject
376 AcpiOsReleaseObject (
385 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInstallInterruptHandler
387 AcpiOsInstallInterruptHandler (
388 UINT32 InterruptNumber
,
389 ACPI_OSD_HANDLER ServiceRoutine
,
393 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRemoveInterruptHandler
395 AcpiOsRemoveInterruptHandler (
396 UINT32 InterruptNumber
,
397 ACPI_OSD_HANDLER ServiceRoutine
);
402 * Threads and Scheduling
404 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
410 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsExecute
413 ACPI_EXECUTE_TYPE Type
,
414 ACPI_OSD_EXEC_CALLBACK Function
,
418 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWaitEventsComplete
420 AcpiOsWaitEventsComplete (
424 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSleep
427 UINT64 Milliseconds
);
430 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsStall
433 UINT32 Microseconds
);
438 * Platform and hardware-independent I/O interfaces
440 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadPort
443 ACPI_IO_ADDRESS Address
,
448 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritePort
451 ACPI_IO_ADDRESS Address
,
458 * Platform and hardware-independent physical memory interfaces
460 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadMemory
463 ACPI_PHYSICAL_ADDRESS Address
,
468 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWriteMemory
471 ACPI_PHYSICAL_ADDRESS Address
,
478 * Platform and hardware-independent PCI configuration space access
479 * Note: Can't use "Register" as a parameter, changed to "Reg" --
480 * certain compilers complain.
482 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadPciConfiguration
484 AcpiOsReadPciConfiguration (
491 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritePciConfiguration
493 AcpiOsWritePciConfiguration (
504 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
511 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
518 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTimer
524 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSignal
533 * Debug print routines
535 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsPrintf
536 void ACPI_INTERNAL_VAR_XFACE
542 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsVprintf
549 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
551 AcpiOsRedirectOutput (
559 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetLine
569 * Obtain ACPI table(s)
571 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
573 AcpiOsGetTableByName (
576 ACPI_TABLE_HEADER
**Table
,
577 ACPI_PHYSICAL_ADDRESS
*Address
);
580 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
582 AcpiOsGetTableByIndex (
584 ACPI_TABLE_HEADER
**Table
,
586 ACPI_PHYSICAL_ADDRESS
*Address
);
589 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
591 AcpiOsGetTableByAddress (
592 ACPI_PHYSICAL_ADDRESS Address
,
593 ACPI_TABLE_HEADER
**Table
);
598 * Directory manipulation
600 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
602 AcpiOsOpenDirectory (
605 char RequestedFileType
);
608 /* RequesteFileType values */
610 #define REQUEST_FILE_ONLY 0
611 #define REQUEST_DIR_ONLY 1
614 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
616 AcpiOsGetNextFilename (
620 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
622 AcpiOsCloseDirectory (
628 * File I/O and related support
630 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenFile
637 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseFile
643 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadFile
652 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWriteFile
661 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetFileOffset
663 AcpiOsGetFileOffset (
667 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsSetFileOffset
669 AcpiOsSetFileOffset (
675 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTracePoint
678 ACPI_TRACE_EVENT_TYPE Type
,
685 #endif /* __ACPIOSXF_H__ */