evmisc.c revision 69450
1/****************************************************************************** 2 * 3 * Module Name: evmisc - ACPI device notification handler dispatch 4 * and ACPI Global Lock support 5 * $Revision: 19 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 14 * 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 EVENT_HANDLING 125 MODULE_NAME ("evmisc") 126 127 128/************************************************************************** 129 * 130 * FUNCTION: AcpiEvNotifyDispatch 131 * 132 * PARAMETERS: 133 * 134 * RETURN: None. 135 * 136 * DESCRIPTION: Dispatch a device notification event to a previously 137 * installed handler. 138 * 139 *************************************************************************/ 140 141void 142AcpiEvNotifyDispatch ( 143 ACPI_HANDLE Device, 144 UINT32 NotifyValue) 145{ 146 ACPI_OPERAND_OBJECT *ObjDesc; 147 ACPI_OPERAND_OBJECT *HandlerObj; 148 NOTIFY_HANDLER Handler; 149 150 151 /* 152 * For value 1 (Ejection Request), some device method may need to be run. 153 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need to be run. 154 * For value 0x80 (Status Change) on the power button or sleep button, 155 * initiate soft-off or sleep operation? 156 */ 157 158 159 DEBUG_PRINT (ACPI_INFO, 160 ("Dispatching Notify(%d) on device %p\n", NotifyValue, Device)); 161 162 switch (NotifyValue) 163 { 164 case 0: 165 DEBUG_PRINT (ACPI_INFO, ("Notify value: Re-enumerate Devices\n")); 166 break; 167 168 case 1: 169 DEBUG_PRINT (ACPI_INFO, ("Notify value: Ejection Request\n")); 170 break; 171 172 case 2: 173 DEBUG_PRINT (ACPI_INFO, ("Notify value: Device Wake\n")); 174 break; 175 176 case 0x80: 177 DEBUG_PRINT (ACPI_INFO, ("Notify value: Status Change\n")); 178 break; 179 180 default: 181 DEBUG_PRINT (ACPI_INFO, ("Unknown Notify Value: %lx \n", NotifyValue)); 182 break; 183 } 184 185 186 /* 187 * Invoke a global notify handler if installed. 188 * This is done _before_ we invoke the per-device handler attached to the device. 189 */ 190 191 if (NotifyValue <= MAX_SYS_NOTIFY) 192 { 193 /* Global system notification handler */ 194 195 if (AcpiGbl_SysNotify.Handler) 196 { 197 AcpiGbl_SysNotify.Handler (Device, NotifyValue, 198 AcpiGbl_SysNotify.Context); 199 } 200 } 201 202 else 203 { 204 /* Global driver notification handler */ 205 206 if (AcpiGbl_DrvNotify.Handler) 207 { 208 AcpiGbl_DrvNotify.Handler (Device, NotifyValue, 209 AcpiGbl_DrvNotify.Context); 210 } 211 } 212 213 214 /* 215 * Get the notify object which must be attached to the device Node 216 */ 217 218 ObjDesc = AcpiNsGetAttachedObject ((ACPI_HANDLE) Device); 219 if (!ObjDesc) 220 { 221 /* There can be no notify handler for this device */ 222 223 DEBUG_PRINT (ACPI_INFO, 224 ("No notify handler for device %p \n", Device)); 225 return; 226 } 227 228 229 /* We have the notify object, Get the right handler */ 230 231 if (NotifyValue <= MAX_SYS_NOTIFY) 232 { 233 HandlerObj = ObjDesc->Device.SysHandler; 234 } 235 else 236 { 237 HandlerObj = ObjDesc->Device.DrvHandler; 238 } 239 240 /* Validate the handler */ 241 242 if (!HandlerObj) 243 { 244 /* There is no notify handler for this device */ 245 246 DEBUG_PRINT (ACPI_INFO, 247 ("No notify handler for device %p \n", Device)); 248 return; 249 } 250 251 /* There is a handler, invoke it */ 252 253 Handler = HandlerObj->NotifyHandler.Handler; 254 Handler (Device, NotifyValue, HandlerObj->NotifyHandler.Context); 255 256} 257 258 259/*************************************************************************** 260 * 261 * FUNCTION: AcpiEvGlobalLockThread 262 * 263 * RETURN: None 264 * 265 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the 266 * Global Lock. Simply signal all threads that are waiting 267 * for the lock. 268 * 269 **************************************************************************/ 270 271static void 272AcpiEvGlobalLockThread ( 273 void *Context) 274{ 275 276 /* Signal threads that are waiting for the lock */ 277 278 if (AcpiGbl_GlobalLockThreadCount) 279 { 280 /* Send sufficient units to the semaphore */ 281 282 AcpiOsSignalSemaphore (AcpiGbl_GlobalLockSemaphore, 283 AcpiGbl_GlobalLockThreadCount); 284 } 285} 286 287 288/*************************************************************************** 289 * 290 * FUNCTION: AcpiEvGlobalLockHandler 291 * 292 * RETURN: Status 293 * 294 * DESCRIPTION: Invoked directly from the SCI handler when a global lock 295 * release interrupt occurs. Grab the global lock and queue 296 * the global lock thread for execution 297 * 298 **************************************************************************/ 299 300static UINT32 301AcpiEvGlobalLockHandler ( 302 void *Context) 303{ 304 BOOLEAN Acquired = FALSE; 305 void *GlobalLock; 306 307 308 /* 309 * Attempt to get the lock 310 * If we don't get it now, it will be marked pending and we will 311 * take another interrupt when it becomes free. 312 */ 313 314 GlobalLock = AcpiGbl_FACS->GlobalLock; 315 ACPI_ACQUIRE_GLOBAL_LOCK (GlobalLock, Acquired); 316 if (Acquired) 317 { 318 /* Got the lock, now wake all threads waiting for it */ 319 320 AcpiGbl_GlobalLockAcquired = TRUE; 321 322 /* Run the Global Lock thread which will signal all waiting threads */ 323 324 AcpiOsQueueForExecution (OSD_PRIORITY_HIGH, AcpiEvGlobalLockThread, 325 Context); 326 } 327 328 return (INTERRUPT_HANDLED); 329} 330 331 332/*************************************************************************** 333 * 334 * FUNCTION: AcpiEvInitGlobalLockHandler 335 * 336 * RETURN: Status 337 * 338 * DESCRIPTION: Install a handler for the global lock release event 339 * 340 **************************************************************************/ 341 342ACPI_STATUS 343AcpiEvInitGlobalLockHandler (void) 344{ 345 ACPI_STATUS Status; 346 347 348 FUNCTION_TRACE ("EvInitGlobalLockHandler"); 349 350 351 Status = AcpiInstallFixedEventHandler (ACPI_EVENT_GLOBAL, 352 AcpiEvGlobalLockHandler, NULL); 353 354 return_ACPI_STATUS (Status); 355} 356 357 358/*************************************************************************** 359 * 360 * FUNCTION: AcpiEvAcquireGlobalLock 361 * 362 * RETURN: Status 363 * 364 * DESCRIPTION: Attempt to gain ownership of the Global Lock. 365 * 366 **************************************************************************/ 367 368ACPI_STATUS 369AcpiEvAcquireGlobalLock(void) 370{ 371 ACPI_STATUS Status = AE_OK; 372 BOOLEAN Acquired = FALSE; 373 void *GlobalLock; 374 375 376 FUNCTION_TRACE ("EvAcquireGlobalLock"); 377 378 379 /* One more thread wants the global lock */ 380 381 AcpiGbl_GlobalLockThreadCount++; 382 383 384 /* If we (OS side) have the hardware lock already, we are done */ 385 386 if (AcpiGbl_GlobalLockAcquired) 387 { 388 return_ACPI_STATUS (AE_OK); 389 } 390 391 /* Only if the FACS is valid */ 392 393 if (!AcpiGbl_FACS) 394 { 395 return_ACPI_STATUS (AE_OK); 396 } 397 398 399 /* We must acquire the actual hardware lock */ 400 401 GlobalLock = AcpiGbl_FACS->GlobalLock; 402 ACPI_ACQUIRE_GLOBAL_LOCK (GlobalLock, Acquired); 403 if (Acquired) 404 { 405 /* We got the lock */ 406 407 DEBUG_PRINT (ACPI_INFO, ("Acquired the HW Global Lock\n")); 408 409 AcpiGbl_GlobalLockAcquired = TRUE; 410 411 return_ACPI_STATUS (AE_OK); 412 } 413 414 415 /* 416 * Did not get the lock. The pending bit was set above, and we must now 417 * wait until we get the global lock released interrupt. 418 */ 419 420 DEBUG_PRINT (ACPI_INFO, ("Waiting for the HW Global Lock\n")); 421 422 /* 423 * Acquire the global lock semaphore first. 424 * Since this wait will block, we must release the interpreter 425 */ 426 427 Status = AcpiAmlSystemWaitSemaphore (AcpiGbl_GlobalLockSemaphore, 428 ACPI_UINT32_MAX); 429 430 return_ACPI_STATUS (Status); 431} 432 433 434/*************************************************************************** 435 * 436 * FUNCTION: AcpiEvReleaseGlobalLock 437 * 438 * DESCRIPTION: Releases ownership of the Global Lock. 439 * 440 **************************************************************************/ 441 442void 443AcpiEvReleaseGlobalLock (void) 444{ 445 BOOLEAN Pending = FALSE; 446 void *GlobalLock; 447 448 449 FUNCTION_TRACE ("EvReleaseGlobalLock"); 450 451 if (!AcpiGbl_GlobalLockThreadCount) 452 { 453 REPORT_WARNING(("Releasing a non-acquired Global Lock\n")); 454 return_VOID; 455 } 456 457 /* One fewer thread has the global lock */ 458 459 AcpiGbl_GlobalLockThreadCount--; 460 461 /* Have all threads released the lock? */ 462 463 if (!AcpiGbl_GlobalLockThreadCount) 464 { 465 /* 466 * No more threads holding lock, we can do the actual hardware 467 * release 468 */ 469 470 GlobalLock = AcpiGbl_FACS->GlobalLock; 471 ACPI_RELEASE_GLOBAL_LOCK (GlobalLock, Pending); 472 AcpiGbl_GlobalLockAcquired = FALSE; 473 474 /* 475 * If the pending bit was set, we must write GBL_RLS to the control 476 * register 477 */ 478 if (Pending) 479 { 480 AcpiHwRegisterBitAccess (ACPI_WRITE, ACPI_MTX_LOCK, 481 GBL_RLS, 1); 482 } 483 } 484 485 return_VOID; 486} 487