evgpe.c revision 237412
1/******************************************************************************
2 *
3 * Module Name: evgpe - General Purpose Event handling and dispatch
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions, and the following disclaimer,
16 *    without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 *    substantially similar to the "NO WARRANTY" disclaimer below
19 *    ("Disclaimer") and any redistribution must be conditioned upon
20 *    including a substantially similar Disclaimer requirement for further
21 *    binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 *    of any contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include <contrib/dev/acpica/include/acpi.h>
45#include <contrib/dev/acpica/include/accommon.h>
46#include <contrib/dev/acpica/include/acevents.h>
47#include <contrib/dev/acpica/include/acnamesp.h>
48
49#define _COMPONENT          ACPI_EVENTS
50        ACPI_MODULE_NAME    ("evgpe")
51
52#if (!ACPI_REDUCED_HARDWARE) /* Entire module */
53
54/* Local prototypes */
55
56static void ACPI_SYSTEM_XFACE
57AcpiEvAsynchExecuteGpeMethod (
58    void                    *Context);
59
60static void ACPI_SYSTEM_XFACE
61AcpiEvAsynchEnableGpe (
62    void                    *Context);
63
64
65/*******************************************************************************
66 *
67 * FUNCTION:    AcpiEvUpdateGpeEnableMask
68 *
69 * PARAMETERS:  GpeEventInfo            - GPE to update
70 *
71 * RETURN:      Status
72 *
73 * DESCRIPTION: Updates GPE register enable mask based upon whether there are
74 *              runtime references to this GPE
75 *
76 ******************************************************************************/
77
78ACPI_STATUS
79AcpiEvUpdateGpeEnableMask (
80    ACPI_GPE_EVENT_INFO     *GpeEventInfo)
81{
82    ACPI_GPE_REGISTER_INFO  *GpeRegisterInfo;
83    UINT32                  RegisterBit;
84
85
86    ACPI_FUNCTION_TRACE (EvUpdateGpeEnableMask);
87
88
89    GpeRegisterInfo = GpeEventInfo->RegisterInfo;
90    if (!GpeRegisterInfo)
91    {
92        return_ACPI_STATUS (AE_NOT_EXIST);
93    }
94
95    RegisterBit = AcpiHwGetGpeRegisterBit (GpeEventInfo, GpeRegisterInfo);
96
97    /* Clear the run bit up front */
98
99    ACPI_CLEAR_BIT (GpeRegisterInfo->EnableForRun, RegisterBit);
100
101    /* Set the mask bit only if there are references to this GPE */
102
103    if (GpeEventInfo->RuntimeCount)
104    {
105        ACPI_SET_BIT (GpeRegisterInfo->EnableForRun, (UINT8) RegisterBit);
106    }
107
108    return_ACPI_STATUS (AE_OK);
109}
110
111
112/*******************************************************************************
113 *
114 * FUNCTION:    AcpiEvEnableGpe
115 *
116 * PARAMETERS:  GpeEventInfo            - GPE to enable
117 *
118 * RETURN:      Status
119 *
120 * DESCRIPTION: Clear a GPE of stale events and enable it.
121 *
122 ******************************************************************************/
123
124ACPI_STATUS
125AcpiEvEnableGpe (
126    ACPI_GPE_EVENT_INFO     *GpeEventInfo)
127{
128    ACPI_STATUS             Status;
129
130
131    ACPI_FUNCTION_TRACE (EvEnableGpe);
132
133
134    /*
135     * We will only allow a GPE to be enabled if it has either an associated
136     * method (_Lxx/_Exx) or a handler, or is using the implicit notify
137     * feature. Otherwise, the GPE will be immediately disabled by
138     * AcpiEvGpeDispatch the first time it fires.
139     */
140    if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
141        ACPI_GPE_DISPATCH_NONE)
142    {
143        return_ACPI_STATUS (AE_NO_HANDLER);
144    }
145
146    /* Clear the GPE (of stale events) */
147
148    Status = AcpiHwClearGpe (GpeEventInfo);
149    if (ACPI_FAILURE (Status))
150    {
151        return_ACPI_STATUS (Status);
152    }
153
154    /* Enable the requested GPE */
155
156    Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_ENABLE);
157    return_ACPI_STATUS (Status);
158}
159
160
161/*******************************************************************************
162 *
163 * FUNCTION:    AcpiEvAddGpeReference
164 *
165 * PARAMETERS:  GpeEventInfo            - Add a reference to this GPE
166 *
167 * RETURN:      Status
168 *
169 * DESCRIPTION: Add a reference to a GPE. On the first reference, the GPE is
170 *              hardware-enabled.
171 *
172 ******************************************************************************/
173
174ACPI_STATUS
175AcpiEvAddGpeReference (
176    ACPI_GPE_EVENT_INFO     *GpeEventInfo)
177{
178    ACPI_STATUS             Status = AE_OK;
179
180
181    ACPI_FUNCTION_TRACE (EvAddGpeReference);
182
183
184    if (GpeEventInfo->RuntimeCount == ACPI_UINT8_MAX)
185    {
186        return_ACPI_STATUS (AE_LIMIT);
187    }
188
189    GpeEventInfo->RuntimeCount++;
190    if (GpeEventInfo->RuntimeCount == 1)
191    {
192        /* Enable on first reference */
193
194        Status = AcpiEvUpdateGpeEnableMask (GpeEventInfo);
195        if (ACPI_SUCCESS (Status))
196        {
197            Status = AcpiEvEnableGpe (GpeEventInfo);
198        }
199
200        if (ACPI_FAILURE (Status))
201        {
202            GpeEventInfo->RuntimeCount--;
203        }
204    }
205
206    return_ACPI_STATUS (Status);
207}
208
209
210/*******************************************************************************
211 *
212 * FUNCTION:    AcpiEvRemoveGpeReference
213 *
214 * PARAMETERS:  GpeEventInfo            - Remove a reference to this GPE
215 *
216 * RETURN:      Status
217 *
218 * DESCRIPTION: Remove a reference to a GPE. When the last reference is
219 *              removed, the GPE is hardware-disabled.
220 *
221 ******************************************************************************/
222
223ACPI_STATUS
224AcpiEvRemoveGpeReference (
225    ACPI_GPE_EVENT_INFO     *GpeEventInfo)
226{
227    ACPI_STATUS             Status = AE_OK;
228
229
230    ACPI_FUNCTION_TRACE (EvRemoveGpeReference);
231
232
233    if (!GpeEventInfo->RuntimeCount)
234    {
235        return_ACPI_STATUS (AE_LIMIT);
236    }
237
238    GpeEventInfo->RuntimeCount--;
239    if (!GpeEventInfo->RuntimeCount)
240    {
241        /* Disable on last reference */
242
243        Status = AcpiEvUpdateGpeEnableMask (GpeEventInfo);
244        if (ACPI_SUCCESS (Status))
245        {
246            Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_DISABLE);
247        }
248
249        if (ACPI_FAILURE (Status))
250        {
251            GpeEventInfo->RuntimeCount++;
252        }
253    }
254
255    return_ACPI_STATUS (Status);
256}
257
258
259/*******************************************************************************
260 *
261 * FUNCTION:    AcpiEvLowGetGpeInfo
262 *
263 * PARAMETERS:  GpeNumber           - Raw GPE number
264 *              GpeBlock            - A GPE info block
265 *
266 * RETURN:      A GPE EventInfo struct. NULL if not a valid GPE (The GpeNumber
267 *              is not within the specified GPE block)
268 *
269 * DESCRIPTION: Returns the EventInfo struct associated with this GPE. This is
270 *              the low-level implementation of EvGetGpeEventInfo.
271 *
272 ******************************************************************************/
273
274ACPI_GPE_EVENT_INFO *
275AcpiEvLowGetGpeInfo (
276    UINT32                  GpeNumber,
277    ACPI_GPE_BLOCK_INFO     *GpeBlock)
278{
279    UINT32                  GpeIndex;
280
281
282    /*
283     * Validate that the GpeNumber is within the specified GpeBlock.
284     * (Two steps)
285     */
286    if (!GpeBlock ||
287        (GpeNumber < GpeBlock->BlockBaseNumber))
288    {
289        return (NULL);
290    }
291
292    GpeIndex = GpeNumber - GpeBlock->BlockBaseNumber;
293    if (GpeIndex >= GpeBlock->GpeCount)
294    {
295        return (NULL);
296    }
297
298    return (&GpeBlock->EventInfo[GpeIndex]);
299}
300
301
302/*******************************************************************************
303 *
304 * FUNCTION:    AcpiEvGetGpeEventInfo
305 *
306 * PARAMETERS:  GpeDevice           - Device node. NULL for GPE0/GPE1
307 *              GpeNumber           - Raw GPE number
308 *
309 * RETURN:      A GPE EventInfo struct. NULL if not a valid GPE
310 *
311 * DESCRIPTION: Returns the EventInfo struct associated with this GPE.
312 *              Validates the GpeBlock and the GpeNumber
313 *
314 *              Should be called only when the GPE lists are semaphore locked
315 *              and not subject to change.
316 *
317 ******************************************************************************/
318
319ACPI_GPE_EVENT_INFO *
320AcpiEvGetGpeEventInfo (
321    ACPI_HANDLE             GpeDevice,
322    UINT32                  GpeNumber)
323{
324    ACPI_OPERAND_OBJECT     *ObjDesc;
325    ACPI_GPE_EVENT_INFO     *GpeInfo;
326    UINT32                  i;
327
328
329    ACPI_FUNCTION_ENTRY ();
330
331
332    /* A NULL GpeDevice means use the FADT-defined GPE block(s) */
333
334    if (!GpeDevice)
335    {
336        /* Examine GPE Block 0 and 1 (These blocks are permanent) */
337
338        for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++)
339        {
340            GpeInfo = AcpiEvLowGetGpeInfo (GpeNumber,
341                        AcpiGbl_GpeFadtBlocks[i]);
342            if (GpeInfo)
343            {
344                return (GpeInfo);
345            }
346        }
347
348        /* The GpeNumber was not in the range of either FADT GPE block */
349
350        return (NULL);
351    }
352
353    /* A Non-NULL GpeDevice means this is a GPE Block Device */
354
355    ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) GpeDevice);
356    if (!ObjDesc ||
357        !ObjDesc->Device.GpeBlock)
358    {
359        return (NULL);
360    }
361
362    return (AcpiEvLowGetGpeInfo (GpeNumber, ObjDesc->Device.GpeBlock));
363}
364
365
366/*******************************************************************************
367 *
368 * FUNCTION:    AcpiEvGpeDetect
369 *
370 * PARAMETERS:  GpeXruptList        - Interrupt block for this interrupt.
371 *                                    Can have multiple GPE blocks attached.
372 *
373 * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
374 *
375 * DESCRIPTION: Detect if any GP events have occurred. This function is
376 *              executed at interrupt level.
377 *
378 ******************************************************************************/
379
380UINT32
381AcpiEvGpeDetect (
382    ACPI_GPE_XRUPT_INFO     *GpeXruptList)
383{
384    ACPI_STATUS             Status;
385    ACPI_GPE_BLOCK_INFO     *GpeBlock;
386    ACPI_GPE_REGISTER_INFO  *GpeRegisterInfo;
387    UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
388    UINT8                   EnabledStatusByte;
389    UINT32                  StatusReg;
390    UINT32                  EnableReg;
391    ACPI_CPU_FLAGS          Flags;
392    UINT32                  i;
393    UINT32                  j;
394
395
396    ACPI_FUNCTION_NAME (EvGpeDetect);
397
398    /* Check for the case where there are no GPEs */
399
400    if (!GpeXruptList)
401    {
402        return (IntStatus);
403    }
404
405    /*
406     * We need to obtain the GPE lock for both the data structs and registers
407     * Note: Not necessary to obtain the hardware lock, since the GPE
408     * registers are owned by the GpeLock.
409     */
410    Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
411
412    /* Examine all GPE blocks attached to this interrupt level */
413
414    GpeBlock = GpeXruptList->GpeBlockListHead;
415    while (GpeBlock)
416    {
417        /*
418         * Read all of the 8-bit GPE status and enable registers in this GPE
419         * block, saving all of them. Find all currently active GP events.
420         */
421        for (i = 0; i < GpeBlock->RegisterCount; i++)
422        {
423            /* Get the next status/enable pair */
424
425            GpeRegisterInfo = &GpeBlock->RegisterInfo[i];
426
427            /*
428             * Optimization: If there are no GPEs enabled within this
429             * register, we can safely ignore the entire register.
430             */
431            if (!(GpeRegisterInfo->EnableForRun |
432                  GpeRegisterInfo->EnableForWake))
433            {
434                continue;
435            }
436
437            /* Read the Status Register */
438
439            Status = AcpiHwRead (&StatusReg, &GpeRegisterInfo->StatusAddress);
440            if (ACPI_FAILURE (Status))
441            {
442                goto UnlockAndExit;
443            }
444
445            /* Read the Enable Register */
446
447            Status = AcpiHwRead (&EnableReg, &GpeRegisterInfo->EnableAddress);
448            if (ACPI_FAILURE (Status))
449            {
450                goto UnlockAndExit;
451            }
452
453            ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
454                "Read GPE Register at GPE%02X: Status=%02X, Enable=%02X\n",
455                GpeRegisterInfo->BaseGpeNumber, StatusReg, EnableReg));
456
457            /* Check if there is anything active at all in this register */
458
459            EnabledStatusByte = (UINT8) (StatusReg & EnableReg);
460            if (!EnabledStatusByte)
461            {
462                /* No active GPEs in this register, move on */
463
464                continue;
465            }
466
467            /* Now look at the individual GPEs in this byte register */
468
469            for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++)
470            {
471                /* Examine one GPE bit */
472
473                if (EnabledStatusByte & (1 << j))
474                {
475                    /*
476                     * Found an active GPE. Dispatch the event to a handler
477                     * or method.
478                     */
479                    IntStatus |= AcpiEvGpeDispatch (GpeBlock->Node,
480                        &GpeBlock->EventInfo[((ACPI_SIZE) i *
481                            ACPI_GPE_REGISTER_WIDTH) + j],
482                        j + GpeRegisterInfo->BaseGpeNumber);
483                }
484            }
485        }
486
487        GpeBlock = GpeBlock->Next;
488    }
489
490UnlockAndExit:
491
492    AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
493    return (IntStatus);
494}
495
496
497/*******************************************************************************
498 *
499 * FUNCTION:    AcpiEvAsynchExecuteGpeMethod
500 *
501 * PARAMETERS:  Context (GpeEventInfo) - Info for this GPE
502 *
503 * RETURN:      None
504 *
505 * DESCRIPTION: Perform the actual execution of a GPE control method. This
506 *              function is called from an invocation of AcpiOsExecute and
507 *              therefore does NOT execute at interrupt level - so that
508 *              the control method itself is not executed in the context of
509 *              an interrupt handler.
510 *
511 ******************************************************************************/
512
513static void ACPI_SYSTEM_XFACE
514AcpiEvAsynchExecuteGpeMethod (
515    void                    *Context)
516{
517    ACPI_GPE_EVENT_INFO     *GpeEventInfo = Context;
518    ACPI_STATUS             Status;
519    ACPI_GPE_EVENT_INFO     *LocalGpeEventInfo;
520    ACPI_EVALUATE_INFO      *Info;
521    ACPI_GPE_NOTIFY_INFO    *Notify;
522
523
524    ACPI_FUNCTION_TRACE (EvAsynchExecuteGpeMethod);
525
526
527    /* Allocate a local GPE block */
528
529    LocalGpeEventInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_EVENT_INFO));
530    if (!LocalGpeEventInfo)
531    {
532        ACPI_EXCEPTION ((AE_INFO, AE_NO_MEMORY,
533            "while handling a GPE"));
534        return_VOID;
535    }
536
537    Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
538    if (ACPI_FAILURE (Status))
539    {
540        return_VOID;
541    }
542
543    /* Must revalidate the GpeNumber/GpeBlock */
544
545    if (!AcpiEvValidGpeEvent (GpeEventInfo))
546    {
547        Status = AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
548        return_VOID;
549    }
550
551    /*
552     * Take a snapshot of the GPE info for this level - we copy the info to
553     * prevent a race condition with RemoveHandler/RemoveBlock.
554     */
555    ACPI_MEMCPY (LocalGpeEventInfo, GpeEventInfo,
556        sizeof (ACPI_GPE_EVENT_INFO));
557
558    Status = AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
559    if (ACPI_FAILURE (Status))
560    {
561        return_VOID;
562    }
563
564    /* Do the correct dispatch - normal method or implicit notify */
565
566    switch (LocalGpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK)
567    {
568    case ACPI_GPE_DISPATCH_NOTIFY:
569
570        /*
571         * Implicit notify.
572         * Dispatch a DEVICE_WAKE notify to the appropriate handler.
573         * NOTE: the request is queued for execution after this method
574         * completes. The notify handlers are NOT invoked synchronously
575         * from this thread -- because handlers may in turn run other
576         * control methods.
577         *
578         * June 2012: Expand implicit notify mechanism to support
579         * notifies on multiple device objects.
580         */
581        Notify = LocalGpeEventInfo->Dispatch.NotifyList;
582        while (ACPI_SUCCESS (Status) && Notify)
583        {
584            Status = AcpiEvQueueNotifyRequest (Notify->DeviceNode,
585                        ACPI_NOTIFY_DEVICE_WAKE);
586
587            Notify = Notify->Next;
588        }
589        break;
590
591    case ACPI_GPE_DISPATCH_METHOD:
592
593        /* Allocate the evaluation information block */
594
595        Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
596        if (!Info)
597        {
598            Status = AE_NO_MEMORY;
599        }
600        else
601        {
602            /*
603             * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the
604             * _Lxx/_Exx control method that corresponds to this GPE
605             */
606            Info->PrefixNode = LocalGpeEventInfo->Dispatch.MethodNode;
607            Info->Flags = ACPI_IGNORE_RETURN_VALUE;
608
609            Status = AcpiNsEvaluate (Info);
610            ACPI_FREE (Info);
611        }
612
613        if (ACPI_FAILURE (Status))
614        {
615            ACPI_EXCEPTION ((AE_INFO, Status,
616                "while evaluating GPE method [%4.4s]",
617                AcpiUtGetNodeName (LocalGpeEventInfo->Dispatch.MethodNode)));
618        }
619
620        break;
621
622    default:
623        return_VOID; /* Should never happen */
624    }
625
626    /* Defer enabling of GPE until all notify handlers are done */
627
628    Status = AcpiOsExecute (OSL_NOTIFY_HANDLER,
629                AcpiEvAsynchEnableGpe, LocalGpeEventInfo);
630    if (ACPI_FAILURE (Status))
631    {
632        ACPI_FREE (LocalGpeEventInfo);
633    }
634    return_VOID;
635}
636
637
638/*******************************************************************************
639 *
640 * FUNCTION:    AcpiEvAsynchEnableGpe
641 *
642 * PARAMETERS:  Context (GpeEventInfo) - Info for this GPE
643 *              Callback from AcpiOsExecute
644 *
645 * RETURN:      None
646 *
647 * DESCRIPTION: Asynchronous clear/enable for GPE. This allows the GPE to
648 *              complete (i.e., finish execution of Notify)
649 *
650 ******************************************************************************/
651
652static void ACPI_SYSTEM_XFACE
653AcpiEvAsynchEnableGpe (
654    void                    *Context)
655{
656    ACPI_GPE_EVENT_INFO     *GpeEventInfo = Context;
657
658
659    (void) AcpiEvFinishGpe (GpeEventInfo);
660
661    ACPI_FREE (GpeEventInfo);
662    return;
663}
664
665
666/*******************************************************************************
667 *
668 * FUNCTION:    AcpiEvFinishGpe
669 *
670 * PARAMETERS:  GpeEventInfo        - Info for this GPE
671 *
672 * RETURN:      Status
673 *
674 * DESCRIPTION: Clear/Enable a GPE. Common code that is used after execution
675 *              of a GPE method or a synchronous or asynchronous GPE handler.
676 *
677 ******************************************************************************/
678
679ACPI_STATUS
680AcpiEvFinishGpe (
681    ACPI_GPE_EVENT_INFO     *GpeEventInfo)
682{
683    ACPI_STATUS             Status;
684
685
686    if ((GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
687            ACPI_GPE_LEVEL_TRIGGERED)
688    {
689        /*
690         * GPE is level-triggered, we clear the GPE status bit after
691         * handling the event.
692         */
693        Status = AcpiHwClearGpe (GpeEventInfo);
694        if (ACPI_FAILURE (Status))
695        {
696            return (Status);
697        }
698    }
699
700    /*
701     * Enable this GPE, conditionally. This means that the GPE will
702     * only be physically enabled if the EnableForRun bit is set
703     * in the EventInfo.
704     */
705    (void) AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_CONDITIONAL_ENABLE);
706    return (AE_OK);
707}
708
709
710/*******************************************************************************
711 *
712 * FUNCTION:    AcpiEvGpeDispatch
713 *
714 * PARAMETERS:  GpeDevice           - Device node. NULL for GPE0/GPE1
715 *              GpeEventInfo        - Info for this GPE
716 *              GpeNumber           - Number relative to the parent GPE block
717 *
718 * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
719 *
720 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
721 *              or method (e.g. _Lxx/_Exx) handler.
722 *
723 *              This function executes at interrupt level.
724 *
725 ******************************************************************************/
726
727UINT32
728AcpiEvGpeDispatch (
729    ACPI_NAMESPACE_NODE     *GpeDevice,
730    ACPI_GPE_EVENT_INFO     *GpeEventInfo,
731    UINT32                  GpeNumber)
732{
733    ACPI_STATUS             Status;
734    UINT32                  ReturnValue;
735
736
737    ACPI_FUNCTION_TRACE (EvGpeDispatch);
738
739
740    /* Invoke global event handler if present */
741
742    AcpiGpeCount++;
743    if (AcpiGbl_GlobalEventHandler)
744    {
745        AcpiGbl_GlobalEventHandler (ACPI_EVENT_TYPE_GPE, GpeDevice,
746             GpeNumber, AcpiGbl_GlobalEventHandlerContext);
747    }
748
749    /*
750     * If edge-triggered, clear the GPE status bit now. Note that
751     * level-triggered events are cleared after the GPE is serviced.
752     */
753    if ((GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
754            ACPI_GPE_EDGE_TRIGGERED)
755    {
756        Status = AcpiHwClearGpe (GpeEventInfo);
757        if (ACPI_FAILURE (Status))
758        {
759            ACPI_EXCEPTION ((AE_INFO, Status,
760                "Unable to clear GPE%02X", GpeNumber));
761            return_UINT32 (ACPI_INTERRUPT_NOT_HANDLED);
762        }
763    }
764
765    /*
766     * Always disable the GPE so that it does not keep firing before
767     * any asynchronous activity completes (either from the execution
768     * of a GPE method or an asynchronous GPE handler.)
769     *
770     * If there is no handler or method to run, just disable the
771     * GPE and leave it disabled permanently to prevent further such
772     * pointless events from firing.
773     */
774    Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_DISABLE);
775    if (ACPI_FAILURE (Status))
776    {
777        ACPI_EXCEPTION ((AE_INFO, Status,
778            "Unable to disable GPE%02X", GpeNumber));
779        return_UINT32 (ACPI_INTERRUPT_NOT_HANDLED);
780    }
781
782    /*
783     * Dispatch the GPE to either an installed handler or the control
784     * method associated with this GPE (_Lxx or _Exx). If a handler
785     * exists, we invoke it and do not attempt to run the method.
786     * If there is neither a handler nor a method, leave the GPE
787     * disabled.
788     */
789    switch (GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK)
790    {
791    case ACPI_GPE_DISPATCH_HANDLER:
792
793        /* Invoke the installed handler (at interrupt level) */
794
795        ReturnValue = GpeEventInfo->Dispatch.Handler->Address (
796            GpeDevice, GpeNumber,
797            GpeEventInfo->Dispatch.Handler->Context);
798
799        /* If requested, clear (if level-triggered) and reenable the GPE */
800
801        if (ReturnValue & ACPI_REENABLE_GPE)
802        {
803            (void) AcpiEvFinishGpe (GpeEventInfo);
804        }
805        break;
806
807    case ACPI_GPE_DISPATCH_METHOD:
808    case ACPI_GPE_DISPATCH_NOTIFY:
809
810        /*
811         * Execute the method associated with the GPE
812         * NOTE: Level-triggered GPEs are cleared after the method completes.
813         */
814        Status = AcpiOsExecute (OSL_GPE_HANDLER,
815                    AcpiEvAsynchExecuteGpeMethod, GpeEventInfo);
816        if (ACPI_FAILURE (Status))
817        {
818            ACPI_EXCEPTION ((AE_INFO, Status,
819                "Unable to queue handler for GPE%02X - event disabled",
820                GpeNumber));
821        }
822        break;
823
824    default:
825
826        /*
827         * No handler or method to run!
828         * 03/2010: This case should no longer be possible. We will not allow
829         * a GPE to be enabled if it has no handler or method.
830         */
831        ACPI_ERROR ((AE_INFO,
832            "No handler or method for GPE%02X, disabling event",
833            GpeNumber));
834        break;
835    }
836
837    return_UINT32 (ACPI_INTERRUPT_HANDLED);
838}
839
840#endif /* !ACPI_REDUCED_HARDWARE */
841