drivers/acpi/events/evmisc.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evmisc - Miscellaneous event manager support functions
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2004, R. Byron Moore
   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 <acpi/acevents.h>
  46 #include <acpi/acnamesp.h>
  47 #include <acpi/acinterp.h>
  48
  49 #define _COMPONENT          ACPI_EVENTS
  50          ACPI_MODULE_NAME    ("evmisc")
  51
  52
  53 /*******************************************************************************
  54  *
  55  * FUNCTION:    acpi_ev_is_notify_object
  56  *
  57  * PARAMETERS:  Node            - Node to check
  58  *
  59  * RETURN:      TRUE if notifies allowed on this object
  60  *
  61  * DESCRIPTION: Check type of node for a object that supports notifies.
  62  *
  63  *              TBD: This could be replaced by a flag bit in the node.
  64  *
  65  ******************************************************************************/
  66
  67 u8
  68 acpi_ev_is_notify_object (
  69         struct acpi_namespace_node      *node)
  70 {
  71         switch (node->type) {
  72         case ACPI_TYPE_DEVICE:
  73         case ACPI_TYPE_PROCESSOR:
  74         case ACPI_TYPE_POWER:
  75         case ACPI_TYPE_THERMAL:
  76                 /*
  77                  * These are the ONLY objects that can receive ACPI notifications
  78                  */
  79                 return (TRUE);
  80
  81         default:
  82                 return (FALSE);
  83         }
  84 }
  85
  86
  87 /*******************************************************************************
  88  *
  89  * FUNCTION:    acpi_ev_queue_notify_request
  90  *
  91  * PARAMETERS:
  92  *
  93  * RETURN:      None.
  94  *
  95  * DESCRIPTION: Dispatch a device notification event to a previously
  96  *              installed handler.
  97  *
  98  ******************************************************************************/
  99
 100 #ifdef ACPI_DEBUG_OUTPUT
 101 static const char                *acpi_notify_value_names[] =
 102 {
 103         "Bus Check",
 104         "Device Check",
 105         "Device Wake",
 106         "Eject request",
 107         "Device Check Light",
 108         "Frequency Mismatch",
 109         "Bus Mode Mismatch",
 110         "Power Fault"
 111 };
 112 #endif
 113
 114 acpi_status
 115 acpi_ev_queue_notify_request (
 116         struct acpi_namespace_node      *node,
 117         u32                             notify_value)
 118 {
 119         union acpi_operand_object       *obj_desc;
 120         union acpi_operand_object       *handler_obj = NULL;
 121         union acpi_generic_state        *notify_info;
 122         acpi_status                     status = AE_OK;
 123
 124
 125         ACPI_FUNCTION_NAME ("ev_queue_notify_request");
 126
 127
 128         /*
 129          * For value 3 (Ejection Request), some device method may need to be run.
 130          * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need to be run.
 131          * For value 0x80 (Status Change) on the power button or sleep button,
 132          * initiate soft-off or sleep operation?
 133          */
 134         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 135                 "Dispatching Notify(%X) on node %p\n", notify_value, node));
 136
 137         if (notify_value <= 7) {
 138                 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: %s\n",
 139                                 acpi_notify_value_names[notify_value]));
 140         }
 141         else {
 142                 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 143                                 "notify value: 0x%2.2x **Device Specific**\n",
 144                                 notify_value));
 145         }
 146
 147         /*
 148          * Get the notify object attached to the NS Node
 149          */
 150         obj_desc = acpi_ns_get_attached_object (node);
 151         if (obj_desc) {
 152                 /* We have the notify object, Get the right handler */
 153
 154                 switch (node->type) {
 155                 case ACPI_TYPE_DEVICE:
 156                 case ACPI_TYPE_THERMAL:
 157                 case ACPI_TYPE_PROCESSOR:
 158                 case ACPI_TYPE_POWER:
 159
 160                         if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
 161                                 handler_obj = obj_desc->common_notify.system_notify;
 162                         }
 163                         else {
 164                                 handler_obj = obj_desc->common_notify.device_notify;
 165                         }
 166                         break;
 167
 168                 default:
 169                         /* All other types are not supported */
 170                         return (AE_TYPE);
 171                 }
 172         }
 173
 174         /* If there is any handler to run, schedule the dispatcher */
 175
 176         if ((acpi_gbl_system_notify.handler && (notify_value <= ACPI_MAX_SYS_NOTIFY)) ||
 177                 (acpi_gbl_device_notify.handler && (notify_value > ACPI_MAX_SYS_NOTIFY)) ||
 178                 handler_obj) {
 179                 notify_info = acpi_ut_create_generic_state ();
 180                 if (!notify_info) {
 181                         return (AE_NO_MEMORY);
 182                 }
 183
 184                 notify_info->common.data_type = ACPI_DESC_TYPE_STATE_NOTIFY;
 185                 notify_info->notify.node      = node;
 186                 notify_info->notify.value     = (u16) notify_value;
 187                 notify_info->notify.handler_obj = handler_obj;
 188
 189                 status = acpi_os_queue_for_execution (OSD_PRIORITY_HIGH,
 190                                   acpi_ev_notify_dispatch, notify_info);
 191                 if (ACPI_FAILURE (status)) {
 192                         acpi_ut_delete_generic_state (notify_info);
 193                 }
 194         }
 195
 196         if (!handler_obj) {
 197                 /* There is no per-device notify handler for this device */
 198
 199                 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 200                         "No notify handler for [%4.4s] node %p\n",
 201                         acpi_ut_get_node_name (node), node));
 202         }
 203
 204         return (status);
 205 }
 206
 207
 208 /*******************************************************************************
 209  *
 210  * FUNCTION:    acpi_ev_notify_dispatch
 211  *
 212  * PARAMETERS:
 213  *
 214  * RETURN:      None.
 215  *
 216  * DESCRIPTION: Dispatch a device notification event to a previously
 217  *              installed handler.
 218  *
 219  ******************************************************************************/
 220
 221 void ACPI_SYSTEM_XFACE
 222 acpi_ev_notify_dispatch (
 223         void                            *context)
 224 {
 225         union acpi_generic_state        *notify_info = (union acpi_generic_state *) context;
 226         acpi_notify_handler             global_handler = NULL;
 227         void                            *global_context = NULL;
 228         union acpi_operand_object       *handler_obj;
 229
 230
 231         ACPI_FUNCTION_ENTRY ();
 232
 233
 234         /*
 235          * We will invoke a global notify handler if installed.
 236          * This is done _before_ we invoke the per-device handler attached to the device.
 237          */
 238         if (notify_info->notify.value <= ACPI_MAX_SYS_NOTIFY) {
 239                 /* Global system notification handler */
 240
 241                 if (acpi_gbl_system_notify.handler) {
 242                         global_handler = acpi_gbl_system_notify.handler;
 243                         global_context = acpi_gbl_system_notify.context;
 244                 }
 245         }
 246         else {
 247                 /* Global driver notification handler */
 248
 249                 if (acpi_gbl_device_notify.handler) {
 250                         global_handler = acpi_gbl_device_notify.handler;
 251                         global_context = acpi_gbl_device_notify.context;
 252                 }
 253         }
 254
 255         /* Invoke the system handler first, if present */
 256
 257         if (global_handler) {
 258                 global_handler (notify_info->notify.node, notify_info->notify.value, global_context);
 259         }
 260
 261         /* Now invoke the per-device handler, if present */
 262
 263         handler_obj = notify_info->notify.handler_obj;
 264         if (handler_obj) {
 265                 handler_obj->notify.handler (notify_info->notify.node, notify_info->notify.value,
 266                                   handler_obj->notify.context);
 267         }
 268
 269         /* All done with the info object */
 270
 271         acpi_ut_delete_generic_state (notify_info);
 272 }
 273
 274
 275 /*******************************************************************************
 276  *
 277  * FUNCTION:    acpi_ev_global_lock_thread
 278  *
 279  * RETURN:      None
 280  *
 281  * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the
 282  *              Global Lock.  Simply signal all threads that are waiting
 283  *              for the lock.
 284  *
 285  ******************************************************************************/
 286
 287 static void ACPI_SYSTEM_XFACE
 288 acpi_ev_global_lock_thread (
 289         void                            *context)
 290 {
 291         acpi_status                     status;
 292
 293
 294         /* Signal threads that are waiting for the lock */
 295
 296         if (acpi_gbl_global_lock_thread_count) {
 297                 /* Send sufficient units to the semaphore */
 298
 299                 status = acpi_os_signal_semaphore (acpi_gbl_global_lock_semaphore,
 300                                  acpi_gbl_global_lock_thread_count);
 301                 if (ACPI_FAILURE (status)) {
 302                         ACPI_REPORT_ERROR (("Could not signal Global Lock semaphore\n"));
 303                 }
 304         }
 305 }
 306
 307
 308 /*******************************************************************************
 309  *
 310  * FUNCTION:    acpi_ev_global_lock_handler
 311  *
 312  * RETURN:      Status
 313  *
 314  * DESCRIPTION: Invoked directly from the SCI handler when a global lock
 315  *              release interrupt occurs.  Grab the global lock and queue
 316  *              the global lock thread for execution
 317  *
 318  ******************************************************************************/
 319
 320 static u32
 321 acpi_ev_global_lock_handler (
 322         void                            *context)
 323 {
 324         u8                              acquired = FALSE;
 325         acpi_status                     status;
 326
 327
 328         /*
 329          * Attempt to get the lock
 330          * If we don't get it now, it will be marked pending and we will
 331          * take another interrupt when it becomes free.
 332          */
 333         ACPI_ACQUIRE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, acquired);
 334         if (acquired) {
 335                 /* Got the lock, now wake all threads waiting for it */
 336
 337                 acpi_gbl_global_lock_acquired = TRUE;
 338
 339                 /* Run the Global Lock thread which will signal all waiting threads */
 340
 341                 status = acpi_os_queue_for_execution (OSD_PRIORITY_HIGH,
 342                                   acpi_ev_global_lock_thread, context);
 343                 if (ACPI_FAILURE (status)) {
 344                         ACPI_REPORT_ERROR (("Could not queue Global Lock thread, %s\n",
 345                                 acpi_format_exception (status)));
 346
 347                         return (ACPI_INTERRUPT_NOT_HANDLED);
 348                 }
 349         }
 350
 351         return (ACPI_INTERRUPT_HANDLED);
 352 }
 353
 354
 355 /*******************************************************************************
 356  *
 357  * FUNCTION:    acpi_ev_init_global_lock_handler
 358  *
 359  * RETURN:      Status
 360  *
 361  * DESCRIPTION: Install a handler for the global lock release event
 362  *
 363  ******************************************************************************/
 364
 365 acpi_status
 366 acpi_ev_init_global_lock_handler (void)
 367 {
 368         acpi_status                     status;
 369
 370
 371         ACPI_FUNCTION_TRACE ("ev_init_global_lock_handler");
 372
 373
 374         acpi_gbl_global_lock_present = TRUE;
 375         status = acpi_install_fixed_event_handler (ACPI_EVENT_GLOBAL,
 376                           acpi_ev_global_lock_handler, NULL);
 377
 378         /*
 379          * If the global lock does not exist on this platform, the attempt
 380          * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick)
 381          * Map to AE_OK, but mark global lock as not present.
 382          * Any attempt to actually use the global lock will be flagged
 383          * with an error.
 384          */
 385         if (status == AE_NO_HARDWARE_RESPONSE) {
 386                 acpi_gbl_global_lock_present = FALSE;
 387                 status = AE_OK;
 388         }
 389
 390         return_ACPI_STATUS (status);
 391 }
 392
 393
 394 /******************************************************************************
 395  *
 396  * FUNCTION:    acpi_ev_acquire_global_lock
 397  *
 398  * RETURN:      Status
 399  *
 400  * DESCRIPTION: Attempt to gain ownership of the Global Lock.
 401  *
 402  *****************************************************************************/
 403
 404 acpi_status
 405 acpi_ev_acquire_global_lock (
 406         u16                             timeout)
 407 {
 408         acpi_status                     status = AE_OK;
 409         u8                              acquired = FALSE;
 410
 411
 412         ACPI_FUNCTION_TRACE ("ev_acquire_global_lock");
 413
 414
 415 #ifndef ACPI_APPLICATION
 416         /* Make sure that we actually have a global lock */
 417
 418         if (!acpi_gbl_global_lock_present) {
 419                 return_ACPI_STATUS (AE_NO_GLOBAL_LOCK);
 420         }
 421 #endif
 422
 423         /* One more thread wants the global lock */
 424
 425         acpi_gbl_global_lock_thread_count++;
 426
 427         /* If we (OS side vs. BIOS side) have the hardware lock already, we are done */
 428
 429         if (acpi_gbl_global_lock_acquired) {
 430                 return_ACPI_STATUS (AE_OK);
 431         }
 432
 433         /* We must acquire the actual hardware lock */
 434
 435         ACPI_ACQUIRE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, acquired);
 436         if (acquired) {
 437            /* We got the lock */
 438
 439                 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Acquired the HW Global Lock\n"));
 440
 441                 acpi_gbl_global_lock_acquired = TRUE;
 442                 return_ACPI_STATUS (AE_OK);
 443         }
 444
 445         /*
 446          * Did not get the lock.  The pending bit was set above, and we must now
 447          * wait until we get the global lock released interrupt.
 448          */
 449         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Waiting for the HW Global Lock\n"));
 450
 451         /*
 452          * Acquire the global lock semaphore first.
 453          * Since this wait will block, we must release the interpreter
 454          */
 455         status = acpi_ex_system_wait_semaphore (acpi_gbl_global_lock_semaphore,
 456                           timeout);
 457         return_ACPI_STATUS (status);
 458 }
 459
 460
 461 /*******************************************************************************
 462  *
 463  * FUNCTION:    acpi_ev_release_global_lock
 464  *
 465  * DESCRIPTION: Releases ownership of the Global Lock.
 466  *
 467  ******************************************************************************/
 468
 469 acpi_status
 470 acpi_ev_release_global_lock (void)
 471 {
 472         u8                              pending = FALSE;
 473         acpi_status                     status = AE_OK;
 474
 475
 476         ACPI_FUNCTION_TRACE ("ev_release_global_lock");
 477
 478
 479         if (!acpi_gbl_global_lock_thread_count) {
 480                 ACPI_REPORT_WARNING(("Cannot release HW Global Lock, it has not been acquired\n"));
 481                 return_ACPI_STATUS (AE_NOT_ACQUIRED);
 482         }
 483
 484         /* One fewer thread has the global lock */
 485
 486         acpi_gbl_global_lock_thread_count--;
 487         if (acpi_gbl_global_lock_thread_count) {
 488                 /* There are still some threads holding the lock, cannot release */
 489
 490                 return_ACPI_STATUS (AE_OK);
 491         }
 492
 493         /*
 494          * No more threads holding lock, we can do the actual hardware
 495          * release
 496          */
 497         ACPI_RELEASE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, pending);
 498         acpi_gbl_global_lock_acquired = FALSE;
 499
 500         /*
 501          * If the pending bit was set, we must write GBL_RLS to the control
 502          * register
 503          */
 504         if (pending) {
 505                 status = acpi_set_register (ACPI_BITREG_GLOBAL_LOCK_RELEASE, 1, ACPI_MTX_LOCK);
 506         }
 507
 508         return_ACPI_STATUS (status);
 509 }
 510
 511
 512 /******************************************************************************
 513  *
 514  * FUNCTION:    acpi_ev_terminate
 515  *
 516  * PARAMETERS:  none
 517  *
 518  * RETURN:      none
 519  *
 520  * DESCRIPTION: Disable events and free memory allocated for table storage.
 521  *
 522  ******************************************************************************/
 523
 524 void
 525 acpi_ev_terminate (void)
 526 {
 527         acpi_native_uint                i;
 528         acpi_status                     status;
 529
 530
 531         ACPI_FUNCTION_TRACE ("ev_terminate");
 532
 533
 534         if (acpi_gbl_events_initialized) {
 535                 /*
 536                  * Disable all event-related functionality.
 537                  * In all cases, on error, print a message but obviously we don't abort.
 538                  */
 539
 540                 /* Disable all fixed events */
 541
 542                 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
 543                         status = acpi_disable_event ((u32) i, 0);
 544                         if (ACPI_FAILURE (status)) {
 545                                 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not disable fixed event %d\n", (u32) i));
 546                         }
 547                 }
 548
 549                 /* Disable all GPEs in all GPE blocks */
 550
 551                 status = acpi_ev_walk_gpe_list (acpi_hw_disable_gpe_block);
 552
 553                 /* Remove SCI handler */
 554
 555                 status = acpi_ev_remove_sci_handler ();
 556                 if (ACPI_FAILURE(status)) {
 557                         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not remove SCI handler\n"));
 558                 }
 559         }
 560
 561         /* Return to original mode if necessary */
 562
 563         if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
 564                 status = acpi_disable ();
 565                 if (ACPI_FAILURE (status)) {
 566                         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "acpi_disable failed\n"));
 567                 }
 568         }
 569         return_VOID;
 570 }
 571