hwacpi.c revision 82367
11573Srgrimes 21573Srgrimes/****************************************************************************** 31573Srgrimes * 41573Srgrimes * Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface 51573Srgrimes * $Revision: 43 $ 61573Srgrimes * 71573Srgrimes *****************************************************************************/ 81573Srgrimes 91573Srgrimes/****************************************************************************** 101573Srgrimes * 111573Srgrimes * 1. Copyright Notice 121573Srgrimes * 131573Srgrimes * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 141573Srgrimes * All rights reserved. 151573Srgrimes * 161573Srgrimes * 2. License 171573Srgrimes * 181573Srgrimes * 2.1. This is your license from Intel Corp. under its intellectual property 191573Srgrimes * rights. You may have additional license terms from the party that provided 201573Srgrimes * you this software, covering your right to use that party's intellectual 211573Srgrimes * property rights. 221573Srgrimes * 231573Srgrimes * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 241573Srgrimes * copy of the source code appearing in this file ("Covered Code") an 251573Srgrimes * irrevocable, perpetual, worldwide license under Intel's copyrights in the 261573Srgrimes * base code distributed originally by Intel ("Original Intel Code") to copy, 271573Srgrimes * make derivatives, distribute, use and display any portion of the Covered 281573Srgrimes * Code in any form, with the right to sublicense such rights; and 2950476Speter * 301573Srgrimes * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31217484Sjilles * license (with the right to sublicense), under only those claims of Intel 321573Srgrimes * patents that are infringed by the Original Intel Code, to make, use, sell, 3379531Sru * offer to sell, and import the Covered Code and derivative works thereof 341573Srgrimes * solely to the minimum extent necessary to exercise the above copyright 35178245Skib * license, and in no event shall the patent license extend to any additions 36178245Skib * to or modifications of the Original Intel Code. No other license or right 371573Srgrimes * is granted directly or by implication, estoppel or otherwise; 3859460Sphantom * 3959460Sphantom * The above copyright and patent license is granted only if the following 401573Srgrimes * conditions are met: 41217484Sjilles * 421573Srgrimes * 3. Conditions 431573Srgrimes * 44178245Skib * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45178245Skib * Redistribution of source code of any substantial portion of the Covered 461573Srgrimes * Code or modification with rights to further distribute source must include 47107788Sru * the above Copyright Notice, the above License, this list of Conditions, 481573Srgrimes * and the following Disclaimer and Export Compliance provision. In addition, 4924526Sjdp * Licensee must cause all Covered Code to which Licensee contributes to 5024526Sjdp * contain a file documenting the changes Licensee made to create that Covered 5124526Sjdp * Code and the date of any change. Licensee must include in that file the 521573Srgrimes * documentation of any changes made by any predecessor Licensee. Licensee 531573Srgrimes * must include a prominent statement that the modification is derived, 541573Srgrimes * directly or indirectly, from Original Intel Code. 551573Srgrimes * 561573Srgrimes * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5724526Sjdp * Redistribution of source code of any substantial portion of the Covered 5824526Sjdp * Code or modification without rights to further distribute source must 5924526Sjdp * include the following Disclaimer and Export Compliance provision in the 601573Srgrimes * documentation and/or other materials provided with distribution. In 611573Srgrimes * addition, Licensee may not authorize further sublicense of source of any 621573Srgrimes * portion of the Covered Code, and must include terms to the effect that the 63108028Sru * license from Licensee to its licensee is limited to the intellectual 64108028Sru * property embodied in the software Licensee provides to its licensee, and 65108028Sru * not to intellectual property embodied in modifications its licensee may 661573Srgrimes * make. 67178245Skib * 68178245Skib * 3.3. Redistribution of Executable. Redistribution in executable form of any 69178245Skib * substantial portion of the Covered Code or modification must reproduce the 70178245Skib * above Copyright Notice, and the following Disclaimer and Export Compliance 71178245Skib * provision in the documentation and/or other materials provided with the 72178245Skib * distribution. 73178245Skib * 74178245Skib * 3.4. Intel retains all right, title, and interest in and to the Original 75178245Skib * Intel Code. 76178245Skib * 77178245Skib * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78178245Skib * Intel shall be used in advertising or otherwise to promote the sale, use or 79178245Skib * other dealings in products derived from or relating to the Covered Code 80178245Skib * without prior written authorization from Intel. 81178245Skib * 82178245Skib * 4. Disclaimer and Export Compliance 83178245Skib * 84178245Skib * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85178245Skib * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86178245Skib * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87178245Skib * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 881573Srgrimes * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8981352Syar * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 901573Srgrimes * PARTICULAR PURPOSE. 91108028Sru * 92108028Sru * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93108028Sru * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 941573Srgrimes * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 951573Srgrimes * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 961573Srgrimes * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 971573Srgrimes * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 981573Srgrimes * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 991573Srgrimes * LIMITED REMEDY. 1001573Srgrimes * 1011573Srgrimes * 4.3. Licensee shall not export, either directly or indirectly, any of this 1021573Srgrimes * software or system incorporating such software without first obtaining any 1031573Srgrimes * required license or other approval from the U. S. Department of Commerce or 1041573Srgrimes * any other agency or department of the United States Government. In the 1051573Srgrimes * event Licensee exports any such software from the United States or 1061573Srgrimes * re-exports any such software from a foreign destination, Licensee shall 1071573Srgrimes * ensure that the distribution and export/re-export of the software is in 1081573Srgrimes * compliance with all laws, regulations, orders, or other restrictions of the 1091573Srgrimes * U.S. Export Administration Regulations. Licensee agrees that neither it nor 1101573Srgrimes * any of its subsidiaries will export/re-export any technical data, process, 1111573Srgrimes * software, or service, directly or indirectly, to any country for which the 1121573Srgrimes * United States government or any agency thereof requires an export license, 1131573Srgrimes * other governmental approval, or letter of assurance, without first obtaining 1141573Srgrimes * such license, approval or letter. 1151573Srgrimes * 1161573Srgrimes *****************************************************************************/ 1171573Srgrimes 1181573Srgrimes#define __HWACPI_C__ 1191573Srgrimes 1201573Srgrimes#include "acpi.h" 1211573Srgrimes#include "achware.h" 1221573Srgrimes 1231573Srgrimes 1241573Srgrimes#define _COMPONENT ACPI_HARDWARE 1251573Srgrimes MODULE_NAME ("hwacpi") 1261573Srgrimes 1271573Srgrimes 1281573Srgrimes/****************************************************************************** 1291573Srgrimes * 1301573Srgrimes * FUNCTION: AcpiHwInitialize 131108087Sru * 132108087Sru * PARAMETERS: None 133108087Sru * 1341573Srgrimes * RETURN: Status 13546150Sjoerg * 13646150Sjoerg * DESCRIPTION: Initialize and validate various ACPI registers 13746150Sjoerg * 13846150Sjoerg ******************************************************************************/ 13946150Sjoerg 1401573SrgrimesACPI_STATUS 141178245SkibAcpiHwInitialize ( 142178245Skib void) 143178245Skib{ 144178245Skib ACPI_STATUS Status = AE_OK; 145178245Skib UINT32 Index; 146178245Skib 147178245Skib 148178245Skib FUNCTION_TRACE ("HwInitialize"); 149178245Skib 150178245Skib 151178245Skib /* We must have the ACPI tables by the time we get here */ 152178245Skib 153178245Skib if (!AcpiGbl_FADT) 154178245Skib { 155178245Skib AcpiGbl_RestoreAcpiChipset = FALSE; 156178245Skib 157178245Skib ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No FADT!\n")); 158178245Skib 159178245Skib return_ACPI_STATUS (AE_NO_ACPI_TABLES); 160178245Skib } 161178245Skib 162178245Skib /* Must support *some* mode! */ 163178245Skib/* 164178245Skib if (!(SystemFlags & SYS_MODES_MASK)) 1651573Srgrimes { 1661573Srgrimes RestoreAcpiChipset = FALSE; 16722045Sobrien 1681573Srgrimes ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, 1691573Srgrimes "Supported modes uninitialized!\n")); 170178245Skib return_ACPI_STATUS (AE_ERROR); 171178245Skib } 172178245Skib 173178245Skib*/ 1741573Srgrimes 175108028Sru 17617782Smpp switch (AcpiGbl_SystemFlags & SYS_MODES_MASK) 177108028Sru { 17817782Smpp /* Identify current ACPI/legacy mode */ 179178245Skib 180178245Skib case (SYS_MODE_ACPI): 181178245Skib 182178245Skib AcpiGbl_OriginalMode = SYS_MODE_ACPI; 183 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "System supports ACPI mode only.\n")); 184 break; 185 186 187 case (SYS_MODE_LEGACY): 188 189 AcpiGbl_OriginalMode = SYS_MODE_LEGACY; 190 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 191 "Tables loaded from buffer, hardware assumed to support LEGACY mode only.\n")); 192 break; 193 194 195 case (SYS_MODE_ACPI | SYS_MODE_LEGACY): 196 197 if (AcpiHwGetMode () == SYS_MODE_ACPI) 198 { 199 AcpiGbl_OriginalMode = SYS_MODE_ACPI; 200 } 201 else 202 { 203 AcpiGbl_OriginalMode = SYS_MODE_LEGACY; 204 } 205 206 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 207 "System supports both ACPI and LEGACY modes.\n")); 208 209 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 210 "System is currently in %s mode.\n", 211 (AcpiGbl_OriginalMode == SYS_MODE_ACPI) ? "ACPI" : "LEGACY")); 212 break; 213 } 214 215 216 if (AcpiGbl_SystemFlags & SYS_MODE_ACPI) 217 { 218 /* Target system supports ACPI mode */ 219 220 /* 221 * The purpose of this code is to save the initial state 222 * of the ACPI event enable registers. An exit function will be 223 * registered which will restore this state when the application 224 * exits. The exit function will also clear all of the ACPI event 225 * status bits prior to restoring the original mode. 226 * 227 * The location of the PM1aEvtBlk enable registers is defined as the 228 * base of PM1aEvtBlk + DIV_2(PM1aEvtBlkLength). Since the spec further 229 * fully defines the PM1aEvtBlk to be a total of 4 bytes, the offset 230 * for the enable registers is always 2 from the base. It is hard 231 * coded here. If this changes in the spec, this code will need to 232 * be modified. The PM1bEvtBlk behaves as expected. 233 */ 234 235 AcpiGbl_Pm1EnableRegisterSave = (UINT16) AcpiHwRegisterRead ( 236 ACPI_MTX_LOCK, PM1_EN); 237 238 239 /* 240 * The GPEs behave similarly, except that the length of the register 241 * block is not fixed, so the buffer must be allocated with malloc 242 */ 243 244 if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe0Blk.Address) && 245 AcpiGbl_FADT->Gpe0BlkLen) 246 { 247 /* GPE0 specified in FADT */ 248 249 AcpiGbl_Gpe0EnableRegisterSave = ACPI_MEM_ALLOCATE ( 250 DIV_2 (AcpiGbl_FADT->Gpe0BlkLen)); 251 if (!AcpiGbl_Gpe0EnableRegisterSave) 252 { 253 return_ACPI_STATUS (AE_NO_MEMORY); 254 } 255 256 /* Save state of GPE0 enable bits */ 257 258 for (Index = 0; Index < DIV_2 (AcpiGbl_FADT->Gpe0BlkLen); Index++) 259 { 260 AcpiGbl_Gpe0EnableRegisterSave[Index] = 261 (UINT8) AcpiHwRegisterRead (ACPI_MTX_LOCK, GPE0_EN_BLOCK | Index); 262 } 263 } 264 265 else 266 { 267 AcpiGbl_Gpe0EnableRegisterSave = NULL; 268 } 269 270 if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe1Blk.Address) && 271 AcpiGbl_FADT->Gpe1BlkLen) 272 { 273 /* GPE1 defined */ 274 275 AcpiGbl_Gpe1EnableRegisterSave = ACPI_MEM_ALLOCATE ( 276 DIV_2 (AcpiGbl_FADT->Gpe1BlkLen)); 277 if (!AcpiGbl_Gpe1EnableRegisterSave) 278 { 279 return_ACPI_STATUS (AE_NO_MEMORY); 280 } 281 282 /* save state of GPE1 enable bits */ 283 284 for (Index = 0; Index < DIV_2 (AcpiGbl_FADT->Gpe1BlkLen); Index++) 285 { 286 AcpiGbl_Gpe1EnableRegisterSave[Index] = 287 (UINT8) AcpiHwRegisterRead (ACPI_MTX_LOCK, GPE1_EN_BLOCK | Index); 288 } 289 } 290 291 else 292 { 293 AcpiGbl_Gpe1EnableRegisterSave = NULL; 294 } 295 } 296 297 return_ACPI_STATUS (Status); 298} 299 300 301/****************************************************************************** 302 * 303 * FUNCTION: AcpiHwSetMode 304 * 305 * PARAMETERS: Mode - SYS_MODE_ACPI or SYS_MODE_LEGACY 306 * 307 * RETURN: Status 308 * 309 * DESCRIPTION: Transitions the system into the requested mode or does nothing 310 * if the system is already in that mode. 311 * 312 ******************************************************************************/ 313 314ACPI_STATUS 315AcpiHwSetMode ( 316 UINT32 Mode) 317{ 318 319 ACPI_STATUS Status = AE_NO_HARDWARE_RESPONSE; 320 321 FUNCTION_TRACE ("HwSetMode"); 322 323 324 if (Mode == SYS_MODE_ACPI) 325 { 326 /* BIOS should have disabled ALL fixed and GP events */ 327 328 AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, AcpiGbl_FADT->AcpiEnable, 8); 329 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n")); 330 } 331 332 else if (Mode == SYS_MODE_LEGACY) 333 { 334 /* 335 * BIOS should clear all fixed status bits and restore fixed event 336 * enable bits to default 337 */ 338 339 AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, AcpiGbl_FADT->AcpiDisable, 8); 340 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 341 "Attempting to enable Legacy (non-ACPI) mode\n")); 342 } 343 344 if (AcpiHwGetMode () == Mode) 345 { 346 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Mode %X successfully enabled\n", Mode)); 347 Status = AE_OK; 348 } 349 350 return_ACPI_STATUS (Status); 351} 352 353 354/****************************************************************************** 355 * 356 * FUNCTION: AcpiHwGetMode 357 * 358 * PARAMETERS: none 359 * 360 * RETURN: SYS_MODE_ACPI or SYS_MODE_LEGACY 361 * 362 * DESCRIPTION: Return current operating state of system. Determined by 363 * querying the SCI_EN bit. 364 * 365 ******************************************************************************/ 366 367UINT32 368AcpiHwGetMode (void) 369{ 370 371 FUNCTION_TRACE ("HwGetMode"); 372 373 374 if (AcpiHwRegisterBitAccess (ACPI_READ, ACPI_MTX_LOCK, SCI_EN)) 375 { 376 return_VALUE (SYS_MODE_ACPI); 377 } 378 else 379 { 380 return_VALUE (SYS_MODE_LEGACY); 381 } 382} 383 384/****************************************************************************** 385 * 386 * FUNCTION: AcpiHwGetModeCapabilities 387 * 388 * PARAMETERS: none 389 * 390 * RETURN: logical OR of SYS_MODE_ACPI and SYS_MODE_LEGACY determined at initial 391 * system state. 392 * 393 * DESCRIPTION: Returns capablities of system 394 * 395 ******************************************************************************/ 396 397UINT32 398AcpiHwGetModeCapabilities (void) 399{ 400 401 FUNCTION_TRACE ("HwGetModeCapabilities"); 402 403 404 if (!(AcpiGbl_SystemFlags & SYS_MODES_MASK)) 405 { 406 if (AcpiHwGetMode () == SYS_MODE_LEGACY) 407 { 408 /* 409 * Assume that if this call is being made, AcpiInit has been called 410 * and ACPI support has been established by the presence of the 411 * tables. Therefore since we're in SYS_MODE_LEGACY, the system 412 * must support both modes 413 */ 414 415 AcpiGbl_SystemFlags |= (SYS_MODE_ACPI | SYS_MODE_LEGACY); 416 } 417 418 else 419 { 420 /* TBD: [Investigate] !!! this may be unsafe... */ 421 /* 422 * system is is ACPI mode, so try to switch back to LEGACY to see if 423 * it is supported 424 */ 425 AcpiHwSetMode (SYS_MODE_LEGACY); 426 427 if (AcpiHwGetMode () == SYS_MODE_LEGACY) 428 { 429 /* Now in SYS_MODE_LEGACY, so both are supported */ 430 431 AcpiGbl_SystemFlags |= (SYS_MODE_ACPI | SYS_MODE_LEGACY); 432 AcpiHwSetMode (SYS_MODE_ACPI); 433 } 434 435 else 436 { 437 /* Still in SYS_MODE_ACPI so this must be an ACPI only system */ 438 439 AcpiGbl_SystemFlags |= SYS_MODE_ACPI; 440 } 441 } 442 } 443 444 return_VALUE (AcpiGbl_SystemFlags & SYS_MODES_MASK); 445} 446 447 448