acpixf.h revision 91116
167754Smsmith 267754Smsmith/****************************************************************************** 367754Smsmith * 470243Smsmith * Name: acpixf.h - External interfaces to the ACPI subsystem 567754Smsmith * 667754Smsmith *****************************************************************************/ 767754Smsmith 867754Smsmith/****************************************************************************** 967754Smsmith * 1067754Smsmith * 1. Copyright Notice 1167754Smsmith * 1291116Smsmith * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 1370243Smsmith * All rights reserved. 1467754Smsmith * 1567754Smsmith * 2. License 1667754Smsmith * 1767754Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1867754Smsmith * rights. You may have additional license terms from the party that provided 1967754Smsmith * you this software, covering your right to use that party's intellectual 2067754Smsmith * property rights. 2167754Smsmith * 2267754Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2367754Smsmith * copy of the source code appearing in this file ("Covered Code") an 2467754Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2567754Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2667754Smsmith * make derivatives, distribute, use and display any portion of the Covered 2767754Smsmith * Code in any form, with the right to sublicense such rights; and 2867754Smsmith * 2967754Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3067754Smsmith * license (with the right to sublicense), under only those claims of Intel 3167754Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3267754Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3367754Smsmith * solely to the minimum extent necessary to exercise the above copyright 3467754Smsmith * license, and in no event shall the patent license extend to any additions 3567754Smsmith * to or modifications of the Original Intel Code. No other license or right 3667754Smsmith * is granted directly or by implication, estoppel or otherwise; 3767754Smsmith * 3867754Smsmith * The above copyright and patent license is granted only if the following 3967754Smsmith * conditions are met: 4067754Smsmith * 4167754Smsmith * 3. Conditions 4267754Smsmith * 4367754Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4467754Smsmith * Redistribution of source code of any substantial portion of the Covered 4567754Smsmith * Code or modification with rights to further distribute source must include 4667754Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4767754Smsmith * and the following Disclaimer and Export Compliance provision. In addition, 4867754Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 4967754Smsmith * contain a file documenting the changes Licensee made to create that Covered 5067754Smsmith * Code and the date of any change. Licensee must include in that file the 5167754Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5267754Smsmith * must include a prominent statement that the modification is derived, 5367754Smsmith * directly or indirectly, from Original Intel Code. 5467754Smsmith * 5567754Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5667754Smsmith * Redistribution of source code of any substantial portion of the Covered 5767754Smsmith * Code or modification without rights to further distribute source must 5867754Smsmith * include the following Disclaimer and Export Compliance provision in the 5967754Smsmith * documentation and/or other materials provided with distribution. In 6067754Smsmith * addition, Licensee may not authorize further sublicense of source of any 6167754Smsmith * portion of the Covered Code, and must include terms to the effect that the 6267754Smsmith * license from Licensee to its licensee is limited to the intellectual 6367754Smsmith * property embodied in the software Licensee provides to its licensee, and 6467754Smsmith * not to intellectual property embodied in modifications its licensee may 6567754Smsmith * make. 6667754Smsmith * 6767754Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6867754Smsmith * substantial portion of the Covered Code or modification must reproduce the 6967754Smsmith * above Copyright Notice, and the following Disclaimer and Export Compliance 7067754Smsmith * provision in the documentation and/or other materials provided with the 7167754Smsmith * distribution. 7267754Smsmith * 7367754Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7467754Smsmith * Intel Code. 7567754Smsmith * 7667754Smsmith * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7767754Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 7867754Smsmith * other dealings in products derived from or relating to the Covered Code 7967754Smsmith * without prior written authorization from Intel. 8067754Smsmith * 8167754Smsmith * 4. Disclaimer and Export Compliance 8267754Smsmith * 8367754Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8467754Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8567754Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8667754Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8767754Smsmith * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8867754Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8967754Smsmith * PARTICULAR PURPOSE. 9067754Smsmith * 9167754Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9267754Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9367754Smsmith * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9467754Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9567754Smsmith * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9667754Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9767754Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9867754Smsmith * LIMITED REMEDY. 9967754Smsmith * 10067754Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10167754Smsmith * software or system incorporating such software without first obtaining any 10267754Smsmith * required license or other approval from the U. S. Department of Commerce or 10367754Smsmith * any other agency or department of the United States Government. In the 10467754Smsmith * event Licensee exports any such software from the United States or 10567754Smsmith * re-exports any such software from a foreign destination, Licensee shall 10667754Smsmith * ensure that the distribution and export/re-export of the software is in 10767754Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10867754Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10967754Smsmith * any of its subsidiaries will export/re-export any technical data, process, 11067754Smsmith * software, or service, directly or indirectly, to any country for which the 11167754Smsmith * United States government or any agency thereof requires an export license, 11267754Smsmith * other governmental approval, or letter of assurance, without first obtaining 11367754Smsmith * such license, approval or letter. 11467754Smsmith * 11567754Smsmith *****************************************************************************/ 11667754Smsmith 11767754Smsmith 11867754Smsmith#ifndef __ACXFACE_H__ 11967754Smsmith#define __ACXFACE_H__ 12067754Smsmith 12167754Smsmith#include "actypes.h" 12267754Smsmith#include "actbl.h" 12367754Smsmith 12477424Smsmith 12580062Smsmith /* 12667754Smsmith * Global interfaces 12767754Smsmith */ 12867754Smsmith 12967754SmsmithACPI_STATUS 13067754SmsmithAcpiInitializeSubsystem ( 13167754Smsmith void); 13267754Smsmith 13367754SmsmithACPI_STATUS 13467754SmsmithAcpiEnableSubsystem ( 13567754Smsmith UINT32 Flags); 13667754Smsmith 13767754SmsmithACPI_STATUS 13867754SmsmithAcpiTerminate ( 13967754Smsmith void); 14067754Smsmith 14167754SmsmithACPI_STATUS 14280062SmsmithAcpiSubsystemStatus ( 14380062Smsmith void); 14480062Smsmith 14580062SmsmithACPI_STATUS 14667754SmsmithAcpiEnable ( 14767754Smsmith void); 14867754Smsmith 14967754SmsmithACPI_STATUS 15067754SmsmithAcpiDisable ( 15167754Smsmith void); 15267754Smsmith 15367754SmsmithACPI_STATUS 15480062SmsmithAcpiGetSystemInfo ( 15567754Smsmith ACPI_BUFFER *RetBuffer); 15667754Smsmith 15780062Smsmithconst char * 15867754SmsmithAcpiFormatException ( 15980062Smsmith ACPI_STATUS Exception); 16067754Smsmith 16187031SmsmithACPI_STATUS 16287031SmsmithAcpiPurgeCachedObjects ( 16387031Smsmith void); 16467754Smsmith 16587031Smsmith 16667754Smsmith/* 16777424Smsmith * ACPI Memory manager 16877424Smsmith */ 16977424Smsmith 17077424Smsmithvoid * 17177424SmsmithAcpiAllocate ( 17277424Smsmith UINT32 Size); 17377424Smsmith 17477424Smsmithvoid * 17577424SmsmithAcpiCallocate ( 17677424Smsmith UINT32 Size); 17777424Smsmith 17877424Smsmithvoid 17977424SmsmithAcpiFree ( 18077424Smsmith void *Address); 18177424Smsmith 18277424Smsmith 18377424Smsmith/* 18467754Smsmith * ACPI table manipulation interfaces 18567754Smsmith */ 18667754Smsmith 18767754SmsmithACPI_STATUS 18867754SmsmithAcpiFindRootPointer ( 18980062Smsmith UINT32 Flags, 19069450Smsmith ACPI_PHYSICAL_ADDRESS *RsdpPhysicalAddress); 19167754Smsmith 19267754SmsmithACPI_STATUS 19367754SmsmithAcpiLoadTables ( 19480062Smsmith void); 19567754Smsmith 19667754SmsmithACPI_STATUS 19767754SmsmithAcpiLoadTable ( 19867754Smsmith ACPI_TABLE_HEADER *TablePtr); 19967754Smsmith 20067754SmsmithACPI_STATUS 20167754SmsmithAcpiUnloadTable ( 20267754Smsmith ACPI_TABLE_TYPE TableType); 20367754Smsmith 20467754SmsmithACPI_STATUS 20567754SmsmithAcpiGetTableHeader ( 20667754Smsmith ACPI_TABLE_TYPE TableType, 20767754Smsmith UINT32 Instance, 20867754Smsmith ACPI_TABLE_HEADER *OutTableHeader); 20967754Smsmith 21067754SmsmithACPI_STATUS 21167754SmsmithAcpiGetTable ( 21267754Smsmith ACPI_TABLE_TYPE TableType, 21367754Smsmith UINT32 Instance, 21467754Smsmith ACPI_BUFFER *RetBuffer); 21567754Smsmith 21678986SmsmithACPI_STATUS 21778986SmsmithAcpiGetFirmwareTable ( 21878986Smsmith ACPI_STRING Signature, 21978986Smsmith UINT32 Instance, 22078986Smsmith UINT32 Flags, 22178986Smsmith ACPI_TABLE_HEADER **TablePointer); 22267754Smsmith 22378986Smsmith 22467754Smsmith/* 22567754Smsmith * Namespace and name interfaces 22667754Smsmith */ 22767754Smsmith 22867754SmsmithACPI_STATUS 22967754SmsmithAcpiWalkNamespace ( 23067754Smsmith ACPI_OBJECT_TYPE Type, 23167754Smsmith ACPI_HANDLE StartObject, 23267754Smsmith UINT32 MaxDepth, 23377424Smsmith ACPI_WALK_CALLBACK UserFunction, 23467754Smsmith void *Context, 23567754Smsmith void * *ReturnValue); 23667754Smsmith 23767754SmsmithACPI_STATUS 23867754SmsmithAcpiGetDevices ( 23967754Smsmith NATIVE_CHAR *HID, 24077424Smsmith ACPI_WALK_CALLBACK UserFunction, 24167754Smsmith void *Context, 24267754Smsmith void **ReturnValue); 24367754Smsmith 24467754SmsmithACPI_STATUS 24567754SmsmithAcpiGetName ( 24667754Smsmith ACPI_HANDLE Handle, 24767754Smsmith UINT32 NameType, 24867754Smsmith ACPI_BUFFER *RetPathPtr); 24967754Smsmith 25067754SmsmithACPI_STATUS 25167754SmsmithAcpiGetHandle ( 25267754Smsmith ACPI_HANDLE Parent, 25367754Smsmith ACPI_STRING Pathname, 25467754Smsmith ACPI_HANDLE *RetHandle); 25567754Smsmith 25687031SmsmithACPI_STATUS 25787031SmsmithAcpiAttachData ( 25887031Smsmith ACPI_HANDLE ObjHandle, 25987031Smsmith ACPI_OBJECT_HANDLER Handler, 26087031Smsmith void *Data); 26167754Smsmith 26287031SmsmithACPI_STATUS 26387031SmsmithAcpiDetachData ( 26487031Smsmith ACPI_HANDLE ObjHandle, 26587031Smsmith ACPI_OBJECT_HANDLER Handler); 26687031Smsmith 26787031SmsmithACPI_STATUS 26887031SmsmithAcpiGetData ( 26987031Smsmith ACPI_HANDLE ObjHandle, 27087031Smsmith ACPI_OBJECT_HANDLER Handler, 27187031Smsmith void **Data); 27287031Smsmith 27387031Smsmith 27467754Smsmith/* 27567754Smsmith * Object manipulation and enumeration 27667754Smsmith */ 27767754Smsmith 27867754SmsmithACPI_STATUS 27967754SmsmithAcpiEvaluateObject ( 28067754Smsmith ACPI_HANDLE Object, 28167754Smsmith ACPI_STRING Pathname, 28267754Smsmith ACPI_OBJECT_LIST *ParameterObjects, 28367754Smsmith ACPI_BUFFER *ReturnObjectBuffer); 28467754Smsmith 28567754SmsmithACPI_STATUS 28667754SmsmithAcpiGetObjectInfo ( 28767754Smsmith ACPI_HANDLE Device, 28867754Smsmith ACPI_DEVICE_INFO *Info); 28967754Smsmith 29067754SmsmithACPI_STATUS 29167754SmsmithAcpiGetNextObject ( 29267754Smsmith ACPI_OBJECT_TYPE Type, 29367754Smsmith ACPI_HANDLE Parent, 29467754Smsmith ACPI_HANDLE Child, 29567754Smsmith ACPI_HANDLE *OutHandle); 29667754Smsmith 29767754SmsmithACPI_STATUS 29867754SmsmithAcpiGetType ( 29967754Smsmith ACPI_HANDLE Object, 30067754Smsmith ACPI_OBJECT_TYPE *OutType); 30167754Smsmith 30267754SmsmithACPI_STATUS 30367754SmsmithAcpiGetParent ( 30467754Smsmith ACPI_HANDLE Object, 30567754Smsmith ACPI_HANDLE *OutHandle); 30667754Smsmith 30767754Smsmith 30867754Smsmith/* 30977424Smsmith * Event handler interfaces 31067754Smsmith */ 31167754Smsmith 31267754SmsmithACPI_STATUS 31367754SmsmithAcpiInstallFixedEventHandler ( 31467754Smsmith UINT32 AcpiEvent, 31577424Smsmith ACPI_EVENT_HANDLER Handler, 31667754Smsmith void *Context); 31767754Smsmith 31867754SmsmithACPI_STATUS 31967754SmsmithAcpiRemoveFixedEventHandler ( 32067754Smsmith UINT32 AcpiEvent, 32177424Smsmith ACPI_EVENT_HANDLER Handler); 32267754Smsmith 32367754SmsmithACPI_STATUS 32467754SmsmithAcpiInstallNotifyHandler ( 32567754Smsmith ACPI_HANDLE Device, 32667754Smsmith UINT32 HandlerType, 32777424Smsmith ACPI_NOTIFY_HANDLER Handler, 32867754Smsmith void *Context); 32967754Smsmith 33067754SmsmithACPI_STATUS 33167754SmsmithAcpiRemoveNotifyHandler ( 33267754Smsmith ACPI_HANDLE Device, 33367754Smsmith UINT32 HandlerType, 33477424Smsmith ACPI_NOTIFY_HANDLER Handler); 33567754Smsmith 33667754SmsmithACPI_STATUS 33767754SmsmithAcpiInstallAddressSpaceHandler ( 33867754Smsmith ACPI_HANDLE Device, 33977424Smsmith ACPI_ADR_SPACE_TYPE SpaceId, 34077424Smsmith ACPI_ADR_SPACE_HANDLER Handler, 34177424Smsmith ACPI_ADR_SPACE_SETUP Setup, 34267754Smsmith void *Context); 34367754Smsmith 34467754SmsmithACPI_STATUS 34567754SmsmithAcpiRemoveAddressSpaceHandler ( 34667754Smsmith ACPI_HANDLE Device, 34777424Smsmith ACPI_ADR_SPACE_TYPE SpaceId, 34877424Smsmith ACPI_ADR_SPACE_HANDLER Handler); 34967754Smsmith 35067754SmsmithACPI_STATUS 35167754SmsmithAcpiInstallGpeHandler ( 35267754Smsmith UINT32 GpeNumber, 35367754Smsmith UINT32 Type, 35477424Smsmith ACPI_GPE_HANDLER Handler, 35567754Smsmith void *Context); 35667754Smsmith 35767754SmsmithACPI_STATUS 35867754SmsmithAcpiAcquireGlobalLock ( 35991116Smsmith UINT32 Timeout, 36091116Smsmith UINT32 *Handle); 36167754Smsmith 36267754SmsmithACPI_STATUS 36367754SmsmithAcpiReleaseGlobalLock ( 36491116Smsmith UINT32 Handle); 36567754Smsmith 36667754SmsmithACPI_STATUS 36767754SmsmithAcpiRemoveGpeHandler ( 36867754Smsmith UINT32 GpeNumber, 36977424Smsmith ACPI_GPE_HANDLER Handler); 37067754Smsmith 37167754SmsmithACPI_STATUS 37267754SmsmithAcpiEnableEvent ( 37367754Smsmith UINT32 AcpiEvent, 37484491Smsmith UINT32 Type, 37584491Smsmith UINT32 Flags); 37667754Smsmith 37767754SmsmithACPI_STATUS 37867754SmsmithAcpiDisableEvent ( 37967754Smsmith UINT32 AcpiEvent, 38084491Smsmith UINT32 Type, 38184491Smsmith UINT32 Flags); 38267754Smsmith 38367754SmsmithACPI_STATUS 38467754SmsmithAcpiClearEvent ( 38567754Smsmith UINT32 AcpiEvent, 38667754Smsmith UINT32 Type); 38767754Smsmith 38867754SmsmithACPI_STATUS 38967754SmsmithAcpiGetEventStatus ( 39067754Smsmith UINT32 AcpiEvent, 39167754Smsmith UINT32 Type, 39267754Smsmith ACPI_EVENT_STATUS *EventStatus); 39367754Smsmith 39467754Smsmith/* 39567754Smsmith * Resource interfaces 39667754Smsmith */ 39767754Smsmith 39867754SmsmithACPI_STATUS 39967754SmsmithAcpiGetCurrentResources( 40067754Smsmith ACPI_HANDLE DeviceHandle, 40167754Smsmith ACPI_BUFFER *RetBuffer); 40267754Smsmith 40367754SmsmithACPI_STATUS 40467754SmsmithAcpiGetPossibleResources( 40567754Smsmith ACPI_HANDLE DeviceHandle, 40667754Smsmith ACPI_BUFFER *RetBuffer); 40767754Smsmith 40867754SmsmithACPI_STATUS 40967754SmsmithAcpiSetCurrentResources ( 41067754Smsmith ACPI_HANDLE DeviceHandle, 41167754Smsmith ACPI_BUFFER *InBuffer); 41267754Smsmith 41367754SmsmithACPI_STATUS 41467754SmsmithAcpiGetIrqRoutingTable ( 41567754Smsmith ACPI_HANDLE BusDeviceHandle, 41667754Smsmith ACPI_BUFFER *RetBuffer); 41767754Smsmith 41867754Smsmith 41967754Smsmith/* 42067754Smsmith * Hardware (ACPI device) interfaces 42167754Smsmith */ 42267754Smsmith 42367754SmsmithACPI_STATUS 42467754SmsmithAcpiSetFirmwareWakingVector ( 42569450Smsmith ACPI_PHYSICAL_ADDRESS PhysicalAddress); 42667754Smsmith 42767754SmsmithACPI_STATUS 42867754SmsmithAcpiGetFirmwareWakingVector ( 42969450Smsmith ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 43067754Smsmith 43187031Smsmith 43267754SmsmithACPI_STATUS 43387031SmsmithAcpiEnterSleepStatePrep ( 43487031Smsmith UINT8 SleepState); 43587031Smsmith 43687031SmsmithACPI_STATUS 43771867SmsmithAcpiEnterSleepState ( 43871867Smsmith UINT8 SleepState); 43971867Smsmith 44071867SmsmithACPI_STATUS 44182367SmsmithAcpiLeaveSleepState ( 44282367Smsmith UINT8 SleepState); 44367754Smsmith 44467754Smsmith#endif /* __ACXFACE_H__ */ 445