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