1/******************************************************************************
2 *
3 * Module Name: evevent - Fixed Event handling and dispatch
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2012, 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    ("evevent")
122
123#if (!ACPI_REDUCED_HARDWARE) /* Entire module */
124
125/* Local prototypes */
126
127static ACPI_STATUS
128AcpiEvFixedEventInitialize (
129    void);
130
131static UINT32
132AcpiEvFixedEventDispatch (
133    UINT32                  Event);
134
135
136/*******************************************************************************
137 *
138 * FUNCTION:    AcpiEvInitializeEvents
139 *
140 * PARAMETERS:  None
141 *
142 * RETURN:      Status
143 *
144 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
145 *
146 ******************************************************************************/
147
148ACPI_STATUS
149AcpiEvInitializeEvents (
150    void)
151{
152    ACPI_STATUS             Status;
153
154
155    ACPI_FUNCTION_TRACE (EvInitializeEvents);
156
157
158    /* If Hardware Reduced flag is set, there are no fixed events */
159
160    if (AcpiGbl_ReducedHardware)
161    {
162        return_ACPI_STATUS (AE_OK);
163    }
164
165    /*
166     * Initialize the Fixed and General Purpose Events. This is done prior to
167     * enabling SCIs to prevent interrupts from occurring before the handlers
168     * are installed.
169     */
170    Status = AcpiEvFixedEventInitialize ();
171    if (ACPI_FAILURE (Status))
172    {
173        ACPI_EXCEPTION ((AE_INFO, Status,
174            "Unable to initialize fixed events"));
175        return_ACPI_STATUS (Status);
176    }
177
178    Status = AcpiEvGpeInitialize ();
179    if (ACPI_FAILURE (Status))
180    {
181        ACPI_EXCEPTION ((AE_INFO, Status,
182            "Unable to initialize general purpose events"));
183        return_ACPI_STATUS (Status);
184    }
185
186    return_ACPI_STATUS (Status);
187}
188
189
190/*******************************************************************************
191 *
192 * FUNCTION:    AcpiEvInstallXruptHandlers
193 *
194 * PARAMETERS:  None
195 *
196 * RETURN:      Status
197 *
198 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
199 *
200 ******************************************************************************/
201
202ACPI_STATUS
203AcpiEvInstallXruptHandlers (
204    void)
205{
206    ACPI_STATUS             Status;
207
208
209    ACPI_FUNCTION_TRACE (EvInstallXruptHandlers);
210
211
212    /* If Hardware Reduced flag is set, there is no ACPI h/w */
213
214    if (AcpiGbl_ReducedHardware)
215    {
216        return_ACPI_STATUS (AE_OK);
217    }
218
219    /* Install the SCI handler */
220
221    Status = AcpiEvInstallSciHandler ();
222    if (ACPI_FAILURE (Status))
223    {
224        ACPI_EXCEPTION ((AE_INFO, Status,
225            "Unable to install System Control Interrupt handler"));
226        return_ACPI_STATUS (Status);
227    }
228
229    /* Install the handler for the Global Lock */
230
231    Status = AcpiEvInitGlobalLockHandler ();
232    if (ACPI_FAILURE (Status))
233    {
234        ACPI_EXCEPTION ((AE_INFO, Status,
235            "Unable to initialize Global Lock handler"));
236        return_ACPI_STATUS (Status);
237    }
238
239    AcpiGbl_EventsInitialized = TRUE;
240    return_ACPI_STATUS (Status);
241}
242
243
244/*******************************************************************************
245 *
246 * FUNCTION:    AcpiEvFixedEventInitialize
247 *
248 * PARAMETERS:  None
249 *
250 * RETURN:      Status
251 *
252 * DESCRIPTION: Install the fixed event handlers and disable all fixed events.
253 *
254 ******************************************************************************/
255
256static ACPI_STATUS
257AcpiEvFixedEventInitialize (
258    void)
259{
260    UINT32                  i;
261    ACPI_STATUS             Status;
262
263
264    /*
265     * Initialize the structure that keeps track of fixed event handlers and
266     * enable the fixed events.
267     */
268    for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
269    {
270        AcpiGbl_FixedEventHandlers[i].Handler = NULL;
271        AcpiGbl_FixedEventHandlers[i].Context = NULL;
272
273        /* Disable the fixed event */
274
275        if (AcpiGbl_FixedEventInfo[i].EnableRegisterId != 0xFF)
276        {
277            Status = AcpiWriteBitRegister (
278                        AcpiGbl_FixedEventInfo[i].EnableRegisterId,
279                        ACPI_DISABLE_EVENT);
280            if (ACPI_FAILURE (Status))
281            {
282                return (Status);
283            }
284        }
285    }
286
287    return (AE_OK);
288}
289
290
291/*******************************************************************************
292 *
293 * FUNCTION:    AcpiEvFixedEventDetect
294 *
295 * PARAMETERS:  None
296 *
297 * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
298 *
299 * DESCRIPTION: Checks the PM status register for active fixed events
300 *
301 ******************************************************************************/
302
303UINT32
304AcpiEvFixedEventDetect (
305    void)
306{
307    UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
308    UINT32                  FixedStatus;
309    UINT32                  FixedEnable;
310    UINT32                  i;
311
312
313    ACPI_FUNCTION_NAME (EvFixedEventDetect);
314
315
316    /*
317     * Read the fixed feature status and enable registers, as all the cases
318     * depend on their values. Ignore errors here.
319     */
320    (void) AcpiHwRegisterRead (ACPI_REGISTER_PM1_STATUS, &FixedStatus);
321    (void) AcpiHwRegisterRead (ACPI_REGISTER_PM1_ENABLE, &FixedEnable);
322
323    ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
324        "Fixed Event Block: Enable %08X Status %08X\n",
325        FixedEnable, FixedStatus));
326
327    /*
328     * Check for all possible Fixed Events and dispatch those that are active
329     */
330    for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
331    {
332        /* Both the status and enable bits must be on for this event */
333
334        if ((FixedStatus & AcpiGbl_FixedEventInfo[i].StatusBitMask) &&
335            (FixedEnable & AcpiGbl_FixedEventInfo[i].EnableBitMask))
336        {
337            /*
338             * Found an active (signalled) event. Invoke global event
339             * handler if present.
340             */
341            AcpiFixedEventCount[i]++;
342            if (AcpiGbl_GlobalEventHandler)
343            {
344                AcpiGbl_GlobalEventHandler (ACPI_EVENT_TYPE_FIXED, NULL,
345                     i, AcpiGbl_GlobalEventHandlerContext);
346            }
347
348            IntStatus |= AcpiEvFixedEventDispatch (i);
349        }
350    }
351
352    return (IntStatus);
353}
354
355
356/*******************************************************************************
357 *
358 * FUNCTION:    AcpiEvFixedEventDispatch
359 *
360 * PARAMETERS:  Event               - Event type
361 *
362 * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
363 *
364 * DESCRIPTION: Clears the status bit for the requested event, calls the
365 *              handler that previously registered for the event.
366 *
367 ******************************************************************************/
368
369static UINT32
370AcpiEvFixedEventDispatch (
371    UINT32                  Event)
372{
373
374    ACPI_FUNCTION_ENTRY ();
375
376
377    /* Clear the status bit */
378
379    (void) AcpiWriteBitRegister (
380            AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
381            ACPI_CLEAR_STATUS);
382
383    /*
384     * Make sure we've got a handler. If not, report an error. The event is
385     * disabled to prevent further interrupts.
386     */
387    if (NULL == AcpiGbl_FixedEventHandlers[Event].Handler)
388    {
389        (void) AcpiWriteBitRegister (
390                AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
391                ACPI_DISABLE_EVENT);
392
393        ACPI_ERROR ((AE_INFO,
394            "No installed handler for fixed event [0x%08X]",
395            Event));
396
397        return (ACPI_INTERRUPT_NOT_HANDLED);
398    }
399
400    /* Invoke the Fixed Event handler */
401
402    return ((AcpiGbl_FixedEventHandlers[Event].Handler)(
403                AcpiGbl_FixedEventHandlers[Event].Context));
404}
405
406#endif /* !ACPI_REDUCED_HARDWARE */
407