[deliverable/linux.git] / drivers / acpi / events / evxfregn.c

/******************************************************************************
 *
 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
 *                         Address Spaces.
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2008, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
#include <acpi/accommon.h>
#include <acpi/acnamesp.h>
#include <acpi/acevents.h>

#define _COMPONENT          ACPI_EVENTS
ACPI_MODULE_NAME("evxfregn")

/*******************************************************************************
 *
 * FUNCTION:    acpi_install_address_space_handler
 *
 * PARAMETERS:  Device          - Handle for the device
 *              space_id        - The address space ID
 *              Handler         - Address of the handler
 *              Setup           - Address of the setup function
 *              Context         - Value passed to the handler on each access
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Install a handler for all op_regions of a given space_id.
 *
 ******************************************************************************/
acpi_status
acpi_install_address_space_handler(acpi_handle device,
				   acpi_adr_space_type space_id,
				   acpi_adr_space_handler handler,
				   acpi_adr_space_setup setup, void *context)
{
	struct acpi_namespace_node *node;
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_install_address_space_handler);

	/* Parameter validation */

	if (!device) {
		return_ACPI_STATUS(AE_BAD_PARAMETER);
	}

	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Convert and validate the device handle */

	node = acpi_ns_map_handle_to_node(device);
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

	/* Install the handler for all Regions for this Space ID */

	status =
	    acpi_ev_install_space_handler(node, space_id, handler, setup,
					  context);
	if (ACPI_FAILURE(status)) {
		goto unlock_and_exit;
	}

	/* Run all _REG methods for this address space */

	status = acpi_ev_execute_reg_methods(node, space_id);

      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler)

/*******************************************************************************
 *
 * FUNCTION:    acpi_remove_address_space_handler
 *
 * PARAMETERS:  Device          - Handle for the device
 *              space_id        - The address space ID
 *              Handler         - Address of the handler
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Remove a previously installed handler.
 *
 ******************************************************************************/
acpi_status
acpi_remove_address_space_handler(acpi_handle device,
				  acpi_adr_space_type space_id,
				  acpi_adr_space_handler handler)
{
	union acpi_operand_object *obj_desc;
	union acpi_operand_object *handler_obj;
	union acpi_operand_object *region_obj;
	union acpi_operand_object **last_obj_ptr;
	struct acpi_namespace_node *node;
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler);

	/* Parameter validation */

	if (!device) {
		return_ACPI_STATUS(AE_BAD_PARAMETER);
	}

	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Convert and validate the device handle */

	node = acpi_ns_map_handle_to_node(device);
	if (!node ||
	    ((node->type != ACPI_TYPE_DEVICE) &&
	     (node->type != ACPI_TYPE_PROCESSOR) &&
	     (node->type != ACPI_TYPE_THERMAL) &&
	     (node != acpi_gbl_root_node))) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

	/* Make sure the internal object exists */

	obj_desc = acpi_ns_get_attached_object(node);
	if (!obj_desc) {
		status = AE_NOT_EXIST;
		goto unlock_and_exit;
	}

	/* Find the address handler the user requested */

	handler_obj = obj_desc->device.handler;
	last_obj_ptr = &obj_desc->device.handler;
	while (handler_obj) {

		/* We have a handler, see if user requested this one */

		if (handler_obj->address_space.space_id == space_id) {

			/* Handler must be the same as the installed handler */

			if (handler_obj->address_space.handler != handler) {
				status = AE_BAD_PARAMETER;
				goto unlock_and_exit;
			}

			/* Matched space_id, first dereference this in the Regions */

			ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
					  "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
					  handler_obj, handler,
					  acpi_ut_get_region_name(space_id),
					  node, obj_desc));

			region_obj = handler_obj->address_space.region_list;

			/* Walk the handler's region list */

			while (region_obj) {
				/*
				 * First disassociate the handler from the region.
				 *
				 * NOTE: this doesn't mean that the region goes away
				 * The region is just inaccessible as indicated to
				 * the _REG method
				 */
				acpi_ev_detach_region(region_obj, TRUE);

				/*
				 * Walk the list: Just grab the head because the
				 * detach_region removed the previous head.
				 */
				region_obj =
				    handler_obj->address_space.region_list;

			}

			/* Remove this Handler object from the list */

			*last_obj_ptr = handler_obj->address_space.next;

			/* Now we can delete the handler object */

			acpi_ut_remove_reference(handler_obj);
			goto unlock_and_exit;
		}

		/* Walk the linked list of handlers */

		last_obj_ptr = &handler_obj->address_space.next;
		handler_obj = handler_obj->address_space.next;
	}

	/* The handler does not exist */

	ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
			  "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
			  handler, acpi_ut_get_region_name(space_id), space_id,
			  node, obj_desc));

	status = AE_NOT_EXIST;

      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler)
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
	4	* Address Spaces.
	5	*
	6	*****************************************************************************/
	7
	8	/*
75a44ce0	9	* Copyright (C) 2000 - 2008, Intel Corp.
1da177e4 LT	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
1da177e4	45	#include <acpi/acpi.h>
50df4d8b	46	#include <acpi/accommon.h>
1da177e4 LT	47	#include <acpi/acnamesp.h>
	48	#include <acpi/acevents.h>
	49
	50	#define _COMPONENT ACPI_EVENTS
4be44fcd	51	ACPI_MODULE_NAME("evxfregn")
1da177e4 LT	52
	53	/*******************************************************************************
	54	*
	55	* FUNCTION: acpi_install_address_space_handler
	56	*
	57	* PARAMETERS: Device - Handle for the device
	58	* space_id - The address space ID
	59	* Handler - Address of the handler
	60	* Setup - Address of the setup function
	61	* Context - Value passed to the handler on each access
	62	*
	63	* RETURN: Status
	64	*
	65	* DESCRIPTION: Install a handler for all op_regions of a given space_id.
	66	*
	67	******************************************************************************/
1da177e4	68	acpi_status
4be44fcd LB	69	acpi_install_address_space_handler(acpi_handle device,
	70	acpi_adr_space_type space_id,
	71	acpi_adr_space_handler handler,
	72	acpi_adr_space_setup setup, void *context)
1da177e4	73	{
4be44fcd LB	74	struct acpi_namespace_node *node;
4be44fcd LB	75	acpi_status status;
1da177e4	76
b229cf92	77	ACPI_FUNCTION_TRACE(acpi_install_address_space_handler);
1da177e4 LT	78
	79	/* Parameter validation */
	80
	81	if (!device) {
4be44fcd	82	return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4 LT	83	}
1da177e4 LT	84
4be44fcd LB	85	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	86	if (ACPI_FAILURE(status)) {
	87	return_ACPI_STATUS(status);
1da177e4 LT	88	}
	89
	90	/* Convert and validate the device handle */
	91
4be44fcd	92	node = acpi_ns_map_handle_to_node(device);
1da177e4 LT	93	if (!node) {
	94	status = AE_BAD_PARAMETER;
	95	goto unlock_and_exit;
	96	}
	97
	98	/* Install the handler for all Regions for this Space ID */
	99
4be44fcd LB	100	status =
	101	acpi_ev_install_space_handler(node, space_id, handler, setup,
	102	context);
	103	if (ACPI_FAILURE(status)) {
1da177e4 LT	104	goto unlock_and_exit;
	105	}
	106
	107	/* Run all _REG methods for this address space */
	108
4be44fcd	109	status = acpi_ev_execute_reg_methods(node, space_id);
1da177e4	110
4be44fcd LB	111	unlock_and_exit:
	112	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	113	return_ACPI_STATUS(status);
1da177e4	114	}
1da177e4	115
8313524a	116	ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler)
1da177e4 LT	117
	118	/*******************************************************************************
	119	*
	120	* FUNCTION: acpi_remove_address_space_handler
	121	*
	122	* PARAMETERS: Device - Handle for the device
	123	* space_id - The address space ID
	124	* Handler - Address of the handler
	125	*
	126	* RETURN: Status
	127	*
	128	* DESCRIPTION: Remove a previously installed handler.
	129	*
	130	******************************************************************************/
1da177e4	131	acpi_status
4be44fcd LB	132	acpi_remove_address_space_handler(acpi_handle device,
	133	acpi_adr_space_type space_id,
	134	acpi_adr_space_handler handler)
1da177e4	135	{
4be44fcd LB	136	union acpi_operand_object *obj_desc;
	137	union acpi_operand_object *handler_obj;
	138	union acpi_operand_object *region_obj;
	139	union acpi_operand_object **last_obj_ptr;
	140	struct acpi_namespace_node *node;
	141	acpi_status status;
1da177e4	142
b229cf92	143	ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler);
1da177e4 LT	144
	145	/* Parameter validation */
	146
	147	if (!device) {
4be44fcd	148	return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4 LT	149	}
1da177e4 LT	150
4be44fcd LB	151	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	152	if (ACPI_FAILURE(status)) {
	153	return_ACPI_STATUS(status);
1da177e4 LT	154	}
	155
	156	/* Convert and validate the device handle */
	157
4be44fcd	158	node = acpi_ns_map_handle_to_node(device);
f6dd9221 BM	159	if (!node \|\|
	160	((node->type != ACPI_TYPE_DEVICE) &&
	161	(node->type != ACPI_TYPE_PROCESSOR) &&
	162	(node->type != ACPI_TYPE_THERMAL) &&
	163	(node != acpi_gbl_root_node))) {
1da177e4 LT	164	status = AE_BAD_PARAMETER;
	165	goto unlock_and_exit;
	166	}
	167
	168	/* Make sure the internal object exists */
	169
4be44fcd	170	obj_desc = acpi_ns_get_attached_object(node);
1da177e4 LT	171	if (!obj_desc) {
	172	status = AE_NOT_EXIST;
	173	goto unlock_and_exit;
	174	}
	175
	176	/* Find the address handler the user requested */
	177
	178	handler_obj = obj_desc->device.handler;
	179	last_obj_ptr = &obj_desc->device.handler;
	180	while (handler_obj) {
52fc0b02	181
1da177e4 LT	182	/* We have a handler, see if user requested this one */
	183
	184	if (handler_obj->address_space.space_id == space_id) {
52fc0b02	185
f6dd9221 BM	186	/* Handler must be the same as the installed handler */
	187
	188	if (handler_obj->address_space.handler != handler) {
	189	status = AE_BAD_PARAMETER;
	190	goto unlock_and_exit;
	191	}
	192
1da177e4 LT	193	/* Matched space_id, first dereference this in the Regions */
1da177e4 LT	194
4be44fcd LB	195	ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
	196	"Removing address handler %p(%p) for region %s on Device %p(%p)\n",
	197	handler_obj, handler,
	198	acpi_ut_get_region_name(space_id),
	199	node, obj_desc));
1da177e4 LT	200
	201	region_obj = handler_obj->address_space.region_list;
	202
	203	/* Walk the handler's region list */
	204
	205	while (region_obj) {
	206	/*
	207	* First disassociate the handler from the region.
	208	*
	209	* NOTE: this doesn't mean that the region goes away
	210	* The region is just inaccessible as indicated to
	211	* the _REG method
	212	*/
4be44fcd	213	acpi_ev_detach_region(region_obj, TRUE);
1da177e4 LT	214
	215	/*
	216	* Walk the list: Just grab the head because the
	217	* detach_region removed the previous head.
	218	*/
4be44fcd LB	219	region_obj =
4be44fcd LB	220	handler_obj->address_space.region_list;
1da177e4 LT	221
	222	}
	223
	224	/* Remove this Handler object from the list */
	225
	226	*last_obj_ptr = handler_obj->address_space.next;
	227
	228	/* Now we can delete the handler object */
	229
4be44fcd	230	acpi_ut_remove_reference(handler_obj);
1da177e4 LT	231	goto unlock_and_exit;
	232	}
	233
	234	/* Walk the linked list of handlers */
	235
	236	last_obj_ptr = &handler_obj->address_space.next;
	237	handler_obj = handler_obj->address_space.next;
	238	}
	239
	240	/* The handler does not exist */
	241
4be44fcd	242	ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
b229cf92	243	"Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
4be44fcd LB	244	handler, acpi_ut_get_region_name(space_id), space_id,
4be44fcd LB	245	node, obj_desc));
1da177e4 LT	246
	247	status = AE_NOT_EXIST;
	248
4be44fcd LB	249	unlock_and_exit:
	250	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	251	return_ACPI_STATUS(status);
1da177e4	252	}
1da177e4	253
8313524a	254	ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler)