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