evmisc.c revision 83174
133965Sjdp/****************************************************************************** 2218822Sdim * 378828Sobrien * Module Name: evmisc - ACPI device notification handler dispatch 433965Sjdp * and ACPI Global Lock support 5218822Sdim * $Revision: 33 $ 6218822Sdim * 7218822Sdim *****************************************************************************/ 8218822Sdim 933965Sjdp/****************************************************************************** 10218822Sdim * 11218822Sdim * 1. Copyright Notice 12218822Sdim * 13218822Sdim * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 1433965Sjdp * All rights reserved. 15218822Sdim * 16218822Sdim * 2. License 17218822Sdim * 18218822Sdim * 2.1. This is your license from Intel Corp. under its intellectual property 1933965Sjdp * rights. You may have additional license terms from the party that provided 2033965Sjdp * you this software, covering your right to use that party's intellectual 2133965Sjdp * property rights. 2233965Sjdp * 2360484Sobrien * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2433965Sjdp * copy of the source code appearing in this file ("Covered Code") an 2533965Sjdp * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2633965Sjdp * base code distributed originally by Intel ("Original Intel Code") to copy, 2733965Sjdp * make derivatives, distribute, use and display any portion of the Covered 28218822Sdim * Code in any form, with the right to sublicense such rights; and 29218822Sdim * 30218822Sdim * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31218822Sdim * license (with the right to sublicense), under only those claims of Intel 3233965Sjdp * patents that are infringed by the Original Intel Code, to make, use, sell, 3360484Sobrien * offer to sell, and import the Covered Code and derivative works thereof 3460484Sobrien * solely to the minimum extent necessary to exercise the above copyright 3560484Sobrien * license, and in no event shall the patent license extend to any additions 3660484Sobrien * to or modifications of the Original Intel Code. No other license or right 3760484Sobrien * is granted directly or by implication, estoppel or otherwise; 3833965Sjdp * 3960484Sobrien * The above copyright and patent license is granted only if the following 4033965Sjdp * conditions are met: 4133965Sjdp * 4260484Sobrien * 3. Conditions 4360484Sobrien * 4433965Sjdp * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4533965Sjdp * Redistribution of source code of any substantial portion of the Covered 4633965Sjdp * Code or modification with rights to further distribute source must include 4733965Sjdp * the above Copyright Notice, the above License, this list of Conditions, 4833965Sjdp * and the following Disclaimer and Export Compliance provision. In addition, 49218822Sdim * Licensee must cause all Covered Code to which Licensee contributes to 5033965Sjdp * contain a file documenting the changes Licensee made to create that Covered 51218822Sdim * Code and the date of any change. Licensee must include in that file the 52218822Sdim * documentation of any changes made by any predecessor Licensee. Licensee 53218822Sdim * must include a prominent statement that the modification is derived, 5433965Sjdp * directly or indirectly, from Original Intel Code. 5533965Sjdp * 5633965Sjdp * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5760484Sobrien * Redistribution of source code of any substantial portion of the Covered 5833965Sjdp * Code or modification without rights to further distribute source must 59218822Sdim * include the following Disclaimer and Export Compliance provision in the 60218822Sdim * documentation and/or other materials provided with distribution. In 61218822Sdim * addition, Licensee may not authorize further sublicense of source of any 62218822Sdim * portion of the Covered Code, and must include terms to the effect that the 63218822Sdim * license from Licensee to its licensee is limited to the intellectual 64218822Sdim * property embodied in the software Licensee provides to its licensee, and 65218822Sdim * not to intellectual property embodied in modifications its licensee may 66218822Sdim * make. 67218822Sdim * 6833965Sjdp * 3.3. Redistribution of Executable. Redistribution in executable form of any 6933965Sjdp * substantial portion of the Covered Code or modification must reproduce the 7033965Sjdp * above Copyright Notice, and the following Disclaimer and Export Compliance 7133965Sjdp * provision in the documentation and/or other materials provided with the 7233965Sjdp * distribution. 7333965Sjdp * 7433965Sjdp * 3.4. Intel retains all right, title, and interest in and to the Original 7533965Sjdp * Intel Code. 7633965Sjdp * 7733965Sjdp * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78218822Sdim * Intel shall be used in advertising or otherwise to promote the sale, use or 7933965Sjdp * other dealings in products derived from or relating to the Covered Code 8060484Sobrien * without prior written authorization from Intel. 8160484Sobrien * 8260484Sobrien * 4. Disclaimer and Export Compliance 8360484Sobrien * 8433965Sjdp * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8538889Sjdp * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86130561Sobrien * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8738889Sjdp * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8838889Sjdp * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89218822Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90218822Sdim * PARTICULAR PURPOSE. 9138889Sjdp * 9238889Sjdp * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9338889Sjdp * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94130561Sobrien * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95130561Sobrien * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96130561Sobrien * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97130561Sobrien * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98130561Sobrien * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99130561Sobrien * LIMITED REMEDY. 100130561Sobrien * 101130561Sobrien * 4.3. Licensee shall not export, either directly or indirectly, any of this 102130561Sobrien * 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: %lx \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 224 /* If there is any handler to run, schedule the dispatcher */ 225 226 if ((AcpiGbl_SysNotify.Handler && (NotifyValue <= MAX_SYS_NOTIFY)) || 227 (AcpiGbl_DrvNotify.Handler && (NotifyValue > MAX_SYS_NOTIFY)) || 228 HandlerObj) 229 { 230 231 NotifyInfo = AcpiUtCreateGenericState (); 232 if (!NotifyInfo) 233 { 234 return (AE_NO_MEMORY); 235 } 236 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 301 else 302 { 303 /* Global driver notification handler */ 304 305 if (AcpiGbl_DrvNotify.Handler) 306 { 307 GlobalHandler = AcpiGbl_DrvNotify.Handler; 308 GlobalContext = AcpiGbl_DrvNotify.Context; 309 } 310 } 311 312 313 /* Invoke the system handler first, if present */ 314 315 if (GlobalHandler) 316 { 317 GlobalHandler (NotifyInfo->Notify.Node, NotifyInfo->Notify.Value, GlobalContext); 318 } 319 320 /* Now invoke the per-device handler, if present */ 321 322 HandlerObj = NotifyInfo->Notify.HandlerObj; 323 if (HandlerObj) 324 { 325 HandlerObj->NotifyHandler.Handler (NotifyInfo->Notify.Node, NotifyInfo->Notify.Value, 326 HandlerObj->NotifyHandler.Context); 327 } 328 329 /* All done with the info object */ 330 331 AcpiUtDeleteGenericState (NotifyInfo); 332} 333 334 335/******************************************************************************* 336 * 337 * FUNCTION: AcpiEvGlobalLockThread 338 * 339 * RETURN: None 340 * 341 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the 342 * Global Lock. Simply signal all threads that are waiting 343 * for the lock. 344 * 345 ******************************************************************************/ 346 347static void 348AcpiEvGlobalLockThread ( 349 void *Context) 350{ 351 352 /* Signal threads that are waiting for the lock */ 353 354 if (AcpiGbl_GlobalLockThreadCount) 355 { 356 /* Send sufficient units to the semaphore */ 357 358 AcpiOsSignalSemaphore (AcpiGbl_GlobalLockSemaphore, 359 AcpiGbl_GlobalLockThreadCount); 360 } 361} 362 363 364/******************************************************************************* 365 * 366 * FUNCTION: AcpiEvGlobalLockHandler 367 * 368 * RETURN: Status 369 * 370 * DESCRIPTION: Invoked directly from the SCI handler when a global lock 371 * release interrupt occurs. Grab the global lock and queue 372 * the global lock thread for execution 373 * 374 ******************************************************************************/ 375 376static UINT32 377AcpiEvGlobalLockHandler ( 378 void *Context) 379{ 380 BOOLEAN Acquired = FALSE; 381 void *GlobalLock; 382 383 384 /* 385 * Attempt to get the lock 386 * If we don't get it now, it will be marked pending and we will 387 * take another interrupt when it becomes free. 388 */ 389 GlobalLock = AcpiGbl_FACS->GlobalLock; 390 ACPI_ACQUIRE_GLOBAL_LOCK (GlobalLock, Acquired); 391 if (Acquired) 392 { 393 /* Got the lock, now wake all threads waiting for it */ 394 395 AcpiGbl_GlobalLockAcquired = TRUE; 396 397 /* Run the Global Lock thread which will signal all waiting threads */ 398 399 AcpiOsQueueForExecution (OSD_PRIORITY_HIGH, AcpiEvGlobalLockThread, 400 Context); 401 } 402 403 return (INTERRUPT_HANDLED); 404} 405 406 407/******************************************************************************* 408 * 409 * FUNCTION: AcpiEvInitGlobalLockHandler 410 * 411 * RETURN: Status 412 * 413 * DESCRIPTION: Install a handler for the global lock release event 414 * 415 ******************************************************************************/ 416 417ACPI_STATUS 418AcpiEvInitGlobalLockHandler (void) 419{ 420 ACPI_STATUS Status; 421 422 423 FUNCTION_TRACE ("EvInitGlobalLockHandler"); 424 425 426 AcpiGbl_GlobalLockPresent = TRUE; 427 Status = AcpiInstallFixedEventHandler (ACPI_EVENT_GLOBAL, 428 AcpiEvGlobalLockHandler, NULL); 429 430 /* 431 * If the global lock does not exist on this platform, the attempt 432 * to enable GBL_STS will fail (the GBL_EN bit will not stick) 433 * Map to AE_OK, but mark global lock as not present. 434 * Any attempt to actually use the global lock will be flagged 435 * with an error. 436 */ 437 if (Status == AE_NO_HARDWARE_RESPONSE) 438 { 439 AcpiGbl_GlobalLockPresent = FALSE; 440 Status = AE_OK; 441 } 442 443 return_ACPI_STATUS (Status); 444} 445 446 447/****************************************************************************** 448 * 449 * FUNCTION: AcpiEvAcquireGlobalLock 450 * 451 * RETURN: Status 452 * 453 * DESCRIPTION: Attempt to gain ownership of the Global Lock. 454 * 455 *****************************************************************************/ 456 457ACPI_STATUS 458AcpiEvAcquireGlobalLock(void) 459{ 460 ACPI_STATUS Status = AE_OK; 461 BOOLEAN Acquired = FALSE; 462 void *GlobalLock; 463 464 465 FUNCTION_TRACE ("EvAcquireGlobalLock"); 466 467 /* Make sure that we actually have a global lock */ 468 469 if (!AcpiGbl_GlobalLockPresent) 470 { 471 return_ACPI_STATUS (AE_NO_GLOBAL_LOCK); 472 } 473 474 /* One more thread wants the global lock */ 475 476 AcpiGbl_GlobalLockThreadCount++; 477 478 479 /* If we (OS side) have the hardware lock already, we are done */ 480 481 if (AcpiGbl_GlobalLockAcquired) 482 { 483 return_ACPI_STATUS (AE_OK); 484 } 485 486 /* Only if the FACS is valid */ 487 488 if (!AcpiGbl_FACS) 489 { 490 return_ACPI_STATUS (AE_OK); 491 } 492 493 494 /* We must acquire the actual hardware lock */ 495 496 GlobalLock = AcpiGbl_FACS->GlobalLock; 497 ACPI_ACQUIRE_GLOBAL_LOCK (GlobalLock, Acquired); 498 if (Acquired) 499 { 500 /* We got the lock */ 501 502 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Acquired the Global Lock\n")); 503 504 AcpiGbl_GlobalLockAcquired = TRUE; 505 return_ACPI_STATUS (AE_OK); 506 } 507 508 509 /* 510 * Did not get the lock. The pending bit was set above, and we must now 511 * wait until we get the global lock released interrupt. 512 */ 513 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Waiting for the HW Global Lock\n")); 514 515 /* 516 * Acquire the global lock semaphore first. 517 * Since this wait will block, we must release the interpreter 518 */ 519 Status = AcpiExSystemWaitSemaphore (AcpiGbl_GlobalLockSemaphore, 520 ACPI_UINT32_MAX); 521 return_ACPI_STATUS (Status); 522} 523 524 525/******************************************************************************* 526 * 527 * FUNCTION: AcpiEvReleaseGlobalLock 528 * 529 * DESCRIPTION: Releases ownership of the Global Lock. 530 * 531 ******************************************************************************/ 532 533void 534AcpiEvReleaseGlobalLock (void) 535{ 536 BOOLEAN Pending = FALSE; 537 void *GlobalLock; 538 539 540 FUNCTION_TRACE ("EvReleaseGlobalLock"); 541 542 543 if (!AcpiGbl_GlobalLockThreadCount) 544 { 545 REPORT_WARNING(("Global Lock has not be acquired, cannot release\n")); 546 return_VOID; 547 } 548 549 /* One fewer thread has the global lock */ 550 551 AcpiGbl_GlobalLockThreadCount--; 552 553 /* Have all threads released the lock? */ 554 555 if (!AcpiGbl_GlobalLockThreadCount) 556 { 557 /* 558 * No more threads holding lock, we can do the actual hardware 559 * release 560 */ 561 GlobalLock = AcpiGbl_FACS->GlobalLock; 562 ACPI_RELEASE_GLOBAL_LOCK (GlobalLock, Pending); 563 AcpiGbl_GlobalLockAcquired = FALSE; 564 565 /* 566 * If the pending bit was set, we must write GBL_RLS to the control 567 * register 568 */ 569 if (Pending) 570 { 571 AcpiHwRegisterBitAccess (ACPI_WRITE, ACPI_MTX_LOCK, 572 GBL_RLS, 1); 573 } 574 } 575 576 return_VOID; 577} 578