1 /******************************************************************************
2 *
3 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
4 * Address Spaces.
5 *
6 *****************************************************************************/
7
8 /*
9 * Copyright (C) 2000 - 2016, 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 #define EXPORT_ACPI_INTERFACES
46
47 #include <acpi/acpi.h>
48 #include "accommon.h"
49 #include "acnamesp.h"
50 #include "acevents.h"
51
52 #define _COMPONENT ACPI_EVENTS
53 ACPI_MODULE_NAME("evxfregn")
54
55 /*******************************************************************************
56 *
57 * FUNCTION: acpi_install_address_space_handler
58 *
59 * PARAMETERS: device - Handle for the device
60 * space_id - The address space ID
61 * handler - Address of the handler
62 * setup - Address of the setup function
63 * context - Value passed to the handler on each access
64 *
65 * RETURN: Status
66 *
67 * DESCRIPTION: Install a handler for all op_regions of a given space_id.
68 *
69 * NOTE: This function should only be called after acpi_enable_subsystem has
70 * been called. This is because any _REG methods associated with the Space ID
71 * are executed here, and these methods can only be safely executed after
72 * the default handlers have been installed and the hardware has been
73 * initialized (via acpi_enable_subsystem.)
74 *
75 ******************************************************************************/
76 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)77 acpi_install_address_space_handler(acpi_handle device,
78 acpi_adr_space_type space_id,
79 acpi_adr_space_handler handler,
80 acpi_adr_space_setup setup, void *context)
81 {
82 struct acpi_namespace_node *node;
83 acpi_status status;
84
85 ACPI_FUNCTION_TRACE(acpi_install_address_space_handler);
86
87 /* Parameter validation */
88
89 if (!device) {
90 return_ACPI_STATUS(AE_BAD_PARAMETER);
91 }
92
93 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
94 if (ACPI_FAILURE(status)) {
95 return_ACPI_STATUS(status);
96 }
97
98 /* Convert and validate the device handle */
99
100 node = acpi_ns_validate_handle(device);
101 if (!node) {
102 status = AE_BAD_PARAMETER;
103 goto unlock_and_exit;
104 }
105
106 /* Install the handler for all Regions for this Space ID */
107
108 status =
109 acpi_ev_install_space_handler(node, space_id, handler, setup,
110 context);
111 if (ACPI_FAILURE(status)) {
112 goto unlock_and_exit;
113 }
114
115 /* Run all _REG methods for this address space */
116
117 acpi_ev_execute_reg_methods(node, space_id, ACPI_REG_CONNECT);
118
119 unlock_and_exit:
120 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
121 return_ACPI_STATUS(status);
122 }
123
ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler)124 ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler)
125
126 /*******************************************************************************
127 *
128 * FUNCTION: acpi_remove_address_space_handler
129 *
130 * PARAMETERS: device - Handle for the device
131 * space_id - The address space ID
132 * handler - Address of the handler
133 *
134 * RETURN: Status
135 *
136 * DESCRIPTION: Remove a previously installed handler.
137 *
138 ******************************************************************************/
139 acpi_status
140 acpi_remove_address_space_handler(acpi_handle device,
141 acpi_adr_space_type space_id,
142 acpi_adr_space_handler handler)
143 {
144 union acpi_operand_object *obj_desc;
145 union acpi_operand_object *handler_obj;
146 union acpi_operand_object *region_obj;
147 union acpi_operand_object **last_obj_ptr;
148 struct acpi_namespace_node *node;
149 acpi_status status;
150
151 ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler);
152
153 /* Parameter validation */
154
155 if (!device) {
156 return_ACPI_STATUS(AE_BAD_PARAMETER);
157 }
158
159 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
160 if (ACPI_FAILURE(status)) {
161 return_ACPI_STATUS(status);
162 }
163
164 /* Convert and validate the device handle */
165
166 node = acpi_ns_validate_handle(device);
167 if (!node ||
168 ((node->type != ACPI_TYPE_DEVICE) &&
169 (node->type != ACPI_TYPE_PROCESSOR) &&
170 (node->type != ACPI_TYPE_THERMAL) &&
171 (node != acpi_gbl_root_node))) {
172 status = AE_BAD_PARAMETER;
173 goto unlock_and_exit;
174 }
175
176 /* Make sure the internal object exists */
177
178 obj_desc = acpi_ns_get_attached_object(node);
179 if (!obj_desc) {
180 status = AE_NOT_EXIST;
181 goto unlock_and_exit;
182 }
183
184 /* Find the address handler the user requested */
185
186 handler_obj = obj_desc->common_notify.handler;
187 last_obj_ptr = &obj_desc->common_notify.handler;
188 while (handler_obj) {
189
190 /* We have a handler, see if user requested this one */
191
192 if (handler_obj->address_space.space_id == space_id) {
193
194 /* Handler must be the same as the installed handler */
195
196 if (handler_obj->address_space.handler != handler) {
197 status = AE_BAD_PARAMETER;
198 goto unlock_and_exit;
199 }
200
201 /* Matched space_id, first dereference this in the Regions */
202
203 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
204 "Removing address handler %p(%p) for region %s "
205 "on Device %p(%p)\n",
206 handler_obj, handler,
207 acpi_ut_get_region_name(space_id),
208 node, obj_desc));
209
210 region_obj = handler_obj->address_space.region_list;
211
212 /* Walk the handler's region list */
213
214 while (region_obj) {
215 /*
216 * First disassociate the handler from the region.
217 *
218 * NOTE: this doesn't mean that the region goes away
219 * The region is just inaccessible as indicated to
220 * the _REG method
221 */
222 acpi_ev_detach_region(region_obj, TRUE);
223
224 /*
225 * Walk the list: Just grab the head because the
226 * detach_region removed the previous head.
227 */
228 region_obj =
229 handler_obj->address_space.region_list;
230
231 }
232
233 /* Remove this Handler object from the list */
234
235 *last_obj_ptr = handler_obj->address_space.next;
236
237 /* Now we can delete the handler object */
238
239 acpi_ut_remove_reference(handler_obj);
240 goto unlock_and_exit;
241 }
242
243 /* Walk the linked list of handlers */
244
245 last_obj_ptr = &handler_obj->address_space.next;
246 handler_obj = handler_obj->address_space.next;
247 }
248
249 /* The handler does not exist */
250
251 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
252 "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
253 handler, acpi_ut_get_region_name(space_id), space_id,
254 node, obj_desc));
255
256 status = AE_NOT_EXIST;
257
258 unlock_and_exit:
259 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
260 return_ACPI_STATUS(status);
261 }
262
263 ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler)
264