1 /****************************************************************************** 2 * 3 * Module Name: aeinstall - Installation of operation region handlers 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "aecommon.h" 153 154 #define _COMPONENT ACPI_TOOLS 155 ACPI_MODULE_NAME ("aeinstall") 156 157 158 static ACPI_STATUS 159 AeRegionInit ( 160 ACPI_HANDLE RegionHandle, 161 UINT32 Function, 162 void *HandlerContext, 163 void **RegionContext); 164 165 static ACPI_STATUS 166 AeInstallEcHandler ( 167 ACPI_HANDLE ObjHandle, 168 UINT32 Level, 169 void *Context, 170 void **ReturnValue); 171 172 static ACPI_STATUS 173 AeInstallPciHandler ( 174 ACPI_HANDLE ObjHandle, 175 UINT32 Level, 176 void *Context, 177 void **ReturnValue); 178 179 180 BOOLEAN AcpiGbl_DisplayRegionAccess = FALSE; 181 ACPI_CONNECTION_INFO AeMyContext; 182 183 184 /* 185 * We will override some of the default region handlers, especially 186 * the SystemMemory handler, which must be implemented locally. 187 * These handlers are installed "early" - before any _REG methods 188 * are executed - since they are special in the sense that the ACPI spec 189 * declares that they must "always be available". Cannot override the 190 * DataTable region handler either -- needed for test execution. 191 * 192 * NOTE: The local region handler will simulate access to these address 193 * spaces by creating a memory buffer behind each operation region. 194 */ 195 static ACPI_ADR_SPACE_TYPE DefaultSpaceIdList[] = 196 { 197 ACPI_ADR_SPACE_SYSTEM_MEMORY, 198 ACPI_ADR_SPACE_SYSTEM_IO, 199 ACPI_ADR_SPACE_PCI_CONFIG, 200 ACPI_ADR_SPACE_EC 201 }; 202 203 /* 204 * We will install handlers for some of the various address space IDs. 205 * Test one user-defined address space (used by aslts). 206 */ 207 #define ACPI_ADR_SPACE_USER_DEFINED1 0x80 208 #define ACPI_ADR_SPACE_USER_DEFINED2 0xE4 209 210 static ACPI_ADR_SPACE_TYPE SpaceIdList[] = 211 { 212 ACPI_ADR_SPACE_SMBUS, 213 ACPI_ADR_SPACE_CMOS, 214 ACPI_ADR_SPACE_PCI_BAR_TARGET, 215 ACPI_ADR_SPACE_IPMI, 216 ACPI_ADR_SPACE_GPIO, 217 ACPI_ADR_SPACE_GSBUS, 218 ACPI_ADR_SPACE_PLATFORM_COMM, 219 ACPI_ADR_SPACE_PLATFORM_RT, 220 ACPI_ADR_SPACE_FIXED_HARDWARE, 221 ACPI_ADR_SPACE_USER_DEFINED1, 222 ACPI_ADR_SPACE_USER_DEFINED2 223 }; 224 225 226 /****************************************************************************** 227 * 228 * FUNCTION: AeRegionInit 229 * 230 * PARAMETERS: Region init handler 231 * 232 * RETURN: Status 233 * 234 * DESCRIPTION: Opregion init function. 235 * 236 *****************************************************************************/ 237 238 static ACPI_STATUS 239 AeRegionInit ( 240 ACPI_HANDLE RegionHandle, 241 UINT32 Function, 242 void *HandlerContext, 243 void **RegionContext) 244 { 245 246 if (Function == ACPI_REGION_DEACTIVATE) 247 { 248 *RegionContext = NULL; 249 } 250 else 251 { 252 *RegionContext = RegionHandle; 253 } 254 255 return (AE_OK); 256 } 257 258 259 /****************************************************************************** 260 * 261 * FUNCTION: AeOverrideRegionHandlers 262 * 263 * PARAMETERS: None 264 * 265 * RETURN: None 266 * 267 * DESCRIPTION: Override the default region handlers for memory, i/o, and 268 * pci_config. Also install a handler for EC. This is part of 269 * the "install early handlers" functionality. 270 * 271 *****************************************************************************/ 272 273 void 274 AeOverrideRegionHandlers ( 275 void) 276 { 277 UINT32 i; 278 ACPI_STATUS Status; 279 280 /* 281 * Install handlers that will override the default handlers for some of 282 * the space IDs. 283 */ 284 for (i = 0; i < ACPI_ARRAY_LENGTH (DefaultSpaceIdList); i++) 285 { 286 /* Install handler at the root object */ 287 288 Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT, 289 DefaultSpaceIdList[i], AeRegionHandler, AeRegionInit, 290 &AeMyContext); 291 292 if (ACPI_FAILURE (Status)) 293 { 294 ACPI_EXCEPTION ((AE_INFO, Status, 295 "Could not install an OpRegion handler for %s space(%u)", 296 AcpiUtGetRegionName ((UINT8) DefaultSpaceIdList[i]), 297 DefaultSpaceIdList[i])); 298 } 299 } 300 } 301 302 303 /****************************************************************************** 304 * 305 * FUNCTION: AeInstallRegionHandlers 306 * 307 * PARAMETERS: None 308 * 309 * RETURN: None 310 * 311 * DESCRIPTION: Install handlers for the address spaces other than 312 * SystemMemory, SystemIO, and PCI_CONFIG. 313 * 314 *****************************************************************************/ 315 316 void 317 AeInstallRegionHandlers ( 318 void) 319 { 320 UINT32 i; 321 ACPI_STATUS Status; 322 323 324 /* 325 * Install handlers for some of the "device driver" address spaces 326 * such as SMBus, etc. 327 */ 328 for (i = 0; i < ACPI_ARRAY_LENGTH (SpaceIdList); i++) 329 { 330 /* Install handler at the root object */ 331 332 Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT, 333 SpaceIdList[i], AeRegionHandler, AeRegionInit, 334 &AeMyContext); 335 336 if (ACPI_FAILURE (Status)) 337 { 338 ACPI_EXCEPTION ((AE_INFO, Status, 339 "Could not install an OpRegion handler for %s space(%u)", 340 AcpiUtGetRegionName((UINT8) SpaceIdList[i]), SpaceIdList[i])); 341 return; 342 } 343 } 344 } 345 346 347 /******************************************************************************* 348 * 349 * FUNCTION: AeInstallDeviceHandlers 350 * 351 * PARAMETERS: None 352 * 353 * RETURN: Status 354 * 355 * DESCRIPTION: Install handlers for all EC and PCI devices in the namespace 356 * 357 ******************************************************************************/ 358 359 ACPI_STATUS 360 AeInstallDeviceHandlers ( 361 void) 362 { 363 364 /* Find all Embedded Controller devices */ 365 366 AcpiGetDevices ("PNP0C09", AeInstallEcHandler, NULL, NULL); 367 368 /* Install a PCI handler */ 369 370 AcpiGetDevices ("PNP0A08", AeInstallPciHandler, NULL, NULL); 371 return (AE_OK); 372 } 373 374 375 /******************************************************************************* 376 * 377 * FUNCTION: AeInstallEcHandler 378 * 379 * PARAMETERS: ACPI_WALK_NAMESPACE callback 380 * 381 * RETURN: Status 382 * 383 * DESCRIPTION: Walk entire namespace, install a handler for every EC 384 * device found. 385 * 386 ******************************************************************************/ 387 388 static ACPI_STATUS 389 AeInstallEcHandler ( 390 ACPI_HANDLE ObjHandle, 391 UINT32 Level, 392 void *Context, 393 void **ReturnValue) 394 { 395 ACPI_STATUS Status; 396 397 398 /* Install the handler for this EC device */ 399 400 Status = AcpiInstallAddressSpaceHandler (ObjHandle, 401 ACPI_ADR_SPACE_EC, AeRegionHandler, AeRegionInit, &AeMyContext); 402 if (ACPI_FAILURE (Status)) 403 { 404 ACPI_EXCEPTION ((AE_INFO, Status, 405 "Could not install an OpRegion handler for EC device (%p)", 406 ObjHandle)); 407 } 408 409 return (Status); 410 } 411 412 413 /******************************************************************************* 414 * 415 * FUNCTION: AeInstallPciHandler 416 * 417 * PARAMETERS: ACPI_WALK_NAMESPACE callback 418 * 419 * RETURN: Status 420 * 421 * DESCRIPTION: Walk entire namespace, install a handler for every PCI 422 * device found. 423 * 424 ******************************************************************************/ 425 426 static ACPI_STATUS 427 AeInstallPciHandler ( 428 ACPI_HANDLE ObjHandle, 429 UINT32 Level, 430 void *Context, 431 void **ReturnValue) 432 { 433 ACPI_STATUS Status; 434 435 436 /* Install memory and I/O handlers for the PCI device */ 437 438 Status = AcpiInstallAddressSpaceHandler (ObjHandle, 439 ACPI_ADR_SPACE_SYSTEM_IO, AeRegionHandler, AeRegionInit, 440 &AeMyContext); 441 if (ACPI_FAILURE (Status)) 442 { 443 ACPI_EXCEPTION ((AE_INFO, Status, 444 "Could not install an OpRegion handler for PCI device (%p)", 445 ObjHandle)); 446 } 447 448 Status = AcpiInstallAddressSpaceHandler (ObjHandle, 449 ACPI_ADR_SPACE_SYSTEM_MEMORY, AeRegionHandler, AeRegionInit, 450 &AeMyContext); 451 if (ACPI_FAILURE (Status)) 452 { 453 ACPI_EXCEPTION ((AE_INFO, Status, 454 "Could not install an OpRegion handler for PCI device (%p)", 455 ObjHandle)); 456 } 457 458 return (AE_CTRL_TERMINATE); 459 } 460