1 /****************************************************************************** 2 * 3 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and 4 * Address Spaces. 5 * 6 *****************************************************************************/ 7 8 /* 9 * Copyright (C) 2000 - 2015, 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.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 * 58 * FUNCTION: AcpiInstallAddressSpaceHandler 59 * 60 * PARAMETERS: Device - Handle for the device 61 * SpaceId - The address space ID 62 * Handler - Address of the handler 63 * Setup - Address of the setup function 64 * Context - Value passed to the handler on each access 65 * 66 * RETURN: Status 67 * 68 * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId. 69 * 70 * NOTE: This function should only be called after AcpiEnableSubsystem has 71 * been called. This is because any _REG methods associated with the Space ID 72 * are executed here, and these methods can only be safely executed after 73 * the default handlers have been installed and the hardware has been 74 * initialized (via AcpiEnableSubsystem.) 75 * 76 ******************************************************************************/ 77 78 ACPI_STATUS 79 AcpiInstallAddressSpaceHandler ( 80 ACPI_HANDLE Device, 81 ACPI_ADR_SPACE_TYPE SpaceId, 82 ACPI_ADR_SPACE_HANDLER Handler, 83 ACPI_ADR_SPACE_SETUP Setup, 84 void *Context) 85 { 86 ACPI_NAMESPACE_NODE *Node; 87 ACPI_STATUS Status; 88 89 90 ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler); 91 92 93 /* Parameter validation */ 94 95 if (!Device) 96 { 97 return_ACPI_STATUS (AE_BAD_PARAMETER); 98 } 99 100 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 101 if (ACPI_FAILURE (Status)) 102 { 103 return_ACPI_STATUS (Status); 104 } 105 106 /* Convert and validate the device handle */ 107 108 Node = AcpiNsValidateHandle (Device); 109 if (!Node) 110 { 111 Status = AE_BAD_PARAMETER; 112 goto UnlockAndExit; 113 } 114 115 /* Install the handler for all Regions for this Space ID */ 116 117 Status = AcpiEvInstallSpaceHandler ( 118 Node, SpaceId, Handler, Setup, Context); 119 if (ACPI_FAILURE (Status)) 120 { 121 goto UnlockAndExit; 122 } 123 124 /* 125 * For the default SpaceIDs, (the IDs for which there are default region handlers 126 * installed) Only execute the _REG methods if the global initialization _REG 127 * methods have already been run (via AcpiInitializeObjects). In other words, 128 * we will defer the execution of the _REG methods for these SpaceIDs until 129 * execution of AcpiInitializeObjects. This is done because we need the handlers 130 * for the default spaces (mem/io/pci/table) to be installed before we can run 131 * any control methods (or _REG methods). There is known BIOS code that depends 132 * on this. 133 * 134 * For all other SpaceIDs, we can safely execute the _REG methods immediately. 135 * This means that for IDs like EmbeddedController, this function should be called 136 * only after AcpiEnableSubsystem has been called. 137 */ 138 switch (SpaceId) 139 { 140 case ACPI_ADR_SPACE_SYSTEM_MEMORY: 141 case ACPI_ADR_SPACE_SYSTEM_IO: 142 case ACPI_ADR_SPACE_PCI_CONFIG: 143 case ACPI_ADR_SPACE_DATA_TABLE: 144 145 if (!AcpiGbl_RegMethodsExecuted) 146 { 147 /* We will defer execution of the _REG methods for this space */ 148 149 goto UnlockAndExit; 150 } 151 break; 152 153 default: 154 155 break; 156 } 157 158 /* Run all _REG methods for this address space */ 159 160 Status = AcpiEvExecuteRegMethods (Node, SpaceId); 161 162 163 UnlockAndExit: 164 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 165 return_ACPI_STATUS (Status); 166 } 167 168 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler) 169 170 171 /******************************************************************************* 172 * 173 * FUNCTION: AcpiRemoveAddressSpaceHandler 174 * 175 * PARAMETERS: Device - Handle for the device 176 * SpaceId - The address space ID 177 * Handler - Address of the handler 178 * 179 * RETURN: Status 180 * 181 * DESCRIPTION: Remove a previously installed handler. 182 * 183 ******************************************************************************/ 184 185 ACPI_STATUS 186 AcpiRemoveAddressSpaceHandler ( 187 ACPI_HANDLE Device, 188 ACPI_ADR_SPACE_TYPE SpaceId, 189 ACPI_ADR_SPACE_HANDLER Handler) 190 { 191 ACPI_OPERAND_OBJECT *ObjDesc; 192 ACPI_OPERAND_OBJECT *HandlerObj; 193 ACPI_OPERAND_OBJECT *RegionObj; 194 ACPI_OPERAND_OBJECT **LastObjPtr; 195 ACPI_NAMESPACE_NODE *Node; 196 ACPI_STATUS Status; 197 198 199 ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler); 200 201 202 /* Parameter validation */ 203 204 if (!Device) 205 { 206 return_ACPI_STATUS (AE_BAD_PARAMETER); 207 } 208 209 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 210 if (ACPI_FAILURE (Status)) 211 { 212 return_ACPI_STATUS (Status); 213 } 214 215 /* Convert and validate the device handle */ 216 217 Node = AcpiNsValidateHandle (Device); 218 if (!Node || 219 ((Node->Type != ACPI_TYPE_DEVICE) && 220 (Node->Type != ACPI_TYPE_PROCESSOR) && 221 (Node->Type != ACPI_TYPE_THERMAL) && 222 (Node != AcpiGbl_RootNode))) 223 { 224 Status = AE_BAD_PARAMETER; 225 goto UnlockAndExit; 226 } 227 228 /* Make sure the internal object exists */ 229 230 ObjDesc = AcpiNsGetAttachedObject (Node); 231 if (!ObjDesc) 232 { 233 Status = AE_NOT_EXIST; 234 goto UnlockAndExit; 235 } 236 237 /* Find the address handler the user requested */ 238 239 HandlerObj = ObjDesc->Device.Handler; 240 LastObjPtr = &ObjDesc->Device.Handler; 241 while (HandlerObj) 242 { 243 /* We have a handler, see if user requested this one */ 244 245 if (HandlerObj->AddressSpace.SpaceId == SpaceId) 246 { 247 /* Handler must be the same as the installed handler */ 248 249 if (HandlerObj->AddressSpace.Handler != Handler) 250 { 251 Status = AE_BAD_PARAMETER; 252 goto UnlockAndExit; 253 } 254 255 /* Matched SpaceId, first dereference this in the Regions */ 256 257 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION, 258 "Removing address handler %p(%p) for region %s " 259 "on Device %p(%p)\n", 260 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId), 261 Node, ObjDesc)); 262 263 RegionObj = HandlerObj->AddressSpace.RegionList; 264 265 /* Walk the handler's region list */ 266 267 while (RegionObj) 268 { 269 /* 270 * First disassociate the handler from the region. 271 * 272 * NOTE: this doesn't mean that the region goes away 273 * The region is just inaccessible as indicated to 274 * the _REG method 275 */ 276 AcpiEvDetachRegion (RegionObj, TRUE); 277 278 /* 279 * Walk the list: Just grab the head because the 280 * DetachRegion removed the previous head. 281 */ 282 RegionObj = HandlerObj->AddressSpace.RegionList; 283 284 } 285 286 /* Remove this Handler object from the list */ 287 288 *LastObjPtr = HandlerObj->AddressSpace.Next; 289 290 /* Now we can delete the handler object */ 291 292 AcpiUtRemoveReference (HandlerObj); 293 goto UnlockAndExit; 294 } 295 296 /* Walk the linked list of handlers */ 297 298 LastObjPtr = &HandlerObj->AddressSpace.Next; 299 HandlerObj = HandlerObj->AddressSpace.Next; 300 } 301 302 /* The handler does not exist */ 303 304 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION, 305 "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n", 306 Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc)); 307 308 Status = AE_NOT_EXIST; 309 310 UnlockAndExit: 311 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 312 return_ACPI_STATUS (Status); 313 } 314 315 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler) 316