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 <linux/module.h>
46 #include <acpi/acpi.h>
47 #include <acpi/acevents.h>
48 #include <acpi/acnamesp.h>
50 #define _COMPONENT ACPI_EVENTS
51 ACPI_MODULE_NAME("evxfevnt")
53 /*******************************************************************************
55 * FUNCTION: acpi_enable
61 * DESCRIPTION: Transfers the system into ACPI mode.
63 ******************************************************************************/
64 acpi_status acpi_enable(void)
66 acpi_status status = AE_OK;
68 ACPI_FUNCTION_TRACE("acpi_enable");
70 /* Make sure we have the FADT */
73 ACPI_WARNING((AE_INFO, "No FADT information present!"));
74 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
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 /*******************************************************************************
99 * FUNCTION: acpi_disable
105 * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
107 ******************************************************************************/
109 acpi_status acpi_disable(void)
111 acpi_status status = AE_OK;
113 ACPI_FUNCTION_TRACE("acpi_disable");
115 if (!acpi_gbl_FADT) {
116 ACPI_WARNING((AE_INFO, "No FADT information present!"));
117 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
120 if (acpi_hw_get_mode() == ACPI_SYS_MODE_LEGACY) {
121 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
122 "System is already in legacy (non-ACPI) mode\n"));
124 /* Transition to LEGACY mode */
126 status = acpi_hw_set_mode(ACPI_SYS_MODE_LEGACY);
128 if (ACPI_FAILURE(status)) {
130 "Could not exit ACPI mode to legacy mode"));
131 return_ACPI_STATUS(status);
134 ACPI_DEBUG_PRINT((ACPI_DB_INIT, "ACPI mode disabled\n"));
137 return_ACPI_STATUS(status);
140 /*******************************************************************************
142 * FUNCTION: acpi_enable_event
144 * PARAMETERS: Event - The fixed eventto be enabled
149 * DESCRIPTION: Enable an ACPI event (fixed)
151 ******************************************************************************/
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 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 ******************************************************************************/
212 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type)
214 acpi_status status = AE_OK;
215 struct acpi_gpe_event_info *gpe_event_info;
217 ACPI_FUNCTION_TRACE("acpi_set_gpe_type");
219 /* Ensure that we have a valid GPE number */
221 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
222 if (!gpe_event_info) {
223 status = AE_BAD_PARAMETER;
224 goto unlock_and_exit;
227 if ((gpe_event_info->flags & ACPI_GPE_TYPE_MASK) == type) {
228 return_ACPI_STATUS(AE_OK);
231 /* Set the new type (will disable GPE if currently enabled) */
233 status = acpi_ev_set_gpe_type(gpe_event_info, type);
236 return_ACPI_STATUS(status);
239 EXPORT_SYMBOL(acpi_set_gpe_type);
241 /*******************************************************************************
243 * FUNCTION: acpi_enable_gpe
245 * PARAMETERS: gpe_device - Parent GPE Device
246 * gpe_number - GPE level within the GPE block
247 * Flags - Just enable, or also wake enable?
248 * Called from ISR or not
252 * DESCRIPTION: Enable an ACPI event (general purpose)
254 ******************************************************************************/
256 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
258 acpi_status status = AE_OK;
259 struct acpi_gpe_event_info *gpe_event_info;
261 ACPI_FUNCTION_TRACE("acpi_enable_gpe");
263 /* Use semaphore lock if not executing at interrupt level */
265 if (flags & ACPI_NOT_ISR) {
266 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
267 if (ACPI_FAILURE(status)) {
268 return_ACPI_STATUS(status);
272 /* Ensure that we have a valid GPE number */
274 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
275 if (!gpe_event_info) {
276 status = AE_BAD_PARAMETER;
277 goto unlock_and_exit;
280 /* Perform the enable */
282 status = acpi_ev_enable_gpe(gpe_event_info, TRUE);
285 if (flags & ACPI_NOT_ISR) {
286 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
288 return_ACPI_STATUS(status);
291 EXPORT_SYMBOL(acpi_enable_gpe);
293 /*******************************************************************************
295 * FUNCTION: acpi_disable_gpe
297 * PARAMETERS: gpe_device - Parent GPE Device
298 * gpe_number - GPE level within the GPE block
299 * Flags - Just disable, or also wake disable?
300 * Called from ISR or not
304 * DESCRIPTION: Disable an ACPI event (general purpose)
306 ******************************************************************************/
308 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
310 acpi_status status = AE_OK;
311 struct acpi_gpe_event_info *gpe_event_info;
313 ACPI_FUNCTION_TRACE("acpi_disable_gpe");
315 /* Use semaphore lock if not executing at interrupt level */
317 if (flags & ACPI_NOT_ISR) {
318 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
319 if (ACPI_FAILURE(status)) {
320 return_ACPI_STATUS(status);
324 /* Ensure that we have a valid GPE number */
326 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
327 if (!gpe_event_info) {
328 status = AE_BAD_PARAMETER;
329 goto unlock_and_exit;
332 status = acpi_ev_disable_gpe(gpe_event_info);
335 if (flags & ACPI_NOT_ISR) {
336 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
338 return_ACPI_STATUS(status);
341 /*******************************************************************************
343 * FUNCTION: acpi_disable_event
345 * PARAMETERS: Event - The fixed eventto be enabled
350 * DESCRIPTION: Disable an ACPI event (fixed)
352 ******************************************************************************/
354 acpi_status acpi_disable_event(u32 event, u32 flags)
356 acpi_status status = AE_OK;
359 ACPI_FUNCTION_TRACE("acpi_disable_event");
361 /* Decode the Fixed Event */
363 if (event > ACPI_EVENT_MAX) {
364 return_ACPI_STATUS(AE_BAD_PARAMETER);
368 * Disable the requested fixed event (by writing a zero to the
369 * enable register bit)
372 acpi_set_register(acpi_gbl_fixed_event_info[event].
373 enable_register_id, 0, ACPI_MTX_LOCK);
374 if (ACPI_FAILURE(status)) {
375 return_ACPI_STATUS(status);
379 acpi_get_register(acpi_gbl_fixed_event_info[event].
380 enable_register_id, &value, ACPI_MTX_LOCK);
381 if (ACPI_FAILURE(status)) {
382 return_ACPI_STATUS(status);
387 "Could not disable %s events",
388 acpi_ut_get_event_name(event)));
389 return_ACPI_STATUS(AE_NO_HARDWARE_RESPONSE);
392 return_ACPI_STATUS(status);
395 EXPORT_SYMBOL(acpi_disable_event);
397 /*******************************************************************************
399 * FUNCTION: acpi_clear_event
401 * PARAMETERS: Event - The fixed event to be cleared
405 * DESCRIPTION: Clear an ACPI event (fixed)
407 ******************************************************************************/
409 acpi_status acpi_clear_event(u32 event)
411 acpi_status status = AE_OK;
413 ACPI_FUNCTION_TRACE("acpi_clear_event");
415 /* Decode the Fixed Event */
417 if (event > ACPI_EVENT_MAX) {
418 return_ACPI_STATUS(AE_BAD_PARAMETER);
422 * Clear the requested fixed event (By writing a one to the
423 * status register bit)
426 acpi_set_register(acpi_gbl_fixed_event_info[event].
427 status_register_id, 1, ACPI_MTX_LOCK);
429 return_ACPI_STATUS(status);
432 EXPORT_SYMBOL(acpi_clear_event);
434 /*******************************************************************************
436 * FUNCTION: acpi_clear_gpe
438 * PARAMETERS: gpe_device - Parent GPE Device
439 * gpe_number - GPE level within the GPE block
440 * Flags - Called from an ISR or not
444 * DESCRIPTION: Clear an ACPI event (general purpose)
446 ******************************************************************************/
448 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags)
450 acpi_status status = AE_OK;
451 struct acpi_gpe_event_info *gpe_event_info;
453 ACPI_FUNCTION_TRACE("acpi_clear_gpe");
455 /* Use semaphore lock if not executing at interrupt level */
457 if (flags & ACPI_NOT_ISR) {
458 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
459 if (ACPI_FAILURE(status)) {
460 return_ACPI_STATUS(status);
464 /* Ensure that we have a valid GPE number */
466 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
467 if (!gpe_event_info) {
468 status = AE_BAD_PARAMETER;
469 goto unlock_and_exit;
472 status = acpi_hw_clear_gpe(gpe_event_info);
475 if (flags & ACPI_NOT_ISR) {
476 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
478 return_ACPI_STATUS(status);
481 #ifdef ACPI_FUTURE_USAGE
482 /*******************************************************************************
484 * FUNCTION: acpi_get_event_status
486 * PARAMETERS: Event - The fixed event
487 * event_status - Where the current status of the event will
492 * DESCRIPTION: Obtains and returns the current status of the event
494 ******************************************************************************/
496 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status)
498 acpi_status status = AE_OK;
500 ACPI_FUNCTION_TRACE("acpi_get_event_status");
503 return_ACPI_STATUS(AE_BAD_PARAMETER);
506 /* Decode the Fixed Event */
508 if (event > ACPI_EVENT_MAX) {
509 return_ACPI_STATUS(AE_BAD_PARAMETER);
512 /* Get the status of the requested fixed event */
515 acpi_get_register(acpi_gbl_fixed_event_info[event].
516 status_register_id, event_status, ACPI_MTX_LOCK);
518 return_ACPI_STATUS(status);
521 /*******************************************************************************
523 * FUNCTION: acpi_get_gpe_status
525 * PARAMETERS: gpe_device - Parent GPE Device
526 * gpe_number - GPE level within the GPE block
527 * Flags - Called from an ISR or not
528 * event_status - Where the current status of the event will
533 * DESCRIPTION: Get status of an event (general purpose)
535 ******************************************************************************/
538 acpi_get_gpe_status(acpi_handle gpe_device,
539 u32 gpe_number, u32 flags, acpi_event_status * event_status)
541 acpi_status status = AE_OK;
542 struct acpi_gpe_event_info *gpe_event_info;
544 ACPI_FUNCTION_TRACE("acpi_get_gpe_status");
546 /* Use semaphore lock if not executing at interrupt level */
548 if (flags & ACPI_NOT_ISR) {
549 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
550 if (ACPI_FAILURE(status)) {
551 return_ACPI_STATUS(status);
555 /* Ensure that we have a valid GPE number */
557 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
558 if (!gpe_event_info) {
559 status = AE_BAD_PARAMETER;
560 goto unlock_and_exit;
563 /* Obtain status on the requested GPE number */
565 status = acpi_hw_get_gpe_status(gpe_event_info, event_status);
568 if (flags & ACPI_NOT_ISR) {
569 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
571 return_ACPI_STATUS(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 ******************************************************************************/
591 acpi_install_gpe_block(acpi_handle gpe_device,
592 struct acpi_generic_address *gpe_block_address,
593 u32 register_count, u32 interrupt_number)
596 union acpi_operand_object *obj_desc;
597 struct acpi_namespace_node *node;
598 struct acpi_gpe_block_info *gpe_block;
600 ACPI_FUNCTION_TRACE("acpi_install_gpe_block");
602 if ((!gpe_device) || (!gpe_block_address) || (!register_count)) {
603 return_ACPI_STATUS(AE_BAD_PARAMETER);
606 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
607 if (ACPI_FAILURE(status)) {
611 node = acpi_ns_map_handle_to_node(gpe_device);
613 status = AE_BAD_PARAMETER;
614 goto unlock_and_exit;
618 * For user-installed GPE Block Devices, the gpe_block_base_number
622 acpi_ev_create_gpe_block(node, gpe_block_address, register_count, 0,
623 interrupt_number, &gpe_block);
624 if (ACPI_FAILURE(status)) {
625 goto unlock_and_exit;
628 /* Run the _PRW methods and enable the GPEs */
630 status = acpi_ev_initialize_gpe_block(node, gpe_block);
631 if (ACPI_FAILURE(status)) {
632 goto unlock_and_exit;
635 /* Get the device_object attached to the node */
637 obj_desc = acpi_ns_get_attached_object(node);
640 /* No object, create a new one */
642 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_DEVICE);
644 status = AE_NO_MEMORY;
645 goto unlock_and_exit;
649 acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_DEVICE);
651 /* Remove local reference to the object */
653 acpi_ut_remove_reference(obj_desc);
655 if (ACPI_FAILURE(status)) {
656 goto unlock_and_exit;
660 /* Install the GPE block in the device_object */
662 obj_desc->device.gpe_block = gpe_block;
665 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
666 return_ACPI_STATUS(status);
669 EXPORT_SYMBOL(acpi_install_gpe_block);
671 /*******************************************************************************
673 * FUNCTION: acpi_remove_gpe_block
675 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
679 * DESCRIPTION: Remove a previously installed block of GPE registers
681 ******************************************************************************/
683 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device)
685 union acpi_operand_object *obj_desc;
687 struct acpi_namespace_node *node;
689 ACPI_FUNCTION_TRACE("acpi_remove_gpe_block");
692 return_ACPI_STATUS(AE_BAD_PARAMETER);
695 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
696 if (ACPI_FAILURE(status)) {
700 node = acpi_ns_map_handle_to_node(gpe_device);
702 status = AE_BAD_PARAMETER;
703 goto unlock_and_exit;
706 /* Get the device_object attached to the node */
708 obj_desc = acpi_ns_get_attached_object(node);
709 if (!obj_desc || !obj_desc->device.gpe_block) {
710 return_ACPI_STATUS(AE_NULL_OBJECT);
713 /* Delete the GPE block (but not the device_object) */
715 status = acpi_ev_delete_gpe_block(obj_desc->device.gpe_block);
716 if (ACPI_SUCCESS(status)) {
717 obj_desc->device.gpe_block = NULL;
721 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
722 return_ACPI_STATUS(status);
725 EXPORT_SYMBOL(acpi_remove_gpe_block);