hwacpi.c revision 83174
1216109Slstewart 2216109Slstewart/****************************************************************************** 3216115Slstewart * 4216115Slstewart * Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface 5216109Slstewart * $Revision: 45 $ 6216109Slstewart * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118#define __HWACPI_C__ 119 120#include "acpi.h" 121#include "achware.h" 122 123 124#define _COMPONENT ACPI_HARDWARE 125 MODULE_NAME ("hwacpi") 126 127 128/****************************************************************************** 129 * 130 * FUNCTION: AcpiHwInitialize 131 * 132 * PARAMETERS: None 133 * 134 * RETURN: Status 135 * 136 * DESCRIPTION: Initialize and validate various ACPI registers 137 * 138 ******************************************************************************/ 139 140ACPI_STATUS 141AcpiHwInitialize ( 142 void) 143{ 144 ACPI_STATUS Status = AE_OK; 145 UINT32 Index; 146 147 148 FUNCTION_TRACE ("HwInitialize"); 149 150 151 /* We must have the ACPI tables by the time we get here */ 152 153 if (!AcpiGbl_FADT) 154 { 155 AcpiGbl_RestoreAcpiChipset = FALSE; 156 157 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No FADT!\n")); 158 159 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 160 } 161 162 /* Identify current ACPI/legacy mode */ 163 164 switch (AcpiGbl_SystemFlags & SYS_MODES_MASK) 165 { 166 case (SYS_MODE_ACPI): 167 168 AcpiGbl_OriginalMode = SYS_MODE_ACPI; 169 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "System supports ACPI mode only.\n")); 170 break; 171 172 173 case (SYS_MODE_LEGACY): 174 175 AcpiGbl_OriginalMode = SYS_MODE_LEGACY; 176 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 177 "Tables loaded from buffer, hardware assumed to support LEGACY mode only.\n")); 178 break; 179 180 181 case (SYS_MODE_ACPI | SYS_MODE_LEGACY): 182 183 if (AcpiHwGetMode () == SYS_MODE_ACPI) 184 { 185 AcpiGbl_OriginalMode = SYS_MODE_ACPI; 186 } 187 else 188 { 189 AcpiGbl_OriginalMode = SYS_MODE_LEGACY; 190 } 191 192 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 193 "System supports both ACPI and LEGACY modes.\n")); 194 195 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 196 "System is currently in %s mode.\n", 197 (AcpiGbl_OriginalMode == SYS_MODE_ACPI) ? "ACPI" : "LEGACY")); 198 break; 199 } 200 201 202 if (AcpiGbl_SystemFlags & SYS_MODE_ACPI) 203 { 204 /* Target system supports ACPI mode */ 205 206 /* 207 * The purpose of this code is to save the initial state 208 * of the ACPI event enable registers. An exit function will be 209 * registered which will restore this state when the application 210 * exits. The exit function will also clear all of the ACPI event 211 * status bits prior to restoring the original mode. 212 * 213 * The location of the PM1aEvtBlk enable registers is defined as the 214 * base of PM1aEvtBlk + DIV_2(PM1aEvtBlkLength). Since the spec further 215 * fully defines the PM1aEvtBlk to be a total of 4 bytes, the offset 216 * for the enable registers is always 2 from the base. It is hard 217 * coded here. If this changes in the spec, this code will need to 218 * be modified. The PM1bEvtBlk behaves as expected. 219 */ 220 AcpiGbl_Pm1EnableRegisterSave = (UINT16) AcpiHwRegisterRead ( 221 ACPI_MTX_LOCK, PM1_EN); 222 223 224 /* 225 * The GPEs behave similarly, except that the length of the register 226 * block is not fixed, so the buffer must be allocated with malloc 227 */ 228 if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe0Blk.Address) && 229 AcpiGbl_FADT->Gpe0BlkLen) 230 { 231 /* GPE0 specified in FADT */ 232 233 AcpiGbl_Gpe0EnableRegisterSave = ACPI_MEM_ALLOCATE ( 234 DIV_2 (AcpiGbl_FADT->Gpe0BlkLen)); 235 if (!AcpiGbl_Gpe0EnableRegisterSave) 236 { 237 return_ACPI_STATUS (AE_NO_MEMORY); 238 } 239 240 /* Save state of GPE0 enable bits */ 241 242 for (Index = 0; Index < DIV_2 (AcpiGbl_FADT->Gpe0BlkLen); Index++) 243 { 244 AcpiGbl_Gpe0EnableRegisterSave[Index] = 245 (UINT8) AcpiHwRegisterRead (ACPI_MTX_LOCK, GPE0_EN_BLOCK | Index); 246 } 247 } 248 249 else 250 { 251 AcpiGbl_Gpe0EnableRegisterSave = NULL; 252 } 253 254 if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe1Blk.Address) && 255 AcpiGbl_FADT->Gpe1BlkLen) 256 { 257 /* GPE1 defined */ 258 259 AcpiGbl_Gpe1EnableRegisterSave = ACPI_MEM_ALLOCATE ( 260 DIV_2 (AcpiGbl_FADT->Gpe1BlkLen)); 261 if (!AcpiGbl_Gpe1EnableRegisterSave) 262 { 263 return_ACPI_STATUS (AE_NO_MEMORY); 264 } 265 266 /* save state of GPE1 enable bits */ 267 268 for (Index = 0; Index < DIV_2 (AcpiGbl_FADT->Gpe1BlkLen); Index++) 269 { 270 AcpiGbl_Gpe1EnableRegisterSave[Index] = 271 (UINT8) AcpiHwRegisterRead (ACPI_MTX_LOCK, GPE1_EN_BLOCK | Index); 272 } 273 } 274 275 else 276 { 277 AcpiGbl_Gpe1EnableRegisterSave = NULL; 278 } 279 } 280 281 return_ACPI_STATUS (Status); 282} 283 284 285/****************************************************************************** 286 * 287 * FUNCTION: AcpiHwSetMode 288 * 289 * PARAMETERS: Mode - SYS_MODE_ACPI or SYS_MODE_LEGACY 290 * 291 * RETURN: Status 292 * 293 * DESCRIPTION: Transitions the system into the requested mode or does nothing 294 * if the system is already in that mode. 295 * 296 ******************************************************************************/ 297 298ACPI_STATUS 299AcpiHwSetMode ( 300 UINT32 Mode) 301{ 302 303 ACPI_STATUS Status = AE_NO_HARDWARE_RESPONSE; 304 305 306 FUNCTION_TRACE ("HwSetMode"); 307 308 309 if (Mode == SYS_MODE_ACPI) 310 { 311 /* BIOS should have disabled ALL fixed and GP events */ 312 313 AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, AcpiGbl_FADT->AcpiEnable, 8); 314 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n")); 315 } 316 317 else if (Mode == SYS_MODE_LEGACY) 318 { 319 /* 320 * BIOS should clear all fixed status bits and restore fixed event 321 * enable bits to default 322 */ 323 AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, AcpiGbl_FADT->AcpiDisable, 8); 324 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 325 "Attempting to enable Legacy (non-ACPI) mode\n")); 326 } 327 328 /* Give the platform some time to react */ 329 330 AcpiOsStall (5000); 331 332 if (AcpiHwGetMode () == Mode) 333 { 334 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Mode %X successfully enabled\n", Mode)); 335 Status = AE_OK; 336 } 337 338 return_ACPI_STATUS (Status); 339} 340 341 342/****************************************************************************** 343 * 344 * FUNCTION: AcpiHwGetMode 345 * 346 * PARAMETERS: none 347 * 348 * RETURN: SYS_MODE_ACPI or SYS_MODE_LEGACY 349 * 350 * DESCRIPTION: Return current operating state of system. Determined by 351 * querying the SCI_EN bit. 352 * 353 ******************************************************************************/ 354 355UINT32 356AcpiHwGetMode (void) 357{ 358 359 FUNCTION_TRACE ("HwGetMode"); 360 361 362 if (AcpiHwRegisterBitAccess (ACPI_READ, ACPI_MTX_LOCK, SCI_EN)) 363 { 364 return_VALUE (SYS_MODE_ACPI); 365 } 366 else 367 { 368 return_VALUE (SYS_MODE_LEGACY); 369 } 370} 371 372 373/****************************************************************************** 374 * 375 * FUNCTION: AcpiHwGetModeCapabilities 376 * 377 * PARAMETERS: none 378 * 379 * RETURN: logical OR of SYS_MODE_ACPI and SYS_MODE_LEGACY determined at initial 380 * system state. 381 * 382 * DESCRIPTION: Returns capablities of system 383 * 384 ******************************************************************************/ 385 386UINT32 387AcpiHwGetModeCapabilities (void) 388{ 389 390 FUNCTION_TRACE ("HwGetModeCapabilities"); 391 392 393 if (!(AcpiGbl_SystemFlags & SYS_MODES_MASK)) 394 { 395 if (AcpiHwGetMode () == SYS_MODE_LEGACY) 396 { 397 /* 398 * Assume that if this call is being made, AcpiInit has been called 399 * and ACPI support has been established by the presence of the 400 * tables. Therefore since we're in SYS_MODE_LEGACY, the system 401 * must support both modes 402 */ 403 AcpiGbl_SystemFlags |= (SYS_MODE_ACPI | SYS_MODE_LEGACY); 404 } 405 406 else 407 { 408 /* TBD: [Investigate] !!! this may be unsafe... */ 409 /* 410 * system is is ACPI mode, so try to switch back to LEGACY to see if 411 * it is supported 412 */ 413 AcpiHwSetMode (SYS_MODE_LEGACY); 414 415 if (AcpiHwGetMode () == SYS_MODE_LEGACY) 416 { 417 /* Now in SYS_MODE_LEGACY, so both are supported */ 418 419 AcpiGbl_SystemFlags |= (SYS_MODE_ACPI | SYS_MODE_LEGACY); 420 AcpiHwSetMode (SYS_MODE_ACPI); 421 } 422 423 else 424 { 425 /* Still in SYS_MODE_ACPI so this must be an ACPI only system */ 426 427 AcpiGbl_SystemFlags |= SYS_MODE_ACPI; 428 } 429 } 430 } 431 432 return_VALUE (AcpiGbl_SystemFlags & SYS_MODES_MASK); 433} 434 435 436