1 /******************************************************************************
3 * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, 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>
48 #define _COMPONENT ACPI_EVENTS
49 ACPI_MODULE_NAME("evxfevnt")
51 /*******************************************************************************
53 * FUNCTION: acpi_enable
59 * DESCRIPTION: Transfers the system into ACPI mode.
61 ******************************************************************************/
62 acpi_status acpi_enable(void)
64 acpi_status status = AE_OK;
66 ACPI_FUNCTION_TRACE(acpi_enable);
68 /* Make sure we have the FADT */
71 ACPI_WARNING((AE_INFO, "No FADT information present!"));
72 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
75 if (acpi_hw_get_mode() == ACPI_SYS_MODE_ACPI) {
76 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
77 "System is already in ACPI mode\n"));
79 /* Transition to ACPI mode */
81 status = acpi_hw_set_mode(ACPI_SYS_MODE_ACPI);
82 if (ACPI_FAILURE(status)) {
84 "Could not transition to ACPI mode"));
85 return_ACPI_STATUS(status);
88 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
89 "Transition to ACPI mode successful\n"));
92 return_ACPI_STATUS(status);
95 ACPI_EXPORT_SYMBOL(acpi_enable)
97 /*******************************************************************************
99 * FUNCTION: acpi_disable
105 * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
107 ******************************************************************************/
108 acpi_status acpi_disable(void)
110 acpi_status status = AE_OK;
112 ACPI_FUNCTION_TRACE(acpi_disable);
114 if (!acpi_gbl_FADT) {
115 ACPI_WARNING((AE_INFO, "No FADT information present!"));
116 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
119 if (acpi_hw_get_mode() == ACPI_SYS_MODE_LEGACY) {
120 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
121 "System is already in legacy (non-ACPI) mode\n"));
123 /* Transition to LEGACY mode */
125 status = acpi_hw_set_mode(ACPI_SYS_MODE_LEGACY);
127 if (ACPI_FAILURE(status)) {
129 "Could not exit ACPI mode to legacy mode"));
130 return_ACPI_STATUS(status);
133 ACPI_DEBUG_PRINT((ACPI_DB_INIT, "ACPI mode disabled\n"));
136 return_ACPI_STATUS(status);
139 ACPI_EXPORT_SYMBOL(acpi_disable)
141 /*******************************************************************************
143 * FUNCTION: acpi_enable_event
145 * PARAMETERS: Event - The fixed eventto be enabled
150 * DESCRIPTION: Enable an ACPI event (fixed)
152 ******************************************************************************/
153 acpi_status acpi_enable_event(u32 event, u32 flags)
155 acpi_status status = AE_OK;
158 ACPI_FUNCTION_TRACE(acpi_enable_event);
160 /* Decode the Fixed Event */
162 if (event > ACPI_EVENT_MAX) {
163 return_ACPI_STATUS(AE_BAD_PARAMETER);
167 * Enable the requested fixed event (by writing a one to the
168 * enable register bit)
171 acpi_set_register(acpi_gbl_fixed_event_info[event].
172 enable_register_id, 1, ACPI_MTX_LOCK);
173 if (ACPI_FAILURE(status)) {
174 return_ACPI_STATUS(status);
177 /* Make sure that the hardware responded */
180 acpi_get_register(acpi_gbl_fixed_event_info[event].
181 enable_register_id, &value, ACPI_MTX_LOCK);
182 if (ACPI_FAILURE(status)) {
183 return_ACPI_STATUS(status);
188 "Could not enable %s event",
189 acpi_ut_get_event_name(event)));
190 return_ACPI_STATUS(AE_NO_HARDWARE_RESPONSE);
193 return_ACPI_STATUS(status);
196 ACPI_EXPORT_SYMBOL(acpi_enable_event)
198 /*******************************************************************************
200 * FUNCTION: acpi_set_gpe_type
202 * PARAMETERS: gpe_device - Parent GPE Device
203 * gpe_number - GPE level within the GPE block
204 * Type - New GPE type
208 * DESCRIPTION: Set the type of an individual GPE
210 ******************************************************************************/
211 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type)
213 acpi_status status = AE_OK;
214 struct acpi_gpe_event_info *gpe_event_info;
216 ACPI_FUNCTION_TRACE(acpi_set_gpe_type);
218 /* Ensure that we have a valid GPE number */
220 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
221 if (!gpe_event_info) {
222 status = AE_BAD_PARAMETER;
223 goto unlock_and_exit;
226 if ((gpe_event_info->flags & ACPI_GPE_TYPE_MASK) == type) {
227 return_ACPI_STATUS(AE_OK);
230 /* Set the new type (will disable GPE if currently enabled) */
232 status = acpi_ev_set_gpe_type(gpe_event_info, type);
235 return_ACPI_STATUS(status);
238 ACPI_EXPORT_SYMBOL(acpi_set_gpe_type)
240 /*******************************************************************************
242 * FUNCTION: acpi_enable_gpe
244 * PARAMETERS: gpe_device - Parent GPE Device
245 * gpe_number - GPE level within the GPE block
246 * Flags - Just enable, or also wake enable?
247 * Called from ISR or not
251 * DESCRIPTION: Enable an ACPI event (general purpose)
253 ******************************************************************************/
254 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
256 acpi_status status = AE_OK;
257 struct acpi_gpe_event_info *gpe_event_info;
259 ACPI_FUNCTION_TRACE(acpi_enable_gpe);
261 /* Use semaphore lock if not executing at interrupt level */
263 if (flags & ACPI_NOT_ISR) {
264 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
265 if (ACPI_FAILURE(status)) {
266 return_ACPI_STATUS(status);
270 /* Ensure that we have a valid GPE number */
272 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
273 if (!gpe_event_info) {
274 status = AE_BAD_PARAMETER;
275 goto unlock_and_exit;
278 /* Perform the enable */
280 status = acpi_ev_enable_gpe(gpe_event_info, TRUE);
283 if (flags & ACPI_NOT_ISR) {
284 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
286 return_ACPI_STATUS(status);
289 ACPI_EXPORT_SYMBOL(acpi_enable_gpe)
291 /*******************************************************************************
293 * FUNCTION: acpi_disable_gpe
295 * PARAMETERS: gpe_device - Parent GPE Device
296 * gpe_number - GPE level within the GPE block
297 * Flags - Just disable, or also wake disable?
298 * Called from ISR or not
302 * DESCRIPTION: Disable an ACPI event (general purpose)
304 ******************************************************************************/
305 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
307 acpi_status status = AE_OK;
308 struct acpi_gpe_event_info *gpe_event_info;
310 ACPI_FUNCTION_TRACE(acpi_disable_gpe);
312 /* Use semaphore lock if not executing at interrupt level */
314 if (flags & ACPI_NOT_ISR) {
315 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
316 if (ACPI_FAILURE(status)) {
317 return_ACPI_STATUS(status);
321 /* Ensure that we have a valid GPE number */
323 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
324 if (!gpe_event_info) {
325 status = AE_BAD_PARAMETER;
326 goto unlock_and_exit;
329 status = acpi_ev_disable_gpe(gpe_event_info);
332 if (flags & ACPI_NOT_ISR) {
333 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
335 return_ACPI_STATUS(status);
338 ACPI_EXPORT_SYMBOL(acpi_disable_gpe)
340 /*******************************************************************************
342 * FUNCTION: acpi_disable_event
344 * PARAMETERS: Event - The fixed eventto be enabled
349 * DESCRIPTION: Disable an ACPI event (fixed)
351 ******************************************************************************/
352 acpi_status acpi_disable_event(u32 event, u32 flags)
354 acpi_status status = AE_OK;
357 ACPI_FUNCTION_TRACE(acpi_disable_event);
359 /* Decode the Fixed Event */
361 if (event > ACPI_EVENT_MAX) {
362 return_ACPI_STATUS(AE_BAD_PARAMETER);
366 * Disable the requested fixed event (by writing a zero to the
367 * enable register bit)
370 acpi_set_register(acpi_gbl_fixed_event_info[event].
371 enable_register_id, 0, ACPI_MTX_LOCK);
372 if (ACPI_FAILURE(status)) {
373 return_ACPI_STATUS(status);
377 acpi_get_register(acpi_gbl_fixed_event_info[event].
378 enable_register_id, &value, ACPI_MTX_LOCK);
379 if (ACPI_FAILURE(status)) {
380 return_ACPI_STATUS(status);
385 "Could not disable %s events",
386 acpi_ut_get_event_name(event)));
387 return_ACPI_STATUS(AE_NO_HARDWARE_RESPONSE);
390 return_ACPI_STATUS(status);
393 ACPI_EXPORT_SYMBOL(acpi_disable_event)
395 /*******************************************************************************
397 * FUNCTION: acpi_clear_event
399 * PARAMETERS: Event - The fixed event to be cleared
403 * DESCRIPTION: Clear an ACPI event (fixed)
405 ******************************************************************************/
406 acpi_status acpi_clear_event(u32 event)
408 acpi_status status = AE_OK;
410 ACPI_FUNCTION_TRACE(acpi_clear_event);
412 /* Decode the Fixed Event */
414 if (event > ACPI_EVENT_MAX) {
415 return_ACPI_STATUS(AE_BAD_PARAMETER);
419 * Clear the requested fixed event (By writing a one to the
420 * status register bit)
423 acpi_set_register(acpi_gbl_fixed_event_info[event].
424 status_register_id, 1, ACPI_MTX_LOCK);
426 return_ACPI_STATUS(status);
429 ACPI_EXPORT_SYMBOL(acpi_clear_event)
431 /*******************************************************************************
433 * FUNCTION: acpi_clear_gpe
435 * PARAMETERS: gpe_device - Parent GPE Device
436 * gpe_number - GPE level within the GPE block
437 * Flags - Called from an ISR or not
441 * DESCRIPTION: Clear an ACPI event (general purpose)
443 ******************************************************************************/
444 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
446 acpi_status status = AE_OK;
447 struct acpi_gpe_event_info *gpe_event_info;
449 ACPI_FUNCTION_TRACE(acpi_clear_gpe);
451 /* Use semaphore lock if not executing at interrupt level */
453 if (flags & ACPI_NOT_ISR) {
454 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
455 if (ACPI_FAILURE(status)) {
456 return_ACPI_STATUS(status);
460 /* Ensure that we have a valid GPE number */
462 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
463 if (!gpe_event_info) {
464 status = AE_BAD_PARAMETER;
465 goto unlock_and_exit;
468 status = acpi_hw_clear_gpe(gpe_event_info);
471 if (flags & ACPI_NOT_ISR) {
472 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
474 return_ACPI_STATUS(status);
477 ACPI_EXPORT_SYMBOL(acpi_clear_gpe)
479 #ifdef ACPI_FUTURE_USAGE
480 /*******************************************************************************
482 * FUNCTION: acpi_get_event_status
484 * PARAMETERS: Event - The fixed event
485 * event_status - Where the current status of the event will
490 * DESCRIPTION: Obtains and returns the current status of the event
492 ******************************************************************************/
493 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status)
495 acpi_status status = AE_OK;
497 ACPI_FUNCTION_TRACE(acpi_get_event_status);
500 return_ACPI_STATUS(AE_BAD_PARAMETER);
503 /* Decode the Fixed Event */
505 if (event > ACPI_EVENT_MAX) {
506 return_ACPI_STATUS(AE_BAD_PARAMETER);
509 /* Get the status of the requested fixed event */
512 acpi_get_register(acpi_gbl_fixed_event_info[event].
513 status_register_id, event_status, ACPI_MTX_LOCK);
515 return_ACPI_STATUS(status);
518 ACPI_EXPORT_SYMBOL(acpi_get_event_status)
520 /*******************************************************************************
522 * FUNCTION: acpi_get_gpe_status
524 * PARAMETERS: gpe_device - Parent GPE Device
525 * gpe_number - GPE level within the GPE block
526 * Flags - Called from an ISR or not
527 * event_status - Where the current status of the event will
532 * DESCRIPTION: Get status of an event (general purpose)
534 ******************************************************************************/
536 acpi_get_gpe_status(acpi_handle gpe_device,
537 u32 gpe_number, u32 flags, acpi_event_status * event_status)
539 acpi_status status = AE_OK;
540 struct acpi_gpe_event_info *gpe_event_info;
542 ACPI_FUNCTION_TRACE(acpi_get_gpe_status);
544 /* Use semaphore lock if not executing at interrupt level */
546 if (flags & ACPI_NOT_ISR) {
547 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
548 if (ACPI_FAILURE(status)) {
549 return_ACPI_STATUS(status);
553 /* Ensure that we have a valid GPE number */
555 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
556 if (!gpe_event_info) {
557 status = AE_BAD_PARAMETER;
558 goto unlock_and_exit;
561 /* Obtain status on the requested GPE number */
563 status = acpi_hw_get_gpe_status(gpe_event_info, event_status);
566 if (flags & ACPI_NOT_ISR) {
567 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
569 return_ACPI_STATUS(status);
572 ACPI_EXPORT_SYMBOL(acpi_get_gpe_status)
573 #endif /* ACPI_FUTURE_USAGE */
575 /*******************************************************************************
577 * FUNCTION: acpi_install_gpe_block
579 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
580 * gpe_block_address - Address and space_iD
581 * register_count - Number of GPE register pairs in the block
582 * interrupt_number - H/W interrupt for the block
586 * DESCRIPTION: Create and Install a block of GPE registers
588 ******************************************************************************/
590 acpi_install_gpe_block(acpi_handle gpe_device,
591 struct acpi_generic_address *gpe_block_address,
592 u32 register_count, u32 interrupt_number)
595 union acpi_operand_object *obj_desc;
596 struct acpi_namespace_node *node;
597 struct acpi_gpe_block_info *gpe_block;
599 ACPI_FUNCTION_TRACE(acpi_install_gpe_block);
601 if ((!gpe_device) || (!gpe_block_address) || (!register_count)) {
602 return_ACPI_STATUS(AE_BAD_PARAMETER);
605 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
606 if (ACPI_FAILURE(status)) {
610 node = acpi_ns_map_handle_to_node(gpe_device);
612 status = AE_BAD_PARAMETER;
613 goto unlock_and_exit;
617 * For user-installed GPE Block Devices, the gpe_block_base_number
621 acpi_ev_create_gpe_block(node, gpe_block_address, register_count, 0,
622 interrupt_number, &gpe_block);
623 if (ACPI_FAILURE(status)) {
624 goto unlock_and_exit;
627 /* Run the _PRW methods and enable the GPEs */
629 status = acpi_ev_initialize_gpe_block(node, gpe_block);
630 if (ACPI_FAILURE(status)) {
631 goto unlock_and_exit;
634 /* Get the device_object attached to the node */
636 obj_desc = acpi_ns_get_attached_object(node);
639 /* No object, create a new one */
641 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_DEVICE);
643 status = AE_NO_MEMORY;
644 goto unlock_and_exit;
648 acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_DEVICE);
650 /* Remove local reference to the object */
652 acpi_ut_remove_reference(obj_desc);
654 if (ACPI_FAILURE(status)) {
655 goto unlock_and_exit;
659 /* Install the GPE block in the device_object */
661 obj_desc->device.gpe_block = gpe_block;
664 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
665 return_ACPI_STATUS(status);
668 ACPI_EXPORT_SYMBOL(acpi_install_gpe_block)
670 /*******************************************************************************
672 * FUNCTION: acpi_remove_gpe_block
674 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
678 * DESCRIPTION: Remove a previously installed block of GPE registers
680 ******************************************************************************/
681 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device)
683 union acpi_operand_object *obj_desc;
685 struct acpi_namespace_node *node;
687 ACPI_FUNCTION_TRACE(acpi_remove_gpe_block);
690 return_ACPI_STATUS(AE_BAD_PARAMETER);
693 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
694 if (ACPI_FAILURE(status)) {
698 node = acpi_ns_map_handle_to_node(gpe_device);
700 status = AE_BAD_PARAMETER;
701 goto unlock_and_exit;
704 /* Get the device_object attached to the node */
706 obj_desc = acpi_ns_get_attached_object(node);
707 if (!obj_desc || !obj_desc->device.gpe_block) {
708 return_ACPI_STATUS(AE_NULL_OBJECT);
711 /* Delete the GPE block (but not the device_object) */
713 status = acpi_ev_delete_gpe_block(obj_desc->device.gpe_block);
714 if (ACPI_SUCCESS(status)) {
715 obj_desc->device.gpe_block = NULL;
719 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
720 return_ACPI_STATUS(status);
723 ACPI_EXPORT_SYMBOL(acpi_remove_gpe_block)