evmisc.c revision 91116
1/****************************************************************************** 2 * 3 * Module Name: evmisc - ACPI device notification handler dispatch 4 * and ACPI Global Lock support 5 * $Revision: 46 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, 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#include "acnamesp.h" 121#include "acinterp.h" 122#include "achware.h" 123 124#define _COMPONENT ACPI_EVENTS 125 ACPI_MODULE_NAME ("evmisc") 126 127 128/******************************************************************************* 129 * 130 * FUNCTION: AcpiEvGetGpeRegisterIndex 131 * 132 * PARAMETERS: GpeNumber - Raw GPE number 133 * 134 * RETURN: None. 135 * 136 * DESCRIPTION: Returns the register index (index into the GPE register info 137 * table) associated with this GPE. 138 * 139 ******************************************************************************/ 140 141UINT32 142AcpiEvGetGpeRegisterIndex ( 143 UINT32 GpeNumber) 144{ 145 146 if (GpeNumber > AcpiGbl_GpeNumberMax) 147 { 148 return (ACPI_GPE_INVALID); 149 } 150 151 return (ACPI_DIV_8 (AcpiGbl_GpeNumberToIndex[GpeNumber].NumberIndex)); 152} 153 154 155/******************************************************************************* 156 * 157 * FUNCTION: AcpiEvGetGpeNumberIndex 158 * 159 * PARAMETERS: GpeNumber - Raw GPE number 160 * 161 * RETURN: None. 162 * 163 * DESCRIPTION: Returns the number index (index into the GPE number info table) 164 * associated with this GPE. 165 * 166 ******************************************************************************/ 167 168UINT32 169AcpiEvGetGpeNumberIndex ( 170 UINT32 GpeNumber) 171{ 172 173 if (GpeNumber > AcpiGbl_GpeNumberMax) 174 { 175 return (ACPI_GPE_INVALID); 176 } 177 178 return (AcpiGbl_GpeNumberToIndex[GpeNumber].NumberIndex); 179} 180 181 182/******************************************************************************* 183 * 184 * FUNCTION: AcpiEvQueueNotifyRequest 185 * 186 * PARAMETERS: 187 * 188 * RETURN: None. 189 * 190 * DESCRIPTION: Dispatch a device notification event to a previously 191 * installed handler. 192 * 193 ******************************************************************************/ 194 195ACPI_STATUS 196AcpiEvQueueNotifyRequest ( 197 ACPI_NAMESPACE_NODE *Node, 198 UINT32 NotifyValue) 199{ 200 ACPI_OPERAND_OBJECT *ObjDesc; 201 ACPI_OPERAND_OBJECT *HandlerObj = NULL; 202 ACPI_GENERIC_STATE *NotifyInfo; 203 ACPI_STATUS Status = AE_OK; 204 205 206 ACPI_FUNCTION_NAME ("EvQueueNotifyRequest"); 207 208 209 /* 210 * For value 1 (Ejection Request), some device method may need to be run. 211 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need to be run. 212 * For value 0x80 (Status Change) on the power button or sleep button, 213 * initiate soft-off or sleep operation? 214 */ 215 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 216 "Dispatching Notify(%X) on node %p\n", NotifyValue, Node)); 217 218 switch (NotifyValue) 219 { 220 case 0: 221 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: Re-enumerate Devices\n")); 222 break; 223 224 case 1: 225 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: Ejection Request\n")); 226 break; 227 228 case 2: 229 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: Device Wake\n")); 230 break; 231 232 case 0x80: 233 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: Status Change\n")); 234 break; 235 236 default: 237 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Unknown Notify Value: %X \n", NotifyValue)); 238 break; 239 } 240 241 /* 242 * Get the notify object attached to the device Node 243 */ 244 ObjDesc = AcpiNsGetAttachedObject (Node); 245 if (ObjDesc) 246 { 247 /* We have the notify object, Get the right handler */ 248 249 switch (Node->Type) 250 { 251 case ACPI_TYPE_DEVICE: 252 253 if (NotifyValue <= ACPI_MAX_SYS_NOTIFY) 254 { 255 HandlerObj = ObjDesc->Device.SysHandler; 256 } 257 else 258 { 259 HandlerObj = ObjDesc->Device.DrvHandler; 260 } 261 break; 262 263 264 case ACPI_TYPE_THERMAL: 265 266 if (NotifyValue <= ACPI_MAX_SYS_NOTIFY) 267 { 268 HandlerObj = ObjDesc->ThermalZone.SysHandler; 269 } 270 else 271 { 272 HandlerObj = ObjDesc->ThermalZone.DrvHandler; 273 } 274 break; 275 } 276 } 277 278 /* If there is any handler to run, schedule the dispatcher */ 279 280 if ((AcpiGbl_SysNotify.Handler && (NotifyValue <= ACPI_MAX_SYS_NOTIFY)) || 281 (AcpiGbl_DrvNotify.Handler && (NotifyValue > ACPI_MAX_SYS_NOTIFY)) || 282 HandlerObj) 283 { 284 NotifyInfo = AcpiUtCreateGenericState (); 285 if (!NotifyInfo) 286 { 287 return (AE_NO_MEMORY); 288 } 289 290 NotifyInfo->Common.DataType = ACPI_DESC_TYPE_STATE_NOTIFY; 291 NotifyInfo->Notify.Node = Node; 292 NotifyInfo->Notify.Value = (UINT16) NotifyValue; 293 NotifyInfo->Notify.HandlerObj = HandlerObj; 294 295 Status = AcpiOsQueueForExecution (OSD_PRIORITY_HIGH, 296 AcpiEvNotifyDispatch, NotifyInfo); 297 if (ACPI_FAILURE (Status)) 298 { 299 AcpiUtDeleteGenericState (NotifyInfo); 300 } 301 } 302 303 if (!HandlerObj) 304 { 305 /* There is no per-device notify handler for this device */ 306 307 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "No notify handler for node %p \n", Node)); 308 } 309 310 return (Status); 311} 312 313 314/******************************************************************************* 315 * 316 * FUNCTION: AcpiEvNotifyDispatch 317 * 318 * PARAMETERS: 319 * 320 * RETURN: None. 321 * 322 * DESCRIPTION: Dispatch a device notification event to a previously 323 * installed handler. 324 * 325 ******************************************************************************/ 326 327void 328AcpiEvNotifyDispatch ( 329 void *Context) 330{ 331 ACPI_GENERIC_STATE *NotifyInfo = (ACPI_GENERIC_STATE *) Context; 332 ACPI_NOTIFY_HANDLER GlobalHandler = NULL; 333 void *GlobalContext = NULL; 334 ACPI_OPERAND_OBJECT *HandlerObj; 335 336 337 ACPI_FUNCTION_ENTRY (); 338 339 340 /* 341 * We will invoke a global notify handler if installed. 342 * This is done _before_ we invoke the per-device handler attached to the device. 343 */ 344 if (NotifyInfo->Notify.Value <= ACPI_MAX_SYS_NOTIFY) 345 { 346 /* Global system notification handler */ 347 348 if (AcpiGbl_SysNotify.Handler) 349 { 350 GlobalHandler = AcpiGbl_SysNotify.Handler; 351 GlobalContext = AcpiGbl_SysNotify.Context; 352 } 353 } 354 else 355 { 356 /* Global driver notification handler */ 357 358 if (AcpiGbl_DrvNotify.Handler) 359 { 360 GlobalHandler = AcpiGbl_DrvNotify.Handler; 361 GlobalContext = AcpiGbl_DrvNotify.Context; 362 } 363 } 364 365 /* Invoke the system handler first, if present */ 366 367 if (GlobalHandler) 368 { 369 GlobalHandler (NotifyInfo->Notify.Node, NotifyInfo->Notify.Value, GlobalContext); 370 } 371 372 /* Now invoke the per-device handler, if present */ 373 374 HandlerObj = NotifyInfo->Notify.HandlerObj; 375 if (HandlerObj) 376 { 377 HandlerObj->NotifyHandler.Handler (NotifyInfo->Notify.Node, NotifyInfo->Notify.Value, 378 HandlerObj->NotifyHandler.Context); 379 } 380 381 /* All done with the info object */ 382 383 AcpiUtDeleteGenericState (NotifyInfo); 384} 385 386 387/******************************************************************************* 388 * 389 * FUNCTION: AcpiEvGlobalLockThread 390 * 391 * RETURN: None 392 * 393 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the 394 * Global Lock. Simply signal all threads that are waiting 395 * for the lock. 396 * 397 ******************************************************************************/ 398 399static void 400AcpiEvGlobalLockThread ( 401 void *Context) 402{ 403 404 /* Signal threads that are waiting for the lock */ 405 406 if (AcpiGbl_GlobalLockThreadCount) 407 { 408 /* Send sufficient units to the semaphore */ 409 410 AcpiOsSignalSemaphore (AcpiGbl_GlobalLockSemaphore, 411 AcpiGbl_GlobalLockThreadCount); 412 } 413} 414 415 416/******************************************************************************* 417 * 418 * FUNCTION: AcpiEvGlobalLockHandler 419 * 420 * RETURN: Status 421 * 422 * DESCRIPTION: Invoked directly from the SCI handler when a global lock 423 * release interrupt occurs. Grab the global lock and queue 424 * the global lock thread for execution 425 * 426 ******************************************************************************/ 427 428static UINT32 429AcpiEvGlobalLockHandler ( 430 void *Context) 431{ 432 BOOLEAN Acquired = FALSE; 433 434 435 /* 436 * Attempt to get the lock 437 * If we don't get it now, it will be marked pending and we will 438 * take another interrupt when it becomes free. 439 */ 440 ACPI_ACQUIRE_GLOBAL_LOCK (AcpiGbl_CommonFACS.GlobalLock, Acquired); 441 if (Acquired) 442 { 443 /* Got the lock, now wake all threads waiting for it */ 444 445 AcpiGbl_GlobalLockAcquired = TRUE; 446 447 /* Run the Global Lock thread which will signal all waiting threads */ 448 449 AcpiOsQueueForExecution (OSD_PRIORITY_HIGH, AcpiEvGlobalLockThread, 450 Context); 451 } 452 453 return (ACPI_INTERRUPT_HANDLED); 454} 455 456 457/******************************************************************************* 458 * 459 * FUNCTION: AcpiEvInitGlobalLockHandler 460 * 461 * RETURN: Status 462 * 463 * DESCRIPTION: Install a handler for the global lock release event 464 * 465 ******************************************************************************/ 466 467ACPI_STATUS 468AcpiEvInitGlobalLockHandler (void) 469{ 470 ACPI_STATUS Status; 471 472 473 ACPI_FUNCTION_TRACE ("EvInitGlobalLockHandler"); 474 475 476 AcpiGbl_GlobalLockPresent = TRUE; 477 Status = AcpiInstallFixedEventHandler (ACPI_EVENT_GLOBAL, 478 AcpiEvGlobalLockHandler, NULL); 479 480 /* 481 * If the global lock does not exist on this platform, the attempt 482 * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick) 483 * Map to AE_OK, but mark global lock as not present. 484 * Any attempt to actually use the global lock will be flagged 485 * with an error. 486 */ 487 if (Status == AE_NO_HARDWARE_RESPONSE) 488 { 489 AcpiGbl_GlobalLockPresent = FALSE; 490 Status = AE_OK; 491 } 492 493 return_ACPI_STATUS (Status); 494} 495 496 497/****************************************************************************** 498 * 499 * FUNCTION: AcpiEvAcquireGlobalLock 500 * 501 * RETURN: Status 502 * 503 * DESCRIPTION: Attempt to gain ownership of the Global Lock. 504 * 505 *****************************************************************************/ 506 507ACPI_STATUS 508AcpiEvAcquireGlobalLock ( 509 UINT32 Timeout) 510{ 511 ACPI_STATUS Status = AE_OK; 512 BOOLEAN Acquired = FALSE; 513 514 515 ACPI_FUNCTION_TRACE ("EvAcquireGlobalLock"); 516 517 518 /* Make sure that we actually have a global lock */ 519 520 if (!AcpiGbl_GlobalLockPresent) 521 { 522 return_ACPI_STATUS (AE_NO_GLOBAL_LOCK); 523 } 524 525 /* One more thread wants the global lock */ 526 527 AcpiGbl_GlobalLockThreadCount++; 528 529 /* If we (OS side vs. BIOS side) have the hardware lock already, we are done */ 530 531 if (AcpiGbl_GlobalLockAcquired) 532 { 533 return_ACPI_STATUS (AE_OK); 534 } 535 536 /* We must acquire the actual hardware lock */ 537 538 ACPI_ACQUIRE_GLOBAL_LOCK (AcpiGbl_CommonFACS.GlobalLock, Acquired); 539 if (Acquired) 540 { 541 /* We got the lock */ 542 543 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Acquired the HW Global Lock\n")); 544 545 AcpiGbl_GlobalLockAcquired = TRUE; 546 return_ACPI_STATUS (AE_OK); 547 } 548 549 /* 550 * Did not get the lock. The pending bit was set above, and we must now 551 * wait until we get the global lock released interrupt. 552 */ 553 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Waiting for the HW Global Lock\n")); 554 555 /* 556 * Acquire the global lock semaphore first. 557 * Since this wait will block, we must release the interpreter 558 */ 559 Status = AcpiExSystemWaitSemaphore (AcpiGbl_GlobalLockSemaphore, 560 Timeout); 561 return_ACPI_STATUS (Status); 562} 563 564 565/******************************************************************************* 566 * 567 * FUNCTION: AcpiEvReleaseGlobalLock 568 * 569 * DESCRIPTION: Releases ownership of the Global Lock. 570 * 571 ******************************************************************************/ 572 573void 574AcpiEvReleaseGlobalLock (void) 575{ 576 BOOLEAN Pending = FALSE; 577 578 579 ACPI_FUNCTION_TRACE ("EvReleaseGlobalLock"); 580 581 582 if (!AcpiGbl_GlobalLockThreadCount) 583 { 584 ACPI_REPORT_WARNING(("Cannot release HW Global Lock, it has not been acquired\n")); 585 return_VOID; 586 } 587 588 /* One fewer thread has the global lock */ 589 590 AcpiGbl_GlobalLockThreadCount--; 591 if (AcpiGbl_GlobalLockThreadCount) 592 { 593 /* There are still some threads holding the lock, cannot release */ 594 595 return_VOID; 596 } 597 598 /* 599 * No more threads holding lock, we can do the actual hardware 600 * release 601 */ 602 ACPI_RELEASE_GLOBAL_LOCK (AcpiGbl_CommonFACS.GlobalLock, Pending); 603 AcpiGbl_GlobalLockAcquired = FALSE; 604 605 /* 606 * If the pending bit was set, we must write GBL_RLS to the control 607 * register 608 */ 609 if (Pending) 610 { 611 AcpiHwBitRegisterWrite (ACPI_BITREG_GLOBAL_LOCK_RELEASE, 1, ACPI_MTX_LOCK); 612 } 613 614 return_VOID; 615} 616 617 618/****************************************************************************** 619 * 620 * FUNCTION: AcpiEvTerminate 621 * 622 * PARAMETERS: none 623 * 624 * RETURN: none 625 * 626 * DESCRIPTION: free memory allocated for table storage. 627 * 628 ******************************************************************************/ 629 630void 631AcpiEvTerminate (void) 632{ 633 634 ACPI_FUNCTION_TRACE ("EvTerminate"); 635 636 637 /* 638 * Free global tables, etc. 639 */ 640 if (AcpiGbl_GpeRegisterInfo) 641 { 642 ACPI_MEM_FREE (AcpiGbl_GpeRegisterInfo); 643 AcpiGbl_GpeRegisterInfo = NULL; 644 } 645 646 if (AcpiGbl_GpeNumberInfo) 647 { 648 ACPI_MEM_FREE (AcpiGbl_GpeNumberInfo); 649 AcpiGbl_GpeNumberInfo = NULL; 650 } 651 652 if (AcpiGbl_GpeNumberToIndex) 653 { 654 ACPI_MEM_FREE (AcpiGbl_GpeNumberToIndex); 655 AcpiGbl_GpeNumberToIndex = NULL; 656 } 657 658 return_VOID; 659} 660 661