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