Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and | |
4 | * Address Spaces. | |
5 | * | |
6 | *****************************************************************************/ | |
7 | ||
8 | /* | |
25f044e6 | 9 | * Copyright (C) 2000 - 2013, 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 | |
51 | #define _COMPONENT ACPI_EVENTS | |
4be44fcd | 52 | ACPI_MODULE_NAME("evxfregn") |
1da177e4 LT |
53 | |
54 | /******************************************************************************* | |
55 | * | |
56 | * FUNCTION: acpi_install_address_space_handler | |
57 | * | |
ba494bee | 58 | * PARAMETERS: device - Handle for the device |
1da177e4 | 59 | * space_id - The address space ID |
ba494bee BM |
60 | * handler - Address of the handler |
61 | * setup - Address of the setup function | |
62 | * context - Value passed to the handler on each access | |
1da177e4 LT |
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; |
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 | } |
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 | 114 | /* |
ba494bee | 115 | * For the default space_IDs, (the IDs for which there are default region handlers |
ef09c4f5 BM |
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, | |
ba494bee | 118 | * we will defer the execution of the _REG methods for these space_IDs until |
ef09c4f5 BM |
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 | * | |
ba494bee | 124 | * For all other space_IDs, we can safely execute the _REG methods immediately. |
ef09c4f5 BM |
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 */ |
137 | goto unlock_and_exit; | |
ef09c4f5 BM |
138 | } |
139 | break; | |
140 | ||
141 | default: | |
1d1ea1b7 | 142 | |
ef09c4f5 BM |
143 | break; |
144 | } | |
1da177e4 | 145 | |
e2066ca1 BM |
146 | /* Run all _REG methods for this address space */ |
147 | ||
148 | status = acpi_ev_execute_reg_methods(node, space_id); | |
149 | ||
4be44fcd LB |
150 | unlock_and_exit: |
151 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
152 | return_ACPI_STATUS(status); | |
1da177e4 | 153 | } |
1da177e4 | 154 | |
8313524a | 155 | ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler) |
1da177e4 LT |
156 | |
157 | /******************************************************************************* | |
158 | * | |
159 | * FUNCTION: acpi_remove_address_space_handler | |
160 | * | |
ba494bee | 161 | * PARAMETERS: device - Handle for the device |
1da177e4 | 162 | * space_id - The address space ID |
ba494bee | 163 | * handler - Address of the handler |
1da177e4 LT |
164 | * |
165 | * RETURN: Status | |
166 | * | |
167 | * DESCRIPTION: Remove a previously installed handler. | |
168 | * | |
169 | ******************************************************************************/ | |
1da177e4 | 170 | acpi_status |
4be44fcd LB |
171 | acpi_remove_address_space_handler(acpi_handle device, |
172 | acpi_adr_space_type space_id, | |
173 | acpi_adr_space_handler handler) | |
1da177e4 | 174 | { |
4be44fcd LB |
175 | union acpi_operand_object *obj_desc; |
176 | union acpi_operand_object *handler_obj; | |
177 | union acpi_operand_object *region_obj; | |
178 | union acpi_operand_object **last_obj_ptr; | |
179 | struct acpi_namespace_node *node; | |
180 | acpi_status status; | |
1da177e4 | 181 | |
b229cf92 | 182 | ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler); |
1da177e4 LT |
183 | |
184 | /* Parameter validation */ | |
185 | ||
186 | if (!device) { | |
4be44fcd | 187 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
188 | } |
189 | ||
4be44fcd LB |
190 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
191 | if (ACPI_FAILURE(status)) { | |
192 | return_ACPI_STATUS(status); | |
1da177e4 LT |
193 | } |
194 | ||
195 | /* Convert and validate the device handle */ | |
196 | ||
f24b664d | 197 | node = acpi_ns_validate_handle(device); |
f6dd9221 BM |
198 | if (!node || |
199 | ((node->type != ACPI_TYPE_DEVICE) && | |
200 | (node->type != ACPI_TYPE_PROCESSOR) && | |
201 | (node->type != ACPI_TYPE_THERMAL) && | |
202 | (node != acpi_gbl_root_node))) { | |
1da177e4 LT |
203 | status = AE_BAD_PARAMETER; |
204 | goto unlock_and_exit; | |
205 | } | |
206 | ||
207 | /* Make sure the internal object exists */ | |
208 | ||
4be44fcd | 209 | obj_desc = acpi_ns_get_attached_object(node); |
1da177e4 LT |
210 | if (!obj_desc) { |
211 | status = AE_NOT_EXIST; | |
212 | goto unlock_and_exit; | |
213 | } | |
214 | ||
215 | /* Find the address handler the user requested */ | |
216 | ||
217 | handler_obj = obj_desc->device.handler; | |
218 | last_obj_ptr = &obj_desc->device.handler; | |
219 | while (handler_obj) { | |
52fc0b02 | 220 | |
1da177e4 LT |
221 | /* We have a handler, see if user requested this one */ |
222 | ||
223 | if (handler_obj->address_space.space_id == space_id) { | |
52fc0b02 | 224 | |
f6dd9221 BM |
225 | /* Handler must be the same as the installed handler */ |
226 | ||
227 | if (handler_obj->address_space.handler != handler) { | |
228 | status = AE_BAD_PARAMETER; | |
229 | goto unlock_and_exit; | |
230 | } | |
231 | ||
1da177e4 LT |
232 | /* Matched space_id, first dereference this in the Regions */ |
233 | ||
4be44fcd | 234 | ACPI_DEBUG_PRINT((ACPI_DB_OPREGION, |
d4913dc6 BM |
235 | "Removing address handler %p(%p) for region %s " |
236 | "on Device %p(%p)\n", | |
4be44fcd LB |
237 | handler_obj, handler, |
238 | acpi_ut_get_region_name(space_id), | |
239 | node, obj_desc)); | |
1da177e4 LT |
240 | |
241 | region_obj = handler_obj->address_space.region_list; | |
242 | ||
243 | /* Walk the handler's region list */ | |
244 | ||
245 | while (region_obj) { | |
246 | /* | |
247 | * First disassociate the handler from the region. | |
248 | * | |
249 | * NOTE: this doesn't mean that the region goes away | |
250 | * The region is just inaccessible as indicated to | |
251 | * the _REG method | |
252 | */ | |
4be44fcd | 253 | acpi_ev_detach_region(region_obj, TRUE); |
1da177e4 LT |
254 | |
255 | /* | |
256 | * Walk the list: Just grab the head because the | |
257 | * detach_region removed the previous head. | |
258 | */ | |
4be44fcd LB |
259 | region_obj = |
260 | handler_obj->address_space.region_list; | |
1da177e4 LT |
261 | |
262 | } | |
263 | ||
264 | /* Remove this Handler object from the list */ | |
265 | ||
266 | *last_obj_ptr = handler_obj->address_space.next; | |
267 | ||
268 | /* Now we can delete the handler object */ | |
269 | ||
4be44fcd | 270 | acpi_ut_remove_reference(handler_obj); |
1da177e4 LT |
271 | goto unlock_and_exit; |
272 | } | |
273 | ||
274 | /* Walk the linked list of handlers */ | |
275 | ||
276 | last_obj_ptr = &handler_obj->address_space.next; | |
277 | handler_obj = handler_obj->address_space.next; | |
278 | } | |
279 | ||
280 | /* The handler does not exist */ | |
281 | ||
4be44fcd | 282 | ACPI_DEBUG_PRINT((ACPI_DB_OPREGION, |
b229cf92 | 283 | "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n", |
4be44fcd LB |
284 | handler, acpi_ut_get_region_name(space_id), space_id, |
285 | node, obj_desc)); | |
1da177e4 LT |
286 | |
287 | status = AE_NOT_EXIST; | |
288 | ||
4be44fcd LB |
289 | unlock_and_exit: |
290 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
291 | return_ACPI_STATUS(status); | |
1da177e4 | 292 | } |
1da177e4 | 293 | |
8313524a | 294 | ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler) |