1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 2 /****************************************************************************** 3 * 4 * Module Name: evevent - Fixed Event handling and dispatch 5 * 6 * Copyright (C) 2000 - 2022, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #include <acpi/acpi.h> 11 #include "accommon.h" 12 #include "acevents.h" 13 14 #define _COMPONENT ACPI_EVENTS 15 ACPI_MODULE_NAME("evevent") 16 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */ 17 /* Local prototypes */ 18 static acpi_status acpi_ev_fixed_event_initialize(void); 19 20 static u32 acpi_ev_fixed_event_dispatch(u32 event); 21 22 /******************************************************************************* 23 * 24 * FUNCTION: acpi_ev_initialize_events 25 * 26 * PARAMETERS: None 27 * 28 * RETURN: Status 29 * 30 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE) 31 * 32 ******************************************************************************/ 33 34 acpi_status acpi_ev_initialize_events(void) 35 { 36 acpi_status status; 37 38 ACPI_FUNCTION_TRACE(ev_initialize_events); 39 40 /* If Hardware Reduced flag is set, there are no fixed events */ 41 42 if (acpi_gbl_reduced_hardware) { 43 return_ACPI_STATUS(AE_OK); 44 } 45 46 /* 47 * Initialize the Fixed and General Purpose Events. This is done prior to 48 * enabling SCIs to prevent interrupts from occurring before the handlers 49 * are installed. 50 */ 51 status = acpi_ev_fixed_event_initialize(); 52 if (ACPI_FAILURE(status)) { 53 ACPI_EXCEPTION((AE_INFO, status, 54 "Unable to initialize fixed events")); 55 return_ACPI_STATUS(status); 56 } 57 58 status = acpi_ev_gpe_initialize(); 59 if (ACPI_FAILURE(status)) { 60 ACPI_EXCEPTION((AE_INFO, status, 61 "Unable to initialize general purpose events")); 62 return_ACPI_STATUS(status); 63 } 64 65 return_ACPI_STATUS(status); 66 } 67 68 /******************************************************************************* 69 * 70 * FUNCTION: acpi_ev_install_xrupt_handlers 71 * 72 * PARAMETERS: None 73 * 74 * RETURN: Status 75 * 76 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock 77 * 78 ******************************************************************************/ 79 80 acpi_status acpi_ev_install_xrupt_handlers(void) 81 { 82 acpi_status status; 83 84 ACPI_FUNCTION_TRACE(ev_install_xrupt_handlers); 85 86 /* If Hardware Reduced flag is set, there is no ACPI h/w */ 87 88 if (acpi_gbl_reduced_hardware) { 89 return_ACPI_STATUS(AE_OK); 90 } 91 92 /* Install the SCI handler */ 93 94 status = acpi_ev_install_sci_handler(); 95 if (ACPI_FAILURE(status)) { 96 ACPI_EXCEPTION((AE_INFO, status, 97 "Unable to install System Control Interrupt handler")); 98 return_ACPI_STATUS(status); 99 } 100 101 /* Install the handler for the Global Lock */ 102 103 status = acpi_ev_init_global_lock_handler(); 104 if (ACPI_FAILURE(status)) { 105 ACPI_EXCEPTION((AE_INFO, status, 106 "Unable to initialize Global Lock handler")); 107 return_ACPI_STATUS(status); 108 } 109 110 acpi_gbl_events_initialized = TRUE; 111 return_ACPI_STATUS(status); 112 } 113 114 /******************************************************************************* 115 * 116 * FUNCTION: acpi_ev_fixed_event_initialize 117 * 118 * PARAMETERS: None 119 * 120 * RETURN: Status 121 * 122 * DESCRIPTION: Install the fixed event handlers and disable all fixed events. 123 * 124 ******************************************************************************/ 125 126 static acpi_status acpi_ev_fixed_event_initialize(void) 127 { 128 u32 i; 129 acpi_status status; 130 131 /* 132 * Initialize the structure that keeps track of fixed event handlers and 133 * disable all of the fixed events. 134 */ 135 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) { 136 acpi_gbl_fixed_event_handlers[i].handler = NULL; 137 acpi_gbl_fixed_event_handlers[i].context = NULL; 138 139 /* Disable the fixed event */ 140 141 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) { 142 status = 143 acpi_write_bit_register(acpi_gbl_fixed_event_info 144 [i].enable_register_id, 145 (i == 146 ACPI_EVENT_PCIE_WAKE) ? 147 ACPI_ENABLE_EVENT : 148 ACPI_DISABLE_EVENT); 149 if (ACPI_FAILURE(status)) { 150 return (status); 151 } 152 } 153 } 154 155 return (AE_OK); 156 } 157 158 /******************************************************************************* 159 * 160 * FUNCTION: acpi_ev_fixed_event_detect 161 * 162 * PARAMETERS: None 163 * 164 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED 165 * 166 * DESCRIPTION: Checks the PM status register for active fixed events 167 * 168 ******************************************************************************/ 169 170 u32 acpi_ev_fixed_event_detect(void) 171 { 172 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED; 173 u32 fixed_status; 174 u32 fixed_enable; 175 u32 i; 176 acpi_status status; 177 178 ACPI_FUNCTION_NAME(ev_fixed_event_detect); 179 180 /* 181 * Read the fixed feature status and enable registers, as all the cases 182 * depend on their values. Ignore errors here. 183 */ 184 status = acpi_hw_register_read(ACPI_REGISTER_PM1_STATUS, &fixed_status); 185 status |= 186 acpi_hw_register_read(ACPI_REGISTER_PM1_ENABLE, &fixed_enable); 187 if (ACPI_FAILURE(status)) { 188 return (int_status); 189 } 190 191 if (fixed_enable & ACPI_BITMASK_PCIEXP_WAKE_DISABLE) 192 fixed_enable &= ~ACPI_BITMASK_PCIEXP_WAKE_DISABLE; 193 else 194 fixed_enable |= ACPI_BITMASK_PCIEXP_WAKE_DISABLE; 195 196 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS, 197 "Fixed Event Block: Enable %08X Status %08X\n", 198 fixed_enable, fixed_status)); 199 200 /* 201 * Check for all possible Fixed Events and dispatch those that are active 202 */ 203 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) { 204 205 /* Both the status and enable bits must be on for this event */ 206 207 if ((fixed_status & acpi_gbl_fixed_event_info[i]. 208 status_bit_mask) 209 && (fixed_enable & acpi_gbl_fixed_event_info[i]. 210 enable_bit_mask)) { 211 /* 212 * Found an active (signalled) event. Invoke global event 213 * handler if present. 214 */ 215 acpi_fixed_event_count[i]++; 216 if (acpi_gbl_global_event_handler) { 217 acpi_gbl_global_event_handler 218 (ACPI_EVENT_TYPE_FIXED, NULL, i, 219 acpi_gbl_global_event_handler_context); 220 } 221 222 int_status |= acpi_ev_fixed_event_dispatch(i); 223 } 224 } 225 226 return (int_status); 227 } 228 229 /******************************************************************************* 230 * 231 * FUNCTION: acpi_ev_fixed_event_dispatch 232 * 233 * PARAMETERS: event - Event type 234 * 235 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED 236 * 237 * DESCRIPTION: Clears the status bit for the requested event, calls the 238 * handler that previously registered for the event. 239 * NOTE: If there is no handler for the event, the event is 240 * disabled to prevent further interrupts. 241 * 242 ******************************************************************************/ 243 244 static u32 acpi_ev_fixed_event_dispatch(u32 event) 245 { 246 247 ACPI_FUNCTION_ENTRY(); 248 249 /* Clear the status bit */ 250 251 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event]. 252 status_register_id, ACPI_CLEAR_STATUS); 253 254 /* 255 * Make sure that a handler exists. If not, report an error 256 * and disable the event to prevent further interrupts. 257 */ 258 if (!acpi_gbl_fixed_event_handlers[event].handler) { 259 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event]. 260 enable_register_id, 261 (event == 262 ACPI_EVENT_PCIE_WAKE) ? 263 ACPI_ENABLE_EVENT : 264 ACPI_DISABLE_EVENT); 265 266 ACPI_ERROR((AE_INFO, 267 "No installed handler for fixed event - %s (%u), disabling", 268 acpi_ut_get_event_name(event), event)); 269 270 return (ACPI_INTERRUPT_NOT_HANDLED); 271 } 272 273 /* Invoke the Fixed Event handler */ 274 275 return ((acpi_gbl_fixed_event_handlers[event]. 276 handler) (acpi_gbl_fixed_event_handlers[event].context)); 277 } 278 279 /******************************************************************************* 280 * 281 * FUNCTION: acpi_any_fixed_event_status_set 282 * 283 * PARAMETERS: None 284 * 285 * RETURN: TRUE or FALSE 286 * 287 * DESCRIPTION: Checks the PM status register for active fixed events 288 * 289 ******************************************************************************/ 290 291 u32 acpi_any_fixed_event_status_set(void) 292 { 293 acpi_status status; 294 u32 in_status; 295 u32 in_enable; 296 u32 i; 297 298 status = acpi_hw_register_read(ACPI_REGISTER_PM1_ENABLE, &in_enable); 299 if (ACPI_FAILURE(status)) { 300 return (FALSE); 301 } 302 303 status = acpi_hw_register_read(ACPI_REGISTER_PM1_STATUS, &in_status); 304 if (ACPI_FAILURE(status)) { 305 return (FALSE); 306 } 307 308 /* 309 * Check for all possible Fixed Events and dispatch those that are active 310 */ 311 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) { 312 313 /* Both the status and enable bits must be on for this event */ 314 315 if ((in_status & acpi_gbl_fixed_event_info[i].status_bit_mask) && 316 (in_enable & acpi_gbl_fixed_event_info[i].enable_bit_mask)) { 317 return (TRUE); 318 } 319 } 320 321 return (FALSE); 322 } 323 324 #endif /* !ACPI_REDUCED_HARDWARE */ 325