1/****************************************************************************** 2 * 3 * Module Name: exregion - ACPI default OpRegion (address space) handlers 4 * 5 *****************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 <contrib/dev/acpica/include/acpi.h> 153#include <contrib/dev/acpica/include/accommon.h> 154#include <contrib/dev/acpica/include/acinterp.h> 155 156 157#define _COMPONENT ACPI_EXECUTER 158 ACPI_MODULE_NAME ("exregion") 159 160 161/******************************************************************************* 162 * 163 * FUNCTION: AcpiExSystemMemorySpaceHandler 164 * 165 * PARAMETERS: Function - Read or Write operation 166 * Address - Where in the space to read or write 167 * BitWidth - Field width in bits (8, 16, or 32) 168 * Value - Pointer to in or out value 169 * HandlerContext - Pointer to Handler's context 170 * RegionContext - Pointer to context specific to the 171 * accessed region 172 * 173 * RETURN: Status 174 * 175 * DESCRIPTION: Handler for the System Memory address space (Op Region) 176 * 177 ******************************************************************************/ 178 179ACPI_STATUS 180AcpiExSystemMemorySpaceHandler ( 181 UINT32 Function, 182 ACPI_PHYSICAL_ADDRESS Address, 183 UINT32 BitWidth, 184 UINT64 *Value, 185 void *HandlerContext, 186 void *RegionContext) 187{ 188 ACPI_STATUS Status = AE_OK; 189 void *LogicalAddrPtr = NULL; 190 ACPI_MEM_SPACE_CONTEXT *MemInfo = RegionContext; 191 UINT32 Length; 192 ACPI_SIZE MapLength; 193 ACPI_SIZE PageBoundaryMapLength; 194#ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED 195 UINT32 Remainder; 196#endif 197 198 199 ACPI_FUNCTION_TRACE (ExSystemMemorySpaceHandler); 200 201 202 /* Validate and translate the bit width */ 203 204 switch (BitWidth) 205 { 206 case 8: 207 208 Length = 1; 209 break; 210 211 case 16: 212 213 Length = 2; 214 break; 215 216 case 32: 217 218 Length = 4; 219 break; 220 221 case 64: 222 223 Length = 8; 224 break; 225 226 default: 227 228 ACPI_ERROR ((AE_INFO, "Invalid SystemMemory width %u", 229 BitWidth)); 230 return_ACPI_STATUS (AE_AML_OPERAND_VALUE); 231 } 232 233#ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED 234 /* 235 * Hardware does not support non-aligned data transfers, we must verify 236 * the request. 237 */ 238 (void) AcpiUtShortDivide ((UINT64) Address, Length, NULL, &Remainder); 239 if (Remainder != 0) 240 { 241 return_ACPI_STATUS (AE_AML_ALIGNMENT); 242 } 243#endif 244 245 /* 246 * Does the request fit into the cached memory mapping? 247 * Is 1) Address below the current mapping? OR 248 * 2) Address beyond the current mapping? 249 */ 250 if ((Address < MemInfo->MappedPhysicalAddress) || 251 (((UINT64) Address + Length) > 252 ((UINT64) 253 MemInfo->MappedPhysicalAddress + MemInfo->MappedLength))) 254 { 255 /* 256 * The request cannot be resolved by the current memory mapping; 257 * Delete the existing mapping and create a new one. 258 */ 259 if (MemInfo->MappedLength) 260 { 261 /* Valid mapping, delete it */ 262 263 AcpiOsUnmapMemory (MemInfo->MappedLogicalAddress, 264 MemInfo->MappedLength); 265 } 266 267 /* 268 * October 2009: Attempt to map from the requested address to the 269 * end of the region. However, we will never map more than one 270 * page, nor will we cross a page boundary. 271 */ 272 MapLength = (ACPI_SIZE) 273 ((MemInfo->Address + MemInfo->Length) - Address); 274 275 /* 276 * If mapping the entire remaining portion of the region will cross 277 * a page boundary, just map up to the page boundary, do not cross. 278 * On some systems, crossing a page boundary while mapping regions 279 * can cause warnings if the pages have different attributes 280 * due to resource management. 281 * 282 * This has the added benefit of constraining a single mapping to 283 * one page, which is similar to the original code that used a 4k 284 * maximum window. 285 */ 286 PageBoundaryMapLength = (ACPI_SIZE) 287 (ACPI_ROUND_UP (Address, ACPI_DEFAULT_PAGE_SIZE) - Address); 288 if (PageBoundaryMapLength == 0) 289 { 290 PageBoundaryMapLength = ACPI_DEFAULT_PAGE_SIZE; 291 } 292 293 if (MapLength > PageBoundaryMapLength) 294 { 295 MapLength = PageBoundaryMapLength; 296 } 297 298 /* Create a new mapping starting at the address given */ 299 300 MemInfo->MappedLogicalAddress = AcpiOsMapMemory (Address, MapLength); 301 if (!MemInfo->MappedLogicalAddress) 302 { 303 ACPI_ERROR ((AE_INFO, 304 "Could not map memory at 0x%8.8X%8.8X, size %u", 305 ACPI_FORMAT_UINT64 (Address), (UINT32) MapLength)); 306 MemInfo->MappedLength = 0; 307 return_ACPI_STATUS (AE_NO_MEMORY); 308 } 309 310 /* Save the physical address and mapping size */ 311 312 MemInfo->MappedPhysicalAddress = Address; 313 MemInfo->MappedLength = MapLength; 314 } 315 316 /* 317 * Generate a logical pointer corresponding to the address we want to 318 * access 319 */ 320 LogicalAddrPtr = MemInfo->MappedLogicalAddress + 321 ((UINT64) Address - (UINT64) MemInfo->MappedPhysicalAddress); 322 323 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 324 "System-Memory (width %u) R/W %u Address=%8.8X%8.8X\n", 325 BitWidth, Function, ACPI_FORMAT_UINT64 (Address))); 326 327 /* 328 * Perform the memory read or write 329 * 330 * Note: For machines that do not support non-aligned transfers, the target 331 * address was checked for alignment above. We do not attempt to break the 332 * transfer up into smaller (byte-size) chunks because the AML specifically 333 * asked for a transfer width that the hardware may require. 334 */ 335 switch (Function) 336 { 337 case ACPI_READ: 338 339 *Value = 0; 340 switch (BitWidth) 341 { 342 case 8: 343 344 *Value = (UINT64) ACPI_GET8 (LogicalAddrPtr); 345 break; 346 347 case 16: 348 349 *Value = (UINT64) ACPI_GET16 (LogicalAddrPtr); 350 break; 351 352 case 32: 353 354 *Value = (UINT64) ACPI_GET32 (LogicalAddrPtr); 355 break; 356 357 case 64: 358 359 *Value = (UINT64) ACPI_GET64 (LogicalAddrPtr); 360 break; 361 362 default: 363 364 /* BitWidth was already validated */ 365 366 break; 367 } 368 break; 369 370 case ACPI_WRITE: 371 372 switch (BitWidth) 373 { 374 case 8: 375 376 ACPI_SET8 (LogicalAddrPtr, *Value); 377 break; 378 379 case 16: 380 381 ACPI_SET16 (LogicalAddrPtr, *Value); 382 break; 383 384 case 32: 385 386 ACPI_SET32 (LogicalAddrPtr, *Value); 387 break; 388 389 case 64: 390 391 ACPI_SET64 (LogicalAddrPtr, *Value); 392 break; 393 394 default: 395 396 /* BitWidth was already validated */ 397 398 break; 399 } 400 break; 401 402 default: 403 404 Status = AE_BAD_PARAMETER; 405 break; 406 } 407 408 return_ACPI_STATUS (Status); 409} 410 411 412/******************************************************************************* 413 * 414 * FUNCTION: AcpiExSystemIoSpaceHandler 415 * 416 * PARAMETERS: Function - Read or Write operation 417 * Address - Where in the space to read or write 418 * BitWidth - Field width in bits (8, 16, or 32) 419 * Value - Pointer to in or out value 420 * HandlerContext - Pointer to Handler's context 421 * RegionContext - Pointer to context specific to the 422 * accessed region 423 * 424 * RETURN: Status 425 * 426 * DESCRIPTION: Handler for the System IO address space (Op Region) 427 * 428 ******************************************************************************/ 429 430ACPI_STATUS 431AcpiExSystemIoSpaceHandler ( 432 UINT32 Function, 433 ACPI_PHYSICAL_ADDRESS Address, 434 UINT32 BitWidth, 435 UINT64 *Value, 436 void *HandlerContext, 437 void *RegionContext) 438{ 439 ACPI_STATUS Status = AE_OK; 440 UINT32 Value32; 441 442 443 ACPI_FUNCTION_TRACE (ExSystemIoSpaceHandler); 444 445 446 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 447 "System-IO (width %u) R/W %u Address=%8.8X%8.8X\n", 448 BitWidth, Function, ACPI_FORMAT_UINT64 (Address))); 449 450 /* Decode the function parameter */ 451 452 switch (Function) 453 { 454 case ACPI_READ: 455 456 Status = AcpiHwReadPort ((ACPI_IO_ADDRESS) Address, 457 &Value32, BitWidth); 458 *Value = Value32; 459 break; 460 461 case ACPI_WRITE: 462 463 Status = AcpiHwWritePort ((ACPI_IO_ADDRESS) Address, 464 (UINT32) *Value, BitWidth); 465 break; 466 467 default: 468 469 Status = AE_BAD_PARAMETER; 470 break; 471 } 472 473 return_ACPI_STATUS (Status); 474} 475 476 477/******************************************************************************* 478 * 479 * FUNCTION: AcpiExPciConfigSpaceHandler 480 * 481 * PARAMETERS: Function - Read or Write operation 482 * Address - Where in the space to read or write 483 * BitWidth - Field width in bits (8, 16, or 32) 484 * Value - Pointer to in or out value 485 * HandlerContext - Pointer to Handler's context 486 * RegionContext - Pointer to context specific to the 487 * accessed region 488 * 489 * RETURN: Status 490 * 491 * DESCRIPTION: Handler for the PCI Config address space (Op Region) 492 * 493 ******************************************************************************/ 494 495ACPI_STATUS 496AcpiExPciConfigSpaceHandler ( 497 UINT32 Function, 498 ACPI_PHYSICAL_ADDRESS Address, 499 UINT32 BitWidth, 500 UINT64 *Value, 501 void *HandlerContext, 502 void *RegionContext) 503{ 504 ACPI_STATUS Status = AE_OK; 505 ACPI_PCI_ID *PciId; 506 UINT16 PciRegister; 507 508 509 ACPI_FUNCTION_TRACE (ExPciConfigSpaceHandler); 510 511 512 /* 513 * The arguments to AcpiOs(Read|Write)PciConfiguration are: 514 * 515 * PciSegment is the PCI bus segment range 0-31 516 * PciBus is the PCI bus number range 0-255 517 * PciDevice is the PCI device number range 0-31 518 * PciFunction is the PCI device function number 519 * PciRegister is the Config space register range 0-255 bytes 520 * 521 * Value - input value for write, output address for read 522 * 523 */ 524 PciId = (ACPI_PCI_ID *) RegionContext; 525 PciRegister = (UINT16) (UINT32) Address; 526 527 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 528 "Pci-Config %u (%u) Seg(%04x) Bus(%04x) " 529 "Dev(%04x) Func(%04x) Reg(%04x)\n", 530 Function, BitWidth, PciId->Segment, PciId->Bus, PciId->Device, 531 PciId->Function, PciRegister)); 532 533 switch (Function) 534 { 535 case ACPI_READ: 536 537 *Value = 0; 538 Status = AcpiOsReadPciConfiguration ( 539 PciId, PciRegister, Value, BitWidth); 540 break; 541 542 case ACPI_WRITE: 543 544 Status = AcpiOsWritePciConfiguration ( 545 PciId, PciRegister, *Value, BitWidth); 546 break; 547 548 default: 549 550 Status = AE_BAD_PARAMETER; 551 break; 552 } 553 554 return_ACPI_STATUS (Status); 555} 556 557 558/******************************************************************************* 559 * 560 * FUNCTION: AcpiExCmosSpaceHandler 561 * 562 * PARAMETERS: Function - Read or Write operation 563 * Address - Where in the space to read or write 564 * BitWidth - Field width in bits (8, 16, or 32) 565 * Value - Pointer to in or out value 566 * HandlerContext - Pointer to Handler's context 567 * RegionContext - Pointer to context specific to the 568 * accessed region 569 * 570 * RETURN: Status 571 * 572 * DESCRIPTION: Handler for the CMOS address space (Op Region) 573 * 574 ******************************************************************************/ 575 576ACPI_STATUS 577AcpiExCmosSpaceHandler ( 578 UINT32 Function, 579 ACPI_PHYSICAL_ADDRESS Address, 580 UINT32 BitWidth, 581 UINT64 *Value, 582 void *HandlerContext, 583 void *RegionContext) 584{ 585 ACPI_STATUS Status = AE_OK; 586 587 588 ACPI_FUNCTION_TRACE (ExCmosSpaceHandler); 589 590 591 return_ACPI_STATUS (Status); 592} 593 594 595/******************************************************************************* 596 * 597 * FUNCTION: AcpiExPciBarSpaceHandler 598 * 599 * PARAMETERS: Function - Read or Write operation 600 * Address - Where in the space to read or write 601 * BitWidth - Field width in bits (8, 16, or 32) 602 * Value - Pointer to in or out value 603 * HandlerContext - Pointer to Handler's context 604 * RegionContext - Pointer to context specific to the 605 * accessed region 606 * 607 * RETURN: Status 608 * 609 * DESCRIPTION: Handler for the PCI BarTarget address space (Op Region) 610 * 611 ******************************************************************************/ 612 613ACPI_STATUS 614AcpiExPciBarSpaceHandler ( 615 UINT32 Function, 616 ACPI_PHYSICAL_ADDRESS Address, 617 UINT32 BitWidth, 618 UINT64 *Value, 619 void *HandlerContext, 620 void *RegionContext) 621{ 622 ACPI_STATUS Status = AE_OK; 623 624 625 ACPI_FUNCTION_TRACE (ExPciBarSpaceHandler); 626 627 628 return_ACPI_STATUS (Status); 629} 630 631 632/******************************************************************************* 633 * 634 * FUNCTION: AcpiExDataTableSpaceHandler 635 * 636 * PARAMETERS: Function - Read or Write operation 637 * Address - Where in the space to read or write 638 * BitWidth - Field width in bits (8, 16, or 32) 639 * Value - Pointer to in or out value 640 * HandlerContext - Pointer to Handler's context 641 * RegionContext - Pointer to context specific to the 642 * accessed region 643 * 644 * RETURN: Status 645 * 646 * DESCRIPTION: Handler for the Data Table address space (Op Region) 647 * 648 ******************************************************************************/ 649 650ACPI_STATUS 651AcpiExDataTableSpaceHandler ( 652 UINT32 Function, 653 ACPI_PHYSICAL_ADDRESS Address, 654 UINT32 BitWidth, 655 UINT64 *Value, 656 void *HandlerContext, 657 void *RegionContext) 658{ 659 ACPI_FUNCTION_TRACE (ExDataTableSpaceHandler); 660 661 662 /* 663 * Perform the memory read or write. The BitWidth was already 664 * validated. 665 */ 666 switch (Function) 667 { 668 case ACPI_READ: 669 670 memcpy (ACPI_CAST_PTR (char, Value), ACPI_PHYSADDR_TO_PTR (Address), 671 ACPI_DIV_8 (BitWidth)); 672 break; 673 674 case ACPI_WRITE: 675 676 memcpy (ACPI_PHYSADDR_TO_PTR (Address), ACPI_CAST_PTR (char, Value), 677 ACPI_DIV_8 (BitWidth)); 678 break; 679 680 default: 681 682 return_ACPI_STATUS (AE_BAD_PARAMETER); 683 } 684 685 return_ACPI_STATUS (AE_OK); 686} 687