drivers/acpi/acpica/evevent.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evevent - Fixed Event handling and dispatch
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2011, 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_xrupt_handlers
  99  *
 100  * PARAMETERS:  None
 101  *
 102  * RETURN:      Status
 103  *
 104  * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
 105  *
 106  ******************************************************************************/
 107
 108 acpi_status acpi_ev_install_xrupt_handlers(void)
 109 {
 110         acpi_status status;
 111
 112         ACPI_FUNCTION_TRACE(ev_install_xrupt_handlers);
 113
 114         /* Install the SCI handler */
 115
 116         status = acpi_ev_install_sci_handler();
 117         if (ACPI_FAILURE(status)) {
 118                 ACPI_EXCEPTION((AE_INFO, status,
 119                                 "Unable to install System Control Interrupt handler"));
 120                 return_ACPI_STATUS(status);
 121         }
 122
 123         /* Install the handler for the Global Lock */
 124
 125         status = acpi_ev_init_global_lock_handler();
 126         if (ACPI_FAILURE(status)) {
 127                 ACPI_EXCEPTION((AE_INFO, status,
 128                                 "Unable to initialize Global Lock handler"));
 129                 return_ACPI_STATUS(status);
 130         }
 131
 132         acpi_gbl_events_initialized = TRUE;
 133         return_ACPI_STATUS(status);
 134 }
 135
 136 /*******************************************************************************
 137  *
 138  * FUNCTION:    acpi_ev_fixed_event_initialize
 139  *
 140  * PARAMETERS:  None
 141  *
 142  * RETURN:      Status
 143  *
 144  * DESCRIPTION: Install the fixed event handlers and disable all fixed events.
 145  *
 146  ******************************************************************************/
 147
 148 static acpi_status acpi_ev_fixed_event_initialize(void)
 149 {
 150         u32 i;
 151         acpi_status status;
 152
 153         /*
 154          * Initialize the structure that keeps track of fixed event handlers and
 155          * enable the fixed events.
 156          */
 157         for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
 158                 acpi_gbl_fixed_event_handlers[i].handler = NULL;
 159                 acpi_gbl_fixed_event_handlers[i].context = NULL;
 160
 161                 /* Disable the fixed event */
 162
 163                 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) {
 164                         status =
 165                             acpi_write_bit_register(acpi_gbl_fixed_event_info
 166                                                     [i].enable_register_id,
 167                                                     ACPI_DISABLE_EVENT);
 168                         if (ACPI_FAILURE(status)) {
 169                                 return (status);
 170                         }
 171                 }
 172         }
 173
 174         return (AE_OK);
 175 }
 176
 177 /*******************************************************************************
 178  *
 179  * FUNCTION:    acpi_ev_fixed_event_detect
 180  *
 181  * PARAMETERS:  None
 182  *
 183  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 184  *
 185  * DESCRIPTION: Checks the PM status register for active fixed events
 186  *
 187  ******************************************************************************/
 188
 189 u32 acpi_ev_fixed_event_detect(void)
 190 {
 191         u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
 192         u32 fixed_status;
 193         u32 fixed_enable;
 194         u32 i;
 195
 196         ACPI_FUNCTION_NAME(ev_fixed_event_detect);
 197
 198         /*
 199          * Read the fixed feature status and enable registers, as all the cases
 200          * depend on their values. Ignore errors here.
 201          */
 202         (void)acpi_hw_register_read(ACPI_REGISTER_PM1_STATUS, &fixed_status);
 203         (void)acpi_hw_register_read(ACPI_REGISTER_PM1_ENABLE, &fixed_enable);
 204
 205         ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
 206                           "Fixed Event Block: Enable %08X Status %08X\n",
 207                           fixed_enable, fixed_status));
 208
 209         /*
 210          * Check for all possible Fixed Events and dispatch those that are active
 211          */
 212         for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
 213
 214                 /* Both the status and enable bits must be on for this event */
 215
 216                 if ((fixed_status & acpi_gbl_fixed_event_info[i].
 217                      status_bit_mask)
 218                     && (fixed_enable & acpi_gbl_fixed_event_info[i].
 219                         enable_bit_mask)) {
 220                         /*
 221                          * Found an active (signalled) event. Invoke global event
 222                          * handler if present.
 223                          */
 224                         acpi_fixed_event_count[i]++;
 225                         if (acpi_gbl_global_event_handler) {
 226                                 acpi_gbl_global_event_handler
 227                                     (ACPI_EVENT_TYPE_FIXED, NULL, i,
 228                                      acpi_gbl_global_event_handler_context);
 229                         }
 230
 231                         int_status |= acpi_ev_fixed_event_dispatch(i);
 232                 }
 233         }
 234
 235         return (int_status);
 236 }
 237
 238 /*******************************************************************************
 239  *
 240  * FUNCTION:    acpi_ev_fixed_event_dispatch
 241  *
 242  * PARAMETERS:  Event               - Event type
 243  *
 244  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 245  *
 246  * DESCRIPTION: Clears the status bit for the requested event, calls the
 247  *              handler that previously registered for the event.
 248  *
 249  ******************************************************************************/
 250
 251 static u32 acpi_ev_fixed_event_dispatch(u32 event)
 252 {
 253
 254         ACPI_FUNCTION_ENTRY();
 255
 256         /* Clear the status bit */
 257
 258         (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event].
 259                                       status_register_id, ACPI_CLEAR_STATUS);
 260
 261         /*
 262          * Make sure we've got a handler. If not, report an error. The event is
 263          * disabled to prevent further interrupts.
 264          */
 265         if (NULL == acpi_gbl_fixed_event_handlers[event].handler) {
 266                 (void)acpi_write_bit_register(acpi_gbl_fixed_event_info[event].
 267                                               enable_register_id,
 268                                               ACPI_DISABLE_EVENT);
 269
 270                 ACPI_ERROR((AE_INFO,
 271                             "No installed handler for fixed event [0x%08X]",
 272                             event));
 273
 274                 return (ACPI_INTERRUPT_NOT_HANDLED);
 275         }
 276
 277         /* Invoke the Fixed Event handler */
 278
 279         return ((acpi_gbl_fixed_event_handlers[event].
 280                  handler) (acpi_gbl_fixed_event_handlers[event].context));
 281 }