achware.h revision 941:49d0d4c2eea8
1/****************************************************************************** 2 * 3 * Name: achware.h -- hardware specific interfaces 4 * $Revision: 1.79 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#ifndef __ACHWARE_H__ 118#define __ACHWARE_H__ 119 120 121/* PM Timer ticks per second (HZ) */ 122 123#define PM_TIMER_FREQUENCY 3579545 124 125/* Values for the _SST reserved method */ 126 127#define ACPI_SST_INDICATOR_OFF 0 128#define ACPI_SST_WORKING 1 129#define ACPI_SST_WAKING 2 130#define ACPI_SST_SLEEPING 3 131#define ACPI_SST_SLEEP_CONTEXT 4 132 133 134/* Prototypes */ 135 136 137/* 138 * hwacpi - high level functions 139 */ 140ACPI_STATUS 141AcpiHwInitialize ( 142 void); 143 144ACPI_STATUS 145AcpiHwSetMode ( 146 UINT32 Mode); 147 148UINT32 149AcpiHwGetMode ( 150 void); 151 152 153/* 154 * hwregs - ACPI Register I/O 155 */ 156ACPI_BIT_REGISTER_INFO * 157AcpiHwGetBitRegisterInfo ( 158 UINT32 RegisterId); 159 160ACPI_STATUS 161AcpiHwRegisterRead ( 162 BOOLEAN UseLock, 163 UINT32 RegisterId, 164 UINT32 *ReturnValue); 165 166ACPI_STATUS 167AcpiHwRegisterWrite ( 168 BOOLEAN UseLock, 169 UINT32 RegisterId, 170 UINT32 Value); 171 172ACPI_STATUS 173AcpiHwLowLevelRead ( 174 UINT32 Width, 175 UINT32 *Value, 176 ACPI_GENERIC_ADDRESS *Reg); 177 178ACPI_STATUS 179AcpiHwLowLevelWrite ( 180 UINT32 Width, 181 UINT32 Value, 182 ACPI_GENERIC_ADDRESS *Reg); 183 184ACPI_STATUS 185AcpiHwClearAcpiStatus ( 186 UINT32 Flags); 187 188 189/* 190 * hwgpe - GPE support 191 */ 192ACPI_STATUS 193AcpiHwWriteGpeEnableReg ( 194 ACPI_GPE_EVENT_INFO *GpeEventInfo); 195 196ACPI_STATUS 197AcpiHwDisableGpeBlock ( 198 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 199 ACPI_GPE_BLOCK_INFO *GpeBlock); 200 201ACPI_STATUS 202AcpiHwClearGpe ( 203 ACPI_GPE_EVENT_INFO *GpeEventInfo); 204 205ACPI_STATUS 206AcpiHwClearGpeBlock ( 207 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 208 ACPI_GPE_BLOCK_INFO *GpeBlock); 209 210ACPI_STATUS 211AcpiHwGetGpeStatus ( 212 ACPI_GPE_EVENT_INFO *GpeEventInfo, 213 ACPI_EVENT_STATUS *EventStatus); 214 215ACPI_STATUS 216AcpiHwDisableAllGpes ( 217 void); 218 219ACPI_STATUS 220AcpiHwEnableAllRuntimeGpes ( 221 void); 222 223ACPI_STATUS 224AcpiHwEnableAllWakeupGpes ( 225 void); 226 227ACPI_STATUS 228AcpiHwEnableRuntimeGpeBlock ( 229 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 230 ACPI_GPE_BLOCK_INFO *GpeBlock); 231 232 233/* 234 * hwtimer - ACPI Timer prototypes 235 */ 236ACPI_STATUS 237AcpiGetTimerResolution ( 238 UINT32 *Resolution); 239 240ACPI_STATUS 241AcpiGetTimer ( 242 UINT32 *Ticks); 243 244ACPI_STATUS 245AcpiGetTimerDuration ( 246 UINT32 StartTicks, 247 UINT32 EndTicks, 248 UINT32 *TimeElapsed); 249 250 251#endif /* __ACHWARE_H__ */ 252