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 0x20101013
125 #include <contrib/dev/acpica/include/actypes.h>
126 #include <contrib/dev/acpica/include/actbl.h>
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_LeaveWakeGpesDisabled;
146 extern UINT8 AcpiGbl_UseDefaultRegisterWidths;
147 extern ACPI_NAME AcpiGbl_TraceMethodName;
148 extern UINT32 AcpiGbl_TraceFlags;
149 extern UINT8 AcpiGbl_EnableAmlDebugObject;
150 extern UINT8 AcpiGbl_CopyDsdtLocally;
151 extern UINT8 AcpiGbl_TruncateIoAddresses;
158 AcpiInitializeTables (
159 ACPI_TABLE_DESC *InitialStorage,
160 UINT32 InitialTableCount,
161 BOOLEAN AllowResize);
164 AcpiInitializeSubsystem (
168 AcpiEnableSubsystem (
172 AcpiInitializeObjects (
180 AcpiSubsystemStatus (
193 ACPI_BUFFER *RetBuffer);
197 ACPI_STATISTICS *Stats);
200 AcpiFormatException (
201 ACPI_STATUS Exception);
204 AcpiPurgeCachedObjects (
208 AcpiInstallInterface (
209 ACPI_STRING InterfaceName);
212 AcpiRemoveInterface (
213 ACPI_STRING InterfaceName);
216 * ACPI Memory management
232 * ACPI table manipulation interfaces
235 AcpiReallocateRootTable (
239 AcpiFindRootPointer (
240 ACPI_SIZE *RsdpAddress);
248 ACPI_STRING Signature,
250 ACPI_TABLE_HEADER *OutTableHeader);
254 ACPI_STRING Signature,
256 ACPI_TABLE_HEADER **OutTable);
259 AcpiGetTableByIndex (
261 ACPI_TABLE_HEADER **OutTable);
264 AcpiInstallTableHandler (
265 ACPI_TABLE_HANDLER Handler,
269 AcpiRemoveTableHandler (
270 ACPI_TABLE_HANDLER Handler);
274 * Namespace and name interfaces
278 ACPI_OBJECT_TYPE Type,
279 ACPI_HANDLE StartObject,
281 ACPI_WALK_CALLBACK PreOrderVisit,
282 ACPI_WALK_CALLBACK PostOrderVisit,
289 ACPI_WALK_CALLBACK UserFunction,
297 ACPI_BUFFER *RetPathPtr);
302 ACPI_STRING Pathname,
303 ACPI_HANDLE *RetHandle);
308 ACPI_OBJECT_HANDLER Handler,
314 ACPI_OBJECT_HANDLER Handler);
319 ACPI_OBJECT_HANDLER Handler,
331 * Object manipulation and enumeration
336 ACPI_STRING Pathname,
337 ACPI_OBJECT_LIST *ParameterObjects,
338 ACPI_BUFFER *ReturnObjectBuffer);
341 AcpiEvaluateObjectTyped (
343 ACPI_STRING Pathname,
344 ACPI_OBJECT_LIST *ExternalParams,
345 ACPI_BUFFER *ReturnBuffer,
346 ACPI_OBJECT_TYPE ReturnType);
351 ACPI_DEVICE_INFO **ReturnBuffer);
359 ACPI_OBJECT_TYPE Type,
362 ACPI_HANDLE *OutHandle);
367 ACPI_OBJECT_TYPE *OutType);
372 ACPI_HANDLE *OutHandle);
379 AcpiInstallInitializationHandler (
380 ACPI_INIT_HANDLER Handler,
384 AcpiInstallFixedEventHandler (
386 ACPI_EVENT_HANDLER Handler,
390 AcpiRemoveFixedEventHandler (
392 ACPI_EVENT_HANDLER Handler);
395 AcpiInstallNotifyHandler (
398 ACPI_NOTIFY_HANDLER Handler,
402 AcpiRemoveNotifyHandler (
405 ACPI_NOTIFY_HANDLER Handler);
408 AcpiInstallAddressSpaceHandler (
410 ACPI_ADR_SPACE_TYPE SpaceId,
411 ACPI_ADR_SPACE_HANDLER Handler,
412 ACPI_ADR_SPACE_SETUP Setup,
416 AcpiRemoveAddressSpaceHandler (
418 ACPI_ADR_SPACE_TYPE SpaceId,
419 ACPI_ADR_SPACE_HANDLER Handler);
422 AcpiInstallGpeHandler (
423 ACPI_HANDLE GpeDevice,
426 ACPI_EVENT_HANDLER Address,
430 AcpiRemoveGpeHandler (
431 ACPI_HANDLE GpeDevice,
433 ACPI_EVENT_HANDLER Address);
436 AcpiInstallExceptionHandler (
437 ACPI_EXCEPTION_HANDLER Handler);
440 AcpiInstallInterfaceHandler (
441 ACPI_INTERFACE_HANDLER Handler);
448 AcpiAcquireGlobalLock (
453 AcpiReleaseGlobalLock (
473 ACPI_EVENT_STATUS *EventStatus);
481 ACPI_HANDLE GpeDevice,
487 ACPI_HANDLE GpeDevice,
492 ACPI_HANDLE GpeDevice,
497 ACPI_HANDLE GpeDevice,
502 ACPI_HANDLE GpeDevice,
508 ACPI_HANDLE GpeDevice,
510 ACPI_EVENT_STATUS *EventStatus);
517 AcpiEnableAllRuntimeGpes (
523 ACPI_HANDLE *GpeDevice);
526 AcpiInstallGpeBlock (
527 ACPI_HANDLE GpeDevice,
528 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
529 UINT32 RegisterCount,
530 UINT32 InterruptNumber);
534 ACPI_HANDLE GpeDevice);
538 * Resource interfaces
541 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
542 ACPI_RESOURCE *Resource,
546 AcpiGetVendorResource (
549 ACPI_VENDOR_UUID *Uuid,
550 ACPI_BUFFER *RetBuffer);
553 AcpiGetCurrentResources (
555 ACPI_BUFFER *RetBuffer);
558 AcpiGetPossibleResources (
560 ACPI_BUFFER *RetBuffer);
566 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
570 AcpiSetCurrentResources (
572 ACPI_BUFFER *InBuffer);
575 AcpiGetIrqRoutingTable (
577 ACPI_BUFFER *RetBuffer);
580 AcpiResourceToAddress64 (
581 ACPI_RESOURCE *Resource,
582 ACPI_RESOURCE_ADDRESS64 *Out);
586 * Hardware (ACPI device) interfaces
595 ACPI_GENERIC_ADDRESS *Reg);
600 ACPI_GENERIC_ADDRESS *Reg);
603 AcpiReadBitRegister (
605 UINT32 *ReturnValue);
608 AcpiWriteBitRegister (
613 AcpiGetSleepTypeData (
619 AcpiEnterSleepStatePrep (
623 AcpiEnterSleepState (
627 AcpiEnterSleepStateS4bios (
631 AcpiLeaveSleepState (
635 AcpiSetFirmwareWakingVector (
636 UINT32 PhysicalAddress);
638 #if ACPI_MACHINE_WIDTH == 64
640 AcpiSetFirmwareWakingVector64 (
641 UINT64 PhysicalAddress);
646 * Error/Warning output
648 void ACPI_INTERNAL_VAR_XFACE
650 const char *ModuleName,
653 ...) ACPI_PRINTF_LIKE(3);
655 void ACPI_INTERNAL_VAR_XFACE
657 const char *ModuleName,
661 ...) ACPI_PRINTF_LIKE(4);
663 void ACPI_INTERNAL_VAR_XFACE
665 const char *ModuleName,
668 ...) ACPI_PRINTF_LIKE(3);
670 void ACPI_INTERNAL_VAR_XFACE
672 const char *ModuleName,
675 ...) ACPI_PRINTF_LIKE(3);
681 #ifdef ACPI_DEBUG_OUTPUT
683 void ACPI_INTERNAL_VAR_XFACE
685 UINT32 RequestedDebugLevel,
687 const char *FunctionName,
688 const char *ModuleName,
691 ...) ACPI_PRINTF_LIKE(6);
693 void ACPI_INTERNAL_VAR_XFACE
695 UINT32 RequestedDebugLevel,
697 const char *FunctionName,
698 const char *ModuleName,
701 ...) ACPI_PRINTF_LIKE(6);
704 #endif /* __ACXFACE_H__ */