evgpe.c revision 114239
1/****************************************************************************** 2 * 3 * Module Name: evgpe - General Purpose Event handling and dispatch 4 * $Revision: 12 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#include "acpi.h" 118#include "acevents.h" 119#include "acnamesp.h" 120 121#define _COMPONENT ACPI_EVENTS 122 ACPI_MODULE_NAME ("evgpe") 123 124 125/******************************************************************************* 126 * 127 * FUNCTION: AcpiEvGetGpeEventInfo 128 * 129 * PARAMETERS: GpeNumber - Raw GPE number 130 * 131 * RETURN: None. 132 * 133 * DESCRIPTION: Returns the EventInfo struct 134 * associated with this GPE. 135 * 136 * TBD: this function will go away when full support of GPE block devices 137 * is implemented! 138 * 139 ******************************************************************************/ 140 141ACPI_GPE_EVENT_INFO * 142AcpiEvGetGpeEventInfo ( 143 UINT32 GpeNumber) 144{ 145 ACPI_GPE_BLOCK_INFO *GpeBlock; 146 147 148 /* Examine GPE Block 0 */ 149 150 GpeBlock = AcpiGbl_GpeBlockListHead; 151 if (!GpeBlock) 152 { 153 return (NULL); 154 } 155 156 if ((GpeNumber >= GpeBlock->BlockBaseNumber) && 157 (GpeNumber < GpeBlock->BlockBaseNumber + (GpeBlock->RegisterCount * 8))) 158 { 159 return (&GpeBlock->EventInfo[GpeNumber - GpeBlock->BlockBaseNumber]); 160 } 161 162 /* Examine GPE Block 1 */ 163 164 GpeBlock = GpeBlock->Next; 165 if (!GpeBlock) 166 { 167 return (NULL); 168 } 169 170 if ((GpeNumber >= GpeBlock->BlockBaseNumber) && 171 (GpeNumber < GpeBlock->BlockBaseNumber + (GpeBlock->RegisterCount * 8))) 172 { 173 return (&GpeBlock->EventInfo[GpeNumber - GpeBlock->BlockBaseNumber]); 174 } 175 176 return (NULL); 177} 178 179/******************************************************************************* 180 * 181 * FUNCTION: AcpiEvGpeDetect 182 * 183 * PARAMETERS: None 184 * 185 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED 186 * 187 * DESCRIPTION: Detect if any GP events have occurred. This function is 188 * executed at interrupt level. 189 * 190 ******************************************************************************/ 191 192UINT32 193AcpiEvGpeDetect (void) 194{ 195 UINT32 IntStatus = ACPI_INTERRUPT_NOT_HANDLED; 196 UINT32 i; 197 UINT32 j; 198 UINT8 EnabledStatusByte; 199 UINT8 BitMask; 200 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 201 UINT32 InValue; 202 ACPI_STATUS Status; 203 ACPI_GPE_BLOCK_INFO *GpeBlock; 204 205 206 ACPI_FUNCTION_NAME ("EvGpeDetect"); 207 208 209 /* Examine all GPE blocks attached to this interrupt level */ 210 211 GpeBlock = AcpiGbl_GpeBlockListHead; 212 while (GpeBlock) 213 { 214 /* 215 * Read all of the 8-bit GPE status and enable registers 216 * in this GPE block, saving all of them. 217 * Find all currently active GP events. 218 */ 219 for (i = 0; i < GpeBlock->RegisterCount; i++) 220 { 221 /* Get the next status/enable pair */ 222 223 GpeRegisterInfo = &GpeBlock->RegisterInfo[i]; 224 225 Status = AcpiHwLowLevelRead (ACPI_GPE_REGISTER_WIDTH, &InValue, 226 &GpeRegisterInfo->StatusAddress, 0); 227 GpeRegisterInfo->Status = (UINT8) InValue; 228 if (ACPI_FAILURE (Status)) 229 { 230 return (ACPI_INTERRUPT_NOT_HANDLED); 231 } 232 233 Status = AcpiHwLowLevelRead (ACPI_GPE_REGISTER_WIDTH, &InValue, 234 &GpeRegisterInfo->EnableAddress, 0); 235 GpeRegisterInfo->Enable = (UINT8) InValue; 236 if (ACPI_FAILURE (Status)) 237 { 238 return (ACPI_INTERRUPT_NOT_HANDLED); 239 } 240 241 ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS, 242 "GPE block at %8.8X%8.8X - Values: Enable %02X Status %02X\n", 243 ACPI_HIDWORD (ACPI_GET_ADDRESS (GpeRegisterInfo->EnableAddress.Address)), 244 ACPI_LODWORD (ACPI_GET_ADDRESS (GpeRegisterInfo->EnableAddress.Address)), 245 GpeRegisterInfo->Enable, 246 GpeRegisterInfo->Status)); 247 248 /* First check if there is anything active at all in this register */ 249 250 EnabledStatusByte = (UINT8) (GpeRegisterInfo->Status & 251 GpeRegisterInfo->Enable); 252 if (!EnabledStatusByte) 253 { 254 /* No active GPEs in this register, move on */ 255 256 continue; 257 } 258 259 /* Now look at the individual GPEs in this byte register */ 260 261 for (j = 0, BitMask = 1; j < ACPI_GPE_REGISTER_WIDTH; j++, BitMask <<= 1) 262 { 263 /* Examine one GPE bit */ 264 265 if (EnabledStatusByte & BitMask) 266 { 267 /* 268 * Found an active GPE. Dispatch the event to a handler 269 * or method. 270 */ 271 IntStatus |= AcpiEvGpeDispatch ( 272 &GpeBlock->EventInfo[(i * ACPI_GPE_REGISTER_WIDTH) +j]); 273 } 274 } 275 } 276 277 GpeBlock = GpeBlock->Next; 278 } 279 280 return (IntStatus); 281} 282 283 284/******************************************************************************* 285 * 286 * FUNCTION: AcpiEvAsynchExecuteGpeMethod 287 * 288 * PARAMETERS: GpeEventInfo - Info for this GPE 289 * 290 * RETURN: None 291 * 292 * DESCRIPTION: Perform the actual execution of a GPE control method. This 293 * function is called from an invocation of AcpiOsQueueForExecution 294 * (and therefore does NOT execute at interrupt level) so that 295 * the control method itself is not executed in the context of 296 * the SCI interrupt handler. 297 * 298 ******************************************************************************/ 299 300static void ACPI_SYSTEM_XFACE 301AcpiEvAsynchExecuteGpeMethod ( 302 void *Context) 303{ 304 ACPI_GPE_EVENT_INFO *GpeEventInfo = (void *) Context; 305 UINT32 GpeNumber = 0; 306 ACPI_STATUS Status; 307 308 309 ACPI_FUNCTION_TRACE ("EvAsynchExecuteGpeMethod"); 310 311 312 /* 313 * Take a snapshot of the GPE info for this level - we copy the 314 * info to prevent a race condition with RemoveHandler. 315 */ 316 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS); 317 if (ACPI_FAILURE (Status)) 318 { 319 return_VOID; 320 } 321 322 Status = AcpiUtReleaseMutex (ACPI_MTX_EVENTS); 323 if (ACPI_FAILURE (Status)) 324 { 325 return_VOID; 326 } 327 328 if (GpeEventInfo->MethodNode) 329 { 330 /* 331 * Invoke the GPE Method (_Lxx, _Exx): 332 * (Evaluate the _Lxx/_Exx control method that corresponds to this GPE.) 333 */ 334 Status = AcpiNsEvaluateByHandle (GpeEventInfo->MethodNode, NULL, NULL); 335 if (ACPI_FAILURE (Status)) 336 { 337 ACPI_REPORT_ERROR (("%s while evaluating method [%4.4s] for GPE[%2.2X]\n", 338 AcpiFormatException (Status), 339 GpeEventInfo->MethodNode->Name.Ascii, GpeNumber)); 340 } 341 } 342 343 if (GpeEventInfo->Type & ACPI_EVENT_LEVEL_TRIGGERED) 344 { 345 /* 346 * GPE is level-triggered, we clear the GPE status bit after handling 347 * the event. 348 */ 349 Status = AcpiHwClearGpe (GpeEventInfo); 350 if (ACPI_FAILURE (Status)) 351 { 352 return_VOID; 353 } 354 } 355 356 /* Enable this GPE */ 357 358 (void) AcpiHwEnableGpe (GpeEventInfo); 359 return_VOID; 360} 361 362 363/******************************************************************************* 364 * 365 * FUNCTION: AcpiEvGpeDispatch 366 * 367 * PARAMETERS: GpeEventInfo - info for this GPE 368 * 369 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED 370 * 371 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC) 372 * or method (e.g. _Lxx/_Exx) handler. This function executes 373 * at interrupt level. 374 * 375 ******************************************************************************/ 376 377UINT32 378AcpiEvGpeDispatch ( 379 ACPI_GPE_EVENT_INFO *GpeEventInfo) 380{ 381 UINT32 GpeNumber = 0; /* TBD: remove */ 382 ACPI_STATUS Status; 383 384 385 ACPI_FUNCTION_TRACE ("EvGpeDispatch"); 386 387 388 /* 389 * If edge-triggered, clear the GPE status bit now. Note that 390 * level-triggered events are cleared after the GPE is serviced. 391 */ 392 if (GpeEventInfo->Type & ACPI_EVENT_EDGE_TRIGGERED) 393 { 394 Status = AcpiHwClearGpe (GpeEventInfo); 395 if (ACPI_FAILURE (Status)) 396 { 397 ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to clear GPE[%2.2X]\n", 398 GpeNumber)); 399 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 400 } 401 } 402 403 /* 404 * Dispatch the GPE to either an installed handler, or the control 405 * method associated with this GPE (_Lxx or _Exx). 406 * If a handler exists, we invoke it and do not attempt to run the method. 407 * If there is neither a handler nor a method, we disable the level to 408 * prevent further events from coming in here. 409 */ 410 if (GpeEventInfo->Handler) 411 { 412 /* Invoke the installed handler (at interrupt level) */ 413 414 GpeEventInfo->Handler (GpeEventInfo->Context); 415 } 416 else if (GpeEventInfo->MethodNode) 417 { 418 /* 419 * Disable GPE, so it doesn't keep firing before the method has a 420 * chance to run. 421 */ 422 Status = AcpiHwDisableGpe (GpeEventInfo); 423 if (ACPI_FAILURE (Status)) 424 { 425 ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to disable GPE[%2.2X]\n", 426 GpeNumber)); 427 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 428 } 429 430 /* 431 * Execute the method associated with the GPE. 432 */ 433 if (ACPI_FAILURE (AcpiOsQueueForExecution (OSD_PRIORITY_GPE, 434 AcpiEvAsynchExecuteGpeMethod, 435 GpeEventInfo))) 436 { 437 ACPI_REPORT_ERROR (( 438 "AcpiEvGpeDispatch: Unable to queue handler for GPE[%2.2X], event is disabled\n", 439 GpeNumber)); 440 } 441 } 442 else 443 { 444 /* No handler or method to run! */ 445 446 ACPI_REPORT_ERROR (( 447 "AcpiEvGpeDispatch: No handler or method for GPE[%2.2X], disabling event\n", 448 GpeNumber)); 449 450 /* 451 * Disable the GPE. The GPE will remain disabled until the ACPI 452 * Core Subsystem is restarted, or the handler is reinstalled. 453 */ 454 Status = AcpiHwDisableGpe (GpeEventInfo); 455 if (ACPI_FAILURE (Status)) 456 { 457 ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to disable GPE[%2.2X]\n", 458 GpeNumber)); 459 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 460 } 461 } 462 463 /* 464 * It is now safe to clear level-triggered evnets. 465 */ 466 if (GpeEventInfo->Type & ACPI_EVENT_LEVEL_TRIGGERED) 467 { 468 Status = AcpiHwClearGpe (GpeEventInfo); 469 if (ACPI_FAILURE (Status)) 470 { 471 ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to clear GPE[%2.2X]\n", 472 GpeNumber)); 473 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 474 } 475 } 476 477 return_VALUE (ACPI_INTERRUPT_HANDLED); 478} 479 480