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 0x20110211
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;
157 AcpiInitializeTables (
158 ACPI_TABLE_DESC *InitialStorage,
159 UINT32 InitialTableCount,
160 BOOLEAN AllowResize);
163 AcpiInitializeSubsystem (
167 AcpiEnableSubsystem (
171 AcpiInitializeObjects (
180 * Miscellaneous global interfaces
191 AcpiSubsystemStatus (
196 ACPI_BUFFER *RetBuffer);
200 ACPI_STATISTICS *Stats);
203 AcpiFormatException (
204 ACPI_STATUS Exception);
207 AcpiPurgeCachedObjects (
211 AcpiInstallInterface (
212 ACPI_STRING InterfaceName);
215 AcpiRemoveInterface (
216 ACPI_STRING InterfaceName);
220 * ACPI Memory management
236 * ACPI table manipulation interfaces
239 AcpiReallocateRootTable (
243 AcpiFindRootPointer (
244 ACPI_SIZE *RsdpAddress);
252 ACPI_STRING Signature,
254 ACPI_TABLE_HEADER *OutTableHeader);
258 ACPI_STRING Signature,
260 ACPI_TABLE_HEADER **OutTable);
263 AcpiGetTableByIndex (
265 ACPI_TABLE_HEADER **OutTable);
268 AcpiInstallTableHandler (
269 ACPI_TABLE_HANDLER Handler,
273 AcpiRemoveTableHandler (
274 ACPI_TABLE_HANDLER Handler);
278 * Namespace and name interfaces
282 ACPI_OBJECT_TYPE Type,
283 ACPI_HANDLE StartObject,
285 ACPI_WALK_CALLBACK PreOrderVisit,
286 ACPI_WALK_CALLBACK PostOrderVisit,
293 ACPI_WALK_CALLBACK UserFunction,
301 ACPI_BUFFER *RetPathPtr);
306 ACPI_STRING Pathname,
307 ACPI_HANDLE *RetHandle);
312 ACPI_OBJECT_HANDLER Handler,
318 ACPI_OBJECT_HANDLER Handler);
323 ACPI_OBJECT_HANDLER Handler,
335 * Object manipulation and enumeration
340 ACPI_STRING Pathname,
341 ACPI_OBJECT_LIST *ParameterObjects,
342 ACPI_BUFFER *ReturnObjectBuffer);
345 AcpiEvaluateObjectTyped (
347 ACPI_STRING Pathname,
348 ACPI_OBJECT_LIST *ExternalParams,
349 ACPI_BUFFER *ReturnBuffer,
350 ACPI_OBJECT_TYPE ReturnType);
355 ACPI_DEVICE_INFO **ReturnBuffer);
363 ACPI_OBJECT_TYPE Type,
366 ACPI_HANDLE *OutHandle);
371 ACPI_OBJECT_TYPE *OutType);
376 ACPI_HANDLE *OutHandle);
383 AcpiInstallInitializationHandler (
384 ACPI_INIT_HANDLER Handler,
388 AcpiInstallGlobalEventHandler (
389 ACPI_GBL_EVENT_HANDLER Handler,
393 AcpiInstallFixedEventHandler (
395 ACPI_EVENT_HANDLER Handler,
399 AcpiRemoveFixedEventHandler (
401 ACPI_EVENT_HANDLER Handler);
404 AcpiInstallGpeHandler (
405 ACPI_HANDLE GpeDevice,
408 ACPI_GPE_HANDLER Address,
412 AcpiRemoveGpeHandler (
413 ACPI_HANDLE GpeDevice,
415 ACPI_GPE_HANDLER Address);
418 AcpiInstallNotifyHandler (
421 ACPI_NOTIFY_HANDLER Handler,
425 AcpiRemoveNotifyHandler (
428 ACPI_NOTIFY_HANDLER Handler);
431 AcpiInstallAddressSpaceHandler (
433 ACPI_ADR_SPACE_TYPE SpaceId,
434 ACPI_ADR_SPACE_HANDLER Handler,
435 ACPI_ADR_SPACE_SETUP Setup,
439 AcpiRemoveAddressSpaceHandler (
441 ACPI_ADR_SPACE_TYPE SpaceId,
442 ACPI_ADR_SPACE_HANDLER Handler);
445 AcpiInstallExceptionHandler (
446 ACPI_EXCEPTION_HANDLER Handler);
449 AcpiInstallInterfaceHandler (
450 ACPI_INTERFACE_HANDLER Handler);
454 * Global Lock interfaces
457 AcpiAcquireGlobalLock (
462 AcpiReleaseGlobalLock (
467 * Fixed Event interfaces
486 ACPI_EVENT_STATUS *EventStatus);
490 * General Purpose Event (GPE) Interfaces
498 ACPI_HANDLE GpeDevice,
503 ACPI_HANDLE GpeDevice,
508 ACPI_HANDLE GpeDevice,
513 ACPI_HANDLE GpeDevice,
519 ACPI_HANDLE GpeDevice,
523 AcpiSetupGpeForWake (
524 ACPI_HANDLE ParentDevice,
525 ACPI_HANDLE GpeDevice,
530 ACPI_HANDLE GpeDevice,
536 ACPI_HANDLE GpeDevice,
538 ACPI_EVENT_STATUS *EventStatus);
545 AcpiEnableAllRuntimeGpes (
551 ACPI_HANDLE *GpeDevice);
554 AcpiInstallGpeBlock (
555 ACPI_HANDLE GpeDevice,
556 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
557 UINT32 RegisterCount,
558 UINT32 InterruptNumber);
562 ACPI_HANDLE GpeDevice);
566 * Resource interfaces
569 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
570 ACPI_RESOURCE *Resource,
574 AcpiGetVendorResource (
577 ACPI_VENDOR_UUID *Uuid,
578 ACPI_BUFFER *RetBuffer);
581 AcpiGetCurrentResources (
583 ACPI_BUFFER *RetBuffer);
586 AcpiGetPossibleResources (
588 ACPI_BUFFER *RetBuffer);
594 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
598 AcpiSetCurrentResources (
600 ACPI_BUFFER *InBuffer);
603 AcpiGetIrqRoutingTable (
605 ACPI_BUFFER *RetBuffer);
608 AcpiResourceToAddress64 (
609 ACPI_RESOURCE *Resource,
610 ACPI_RESOURCE_ADDRESS64 *Out);
614 * Hardware (ACPI device) interfaces
623 ACPI_GENERIC_ADDRESS *Reg);
628 ACPI_GENERIC_ADDRESS *Reg);
631 AcpiReadBitRegister (
633 UINT32 *ReturnValue);
636 AcpiWriteBitRegister (
641 AcpiGetSleepTypeData (
647 AcpiEnterSleepStatePrep (
651 AcpiEnterSleepState (
655 AcpiEnterSleepStateS4bios (
659 AcpiLeaveSleepState (
663 AcpiSetFirmwareWakingVector (
664 UINT32 PhysicalAddress);
666 #if ACPI_MACHINE_WIDTH == 64
668 AcpiSetFirmwareWakingVector64 (
669 UINT64 PhysicalAddress);
674 * Error/Warning output
676 void ACPI_INTERNAL_VAR_XFACE
678 const char *ModuleName,
681 ...) ACPI_PRINTF_LIKE(3);
683 void ACPI_INTERNAL_VAR_XFACE
685 const char *ModuleName,
689 ...) ACPI_PRINTF_LIKE(4);
691 void ACPI_INTERNAL_VAR_XFACE
693 const char *ModuleName,
696 ...) ACPI_PRINTF_LIKE(3);
698 void ACPI_INTERNAL_VAR_XFACE
700 const char *ModuleName,
703 ...) ACPI_PRINTF_LIKE(3);
709 #ifdef ACPI_DEBUG_OUTPUT
711 void ACPI_INTERNAL_VAR_XFACE
713 UINT32 RequestedDebugLevel,
715 const char *FunctionName,
716 const char *ModuleName,
719 ...) ACPI_PRINTF_LIKE(6);
721 void ACPI_INTERNAL_VAR_XFACE
723 UINT32 RequestedDebugLevel,
725 const char *FunctionName,
726 const char *ModuleName,
729 ...) ACPI_PRINTF_LIKE(6);
732 #endif /* __ACXFACE_H__ */