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