ACPICA: Update all ACPICA copyrights and signons to 2010
[linux-3.10.git] / drivers / acpi / acpica / evxfregn.c
1 /******************************************************************************
2  *
3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
4  *                         Address Spaces.
5  *
6  *****************************************************************************/
7
8 /*
9  * Copyright (C) 2000 - 2010, Intel Corp.
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
45 #include <acpi/acpi.h>
46 #include "accommon.h"
47 #include "acnamesp.h"
48 #include "acevents.h"
49
50 #define _COMPONENT          ACPI_EVENTS
51 ACPI_MODULE_NAME("evxfregn")
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  ******************************************************************************/
68 acpi_status
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)
73 {
74         struct acpi_namespace_node *node;
75         acpi_status status;
76
77         ACPI_FUNCTION_TRACE(acpi_install_address_space_handler);
78
79         /* Parameter validation */
80
81         if (!device) {
82                 return_ACPI_STATUS(AE_BAD_PARAMETER);
83         }
84
85         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
86         if (ACPI_FAILURE(status)) {
87                 return_ACPI_STATUS(status);
88         }
89
90         /* Convert and validate the device handle */
91
92         node = acpi_ns_validate_handle(device);
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
100         status =
101             acpi_ev_install_space_handler(node, space_id, handler, setup,
102                                           context);
103         if (ACPI_FAILURE(status)) {
104                 goto unlock_and_exit;
105         }
106
107         /* Run all _REG methods for this address space */
108
109         status = acpi_ev_execute_reg_methods(node, space_id);
110
111       unlock_and_exit:
112         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
113         return_ACPI_STATUS(status);
114 }
115
116 ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler)
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  ******************************************************************************/
131 acpi_status
132 acpi_remove_address_space_handler(acpi_handle device,
133                                   acpi_adr_space_type space_id,
134                                   acpi_adr_space_handler handler)
135 {
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;
142
143         ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler);
144
145         /* Parameter validation */
146
147         if (!device) {
148                 return_ACPI_STATUS(AE_BAD_PARAMETER);
149         }
150
151         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
152         if (ACPI_FAILURE(status)) {
153                 return_ACPI_STATUS(status);
154         }
155
156         /* Convert and validate the device handle */
157
158         node = acpi_ns_validate_handle(device);
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))) {
164                 status = AE_BAD_PARAMETER;
165                 goto unlock_and_exit;
166         }
167
168         /* Make sure the internal object exists */
169
170         obj_desc = acpi_ns_get_attached_object(node);
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) {
181
182                 /* We have a handler, see if user requested this one */
183
184                 if (handler_obj->address_space.space_id == space_id) {
185
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
193                         /* Matched space_id, first dereference this in the Regions */
194
195                         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
196                                           "Removing address handler %p(%p) for region %s "
197                                           "on Device %p(%p)\n",
198                                           handler_obj, handler,
199                                           acpi_ut_get_region_name(space_id),
200                                           node, obj_desc));
201
202                         region_obj = handler_obj->address_space.region_list;
203
204                         /* Walk the handler's region list */
205
206                         while (region_obj) {
207                                 /*
208                                  * First disassociate the handler from the region.
209                                  *
210                                  * NOTE: this doesn't mean that the region goes away
211                                  * The region is just inaccessible as indicated to
212                                  * the _REG method
213                                  */
214                                 acpi_ev_detach_region(region_obj, TRUE);
215
216                                 /*
217                                  * Walk the list: Just grab the head because the
218                                  * detach_region removed the previous head.
219                                  */
220                                 region_obj =
221                                     handler_obj->address_space.region_list;
222
223                         }
224
225                         /* Remove this Handler object from the list */
226
227                         *last_obj_ptr = handler_obj->address_space.next;
228
229                         /* Now we can delete the handler object */
230
231                         acpi_ut_remove_reference(handler_obj);
232                         goto unlock_and_exit;
233                 }
234
235                 /* Walk the linked list of handlers */
236
237                 last_obj_ptr = &handler_obj->address_space.next;
238                 handler_obj = handler_obj->address_space.next;
239         }
240
241         /* The handler does not exist */
242
243         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
244                           "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
245                           handler, acpi_ut_get_region_name(space_id), space_id,
246                           node, obj_desc));
247
248         status = AE_NOT_EXIST;
249
250       unlock_and_exit:
251         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
252         return_ACPI_STATUS(status);
253 }
254
255 ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler)