1 /******************************************************************************
3 * Module Name: evgpeutil - GPE utilities
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, 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 *****************************************************************************/
118 #include "accommon.h"
119 #include "acevents.h"
121 #define _COMPONENT ACPI_EVENTS
122 ACPI_MODULE_NAME ("evgpeutil")
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: AcpiEvValidGpeEvent
192 * PARAMETERS: GpeEventInfo - Info for this GPE
194 * RETURN: TRUE if the GpeEvent is valid
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.
200 ******************************************************************************/
203 AcpiEvValidGpeEvent (
204 ACPI_GPE_EVENT_INFO
*GpeEventInfo
)
206 ACPI_GPE_XRUPT_INFO
*GpeXruptBlock
;
207 ACPI_GPE_BLOCK_INFO
*GpeBlock
;
210 ACPI_FUNCTION_ENTRY ();
213 /* No need for spin lock since we are not changing any list elements */
215 /* Walk the GPE interrupt levels */
217 GpeXruptBlock
= AcpiGbl_GpeXruptListHead
;
218 while (GpeXruptBlock
)
220 GpeBlock
= GpeXruptBlock
->GpeBlockListHead
;
222 /* Walk the GPE blocks on this interrupt level */
226 if ((&GpeBlock
->EventInfo
[0] <= GpeEventInfo
) &&
227 (&GpeBlock
->EventInfo
[GpeBlock
->GpeCount
] > GpeEventInfo
))
232 GpeBlock
= GpeBlock
->Next
;
235 GpeXruptBlock
= GpeXruptBlock
->Next
;
242 /*******************************************************************************
244 * FUNCTION: AcpiEvGetGpeDevice
246 * PARAMETERS: GPE_WALK_CALLBACK
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.
253 ******************************************************************************/
257 ACPI_GPE_XRUPT_INFO
*GpeXruptInfo
,
258 ACPI_GPE_BLOCK_INFO
*GpeBlock
,
261 ACPI_GPE_DEVICE_INFO
*Info
= Context
;
264 /* Increment Index by the number of GPEs in this block */
266 Info
->NextBlockBaseIndex
+= GpeBlock
->GpeCount
;
268 if (Info
->Index
< Info
->NextBlockBaseIndex
)
271 * The GPE index is within this block, get the node. Leave the node
272 * NULL for the FADT-defined GPEs
274 if ((GpeBlock
->Node
)->Type
== ACPI_TYPE_DEVICE
)
276 Info
->GpeDevice
= GpeBlock
->Node
;
279 Info
->Status
= AE_OK
;
280 return (AE_CTRL_END
);
287 /*******************************************************************************
289 * FUNCTION: AcpiEvGetGpeXruptBlock
291 * PARAMETERS: InterruptNumber - Interrupt for a GPE block
293 * RETURN: A GPE interrupt block
295 * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
296 * block per unique interrupt level used for GPEs. Should be
297 * called only when the GPE lists are semaphore locked and not
300 ******************************************************************************/
302 ACPI_GPE_XRUPT_INFO
*
303 AcpiEvGetGpeXruptBlock (
304 UINT32 InterruptNumber
)
306 ACPI_GPE_XRUPT_INFO
*NextGpeXrupt
;
307 ACPI_GPE_XRUPT_INFO
*GpeXrupt
;
309 ACPI_CPU_FLAGS Flags
;
312 ACPI_FUNCTION_TRACE (EvGetGpeXruptBlock
);
315 /* No need for lock since we are not changing any list elements here */
317 NextGpeXrupt
= AcpiGbl_GpeXruptListHead
;
320 if (NextGpeXrupt
->InterruptNumber
== InterruptNumber
)
322 return_PTR (NextGpeXrupt
);
325 NextGpeXrupt
= NextGpeXrupt
->Next
;
328 /* Not found, must allocate a new xrupt descriptor */
330 GpeXrupt
= ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_XRUPT_INFO
));
336 GpeXrupt
->InterruptNumber
= InterruptNumber
;
338 /* Install new interrupt descriptor with spin lock */
340 Flags
= AcpiOsAcquireLock (AcpiGbl_GpeLock
);
341 if (AcpiGbl_GpeXruptListHead
)
343 NextGpeXrupt
= AcpiGbl_GpeXruptListHead
;
344 while (NextGpeXrupt
->Next
)
346 NextGpeXrupt
= NextGpeXrupt
->Next
;
349 NextGpeXrupt
->Next
= GpeXrupt
;
350 GpeXrupt
->Previous
= NextGpeXrupt
;
354 AcpiGbl_GpeXruptListHead
= GpeXrupt
;
356 AcpiOsReleaseLock (AcpiGbl_GpeLock
, Flags
);
358 /* Install new interrupt handler if not SCI_INT */
360 if (InterruptNumber
!= AcpiGbl_FADT
.SciInterrupt
)
362 Status
= AcpiOsInstallInterruptHandler (InterruptNumber
,
363 AcpiEvGpeXruptHandler
, GpeXrupt
);
364 if (ACPI_FAILURE (Status
))
366 ACPI_ERROR ((AE_INFO
,
367 "Could not install GPE interrupt handler at level 0x%X",
373 return_PTR (GpeXrupt
);
377 /*******************************************************************************
379 * FUNCTION: AcpiEvDeleteGpeXrupt
381 * PARAMETERS: GpeXrupt - A GPE interrupt info block
385 * DESCRIPTION: Remove and free a GpeXrupt block. Remove an associated
386 * interrupt handler if not the SCI interrupt.
388 ******************************************************************************/
391 AcpiEvDeleteGpeXrupt (
392 ACPI_GPE_XRUPT_INFO
*GpeXrupt
)
395 ACPI_CPU_FLAGS Flags
;
398 ACPI_FUNCTION_TRACE (EvDeleteGpeXrupt
);
401 /* We never want to remove the SCI interrupt handler */
403 if (GpeXrupt
->InterruptNumber
== AcpiGbl_FADT
.SciInterrupt
)
405 GpeXrupt
->GpeBlockListHead
= NULL
;
406 return_ACPI_STATUS (AE_OK
);
409 /* Disable this interrupt */
411 Status
= AcpiOsRemoveInterruptHandler (
412 GpeXrupt
->InterruptNumber
, AcpiEvGpeXruptHandler
);
413 if (ACPI_FAILURE (Status
))
415 return_ACPI_STATUS (Status
);
418 /* Unlink the interrupt block with lock */
420 Flags
= AcpiOsAcquireLock (AcpiGbl_GpeLock
);
421 if (GpeXrupt
->Previous
)
423 GpeXrupt
->Previous
->Next
= GpeXrupt
->Next
;
427 /* No previous, update list head */
429 AcpiGbl_GpeXruptListHead
= GpeXrupt
->Next
;
434 GpeXrupt
->Next
->Previous
= GpeXrupt
->Previous
;
436 AcpiOsReleaseLock (AcpiGbl_GpeLock
, Flags
);
440 ACPI_FREE (GpeXrupt
);
441 return_ACPI_STATUS (AE_OK
);
445 /*******************************************************************************
447 * FUNCTION: AcpiEvDeleteGpeHandlers
449 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
450 * GpeBlock - Gpe Block info
454 * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
455 * Used only prior to termination.
457 ******************************************************************************/
460 AcpiEvDeleteGpeHandlers (
461 ACPI_GPE_XRUPT_INFO
*GpeXruptInfo
,
462 ACPI_GPE_BLOCK_INFO
*GpeBlock
,
465 ACPI_GPE_EVENT_INFO
*GpeEventInfo
;
470 ACPI_FUNCTION_TRACE (EvDeleteGpeHandlers
);
473 /* Examine each GPE Register within the block */
475 for (i
= 0; i
< GpeBlock
->RegisterCount
; i
++)
477 /* Now look at the individual GPEs in this byte register */
479 for (j
= 0; j
< ACPI_GPE_REGISTER_WIDTH
; j
++)
481 GpeEventInfo
= &GpeBlock
->EventInfo
[((ACPI_SIZE
) i
*
482 ACPI_GPE_REGISTER_WIDTH
) + j
];
484 if ((GpeEventInfo
->Flags
& ACPI_GPE_DISPATCH_MASK
) ==
485 ACPI_GPE_DISPATCH_HANDLER
)
487 ACPI_FREE (GpeEventInfo
->Dispatch
.Handler
);
488 GpeEventInfo
->Dispatch
.Handler
= NULL
;
489 GpeEventInfo
->Flags
&= ~ACPI_GPE_DISPATCH_MASK
;
494 return_ACPI_STATUS (AE_OK
);