drivers/acpi/events/evmisc.c

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