1 /******************************************************************************
3 * Module Name: evevent - Fixed Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_EVENTS
49 ACPI_MODULE_NAME("evevent")
50 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
51 /* Local prototypes */
52 static acpi_status acpi_ev_fixed_event_initialize(void);
54 static u32 acpi_ev_fixed_event_dispatch(u32 event);
56 /*******************************************************************************
58 * FUNCTION: acpi_ev_initialize_events
64 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
66 ******************************************************************************/
68 acpi_status acpi_ev_initialize_events(void)
72 ACPI_FUNCTION_TRACE(ev_initialize_events);
74 /* If Hardware Reduced flag is set, there are no fixed events */
76 if (acpi_gbl_reduced_hardware) {
77 return_ACPI_STATUS(AE_OK);
81 * Initialize the Fixed and General Purpose Events. This is done prior to
82 * enabling SCIs to prevent interrupts from occurring before the handlers
85 status = acpi_ev_fixed_event_initialize();
86 if (ACPI_FAILURE(status)) {
87 ACPI_EXCEPTION((AE_INFO, status,
88 "Unable to initialize fixed events"));
89 return_ACPI_STATUS(status);
92 status = acpi_ev_gpe_initialize();
93 if (ACPI_FAILURE(status)) {
94 ACPI_EXCEPTION((AE_INFO, status,
95 "Unable to initialize general purpose events"));
96 return_ACPI_STATUS(status);
99 return_ACPI_STATUS(status);
102 /*******************************************************************************
104 * FUNCTION: acpi_ev_install_xrupt_handlers
110 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
112 ******************************************************************************/
114 acpi_status acpi_ev_install_xrupt_handlers(void)
118 ACPI_FUNCTION_TRACE(ev_install_xrupt_handlers);
120 /* If Hardware Reduced flag is set, there is no ACPI h/w */
122 if (acpi_gbl_reduced_hardware) {
123 return_ACPI_STATUS(AE_OK);
126 /* Install the SCI handler */
128 status = acpi_ev_install_sci_handler();
129 if (ACPI_FAILURE(status)) {
130 ACPI_EXCEPTION((AE_INFO, status,
131 "Unable to install System Control Interrupt handler"));
132 return_ACPI_STATUS(status);
135 /* Install the handler for the Global Lock */
137 status = acpi_ev_init_global_lock_handler();
138 if (ACPI_FAILURE(status)) {
139 ACPI_EXCEPTION((AE_INFO, status,
140 "Unable to initialize Global Lock handler"));
141 return_ACPI_STATUS(status);
144 acpi_gbl_events_initialized = TRUE;
145 return_ACPI_STATUS(status);
148 /*******************************************************************************
150 * FUNCTION: acpi_ev_fixed_event_initialize
156 * DESCRIPTION: Install the fixed event handlers and disable all fixed events.
158 ******************************************************************************/
160 static acpi_status acpi_ev_fixed_event_initialize(void)
166 * Initialize the structure that keeps track of fixed event handlers and
167 * enable the fixed events.
169 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
170 acpi_gbl_fixed_event_handlers[i].handler = NULL;
171 acpi_gbl_fixed_event_handlers[i].context = NULL;
173 /* Disable the fixed event */
175 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) {
177 acpi_write_bit_register(acpi_gbl_fixed_event_info
178 [i].enable_register_id,
180 if (ACPI_FAILURE(status)) {
189 /*******************************************************************************
191 * FUNCTION: acpi_ev_fixed_event_detect
195 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
197 * DESCRIPTION: Checks the PM status register for active fixed events
199 ******************************************************************************/
201 u32 acpi_ev_fixed_event_detect(void)
203 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
209 ACPI_FUNCTION_NAME(ev_fixed_event_detect);
212 * Read the fixed feature status and enable registers, as all the cases
213 * depend on their values. Ignore errors here.
215 status = acpi_hw_register_read(ACPI_REGISTER_PM1_STATUS, &fixed_status);
217 acpi_hw_register_read(ACPI_REGISTER_PM1_ENABLE, &fixed_enable);
218 if (ACPI_FAILURE(status)) {
222 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
223 "Fixed Event Block: Enable %08X Status %08X\n",
224 fixed_enable, fixed_status));
227 * Check for all possible Fixed Events and dispatch those that are active
229 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
231 /* Both the status and enable bits must be on for this event */
233 if ((fixed_status & acpi_gbl_fixed_event_info[i].
235 && (fixed_enable & acpi_gbl_fixed_event_info[i].
238 * Found an active (signalled) event. Invoke global event
239 * handler if present.
241 acpi_fixed_event_count[i]++;
242 if (acpi_gbl_global_event_handler) {
243 acpi_gbl_global_event_handler
244 (ACPI_EVENT_TYPE_FIXED, NULL, i,
245 acpi_gbl_global_event_handler_context);
248 int_status |= acpi_ev_fixed_event_dispatch(i);
255 /*******************************************************************************
257 * FUNCTION: acpi_ev_fixed_event_dispatch
259 * PARAMETERS: event - Event type
261 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
263 * DESCRIPTION: Clears the status bit for the requested event, calls the
264 * handler that previously registered for the event.
265 * NOTE: If there is no handler for the event, the event is
266 * disabled to prevent further interrupts.
268 ******************************************************************************/
270 static u32 acpi_ev_fixed_event_dispatch(u32 event)
273 ACPI_FUNCTION_ENTRY();
275 /* Clear the status bit */
277 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event].
278 status_register_id, ACPI_CLEAR_STATUS);
281 * Make sure that a handler exists. If not, report an error
282 * and disable the event to prevent further interrupts.
284 if (!acpi_gbl_fixed_event_handlers[event].handler) {
285 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event].
290 "No installed handler for fixed event - %s (%u), disabling",
291 acpi_ut_get_event_name(event), event));
293 return (ACPI_INTERRUPT_NOT_HANDLED);
296 /* Invoke the Fixed Event handler */
298 return ((acpi_gbl_fixed_event_handlers[event].
299 handler) (acpi_gbl_fixed_event_handlers[event].context));
302 #endif /* !ACPI_REDUCED_HARDWARE */