[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / acpi / acpica / evxfregn.c

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

/*
 * Copyright (C) 2000 - 2012, 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 <linux/export.h>
#include <acpi/acpi.h>
#include "accommon.h"
#include "acnamesp.h"
#include "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.
 *
 * NOTE: This function should only be called after acpi_enable_subsystem has
 * been called. This is because any _REG methods associated with the Space ID
 * are executed here, and these methods can only be safely executed after
 * the default handlers have been installed and the hardware has been
 * initialized (via acpi_enable_subsystem.)
 *
 ******************************************************************************/
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_validate_handle(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;
	}

	/*
	 * For the default space_iDs, (the IDs for which there are default region handlers
	 * installed) Only execute the _REG methods if the global initialization _REG
	 * methods have already been run (via acpi_initialize_objects). In other words,
	 * we will defer the execution of the _REG methods for these space_iDs until
	 * execution of acpi_initialize_objects. This is done because we need the handlers
	 * for the default spaces (mem/io/pci/table) to be installed before we can run
	 * any control methods (or _REG methods). There is known BIOS code that depends
	 * on this.
	 *
	 * For all other space_iDs, we can safely execute the _REG methods immediately.
	 * This means that for IDs like embedded_controller, this function should be called
	 * only after acpi_enable_subsystem has been called.
	 */
	switch (space_id) {
	case ACPI_ADR_SPACE_SYSTEM_MEMORY:
	case ACPI_ADR_SPACE_SYSTEM_IO:
	case ACPI_ADR_SPACE_PCI_CONFIG:
	case ACPI_ADR_SPACE_DATA_TABLE:

		if (!acpi_gbl_reg_methods_executed) {

			/* We will defer execution of the _REG methods for this space */
			goto unlock_and_exit;
		}
		break;

	default:
		break;
	}

	/* 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_validate_handle(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	/*
77848130	9	* Copyright (C) 2000 - 2012, 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
214f2c90	45	#include <linux/export.h>
1da177e4	46	#include <acpi/acpi.h>
e2f7a777 LB	47	#include "accommon.h"
	48	#include "acnamesp.h"
	49	#include "acevents.h"
1da177e4 LT	50
1da177e4 LT	51	#define _COMPONENT ACPI_EVENTS
4be44fcd	52	ACPI_MODULE_NAME("evxfregn")
1da177e4 LT	53
	54	/*******************************************************************************
	55	*
	56	* FUNCTION: acpi_install_address_space_handler
	57	*
	58	* PARAMETERS: Device - Handle for the device
	59	* space_id - The address space ID
	60	* Handler - Address of the handler
	61	* Setup - Address of the setup function
	62	* Context - Value passed to the handler on each access
	63	*
	64	* RETURN: Status
	65	*
	66	* DESCRIPTION: Install a handler for all op_regions of a given space_id.
	67	*
3989170f BM	68	* NOTE: This function should only be called after acpi_enable_subsystem has
	69	* been called. This is because any _REG methods associated with the Space ID
	70	* are executed here, and these methods can only be safely executed after
	71	* the default handlers have been installed and the hardware has been
	72	* initialized (via acpi_enable_subsystem.)
	73	*
1da177e4	74	******************************************************************************/
1da177e4	75	acpi_status
4be44fcd LB	76	acpi_install_address_space_handler(acpi_handle device,
	77	acpi_adr_space_type space_id,
	78	acpi_adr_space_handler handler,
	79	acpi_adr_space_setup setup, void *context)
1da177e4	80	{
4be44fcd LB	81	struct acpi_namespace_node *node;
4be44fcd LB	82	acpi_status status;
1da177e4	83
b229cf92	84	ACPI_FUNCTION_TRACE(acpi_install_address_space_handler);
1da177e4 LT	85
	86	/* Parameter validation */
	87
	88	if (!device) {
4be44fcd	89	return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4 LT	90	}
1da177e4 LT	91
4be44fcd LB	92	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	93	if (ACPI_FAILURE(status)) {
	94	return_ACPI_STATUS(status);
1da177e4 LT	95	}
	96
	97	/* Convert and validate the device handle */
	98
f24b664d	99	node = acpi_ns_validate_handle(device);
1da177e4 LT	100	if (!node) {
	101	status = AE_BAD_PARAMETER;
	102	goto unlock_and_exit;
	103	}
	104
	105	/* Install the handler for all Regions for this Space ID */
	106
4be44fcd LB	107	status =
	108	acpi_ev_install_space_handler(node, space_id, handler, setup,
	109	context);
	110	if (ACPI_FAILURE(status)) {
1da177e4 LT	111	goto unlock_and_exit;
	112	}
	113
ef09c4f5 BM	114	/*
	115	* For the default space_iDs, (the IDs for which there are default region handlers
	116	* installed) Only execute the _REG methods if the global initialization _REG
	117	* methods have already been run (via acpi_initialize_objects). In other words,
	118	* we will defer the execution of the _REG methods for these space_iDs until
	119	* execution of acpi_initialize_objects. This is done because we need the handlers
	120	* for the default spaces (mem/io/pci/table) to be installed before we can run
	121	* any control methods (or _REG methods). There is known BIOS code that depends
	122	* on this.
	123	*
	124	* For all other space_iDs, we can safely execute the _REG methods immediately.
	125	* This means that for IDs like embedded_controller, this function should be called
	126	* only after acpi_enable_subsystem has been called.
	127	*/
	128	switch (space_id) {
	129	case ACPI_ADR_SPACE_SYSTEM_MEMORY:
	130	case ACPI_ADR_SPACE_SYSTEM_IO:
	131	case ACPI_ADR_SPACE_PCI_CONFIG:
	132	case ACPI_ADR_SPACE_DATA_TABLE:
	133
e2066ca1	134	if (!acpi_gbl_reg_methods_executed) {
ef09c4f5	135
e2066ca1 BM	136	/* We will defer execution of the _REG methods for this space */
e2066ca1 BM	137	goto unlock_and_exit;
ef09c4f5 BM	138	}
	139	break;
	140
	141	default:
ef09c4f5 BM	142	break;
ef09c4f5 BM	143	}
1da177e4	144
e2066ca1 BM	145	/* Run all _REG methods for this address space */
	146
	147	status = acpi_ev_execute_reg_methods(node, space_id);
	148
4be44fcd LB	149	unlock_and_exit:
	150	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	151	return_ACPI_STATUS(status);
1da177e4	152	}
1da177e4	153
8313524a	154	ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler)
1da177e4 LT	155
	156	/*******************************************************************************
	157	*
	158	* FUNCTION: acpi_remove_address_space_handler
	159	*
	160	* PARAMETERS: Device - Handle for the device
	161	* space_id - The address space ID
	162	* Handler - Address of the handler
	163	*
	164	* RETURN: Status
	165	*
	166	* DESCRIPTION: Remove a previously installed handler.
	167	*
	168	******************************************************************************/
1da177e4	169	acpi_status
4be44fcd LB	170	acpi_remove_address_space_handler(acpi_handle device,
	171	acpi_adr_space_type space_id,
	172	acpi_adr_space_handler handler)
1da177e4	173	{
4be44fcd LB	174	union acpi_operand_object *obj_desc;
	175	union acpi_operand_object *handler_obj;
	176	union acpi_operand_object *region_obj;
	177	union acpi_operand_object **last_obj_ptr;
	178	struct acpi_namespace_node *node;
	179	acpi_status status;
1da177e4	180
b229cf92	181	ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler);
1da177e4 LT	182
	183	/* Parameter validation */
	184
	185	if (!device) {
4be44fcd	186	return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4 LT	187	}
1da177e4 LT	188
4be44fcd LB	189	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	190	if (ACPI_FAILURE(status)) {
	191	return_ACPI_STATUS(status);
1da177e4 LT	192	}
	193
	194	/* Convert and validate the device handle */
	195
f24b664d	196	node = acpi_ns_validate_handle(device);
f6dd9221 BM	197	if (!node \|\|
	198	((node->type != ACPI_TYPE_DEVICE) &&
	199	(node->type != ACPI_TYPE_PROCESSOR) &&
	200	(node->type != ACPI_TYPE_THERMAL) &&
	201	(node != acpi_gbl_root_node))) {
1da177e4 LT	202	status = AE_BAD_PARAMETER;
	203	goto unlock_and_exit;
	204	}
	205
	206	/* Make sure the internal object exists */
	207
4be44fcd	208	obj_desc = acpi_ns_get_attached_object(node);
1da177e4 LT	209	if (!obj_desc) {
	210	status = AE_NOT_EXIST;
	211	goto unlock_and_exit;
	212	}
	213
	214	/* Find the address handler the user requested */
	215
	216	handler_obj = obj_desc->device.handler;
	217	last_obj_ptr = &obj_desc->device.handler;
	218	while (handler_obj) {
52fc0b02	219
1da177e4 LT	220	/* We have a handler, see if user requested this one */
	221
	222	if (handler_obj->address_space.space_id == space_id) {
52fc0b02	223
f6dd9221 BM	224	/* Handler must be the same as the installed handler */
	225
	226	if (handler_obj->address_space.handler != handler) {
	227	status = AE_BAD_PARAMETER;
	228	goto unlock_and_exit;
	229	}
	230
1da177e4 LT	231	/* Matched space_id, first dereference this in the Regions */
1da177e4 LT	232
4be44fcd	233	ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
d4913dc6 BM	234	"Removing address handler %p(%p) for region %s "
d4913dc6 BM	235	"on Device %p(%p)\n",
4be44fcd LB	236	handler_obj, handler,
	237	acpi_ut_get_region_name(space_id),
	238	node, obj_desc));
1da177e4 LT	239
	240	region_obj = handler_obj->address_space.region_list;
	241
	242	/* Walk the handler's region list */
	243
	244	while (region_obj) {
	245	/*
	246	* First disassociate the handler from the region.
	247	*
	248	* NOTE: this doesn't mean that the region goes away
	249	* The region is just inaccessible as indicated to
	250	* the _REG method
	251	*/
4be44fcd	252	acpi_ev_detach_region(region_obj, TRUE);
1da177e4 LT	253
	254	/*
	255	* Walk the list: Just grab the head because the
	256	* detach_region removed the previous head.
	257	*/
4be44fcd LB	258	region_obj =
4be44fcd LB	259	handler_obj->address_space.region_list;
1da177e4 LT	260
	261	}
	262
	263	/* Remove this Handler object from the list */
	264
	265	*last_obj_ptr = handler_obj->address_space.next;
	266
	267	/* Now we can delete the handler object */
	268
4be44fcd	269	acpi_ut_remove_reference(handler_obj);
1da177e4 LT	270	goto unlock_and_exit;
	271	}
	272
	273	/* Walk the linked list of handlers */
	274
	275	last_obj_ptr = &handler_obj->address_space.next;
	276	handler_obj = handler_obj->address_space.next;
	277	}
	278
	279	/* The handler does not exist */
	280
4be44fcd	281	ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
b229cf92	282	"Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
4be44fcd LB	283	handler, acpi_ut_get_region_name(space_id), space_id,
4be44fcd LB	284	node, obj_desc));
1da177e4 LT	285
	286	status = AE_NOT_EXIST;
	287
4be44fcd LB	288	unlock_and_exit:
	289	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	290	return_ACPI_STATUS(status);
1da177e4	291	}
1da177e4	292
8313524a	293	ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler)