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