acpixf.h revision 77424
167754Smsmith 267754Smsmith/****************************************************************************** 367754Smsmith * 470243Smsmith * Name: acpixf.h - External interfaces to the ACPI subsystem 567754Smsmith * 667754Smsmith *****************************************************************************/ 767754Smsmith 867754Smsmith/****************************************************************************** 967754Smsmith * 1067754Smsmith * 1. Copyright Notice 1167754Smsmith * 1271867Smsmith * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 12567754Smsmith/* 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 14267754SmsmithAcpiEnable ( 14367754Smsmith void); 14467754Smsmith 14567754SmsmithACPI_STATUS 14667754SmsmithAcpiDisable ( 14767754Smsmith void); 14867754Smsmith 14967754SmsmithACPI_STATUS 15067754SmsmithAcpiGetSystemInfo( 15167754Smsmith ACPI_BUFFER *RetBuffer); 15267754Smsmith 15367754SmsmithACPI_STATUS 15467754SmsmithAcpiFormatException ( 15567754Smsmith ACPI_STATUS Exception, 15667754Smsmith ACPI_BUFFER *OutBuffer); 15767754Smsmith 15867754Smsmith 15967754Smsmith/* 16077424Smsmith * ACPI Memory manager 16177424Smsmith */ 16277424Smsmith 16377424Smsmithvoid * 16477424SmsmithAcpiAllocate ( 16577424Smsmith UINT32 Size); 16677424Smsmith 16777424Smsmithvoid * 16877424SmsmithAcpiCallocate ( 16977424Smsmith UINT32 Size); 17077424Smsmith 17177424Smsmithvoid 17277424SmsmithAcpiFree ( 17377424Smsmith void *Address); 17477424Smsmith 17577424Smsmith 17677424Smsmith/* 17767754Smsmith * ACPI table manipulation interfaces 17867754Smsmith */ 17967754Smsmith 18067754SmsmithACPI_STATUS 18167754SmsmithAcpiFindRootPointer ( 18269450Smsmith ACPI_PHYSICAL_ADDRESS *RsdpPhysicalAddress); 18367754Smsmith 18467754SmsmithACPI_STATUS 18567754SmsmithAcpiLoadTables ( 18669450Smsmith ACPI_PHYSICAL_ADDRESS RsdpPhysicalAddress); 18767754Smsmith 18867754SmsmithACPI_STATUS 18967754SmsmithAcpiLoadTable ( 19067754Smsmith ACPI_TABLE_HEADER *TablePtr); 19167754Smsmith 19267754SmsmithACPI_STATUS 19367754SmsmithAcpiUnloadTable ( 19467754Smsmith ACPI_TABLE_TYPE TableType); 19567754Smsmith 19667754SmsmithACPI_STATUS 19767754SmsmithAcpiGetTableHeader ( 19867754Smsmith ACPI_TABLE_TYPE TableType, 19967754Smsmith UINT32 Instance, 20067754Smsmith ACPI_TABLE_HEADER *OutTableHeader); 20167754Smsmith 20267754SmsmithACPI_STATUS 20367754SmsmithAcpiGetTable ( 20467754Smsmith ACPI_TABLE_TYPE TableType, 20567754Smsmith UINT32 Instance, 20667754Smsmith ACPI_BUFFER *RetBuffer); 20767754Smsmith 20867754Smsmith 20967754Smsmith/* 21067754Smsmith * Namespace and name interfaces 21167754Smsmith */ 21267754Smsmith 21367754SmsmithACPI_STATUS 21467754SmsmithAcpiWalkNamespace ( 21567754Smsmith ACPI_OBJECT_TYPE Type, 21667754Smsmith ACPI_HANDLE StartObject, 21767754Smsmith UINT32 MaxDepth, 21877424Smsmith ACPI_WALK_CALLBACK UserFunction, 21967754Smsmith void *Context, 22067754Smsmith void * *ReturnValue); 22167754Smsmith 22267754SmsmithACPI_STATUS 22367754SmsmithAcpiGetDevices ( 22467754Smsmith NATIVE_CHAR *HID, 22577424Smsmith ACPI_WALK_CALLBACK UserFunction, 22667754Smsmith void *Context, 22767754Smsmith void **ReturnValue); 22867754Smsmith 22967754SmsmithACPI_STATUS 23067754SmsmithAcpiGetName ( 23167754Smsmith ACPI_HANDLE Handle, 23267754Smsmith UINT32 NameType, 23367754Smsmith ACPI_BUFFER *RetPathPtr); 23467754Smsmith 23567754SmsmithACPI_STATUS 23667754SmsmithAcpiGetHandle ( 23767754Smsmith ACPI_HANDLE Parent, 23867754Smsmith ACPI_STRING Pathname, 23967754Smsmith ACPI_HANDLE *RetHandle); 24067754Smsmith 24167754Smsmith 24267754Smsmith/* 24367754Smsmith * Object manipulation and enumeration 24467754Smsmith */ 24567754Smsmith 24667754SmsmithACPI_STATUS 24767754SmsmithAcpiEvaluateObject ( 24867754Smsmith ACPI_HANDLE Object, 24967754Smsmith ACPI_STRING Pathname, 25067754Smsmith ACPI_OBJECT_LIST *ParameterObjects, 25167754Smsmith ACPI_BUFFER *ReturnObjectBuffer); 25267754Smsmith 25367754SmsmithACPI_STATUS 25467754SmsmithAcpiGetObjectInfo ( 25567754Smsmith ACPI_HANDLE Device, 25667754Smsmith ACPI_DEVICE_INFO *Info); 25767754Smsmith 25867754SmsmithACPI_STATUS 25967754SmsmithAcpiGetNextObject ( 26067754Smsmith ACPI_OBJECT_TYPE Type, 26167754Smsmith ACPI_HANDLE Parent, 26267754Smsmith ACPI_HANDLE Child, 26367754Smsmith ACPI_HANDLE *OutHandle); 26467754Smsmith 26567754SmsmithACPI_STATUS 26667754SmsmithAcpiGetType ( 26767754Smsmith ACPI_HANDLE Object, 26867754Smsmith ACPI_OBJECT_TYPE *OutType); 26967754Smsmith 27067754SmsmithACPI_STATUS 27167754SmsmithAcpiGetParent ( 27267754Smsmith ACPI_HANDLE Object, 27367754Smsmith ACPI_HANDLE *OutHandle); 27467754Smsmith 27567754Smsmith 27667754Smsmith/* 27777424Smsmith * Event handler interfaces 27867754Smsmith */ 27967754Smsmith 28067754SmsmithACPI_STATUS 28167754SmsmithAcpiInstallFixedEventHandler ( 28267754Smsmith UINT32 AcpiEvent, 28377424Smsmith ACPI_EVENT_HANDLER Handler, 28467754Smsmith void *Context); 28567754Smsmith 28667754SmsmithACPI_STATUS 28767754SmsmithAcpiRemoveFixedEventHandler ( 28867754Smsmith UINT32 AcpiEvent, 28977424Smsmith ACPI_EVENT_HANDLER Handler); 29067754Smsmith 29167754SmsmithACPI_STATUS 29267754SmsmithAcpiInstallNotifyHandler ( 29367754Smsmith ACPI_HANDLE Device, 29467754Smsmith UINT32 HandlerType, 29577424Smsmith ACPI_NOTIFY_HANDLER Handler, 29667754Smsmith void *Context); 29767754Smsmith 29867754SmsmithACPI_STATUS 29967754SmsmithAcpiRemoveNotifyHandler ( 30067754Smsmith ACPI_HANDLE Device, 30167754Smsmith UINT32 HandlerType, 30277424Smsmith ACPI_NOTIFY_HANDLER Handler); 30367754Smsmith 30467754SmsmithACPI_STATUS 30567754SmsmithAcpiInstallAddressSpaceHandler ( 30667754Smsmith ACPI_HANDLE Device, 30777424Smsmith ACPI_ADR_SPACE_TYPE SpaceId, 30877424Smsmith ACPI_ADR_SPACE_HANDLER Handler, 30977424Smsmith ACPI_ADR_SPACE_SETUP Setup, 31067754Smsmith void *Context); 31167754Smsmith 31267754SmsmithACPI_STATUS 31367754SmsmithAcpiRemoveAddressSpaceHandler ( 31467754Smsmith ACPI_HANDLE Device, 31577424Smsmith ACPI_ADR_SPACE_TYPE SpaceId, 31677424Smsmith ACPI_ADR_SPACE_HANDLER Handler); 31767754Smsmith 31867754SmsmithACPI_STATUS 31967754SmsmithAcpiInstallGpeHandler ( 32067754Smsmith UINT32 GpeNumber, 32167754Smsmith UINT32 Type, 32277424Smsmith ACPI_GPE_HANDLER Handler, 32367754Smsmith void *Context); 32467754Smsmith 32567754SmsmithACPI_STATUS 32667754SmsmithAcpiAcquireGlobalLock ( 32767754Smsmith void); 32867754Smsmith 32967754SmsmithACPI_STATUS 33067754SmsmithAcpiReleaseGlobalLock ( 33167754Smsmith void); 33267754Smsmith 33367754SmsmithACPI_STATUS 33467754SmsmithAcpiRemoveGpeHandler ( 33567754Smsmith UINT32 GpeNumber, 33677424Smsmith ACPI_GPE_HANDLER Handler); 33767754Smsmith 33867754SmsmithACPI_STATUS 33967754SmsmithAcpiEnableEvent ( 34067754Smsmith UINT32 AcpiEvent, 34167754Smsmith UINT32 Type); 34267754Smsmith 34367754SmsmithACPI_STATUS 34467754SmsmithAcpiDisableEvent ( 34567754Smsmith UINT32 AcpiEvent, 34667754Smsmith UINT32 Type); 34767754Smsmith 34867754SmsmithACPI_STATUS 34967754SmsmithAcpiClearEvent ( 35067754Smsmith UINT32 AcpiEvent, 35167754Smsmith UINT32 Type); 35267754Smsmith 35367754SmsmithACPI_STATUS 35467754SmsmithAcpiGetEventStatus ( 35567754Smsmith UINT32 AcpiEvent, 35667754Smsmith UINT32 Type, 35767754Smsmith ACPI_EVENT_STATUS *EventStatus); 35867754Smsmith 35967754Smsmith/* 36067754Smsmith * Resource interfaces 36167754Smsmith */ 36267754Smsmith 36367754SmsmithACPI_STATUS 36467754SmsmithAcpiGetCurrentResources( 36567754Smsmith ACPI_HANDLE DeviceHandle, 36667754Smsmith ACPI_BUFFER *RetBuffer); 36767754Smsmith 36867754SmsmithACPI_STATUS 36967754SmsmithAcpiGetPossibleResources( 37067754Smsmith ACPI_HANDLE DeviceHandle, 37167754Smsmith ACPI_BUFFER *RetBuffer); 37267754Smsmith 37367754SmsmithACPI_STATUS 37467754SmsmithAcpiSetCurrentResources ( 37567754Smsmith ACPI_HANDLE DeviceHandle, 37667754Smsmith ACPI_BUFFER *InBuffer); 37767754Smsmith 37867754SmsmithACPI_STATUS 37967754SmsmithAcpiGetIrqRoutingTable ( 38067754Smsmith ACPI_HANDLE BusDeviceHandle, 38167754Smsmith ACPI_BUFFER *RetBuffer); 38267754Smsmith 38367754Smsmith 38467754Smsmith/* 38567754Smsmith * Hardware (ACPI device) interfaces 38667754Smsmith */ 38767754Smsmith 38867754SmsmithACPI_STATUS 38967754SmsmithAcpiSetFirmwareWakingVector ( 39069450Smsmith ACPI_PHYSICAL_ADDRESS PhysicalAddress); 39167754Smsmith 39267754SmsmithACPI_STATUS 39367754SmsmithAcpiGetFirmwareWakingVector ( 39469450Smsmith ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 39567754Smsmith 39667754SmsmithACPI_STATUS 39771867SmsmithAcpiEnterSleepState ( 39871867Smsmith UINT8 SleepState); 39971867Smsmith 40071867SmsmithACPI_STATUS 40167754SmsmithAcpiGetProcessorThrottlingInfo ( 40267754Smsmith ACPI_HANDLE ProcessorHandle, 40367754Smsmith ACPI_BUFFER *UserBuffer); 40467754Smsmith 40567754SmsmithACPI_STATUS 40667754SmsmithAcpiSetProcessorThrottlingState ( 40767754Smsmith ACPI_HANDLE ProcessorHandle, 40867754Smsmith UINT32 ThrottleState); 40967754Smsmith 41067754SmsmithACPI_STATUS 41167754SmsmithAcpiGetProcessorThrottlingState ( 41267754Smsmith ACPI_HANDLE ProcessorHandle, 41367754Smsmith UINT32 *ThrottleState); 41467754Smsmith 41567754SmsmithACPI_STATUS 41667754SmsmithAcpiGetProcessorCxInfo ( 41767754Smsmith ACPI_HANDLE ProcessorHandle, 41867754Smsmith ACPI_BUFFER *UserBuffer); 41967754Smsmith 42067754SmsmithACPI_STATUS 42167754SmsmithAcpiSetProcessorSleepState ( 42267754Smsmith ACPI_HANDLE ProcessorHandle, 42367754Smsmith UINT32 CxState); 42467754Smsmith 42567754SmsmithACPI_STATUS 42667754SmsmithAcpiProcessorSleep ( 42767754Smsmith ACPI_HANDLE ProcessorHandle, 42867754Smsmith UINT32 *PmTimerTicks); 42967754Smsmith 43067754Smsmith 43167754Smsmith#endif /* __ACXFACE_H__ */ 432