achware.h revision 233250
1299871Sjmcneill/****************************************************************************** 2299871Sjmcneill * 3299871Sjmcneill * Name: achware.h -- hardware specific interfaces 4299871Sjmcneill * 5299871Sjmcneill *****************************************************************************/ 6299871Sjmcneill 7299871Sjmcneill/* 8299871Sjmcneill * Copyright (C) 2000 - 2012, Intel Corp. 9299871Sjmcneill * All rights reserved. 10299871Sjmcneill * 11299871Sjmcneill * Redistribution and use in source and binary forms, with or without 12299871Sjmcneill * modification, are permitted provided that the following conditions 13299871Sjmcneill * are met: 14299871Sjmcneill * 1. Redistributions of source code must retain the above copyright 15299871Sjmcneill * notice, this list of conditions, and the following disclaimer, 16299871Sjmcneill * without modification. 17299871Sjmcneill * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18299871Sjmcneill * substantially similar to the "NO WARRANTY" disclaimer below 19299871Sjmcneill * ("Disclaimer") and any redistribution must be conditioned upon 20299871Sjmcneill * including a substantially similar Disclaimer requirement for further 21299871Sjmcneill * binary redistribution. 22299871Sjmcneill * 3. Neither the names of the above-listed copyright holders nor the names 23299871Sjmcneill * of any contributors may be used to endorse or promote products derived 24299871Sjmcneill * from this software without specific prior written permission. 25299871Sjmcneill * 26299871Sjmcneill * Alternatively, this software may be distributed under the terms of the 27299871Sjmcneill * GNU General Public License ("GPL") version 2 as published by the Free 28299871Sjmcneill * Software Foundation. 29299871Sjmcneill * 30299871Sjmcneill * NO WARRANTY 31299871Sjmcneill * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32299871Sjmcneill * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33305440Smanu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34299871Sjmcneill * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35299871Sjmcneill * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44#ifndef __ACHWARE_H__ 45#define __ACHWARE_H__ 46 47 48/* Values for the _SST predefined method */ 49 50#define ACPI_SST_INDICATOR_OFF 0 51#define ACPI_SST_WORKING 1 52#define ACPI_SST_WAKING 2 53#define ACPI_SST_SLEEPING 3 54#define ACPI_SST_SLEEP_CONTEXT 4 55 56 57/* 58 * hwacpi - high level functions 59 */ 60ACPI_STATUS 61AcpiHwSetMode ( 62 UINT32 Mode); 63 64UINT32 65AcpiHwGetMode ( 66 void); 67 68 69/* 70 * hwregs - ACPI Register I/O 71 */ 72ACPI_STATUS 73AcpiHwValidateRegister ( 74 ACPI_GENERIC_ADDRESS *Reg, 75 UINT8 MaxBitWidth, 76 UINT64 *Address); 77 78ACPI_STATUS 79AcpiHwRead ( 80 UINT32 *Value, 81 ACPI_GENERIC_ADDRESS *Reg); 82 83ACPI_STATUS 84AcpiHwWrite ( 85 UINT32 Value, 86 ACPI_GENERIC_ADDRESS *Reg); 87 88ACPI_BIT_REGISTER_INFO * 89AcpiHwGetBitRegisterInfo ( 90 UINT32 RegisterId); 91 92ACPI_STATUS 93AcpiHwWritePm1Control ( 94 UINT32 Pm1aControl, 95 UINT32 Pm1bControl); 96 97ACPI_STATUS 98AcpiHwRegisterRead ( 99 UINT32 RegisterId, 100 UINT32 *ReturnValue); 101 102ACPI_STATUS 103AcpiHwRegisterWrite ( 104 UINT32 RegisterId, 105 UINT32 Value); 106 107ACPI_STATUS 108AcpiHwClearAcpiStatus ( 109 void); 110 111 112/* 113 * hwsleep - sleep/wake support (Legacy sleep registers) 114 */ 115ACPI_STATUS 116AcpiHwLegacySleep ( 117 UINT8 SleepState, 118 UINT8 Flags); 119 120ACPI_STATUS 121AcpiHwLegacyWakePrep ( 122 UINT8 SleepState, 123 UINT8 Flags); 124 125ACPI_STATUS 126AcpiHwLegacyWake ( 127 UINT8 SleepState, 128 UINT8 Flags); 129 130 131/* 132 * hwesleep - sleep/wake support (Extended FADT-V5 sleep registers) 133 */ 134void 135AcpiHwExecuteSleepMethod ( 136 char *MethodName, 137 UINT32 IntegerArgument); 138 139ACPI_STATUS 140AcpiHwExtendedSleep ( 141 UINT8 SleepState, 142 UINT8 Flags); 143 144ACPI_STATUS 145AcpiHwExtendedWakePrep ( 146 UINT8 SleepState, 147 UINT8 Flags); 148 149ACPI_STATUS 150AcpiHwExtendedWake ( 151 UINT8 SleepState, 152 UINT8 Flags); 153 154 155/* 156 * hwvalid - Port I/O with validation 157 */ 158ACPI_STATUS 159AcpiHwReadPort ( 160 ACPI_IO_ADDRESS Address, 161 UINT32 *Value, 162 UINT32 Width); 163 164ACPI_STATUS 165AcpiHwWritePort ( 166 ACPI_IO_ADDRESS Address, 167 UINT32 Value, 168 UINT32 Width); 169 170 171/* 172 * hwgpe - GPE support 173 */ 174UINT32 175AcpiHwGetGpeRegisterBit ( 176 ACPI_GPE_EVENT_INFO *GpeEventInfo, 177 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo); 178 179ACPI_STATUS 180AcpiHwLowSetGpe ( 181 ACPI_GPE_EVENT_INFO *GpeEventInfo, 182 UINT32 Action); 183 184ACPI_STATUS 185AcpiHwDisableGpeBlock ( 186 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 187 ACPI_GPE_BLOCK_INFO *GpeBlock, 188 void *Context); 189 190ACPI_STATUS 191AcpiHwClearGpe ( 192 ACPI_GPE_EVENT_INFO *GpeEventInfo); 193 194ACPI_STATUS 195AcpiHwClearGpeBlock ( 196 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 197 ACPI_GPE_BLOCK_INFO *GpeBlock, 198 void *Context); 199 200ACPI_STATUS 201AcpiHwGetGpeStatus ( 202 ACPI_GPE_EVENT_INFO *GpeEventInfo, 203 ACPI_EVENT_STATUS *EventStatus); 204 205ACPI_STATUS 206AcpiHwDisableAllGpes ( 207 void); 208 209ACPI_STATUS 210AcpiHwEnableAllRuntimeGpes ( 211 void); 212 213ACPI_STATUS 214AcpiHwEnableAllWakeupGpes ( 215 void); 216 217ACPI_STATUS 218AcpiHwEnableRuntimeGpeBlock ( 219 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 220 ACPI_GPE_BLOCK_INFO *GpeBlock, 221 void *Context); 222 223 224/* 225 * hwpci - PCI configuration support 226 */ 227ACPI_STATUS 228AcpiHwDerivePciId ( 229 ACPI_PCI_ID *PciId, 230 ACPI_HANDLE RootPciDevice, 231 ACPI_HANDLE PciRegion); 232 233 234#endif /* __ACHWARE_H__ */ 235