Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and |
| 4 | * Address Spaces. |
| 5 | * |
| 6 | *****************************************************************************/ |
| 7 | |
| 8 | /* |
Bob Moore | 25f044e | 2013-01-25 05:38:56 +0000 | [diff] [blame] | 9 | * Copyright (C) 2000 - 2013, Intel Corp. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Paul Gortmaker | 214f2c9 | 2011-10-26 16:22:14 -0400 | [diff] [blame] | 45 | #include <linux/export.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | #include <acpi/acpi.h> |
Len Brown | e2f7a77 | 2009-01-09 00:30:03 -0500 | [diff] [blame] | 47 | #include "accommon.h" |
| 48 | #include "acnamesp.h" |
| 49 | #include "acevents.h" |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | |
| 51 | #define _COMPONENT ACPI_EVENTS |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 52 | ACPI_MODULE_NAME("evxfregn") |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | |
| 54 | /******************************************************************************* |
| 55 | * |
| 56 | * FUNCTION: acpi_install_address_space_handler |
| 57 | * |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 58 | * PARAMETERS: device - Handle for the device |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | * space_id - The address space ID |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 60 | * handler - Address of the handler |
| 61 | * setup - Address of the setup function |
| 62 | * context - Value passed to the handler on each access |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | * |
| 64 | * RETURN: Status |
| 65 | * |
| 66 | * DESCRIPTION: Install a handler for all op_regions of a given space_id. |
| 67 | * |
Bob Moore | 3989170 | 2010-10-18 08:43:13 +0800 | [diff] [blame] | 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 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | ******************************************************************************/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 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) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 81 | struct acpi_namespace_node *node; |
| 82 | acpi_status status; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 83 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 84 | ACPI_FUNCTION_TRACE(acpi_install_address_space_handler); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | |
| 86 | /* Parameter validation */ |
| 87 | |
| 88 | if (!device) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 89 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | } |
| 91 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 92 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
| 93 | if (ACPI_FAILURE(status)) { |
| 94 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | /* Convert and validate the device handle */ |
| 98 | |
Bob Moore | f24b664 | 2009-12-11 14:57:00 +0800 | [diff] [blame] | 99 | node = acpi_ns_validate_handle(device); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 107 | status = |
| 108 | acpi_ev_install_space_handler(node, space_id, handler, setup, |
| 109 | context); |
| 110 | if (ACPI_FAILURE(status)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 111 | goto unlock_and_exit; |
| 112 | } |
| 113 | |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 114 | /* |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 115 | * For the default space_IDs, (the IDs for which there are default region handlers |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 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, |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 118 | * we will defer the execution of the _REG methods for these space_IDs until |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 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 | * |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 124 | * For all other space_IDs, we can safely execute the _REG methods immediately. |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 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: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 133 | |
Bob Moore | e2066ca | 2011-04-13 13:22:04 +0800 | [diff] [blame] | 134 | if (!acpi_gbl_reg_methods_executed) { |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 135 | |
Bob Moore | e2066ca | 2011-04-13 13:22:04 +0800 | [diff] [blame] | 136 | /* We will defer execution of the _REG methods for this space */ |
| 137 | goto unlock_and_exit; |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 138 | } |
| 139 | break; |
| 140 | |
| 141 | default: |
Chao Guan | 1d1ea1b | 2013-06-08 00:58:14 +0000 | [diff] [blame] | 142 | |
Bob Moore | ef09c4f | 2011-02-14 16:13:25 +0800 | [diff] [blame] | 143 | break; |
| 144 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | |
Bob Moore | e2066ca | 2011-04-13 13:22:04 +0800 | [diff] [blame] | 146 | /* Run all _REG methods for this address space */ |
| 147 | |
| 148 | status = acpi_ev_execute_reg_methods(node, space_id); |
| 149 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 150 | unlock_and_exit: |
| 151 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
| 152 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 154 | |
Bob Moore | 8313524 | 2006-10-03 00:00:00 -0400 | [diff] [blame] | 155 | ACPI_EXPORT_SYMBOL(acpi_install_address_space_handler) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | |
| 157 | /******************************************************************************* |
| 158 | * |
| 159 | * FUNCTION: acpi_remove_address_space_handler |
| 160 | * |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 161 | * PARAMETERS: device - Handle for the device |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | * space_id - The address space ID |
Bob Moore | ba494be | 2012-07-12 09:40:10 +0800 | [diff] [blame] | 163 | * handler - Address of the handler |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | * |
| 165 | * RETURN: Status |
| 166 | * |
| 167 | * DESCRIPTION: Remove a previously installed handler. |
| 168 | * |
| 169 | ******************************************************************************/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 171 | acpi_remove_address_space_handler(acpi_handle device, |
| 172 | acpi_adr_space_type space_id, |
| 173 | acpi_adr_space_handler handler) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 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; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 181 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 182 | ACPI_FUNCTION_TRACE(acpi_remove_address_space_handler); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 183 | |
| 184 | /* Parameter validation */ |
| 185 | |
| 186 | if (!device) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 187 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | } |
| 189 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 190 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
| 191 | if (ACPI_FAILURE(status)) { |
| 192 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | /* Convert and validate the device handle */ |
| 196 | |
Bob Moore | f24b664 | 2009-12-11 14:57:00 +0800 | [diff] [blame] | 197 | node = acpi_ns_validate_handle(device); |
Bob Moore | f6dd922 | 2006-07-07 20:44:38 -0400 | [diff] [blame] | 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))) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | status = AE_BAD_PARAMETER; |
| 204 | goto unlock_and_exit; |
| 205 | } |
| 206 | |
| 207 | /* Make sure the internal object exists */ |
| 208 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 209 | obj_desc = acpi_ns_get_attached_object(node); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 220 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 221 | /* We have a handler, see if user requested this one */ |
| 222 | |
| 223 | if (handler_obj->address_space.space_id == space_id) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 224 | |
Bob Moore | f6dd922 | 2006-07-07 20:44:38 -0400 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | /* Matched space_id, first dereference this in the Regions */ |
| 233 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 234 | ACPI_DEBUG_PRINT((ACPI_DB_OPREGION, |
Bob Moore | d4913dc | 2009-03-06 10:05:18 +0800 | [diff] [blame] | 235 | "Removing address handler %p(%p) for region %s " |
| 236 | "on Device %p(%p)\n", |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 237 | handler_obj, handler, |
| 238 | acpi_ut_get_region_name(space_id), |
| 239 | node, obj_desc)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 253 | acpi_ev_detach_region(region_obj, TRUE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 254 | |
| 255 | /* |
| 256 | * Walk the list: Just grab the head because the |
| 257 | * detach_region removed the previous head. |
| 258 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 259 | region_obj = |
| 260 | handler_obj->address_space.region_list; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 270 | acpi_ut_remove_reference(handler_obj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 282 | ACPI_DEBUG_PRINT((ACPI_DB_OPREGION, |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 283 | "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n", |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 284 | handler, acpi_ut_get_region_name(space_id), space_id, |
| 285 | node, obj_desc)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 286 | |
| 287 | status = AE_NOT_EXIST; |
| 288 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 289 | unlock_and_exit: |
| 290 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
| 291 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 292 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 293 | |
Bob Moore | 8313524 | 2006-10-03 00:00:00 -0400 | [diff] [blame] | 294 | ACPI_EXPORT_SYMBOL(acpi_remove_address_space_handler) |