2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2009, 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 0x20090730
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
;
154 AcpiInitializeTables (
155 ACPI_TABLE_DESC
*InitialStorage
,
156 UINT32 InitialTableCount
,
157 BOOLEAN AllowResize
);
160 AcpiInitializeSubsystem (
164 AcpiEnableSubsystem (
168 AcpiInitializeObjects (
176 AcpiSubsystemStatus (
189 ACPI_BUFFER
*RetBuffer
);
193 ACPI_STATISTICS
*Stats
);
196 AcpiFormatException (
197 ACPI_STATUS Exception
);
200 AcpiPurgeCachedObjects (
205 * ACPI Memory managment
221 * ACPI table manipulation interfaces
224 AcpiReallocateRootTable (
228 AcpiFindRootPointer (
229 ACPI_SIZE
*RsdpAddress
);
237 ACPI_CONST_STRING Signature
,
239 ACPI_TABLE_HEADER
*OutTableHeader
);
243 ACPI_CONST_STRING Signature
,
245 ACPI_TABLE_HEADER
**OutTable
);
248 AcpiGetTableByIndex (
250 ACPI_TABLE_HEADER
**OutTable
);
253 AcpiInstallTableHandler (
254 ACPI_TABLE_HANDLER Handler
,
258 AcpiRemoveTableHandler (
259 ACPI_TABLE_HANDLER Handler
);
263 * Namespace and name interfaces
267 ACPI_OBJECT_TYPE Type
,
268 ACPI_HANDLE StartObject
,
270 ACPI_WALK_CALLBACK UserFunction
,
277 ACPI_WALK_CALLBACK UserFunction
,
285 ACPI_BUFFER
*RetPathPtr
);
290 ACPI_CONST_STRING Pathname
,
291 ACPI_HANDLE
*RetHandle
);
295 ACPI_HANDLE ObjHandle
,
296 ACPI_OBJECT_HANDLER Handler
,
301 ACPI_HANDLE ObjHandle
,
302 ACPI_OBJECT_HANDLER Handler
);
306 ACPI_HANDLE ObjHandle
,
307 ACPI_OBJECT_HANDLER Handler
,
319 * Object manipulation and enumeration
324 ACPI_CONST_STRING Pathname
,
325 ACPI_OBJECT_LIST
*ParameterObjects
,
326 ACPI_BUFFER
*ReturnObjectBuffer
);
329 AcpiEvaluateObjectTyped (
331 ACPI_CONST_STRING Pathname
,
332 ACPI_OBJECT_LIST
*ExternalParams
,
333 ACPI_BUFFER
*ReturnBuffer
,
334 ACPI_OBJECT_TYPE ReturnType
);
339 ACPI_DEVICE_INFO
**ReturnBuffer
);
347 ACPI_OBJECT_TYPE Type
,
350 ACPI_HANDLE
*OutHandle
);
355 ACPI_OBJECT_TYPE
*OutType
);
360 ACPI_HANDLE
*OutHandle
);
367 AcpiInstallInitializationHandler (
368 ACPI_INIT_HANDLER Handler
,
372 AcpiInstallFixedEventHandler (
374 ACPI_EVENT_HANDLER Handler
,
378 AcpiRemoveFixedEventHandler (
380 ACPI_EVENT_HANDLER Handler
);
383 AcpiInstallNotifyHandler (
386 ACPI_NOTIFY_HANDLER Handler
,
390 AcpiRemoveNotifyHandler (
393 ACPI_NOTIFY_HANDLER Handler
);
396 AcpiInstallAddressSpaceHandler (
398 ACPI_ADR_SPACE_TYPE SpaceId
,
399 ACPI_ADR_SPACE_HANDLER Handler
,
400 ACPI_ADR_SPACE_SETUP Setup
,
404 AcpiRemoveAddressSpaceHandler (
406 ACPI_ADR_SPACE_TYPE SpaceId
,
407 ACPI_ADR_SPACE_HANDLER Handler
);
410 AcpiInstallGpeHandler (
411 ACPI_HANDLE GpeDevice
,
414 ACPI_EVENT_HANDLER Address
,
418 AcpiRemoveGpeHandler (
419 ACPI_HANDLE GpeDevice
,
421 ACPI_EVENT_HANDLER Address
);
424 AcpiInstallExceptionHandler (
425 ACPI_EXCEPTION_HANDLER Handler
);
432 AcpiAcquireGlobalLock (
437 AcpiReleaseGlobalLock (
457 ACPI_EVENT_STATUS
*EventStatus
);
465 ACPI_HANDLE GpeDevice
,
471 ACPI_HANDLE GpeDevice
,
477 ACPI_HANDLE GpeDevice
,
483 ACPI_HANDLE GpeDevice
,
489 ACPI_HANDLE GpeDevice
,
492 ACPI_EVENT_STATUS
*EventStatus
);
499 AcpiEnableAllRuntimeGpes (
505 ACPI_HANDLE
*GpeDevice
);
508 AcpiInstallGpeBlock (
509 ACPI_HANDLE GpeDevice
,
510 ACPI_GENERIC_ADDRESS
*GpeBlockAddress
,
511 UINT32 RegisterCount
,
512 UINT32 InterruptNumber
);
516 ACPI_HANDLE GpeDevice
);
520 * Resource interfaces
523 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK
) (
524 ACPI_RESOURCE
*Resource
,
528 AcpiGetVendorResource (
529 ACPI_HANDLE DeviceHandle
,
531 ACPI_VENDOR_UUID
*Uuid
,
532 ACPI_BUFFER
*RetBuffer
);
535 AcpiGetCurrentResources(
536 ACPI_HANDLE DeviceHandle
,
537 ACPI_BUFFER
*RetBuffer
);
540 AcpiGetPossibleResources(
541 ACPI_HANDLE DeviceHandle
,
542 ACPI_BUFFER
*RetBuffer
);
546 ACPI_HANDLE DeviceHandle
,
548 ACPI_WALK_RESOURCE_CALLBACK UserFunction
,
552 AcpiSetCurrentResources (
553 ACPI_HANDLE DeviceHandle
,
554 ACPI_BUFFER
*InBuffer
);
557 AcpiGetIrqRoutingTable (
558 ACPI_HANDLE BusDeviceHandle
,
559 ACPI_BUFFER
*RetBuffer
);
562 AcpiResourceToAddress64 (
563 ACPI_RESOURCE
*Resource
,
564 ACPI_RESOURCE_ADDRESS64
*Out
);
568 * Hardware (ACPI device) interfaces
577 ACPI_GENERIC_ADDRESS
*Reg
);
582 ACPI_GENERIC_ADDRESS
*Reg
);
585 AcpiReadBitRegister (
587 UINT32
*ReturnValue
);
590 AcpiWriteBitRegister (
595 AcpiGetSleepTypeData (
601 AcpiEnterSleepStatePrep (
605 AcpiEnterSleepState (
609 AcpiEnterSleepStateS4bios (
613 AcpiLeaveSleepState (
617 AcpiSetFirmwareWakingVector (
618 UINT32 PhysicalAddress
);
620 #if ACPI_MACHINE_WIDTH == 64
622 AcpiSetFirmwareWakingVector64 (
623 UINT64 PhysicalAddress
);
628 * Error/Warning output
630 void ACPI_INTERNAL_VAR_XFACE
632 const char *ModuleName
,
635 ...) ACPI_PRINTF_LIKE(3);
637 void ACPI_INTERNAL_VAR_XFACE
639 const char *ModuleName
,
643 ...) ACPI_PRINTF_LIKE(4);
645 void ACPI_INTERNAL_VAR_XFACE
647 const char *ModuleName
,
650 ...) ACPI_PRINTF_LIKE(3);
652 void ACPI_INTERNAL_VAR_XFACE
654 const char *ModuleName
,
657 ...) ACPI_PRINTF_LIKE(3);
663 #ifdef ACPI_DEBUG_OUTPUT
665 void ACPI_INTERNAL_VAR_XFACE
667 UINT32 RequestedDebugLevel
,
669 const char *FunctionName
,
670 const char *ModuleName
,
673 ...) ACPI_PRINTF_LIKE(6);
675 void ACPI_INTERNAL_VAR_XFACE
677 UINT32 RequestedDebugLevel
,
679 const char *FunctionName
,
680 const char *ModuleName
,
683 ...) ACPI_PRINTF_LIKE(6);
686 #endif /* __ACXFACE_H__ */