2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2011, 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 0x20110922
129 * Globals that are publically available
131 extern UINT32 AcpiCurrentGpeCount
;
132 extern ACPI_TABLE_FADT AcpiGbl_FADT
;
133 extern BOOLEAN AcpiGbl_SystemAwakeAndRunning
;
135 /* Runtime configuration of debug print levels */
137 extern UINT32 AcpiDbgLevel
;
138 extern UINT32 AcpiDbgLayer
;
140 /* ACPICA runtime options */
142 extern UINT8 AcpiGbl_EnableInterpreterSlack
;
143 extern UINT8 AcpiGbl_AllMethodsSerialized
;
144 extern UINT8 AcpiGbl_CreateOsiMethod
;
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
;
151 extern UINT8 AcpiGbl_DisableAutoRepair
;
158 AcpiInitializeTables (
159 ACPI_TABLE_DESC
*InitialStorage
,
160 UINT32 InitialTableCount
,
161 BOOLEAN AllowResize
);
164 AcpiInitializeSubsystem (
168 AcpiEnableSubsystem (
172 AcpiInitializeObjects (
181 * Miscellaneous global interfaces
192 AcpiSubsystemStatus (
197 ACPI_BUFFER
*RetBuffer
);
201 ACPI_STATISTICS
*Stats
);
204 AcpiFormatException (
205 ACPI_STATUS Exception
);
208 AcpiPurgeCachedObjects (
212 AcpiInstallInterface (
213 ACPI_STRING InterfaceName
);
216 AcpiRemoveInterface (
217 ACPI_STRING InterfaceName
);
221 * ACPI Memory management
237 * ACPI table manipulation interfaces
240 AcpiReallocateRootTable (
244 AcpiFindRootPointer (
245 ACPI_SIZE
*RsdpAddress
);
253 ACPI_STRING Signature
,
255 ACPI_TABLE_HEADER
*OutTableHeader
);
259 ACPI_STRING Signature
,
261 ACPI_TABLE_HEADER
**OutTable
);
264 AcpiGetTableByIndex (
266 ACPI_TABLE_HEADER
**OutTable
);
269 AcpiInstallTableHandler (
270 ACPI_TABLE_HANDLER Handler
,
274 AcpiRemoveTableHandler (
275 ACPI_TABLE_HANDLER Handler
);
279 * Namespace and name interfaces
283 ACPI_OBJECT_TYPE Type
,
284 ACPI_HANDLE StartObject
,
286 ACPI_WALK_CALLBACK PreOrderVisit
,
287 ACPI_WALK_CALLBACK PostOrderVisit
,
294 ACPI_WALK_CALLBACK UserFunction
,
302 ACPI_BUFFER
*RetPathPtr
);
307 ACPI_STRING Pathname
,
308 ACPI_HANDLE
*RetHandle
);
313 ACPI_OBJECT_HANDLER Handler
,
319 ACPI_OBJECT_HANDLER Handler
);
324 ACPI_OBJECT_HANDLER Handler
,
336 * Object manipulation and enumeration
341 ACPI_STRING Pathname
,
342 ACPI_OBJECT_LIST
*ParameterObjects
,
343 ACPI_BUFFER
*ReturnObjectBuffer
);
346 AcpiEvaluateObjectTyped (
348 ACPI_STRING Pathname
,
349 ACPI_OBJECT_LIST
*ExternalParams
,
350 ACPI_BUFFER
*ReturnBuffer
,
351 ACPI_OBJECT_TYPE ReturnType
);
356 ACPI_DEVICE_INFO
**ReturnBuffer
);
364 ACPI_OBJECT_TYPE Type
,
367 ACPI_HANDLE
*OutHandle
);
372 ACPI_OBJECT_TYPE
*OutType
);
377 ACPI_HANDLE
*OutHandle
);
384 AcpiInstallInitializationHandler (
385 ACPI_INIT_HANDLER Handler
,
389 AcpiInstallGlobalEventHandler (
390 ACPI_GBL_EVENT_HANDLER Handler
,
394 AcpiInstallFixedEventHandler (
396 ACPI_EVENT_HANDLER Handler
,
400 AcpiRemoveFixedEventHandler (
402 ACPI_EVENT_HANDLER Handler
);
405 AcpiInstallGpeHandler (
406 ACPI_HANDLE GpeDevice
,
409 ACPI_GPE_HANDLER Address
,
413 AcpiRemoveGpeHandler (
414 ACPI_HANDLE GpeDevice
,
416 ACPI_GPE_HANDLER Address
);
419 AcpiInstallNotifyHandler (
422 ACPI_NOTIFY_HANDLER Handler
,
426 AcpiRemoveNotifyHandler (
429 ACPI_NOTIFY_HANDLER Handler
);
432 AcpiInstallAddressSpaceHandler (
434 ACPI_ADR_SPACE_TYPE SpaceId
,
435 ACPI_ADR_SPACE_HANDLER Handler
,
436 ACPI_ADR_SPACE_SETUP Setup
,
440 AcpiRemoveAddressSpaceHandler (
442 ACPI_ADR_SPACE_TYPE SpaceId
,
443 ACPI_ADR_SPACE_HANDLER Handler
);
446 AcpiInstallExceptionHandler (
447 ACPI_EXCEPTION_HANDLER Handler
);
450 AcpiInstallInterfaceHandler (
451 ACPI_INTERFACE_HANDLER Handler
);
455 * Global Lock interfaces
458 AcpiAcquireGlobalLock (
463 AcpiReleaseGlobalLock (
468 * Fixed Event interfaces
487 ACPI_EVENT_STATUS
*EventStatus
);
491 * General Purpose Event (GPE) Interfaces
499 ACPI_HANDLE GpeDevice
,
504 ACPI_HANDLE GpeDevice
,
509 ACPI_HANDLE GpeDevice
,
514 ACPI_HANDLE GpeDevice
,
520 ACPI_HANDLE GpeDevice
,
524 AcpiSetupGpeForWake (
525 ACPI_HANDLE ParentDevice
,
526 ACPI_HANDLE GpeDevice
,
531 ACPI_HANDLE GpeDevice
,
537 ACPI_HANDLE GpeDevice
,
539 ACPI_EVENT_STATUS
*EventStatus
);
546 AcpiEnableAllRuntimeGpes (
552 ACPI_HANDLE
*GpeDevice
);
555 AcpiInstallGpeBlock (
556 ACPI_HANDLE GpeDevice
,
557 ACPI_GENERIC_ADDRESS
*GpeBlockAddress
,
558 UINT32 RegisterCount
,
559 UINT32 InterruptNumber
);
563 ACPI_HANDLE GpeDevice
);
567 * Resource interfaces
570 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK
) (
571 ACPI_RESOURCE
*Resource
,
575 AcpiGetVendorResource (
578 ACPI_VENDOR_UUID
*Uuid
,
579 ACPI_BUFFER
*RetBuffer
);
582 AcpiGetCurrentResources (
584 ACPI_BUFFER
*RetBuffer
);
587 AcpiGetPossibleResources (
589 ACPI_BUFFER
*RetBuffer
);
595 ACPI_WALK_RESOURCE_CALLBACK UserFunction
,
599 AcpiSetCurrentResources (
601 ACPI_BUFFER
*InBuffer
);
604 AcpiGetIrqRoutingTable (
606 ACPI_BUFFER
*RetBuffer
);
609 AcpiResourceToAddress64 (
610 ACPI_RESOURCE
*Resource
,
611 ACPI_RESOURCE_ADDRESS64
*Out
);
615 * Hardware (ACPI device) interfaces
624 ACPI_GENERIC_ADDRESS
*Reg
);
629 ACPI_GENERIC_ADDRESS
*Reg
);
632 AcpiReadBitRegister (
634 UINT32
*ReturnValue
);
637 AcpiWriteBitRegister (
642 AcpiGetSleepTypeData (
648 AcpiEnterSleepStatePrep (
652 AcpiEnterSleepState (
656 AcpiEnterSleepStateS4bios (
660 AcpiLeaveSleepState (
664 AcpiSetFirmwareWakingVector (
665 UINT32 PhysicalAddress
);
667 #if ACPI_MACHINE_WIDTH == 64
669 AcpiSetFirmwareWakingVector64 (
670 UINT64 PhysicalAddress
);
675 * Error/Warning output
677 void ACPI_INTERNAL_VAR_XFACE
679 const char *ModuleName
,
682 ...) ACPI_PRINTF_LIKE(3);
684 void ACPI_INTERNAL_VAR_XFACE
686 const char *ModuleName
,
690 ...) ACPI_PRINTF_LIKE(4);
692 void ACPI_INTERNAL_VAR_XFACE
694 const char *ModuleName
,
697 ...) ACPI_PRINTF_LIKE(3);
699 void ACPI_INTERNAL_VAR_XFACE
701 const char *ModuleName
,
704 ...) ACPI_PRINTF_LIKE(3);
710 #ifdef ACPI_DEBUG_OUTPUT
712 void ACPI_INTERNAL_VAR_XFACE
714 UINT32 RequestedDebugLevel
,
716 const char *FunctionName
,
717 const char *ModuleName
,
720 ...) ACPI_PRINTF_LIKE(6);
722 void ACPI_INTERNAL_VAR_XFACE
724 UINT32 RequestedDebugLevel
,
726 const char *FunctionName
,
727 const char *ModuleName
,
730 ...) ACPI_PRINTF_LIKE(6);
733 #endif /* __ACXFACE_H__ */