2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2006, 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__
129 AcpiInitializeTables (
130 ACPI_TABLE_DESC
*InitialStorage
,
131 UINT32 InitialTableCount
,
132 BOOLEAN AllowResize
);
135 AcpiInitializeSubsystem (
139 AcpiEnableSubsystem (
143 AcpiInitializeObjects (
151 AcpiSubsystemStatus (
164 ACPI_BUFFER
*RetBuffer
);
167 AcpiFormatException (
168 ACPI_STATUS Exception
);
171 AcpiPurgeCachedObjects (
175 AcpiInstallInitializationHandler (
176 ACPI_INIT_HANDLER Handler
,
180 * ACPI Memory managment
196 * ACPI table manipulation interfaces
199 AcpiReallocateRootTable (
203 AcpiFindRootPointer (
204 ACPI_NATIVE_UINT
*RsdpAddress
);
212 ACPI_STRING Signature
,
213 ACPI_NATIVE_UINT Instance
,
214 ACPI_TABLE_HEADER
*OutTableHeader
);
218 ACPI_STRING Signature
,
219 ACPI_NATIVE_UINT Instance
,
220 ACPI_TABLE_HEADER
**OutTable
);
223 AcpiGetTableByIndex (
224 ACPI_NATIVE_UINT TableIndex
,
225 ACPI_TABLE_HEADER
**OutTable
);
229 * Namespace and name interfaces
233 ACPI_OBJECT_TYPE Type
,
234 ACPI_HANDLE StartObject
,
236 ACPI_WALK_CALLBACK UserFunction
,
243 ACPI_WALK_CALLBACK UserFunction
,
251 ACPI_BUFFER
*RetPathPtr
);
256 ACPI_STRING Pathname
,
257 ACPI_HANDLE
*RetHandle
);
261 ACPI_HANDLE ObjHandle
,
262 ACPI_OBJECT_HANDLER Handler
,
267 ACPI_HANDLE ObjHandle
,
268 ACPI_OBJECT_HANDLER Handler
);
272 ACPI_HANDLE ObjHandle
,
273 ACPI_OBJECT_HANDLER Handler
,
285 * Object manipulation and enumeration
290 ACPI_STRING Pathname
,
291 ACPI_OBJECT_LIST
*ParameterObjects
,
292 ACPI_BUFFER
*ReturnObjectBuffer
);
295 AcpiEvaluateObjectTyped (
297 ACPI_STRING Pathname
,
298 ACPI_OBJECT_LIST
*ExternalParams
,
299 ACPI_BUFFER
*ReturnBuffer
,
300 ACPI_OBJECT_TYPE ReturnType
);
305 ACPI_BUFFER
*ReturnBuffer
);
309 ACPI_OBJECT_TYPE Type
,
312 ACPI_HANDLE
*OutHandle
);
317 ACPI_OBJECT_TYPE
*OutType
);
322 ACPI_HANDLE
*OutHandle
);
326 * Event handler interfaces
329 AcpiInstallFixedEventHandler (
331 ACPI_EVENT_HANDLER Handler
,
335 AcpiRemoveFixedEventHandler (
337 ACPI_EVENT_HANDLER Handler
);
340 AcpiInstallNotifyHandler (
343 ACPI_NOTIFY_HANDLER Handler
,
347 AcpiRemoveNotifyHandler (
350 ACPI_NOTIFY_HANDLER Handler
);
353 AcpiInstallAddressSpaceHandler (
355 ACPI_ADR_SPACE_TYPE SpaceId
,
356 ACPI_ADR_SPACE_HANDLER Handler
,
357 ACPI_ADR_SPACE_SETUP Setup
,
361 AcpiRemoveAddressSpaceHandler (
363 ACPI_ADR_SPACE_TYPE SpaceId
,
364 ACPI_ADR_SPACE_HANDLER Handler
);
367 AcpiInstallGpeHandler (
368 ACPI_HANDLE GpeDevice
,
371 ACPI_EVENT_HANDLER Address
,
375 AcpiInstallExceptionHandler (
376 ACPI_EXCEPTION_HANDLER Handler
);
383 AcpiAcquireGlobalLock (
388 AcpiReleaseGlobalLock (
392 AcpiRemoveGpeHandler (
393 ACPI_HANDLE GpeDevice
,
395 ACPI_EVENT_HANDLER Address
);
414 ACPI_EVENT_STATUS
*EventStatus
);
418 ACPI_HANDLE GpeDevice
,
424 ACPI_HANDLE GpeDevice
,
430 ACPI_HANDLE GpeDevice
,
436 ACPI_HANDLE GpeDevice
,
442 ACPI_HANDLE GpeDevice
,
445 ACPI_EVENT_STATUS
*EventStatus
);
448 AcpiInstallGpeBlock (
449 ACPI_HANDLE GpeDevice
,
450 ACPI_GENERIC_ADDRESS
*GpeBlockAddress
,
451 UINT32 RegisterCount
,
452 UINT32 InterruptNumber
);
456 ACPI_HANDLE GpeDevice
);
460 * Resource interfaces
463 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK
) (
464 ACPI_RESOURCE
*Resource
,
468 AcpiGetVendorResource (
469 ACPI_HANDLE DeviceHandle
,
471 ACPI_VENDOR_UUID
*Uuid
,
472 ACPI_BUFFER
*RetBuffer
);
475 AcpiGetCurrentResources(
476 ACPI_HANDLE DeviceHandle
,
477 ACPI_BUFFER
*RetBuffer
);
480 AcpiGetPossibleResources(
481 ACPI_HANDLE DeviceHandle
,
482 ACPI_BUFFER
*RetBuffer
);
486 ACPI_HANDLE DeviceHandle
,
488 ACPI_WALK_RESOURCE_CALLBACK UserFunction
,
492 AcpiSetCurrentResources (
493 ACPI_HANDLE DeviceHandle
,
494 ACPI_BUFFER
*InBuffer
);
497 AcpiGetIrqRoutingTable (
498 ACPI_HANDLE BusDeviceHandle
,
499 ACPI_BUFFER
*RetBuffer
);
502 AcpiResourceToAddress64 (
503 ACPI_RESOURCE
*Resource
,
504 ACPI_RESOURCE_ADDRESS64
*Out
);
507 * Hardware (ACPI device) interfaces
512 UINT32
*ReturnValue
);
520 AcpiSetFirmwareWakingVector (
521 ACPI_PHYSICAL_ADDRESS PhysicalAddress
);
524 AcpiGetFirmwareWakingVector (
525 ACPI_PHYSICAL_ADDRESS
*PhysicalAddress
);
528 AcpiGetSleepTypeData (
534 AcpiEnterSleepStatePrep (
538 AcpiEnterSleepState (
542 AcpiEnterSleepStateS4bios (
546 AcpiLeaveSleepState (
550 #endif /* __ACXFACE_H__ */