Loading...
1/******************************************************************************
2 *
3 * Module Name: evxface - External interfaces for ACPI events
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, 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 "accommon.h"
46#include "acnamesp.h"
47#include "acevents.h"
48#include "acinterp.h"
49
50#define _COMPONENT ACPI_EVENTS
51ACPI_MODULE_NAME("evxface")
52
53/*******************************************************************************
54 *
55 * FUNCTION: acpi_install_exception_handler
56 *
57 * PARAMETERS: Handler - Pointer to the handler function for the
58 * event
59 *
60 * RETURN: Status
61 *
62 * DESCRIPTION: Saves the pointer to the handler function
63 *
64 ******************************************************************************/
65#ifdef ACPI_FUTURE_USAGE
66acpi_status acpi_install_exception_handler(acpi_exception_handler handler)
67{
68 acpi_status status;
69
70 ACPI_FUNCTION_TRACE(acpi_install_exception_handler);
71
72 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
73 if (ACPI_FAILURE(status)) {
74 return_ACPI_STATUS(status);
75 }
76
77 /* Don't allow two handlers. */
78
79 if (acpi_gbl_exception_handler) {
80 status = AE_ALREADY_EXISTS;
81 goto cleanup;
82 }
83
84 /* Install the handler */
85
86 acpi_gbl_exception_handler = handler;
87
88 cleanup:
89 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
90 return_ACPI_STATUS(status);
91}
92
93ACPI_EXPORT_SYMBOL(acpi_install_exception_handler)
94#endif /* ACPI_FUTURE_USAGE */
95
96/*******************************************************************************
97 *
98 * FUNCTION: acpi_install_global_event_handler
99 *
100 * PARAMETERS: Handler - Pointer to the global event handler function
101 * Context - Value passed to the handler on each event
102 *
103 * RETURN: Status
104 *
105 * DESCRIPTION: Saves the pointer to the handler function. The global handler
106 * is invoked upon each incoming GPE and Fixed Event. It is
107 * invoked at interrupt level at the time of the event dispatch.
108 * Can be used to update event counters, etc.
109 *
110 ******************************************************************************/
111acpi_status
112acpi_install_global_event_handler(ACPI_GBL_EVENT_HANDLER handler, void *context)
113{
114 acpi_status status;
115
116 ACPI_FUNCTION_TRACE(acpi_install_global_event_handler);
117
118 /* Parameter validation */
119
120 if (!handler) {
121 return_ACPI_STATUS(AE_BAD_PARAMETER);
122 }
123
124 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
125 if (ACPI_FAILURE(status)) {
126 return_ACPI_STATUS(status);
127 }
128
129 /* Don't allow two handlers. */
130
131 if (acpi_gbl_global_event_handler) {
132 status = AE_ALREADY_EXISTS;
133 goto cleanup;
134 }
135
136 acpi_gbl_global_event_handler = handler;
137 acpi_gbl_global_event_handler_context = context;
138
139 cleanup:
140 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
141 return_ACPI_STATUS(status);
142}
143
144ACPI_EXPORT_SYMBOL(acpi_install_global_event_handler)
145
146/*******************************************************************************
147 *
148 * FUNCTION: acpi_install_fixed_event_handler
149 *
150 * PARAMETERS: Event - Event type to enable.
151 * Handler - Pointer to the handler function for the
152 * event
153 * Context - Value passed to the handler on each GPE
154 *
155 * RETURN: Status
156 *
157 * DESCRIPTION: Saves the pointer to the handler function and then enables the
158 * event.
159 *
160 ******************************************************************************/
161acpi_status
162acpi_install_fixed_event_handler(u32 event,
163 acpi_event_handler handler, void *context)
164{
165 acpi_status status;
166
167 ACPI_FUNCTION_TRACE(acpi_install_fixed_event_handler);
168
169 /* Parameter validation */
170
171 if (event > ACPI_EVENT_MAX) {
172 return_ACPI_STATUS(AE_BAD_PARAMETER);
173 }
174
175 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
176 if (ACPI_FAILURE(status)) {
177 return_ACPI_STATUS(status);
178 }
179
180 /* Don't allow two handlers. */
181
182 if (NULL != acpi_gbl_fixed_event_handlers[event].handler) {
183 status = AE_ALREADY_EXISTS;
184 goto cleanup;
185 }
186
187 /* Install the handler before enabling the event */
188
189 acpi_gbl_fixed_event_handlers[event].handler = handler;
190 acpi_gbl_fixed_event_handlers[event].context = context;
191
192 status = acpi_clear_event(event);
193 if (ACPI_SUCCESS(status))
194 status = acpi_enable_event(event, 0);
195 if (ACPI_FAILURE(status)) {
196 ACPI_WARNING((AE_INFO, "Could not enable fixed event 0x%X",
197 event));
198
199 /* Remove the handler */
200
201 acpi_gbl_fixed_event_handlers[event].handler = NULL;
202 acpi_gbl_fixed_event_handlers[event].context = NULL;
203 } else {
204 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
205 "Enabled fixed event %X, Handler=%p\n", event,
206 handler));
207 }
208
209 cleanup:
210 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
211 return_ACPI_STATUS(status);
212}
213
214ACPI_EXPORT_SYMBOL(acpi_install_fixed_event_handler)
215
216/*******************************************************************************
217 *
218 * FUNCTION: acpi_remove_fixed_event_handler
219 *
220 * PARAMETERS: Event - Event type to disable.
221 * Handler - Address of the handler
222 *
223 * RETURN: Status
224 *
225 * DESCRIPTION: Disables the event and unregisters the event handler.
226 *
227 ******************************************************************************/
228acpi_status
229acpi_remove_fixed_event_handler(u32 event, acpi_event_handler handler)
230{
231 acpi_status status = AE_OK;
232
233 ACPI_FUNCTION_TRACE(acpi_remove_fixed_event_handler);
234
235 /* Parameter validation */
236
237 if (event > ACPI_EVENT_MAX) {
238 return_ACPI_STATUS(AE_BAD_PARAMETER);
239 }
240
241 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
242 if (ACPI_FAILURE(status)) {
243 return_ACPI_STATUS(status);
244 }
245
246 /* Disable the event before removing the handler */
247
248 status = acpi_disable_event(event, 0);
249
250 /* Always Remove the handler */
251
252 acpi_gbl_fixed_event_handlers[event].handler = NULL;
253 acpi_gbl_fixed_event_handlers[event].context = NULL;
254
255 if (ACPI_FAILURE(status)) {
256 ACPI_WARNING((AE_INFO,
257 "Could not write to fixed event enable register 0x%X",
258 event));
259 } else {
260 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Disabled fixed event %X\n",
261 event));
262 }
263
264 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
265 return_ACPI_STATUS(status);
266}
267
268ACPI_EXPORT_SYMBOL(acpi_remove_fixed_event_handler)
269
270/*******************************************************************************
271 *
272 * FUNCTION: acpi_populate_handler_object
273 *
274 * PARAMETERS: handler_obj - Handler object to populate
275 * handler_type - The type of handler:
276 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
277 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
278 * ACPI_ALL_NOTIFY: both system and device
279 * handler - Address of the handler
280 * context - Value passed to the handler on each GPE
281 * next - Address of a handler object to link to
282 *
283 * RETURN: None
284 *
285 * DESCRIPTION: Populate a handler object.
286 *
287 ******************************************************************************/
288static void
289acpi_populate_handler_object(struct acpi_object_notify_handler *handler_obj,
290 u32 handler_type,
291 acpi_notify_handler handler, void *context,
292 struct acpi_object_notify_handler *next)
293{
294 handler_obj->handler_type = handler_type;
295 handler_obj->handler = handler;
296 handler_obj->context = context;
297 handler_obj->next = next;
298}
299
300/*******************************************************************************
301 *
302 * FUNCTION: acpi_add_handler_object
303 *
304 * PARAMETERS: parent_obj - Parent of the new object
305 * handler - Address of the handler
306 * context - Value passed to the handler on each GPE
307 *
308 * RETURN: Status
309 *
310 * DESCRIPTION: Create a new handler object and populate it.
311 *
312 ******************************************************************************/
313static acpi_status
314acpi_add_handler_object(struct acpi_object_notify_handler *parent_obj,
315 acpi_notify_handler handler, void *context)
316{
317 struct acpi_object_notify_handler *handler_obj;
318
319 /* The parent must not be a defice notify handler object. */
320 if (parent_obj->handler_type & ACPI_DEVICE_NOTIFY)
321 return AE_BAD_PARAMETER;
322
323 handler_obj = ACPI_ALLOCATE_ZEROED(sizeof(*handler_obj));
324 if (!handler_obj)
325 return AE_NO_MEMORY;
326
327 acpi_populate_handler_object(handler_obj,
328 ACPI_SYSTEM_NOTIFY,
329 handler, context,
330 parent_obj->next);
331 parent_obj->next = handler_obj;
332
333 return AE_OK;
334}
335
336/*******************************************************************************
337 *
338 * FUNCTION: acpi_install_notify_handler
339 *
340 * PARAMETERS: Device - The device for which notifies will be handled
341 * handler_type - The type of handler:
342 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
343 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
344 * ACPI_ALL_NOTIFY: both system and device
345 * Handler - Address of the handler
346 * Context - Value passed to the handler on each GPE
347 *
348 * RETURN: Status
349 *
350 * DESCRIPTION: Install a handler for notifies on an ACPI device
351 *
352 ******************************************************************************/
353acpi_status
354acpi_install_notify_handler(acpi_handle device,
355 u32 handler_type,
356 acpi_notify_handler handler, void *context)
357{
358 union acpi_operand_object *obj_desc;
359 union acpi_operand_object *notify_obj;
360 struct acpi_namespace_node *node;
361 acpi_status status;
362
363 ACPI_FUNCTION_TRACE(acpi_install_notify_handler);
364
365 /* Parameter validation */
366
367 if ((!device) ||
368 (!handler) || (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
369 return_ACPI_STATUS(AE_BAD_PARAMETER);
370 }
371
372 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
373 if (ACPI_FAILURE(status)) {
374 return_ACPI_STATUS(status);
375 }
376
377 /* Convert and validate the device handle */
378
379 node = acpi_ns_validate_handle(device);
380 if (!node) {
381 status = AE_BAD_PARAMETER;
382 goto unlock_and_exit;
383 }
384
385 /*
386 * Root Object:
387 * Registering a notify handler on the root object indicates that the
388 * caller wishes to receive notifications for all objects. Note that
389 * only one <external> global handler can be regsitered (per notify type).
390 */
391 if (device == ACPI_ROOT_OBJECT) {
392
393 /* Make sure the handler is not already installed */
394
395 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
396 acpi_gbl_system_notify.handler) ||
397 ((handler_type & ACPI_DEVICE_NOTIFY) &&
398 acpi_gbl_device_notify.handler)) {
399 status = AE_ALREADY_EXISTS;
400 goto unlock_and_exit;
401 }
402
403 if (handler_type & ACPI_SYSTEM_NOTIFY) {
404 acpi_gbl_system_notify.node = node;
405 acpi_gbl_system_notify.handler = handler;
406 acpi_gbl_system_notify.context = context;
407 }
408
409 if (handler_type & ACPI_DEVICE_NOTIFY) {
410 acpi_gbl_device_notify.node = node;
411 acpi_gbl_device_notify.handler = handler;
412 acpi_gbl_device_notify.context = context;
413 }
414
415 /* Global notify handler installed */
416 }
417
418 /*
419 * All Other Objects:
420 * Caller will only receive notifications specific to the target object.
421 * Note that only certain object types can receive notifications.
422 */
423 else {
424 /* Notifies allowed on this object? */
425
426 if (!acpi_ev_is_notify_object(node)) {
427 status = AE_TYPE;
428 goto unlock_and_exit;
429 }
430
431 /* Check for an existing internal object */
432
433 obj_desc = acpi_ns_get_attached_object(node);
434 if (obj_desc) {
435
436 /* Object exists. */
437
438 /* For a device notify, make sure there's no handler. */
439 if ((handler_type & ACPI_DEVICE_NOTIFY) &&
440 obj_desc->common_notify.device_notify) {
441 status = AE_ALREADY_EXISTS;
442 goto unlock_and_exit;
443 }
444
445 /* System notifies may have more handlers installed. */
446 notify_obj = obj_desc->common_notify.system_notify;
447
448 if ((handler_type & ACPI_SYSTEM_NOTIFY) && notify_obj) {
449 struct acpi_object_notify_handler *parent_obj;
450
451 if (handler_type & ACPI_DEVICE_NOTIFY) {
452 status = AE_ALREADY_EXISTS;
453 goto unlock_and_exit;
454 }
455
456 parent_obj = ¬ify_obj->notify;
457 status = acpi_add_handler_object(parent_obj,
458 handler,
459 context);
460 goto unlock_and_exit;
461 }
462 } else {
463 /* Create a new object */
464
465 obj_desc = acpi_ut_create_internal_object(node->type);
466 if (!obj_desc) {
467 status = AE_NO_MEMORY;
468 goto unlock_and_exit;
469 }
470
471 /* Attach new object to the Node */
472
473 status =
474 acpi_ns_attach_object(device, obj_desc, node->type);
475
476 /* Remove local reference to the object */
477
478 acpi_ut_remove_reference(obj_desc);
479 if (ACPI_FAILURE(status)) {
480 goto unlock_and_exit;
481 }
482 }
483
484 /* Install the handler */
485
486 notify_obj =
487 acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_NOTIFY);
488 if (!notify_obj) {
489 status = AE_NO_MEMORY;
490 goto unlock_and_exit;
491 }
492
493 acpi_populate_handler_object(¬ify_obj->notify,
494 handler_type,
495 handler, context,
496 NULL);
497
498 if (handler_type & ACPI_SYSTEM_NOTIFY) {
499 obj_desc->common_notify.system_notify = notify_obj;
500 }
501
502 if (handler_type & ACPI_DEVICE_NOTIFY) {
503 obj_desc->common_notify.device_notify = notify_obj;
504 }
505
506 if (handler_type == ACPI_ALL_NOTIFY) {
507
508 /* Extra ref if installed in both */
509
510 acpi_ut_add_reference(notify_obj);
511 }
512 }
513
514 unlock_and_exit:
515 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
516 return_ACPI_STATUS(status);
517}
518
519ACPI_EXPORT_SYMBOL(acpi_install_notify_handler)
520
521/*******************************************************************************
522 *
523 * FUNCTION: acpi_remove_notify_handler
524 *
525 * PARAMETERS: Device - The device for which notifies will be handled
526 * handler_type - The type of handler:
527 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
528 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
529 * ACPI_ALL_NOTIFY: both system and device
530 * Handler - Address of the handler
531 *
532 * RETURN: Status
533 *
534 * DESCRIPTION: Remove a handler for notifies on an ACPI device
535 *
536 ******************************************************************************/
537acpi_status
538acpi_remove_notify_handler(acpi_handle device,
539 u32 handler_type, acpi_notify_handler handler)
540{
541 union acpi_operand_object *notify_obj;
542 union acpi_operand_object *obj_desc;
543 struct acpi_namespace_node *node;
544 acpi_status status;
545
546 ACPI_FUNCTION_TRACE(acpi_remove_notify_handler);
547
548 /* Parameter validation */
549
550 if ((!device) ||
551 (!handler) || (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
552 status = AE_BAD_PARAMETER;
553 goto exit;
554 }
555
556
557 /* Make sure all deferred tasks are completed */
558 acpi_os_wait_events_complete(NULL);
559
560 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
561 if (ACPI_FAILURE(status)) {
562 goto exit;
563 }
564
565 /* Convert and validate the device handle */
566
567 node = acpi_ns_validate_handle(device);
568 if (!node) {
569 status = AE_BAD_PARAMETER;
570 goto unlock_and_exit;
571 }
572
573 /* Root Object */
574
575 if (device == ACPI_ROOT_OBJECT) {
576 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
577 "Removing notify handler for namespace root object\n"));
578
579 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
580 !acpi_gbl_system_notify.handler) ||
581 ((handler_type & ACPI_DEVICE_NOTIFY) &&
582 !acpi_gbl_device_notify.handler)) {
583 status = AE_NOT_EXIST;
584 goto unlock_and_exit;
585 }
586
587 if (handler_type & ACPI_SYSTEM_NOTIFY) {
588 acpi_gbl_system_notify.node = NULL;
589 acpi_gbl_system_notify.handler = NULL;
590 acpi_gbl_system_notify.context = NULL;
591 }
592
593 if (handler_type & ACPI_DEVICE_NOTIFY) {
594 acpi_gbl_device_notify.node = NULL;
595 acpi_gbl_device_notify.handler = NULL;
596 acpi_gbl_device_notify.context = NULL;
597 }
598 }
599
600 /* All Other Objects */
601
602 else {
603 /* Notifies allowed on this object? */
604
605 if (!acpi_ev_is_notify_object(node)) {
606 status = AE_TYPE;
607 goto unlock_and_exit;
608 }
609
610 /* Check for an existing internal object */
611
612 obj_desc = acpi_ns_get_attached_object(node);
613 if (!obj_desc) {
614 status = AE_NOT_EXIST;
615 goto unlock_and_exit;
616 }
617
618 /* Object exists - make sure there's an existing handler */
619
620 if (handler_type & ACPI_SYSTEM_NOTIFY) {
621 struct acpi_object_notify_handler *handler_obj;
622 struct acpi_object_notify_handler *parent_obj;
623
624 notify_obj = obj_desc->common_notify.system_notify;
625 if (!notify_obj) {
626 status = AE_NOT_EXIST;
627 goto unlock_and_exit;
628 }
629
630 handler_obj = ¬ify_obj->notify;
631 parent_obj = NULL;
632 while (handler_obj->handler != handler) {
633 if (handler_obj->next) {
634 parent_obj = handler_obj;
635 handler_obj = handler_obj->next;
636 } else {
637 break;
638 }
639 }
640
641 if (handler_obj->handler != handler) {
642 status = AE_BAD_PARAMETER;
643 goto unlock_and_exit;
644 }
645
646 /*
647 * Remove the handler. There are three possible cases.
648 * First, we may need to remove a non-embedded object.
649 * Second, we may need to remove the embedded object's
650 * handler data, while non-embedded objects exist.
651 * Finally, we may need to remove the embedded object
652 * entirely along with its container.
653 */
654 if (parent_obj) {
655 /* Non-embedded object is being removed. */
656 parent_obj->next = handler_obj->next;
657 ACPI_FREE(handler_obj);
658 } else if (notify_obj->notify.next) {
659 /*
660 * The handler matches the embedded object, but
661 * there are more handler objects in the list.
662 * Replace the embedded object's data with the
663 * first next object's data and remove that
664 * object.
665 */
666 parent_obj = ¬ify_obj->notify;
667 handler_obj = notify_obj->notify.next;
668 *parent_obj = *handler_obj;
669 ACPI_FREE(handler_obj);
670 } else {
671 /* No more handler objects in the list. */
672 obj_desc->common_notify.system_notify = NULL;
673 acpi_ut_remove_reference(notify_obj);
674 }
675 }
676
677 if (handler_type & ACPI_DEVICE_NOTIFY) {
678 notify_obj = obj_desc->common_notify.device_notify;
679 if (!notify_obj) {
680 status = AE_NOT_EXIST;
681 goto unlock_and_exit;
682 }
683
684 if (notify_obj->notify.handler != handler) {
685 status = AE_BAD_PARAMETER;
686 goto unlock_and_exit;
687 }
688
689 /* Remove the handler */
690 obj_desc->common_notify.device_notify = NULL;
691 acpi_ut_remove_reference(notify_obj);
692 }
693 }
694
695 unlock_and_exit:
696 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
697 exit:
698 if (ACPI_FAILURE(status))
699 ACPI_EXCEPTION((AE_INFO, status, "Removing notify handler"));
700 return_ACPI_STATUS(status);
701}
702
703ACPI_EXPORT_SYMBOL(acpi_remove_notify_handler)
704
705/*******************************************************************************
706 *
707 * FUNCTION: acpi_install_gpe_handler
708 *
709 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
710 * defined GPEs)
711 * gpe_number - The GPE number within the GPE block
712 * Type - Whether this GPE should be treated as an
713 * edge- or level-triggered interrupt.
714 * Address - Address of the handler
715 * Context - Value passed to the handler on each GPE
716 *
717 * RETURN: Status
718 *
719 * DESCRIPTION: Install a handler for a General Purpose Event.
720 *
721 ******************************************************************************/
722acpi_status
723acpi_install_gpe_handler(acpi_handle gpe_device,
724 u32 gpe_number,
725 u32 type, acpi_gpe_handler address, void *context)
726{
727 struct acpi_gpe_event_info *gpe_event_info;
728 struct acpi_gpe_handler_info *handler;
729 acpi_status status;
730 acpi_cpu_flags flags;
731
732 ACPI_FUNCTION_TRACE(acpi_install_gpe_handler);
733
734 /* Parameter validation */
735
736 if ((!address) || (type & ~ACPI_GPE_XRUPT_TYPE_MASK)) {
737 return_ACPI_STATUS(AE_BAD_PARAMETER);
738 }
739
740 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
741 if (ACPI_FAILURE(status)) {
742 return_ACPI_STATUS(status);
743 }
744
745 /* Allocate memory for the handler object */
746
747 handler = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_handler_info));
748 if (!handler) {
749 status = AE_NO_MEMORY;
750 goto unlock_and_exit;
751 }
752
753 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
754
755 /* Ensure that we have a valid GPE number */
756
757 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
758 if (!gpe_event_info) {
759 status = AE_BAD_PARAMETER;
760 goto free_and_exit;
761 }
762
763 /* Make sure that there isn't a handler there already */
764
765 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
766 ACPI_GPE_DISPATCH_HANDLER) {
767 status = AE_ALREADY_EXISTS;
768 goto free_and_exit;
769 }
770
771 /* Allocate and init handler object */
772
773 handler->address = address;
774 handler->context = context;
775 handler->method_node = gpe_event_info->dispatch.method_node;
776 handler->original_flags = gpe_event_info->flags &
777 (ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK);
778
779 /*
780 * If the GPE is associated with a method, it might have been enabled
781 * automatically during initialization, in which case it has to be
782 * disabled now to avoid spurious execution of the handler.
783 */
784
785 if ((handler->original_flags & ACPI_GPE_DISPATCH_METHOD)
786 && gpe_event_info->runtime_count) {
787 handler->originally_enabled = 1;
788 (void)acpi_ev_remove_gpe_reference(gpe_event_info);
789 }
790
791 /* Install the handler */
792
793 gpe_event_info->dispatch.handler = handler;
794
795 /* Setup up dispatch flags to indicate handler (vs. method) */
796
797 gpe_event_info->flags &=
798 ~(ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK);
799 gpe_event_info->flags |= (u8) (type | ACPI_GPE_DISPATCH_HANDLER);
800
801 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
802
803unlock_and_exit:
804 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
805 return_ACPI_STATUS(status);
806
807free_and_exit:
808 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
809 ACPI_FREE(handler);
810 goto unlock_and_exit;
811}
812
813ACPI_EXPORT_SYMBOL(acpi_install_gpe_handler)
814
815/*******************************************************************************
816 *
817 * FUNCTION: acpi_remove_gpe_handler
818 *
819 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
820 * defined GPEs)
821 * gpe_number - The event to remove a handler
822 * Address - Address of the handler
823 *
824 * RETURN: Status
825 *
826 * DESCRIPTION: Remove a handler for a General Purpose acpi_event.
827 *
828 ******************************************************************************/
829acpi_status
830acpi_remove_gpe_handler(acpi_handle gpe_device,
831 u32 gpe_number, acpi_gpe_handler address)
832{
833 struct acpi_gpe_event_info *gpe_event_info;
834 struct acpi_gpe_handler_info *handler;
835 acpi_status status;
836 acpi_cpu_flags flags;
837
838 ACPI_FUNCTION_TRACE(acpi_remove_gpe_handler);
839
840 /* Parameter validation */
841
842 if (!address) {
843 return_ACPI_STATUS(AE_BAD_PARAMETER);
844 }
845
846 /* Make sure all deferred tasks are completed */
847
848 acpi_os_wait_events_complete(NULL);
849
850 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
851 if (ACPI_FAILURE(status)) {
852 return_ACPI_STATUS(status);
853 }
854
855 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
856
857 /* Ensure that we have a valid GPE number */
858
859 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
860 if (!gpe_event_info) {
861 status = AE_BAD_PARAMETER;
862 goto unlock_and_exit;
863 }
864
865 /* Make sure that a handler is indeed installed */
866
867 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) !=
868 ACPI_GPE_DISPATCH_HANDLER) {
869 status = AE_NOT_EXIST;
870 goto unlock_and_exit;
871 }
872
873 /* Make sure that the installed handler is the same */
874
875 if (gpe_event_info->dispatch.handler->address != address) {
876 status = AE_BAD_PARAMETER;
877 goto unlock_and_exit;
878 }
879
880 /* Remove the handler */
881
882 handler = gpe_event_info->dispatch.handler;
883
884 /* Restore Method node (if any), set dispatch flags */
885
886 gpe_event_info->dispatch.method_node = handler->method_node;
887 gpe_event_info->flags &=
888 ~(ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK);
889 gpe_event_info->flags |= handler->original_flags;
890
891 /*
892 * If the GPE was previously associated with a method and it was
893 * enabled, it should be enabled at this point to restore the
894 * post-initialization configuration.
895 */
896
897 if ((handler->original_flags & ACPI_GPE_DISPATCH_METHOD)
898 && handler->originally_enabled)
899 (void)acpi_ev_add_gpe_reference(gpe_event_info);
900
901 /* Now we can free the handler object */
902
903 ACPI_FREE(handler);
904
905unlock_and_exit:
906 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
907
908 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
909 return_ACPI_STATUS(status);
910}
911
912ACPI_EXPORT_SYMBOL(acpi_remove_gpe_handler)
913
914/*******************************************************************************
915 *
916 * FUNCTION: acpi_acquire_global_lock
917 *
918 * PARAMETERS: Timeout - How long the caller is willing to wait
919 * Handle - Where the handle to the lock is returned
920 * (if acquired)
921 *
922 * RETURN: Status
923 *
924 * DESCRIPTION: Acquire the ACPI Global Lock
925 *
926 * Note: Allows callers with the same thread ID to acquire the global lock
927 * multiple times. In other words, externally, the behavior of the global lock
928 * is identical to an AML mutex. On the first acquire, a new handle is
929 * returned. On any subsequent calls to acquire by the same thread, the same
930 * handle is returned.
931 *
932 ******************************************************************************/
933acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle)
934{
935 acpi_status status;
936
937 if (!handle) {
938 return (AE_BAD_PARAMETER);
939 }
940
941 /* Must lock interpreter to prevent race conditions */
942
943 acpi_ex_enter_interpreter();
944
945 status = acpi_ex_acquire_mutex_object(timeout,
946 acpi_gbl_global_lock_mutex,
947 acpi_os_get_thread_id());
948
949 if (ACPI_SUCCESS(status)) {
950
951 /* Return the global lock handle (updated in acpi_ev_acquire_global_lock) */
952
953 *handle = acpi_gbl_global_lock_handle;
954 }
955
956 acpi_ex_exit_interpreter();
957 return (status);
958}
959
960ACPI_EXPORT_SYMBOL(acpi_acquire_global_lock)
961
962/*******************************************************************************
963 *
964 * FUNCTION: acpi_release_global_lock
965 *
966 * PARAMETERS: Handle - Returned from acpi_acquire_global_lock
967 *
968 * RETURN: Status
969 *
970 * DESCRIPTION: Release the ACPI Global Lock. The handle must be valid.
971 *
972 ******************************************************************************/
973acpi_status acpi_release_global_lock(u32 handle)
974{
975 acpi_status status;
976
977 if (!handle || (handle != acpi_gbl_global_lock_handle)) {
978 return (AE_NOT_ACQUIRED);
979 }
980
981 status = acpi_ex_release_mutex_object(acpi_gbl_global_lock_mutex);
982 return (status);
983}
984
985ACPI_EXPORT_SYMBOL(acpi_release_global_lock)
1/******************************************************************************
2 *
3 * Module Name: evxface - External interfaces for ACPI events
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, 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#define EXPORT_ACPI_INTERFACES
45
46#include <acpi/acpi.h>
47#include "accommon.h"
48#include "acnamesp.h"
49#include "acevents.h"
50#include "acinterp.h"
51
52#define _COMPONENT ACPI_EVENTS
53ACPI_MODULE_NAME("evxface")
54#if (!ACPI_REDUCED_HARDWARE)
55/* Local prototypes */
56static acpi_status
57acpi_ev_install_gpe_handler(acpi_handle gpe_device,
58 u32 gpe_number,
59 u32 type,
60 u8 is_raw_handler,
61 acpi_gpe_handler address, void *context);
62
63#endif
64
65
66/*******************************************************************************
67 *
68 * FUNCTION: acpi_install_notify_handler
69 *
70 * PARAMETERS: device - The device for which notifies will be handled
71 * handler_type - The type of handler:
72 * ACPI_SYSTEM_NOTIFY: System Handler (00-7F)
73 * ACPI_DEVICE_NOTIFY: Device Handler (80-FF)
74 * ACPI_ALL_NOTIFY: Both System and Device
75 * handler - Address of the handler
76 * context - Value passed to the handler on each GPE
77 *
78 * RETURN: Status
79 *
80 * DESCRIPTION: Install a handler for notifications on an ACPI Device,
81 * thermal_zone, or Processor object.
82 *
83 * NOTES: The Root namespace object may have only one handler for each
84 * type of notify (System/Device). Device/Thermal/Processor objects
85 * may have one device notify handler, and multiple system notify
86 * handlers.
87 *
88 ******************************************************************************/
89
90acpi_status
91acpi_install_notify_handler(acpi_handle device,
92 u32 handler_type,
93 acpi_notify_handler handler, void *context)
94{
95 struct acpi_namespace_node *node =
96 ACPI_CAST_PTR(struct acpi_namespace_node, device);
97 union acpi_operand_object *obj_desc;
98 union acpi_operand_object *handler_obj;
99 acpi_status status;
100 u32 i;
101
102 ACPI_FUNCTION_TRACE(acpi_install_notify_handler);
103
104 /* Parameter validation */
105
106 if ((!device) || (!handler) || (!handler_type) ||
107 (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
108 return_ACPI_STATUS(AE_BAD_PARAMETER);
109 }
110
111 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
112 if (ACPI_FAILURE(status)) {
113 return_ACPI_STATUS(status);
114 }
115
116 /*
117 * Root Object:
118 * Registering a notify handler on the root object indicates that the
119 * caller wishes to receive notifications for all objects. Note that
120 * only one global handler can be registered per notify type.
121 * Ensure that a handler is not already installed.
122 */
123 if (device == ACPI_ROOT_OBJECT) {
124 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
125 if (handler_type & (i + 1)) {
126 if (acpi_gbl_global_notify[i].handler) {
127 status = AE_ALREADY_EXISTS;
128 goto unlock_and_exit;
129 }
130
131 acpi_gbl_global_notify[i].handler = handler;
132 acpi_gbl_global_notify[i].context = context;
133 }
134 }
135
136 goto unlock_and_exit; /* Global notify handler installed, all done */
137 }
138
139 /*
140 * All Other Objects:
141 * Caller will only receive notifications specific to the target
142 * object. Note that only certain object types are allowed to
143 * receive notifications.
144 */
145
146 /* Are Notifies allowed on this object? */
147
148 if (!acpi_ev_is_notify_object(node)) {
149 status = AE_TYPE;
150 goto unlock_and_exit;
151 }
152
153 /* Check for an existing internal object, might not exist */
154
155 obj_desc = acpi_ns_get_attached_object(node);
156 if (!obj_desc) {
157
158 /* Create a new object */
159
160 obj_desc = acpi_ut_create_internal_object(node->type);
161 if (!obj_desc) {
162 status = AE_NO_MEMORY;
163 goto unlock_and_exit;
164 }
165
166 /* Attach new object to the Node, remove local reference */
167
168 status = acpi_ns_attach_object(device, obj_desc, node->type);
169 acpi_ut_remove_reference(obj_desc);
170 if (ACPI_FAILURE(status)) {
171 goto unlock_and_exit;
172 }
173 }
174
175 /* Ensure that the handler is not already installed in the lists */
176
177 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
178 if (handler_type & (i + 1)) {
179 handler_obj = obj_desc->common_notify.notify_list[i];
180 while (handler_obj) {
181 if (handler_obj->notify.handler == handler) {
182 status = AE_ALREADY_EXISTS;
183 goto unlock_and_exit;
184 }
185
186 handler_obj = handler_obj->notify.next[i];
187 }
188 }
189 }
190
191 /* Create and populate a new notify handler object */
192
193 handler_obj = acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_NOTIFY);
194 if (!handler_obj) {
195 status = AE_NO_MEMORY;
196 goto unlock_and_exit;
197 }
198
199 handler_obj->notify.node = node;
200 handler_obj->notify.handler_type = handler_type;
201 handler_obj->notify.handler = handler;
202 handler_obj->notify.context = context;
203
204 /* Install the handler at the list head(s) */
205
206 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
207 if (handler_type & (i + 1)) {
208 handler_obj->notify.next[i] =
209 obj_desc->common_notify.notify_list[i];
210
211 obj_desc->common_notify.notify_list[i] = handler_obj;
212 }
213 }
214
215 /* Add an extra reference if handler was installed in both lists */
216
217 if (handler_type == ACPI_ALL_NOTIFY) {
218 acpi_ut_add_reference(handler_obj);
219 }
220
221unlock_and_exit:
222 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
223 return_ACPI_STATUS(status);
224}
225
226ACPI_EXPORT_SYMBOL(acpi_install_notify_handler)
227
228/*******************************************************************************
229 *
230 * FUNCTION: acpi_remove_notify_handler
231 *
232 * PARAMETERS: device - The device for which the handler is installed
233 * handler_type - The type of handler:
234 * ACPI_SYSTEM_NOTIFY: System Handler (00-7F)
235 * ACPI_DEVICE_NOTIFY: Device Handler (80-FF)
236 * ACPI_ALL_NOTIFY: Both System and Device
237 * handler - Address of the handler
238 *
239 * RETURN: Status
240 *
241 * DESCRIPTION: Remove a handler for notifies on an ACPI device
242 *
243 ******************************************************************************/
244acpi_status
245acpi_remove_notify_handler(acpi_handle device,
246 u32 handler_type, acpi_notify_handler handler)
247{
248 struct acpi_namespace_node *node =
249 ACPI_CAST_PTR(struct acpi_namespace_node, device);
250 union acpi_operand_object *obj_desc;
251 union acpi_operand_object *handler_obj;
252 union acpi_operand_object *previous_handler_obj;
253 acpi_status status = AE_OK;
254 u32 i;
255
256 ACPI_FUNCTION_TRACE(acpi_remove_notify_handler);
257
258 /* Parameter validation */
259
260 if ((!device) || (!handler) || (!handler_type) ||
261 (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
262 return_ACPI_STATUS(AE_BAD_PARAMETER);
263 }
264
265 /* Root Object. Global handlers are removed here */
266
267 if (device == ACPI_ROOT_OBJECT) {
268 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
269 if (handler_type & (i + 1)) {
270 status =
271 acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
272 if (ACPI_FAILURE(status)) {
273 return_ACPI_STATUS(status);
274 }
275
276 if (!acpi_gbl_global_notify[i].handler ||
277 (acpi_gbl_global_notify[i].handler !=
278 handler)) {
279 status = AE_NOT_EXIST;
280 goto unlock_and_exit;
281 }
282
283 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
284 "Removing global notify handler\n"));
285
286 acpi_gbl_global_notify[i].handler = NULL;
287 acpi_gbl_global_notify[i].context = NULL;
288
289 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
290
291 /* Make sure all deferred notify tasks are completed */
292
293 acpi_os_wait_events_complete();
294 }
295 }
296
297 return_ACPI_STATUS(AE_OK);
298 }
299
300 /* All other objects: Are Notifies allowed on this object? */
301
302 if (!acpi_ev_is_notify_object(node)) {
303 return_ACPI_STATUS(AE_TYPE);
304 }
305
306 /* Must have an existing internal object */
307
308 obj_desc = acpi_ns_get_attached_object(node);
309 if (!obj_desc) {
310 return_ACPI_STATUS(AE_NOT_EXIST);
311 }
312
313 /* Internal object exists. Find the handler and remove it */
314
315 for (i = 0; i < ACPI_NUM_NOTIFY_TYPES; i++) {
316 if (handler_type & (i + 1)) {
317 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
318 if (ACPI_FAILURE(status)) {
319 return_ACPI_STATUS(status);
320 }
321
322 handler_obj = obj_desc->common_notify.notify_list[i];
323 previous_handler_obj = NULL;
324
325 /* Attempt to find the handler in the handler list */
326
327 while (handler_obj &&
328 (handler_obj->notify.handler != handler)) {
329 previous_handler_obj = handler_obj;
330 handler_obj = handler_obj->notify.next[i];
331 }
332
333 if (!handler_obj) {
334 status = AE_NOT_EXIST;
335 goto unlock_and_exit;
336 }
337
338 /* Remove the handler object from the list */
339
340 if (previous_handler_obj) { /* Handler is not at the list head */
341 previous_handler_obj->notify.next[i] =
342 handler_obj->notify.next[i];
343 } else { /* Handler is at the list head */
344
345 obj_desc->common_notify.notify_list[i] =
346 handler_obj->notify.next[i];
347 }
348
349 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
350
351 /* Make sure all deferred notify tasks are completed */
352
353 acpi_os_wait_events_complete();
354 acpi_ut_remove_reference(handler_obj);
355 }
356 }
357
358 return_ACPI_STATUS(status);
359
360unlock_and_exit:
361 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
362 return_ACPI_STATUS(status);
363}
364
365ACPI_EXPORT_SYMBOL(acpi_remove_notify_handler)
366
367/*******************************************************************************
368 *
369 * FUNCTION: acpi_install_exception_handler
370 *
371 * PARAMETERS: handler - Pointer to the handler function for the
372 * event
373 *
374 * RETURN: Status
375 *
376 * DESCRIPTION: Saves the pointer to the handler function
377 *
378 ******************************************************************************/
379#ifdef ACPI_FUTURE_USAGE
380acpi_status acpi_install_exception_handler(acpi_exception_handler handler)
381{
382 acpi_status status;
383
384 ACPI_FUNCTION_TRACE(acpi_install_exception_handler);
385
386 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
387 if (ACPI_FAILURE(status)) {
388 return_ACPI_STATUS(status);
389 }
390
391 /* Don't allow two handlers. */
392
393 if (acpi_gbl_exception_handler) {
394 status = AE_ALREADY_EXISTS;
395 goto cleanup;
396 }
397
398 /* Install the handler */
399
400 acpi_gbl_exception_handler = handler;
401
402cleanup:
403 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
404 return_ACPI_STATUS(status);
405}
406
407ACPI_EXPORT_SYMBOL(acpi_install_exception_handler)
408#endif
409
410#if (!ACPI_REDUCED_HARDWARE)
411/*******************************************************************************
412 *
413 * FUNCTION: acpi_install_sci_handler
414 *
415 * PARAMETERS: address - Address of the handler
416 * context - Value passed to the handler on each SCI
417 *
418 * RETURN: Status
419 *
420 * DESCRIPTION: Install a handler for a System Control Interrupt.
421 *
422 ******************************************************************************/
423acpi_status acpi_install_sci_handler(acpi_sci_handler address, void *context)
424{
425 struct acpi_sci_handler_info *new_sci_handler;
426 struct acpi_sci_handler_info *sci_handler;
427 acpi_cpu_flags flags;
428 acpi_status status;
429
430 ACPI_FUNCTION_TRACE(acpi_install_sci_handler);
431
432 if (!address) {
433 return_ACPI_STATUS(AE_BAD_PARAMETER);
434 }
435
436 /* Allocate and init a handler object */
437
438 new_sci_handler = ACPI_ALLOCATE(sizeof(struct acpi_sci_handler_info));
439 if (!new_sci_handler) {
440 return_ACPI_STATUS(AE_NO_MEMORY);
441 }
442
443 new_sci_handler->address = address;
444 new_sci_handler->context = context;
445
446 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
447 if (ACPI_FAILURE(status)) {
448 goto exit;
449 }
450
451 /* Lock list during installation */
452
453 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
454 sci_handler = acpi_gbl_sci_handler_list;
455
456 /* Ensure handler does not already exist */
457
458 while (sci_handler) {
459 if (address == sci_handler->address) {
460 status = AE_ALREADY_EXISTS;
461 goto unlock_and_exit;
462 }
463
464 sci_handler = sci_handler->next;
465 }
466
467 /* Install the new handler into the global list (at head) */
468
469 new_sci_handler->next = acpi_gbl_sci_handler_list;
470 acpi_gbl_sci_handler_list = new_sci_handler;
471
472unlock_and_exit:
473
474 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
475 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
476
477exit:
478 if (ACPI_FAILURE(status)) {
479 ACPI_FREE(new_sci_handler);
480 }
481 return_ACPI_STATUS(status);
482}
483
484ACPI_EXPORT_SYMBOL(acpi_install_sci_handler)
485
486/*******************************************************************************
487 *
488 * FUNCTION: acpi_remove_sci_handler
489 *
490 * PARAMETERS: address - Address of the handler
491 *
492 * RETURN: Status
493 *
494 * DESCRIPTION: Remove a handler for a System Control Interrupt.
495 *
496 ******************************************************************************/
497acpi_status acpi_remove_sci_handler(acpi_sci_handler address)
498{
499 struct acpi_sci_handler_info *prev_sci_handler;
500 struct acpi_sci_handler_info *next_sci_handler;
501 acpi_cpu_flags flags;
502 acpi_status status;
503
504 ACPI_FUNCTION_TRACE(acpi_remove_sci_handler);
505
506 if (!address) {
507 return_ACPI_STATUS(AE_BAD_PARAMETER);
508 }
509
510 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
511 if (ACPI_FAILURE(status)) {
512 return_ACPI_STATUS(status);
513 }
514
515 /* Remove the SCI handler with lock */
516
517 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
518
519 prev_sci_handler = NULL;
520 next_sci_handler = acpi_gbl_sci_handler_list;
521 while (next_sci_handler) {
522 if (next_sci_handler->address == address) {
523
524 /* Unlink and free the SCI handler info block */
525
526 if (prev_sci_handler) {
527 prev_sci_handler->next = next_sci_handler->next;
528 } else {
529 acpi_gbl_sci_handler_list =
530 next_sci_handler->next;
531 }
532
533 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
534 ACPI_FREE(next_sci_handler);
535 goto unlock_and_exit;
536 }
537
538 prev_sci_handler = next_sci_handler;
539 next_sci_handler = next_sci_handler->next;
540 }
541
542 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
543 status = AE_NOT_EXIST;
544
545unlock_and_exit:
546 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
547 return_ACPI_STATUS(status);
548}
549
550ACPI_EXPORT_SYMBOL(acpi_remove_sci_handler)
551
552/*******************************************************************************
553 *
554 * FUNCTION: acpi_install_global_event_handler
555 *
556 * PARAMETERS: handler - Pointer to the global event handler function
557 * context - Value passed to the handler on each event
558 *
559 * RETURN: Status
560 *
561 * DESCRIPTION: Saves the pointer to the handler function. The global handler
562 * is invoked upon each incoming GPE and Fixed Event. It is
563 * invoked at interrupt level at the time of the event dispatch.
564 * Can be used to update event counters, etc.
565 *
566 ******************************************************************************/
567acpi_status
568acpi_install_global_event_handler(acpi_gbl_event_handler handler, void *context)
569{
570 acpi_status status;
571
572 ACPI_FUNCTION_TRACE(acpi_install_global_event_handler);
573
574 /* Parameter validation */
575
576 if (!handler) {
577 return_ACPI_STATUS(AE_BAD_PARAMETER);
578 }
579
580 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
581 if (ACPI_FAILURE(status)) {
582 return_ACPI_STATUS(status);
583 }
584
585 /* Don't allow two handlers. */
586
587 if (acpi_gbl_global_event_handler) {
588 status = AE_ALREADY_EXISTS;
589 goto cleanup;
590 }
591
592 acpi_gbl_global_event_handler = handler;
593 acpi_gbl_global_event_handler_context = context;
594
595cleanup:
596 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
597 return_ACPI_STATUS(status);
598}
599
600ACPI_EXPORT_SYMBOL(acpi_install_global_event_handler)
601
602/*******************************************************************************
603 *
604 * FUNCTION: acpi_install_fixed_event_handler
605 *
606 * PARAMETERS: event - Event type to enable.
607 * handler - Pointer to the handler function for the
608 * event
609 * context - Value passed to the handler on each GPE
610 *
611 * RETURN: Status
612 *
613 * DESCRIPTION: Saves the pointer to the handler function and then enables the
614 * event.
615 *
616 ******************************************************************************/
617acpi_status
618acpi_install_fixed_event_handler(u32 event,
619 acpi_event_handler handler, void *context)
620{
621 acpi_status status;
622
623 ACPI_FUNCTION_TRACE(acpi_install_fixed_event_handler);
624
625 /* Parameter validation */
626
627 if (event > ACPI_EVENT_MAX) {
628 return_ACPI_STATUS(AE_BAD_PARAMETER);
629 }
630
631 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
632 if (ACPI_FAILURE(status)) {
633 return_ACPI_STATUS(status);
634 }
635
636 /* Do not allow multiple handlers */
637
638 if (acpi_gbl_fixed_event_handlers[event].handler) {
639 status = AE_ALREADY_EXISTS;
640 goto cleanup;
641 }
642
643 /* Install the handler before enabling the event */
644
645 acpi_gbl_fixed_event_handlers[event].handler = handler;
646 acpi_gbl_fixed_event_handlers[event].context = context;
647
648 status = acpi_clear_event(event);
649 if (ACPI_SUCCESS(status))
650 status = acpi_enable_event(event, 0);
651 if (ACPI_FAILURE(status)) {
652 ACPI_WARNING((AE_INFO,
653 "Could not enable fixed event - %s (%u)",
654 acpi_ut_get_event_name(event), event));
655
656 /* Remove the handler */
657
658 acpi_gbl_fixed_event_handlers[event].handler = NULL;
659 acpi_gbl_fixed_event_handlers[event].context = NULL;
660 } else {
661 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
662 "Enabled fixed event %s (%X), Handler=%p\n",
663 acpi_ut_get_event_name(event), event,
664 handler));
665 }
666
667cleanup:
668 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
669 return_ACPI_STATUS(status);
670}
671
672ACPI_EXPORT_SYMBOL(acpi_install_fixed_event_handler)
673
674/*******************************************************************************
675 *
676 * FUNCTION: acpi_remove_fixed_event_handler
677 *
678 * PARAMETERS: event - Event type to disable.
679 * handler - Address of the handler
680 *
681 * RETURN: Status
682 *
683 * DESCRIPTION: Disables the event and unregisters the event handler.
684 *
685 ******************************************************************************/
686acpi_status
687acpi_remove_fixed_event_handler(u32 event, acpi_event_handler handler)
688{
689 acpi_status status = AE_OK;
690
691 ACPI_FUNCTION_TRACE(acpi_remove_fixed_event_handler);
692
693 /* Parameter validation */
694
695 if (event > ACPI_EVENT_MAX) {
696 return_ACPI_STATUS(AE_BAD_PARAMETER);
697 }
698
699 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
700 if (ACPI_FAILURE(status)) {
701 return_ACPI_STATUS(status);
702 }
703
704 /* Disable the event before removing the handler */
705
706 status = acpi_disable_event(event, 0);
707
708 /* Always Remove the handler */
709
710 acpi_gbl_fixed_event_handlers[event].handler = NULL;
711 acpi_gbl_fixed_event_handlers[event].context = NULL;
712
713 if (ACPI_FAILURE(status)) {
714 ACPI_WARNING((AE_INFO,
715 "Could not disable fixed event - %s (%u)",
716 acpi_ut_get_event_name(event), event));
717 } else {
718 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
719 "Disabled fixed event - %s (%X)\n",
720 acpi_ut_get_event_name(event), event));
721 }
722
723 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
724 return_ACPI_STATUS(status);
725}
726
727ACPI_EXPORT_SYMBOL(acpi_remove_fixed_event_handler)
728
729/*******************************************************************************
730 *
731 * FUNCTION: acpi_ev_install_gpe_handler
732 *
733 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
734 * defined GPEs)
735 * gpe_number - The GPE number within the GPE block
736 * type - Whether this GPE should be treated as an
737 * edge- or level-triggered interrupt.
738 * is_raw_handler - Whether this GPE should be handled using
739 * the special GPE handler mode.
740 * address - Address of the handler
741 * context - Value passed to the handler on each GPE
742 *
743 * RETURN: Status
744 *
745 * DESCRIPTION: Internal function to install a handler for a General Purpose
746 * Event.
747 *
748 ******************************************************************************/
749static acpi_status
750acpi_ev_install_gpe_handler(acpi_handle gpe_device,
751 u32 gpe_number,
752 u32 type,
753 u8 is_raw_handler,
754 acpi_gpe_handler address, void *context)
755{
756 struct acpi_gpe_event_info *gpe_event_info;
757 struct acpi_gpe_handler_info *handler;
758 acpi_status status;
759 acpi_cpu_flags flags;
760
761 ACPI_FUNCTION_TRACE(ev_install_gpe_handler);
762
763 /* Parameter validation */
764
765 if ((!address) || (type & ~ACPI_GPE_XRUPT_TYPE_MASK)) {
766 return_ACPI_STATUS(AE_BAD_PARAMETER);
767 }
768
769 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
770 if (ACPI_FAILURE(status)) {
771 return_ACPI_STATUS(status);
772 }
773
774 /* Allocate and init handler object (before lock) */
775
776 handler = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_handler_info));
777 if (!handler) {
778 status = AE_NO_MEMORY;
779 goto unlock_and_exit;
780 }
781
782 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
783
784 /* Ensure that we have a valid GPE number */
785
786 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
787 if (!gpe_event_info) {
788 status = AE_BAD_PARAMETER;
789 goto free_and_exit;
790 }
791
792 /* Make sure that there isn't a handler there already */
793
794 if ((ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) ==
795 ACPI_GPE_DISPATCH_HANDLER) ||
796 (ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) ==
797 ACPI_GPE_DISPATCH_RAW_HANDLER)) {
798 status = AE_ALREADY_EXISTS;
799 goto free_and_exit;
800 }
801
802 handler->address = address;
803 handler->context = context;
804 handler->method_node = gpe_event_info->dispatch.method_node;
805 handler->original_flags = (u8)(gpe_event_info->flags &
806 (ACPI_GPE_XRUPT_TYPE_MASK |
807 ACPI_GPE_DISPATCH_MASK));
808
809 /*
810 * If the GPE is associated with a method, it may have been enabled
811 * automatically during initialization, in which case it has to be
812 * disabled now to avoid spurious execution of the handler.
813 */
814 if (((ACPI_GPE_DISPATCH_TYPE(handler->original_flags) ==
815 ACPI_GPE_DISPATCH_METHOD) ||
816 (ACPI_GPE_DISPATCH_TYPE(handler->original_flags) ==
817 ACPI_GPE_DISPATCH_NOTIFY)) && gpe_event_info->runtime_count) {
818 handler->originally_enabled = TRUE;
819 (void)acpi_ev_remove_gpe_reference(gpe_event_info);
820
821 /* Sanity check of original type against new type */
822
823 if (type !=
824 (u32)(gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK)) {
825 ACPI_WARNING((AE_INFO,
826 "GPE type mismatch (level/edge)"));
827 }
828 }
829
830 /* Install the handler */
831
832 gpe_event_info->dispatch.handler = handler;
833
834 /* Setup up dispatch flags to indicate handler (vs. method/notify) */
835
836 gpe_event_info->flags &=
837 ~(ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK);
838 gpe_event_info->flags |=
839 (u8)(type |
840 (is_raw_handler ? ACPI_GPE_DISPATCH_RAW_HANDLER :
841 ACPI_GPE_DISPATCH_HANDLER));
842
843 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
844
845unlock_and_exit:
846 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
847 return_ACPI_STATUS(status);
848
849free_and_exit:
850 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
851 ACPI_FREE(handler);
852 goto unlock_and_exit;
853}
854
855/*******************************************************************************
856 *
857 * FUNCTION: acpi_install_gpe_handler
858 *
859 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
860 * defined GPEs)
861 * gpe_number - The GPE number within the GPE block
862 * type - Whether this GPE should be treated as an
863 * edge- or level-triggered interrupt.
864 * address - Address of the handler
865 * context - Value passed to the handler on each GPE
866 *
867 * RETURN: Status
868 *
869 * DESCRIPTION: Install a handler for a General Purpose Event.
870 *
871 ******************************************************************************/
872
873acpi_status
874acpi_install_gpe_handler(acpi_handle gpe_device,
875 u32 gpe_number,
876 u32 type, acpi_gpe_handler address, void *context)
877{
878 acpi_status status;
879
880 ACPI_FUNCTION_TRACE(acpi_install_gpe_handler);
881
882 status = acpi_ev_install_gpe_handler(gpe_device, gpe_number, type,
883 FALSE, address, context);
884
885 return_ACPI_STATUS(status);
886}
887
888ACPI_EXPORT_SYMBOL(acpi_install_gpe_handler)
889
890/*******************************************************************************
891 *
892 * FUNCTION: acpi_install_gpe_raw_handler
893 *
894 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
895 * defined GPEs)
896 * gpe_number - The GPE number within the GPE block
897 * type - Whether this GPE should be treated as an
898 * edge- or level-triggered interrupt.
899 * address - Address of the handler
900 * context - Value passed to the handler on each GPE
901 *
902 * RETURN: Status
903 *
904 * DESCRIPTION: Install a handler for a General Purpose Event.
905 *
906 ******************************************************************************/
907acpi_status
908acpi_install_gpe_raw_handler(acpi_handle gpe_device,
909 u32 gpe_number,
910 u32 type, acpi_gpe_handler address, void *context)
911{
912 acpi_status status;
913
914 ACPI_FUNCTION_TRACE(acpi_install_gpe_raw_handler);
915
916 status = acpi_ev_install_gpe_handler(gpe_device, gpe_number, type,
917 TRUE, address, context);
918
919 return_ACPI_STATUS(status);
920}
921
922ACPI_EXPORT_SYMBOL(acpi_install_gpe_raw_handler)
923
924/*******************************************************************************
925 *
926 * FUNCTION: acpi_remove_gpe_handler
927 *
928 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
929 * defined GPEs)
930 * gpe_number - The event to remove a handler
931 * address - Address of the handler
932 *
933 * RETURN: Status
934 *
935 * DESCRIPTION: Remove a handler for a General Purpose acpi_event.
936 *
937 ******************************************************************************/
938acpi_status
939acpi_remove_gpe_handler(acpi_handle gpe_device,
940 u32 gpe_number, acpi_gpe_handler address)
941{
942 struct acpi_gpe_event_info *gpe_event_info;
943 struct acpi_gpe_handler_info *handler;
944 acpi_status status;
945 acpi_cpu_flags flags;
946
947 ACPI_FUNCTION_TRACE(acpi_remove_gpe_handler);
948
949 /* Parameter validation */
950
951 if (!address) {
952 return_ACPI_STATUS(AE_BAD_PARAMETER);
953 }
954
955 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
956 if (ACPI_FAILURE(status)) {
957 return_ACPI_STATUS(status);
958 }
959
960 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
961
962 /* Ensure that we have a valid GPE number */
963
964 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
965 if (!gpe_event_info) {
966 status = AE_BAD_PARAMETER;
967 goto unlock_and_exit;
968 }
969
970 /* Make sure that a handler is indeed installed */
971
972 if ((ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) !=
973 ACPI_GPE_DISPATCH_HANDLER) &&
974 (ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) !=
975 ACPI_GPE_DISPATCH_RAW_HANDLER)) {
976 status = AE_NOT_EXIST;
977 goto unlock_and_exit;
978 }
979
980 /* Make sure that the installed handler is the same */
981
982 if (gpe_event_info->dispatch.handler->address != address) {
983 status = AE_BAD_PARAMETER;
984 goto unlock_and_exit;
985 }
986
987 /* Remove the handler */
988
989 handler = gpe_event_info->dispatch.handler;
990 gpe_event_info->dispatch.handler = NULL;
991
992 /* Restore Method node (if any), set dispatch flags */
993
994 gpe_event_info->dispatch.method_node = handler->method_node;
995 gpe_event_info->flags &=
996 ~(ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK);
997 gpe_event_info->flags |= handler->original_flags;
998
999 /*
1000 * If the GPE was previously associated with a method and it was
1001 * enabled, it should be enabled at this point to restore the
1002 * post-initialization configuration.
1003 */
1004 if (((ACPI_GPE_DISPATCH_TYPE(handler->original_flags) ==
1005 ACPI_GPE_DISPATCH_METHOD) ||
1006 (ACPI_GPE_DISPATCH_TYPE(handler->original_flags) ==
1007 ACPI_GPE_DISPATCH_NOTIFY)) && handler->originally_enabled) {
1008 (void)acpi_ev_add_gpe_reference(gpe_event_info);
1009 }
1010
1011 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
1012 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
1013
1014 /* Make sure all deferred GPE tasks are completed */
1015
1016 acpi_os_wait_events_complete();
1017
1018 /* Now we can free the handler object */
1019
1020 ACPI_FREE(handler);
1021 return_ACPI_STATUS(status);
1022
1023unlock_and_exit:
1024 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
1025
1026 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
1027 return_ACPI_STATUS(status);
1028}
1029
1030ACPI_EXPORT_SYMBOL(acpi_remove_gpe_handler)
1031
1032/*******************************************************************************
1033 *
1034 * FUNCTION: acpi_acquire_global_lock
1035 *
1036 * PARAMETERS: timeout - How long the caller is willing to wait
1037 * handle - Where the handle to the lock is returned
1038 * (if acquired)
1039 *
1040 * RETURN: Status
1041 *
1042 * DESCRIPTION: Acquire the ACPI Global Lock
1043 *
1044 * Note: Allows callers with the same thread ID to acquire the global lock
1045 * multiple times. In other words, externally, the behavior of the global lock
1046 * is identical to an AML mutex. On the first acquire, a new handle is
1047 * returned. On any subsequent calls to acquire by the same thread, the same
1048 * handle is returned.
1049 *
1050 ******************************************************************************/
1051acpi_status acpi_acquire_global_lock(u16 timeout, u32 *handle)
1052{
1053 acpi_status status;
1054
1055 if (!handle) {
1056 return (AE_BAD_PARAMETER);
1057 }
1058
1059 /* Must lock interpreter to prevent race conditions */
1060
1061 acpi_ex_enter_interpreter();
1062
1063 status = acpi_ex_acquire_mutex_object(timeout,
1064 acpi_gbl_global_lock_mutex,
1065 acpi_os_get_thread_id());
1066
1067 if (ACPI_SUCCESS(status)) {
1068
1069 /* Return the global lock handle (updated in acpi_ev_acquire_global_lock) */
1070
1071 *handle = acpi_gbl_global_lock_handle;
1072 }
1073
1074 acpi_ex_exit_interpreter();
1075 return (status);
1076}
1077
1078ACPI_EXPORT_SYMBOL(acpi_acquire_global_lock)
1079
1080/*******************************************************************************
1081 *
1082 * FUNCTION: acpi_release_global_lock
1083 *
1084 * PARAMETERS: handle - Returned from acpi_acquire_global_lock
1085 *
1086 * RETURN: Status
1087 *
1088 * DESCRIPTION: Release the ACPI Global Lock. The handle must be valid.
1089 *
1090 ******************************************************************************/
1091acpi_status acpi_release_global_lock(u32 handle)
1092{
1093 acpi_status status;
1094
1095 if (!handle || (handle != acpi_gbl_global_lock_handle)) {
1096 return (AE_NOT_ACQUIRED);
1097 }
1098
1099 status = acpi_ex_release_mutex_object(acpi_gbl_global_lock_mutex);
1100 return (status);
1101}
1102
1103ACPI_EXPORT_SYMBOL(acpi_release_global_lock)
1104#endif /* !ACPI_REDUCED_HARDWARE */