1 /******************************************************************************
3 * Module Name: evgpeutil - GPE utilities
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
117 #include "accommon.h"
118 #include "acevents.h"
120 #define _COMPONENT ACPI_EVENTS
121 ACPI_MODULE_NAME ("evgpeutil")
124 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
125 /*******************************************************************************
127 * FUNCTION: AcpiEvWalkGpeList
129 * PARAMETERS: GpeWalkCallback - Routine called for each GPE block
130 * Context - Value passed to callback
134 * DESCRIPTION: Walk the GPE lists.
136 ******************************************************************************/
140 ACPI_GPE_CALLBACK GpeWalkCallback,
143 ACPI_GPE_BLOCK_INFO *GpeBlock;
144 ACPI_GPE_XRUPT_INFO *GpeXruptInfo;
145 ACPI_STATUS Status = AE_OK;
146 ACPI_CPU_FLAGS Flags;
149 ACPI_FUNCTION_TRACE (EvWalkGpeList);
152 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
154 /* Walk the interrupt level descriptor list */
156 GpeXruptInfo = AcpiGbl_GpeXruptListHead;
159 /* Walk all Gpe Blocks attached to this interrupt level */
161 GpeBlock = GpeXruptInfo->GpeBlockListHead;
164 /* One callback per GPE block */
166 Status = GpeWalkCallback (GpeXruptInfo, GpeBlock, Context);
167 if (ACPI_FAILURE (Status))
169 if (Status == AE_CTRL_END) /* Callback abort */
176 GpeBlock = GpeBlock->Next;
179 GpeXruptInfo = GpeXruptInfo->Next;
183 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
184 return_ACPI_STATUS (Status);
188 /*******************************************************************************
190 * FUNCTION: AcpiEvGetGpeDevice
192 * PARAMETERS: GPE_WALK_CALLBACK
196 * DESCRIPTION: Matches the input GPE index (0-CurrentGpeCount) with a GPE
197 * block device. NULL if the GPE is one of the FADT-defined GPEs.
199 ******************************************************************************/
203 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
204 ACPI_GPE_BLOCK_INFO *GpeBlock,
207 ACPI_GPE_DEVICE_INFO *Info = Context;
210 /* Increment Index by the number of GPEs in this block */
212 Info->NextBlockBaseIndex += GpeBlock->GpeCount;
214 if (Info->Index < Info->NextBlockBaseIndex)
217 * The GPE index is within this block, get the node. Leave the node
218 * NULL for the FADT-defined GPEs
220 if ((GpeBlock->Node)->Type == ACPI_TYPE_DEVICE)
222 Info->GpeDevice = GpeBlock->Node;
225 Info->Status = AE_OK;
226 return (AE_CTRL_END);
233 /*******************************************************************************
235 * FUNCTION: AcpiEvGetGpeXruptBlock
237 * PARAMETERS: InterruptNumber - Interrupt for a GPE block
238 * GpeXruptBlock - Where the block is returned
242 * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
243 * block per unique interrupt level used for GPEs. Should be
244 * called only when the GPE lists are semaphore locked and not
247 ******************************************************************************/
250 AcpiEvGetGpeXruptBlock (
251 UINT32 InterruptNumber,
252 ACPI_GPE_XRUPT_INFO **GpeXruptBlock)
254 ACPI_GPE_XRUPT_INFO *NextGpeXrupt;
255 ACPI_GPE_XRUPT_INFO *GpeXrupt;
257 ACPI_CPU_FLAGS Flags;
260 ACPI_FUNCTION_TRACE (EvGetGpeXruptBlock);
263 /* No need for lock since we are not changing any list elements here */
265 NextGpeXrupt = AcpiGbl_GpeXruptListHead;
268 if (NextGpeXrupt->InterruptNumber == InterruptNumber)
270 *GpeXruptBlock = NextGpeXrupt;
271 return_ACPI_STATUS (AE_OK);
274 NextGpeXrupt = NextGpeXrupt->Next;
277 /* Not found, must allocate a new xrupt descriptor */
279 GpeXrupt = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_XRUPT_INFO));
282 return_ACPI_STATUS (AE_NO_MEMORY);
285 GpeXrupt->InterruptNumber = InterruptNumber;
287 /* Install new interrupt descriptor with spin lock */
289 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
290 if (AcpiGbl_GpeXruptListHead)
292 NextGpeXrupt = AcpiGbl_GpeXruptListHead;
293 while (NextGpeXrupt->Next)
295 NextGpeXrupt = NextGpeXrupt->Next;
298 NextGpeXrupt->Next = GpeXrupt;
299 GpeXrupt->Previous = NextGpeXrupt;
303 AcpiGbl_GpeXruptListHead = GpeXrupt;
306 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
308 /* Install new interrupt handler if not SCI_INT */
310 if (InterruptNumber != AcpiGbl_FADT.SciInterrupt)
312 Status = AcpiOsInstallInterruptHandler (InterruptNumber,
313 AcpiEvGpeXruptHandler, GpeXrupt);
314 if (ACPI_FAILURE (Status))
316 ACPI_EXCEPTION ((AE_INFO, Status,
317 "Could not install GPE interrupt handler at level 0x%X",
319 return_ACPI_STATUS (Status);
323 *GpeXruptBlock = GpeXrupt;
324 return_ACPI_STATUS (AE_OK);
328 /*******************************************************************************
330 * FUNCTION: AcpiEvDeleteGpeXrupt
332 * PARAMETERS: GpeXrupt - A GPE interrupt info block
336 * DESCRIPTION: Remove and free a GpeXrupt block. Remove an associated
337 * interrupt handler if not the SCI interrupt.
339 ******************************************************************************/
342 AcpiEvDeleteGpeXrupt (
343 ACPI_GPE_XRUPT_INFO *GpeXrupt)
346 ACPI_CPU_FLAGS Flags;
349 ACPI_FUNCTION_TRACE (EvDeleteGpeXrupt);
352 /* We never want to remove the SCI interrupt handler */
354 if (GpeXrupt->InterruptNumber == AcpiGbl_FADT.SciInterrupt)
356 GpeXrupt->GpeBlockListHead = NULL;
357 return_ACPI_STATUS (AE_OK);
360 /* Disable this interrupt */
362 Status = AcpiOsRemoveInterruptHandler (
363 GpeXrupt->InterruptNumber, AcpiEvGpeXruptHandler);
364 if (ACPI_FAILURE (Status))
366 return_ACPI_STATUS (Status);
369 /* Unlink the interrupt block with lock */
371 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
372 if (GpeXrupt->Previous)
374 GpeXrupt->Previous->Next = GpeXrupt->Next;
378 /* No previous, update list head */
380 AcpiGbl_GpeXruptListHead = GpeXrupt->Next;
385 GpeXrupt->Next->Previous = GpeXrupt->Previous;
387 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
391 ACPI_FREE (GpeXrupt);
392 return_ACPI_STATUS (AE_OK);
396 /*******************************************************************************
398 * FUNCTION: AcpiEvDeleteGpeHandlers
400 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
401 * GpeBlock - Gpe Block info
405 * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
406 * Used only prior to termination.
408 ******************************************************************************/
411 AcpiEvDeleteGpeHandlers (
412 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
413 ACPI_GPE_BLOCK_INFO *GpeBlock,
416 ACPI_GPE_EVENT_INFO *GpeEventInfo;
417 ACPI_GPE_NOTIFY_INFO *Notify;
418 ACPI_GPE_NOTIFY_INFO *Next;
423 ACPI_FUNCTION_TRACE (EvDeleteGpeHandlers);
426 /* Examine each GPE Register within the block */
428 for (i = 0; i < GpeBlock->RegisterCount; i++)
430 /* Now look at the individual GPEs in this byte register */
432 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++)
434 GpeEventInfo = &GpeBlock->EventInfo[((ACPI_SIZE) i *
435 ACPI_GPE_REGISTER_WIDTH) + j];
437 if ((ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
438 ACPI_GPE_DISPATCH_HANDLER) ||
439 (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
440 ACPI_GPE_DISPATCH_RAW_HANDLER))
442 /* Delete an installed handler block */
444 ACPI_FREE (GpeEventInfo->Dispatch.Handler);
445 GpeEventInfo->Dispatch.Handler = NULL;
446 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
448 else if (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
449 ACPI_GPE_DISPATCH_NOTIFY)
451 /* Delete the implicit notification device list */
453 Notify = GpeEventInfo->Dispatch.NotifyList;
460 GpeEventInfo->Dispatch.NotifyList = NULL;
461 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
466 return_ACPI_STATUS (AE_OK);
469 #endif /* !ACPI_REDUCED_HARDWARE */