acpixf.h revision 71867
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 12467754Smsmith/* 12567754Smsmith * Global interfaces 12667754Smsmith */ 12767754Smsmith 12867754SmsmithACPI_STATUS 12967754SmsmithAcpiInitializeSubsystem ( 13067754Smsmith void); 13167754Smsmith 13267754SmsmithACPI_STATUS 13367754SmsmithAcpiEnableSubsystem ( 13467754Smsmith UINT32 Flags); 13567754Smsmith 13667754SmsmithACPI_STATUS 13767754SmsmithAcpiTerminate ( 13867754Smsmith void); 13967754Smsmith 14067754SmsmithACPI_STATUS 14167754SmsmithAcpiEnable ( 14267754Smsmith void); 14367754Smsmith 14467754SmsmithACPI_STATUS 14567754SmsmithAcpiDisable ( 14667754Smsmith void); 14767754Smsmith 14867754SmsmithACPI_STATUS 14967754SmsmithAcpiGetSystemInfo( 15067754Smsmith ACPI_BUFFER *RetBuffer); 15167754Smsmith 15267754SmsmithACPI_STATUS 15367754SmsmithAcpiFormatException ( 15467754Smsmith ACPI_STATUS Exception, 15567754Smsmith ACPI_BUFFER *OutBuffer); 15667754Smsmith 15767754Smsmith 15867754Smsmith/* 15967754Smsmith * ACPI table manipulation interfaces 16067754Smsmith */ 16167754Smsmith 16267754SmsmithACPI_STATUS 16367754SmsmithAcpiFindRootPointer ( 16469450Smsmith ACPI_PHYSICAL_ADDRESS *RsdpPhysicalAddress); 16567754Smsmith 16667754SmsmithACPI_STATUS 16767754SmsmithAcpiLoadTables ( 16869450Smsmith ACPI_PHYSICAL_ADDRESS RsdpPhysicalAddress); 16967754Smsmith 17067754SmsmithACPI_STATUS 17167754SmsmithAcpiLoadTable ( 17267754Smsmith ACPI_TABLE_HEADER *TablePtr); 17367754Smsmith 17467754SmsmithACPI_STATUS 17567754SmsmithAcpiUnloadTable ( 17667754Smsmith ACPI_TABLE_TYPE TableType); 17767754Smsmith 17867754SmsmithACPI_STATUS 17967754SmsmithAcpiGetTableHeader ( 18067754Smsmith ACPI_TABLE_TYPE TableType, 18167754Smsmith UINT32 Instance, 18267754Smsmith ACPI_TABLE_HEADER *OutTableHeader); 18367754Smsmith 18467754SmsmithACPI_STATUS 18567754SmsmithAcpiGetTable ( 18667754Smsmith ACPI_TABLE_TYPE TableType, 18767754Smsmith UINT32 Instance, 18867754Smsmith ACPI_BUFFER *RetBuffer); 18967754Smsmith 19067754Smsmith 19167754Smsmith/* 19267754Smsmith * Namespace and name interfaces 19367754Smsmith */ 19467754Smsmith 19567754SmsmithACPI_STATUS 19667754SmsmithAcpiWalkNamespace ( 19767754Smsmith ACPI_OBJECT_TYPE Type, 19867754Smsmith ACPI_HANDLE StartObject, 19967754Smsmith UINT32 MaxDepth, 20067754Smsmith WALK_CALLBACK UserFunction, 20167754Smsmith void *Context, 20267754Smsmith void * *ReturnValue); 20367754Smsmith 20467754SmsmithACPI_STATUS 20567754SmsmithAcpiGetDevices ( 20667754Smsmith NATIVE_CHAR *HID, 20767754Smsmith WALK_CALLBACK UserFunction, 20867754Smsmith void *Context, 20967754Smsmith void **ReturnValue); 21067754Smsmith 21167754SmsmithACPI_STATUS 21267754SmsmithAcpiGetName ( 21367754Smsmith ACPI_HANDLE Handle, 21467754Smsmith UINT32 NameType, 21567754Smsmith ACPI_BUFFER *RetPathPtr); 21667754Smsmith 21767754SmsmithACPI_STATUS 21867754SmsmithAcpiGetHandle ( 21967754Smsmith ACPI_HANDLE Parent, 22067754Smsmith ACPI_STRING Pathname, 22167754Smsmith ACPI_HANDLE *RetHandle); 22267754Smsmith 22367754Smsmith 22467754Smsmith/* 22567754Smsmith * Object manipulation and enumeration 22667754Smsmith */ 22767754Smsmith 22867754SmsmithACPI_STATUS 22967754SmsmithAcpiEvaluateObject ( 23067754Smsmith ACPI_HANDLE Object, 23167754Smsmith ACPI_STRING Pathname, 23267754Smsmith ACPI_OBJECT_LIST *ParameterObjects, 23367754Smsmith ACPI_BUFFER *ReturnObjectBuffer); 23467754Smsmith 23567754SmsmithACPI_STATUS 23667754SmsmithAcpiGetObjectInfo ( 23767754Smsmith ACPI_HANDLE Device, 23867754Smsmith ACPI_DEVICE_INFO *Info); 23967754Smsmith 24067754SmsmithACPI_STATUS 24167754SmsmithAcpiGetNextObject ( 24267754Smsmith ACPI_OBJECT_TYPE Type, 24367754Smsmith ACPI_HANDLE Parent, 24467754Smsmith ACPI_HANDLE Child, 24567754Smsmith ACPI_HANDLE *OutHandle); 24667754Smsmith 24767754SmsmithACPI_STATUS 24867754SmsmithAcpiGetType ( 24967754Smsmith ACPI_HANDLE Object, 25067754Smsmith ACPI_OBJECT_TYPE *OutType); 25167754Smsmith 25267754SmsmithACPI_STATUS 25367754SmsmithAcpiGetParent ( 25467754Smsmith ACPI_HANDLE Object, 25567754Smsmith ACPI_HANDLE *OutHandle); 25667754Smsmith 25767754Smsmith 25867754Smsmith/* 25967754Smsmith * AcpiEvent handler interfaces 26067754Smsmith */ 26167754Smsmith 26267754SmsmithACPI_STATUS 26367754SmsmithAcpiInstallFixedEventHandler ( 26467754Smsmith UINT32 AcpiEvent, 26567754Smsmith FIXED_EVENT_HANDLER Handler, 26667754Smsmith void *Context); 26767754Smsmith 26867754SmsmithACPI_STATUS 26967754SmsmithAcpiRemoveFixedEventHandler ( 27067754Smsmith UINT32 AcpiEvent, 27167754Smsmith FIXED_EVENT_HANDLER Handler); 27267754Smsmith 27367754SmsmithACPI_STATUS 27467754SmsmithAcpiInstallNotifyHandler ( 27567754Smsmith ACPI_HANDLE Device, 27667754Smsmith UINT32 HandlerType, 27767754Smsmith NOTIFY_HANDLER Handler, 27867754Smsmith void *Context); 27967754Smsmith 28067754SmsmithACPI_STATUS 28167754SmsmithAcpiRemoveNotifyHandler ( 28267754Smsmith ACPI_HANDLE Device, 28367754Smsmith UINT32 HandlerType, 28467754Smsmith NOTIFY_HANDLER Handler); 28567754Smsmith 28667754SmsmithACPI_STATUS 28767754SmsmithAcpiInstallAddressSpaceHandler ( 28867754Smsmith ACPI_HANDLE Device, 28967754Smsmith ACPI_ADDRESS_SPACE_TYPE SpaceId, 29067754Smsmith ADDRESS_SPACE_HANDLER Handler, 29167754Smsmith ADDRESS_SPACE_SETUP Setup, 29267754Smsmith void *Context); 29367754Smsmith 29467754SmsmithACPI_STATUS 29567754SmsmithAcpiRemoveAddressSpaceHandler ( 29667754Smsmith ACPI_HANDLE Device, 29767754Smsmith ACPI_ADDRESS_SPACE_TYPE SpaceId, 29867754Smsmith ADDRESS_SPACE_HANDLER Handler); 29967754Smsmith 30067754SmsmithACPI_STATUS 30167754SmsmithAcpiInstallGpeHandler ( 30267754Smsmith UINT32 GpeNumber, 30367754Smsmith UINT32 Type, 30467754Smsmith GPE_HANDLER Handler, 30567754Smsmith void *Context); 30667754Smsmith 30767754SmsmithACPI_STATUS 30867754SmsmithAcpiAcquireGlobalLock ( 30967754Smsmith void); 31067754Smsmith 31167754SmsmithACPI_STATUS 31267754SmsmithAcpiReleaseGlobalLock ( 31367754Smsmith void); 31467754Smsmith 31567754SmsmithACPI_STATUS 31667754SmsmithAcpiRemoveGpeHandler ( 31767754Smsmith UINT32 GpeNumber, 31867754Smsmith GPE_HANDLER Handler); 31967754Smsmith 32067754SmsmithACPI_STATUS 32167754SmsmithAcpiEnableEvent ( 32267754Smsmith UINT32 AcpiEvent, 32367754Smsmith UINT32 Type); 32467754Smsmith 32567754SmsmithACPI_STATUS 32667754SmsmithAcpiDisableEvent ( 32767754Smsmith UINT32 AcpiEvent, 32867754Smsmith UINT32 Type); 32967754Smsmith 33067754SmsmithACPI_STATUS 33167754SmsmithAcpiClearEvent ( 33267754Smsmith UINT32 AcpiEvent, 33367754Smsmith UINT32 Type); 33467754Smsmith 33567754SmsmithACPI_STATUS 33667754SmsmithAcpiGetEventStatus ( 33767754Smsmith UINT32 AcpiEvent, 33867754Smsmith UINT32 Type, 33967754Smsmith ACPI_EVENT_STATUS *EventStatus); 34067754Smsmith 34167754Smsmith/* 34267754Smsmith * Resource interfaces 34367754Smsmith */ 34467754Smsmith 34567754SmsmithACPI_STATUS 34667754SmsmithAcpiGetCurrentResources( 34767754Smsmith ACPI_HANDLE DeviceHandle, 34867754Smsmith ACPI_BUFFER *RetBuffer); 34967754Smsmith 35067754SmsmithACPI_STATUS 35167754SmsmithAcpiGetPossibleResources( 35267754Smsmith ACPI_HANDLE DeviceHandle, 35367754Smsmith ACPI_BUFFER *RetBuffer); 35467754Smsmith 35567754SmsmithACPI_STATUS 35667754SmsmithAcpiSetCurrentResources ( 35767754Smsmith ACPI_HANDLE DeviceHandle, 35867754Smsmith ACPI_BUFFER *InBuffer); 35967754Smsmith 36067754SmsmithACPI_STATUS 36167754SmsmithAcpiGetIrqRoutingTable ( 36267754Smsmith ACPI_HANDLE BusDeviceHandle, 36367754Smsmith ACPI_BUFFER *RetBuffer); 36467754Smsmith 36567754Smsmith 36667754Smsmith/* 36767754Smsmith * Hardware (ACPI device) interfaces 36867754Smsmith */ 36967754Smsmith 37067754SmsmithACPI_STATUS 37167754SmsmithAcpiSetFirmwareWakingVector ( 37269450Smsmith ACPI_PHYSICAL_ADDRESS PhysicalAddress); 37367754Smsmith 37467754SmsmithACPI_STATUS 37567754SmsmithAcpiGetFirmwareWakingVector ( 37669450Smsmith ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 37767754Smsmith 37867754SmsmithACPI_STATUS 37971867SmsmithAcpiEnterSleepState ( 38071867Smsmith UINT8 SleepState); 38171867Smsmith 38271867SmsmithACPI_STATUS 38367754SmsmithAcpiGetProcessorThrottlingInfo ( 38467754Smsmith ACPI_HANDLE ProcessorHandle, 38567754Smsmith ACPI_BUFFER *UserBuffer); 38667754Smsmith 38767754SmsmithACPI_STATUS 38867754SmsmithAcpiSetProcessorThrottlingState ( 38967754Smsmith ACPI_HANDLE ProcessorHandle, 39067754Smsmith UINT32 ThrottleState); 39167754Smsmith 39267754SmsmithACPI_STATUS 39367754SmsmithAcpiGetProcessorThrottlingState ( 39467754Smsmith ACPI_HANDLE ProcessorHandle, 39567754Smsmith UINT32 *ThrottleState); 39667754Smsmith 39767754SmsmithACPI_STATUS 39867754SmsmithAcpiGetProcessorCxInfo ( 39967754Smsmith ACPI_HANDLE ProcessorHandle, 40067754Smsmith ACPI_BUFFER *UserBuffer); 40167754Smsmith 40267754SmsmithACPI_STATUS 40367754SmsmithAcpiSetProcessorSleepState ( 40467754Smsmith ACPI_HANDLE ProcessorHandle, 40567754Smsmith UINT32 CxState); 40667754Smsmith 40767754SmsmithACPI_STATUS 40867754SmsmithAcpiProcessorSleep ( 40967754Smsmith ACPI_HANDLE ProcessorHandle, 41067754Smsmith UINT32 *PmTimerTicks); 41167754Smsmith 41267754Smsmith 41367754Smsmith#endif /* __ACXFACE_H__ */ 414