acpixf.h revision 114237
167754Smsmith 267754Smsmith/****************************************************************************** 367754Smsmith * 470243Smsmith * Name: acpixf.h - External interfaces to the ACPI subsystem 567754Smsmith * 667754Smsmith *****************************************************************************/ 767754Smsmith 867754Smsmith/****************************************************************************** 967754Smsmith * 1067754Smsmith * 1. Copyright Notice 1167754Smsmith * 12114237Snjl * Some or all of this work - Copyright (c) 1999 - 2003, 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 138100966SiwasakiAcpiInitializeObjects ( 139100966Siwasaki UINT32 Flags); 140100966Siwasaki 141100966SiwasakiACPI_STATUS 14267754SmsmithAcpiTerminate ( 14367754Smsmith void); 14467754Smsmith 14567754SmsmithACPI_STATUS 14680062SmsmithAcpiSubsystemStatus ( 14780062Smsmith void); 14880062Smsmith 14980062SmsmithACPI_STATUS 15067754SmsmithAcpiEnable ( 15167754Smsmith void); 15267754Smsmith 15367754SmsmithACPI_STATUS 15467754SmsmithAcpiDisable ( 15567754Smsmith void); 15667754Smsmith 15767754SmsmithACPI_STATUS 15880062SmsmithAcpiGetSystemInfo ( 15967754Smsmith ACPI_BUFFER *RetBuffer); 16067754Smsmith 16180062Smsmithconst char * 16267754SmsmithAcpiFormatException ( 16380062Smsmith ACPI_STATUS Exception); 16467754Smsmith 16587031SmsmithACPI_STATUS 16687031SmsmithAcpiPurgeCachedObjects ( 16787031Smsmith void); 16867754Smsmith 16999679SiwasakiACPI_STATUS 17099679SiwasakiAcpiInstallInitializationHandler ( 17199679Siwasaki ACPI_INIT_HANDLER Handler, 17299679Siwasaki UINT32 Function); 17387031Smsmith 17467754Smsmith/* 17577424Smsmith * ACPI Memory manager 17677424Smsmith */ 17777424Smsmith 17877424Smsmithvoid * 17977424SmsmithAcpiAllocate ( 18077424Smsmith UINT32 Size); 18177424Smsmith 18277424Smsmithvoid * 18377424SmsmithAcpiCallocate ( 18477424Smsmith UINT32 Size); 18577424Smsmith 18677424Smsmithvoid 18777424SmsmithAcpiFree ( 18877424Smsmith void *Address); 18977424Smsmith 19077424Smsmith 19177424Smsmith/* 19267754Smsmith * ACPI table manipulation interfaces 19367754Smsmith */ 19467754Smsmith 19567754SmsmithACPI_STATUS 19667754SmsmithAcpiFindRootPointer ( 19780062Smsmith UINT32 Flags, 19899146Siwasaki ACPI_POINTER *RsdpAddress); 19967754Smsmith 20067754SmsmithACPI_STATUS 20167754SmsmithAcpiLoadTables ( 20280062Smsmith void); 20367754Smsmith 20467754SmsmithACPI_STATUS 20567754SmsmithAcpiLoadTable ( 20667754Smsmith ACPI_TABLE_HEADER *TablePtr); 20767754Smsmith 20867754SmsmithACPI_STATUS 20967754SmsmithAcpiUnloadTable ( 21067754Smsmith ACPI_TABLE_TYPE TableType); 21167754Smsmith 21267754SmsmithACPI_STATUS 21367754SmsmithAcpiGetTableHeader ( 21467754Smsmith ACPI_TABLE_TYPE TableType, 21567754Smsmith UINT32 Instance, 21667754Smsmith ACPI_TABLE_HEADER *OutTableHeader); 21767754Smsmith 21867754SmsmithACPI_STATUS 21967754SmsmithAcpiGetTable ( 22067754Smsmith ACPI_TABLE_TYPE TableType, 22167754Smsmith UINT32 Instance, 22267754Smsmith ACPI_BUFFER *RetBuffer); 22367754Smsmith 22478986SmsmithACPI_STATUS 22578986SmsmithAcpiGetFirmwareTable ( 22678986Smsmith ACPI_STRING Signature, 22778986Smsmith UINT32 Instance, 22878986Smsmith UINT32 Flags, 22978986Smsmith ACPI_TABLE_HEADER **TablePointer); 23067754Smsmith 23178986Smsmith 23267754Smsmith/* 23367754Smsmith * Namespace and name interfaces 23467754Smsmith */ 23567754Smsmith 23667754SmsmithACPI_STATUS 23767754SmsmithAcpiWalkNamespace ( 23867754Smsmith ACPI_OBJECT_TYPE Type, 23967754Smsmith ACPI_HANDLE StartObject, 24067754Smsmith UINT32 MaxDepth, 24177424Smsmith ACPI_WALK_CALLBACK UserFunction, 24267754Smsmith void *Context, 243114237Snjl void **ReturnValue); 24467754Smsmith 24567754SmsmithACPI_STATUS 24667754SmsmithAcpiGetDevices ( 247114237Snjl char *HID, 24877424Smsmith ACPI_WALK_CALLBACK UserFunction, 24967754Smsmith void *Context, 25067754Smsmith void **ReturnValue); 25167754Smsmith 25267754SmsmithACPI_STATUS 25367754SmsmithAcpiGetName ( 25467754Smsmith ACPI_HANDLE Handle, 25567754Smsmith UINT32 NameType, 25667754Smsmith ACPI_BUFFER *RetPathPtr); 25767754Smsmith 25867754SmsmithACPI_STATUS 25967754SmsmithAcpiGetHandle ( 26067754Smsmith ACPI_HANDLE Parent, 26167754Smsmith ACPI_STRING Pathname, 26267754Smsmith ACPI_HANDLE *RetHandle); 26367754Smsmith 26487031SmsmithACPI_STATUS 26587031SmsmithAcpiAttachData ( 26687031Smsmith ACPI_HANDLE ObjHandle, 26787031Smsmith ACPI_OBJECT_HANDLER Handler, 26887031Smsmith void *Data); 26967754Smsmith 27087031SmsmithACPI_STATUS 27187031SmsmithAcpiDetachData ( 27287031Smsmith ACPI_HANDLE ObjHandle, 27387031Smsmith ACPI_OBJECT_HANDLER Handler); 27487031Smsmith 27587031SmsmithACPI_STATUS 27687031SmsmithAcpiGetData ( 27787031Smsmith ACPI_HANDLE ObjHandle, 27887031Smsmith ACPI_OBJECT_HANDLER Handler, 27987031Smsmith void **Data); 28087031Smsmith 28187031Smsmith 28267754Smsmith/* 28367754Smsmith * Object manipulation and enumeration 28467754Smsmith */ 28567754Smsmith 28667754SmsmithACPI_STATUS 28767754SmsmithAcpiEvaluateObject ( 28867754Smsmith ACPI_HANDLE Object, 28967754Smsmith ACPI_STRING Pathname, 29067754Smsmith ACPI_OBJECT_LIST *ParameterObjects, 29167754Smsmith ACPI_BUFFER *ReturnObjectBuffer); 29267754Smsmith 29367754SmsmithACPI_STATUS 29499679SiwasakiAcpiEvaluateObjectTyped ( 29599679Siwasaki ACPI_HANDLE Object, 29699679Siwasaki ACPI_STRING Pathname, 29799679Siwasaki ACPI_OBJECT_LIST *ExternalParams, 29899679Siwasaki ACPI_BUFFER *ReturnBuffer, 29999679Siwasaki ACPI_OBJECT_TYPE ReturnType); 30099679Siwasaki 30199679SiwasakiACPI_STATUS 30267754SmsmithAcpiGetObjectInfo ( 30367754Smsmith ACPI_HANDLE Device, 30467754Smsmith ACPI_DEVICE_INFO *Info); 30567754Smsmith 30667754SmsmithACPI_STATUS 30767754SmsmithAcpiGetNextObject ( 30867754Smsmith ACPI_OBJECT_TYPE Type, 30967754Smsmith ACPI_HANDLE Parent, 31067754Smsmith ACPI_HANDLE Child, 31167754Smsmith ACPI_HANDLE *OutHandle); 31267754Smsmith 31367754SmsmithACPI_STATUS 31467754SmsmithAcpiGetType ( 31567754Smsmith ACPI_HANDLE Object, 31667754Smsmith ACPI_OBJECT_TYPE *OutType); 31767754Smsmith 31867754SmsmithACPI_STATUS 31967754SmsmithAcpiGetParent ( 32067754Smsmith ACPI_HANDLE Object, 32167754Smsmith ACPI_HANDLE *OutHandle); 32267754Smsmith 32367754Smsmith 32467754Smsmith/* 32577424Smsmith * Event handler interfaces 32667754Smsmith */ 32767754Smsmith 32867754SmsmithACPI_STATUS 32967754SmsmithAcpiInstallFixedEventHandler ( 33067754Smsmith UINT32 AcpiEvent, 33177424Smsmith ACPI_EVENT_HANDLER Handler, 33267754Smsmith void *Context); 33367754Smsmith 33467754SmsmithACPI_STATUS 33567754SmsmithAcpiRemoveFixedEventHandler ( 33667754Smsmith UINT32 AcpiEvent, 33777424Smsmith ACPI_EVENT_HANDLER Handler); 33867754Smsmith 33967754SmsmithACPI_STATUS 34067754SmsmithAcpiInstallNotifyHandler ( 34167754Smsmith ACPI_HANDLE Device, 34267754Smsmith UINT32 HandlerType, 34377424Smsmith ACPI_NOTIFY_HANDLER Handler, 34467754Smsmith void *Context); 34567754Smsmith 34667754SmsmithACPI_STATUS 34767754SmsmithAcpiRemoveNotifyHandler ( 34867754Smsmith ACPI_HANDLE Device, 34967754Smsmith UINT32 HandlerType, 35077424Smsmith ACPI_NOTIFY_HANDLER Handler); 35167754Smsmith 35267754SmsmithACPI_STATUS 35367754SmsmithAcpiInstallAddressSpaceHandler ( 35467754Smsmith ACPI_HANDLE Device, 35577424Smsmith ACPI_ADR_SPACE_TYPE SpaceId, 35677424Smsmith ACPI_ADR_SPACE_HANDLER Handler, 35777424Smsmith ACPI_ADR_SPACE_SETUP Setup, 35867754Smsmith void *Context); 35967754Smsmith 36067754SmsmithACPI_STATUS 36167754SmsmithAcpiRemoveAddressSpaceHandler ( 36267754Smsmith ACPI_HANDLE Device, 36377424Smsmith ACPI_ADR_SPACE_TYPE SpaceId, 36477424Smsmith ACPI_ADR_SPACE_HANDLER Handler); 36567754Smsmith 36667754SmsmithACPI_STATUS 36767754SmsmithAcpiInstallGpeHandler ( 36867754Smsmith UINT32 GpeNumber, 36967754Smsmith UINT32 Type, 37077424Smsmith ACPI_GPE_HANDLER Handler, 37167754Smsmith void *Context); 37267754Smsmith 37367754SmsmithACPI_STATUS 37467754SmsmithAcpiAcquireGlobalLock ( 375107325Siwasaki UINT16 Timeout, 37691116Smsmith UINT32 *Handle); 37767754Smsmith 37867754SmsmithACPI_STATUS 37967754SmsmithAcpiReleaseGlobalLock ( 38091116Smsmith UINT32 Handle); 38167754Smsmith 38267754SmsmithACPI_STATUS 38367754SmsmithAcpiRemoveGpeHandler ( 38467754Smsmith UINT32 GpeNumber, 38577424Smsmith ACPI_GPE_HANDLER Handler); 38667754Smsmith 38767754SmsmithACPI_STATUS 38867754SmsmithAcpiEnableEvent ( 38967754Smsmith UINT32 AcpiEvent, 39084491Smsmith UINT32 Type, 39184491Smsmith UINT32 Flags); 39267754Smsmith 39367754SmsmithACPI_STATUS 39467754SmsmithAcpiDisableEvent ( 39567754Smsmith UINT32 AcpiEvent, 39684491Smsmith UINT32 Type, 39784491Smsmith UINT32 Flags); 39867754Smsmith 39967754SmsmithACPI_STATUS 40067754SmsmithAcpiClearEvent ( 40167754Smsmith UINT32 AcpiEvent, 40267754Smsmith UINT32 Type); 40367754Smsmith 40467754SmsmithACPI_STATUS 40567754SmsmithAcpiGetEventStatus ( 40667754Smsmith UINT32 AcpiEvent, 40767754Smsmith UINT32 Type, 40867754Smsmith ACPI_EVENT_STATUS *EventStatus); 40967754Smsmith 41067754Smsmith/* 41167754Smsmith * Resource interfaces 41267754Smsmith */ 41367754Smsmith 414114237Snjltypedef 415114237SnjlACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) ( 416114237Snjl ACPI_RESOURCE *Resource, 417114237Snjl void *Context); 418114237Snjl 419114237Snjl 42067754SmsmithACPI_STATUS 42167754SmsmithAcpiGetCurrentResources( 42267754Smsmith ACPI_HANDLE DeviceHandle, 42367754Smsmith ACPI_BUFFER *RetBuffer); 42467754Smsmith 42567754SmsmithACPI_STATUS 42667754SmsmithAcpiGetPossibleResources( 42767754Smsmith ACPI_HANDLE DeviceHandle, 42867754Smsmith ACPI_BUFFER *RetBuffer); 42967754Smsmith 43067754SmsmithACPI_STATUS 431114237SnjlAcpiWalkResources ( 432114237Snjl ACPI_HANDLE DeviceHandle, 433114237Snjl char *Path, 434114237Snjl ACPI_WALK_RESOURCE_CALLBACK UserFunction, 435114237Snjl void *Context); 436114237Snjl 437114237SnjlACPI_STATUS 43867754SmsmithAcpiSetCurrentResources ( 43967754Smsmith ACPI_HANDLE DeviceHandle, 44067754Smsmith ACPI_BUFFER *InBuffer); 44167754Smsmith 44267754SmsmithACPI_STATUS 44367754SmsmithAcpiGetIrqRoutingTable ( 44467754Smsmith ACPI_HANDLE BusDeviceHandle, 44567754Smsmith ACPI_BUFFER *RetBuffer); 44667754Smsmith 447114237SnjlACPI_STATUS 448114237SnjlAcpiResourceToAddress64 ( 449114237Snjl ACPI_RESOURCE *Resource, 450114237Snjl ACPI_RESOURCE_ADDRESS64 *Out); 45167754Smsmith 45267754Smsmith/* 45367754Smsmith * Hardware (ACPI device) interfaces 45467754Smsmith */ 45567754Smsmith 45667754SmsmithACPI_STATUS 45799679SiwasakiAcpiGetRegister ( 45899679Siwasaki UINT32 RegisterId, 45999679Siwasaki UINT32 *ReturnValue, 46099679Siwasaki UINT32 Flags); 46199679Siwasaki 46299679SiwasakiACPI_STATUS 46399679SiwasakiAcpiSetRegister ( 46499679Siwasaki UINT32 RegisterId, 46599679Siwasaki UINT32 Value, 46699679Siwasaki UINT32 Flags); 46799679Siwasaki 46899679SiwasakiACPI_STATUS 46967754SmsmithAcpiSetFirmwareWakingVector ( 47069450Smsmith ACPI_PHYSICAL_ADDRESS PhysicalAddress); 47167754Smsmith 47267754SmsmithACPI_STATUS 47367754SmsmithAcpiGetFirmwareWakingVector ( 47469450Smsmith ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 47567754Smsmith 47699679SiwasakiACPI_STATUS 47799679SiwasakiAcpiGetSleepTypeData ( 47899679Siwasaki UINT8 SleepState, 47999679Siwasaki UINT8 *Slp_TypA, 48099679Siwasaki UINT8 *Slp_TypB); 48187031Smsmith 48267754SmsmithACPI_STATUS 48387031SmsmithAcpiEnterSleepStatePrep ( 48499679Siwasaki UINT8 SleepState); 48587031Smsmith 48687031SmsmithACPI_STATUS 48771867SmsmithAcpiEnterSleepState ( 48899679Siwasaki UINT8 SleepState); 48971867Smsmith 49071867SmsmithACPI_STATUS 491114237SnjlAcpiEnterSleepStateS4bios ( 492114237Snjl void); 493114237Snjl 494114237SnjlACPI_STATUS 49582367SmsmithAcpiLeaveSleepState ( 49699679Siwasaki UINT8 SleepState); 49767754Smsmith 49899679Siwasaki 49967754Smsmith#endif /* __ACXFACE_H__ */ 500