drivers/acpi/events/evmisc.c

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