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