achware.h revision 70243
167754Smsmith/****************************************************************************** 267754Smsmith * 367754Smsmith * Name: achware.h -- hardware specific interfaces 470243Smsmith * $Revision: 49 $ 567754Smsmith * 667754Smsmith *****************************************************************************/ 767754Smsmith 867754Smsmith/****************************************************************************** 967754Smsmith * 1067754Smsmith * 1. Copyright Notice 1167754Smsmith * 1270243Smsmith * Some or all of this work - Copyright (c) 1999, 2000, 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#ifndef __ACHWARE_H__ 11867754Smsmith#define __ACHWARE_H__ 11967754Smsmith 12067754Smsmith 12167754Smsmith/* Prototypes */ 12267754Smsmith 12367754Smsmith 12467754SmsmithACPI_STATUS 12567754SmsmithAcpiHwInitialize ( 12667754Smsmith void); 12767754Smsmith 12867754SmsmithACPI_STATUS 12967754SmsmithAcpiHwShutdown ( 13067754Smsmith void); 13167754Smsmith 13267754SmsmithACPI_STATUS 13367754SmsmithAcpiHwInitializeSystemInfo ( 13467754Smsmith void); 13567754Smsmith 13667754SmsmithACPI_STATUS 13767754SmsmithAcpiHwSetMode ( 13867754Smsmith UINT32 Mode); 13967754Smsmith 14067754SmsmithUINT32 14167754SmsmithAcpiHwGetMode ( 14267754Smsmith void); 14367754Smsmith 14467754SmsmithUINT32 14567754SmsmithAcpiHwGetModeCapabilities ( 14667754Smsmith void); 14767754Smsmith 14867754Smsmith/* Register I/O Prototypes */ 14967754Smsmith 15069450Smsmith 15167754SmsmithUINT32 15269450SmsmithAcpiHwRegisterBitAccess ( 15367754Smsmith NATIVE_UINT ReadWrite, 15467754Smsmith BOOLEAN UseLock, 15569450Smsmith UINT32 RegisterId, 15669450Smsmith ... /* DWORD Write Value */); 15767754Smsmith 15869450SmsmithUINT32 15969450SmsmithAcpiHwRegisterRead ( 16069450Smsmith BOOLEAN UseLock, 16169450Smsmith UINT32 RegisterId); 16269450Smsmith 16367754Smsmithvoid 16469450SmsmithAcpiHwRegisterWrite ( 16569450Smsmith BOOLEAN UseLock, 16669450Smsmith UINT32 RegisterId, 16769450Smsmith UINT32 Value); 16869450Smsmith 16969450SmsmithUINT32 17069450SmsmithAcpiHwLowLevelRead ( 17169450Smsmith UINT32 Width, 17269450Smsmith ACPI_GAS *Reg, 17369450Smsmith UINT32 Offset); 17469450Smsmith 17569450Smsmithvoid 17669450SmsmithAcpiHwLowLevelWrite ( 17769450Smsmith UINT32 Width, 17869450Smsmith UINT32 Value, 17969450Smsmith ACPI_GAS *Reg, 18069450Smsmith UINT32 Offset); 18169450Smsmith 18269450Smsmithvoid 18367754SmsmithAcpiHwClearAcpiStatus ( 18467754Smsmith void); 18567754Smsmith 18667754Smsmith 18767754Smsmith/* GPE support */ 18867754Smsmith 18967754Smsmithvoid 19067754SmsmithAcpiHwEnableGpe ( 19167754Smsmith UINT32 GpeIndex); 19267754Smsmith 19367754Smsmithvoid 19467754SmsmithAcpiHwDisableGpe ( 19567754Smsmith UINT32 GpeIndex); 19667754Smsmith 19767754Smsmithvoid 19867754SmsmithAcpiHwClearGpe ( 19967754Smsmith UINT32 GpeIndex); 20067754Smsmith 20167754Smsmithvoid 20267754SmsmithAcpiHwGetGpeStatus ( 20367754Smsmith UINT32 GpeNumber, 20467754Smsmith ACPI_EVENT_STATUS *EventStatus); 20567754Smsmith 20667754Smsmith/* Sleep Prototypes */ 20767754Smsmith 20867754SmsmithACPI_STATUS 20967754SmsmithAcpiHwObtainSleepTypeRegisterData ( 21067754Smsmith UINT8 SleepState, 21167754Smsmith UINT8 *Slp_TypA, 21267754Smsmith UINT8 *Slp_TypB); 21367754Smsmith 21467754Smsmith 21567754Smsmith/* Cx State Prototypes */ 21667754Smsmith 21767754SmsmithACPI_STATUS 21867754SmsmithAcpiHwEnterC1( 21967754Smsmith ACPI_IO_ADDRESS PblkAddress, 22067754Smsmith UINT32 *PmTimerTicks); 22167754Smsmith 22267754SmsmithACPI_STATUS 22367754SmsmithAcpiHwEnterC2( 22467754Smsmith ACPI_IO_ADDRESS PblkAddress, 22567754Smsmith UINT32 *PmTimerTicks); 22667754Smsmith 22767754SmsmithACPI_STATUS 22867754SmsmithAcpiHwEnterC3( 22967754Smsmith ACPI_IO_ADDRESS PblkAddress, 23067754Smsmith UINT32 *PmTimerTicks); 23167754Smsmith 23267754SmsmithACPI_STATUS 23367754SmsmithAcpiHwEnterCx ( 23467754Smsmith ACPI_IO_ADDRESS PblkAddress, 23567754Smsmith UINT32 *PmTimerTicks); 23667754Smsmith 23767754SmsmithACPI_STATUS 23867754SmsmithAcpiHwSetCx ( 23967754Smsmith UINT32 CxState); 24067754Smsmith 24167754SmsmithACPI_STATUS 24267754SmsmithAcpiHwGetCxInfo ( 24367754Smsmith UINT32 CxStates[]); 24467754Smsmith 24569450SmsmithACPI_STATUS 24669450SmsmithAcpiHwGetCxHandler ( 24769450Smsmith UINT32 CxState, 24869450Smsmith ACPI_C_STATE_HANDLER *Handler); 24967754Smsmith 25069450SmsmithACPI_STATUS 25169450SmsmithAcpiHwSetCxHandler ( 25269450Smsmith UINT32 CxState, 25369450Smsmith ACPI_C_STATE_HANDLER Handler); 25469450Smsmith 25569450Smsmith 25667754Smsmith/* Throttling Prototypes */ 25767754Smsmith 25867754Smsmithvoid 25967754SmsmithAcpiHwEnableThrottling ( 26067754Smsmith ACPI_IO_ADDRESS PblkAddress); 26167754Smsmith 26267754Smsmithvoid 26367754SmsmithAcpiHwDisableThrottling ( 26467754Smsmith ACPI_IO_ADDRESS PblkAddress); 26567754Smsmith 26667754SmsmithUINT32 26767754SmsmithAcpiHwGetDutyCycle ( 26867754Smsmith UINT8 DutyOffset, 26967754Smsmith ACPI_IO_ADDRESS PblkAddress, 27067754Smsmith UINT32 NumThrottleStates); 27167754Smsmith 27267754Smsmithvoid 27367754SmsmithAcpiHwProgramDutyCycle ( 27467754Smsmith UINT8 DutyOffset, 27567754Smsmith UINT32 DutyCycle, 27667754Smsmith ACPI_IO_ADDRESS PblkAddress, 27767754Smsmith UINT32 NumThrottleStates); 27867754Smsmith 27967754SmsmithNATIVE_UINT 28067754SmsmithAcpiHwLocalPow ( 28167754Smsmith NATIVE_UINT x, 28267754Smsmith NATIVE_UINT y); 28367754Smsmith 28467754Smsmith 28567754Smsmith/* ACPI Timer prototypes */ 28667754Smsmith 28767754SmsmithUINT32 28867754SmsmithAcpiHwPmtTicks ( 28967754Smsmith void); 29067754Smsmith 29167754SmsmithUINT32 29267754SmsmithAcpiHwPmtResolution ( 29367754Smsmith void); 29467754Smsmith 29569450SmsmithACPI_STATUS 29669450SmsmithAcpiGetTimer ( 29769450Smsmith UINT32 *OutTicks); 29867754Smsmith 29969450Smsmith 30067754Smsmith#endif /* __ACHWARE_H__ */ 301