1 /******************************************************************************
3 * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include <acpi/acevents.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/actables.h>
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME("evxfevnt")
52 /*******************************************************************************
54 * FUNCTION: acpi_enable
60 * DESCRIPTION: Transfers the system into ACPI mode.
62 ******************************************************************************/
63 acpi_status acpi_enable(void)
65 acpi_status status = AE_OK;
67 ACPI_FUNCTION_TRACE(acpi_enable);
69 /* ACPI tables must be present */
71 if (!acpi_tb_tables_loaded()) {
72 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
75 /* Check current mode */
77 if (acpi_hw_get_mode() == ACPI_SYS_MODE_ACPI) {
78 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
79 "System is already in ACPI mode\n"));
81 /* Transition to ACPI mode */
83 status = acpi_hw_set_mode(ACPI_SYS_MODE_ACPI);
84 if (ACPI_FAILURE(status)) {
86 "Could not transition to ACPI mode"));
87 return_ACPI_STATUS(status);
90 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
91 "Transition to ACPI mode successful\n"));
94 return_ACPI_STATUS(status);
97 ACPI_EXPORT_SYMBOL(acpi_enable)
99 /*******************************************************************************
101 * FUNCTION: acpi_disable
107 * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
109 ******************************************************************************/
110 acpi_status acpi_disable(void)
112 acpi_status status = AE_OK;
114 ACPI_FUNCTION_TRACE(acpi_disable);
116 if (acpi_hw_get_mode() == ACPI_SYS_MODE_LEGACY) {
117 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
118 "System is already in legacy (non-ACPI) mode\n"));
120 /* Transition to LEGACY mode */
122 status = acpi_hw_set_mode(ACPI_SYS_MODE_LEGACY);
124 if (ACPI_FAILURE(status)) {
126 "Could not exit ACPI mode to legacy mode"));
127 return_ACPI_STATUS(status);
130 ACPI_DEBUG_PRINT((ACPI_DB_INIT, "ACPI mode disabled\n"));
133 return_ACPI_STATUS(status);
136 ACPI_EXPORT_SYMBOL(acpi_disable)
138 /*******************************************************************************
140 * FUNCTION: acpi_enable_event
142 * PARAMETERS: Event - The fixed eventto be enabled
147 * DESCRIPTION: Enable an ACPI event (fixed)
149 ******************************************************************************/
150 acpi_status acpi_enable_event(u32 event, u32 flags)
152 acpi_status status = AE_OK;
155 ACPI_FUNCTION_TRACE(acpi_enable_event);
157 /* Decode the Fixed Event */
159 if (event > ACPI_EVENT_MAX) {
160 return_ACPI_STATUS(AE_BAD_PARAMETER);
164 * Enable the requested fixed event (by writing a one to the
165 * enable register bit)
168 acpi_set_register(acpi_gbl_fixed_event_info[event].
169 enable_register_id, 1);
170 if (ACPI_FAILURE(status)) {
171 return_ACPI_STATUS(status);
174 /* Make sure that the hardware responded */
177 acpi_get_register(acpi_gbl_fixed_event_info[event].
178 enable_register_id, &value);
179 if (ACPI_FAILURE(status)) {
180 return_ACPI_STATUS(status);
185 "Could not enable %s event",
186 acpi_ut_get_event_name(event)));
187 return_ACPI_STATUS(AE_NO_HARDWARE_RESPONSE);
190 return_ACPI_STATUS(status);
193 ACPI_EXPORT_SYMBOL(acpi_enable_event)
195 /*******************************************************************************
197 * FUNCTION: acpi_set_gpe_type
199 * PARAMETERS: gpe_device - Parent GPE Device
200 * gpe_number - GPE level within the GPE block
201 * Type - New GPE type
205 * DESCRIPTION: Set the type of an individual GPE
207 ******************************************************************************/
208 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type)
210 acpi_status status = AE_OK;
211 struct acpi_gpe_event_info *gpe_event_info;
213 ACPI_FUNCTION_TRACE(acpi_set_gpe_type);
215 /* Ensure that we have a valid GPE number */
217 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
218 if (!gpe_event_info) {
219 status = AE_BAD_PARAMETER;
220 goto unlock_and_exit;
223 if ((gpe_event_info->flags & ACPI_GPE_TYPE_MASK) == type) {
224 return_ACPI_STATUS(AE_OK);
227 /* Set the new type (will disable GPE if currently enabled) */
229 status = acpi_ev_set_gpe_type(gpe_event_info, type);
232 return_ACPI_STATUS(status);
235 ACPI_EXPORT_SYMBOL(acpi_set_gpe_type)
237 /*******************************************************************************
239 * FUNCTION: acpi_enable_gpe
241 * PARAMETERS: gpe_device - Parent GPE Device
242 * gpe_number - GPE level within the GPE block
243 * Flags - Just enable, or also wake enable?
244 * Called from ISR or not
248 * DESCRIPTION: Enable an ACPI event (general purpose)
250 ******************************************************************************/
251 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
253 acpi_status status = AE_OK;
254 struct acpi_gpe_event_info *gpe_event_info;
256 ACPI_FUNCTION_TRACE(acpi_enable_gpe);
258 /* Use semaphore lock if not executing at interrupt level */
260 if (flags & ACPI_NOT_ISR) {
261 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
262 if (ACPI_FAILURE(status)) {
263 return_ACPI_STATUS(status);
267 /* Ensure that we have a valid GPE number */
269 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
270 if (!gpe_event_info) {
271 status = AE_BAD_PARAMETER;
272 goto unlock_and_exit;
275 /* Perform the enable */
277 status = acpi_ev_enable_gpe(gpe_event_info, TRUE);
280 if (flags & ACPI_NOT_ISR) {
281 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
283 return_ACPI_STATUS(status);
286 ACPI_EXPORT_SYMBOL(acpi_enable_gpe)
288 /*******************************************************************************
290 * FUNCTION: acpi_disable_gpe
292 * PARAMETERS: gpe_device - Parent GPE Device
293 * gpe_number - GPE level within the GPE block
294 * Flags - Just disable, or also wake disable?
295 * Called from ISR or not
299 * DESCRIPTION: Disable an ACPI event (general purpose)
301 ******************************************************************************/
302 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
304 acpi_status status = AE_OK;
305 struct acpi_gpe_event_info *gpe_event_info;
307 ACPI_FUNCTION_TRACE(acpi_disable_gpe);
309 /* Use semaphore lock if not executing at interrupt level */
311 if (flags & ACPI_NOT_ISR) {
312 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
313 if (ACPI_FAILURE(status)) {
314 return_ACPI_STATUS(status);
318 /* Ensure that we have a valid GPE number */
320 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
321 if (!gpe_event_info) {
322 status = AE_BAD_PARAMETER;
323 goto unlock_and_exit;
326 status = acpi_ev_disable_gpe(gpe_event_info);
329 if (flags & ACPI_NOT_ISR) {
330 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
332 return_ACPI_STATUS(status);
335 ACPI_EXPORT_SYMBOL(acpi_disable_gpe)
337 /*******************************************************************************
339 * FUNCTION: acpi_disable_event
341 * PARAMETERS: Event - The fixed eventto be enabled
346 * DESCRIPTION: Disable an ACPI event (fixed)
348 ******************************************************************************/
349 acpi_status acpi_disable_event(u32 event, u32 flags)
351 acpi_status status = AE_OK;
354 ACPI_FUNCTION_TRACE(acpi_disable_event);
356 /* Decode the Fixed Event */
358 if (event > ACPI_EVENT_MAX) {
359 return_ACPI_STATUS(AE_BAD_PARAMETER);
363 * Disable the requested fixed event (by writing a zero to the
364 * enable register bit)
367 acpi_set_register(acpi_gbl_fixed_event_info[event].
368 enable_register_id, 0);
369 if (ACPI_FAILURE(status)) {
370 return_ACPI_STATUS(status);
374 acpi_get_register(acpi_gbl_fixed_event_info[event].
375 enable_register_id, &value);
376 if (ACPI_FAILURE(status)) {
377 return_ACPI_STATUS(status);
382 "Could not disable %s events",
383 acpi_ut_get_event_name(event)));
384 return_ACPI_STATUS(AE_NO_HARDWARE_RESPONSE);
387 return_ACPI_STATUS(status);
390 ACPI_EXPORT_SYMBOL(acpi_disable_event)
392 /*******************************************************************************
394 * FUNCTION: acpi_clear_event
396 * PARAMETERS: Event - The fixed event to be cleared
400 * DESCRIPTION: Clear an ACPI event (fixed)
402 ******************************************************************************/
403 acpi_status acpi_clear_event(u32 event)
405 acpi_status status = AE_OK;
407 ACPI_FUNCTION_TRACE(acpi_clear_event);
409 /* Decode the Fixed Event */
411 if (event > ACPI_EVENT_MAX) {
412 return_ACPI_STATUS(AE_BAD_PARAMETER);
416 * Clear the requested fixed event (By writing a one to the
417 * status register bit)
420 acpi_set_register(acpi_gbl_fixed_event_info[event].
421 status_register_id, 1);
423 return_ACPI_STATUS(status);
426 ACPI_EXPORT_SYMBOL(acpi_clear_event)
428 /*******************************************************************************
430 * FUNCTION: acpi_clear_gpe
432 * PARAMETERS: gpe_device - Parent GPE Device
433 * gpe_number - GPE level within the GPE block
434 * Flags - Called from an ISR or not
438 * DESCRIPTION: Clear an ACPI event (general purpose)
440 ******************************************************************************/
441 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
443 acpi_status status = AE_OK;
444 struct acpi_gpe_event_info *gpe_event_info;
446 ACPI_FUNCTION_TRACE(acpi_clear_gpe);
448 /* Use semaphore lock if not executing at interrupt level */
450 if (flags & ACPI_NOT_ISR) {
451 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
452 if (ACPI_FAILURE(status)) {
453 return_ACPI_STATUS(status);
457 /* Ensure that we have a valid GPE number */
459 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
460 if (!gpe_event_info) {
461 status = AE_BAD_PARAMETER;
462 goto unlock_and_exit;
465 status = acpi_hw_clear_gpe(gpe_event_info);
468 if (flags & ACPI_NOT_ISR) {
469 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
471 return_ACPI_STATUS(status);
474 ACPI_EXPORT_SYMBOL(acpi_clear_gpe)
476 #ifdef ACPI_FUTURE_USAGE
477 /*******************************************************************************
479 * FUNCTION: acpi_get_event_status
481 * PARAMETERS: Event - The fixed event
482 * event_status - Where the current status of the event will
487 * DESCRIPTION: Obtains and returns the current status of the event
489 ******************************************************************************/
490 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status)
492 acpi_status status = AE_OK;
494 ACPI_FUNCTION_TRACE(acpi_get_event_status);
497 return_ACPI_STATUS(AE_BAD_PARAMETER);
500 /* Decode the Fixed Event */
502 if (event > ACPI_EVENT_MAX) {
503 return_ACPI_STATUS(AE_BAD_PARAMETER);
506 /* Get the status of the requested fixed event */
509 acpi_get_register(acpi_gbl_fixed_event_info[event].
510 status_register_id, event_status);
512 return_ACPI_STATUS(status);
515 ACPI_EXPORT_SYMBOL(acpi_get_event_status)
517 /*******************************************************************************
519 * FUNCTION: acpi_get_gpe_status
521 * PARAMETERS: gpe_device - Parent GPE Device
522 * gpe_number - GPE level within the GPE block
523 * Flags - Called from an ISR or not
524 * event_status - Where the current status of the event will
529 * DESCRIPTION: Get status of an event (general purpose)
531 ******************************************************************************/
533 acpi_get_gpe_status(acpi_handle gpe_device,
534 u32 gpe_number, u32 flags, acpi_event_status * event_status)
536 acpi_status status = AE_OK;
537 struct acpi_gpe_event_info *gpe_event_info;
539 ACPI_FUNCTION_TRACE(acpi_get_gpe_status);
541 /* Use semaphore lock if not executing at interrupt level */
543 if (flags & ACPI_NOT_ISR) {
544 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
545 if (ACPI_FAILURE(status)) {
546 return_ACPI_STATUS(status);
550 /* Ensure that we have a valid GPE number */
552 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
553 if (!gpe_event_info) {
554 status = AE_BAD_PARAMETER;
555 goto unlock_and_exit;
558 /* Obtain status on the requested GPE number */
560 status = acpi_hw_get_gpe_status(gpe_event_info, event_status);
563 if (flags & ACPI_NOT_ISR) {
564 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
566 return_ACPI_STATUS(status);
569 ACPI_EXPORT_SYMBOL(acpi_get_gpe_status)
570 #endif /* ACPI_FUTURE_USAGE */
572 /*******************************************************************************
574 * FUNCTION: acpi_install_gpe_block
576 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
577 * gpe_block_address - Address and space_iD
578 * register_count - Number of GPE register pairs in the block
579 * interrupt_number - H/W interrupt for the block
583 * DESCRIPTION: Create and Install a block of GPE registers
585 ******************************************************************************/
587 acpi_install_gpe_block(acpi_handle gpe_device,
588 struct acpi_generic_address *gpe_block_address,
589 u32 register_count, u32 interrupt_number)
592 union acpi_operand_object *obj_desc;
593 struct acpi_namespace_node *node;
594 struct acpi_gpe_block_info *gpe_block;
596 ACPI_FUNCTION_TRACE(acpi_install_gpe_block);
598 if ((!gpe_device) || (!gpe_block_address) || (!register_count)) {
599 return_ACPI_STATUS(AE_BAD_PARAMETER);
602 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
603 if (ACPI_FAILURE(status)) {
607 node = acpi_ns_map_handle_to_node(gpe_device);
609 status = AE_BAD_PARAMETER;
610 goto unlock_and_exit;
614 * For user-installed GPE Block Devices, the gpe_block_base_number
618 acpi_ev_create_gpe_block(node, gpe_block_address, register_count, 0,
619 interrupt_number, &gpe_block);
620 if (ACPI_FAILURE(status)) {
621 goto unlock_and_exit;
624 /* Run the _PRW methods and enable the GPEs */
626 status = acpi_ev_initialize_gpe_block(node, gpe_block);
627 if (ACPI_FAILURE(status)) {
628 goto unlock_and_exit;
631 /* Get the device_object attached to the node */
633 obj_desc = acpi_ns_get_attached_object(node);
636 /* No object, create a new one */
638 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_DEVICE);
640 status = AE_NO_MEMORY;
641 goto unlock_and_exit;
645 acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_DEVICE);
647 /* Remove local reference to the object */
649 acpi_ut_remove_reference(obj_desc);
651 if (ACPI_FAILURE(status)) {
652 goto unlock_and_exit;
656 /* Install the GPE block in the device_object */
658 obj_desc->device.gpe_block = gpe_block;
661 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
662 return_ACPI_STATUS(status);
665 ACPI_EXPORT_SYMBOL(acpi_install_gpe_block)
667 /*******************************************************************************
669 * FUNCTION: acpi_remove_gpe_block
671 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
675 * DESCRIPTION: Remove a previously installed block of GPE registers
677 ******************************************************************************/
678 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device)
680 union acpi_operand_object *obj_desc;
682 struct acpi_namespace_node *node;
684 ACPI_FUNCTION_TRACE(acpi_remove_gpe_block);
687 return_ACPI_STATUS(AE_BAD_PARAMETER);
690 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
691 if (ACPI_FAILURE(status)) {
695 node = acpi_ns_map_handle_to_node(gpe_device);
697 status = AE_BAD_PARAMETER;
698 goto unlock_and_exit;
701 /* Get the device_object attached to the node */
703 obj_desc = acpi_ns_get_attached_object(node);
704 if (!obj_desc || !obj_desc->device.gpe_block) {
705 return_ACPI_STATUS(AE_NULL_OBJECT);
708 /* Delete the GPE block (but not the device_object) */
710 status = acpi_ev_delete_gpe_block(obj_desc->device.gpe_block);
711 if (ACPI_SUCCESS(status)) {
712 obj_desc->device.gpe_block = NULL;
716 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
717 return_ACPI_STATUS(status);
720 ACPI_EXPORT_SYMBOL(acpi_remove_gpe_block)