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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#include "acpi.h"
153#include "accommon.h"
154#include "acevents.h"
155
156#define _COMPONENT          ACPI_EVENTS
157        ACPI_MODULE_NAME    ("evgpeutil")
158
159
160#if (!ACPI_REDUCED_HARDWARE) /* Entire module */
161/*******************************************************************************
162 *
163 * FUNCTION:    AcpiEvWalkGpeList
164 *
165 * PARAMETERS:  GpeWalkCallback     - Routine called for each GPE block
166 *              Context             - Value passed to callback
167 *
168 * RETURN:      Status
169 *
170 * DESCRIPTION: Walk the GPE lists.
171 *
172 ******************************************************************************/
173
174ACPI_STATUS
175AcpiEvWalkGpeList (
176    ACPI_GPE_CALLBACK       GpeWalkCallback,
177    void                    *Context)
178{
179    ACPI_GPE_BLOCK_INFO     *GpeBlock;
180    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
181    ACPI_STATUS             Status = AE_OK;
182    ACPI_CPU_FLAGS          Flags;
183
184
185    ACPI_FUNCTION_TRACE (EvWalkGpeList);
186
187
188    Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
189
190    /* Walk the interrupt level descriptor list */
191
192    GpeXruptInfo = AcpiGbl_GpeXruptListHead;
193    while (GpeXruptInfo)
194    {
195        /* Walk all Gpe Blocks attached to this interrupt level */
196
197        GpeBlock = GpeXruptInfo->GpeBlockListHead;
198        while (GpeBlock)
199        {
200            /* One callback per GPE block */
201
202            Status = GpeWalkCallback (GpeXruptInfo, GpeBlock, Context);
203            if (ACPI_FAILURE (Status))
204            {
205                if (Status == AE_CTRL_END) /* Callback abort */
206                {
207                    Status = AE_OK;
208                }
209                goto UnlockAndExit;
210            }
211
212            GpeBlock = GpeBlock->Next;
213        }
214
215        GpeXruptInfo = GpeXruptInfo->Next;
216    }
217
218UnlockAndExit:
219    AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
220    return_ACPI_STATUS (Status);
221}
222
223
224/*******************************************************************************
225 *
226 * FUNCTION:    AcpiEvGetGpeDevice
227 *
228 * PARAMETERS:  GPE_WALK_CALLBACK
229 *
230 * RETURN:      Status
231 *
232 * DESCRIPTION: Matches the input GPE index (0-CurrentGpeCount) with a GPE
233 *              block device. NULL if the GPE is one of the FADT-defined GPEs.
234 *
235 ******************************************************************************/
236
237ACPI_STATUS
238AcpiEvGetGpeDevice (
239    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
240    ACPI_GPE_BLOCK_INFO     *GpeBlock,
241    void                    *Context)
242{
243    ACPI_GPE_DEVICE_INFO    *Info = Context;
244
245
246    /* Increment Index by the number of GPEs in this block */
247
248    Info->NextBlockBaseIndex += GpeBlock->GpeCount;
249
250    if (Info->Index < Info->NextBlockBaseIndex)
251    {
252        /*
253         * The GPE index is within this block, get the node. Leave the node
254         * NULL for the FADT-defined GPEs
255         */
256        if ((GpeBlock->Node)->Type == ACPI_TYPE_DEVICE)
257        {
258            Info->GpeDevice = GpeBlock->Node;
259        }
260
261        Info->Status = AE_OK;
262        return (AE_CTRL_END);
263    }
264
265    return (AE_OK);
266}
267
268
269/*******************************************************************************
270 *
271 * FUNCTION:    AcpiEvGetGpeXruptBlock
272 *
273 * PARAMETERS:  InterruptNumber             - Interrupt for a GPE block
274 *              GpeXruptBlock               - Where the block is returned
275 *
276 * RETURN:      Status
277 *
278 * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
279 *              block per unique interrupt level used for GPEs. Should be
280 *              called only when the GPE lists are semaphore locked and not
281 *              subject to change.
282 *
283 ******************************************************************************/
284
285ACPI_STATUS
286AcpiEvGetGpeXruptBlock (
287    UINT32                  InterruptNumber,
288    ACPI_GPE_XRUPT_INFO     **GpeXruptBlock)
289{
290    ACPI_GPE_XRUPT_INFO     *NextGpeXrupt;
291    ACPI_GPE_XRUPT_INFO     *GpeXrupt;
292    ACPI_STATUS             Status;
293    ACPI_CPU_FLAGS          Flags;
294
295
296    ACPI_FUNCTION_TRACE (EvGetGpeXruptBlock);
297
298
299    /* No need for lock since we are not changing any list elements here */
300
301    NextGpeXrupt = AcpiGbl_GpeXruptListHead;
302    while (NextGpeXrupt)
303    {
304        if (NextGpeXrupt->InterruptNumber == InterruptNumber)
305        {
306            *GpeXruptBlock = NextGpeXrupt;
307            return_ACPI_STATUS (AE_OK);
308        }
309
310        NextGpeXrupt = NextGpeXrupt->Next;
311    }
312
313    /* Not found, must allocate a new xrupt descriptor */
314
315    GpeXrupt = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_XRUPT_INFO));
316    if (!GpeXrupt)
317    {
318        return_ACPI_STATUS (AE_NO_MEMORY);
319    }
320
321    GpeXrupt->InterruptNumber = InterruptNumber;
322
323    /* Install new interrupt descriptor with spin lock */
324
325    Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
326    if (AcpiGbl_GpeXruptListHead)
327    {
328        NextGpeXrupt = AcpiGbl_GpeXruptListHead;
329        while (NextGpeXrupt->Next)
330        {
331            NextGpeXrupt = NextGpeXrupt->Next;
332        }
333
334        NextGpeXrupt->Next = GpeXrupt;
335        GpeXrupt->Previous = NextGpeXrupt;
336    }
337    else
338    {
339        AcpiGbl_GpeXruptListHead = GpeXrupt;
340    }
341
342    AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
343
344    /* Install new interrupt handler if not SCI_INT */
345
346    if (InterruptNumber != AcpiGbl_FADT.SciInterrupt)
347    {
348        Status = AcpiOsInstallInterruptHandler (InterruptNumber,
349            AcpiEvGpeXruptHandler, GpeXrupt);
350        if (ACPI_FAILURE (Status))
351        {
352            ACPI_EXCEPTION ((AE_INFO, Status,
353                "Could not install GPE interrupt handler at level 0x%X",
354                InterruptNumber));
355            return_ACPI_STATUS (Status);
356        }
357    }
358
359    *GpeXruptBlock = GpeXrupt;
360    return_ACPI_STATUS (AE_OK);
361}
362
363
364/*******************************************************************************
365 *
366 * FUNCTION:    AcpiEvDeleteGpeXrupt
367 *
368 * PARAMETERS:  GpeXrupt        - A GPE interrupt info block
369 *
370 * RETURN:      Status
371 *
372 * DESCRIPTION: Remove and free a GpeXrupt block. Remove an associated
373 *              interrupt handler if not the SCI interrupt.
374 *
375 ******************************************************************************/
376
377ACPI_STATUS
378AcpiEvDeleteGpeXrupt (
379    ACPI_GPE_XRUPT_INFO     *GpeXrupt)
380{
381    ACPI_STATUS             Status;
382    ACPI_CPU_FLAGS          Flags;
383
384
385    ACPI_FUNCTION_TRACE (EvDeleteGpeXrupt);
386
387
388    /* We never want to remove the SCI interrupt handler */
389
390    if (GpeXrupt->InterruptNumber == AcpiGbl_FADT.SciInterrupt)
391    {
392        GpeXrupt->GpeBlockListHead = NULL;
393        return_ACPI_STATUS (AE_OK);
394    }
395
396    /* Disable this interrupt */
397
398    Status = AcpiOsRemoveInterruptHandler (
399        GpeXrupt->InterruptNumber, AcpiEvGpeXruptHandler);
400    if (ACPI_FAILURE (Status))
401    {
402        return_ACPI_STATUS (Status);
403    }
404
405    /* Unlink the interrupt block with lock */
406
407    Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
408    if (GpeXrupt->Previous)
409    {
410        GpeXrupt->Previous->Next = GpeXrupt->Next;
411    }
412    else
413    {
414        /* No previous, update list head */
415
416        AcpiGbl_GpeXruptListHead = GpeXrupt->Next;
417    }
418
419    if (GpeXrupt->Next)
420    {
421        GpeXrupt->Next->Previous = GpeXrupt->Previous;
422    }
423    AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
424
425    /* Free the block */
426
427    ACPI_FREE (GpeXrupt);
428    return_ACPI_STATUS (AE_OK);
429}
430
431
432/*******************************************************************************
433 *
434 * FUNCTION:    AcpiEvDeleteGpeHandlers
435 *
436 * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
437 *              GpeBlock            - Gpe Block info
438 *
439 * RETURN:      Status
440 *
441 * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
442 *              Used only prior to termination.
443 *
444 ******************************************************************************/
445
446ACPI_STATUS
447AcpiEvDeleteGpeHandlers (
448    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
449    ACPI_GPE_BLOCK_INFO     *GpeBlock,
450    void                    *Context)
451{
452    ACPI_GPE_EVENT_INFO     *GpeEventInfo;
453    ACPI_GPE_NOTIFY_INFO    *Notify;
454    ACPI_GPE_NOTIFY_INFO    *Next;
455    UINT32                  i;
456    UINT32                  j;
457
458
459    ACPI_FUNCTION_TRACE (EvDeleteGpeHandlers);
460
461
462    /* Examine each GPE Register within the block */
463
464    for (i = 0; i < GpeBlock->RegisterCount; i++)
465    {
466        /* Now look at the individual GPEs in this byte register */
467
468        for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++)
469        {
470            GpeEventInfo = &GpeBlock->EventInfo[((ACPI_SIZE) i *
471                ACPI_GPE_REGISTER_WIDTH) + j];
472
473            if ((ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
474                    ACPI_GPE_DISPATCH_HANDLER) ||
475                (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
476                    ACPI_GPE_DISPATCH_RAW_HANDLER))
477            {
478                /* Delete an installed handler block */
479
480                ACPI_FREE (GpeEventInfo->Dispatch.Handler);
481                GpeEventInfo->Dispatch.Handler = NULL;
482                GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
483            }
484            else if (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
485                ACPI_GPE_DISPATCH_NOTIFY)
486            {
487                /* Delete the implicit notification device list */
488
489                Notify = GpeEventInfo->Dispatch.NotifyList;
490                while (Notify)
491                {
492                    Next = Notify->Next;
493                    ACPI_FREE (Notify);
494                    Notify = Next;
495                }
496
497                GpeEventInfo->Dispatch.NotifyList = NULL;
498                GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
499            }
500        }
501    }
502
503    return_ACPI_STATUS (AE_OK);
504}
505
506#endif /* !ACPI_REDUCED_HARDWARE */
507