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