1 /****************************************************************************** 2 * 3 * Module Name: evevent - Fixed Event handling and dispatch 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2010, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 25 * 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. 29 * 30 * NO WARRANTY 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. 42 */ 43 44 #include <acpi/acpi.h> 45 #include "accommon.h" 46 #include "acevents.h" 47 48 #define _COMPONENT ACPI_EVENTS 49 ACPI_MODULE_NAME("evevent") 50 51 /* Local prototypes */ 52 static acpi_status acpi_ev_fixed_event_initialize(void); 53 54 static u32 acpi_ev_fixed_event_dispatch(u32 event); 55 56 /******************************************************************************* 57 * 58 * FUNCTION: acpi_ev_initialize_events 59 * 60 * PARAMETERS: None 61 * 62 * RETURN: Status 63 * 64 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE) 65 * 66 ******************************************************************************/ 67 68 acpi_status acpi_ev_initialize_events(void) 69 { 70 acpi_status status; 71 72 ACPI_FUNCTION_TRACE(ev_initialize_events); 73 74 /* 75 * Initialize the Fixed and General Purpose Events. This is done prior to 76 * enabling SCIs to prevent interrupts from occurring before the handlers 77 * are installed. 78 */ 79 status = acpi_ev_fixed_event_initialize(); 80 if (ACPI_FAILURE(status)) { 81 ACPI_EXCEPTION((AE_INFO, status, 82 "Unable to initialize fixed events")); 83 return_ACPI_STATUS(status); 84 } 85 86 status = acpi_ev_gpe_initialize(); 87 if (ACPI_FAILURE(status)) { 88 ACPI_EXCEPTION((AE_INFO, status, 89 "Unable to initialize general purpose events")); 90 return_ACPI_STATUS(status); 91 } 92 93 return_ACPI_STATUS(status); 94 } 95 96 /******************************************************************************* 97 * 98 * FUNCTION: acpi_ev_install_fadt_gpes 99 * 100 * PARAMETERS: None 101 * 102 * RETURN: Status 103 * 104 * DESCRIPTION: Completes initialization of the FADT-defined GPE blocks 105 * (0 and 1). The HW must be fully initialized at this point, 106 * including global lock support. 107 * 108 ******************************************************************************/ 109 110 acpi_status acpi_ev_install_fadt_gpes(void) 111 { 112 acpi_status status; 113 114 ACPI_FUNCTION_TRACE(ev_install_fadt_gpes); 115 116 /* Namespace must be locked */ 117 118 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); 119 if (ACPI_FAILURE(status)) { 120 return (status); 121 } 122 123 /* FADT GPE Block 0 */ 124 125 (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device, 126 acpi_gbl_gpe_fadt_blocks[0]); 127 128 /* FADT GPE Block 1 */ 129 130 (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device, 131 acpi_gbl_gpe_fadt_blocks[1]); 132 133 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); 134 return_ACPI_STATUS(AE_OK); 135 } 136 137 /******************************************************************************* 138 * 139 * FUNCTION: acpi_ev_install_xrupt_handlers 140 * 141 * PARAMETERS: None 142 * 143 * RETURN: Status 144 * 145 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock 146 * 147 ******************************************************************************/ 148 149 acpi_status acpi_ev_install_xrupt_handlers(void) 150 { 151 acpi_status status; 152 153 ACPI_FUNCTION_TRACE(ev_install_xrupt_handlers); 154 155 /* Install the SCI handler */ 156 157 status = acpi_ev_install_sci_handler(); 158 if (ACPI_FAILURE(status)) { 159 ACPI_EXCEPTION((AE_INFO, status, 160 "Unable to install System Control Interrupt handler")); 161 return_ACPI_STATUS(status); 162 } 163 164 /* Install the handler for the Global Lock */ 165 166 status = acpi_ev_init_global_lock_handler(); 167 if (ACPI_FAILURE(status)) { 168 ACPI_EXCEPTION((AE_INFO, status, 169 "Unable to initialize Global Lock handler")); 170 return_ACPI_STATUS(status); 171 } 172 173 acpi_gbl_events_initialized = TRUE; 174 return_ACPI_STATUS(status); 175 } 176 177 /******************************************************************************* 178 * 179 * FUNCTION: acpi_ev_fixed_event_initialize 180 * 181 * PARAMETERS: None 182 * 183 * RETURN: Status 184 * 185 * DESCRIPTION: Install the fixed event handlers and disable all fixed events. 186 * 187 ******************************************************************************/ 188 189 static acpi_status acpi_ev_fixed_event_initialize(void) 190 { 191 u32 i; 192 acpi_status status; 193 194 /* 195 * Initialize the structure that keeps track of fixed event handlers and 196 * enable the fixed events. 197 */ 198 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) { 199 acpi_gbl_fixed_event_handlers[i].handler = NULL; 200 acpi_gbl_fixed_event_handlers[i].context = NULL; 201 202 /* Disable the fixed event */ 203 204 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) { 205 status = 206 acpi_write_bit_register(acpi_gbl_fixed_event_info 207 [i].enable_register_id, 208 ACPI_DISABLE_EVENT); 209 if (ACPI_FAILURE(status)) { 210 return (status); 211 } 212 } 213 } 214 215 return (AE_OK); 216 } 217 218 /******************************************************************************* 219 * 220 * FUNCTION: acpi_ev_fixed_event_detect 221 * 222 * PARAMETERS: None 223 * 224 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED 225 * 226 * DESCRIPTION: Checks the PM status register for active fixed events 227 * 228 ******************************************************************************/ 229 230 u32 acpi_ev_fixed_event_detect(void) 231 { 232 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED; 233 u32 fixed_status; 234 u32 fixed_enable; 235 u32 i; 236 237 ACPI_FUNCTION_NAME(ev_fixed_event_detect); 238 239 /* 240 * Read the fixed feature status and enable registers, as all the cases 241 * depend on their values. Ignore errors here. 242 */ 243 (void)acpi_hw_register_read(ACPI_REGISTER_PM1_STATUS, &fixed_status); 244 (void)acpi_hw_register_read(ACPI_REGISTER_PM1_ENABLE, &fixed_enable); 245 246 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS, 247 "Fixed Event Block: Enable %08X Status %08X\n", 248 fixed_enable, fixed_status)); 249 250 /* 251 * Check for all possible Fixed Events and dispatch those that are active 252 */ 253 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) { 254 255 /* Both the status and enable bits must be on for this event */ 256 257 if ((fixed_status & acpi_gbl_fixed_event_info[i]. 258 status_bit_mask) 259 && (fixed_enable & acpi_gbl_fixed_event_info[i]. 260 enable_bit_mask)) { 261 262 /* Found an active (signalled) event */ 263 acpi_os_fixed_event_count(i); 264 int_status |= acpi_ev_fixed_event_dispatch(i); 265 } 266 } 267 268 return (int_status); 269 } 270 271 /******************************************************************************* 272 * 273 * FUNCTION: acpi_ev_fixed_event_dispatch 274 * 275 * PARAMETERS: Event - Event type 276 * 277 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED 278 * 279 * DESCRIPTION: Clears the status bit for the requested event, calls the 280 * handler that previously registered for the event. 281 * 282 ******************************************************************************/ 283 284 static u32 acpi_ev_fixed_event_dispatch(u32 event) 285 { 286 287 ACPI_FUNCTION_ENTRY(); 288 289 /* Clear the status bit */ 290 291 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event]. 292 status_register_id, ACPI_CLEAR_STATUS); 293 294 /* 295 * Make sure we've got a handler. If not, report an error. The event is 296 * disabled to prevent further interrupts. 297 */ 298 if (NULL == acpi_gbl_fixed_event_handlers[event].handler) { 299 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event]. 300 enable_register_id, 301 ACPI_DISABLE_EVENT); 302 303 ACPI_ERROR((AE_INFO, 304 "No installed handler for fixed event [0x%08X]", 305 event)); 306 307 return (ACPI_INTERRUPT_NOT_HANDLED); 308 } 309 310 /* Invoke the Fixed Event handler */ 311 312 return ((acpi_gbl_fixed_event_handlers[event]. 313 handler) (acpi_gbl_fixed_event_handlers[event].context)); 314 } 315