2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #ifndef __ACXFACE_H__
119 #define __ACXFACE_H__
121 /* Current ACPICA subsystem version in YYYYMMDD format */
123 #define ACPI_CA_VERSION 0x20100702
129 * Globals that are publically available
131 extern UINT32 AcpiCurrentGpeCount
;
132 extern ACPI_TABLE_FADT AcpiGbl_FADT
;
134 /* Runtime configuration of debug print levels */
136 extern UINT32 AcpiDbgLevel
;
137 extern UINT32 AcpiDbgLayer
;
139 /* ACPICA runtime options */
141 extern UINT8 AcpiGbl_EnableInterpreterSlack
;
142 extern UINT8 AcpiGbl_AllMethodsSerialized
;
143 extern UINT8 AcpiGbl_CreateOsiMethod
;
144 extern UINT8 AcpiGbl_LeaveWakeGpesDisabled
;
145 extern UINT8 AcpiGbl_UseDefaultRegisterWidths
;
146 extern ACPI_NAME AcpiGbl_TraceMethodName
;
147 extern UINT32 AcpiGbl_TraceFlags
;
148 extern UINT8 AcpiGbl_EnableAmlDebugObject
;
149 extern UINT8 AcpiGbl_CopyDsdtLocally
;
150 extern UINT8 AcpiGbl_TruncateIoAddresses
;
157 AcpiInitializeTables (
158 ACPI_TABLE_DESC
*InitialStorage
,
159 UINT32 InitialTableCount
,
160 BOOLEAN AllowResize
);
163 AcpiInitializeSubsystem (
167 AcpiEnableSubsystem (
171 AcpiInitializeObjects (
179 AcpiSubsystemStatus (
192 ACPI_BUFFER
*RetBuffer
);
196 ACPI_STATISTICS
*Stats
);
199 AcpiFormatException (
200 ACPI_STATUS Exception
);
203 AcpiPurgeCachedObjects (
208 * ACPI Memory managment
224 * ACPI table manipulation interfaces
227 AcpiReallocateRootTable (
231 AcpiFindRootPointer (
232 ACPI_SIZE
*RsdpAddress
);
240 ACPI_STRING Signature
,
242 ACPI_TABLE_HEADER
*OutTableHeader
);
246 ACPI_STRING Signature
,
248 ACPI_TABLE_HEADER
**OutTable
);
251 AcpiGetTableByIndex (
253 ACPI_TABLE_HEADER
**OutTable
);
256 AcpiInstallTableHandler (
257 ACPI_TABLE_HANDLER Handler
,
261 AcpiRemoveTableHandler (
262 ACPI_TABLE_HANDLER Handler
);
266 * Namespace and name interfaces
270 ACPI_OBJECT_TYPE Type
,
271 ACPI_HANDLE StartObject
,
273 ACPI_WALK_CALLBACK PreOrderVisit
,
274 ACPI_WALK_CALLBACK PostOrderVisit
,
281 ACPI_WALK_CALLBACK UserFunction
,
289 ACPI_BUFFER
*RetPathPtr
);
294 ACPI_STRING Pathname
,
295 ACPI_HANDLE
*RetHandle
);
300 ACPI_OBJECT_HANDLER Handler
,
306 ACPI_OBJECT_HANDLER Handler
);
311 ACPI_OBJECT_HANDLER Handler
,
323 * Object manipulation and enumeration
328 ACPI_STRING Pathname
,
329 ACPI_OBJECT_LIST
*ParameterObjects
,
330 ACPI_BUFFER
*ReturnObjectBuffer
);
333 AcpiEvaluateObjectTyped (
335 ACPI_STRING Pathname
,
336 ACPI_OBJECT_LIST
*ExternalParams
,
337 ACPI_BUFFER
*ReturnBuffer
,
338 ACPI_OBJECT_TYPE ReturnType
);
343 ACPI_DEVICE_INFO
**ReturnBuffer
);
351 ACPI_OBJECT_TYPE Type
,
354 ACPI_HANDLE
*OutHandle
);
359 ACPI_OBJECT_TYPE
*OutType
);
364 ACPI_HANDLE
*OutHandle
);
371 AcpiInstallInitializationHandler (
372 ACPI_INIT_HANDLER Handler
,
376 AcpiInstallFixedEventHandler (
378 ACPI_EVENT_HANDLER Handler
,
382 AcpiRemoveFixedEventHandler (
384 ACPI_EVENT_HANDLER Handler
);
387 AcpiInstallNotifyHandler (
390 ACPI_NOTIFY_HANDLER Handler
,
394 AcpiRemoveNotifyHandler (
397 ACPI_NOTIFY_HANDLER Handler
);
400 AcpiInstallAddressSpaceHandler (
402 ACPI_ADR_SPACE_TYPE SpaceId
,
403 ACPI_ADR_SPACE_HANDLER Handler
,
404 ACPI_ADR_SPACE_SETUP Setup
,
408 AcpiRemoveAddressSpaceHandler (
410 ACPI_ADR_SPACE_TYPE SpaceId
,
411 ACPI_ADR_SPACE_HANDLER Handler
);
414 AcpiInstallGpeHandler (
415 ACPI_HANDLE GpeDevice
,
418 ACPI_EVENT_HANDLER Address
,
422 AcpiRemoveGpeHandler (
423 ACPI_HANDLE GpeDevice
,
425 ACPI_EVENT_HANDLER Address
);
428 AcpiInstallExceptionHandler (
429 ACPI_EXCEPTION_HANDLER Handler
);
436 AcpiAcquireGlobalLock (
441 AcpiReleaseGlobalLock (
461 ACPI_EVENT_STATUS
*EventStatus
);
469 ACPI_HANDLE GpeDevice
,
475 ACPI_HANDLE GpeDevice
,
480 ACPI_HANDLE GpeDevice
,
485 ACPI_HANDLE GpeDevice
,
490 ACPI_HANDLE GpeDevice
,
496 ACPI_HANDLE GpeDevice
,
498 ACPI_EVENT_STATUS
*EventStatus
);
505 AcpiEnableAllRuntimeGpes (
511 ACPI_HANDLE
*GpeDevice
);
514 AcpiInstallGpeBlock (
515 ACPI_HANDLE GpeDevice
,
516 ACPI_GENERIC_ADDRESS
*GpeBlockAddress
,
517 UINT32 RegisterCount
,
518 UINT32 InterruptNumber
);
522 ACPI_HANDLE GpeDevice
);
526 * Resource interfaces
529 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK
) (
530 ACPI_RESOURCE
*Resource
,
534 AcpiGetVendorResource (
537 ACPI_VENDOR_UUID
*Uuid
,
538 ACPI_BUFFER
*RetBuffer
);
541 AcpiGetCurrentResources (
543 ACPI_BUFFER
*RetBuffer
);
546 AcpiGetPossibleResources (
548 ACPI_BUFFER
*RetBuffer
);
554 ACPI_WALK_RESOURCE_CALLBACK UserFunction
,
558 AcpiSetCurrentResources (
560 ACPI_BUFFER
*InBuffer
);
563 AcpiGetIrqRoutingTable (
565 ACPI_BUFFER
*RetBuffer
);
568 AcpiResourceToAddress64 (
569 ACPI_RESOURCE
*Resource
,
570 ACPI_RESOURCE_ADDRESS64
*Out
);
574 * Hardware (ACPI device) interfaces
583 ACPI_GENERIC_ADDRESS
*Reg
);
588 ACPI_GENERIC_ADDRESS
*Reg
);
591 AcpiReadBitRegister (
593 UINT32
*ReturnValue
);
596 AcpiWriteBitRegister (
601 AcpiGetSleepTypeData (
607 AcpiEnterSleepStatePrep (
611 AcpiEnterSleepState (
615 AcpiEnterSleepStateS4bios (
619 AcpiLeaveSleepState (
623 AcpiSetFirmwareWakingVector (
624 UINT32 PhysicalAddress
);
626 #if ACPI_MACHINE_WIDTH == 64
628 AcpiSetFirmwareWakingVector64 (
629 UINT64 PhysicalAddress
);
634 * Error/Warning output
636 void ACPI_INTERNAL_VAR_XFACE
638 const char *ModuleName
,
641 ...) ACPI_PRINTF_LIKE(3);
643 void ACPI_INTERNAL_VAR_XFACE
645 const char *ModuleName
,
649 ...) ACPI_PRINTF_LIKE(4);
651 void ACPI_INTERNAL_VAR_XFACE
653 const char *ModuleName
,
656 ...) ACPI_PRINTF_LIKE(3);
658 void ACPI_INTERNAL_VAR_XFACE
660 const char *ModuleName
,
663 ...) ACPI_PRINTF_LIKE(3);
669 #ifdef ACPI_DEBUG_OUTPUT
671 void ACPI_INTERNAL_VAR_XFACE
673 UINT32 RequestedDebugLevel
,
675 const char *FunctionName
,
676 const char *ModuleName
,
679 ...) ACPI_PRINTF_LIKE(6);
681 void ACPI_INTERNAL_VAR_XFACE
683 UINT32 RequestedDebugLevel
,
685 const char *FunctionName
,
686 const char *ModuleName
,
689 ...) ACPI_PRINTF_LIKE(6);
692 #endif /* __ACXFACE_H__ */