1 /****************************************************************************** 2 * 3 * Module Name: evgpeutil - GPE utilities 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #include "acpi.h" 117 #include "accommon.h" 118 #include "acevents.h" 119 120 #define _COMPONENT ACPI_EVENTS 121 ACPI_MODULE_NAME ("evgpeutil") 122 123 124 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */ 125 /******************************************************************************* 126 * 127 * FUNCTION: AcpiEvWalkGpeList 128 * 129 * PARAMETERS: GpeWalkCallback - Routine called for each GPE block 130 * Context - Value passed to callback 131 * 132 * RETURN: Status 133 * 134 * DESCRIPTION: Walk the GPE lists. 135 * 136 ******************************************************************************/ 137 138 ACPI_STATUS 139 AcpiEvWalkGpeList ( 140 ACPI_GPE_CALLBACK GpeWalkCallback, 141 void *Context) 142 { 143 ACPI_GPE_BLOCK_INFO *GpeBlock; 144 ACPI_GPE_XRUPT_INFO *GpeXruptInfo; 145 ACPI_STATUS Status = AE_OK; 146 ACPI_CPU_FLAGS Flags; 147 148 149 ACPI_FUNCTION_TRACE (EvWalkGpeList); 150 151 152 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock); 153 154 /* Walk the interrupt level descriptor list */ 155 156 GpeXruptInfo = AcpiGbl_GpeXruptListHead; 157 while (GpeXruptInfo) 158 { 159 /* Walk all Gpe Blocks attached to this interrupt level */ 160 161 GpeBlock = GpeXruptInfo->GpeBlockListHead; 162 while (GpeBlock) 163 { 164 /* One callback per GPE block */ 165 166 Status = GpeWalkCallback (GpeXruptInfo, GpeBlock, Context); 167 if (ACPI_FAILURE (Status)) 168 { 169 if (Status == AE_CTRL_END) /* Callback abort */ 170 { 171 Status = AE_OK; 172 } 173 goto UnlockAndExit; 174 } 175 176 GpeBlock = GpeBlock->Next; 177 } 178 179 GpeXruptInfo = GpeXruptInfo->Next; 180 } 181 182 UnlockAndExit: 183 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags); 184 return_ACPI_STATUS (Status); 185 } 186 187 188 /******************************************************************************* 189 * 190 * FUNCTION: AcpiEvValidGpeEvent 191 * 192 * PARAMETERS: GpeEventInfo - Info for this GPE 193 * 194 * RETURN: TRUE if the GpeEvent is valid 195 * 196 * DESCRIPTION: Validate a GPE event. DO NOT CALL FROM INTERRUPT LEVEL. 197 * Should be called only when the GPE lists are semaphore locked 198 * and not subject to change. 199 * 200 ******************************************************************************/ 201 202 BOOLEAN 203 AcpiEvValidGpeEvent ( 204 ACPI_GPE_EVENT_INFO *GpeEventInfo) 205 { 206 ACPI_GPE_XRUPT_INFO *GpeXruptBlock; 207 ACPI_GPE_BLOCK_INFO *GpeBlock; 208 209 210 ACPI_FUNCTION_ENTRY (); 211 212 213 /* No need for spin lock since we are not changing any list elements */ 214 215 /* Walk the GPE interrupt levels */ 216 217 GpeXruptBlock = AcpiGbl_GpeXruptListHead; 218 while (GpeXruptBlock) 219 { 220 GpeBlock = GpeXruptBlock->GpeBlockListHead; 221 222 /* Walk the GPE blocks on this interrupt level */ 223 224 while (GpeBlock) 225 { 226 if ((&GpeBlock->EventInfo[0] <= GpeEventInfo) && 227 (&GpeBlock->EventInfo[GpeBlock->GpeCount] > GpeEventInfo)) 228 { 229 return (TRUE); 230 } 231 232 GpeBlock = GpeBlock->Next; 233 } 234 235 GpeXruptBlock = GpeXruptBlock->Next; 236 } 237 238 return (FALSE); 239 } 240 241 242 /******************************************************************************* 243 * 244 * FUNCTION: AcpiEvGetGpeDevice 245 * 246 * PARAMETERS: GPE_WALK_CALLBACK 247 * 248 * RETURN: Status 249 * 250 * DESCRIPTION: Matches the input GPE index (0-CurrentGpeCount) with a GPE 251 * block device. NULL if the GPE is one of the FADT-defined GPEs. 252 * 253 ******************************************************************************/ 254 255 ACPI_STATUS 256 AcpiEvGetGpeDevice ( 257 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 258 ACPI_GPE_BLOCK_INFO *GpeBlock, 259 void *Context) 260 { 261 ACPI_GPE_DEVICE_INFO *Info = Context; 262 263 264 /* Increment Index by the number of GPEs in this block */ 265 266 Info->NextBlockBaseIndex += GpeBlock->GpeCount; 267 268 if (Info->Index < Info->NextBlockBaseIndex) 269 { 270 /* 271 * The GPE index is within this block, get the node. Leave the node 272 * NULL for the FADT-defined GPEs 273 */ 274 if ((GpeBlock->Node)->Type == ACPI_TYPE_DEVICE) 275 { 276 Info->GpeDevice = GpeBlock->Node; 277 } 278 279 Info->Status = AE_OK; 280 return (AE_CTRL_END); 281 } 282 283 return (AE_OK); 284 } 285 286 287 /******************************************************************************* 288 * 289 * FUNCTION: AcpiEvGetGpeXruptBlock 290 * 291 * PARAMETERS: InterruptNumber - Interrupt for a GPE block 292 * GpeXruptBlock - Where the block is returned 293 * 294 * RETURN: Status 295 * 296 * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt 297 * block per unique interrupt level used for GPEs. Should be 298 * called only when the GPE lists are semaphore locked and not 299 * subject to change. 300 * 301 ******************************************************************************/ 302 303 ACPI_STATUS 304 AcpiEvGetGpeXruptBlock ( 305 UINT32 InterruptNumber, 306 ACPI_GPE_XRUPT_INFO **GpeXruptBlock) 307 { 308 ACPI_GPE_XRUPT_INFO *NextGpeXrupt; 309 ACPI_GPE_XRUPT_INFO *GpeXrupt; 310 ACPI_STATUS Status; 311 ACPI_CPU_FLAGS Flags; 312 313 314 ACPI_FUNCTION_TRACE (EvGetGpeXruptBlock); 315 316 317 /* No need for lock since we are not changing any list elements here */ 318 319 NextGpeXrupt = AcpiGbl_GpeXruptListHead; 320 while (NextGpeXrupt) 321 { 322 if (NextGpeXrupt->InterruptNumber == InterruptNumber) 323 { 324 *GpeXruptBlock = NextGpeXrupt; 325 return_ACPI_STATUS (AE_OK); 326 } 327 328 NextGpeXrupt = NextGpeXrupt->Next; 329 } 330 331 /* Not found, must allocate a new xrupt descriptor */ 332 333 GpeXrupt = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_XRUPT_INFO)); 334 if (!GpeXrupt) 335 { 336 return_ACPI_STATUS (AE_NO_MEMORY); 337 } 338 339 GpeXrupt->InterruptNumber = InterruptNumber; 340 341 /* Install new interrupt descriptor with spin lock */ 342 343 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock); 344 if (AcpiGbl_GpeXruptListHead) 345 { 346 NextGpeXrupt = AcpiGbl_GpeXruptListHead; 347 while (NextGpeXrupt->Next) 348 { 349 NextGpeXrupt = NextGpeXrupt->Next; 350 } 351 352 NextGpeXrupt->Next = GpeXrupt; 353 GpeXrupt->Previous = NextGpeXrupt; 354 } 355 else 356 { 357 AcpiGbl_GpeXruptListHead = GpeXrupt; 358 } 359 360 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags); 361 362 /* Install new interrupt handler if not SCI_INT */ 363 364 if (InterruptNumber != AcpiGbl_FADT.SciInterrupt) 365 { 366 Status = AcpiOsInstallInterruptHandler (InterruptNumber, 367 AcpiEvGpeXruptHandler, GpeXrupt); 368 if (ACPI_FAILURE (Status)) 369 { 370 ACPI_EXCEPTION ((AE_INFO, Status, 371 "Could not install GPE interrupt handler at level 0x%X", 372 InterruptNumber)); 373 return_ACPI_STATUS (Status); 374 } 375 } 376 377 *GpeXruptBlock = GpeXrupt; 378 return_ACPI_STATUS (AE_OK); 379 } 380 381 382 /******************************************************************************* 383 * 384 * FUNCTION: AcpiEvDeleteGpeXrupt 385 * 386 * PARAMETERS: GpeXrupt - A GPE interrupt info block 387 * 388 * RETURN: Status 389 * 390 * DESCRIPTION: Remove and free a GpeXrupt block. Remove an associated 391 * interrupt handler if not the SCI interrupt. 392 * 393 ******************************************************************************/ 394 395 ACPI_STATUS 396 AcpiEvDeleteGpeXrupt ( 397 ACPI_GPE_XRUPT_INFO *GpeXrupt) 398 { 399 ACPI_STATUS Status; 400 ACPI_CPU_FLAGS Flags; 401 402 403 ACPI_FUNCTION_TRACE (EvDeleteGpeXrupt); 404 405 406 /* We never want to remove the SCI interrupt handler */ 407 408 if (GpeXrupt->InterruptNumber == AcpiGbl_FADT.SciInterrupt) 409 { 410 GpeXrupt->GpeBlockListHead = NULL; 411 return_ACPI_STATUS (AE_OK); 412 } 413 414 /* Disable this interrupt */ 415 416 Status = AcpiOsRemoveInterruptHandler ( 417 GpeXrupt->InterruptNumber, AcpiEvGpeXruptHandler); 418 if (ACPI_FAILURE (Status)) 419 { 420 return_ACPI_STATUS (Status); 421 } 422 423 /* Unlink the interrupt block with lock */ 424 425 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock); 426 if (GpeXrupt->Previous) 427 { 428 GpeXrupt->Previous->Next = GpeXrupt->Next; 429 } 430 else 431 { 432 /* No previous, update list head */ 433 434 AcpiGbl_GpeXruptListHead = GpeXrupt->Next; 435 } 436 437 if (GpeXrupt->Next) 438 { 439 GpeXrupt->Next->Previous = GpeXrupt->Previous; 440 } 441 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags); 442 443 /* Free the block */ 444 445 ACPI_FREE (GpeXrupt); 446 return_ACPI_STATUS (AE_OK); 447 } 448 449 450 /******************************************************************************* 451 * 452 * FUNCTION: AcpiEvDeleteGpeHandlers 453 * 454 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 455 * GpeBlock - Gpe Block info 456 * 457 * RETURN: Status 458 * 459 * DESCRIPTION: Delete all Handler objects found in the GPE data structs. 460 * Used only prior to termination. 461 * 462 ******************************************************************************/ 463 464 ACPI_STATUS 465 AcpiEvDeleteGpeHandlers ( 466 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 467 ACPI_GPE_BLOCK_INFO *GpeBlock, 468 void *Context) 469 { 470 ACPI_GPE_EVENT_INFO *GpeEventInfo; 471 ACPI_GPE_NOTIFY_INFO *Notify; 472 ACPI_GPE_NOTIFY_INFO *Next; 473 UINT32 i; 474 UINT32 j; 475 476 477 ACPI_FUNCTION_TRACE (EvDeleteGpeHandlers); 478 479 480 /* Examine each GPE Register within the block */ 481 482 for (i = 0; i < GpeBlock->RegisterCount; i++) 483 { 484 /* Now look at the individual GPEs in this byte register */ 485 486 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) 487 { 488 GpeEventInfo = &GpeBlock->EventInfo[((ACPI_SIZE) i * 489 ACPI_GPE_REGISTER_WIDTH) + j]; 490 491 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) == 492 ACPI_GPE_DISPATCH_HANDLER) 493 { 494 /* Delete an installed handler block */ 495 496 ACPI_FREE (GpeEventInfo->Dispatch.Handler); 497 GpeEventInfo->Dispatch.Handler = NULL; 498 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK; 499 } 500 else if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) == 501 ACPI_GPE_DISPATCH_NOTIFY) 502 { 503 /* Delete the implicit notification device list */ 504 505 Notify = GpeEventInfo->Dispatch.NotifyList; 506 while (Notify) 507 { 508 Next = Notify->Next; 509 ACPI_FREE (Notify); 510 Notify = Next; 511 } 512 GpeEventInfo->Dispatch.NotifyList = NULL; 513 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK; 514 } 515 } 516 } 517 518 return_ACPI_STATUS (AE_OK); 519 } 520 521 #endif /* !ACPI_REDUCED_HARDWARE */ 522