hwgpe.c revision 129684
1 2/****************************************************************************** 3 * 4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions 5 * $Revision: 62 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2004, 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#include "acpi.h" 119#include "acevents.h" 120 121#define _COMPONENT ACPI_HARDWARE 122 ACPI_MODULE_NAME ("hwgpe") 123 124 125/****************************************************************************** 126 * 127 * FUNCTION: AcpiHwWriteGpeEnableReg 128 * 129 * PARAMETERS: GpeEventInfo - Info block for the GPE to be enabled 130 * 131 * RETURN: Status 132 * 133 * DESCRIPTION: Write a GPE enable register. Note: The bit for this GPE must 134 * already be cleared or set in the parent register 135 * EnableForRun mask. 136 * 137 ******************************************************************************/ 138 139ACPI_STATUS 140AcpiHwWriteGpeEnableReg ( 141 ACPI_GPE_EVENT_INFO *GpeEventInfo) 142{ 143 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 144 ACPI_STATUS Status; 145 146 147 ACPI_FUNCTION_ENTRY (); 148 149 150 /* Get the info block for the entire GPE register */ 151 152 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 153 if (!GpeRegisterInfo) 154 { 155 return (AE_NOT_EXIST); 156 } 157 158 /* Write the entire GPE (runtime) enable register */ 159 160 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->EnableForRun, 161 &GpeRegisterInfo->EnableAddress); 162 163 return (Status); 164} 165 166 167/****************************************************************************** 168 * 169 * FUNCTION: AcpiHwClearGpe 170 * 171 * PARAMETERS: GpeEventInfo - Info block for the GPE to be cleared 172 * 173 * RETURN: StatusStatus 174 * 175 * DESCRIPTION: Clear the status bit for a single GPE. 176 * 177 ******************************************************************************/ 178 179ACPI_STATUS 180AcpiHwClearGpe ( 181 ACPI_GPE_EVENT_INFO *GpeEventInfo) 182{ 183 ACPI_STATUS Status; 184 185 186 ACPI_FUNCTION_ENTRY (); 187 188 189 /* 190 * Write a one to the appropriate bit in the status register to 191 * clear this GPE. 192 */ 193 Status = AcpiHwLowLevelWrite (8, GpeEventInfo->RegisterBit, 194 &GpeEventInfo->RegisterInfo->StatusAddress); 195 196 return (Status); 197} 198 199 200/****************************************************************************** 201 * 202 * FUNCTION: AcpiHwGetGpeStatus 203 * 204 * PARAMETERS: GpeEventInfo - Info block for the GPE to queried 205 * EventStatus - Where the GPE status is returned 206 * 207 * RETURN: Status 208 * 209 * DESCRIPTION: Return the status of a single GPE. 210 * 211 ******************************************************************************/ 212 213ACPI_STATUS 214AcpiHwGetGpeStatus ( 215 ACPI_GPE_EVENT_INFO *GpeEventInfo, 216 ACPI_EVENT_STATUS *EventStatus) 217{ 218 UINT32 InByte; 219 UINT8 RegisterBit; 220 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 221 ACPI_STATUS Status; 222 ACPI_EVENT_STATUS LocalEventStatus = 0; 223 224 225 ACPI_FUNCTION_ENTRY (); 226 227 228 if (!EventStatus) 229 { 230 return (AE_BAD_PARAMETER); 231 } 232 233 /* Get the info block for the entire GPE register */ 234 235 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 236 237 /* Get the register bitmask for this GPE */ 238 239 RegisterBit = GpeEventInfo->RegisterBit; 240 241 /* GPE currently enabled? (enabled for runtime?) */ 242 243 if (RegisterBit & GpeRegisterInfo->EnableForRun) 244 { 245 LocalEventStatus |= ACPI_EVENT_FLAG_ENABLED; 246 } 247 248 /* GPE enabled for wake? */ 249 250 if (RegisterBit & GpeRegisterInfo->EnableForWake) 251 { 252 LocalEventStatus |= ACPI_EVENT_FLAG_WAKE_ENABLED; 253 } 254 255 /* GPE currently active (status bit == 1)? */ 256 257 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->StatusAddress); 258 if (ACPI_FAILURE (Status)) 259 { 260 goto UnlockAndExit; 261 } 262 263 if (RegisterBit & InByte) 264 { 265 LocalEventStatus |= ACPI_EVENT_FLAG_SET; 266 } 267 268 /* Set return value */ 269 270 (*EventStatus) = LocalEventStatus; 271 272 273UnlockAndExit: 274 return (Status); 275} 276 277 278/****************************************************************************** 279 * 280 * FUNCTION: AcpiHwDisableGpeBlock 281 * 282 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 283 * GpeBlock - Gpe Block info 284 * 285 * RETURN: Status 286 * 287 * DESCRIPTION: Disable all GPEs within a GPE block 288 * 289 ******************************************************************************/ 290 291ACPI_STATUS 292AcpiHwDisableGpeBlock ( 293 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 294 ACPI_GPE_BLOCK_INFO *GpeBlock) 295{ 296 UINT32 i; 297 ACPI_STATUS Status; 298 299 300 /* Examine each GPE Register within the block */ 301 302 for (i = 0; i < GpeBlock->RegisterCount; i++) 303 { 304 /* Disable all GPEs in this register */ 305 306 Status = AcpiHwLowLevelWrite (8, 0x00, 307 &GpeBlock->RegisterInfo[i].EnableAddress); 308 if (ACPI_FAILURE (Status)) 309 { 310 return (Status); 311 } 312 } 313 314 return (AE_OK); 315} 316 317 318/****************************************************************************** 319 * 320 * FUNCTION: AcpiHwClearGpeBlock 321 * 322 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 323 * GpeBlock - Gpe Block info 324 * 325 * RETURN: Status 326 * 327 * DESCRIPTION: Clear status bits for all GPEs within a GPE block 328 * 329 ******************************************************************************/ 330 331ACPI_STATUS 332AcpiHwClearGpeBlock ( 333 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 334 ACPI_GPE_BLOCK_INFO *GpeBlock) 335{ 336 UINT32 i; 337 ACPI_STATUS Status; 338 339 340 /* Examine each GPE Register within the block */ 341 342 for (i = 0; i < GpeBlock->RegisterCount; i++) 343 { 344 /* Clear status on all GPEs in this register */ 345 346 Status = AcpiHwLowLevelWrite (8, 0xFF, 347 &GpeBlock->RegisterInfo[i].StatusAddress); 348 if (ACPI_FAILURE (Status)) 349 { 350 return (Status); 351 } 352 } 353 354 return (AE_OK); 355} 356 357 358/****************************************************************************** 359 * 360 * FUNCTION: AcpiHwEnableRuntimeGpeBlock 361 * 362 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 363 * GpeBlock - Gpe Block info 364 * 365 * RETURN: Status 366 * 367 * DESCRIPTION: Enable all "runtime" GPEs within a GPE block. (Includes 368 * combination wake/run GPEs.) 369 * 370 ******************************************************************************/ 371 372ACPI_STATUS 373AcpiHwEnableRuntimeGpeBlock ( 374 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 375 ACPI_GPE_BLOCK_INFO *GpeBlock) 376{ 377 UINT32 i; 378 ACPI_STATUS Status; 379 380 381 /* NOTE: assumes that all GPEs are currently disabled */ 382 383 /* Examine each GPE Register within the block */ 384 385 for (i = 0; i < GpeBlock->RegisterCount; i++) 386 { 387 if (!GpeBlock->RegisterInfo[i].EnableForRun) 388 { 389 continue; 390 } 391 392 /* Enable all "runtime" GPEs in this register */ 393 394 Status = AcpiHwLowLevelWrite (8, GpeBlock->RegisterInfo[i].EnableForRun, 395 &GpeBlock->RegisterInfo[i].EnableAddress); 396 if (ACPI_FAILURE (Status)) 397 { 398 return (Status); 399 } 400 } 401 402 return (AE_OK); 403} 404 405 406/****************************************************************************** 407 * 408 * FUNCTION: AcpiHwEnableWakeupGpeBlock 409 * 410 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 411 * GpeBlock - Gpe Block info 412 * 413 * RETURN: Status 414 * 415 * DESCRIPTION: Enable all "wake" GPEs within a GPE block. (Includes 416 * combination wake/run GPEs.) 417 * 418 ******************************************************************************/ 419 420ACPI_STATUS 421AcpiHwEnableWakeupGpeBlock ( 422 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 423 ACPI_GPE_BLOCK_INFO *GpeBlock) 424{ 425 UINT32 i; 426 ACPI_STATUS Status; 427 428 429 /* Examine each GPE Register within the block */ 430 431 for (i = 0; i < GpeBlock->RegisterCount; i++) 432 { 433 if (!GpeBlock->RegisterInfo[i].EnableForWake) 434 { 435 continue; 436 } 437 438 /* Enable all "wake" GPEs in this register */ 439 440 Status = AcpiHwLowLevelWrite (8, GpeBlock->RegisterInfo[i].EnableForWake, 441 &GpeBlock->RegisterInfo[i].EnableAddress); 442 if (ACPI_FAILURE (Status)) 443 { 444 return (Status); 445 } 446 } 447 448 return (AE_OK); 449} 450 451 452/****************************************************************************** 453 * 454 * FUNCTION: AcpiHwDisableAllGpes 455 * 456 * PARAMETERS: None 457 * 458 * RETURN: Status 459 * 460 * DESCRIPTION: Disable and clear all GPEs 461 * 462 ******************************************************************************/ 463 464ACPI_STATUS 465AcpiHwDisableAllGpes ( 466 void) 467{ 468 ACPI_STATUS Status; 469 470 471 ACPI_FUNCTION_TRACE ("HwDisableAllGpes"); 472 473 474 Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock); 475 Status = AcpiEvWalkGpeList (AcpiHwClearGpeBlock); 476 return_ACPI_STATUS (Status); 477} 478 479 480/****************************************************************************** 481 * 482 * FUNCTION: AcpiHwEnableAllRuntimeGpes 483 * 484 * PARAMETERS: None 485 * 486 * RETURN: Status 487 * 488 * DESCRIPTION: Enable all GPEs of the given type 489 * 490 ******************************************************************************/ 491 492ACPI_STATUS 493AcpiHwEnableAllRuntimeGpes ( 494 void) 495{ 496 ACPI_STATUS Status; 497 498 499 ACPI_FUNCTION_TRACE ("HwEnableAllRuntimeGpes"); 500 501 502 Status = AcpiEvWalkGpeList (AcpiHwEnableRuntimeGpeBlock); 503 return_ACPI_STATUS (Status); 504} 505 506 507/****************************************************************************** 508 * 509 * FUNCTION: AcpiHwEnableAllWakeupGpes 510 * 511 * PARAMETERS: None 512 * 513 * RETURN: Status 514 * 515 * DESCRIPTION: Enable all GPEs of the given type 516 * 517 ******************************************************************************/ 518 519ACPI_STATUS 520AcpiHwEnableAllWakeupGpes ( 521 void) 522{ 523 ACPI_STATUS Status; 524 525 526 ACPI_FUNCTION_TRACE ("HwEnableAllWakeupGpes"); 527 528 529 Status = AcpiEvWalkGpeList (AcpiHwEnableWakeupGpeBlock); 530 return_ACPI_STATUS (Status); 531} 532 533