sys/contrib/dev/acpica/exregion.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exregion - ACPI default OpRegion (address space) handlers
   5  *              $Revision: 1.101 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118
 119 #define __EXREGION_C__
 120
 121 #include <contrib/dev/acpica/acpi.h>
 122 #include <contrib/dev/acpica/acinterp.h>
 123
 124
 125 #define _COMPONENT          ACPI_EXECUTER
 126         ACPI_MODULE_NAME    ("exregion")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiExSystemMemorySpaceHandler
 132  *
 133  * PARAMETERS:  Function            - Read or Write operation
 134  *              Address             - Where in the space to read or write
 135  *              BitWidth            - Field width in bits (8, 16, or 32)
 136  *              Value               - Pointer to in or out value
 137  *              HandlerContext      - Pointer to Handler's context
 138  *              RegionContext       - Pointer to context specific to the
 139  *                                    accessed region
 140  *
 141  * RETURN:      Status
 142  *
 143  * DESCRIPTION: Handler for the System Memory address space (Op Region)
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiExSystemMemorySpaceHandler (
 149     UINT32                  Function,
 150     ACPI_PHYSICAL_ADDRESS   Address,
 151     UINT32                  BitWidth,
 152     ACPI_INTEGER            *Value,
 153     void                    *HandlerContext,
 154     void                    *RegionContext)
 155 {
 156     ACPI_STATUS             Status = AE_OK;
 157     void                    *LogicalAddrPtr = NULL;
 158     ACPI_MEM_SPACE_CONTEXT  *MemInfo = RegionContext;
 159     UINT32                  Length;
 160     ACPI_SIZE               WindowSize;
 161 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
 162     UINT32                  Remainder;
 163 #endif
 164
 165
 166     ACPI_FUNCTION_TRACE (ExSystemMemorySpaceHandler);
 167
 168
 169     /* Validate and translate the bit width */
 170
 171     switch (BitWidth)
 172     {
 173     case 8:
 174         Length = 1;
 175         break;
 176
 177     case 16:
 178         Length = 2;
 179         break;
 180
 181     case 32:
 182         Length = 4;
 183         break;
 184
 185     case 64:
 186         Length = 8;
 187         break;
 188
 189     default:
 190         ACPI_ERROR ((AE_INFO, "Invalid SystemMemory width %d",
 191             BitWidth));
 192         return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
 193     }
 194
 195 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
 196     /*
 197      * Hardware does not support non-aligned data transfers, we must verify
 198      * the request.
 199      */
 200     (void) AcpiUtShortDivide ((ACPI_INTEGER) Address, Length, NULL, &Remainder);
 201     if (Remainder != 0)
 202     {
 203         return_ACPI_STATUS (AE_AML_ALIGNMENT);
 204     }
 205 #endif
 206
 207     /*
 208      * Does the request fit into the cached memory mapping?
 209      * Is 1) Address below the current mapping? OR
 210      *    2) Address beyond the current mapping?
 211      */
 212     if ((Address < MemInfo->MappedPhysicalAddress) ||
 213         (((ACPI_INTEGER) Address + Length) >
 214             ((ACPI_INTEGER)
 215             MemInfo->MappedPhysicalAddress + MemInfo->MappedLength)))
 216     {
 217         /*
 218          * The request cannot be resolved by the current memory mapping;
 219          * Delete the existing mapping and create a new one.
 220          */
 221         if (MemInfo->MappedLength)
 222         {
 223             /* Valid mapping, delete it */
 224
 225             AcpiOsUnmapMemory (MemInfo->MappedLogicalAddress,
 226                 MemInfo->MappedLength);
 227         }
 228
 229         /*
 230          * Don't attempt to map memory beyond the end of the region, and
 231          * constrain the maximum mapping size to something reasonable.
 232          */
 233         WindowSize = (ACPI_SIZE)
 234             ((MemInfo->Address + MemInfo->Length) - Address);
 235
 236         if (WindowSize > ACPI_SYSMEM_REGION_WINDOW_SIZE)
 237         {
 238             WindowSize = ACPI_SYSMEM_REGION_WINDOW_SIZE;
 239         }
 240
 241         /* Create a new mapping starting at the address given */
 242
 243         MemInfo->MappedLogicalAddress = AcpiOsMapMemory ((ACPI_NATIVE_UINT) Address, WindowSize);
 244         if (!MemInfo->MappedLogicalAddress)
 245         {
 246             ACPI_ERROR ((AE_INFO,
 247                 "Could not map memory at %8.8X%8.8X, size %X",
 248                 ACPI_FORMAT_UINT64 (Address), (UINT32) WindowSize));
 249             MemInfo->MappedLength = 0;
 250             return_ACPI_STATUS (AE_NO_MEMORY);
 251         }
 252
 253         /* Save the physical address and mapping size */
 254
 255         MemInfo->MappedPhysicalAddress = Address;
 256         MemInfo->MappedLength = WindowSize;
 257     }
 258
 259     /*
 260      * Generate a logical pointer corresponding to the address we want to
 261      * access
 262      */
 263     LogicalAddrPtr = MemInfo->MappedLogicalAddress +
 264         ((ACPI_INTEGER) Address - (ACPI_INTEGER) MemInfo->MappedPhysicalAddress);
 265
 266     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 267         "System-Memory (width %d) R/W %d Address=%8.8X%8.8X\n",
 268         BitWidth, Function, ACPI_FORMAT_UINT64 (Address)));
 269
 270     /*
 271      * Perform the memory read or write
 272      *
 273      * Note: For machines that do not support non-aligned transfers, the target
 274      * address was checked for alignment above.  We do not attempt to break the
 275      * transfer up into smaller (byte-size) chunks because the AML specifically
 276      * asked for a transfer width that the hardware may require.
 277      */
 278     switch (Function)
 279     {
 280     case ACPI_READ:
 281
 282         *Value = 0;
 283         switch (BitWidth)
 284         {
 285         case 8:
 286             *Value = (ACPI_INTEGER) ACPI_GET8 (LogicalAddrPtr);
 287             break;
 288
 289         case 16:
 290             *Value = (ACPI_INTEGER) ACPI_GET16 (LogicalAddrPtr);
 291             break;
 292
 293         case 32:
 294             *Value = (ACPI_INTEGER) ACPI_GET32 (LogicalAddrPtr);
 295             break;
 296
 297         case 64:
 298             *Value = (ACPI_INTEGER) ACPI_GET64 (LogicalAddrPtr);
 299             break;
 300
 301         default:
 302             /* BitWidth was already validated */
 303             break;
 304         }
 305         break;
 306
 307     case ACPI_WRITE:
 308
 309         switch (BitWidth)
 310         {
 311         case 8:
 312             ACPI_SET8 (LogicalAddrPtr) = (UINT8) *Value;
 313             break;
 314
 315         case 16:
 316             ACPI_SET16 (LogicalAddrPtr) = (UINT16) *Value;
 317             break;
 318
 319         case 32:
 320             ACPI_SET32 ( LogicalAddrPtr) = (UINT32) *Value;
 321             break;
 322
 323         case 64:
 324             ACPI_SET64 (LogicalAddrPtr) = (UINT64) *Value;
 325             break;
 326
 327         default:
 328             /* BitWidth was already validated */
 329             break;
 330         }
 331         break;
 332
 333     default:
 334         Status = AE_BAD_PARAMETER;
 335         break;
 336     }
 337
 338     return_ACPI_STATUS (Status);
 339 }
 340
 341
 342 /*******************************************************************************
 343  *
 344  * FUNCTION:    AcpiExSystemIoSpaceHandler
 345  *
 346  * PARAMETERS:  Function            - Read or Write operation
 347  *              Address             - Where in the space to read or write
 348  *              BitWidth            - Field width in bits (8, 16, or 32)
 349  *              Value               - Pointer to in or out value
 350  *              HandlerContext      - Pointer to Handler's context
 351  *              RegionContext       - Pointer to context specific to the
 352  *                                    accessed region
 353  *
 354  * RETURN:      Status
 355  *
 356  * DESCRIPTION: Handler for the System IO address space (Op Region)
 357  *
 358  ******************************************************************************/
 359
 360 ACPI_STATUS
 361 AcpiExSystemIoSpaceHandler (
 362     UINT32                  Function,
 363     ACPI_PHYSICAL_ADDRESS   Address,
 364     UINT32                  BitWidth,
 365     ACPI_INTEGER            *Value,
 366     void                    *HandlerContext,
 367     void                    *RegionContext)
 368 {
 369     ACPI_STATUS             Status = AE_OK;
 370     UINT32                  Value32;
 371
 372
 373     ACPI_FUNCTION_TRACE (ExSystemIoSpaceHandler);
 374
 375
 376     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 377         "System-IO (width %d) R/W %d Address=%8.8X%8.8X\n",
 378         BitWidth, Function, ACPI_FORMAT_UINT64 (Address)));
 379
 380     /* Decode the function parameter */
 381
 382     switch (Function)
 383     {
 384     case ACPI_READ:
 385
 386         Status = AcpiOsReadPort ((ACPI_IO_ADDRESS) Address,
 387                     &Value32, BitWidth);
 388         *Value = Value32;
 389         break;
 390
 391     case ACPI_WRITE:
 392
 393         Status = AcpiOsWritePort ((ACPI_IO_ADDRESS) Address,
 394                     (UINT32) *Value, BitWidth);
 395         break;
 396
 397     default:
 398         Status = AE_BAD_PARAMETER;
 399         break;
 400     }
 401
 402     return_ACPI_STATUS (Status);
 403 }
 404
 405
 406 /*******************************************************************************
 407  *
 408  * FUNCTION:    AcpiExPciConfigSpaceHandler
 409  *
 410  * PARAMETERS:  Function            - Read or Write operation
 411  *              Address             - Where in the space to read or write
 412  *              BitWidth            - Field width in bits (8, 16, or 32)
 413  *              Value               - Pointer to in or out value
 414  *              HandlerContext      - Pointer to Handler's context
 415  *              RegionContext       - Pointer to context specific to the
 416  *                                    accessed region
 417  *
 418  * RETURN:      Status
 419  *
 420  * DESCRIPTION: Handler for the PCI Config address space (Op Region)
 421  *
 422  ******************************************************************************/
 423
 424 ACPI_STATUS
 425 AcpiExPciConfigSpaceHandler (
 426     UINT32                  Function,
 427     ACPI_PHYSICAL_ADDRESS   Address,
 428     UINT32                  BitWidth,
 429     ACPI_INTEGER            *Value,
 430     void                    *HandlerContext,
 431     void                    *RegionContext)
 432 {
 433     ACPI_STATUS             Status = AE_OK;
 434     ACPI_PCI_ID             *PciId;
 435     UINT16                  PciRegister;
 436
 437
 438     ACPI_FUNCTION_TRACE (ExPciConfigSpaceHandler);
 439
 440
 441     /*
 442      *  The arguments to AcpiOs(Read|Write)PciConfiguration are:
 443      *
 444      *  PciSegment  is the PCI bus segment range 0-31
 445      *  PciBus      is the PCI bus number range 0-255
 446      *  PciDevice   is the PCI device number range 0-31
 447      *  PciFunction is the PCI device function number
 448      *  PciRegister is the Config space register range 0-255 bytes
 449      *
 450      *  Value - input value for write, output address for read
 451      *
 452      */
 453     PciId       = (ACPI_PCI_ID *) RegionContext;
 454     PciRegister = (UINT16) (UINT32) Address;
 455
 456     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 457         "Pci-Config %d (%d) Seg(%04x) Bus(%04x) Dev(%04x) Func(%04x) Reg(%04x)\n",
 458         Function, BitWidth, PciId->Segment, PciId->Bus, PciId->Device,
 459         PciId->Function, PciRegister));
 460
 461     switch (Function)
 462     {
 463     case ACPI_READ:
 464
 465         *Value = 0;
 466         Status = AcpiOsReadPciConfiguration (PciId, PciRegister,
 467                     Value, BitWidth);
 468         break;
 469
 470     case ACPI_WRITE:
 471
 472         Status = AcpiOsWritePciConfiguration (PciId, PciRegister,
 473                     *Value, BitWidth);
 474         break;
 475
 476     default:
 477
 478         Status = AE_BAD_PARAMETER;
 479         break;
 480     }
 481
 482     return_ACPI_STATUS (Status);
 483 }
 484
 485
 486 /*******************************************************************************
 487  *
 488  * FUNCTION:    AcpiExCmosSpaceHandler
 489  *
 490  * PARAMETERS:  Function            - Read or Write operation
 491  *              Address             - Where in the space to read or write
 492  *              BitWidth            - Field width in bits (8, 16, or 32)
 493  *              Value               - Pointer to in or out value
 494  *              HandlerContext      - Pointer to Handler's context
 495  *              RegionContext       - Pointer to context specific to the
 496  *                                    accessed region
 497  *
 498  * RETURN:      Status
 499  *
 500  * DESCRIPTION: Handler for the CMOS address space (Op Region)
 501  *
 502  ******************************************************************************/
 503
 504 ACPI_STATUS
 505 AcpiExCmosSpaceHandler (
 506     UINT32                  Function,
 507     ACPI_PHYSICAL_ADDRESS   Address,
 508     UINT32                  BitWidth,
 509     ACPI_INTEGER            *Value,
 510     void                    *HandlerContext,
 511     void                    *RegionContext)
 512 {
 513     ACPI_STATUS             Status = AE_OK;
 514
 515
 516     ACPI_FUNCTION_TRACE (ExCmosSpaceHandler);
 517
 518
 519     return_ACPI_STATUS (Status);
 520 }
 521
 522
 523 /*******************************************************************************
 524  *
 525  * FUNCTION:    AcpiExPciBarSpaceHandler
 526  *
 527  * PARAMETERS:  Function            - Read or Write operation
 528  *              Address             - Where in the space to read or write
 529  *              BitWidth            - Field width in bits (8, 16, or 32)
 530  *              Value               - Pointer to in or out value
 531  *              HandlerContext      - Pointer to Handler's context
 532  *              RegionContext       - Pointer to context specific to the
 533  *                                    accessed region
 534  *
 535  * RETURN:      Status
 536  *
 537  * DESCRIPTION: Handler for the PCI BarTarget address space (Op Region)
 538  *
 539  ******************************************************************************/
 540
 541 ACPI_STATUS
 542 AcpiExPciBarSpaceHandler (
 543     UINT32                  Function,
 544     ACPI_PHYSICAL_ADDRESS   Address,
 545     UINT32                  BitWidth,
 546     ACPI_INTEGER            *Value,
 547     void                    *HandlerContext,
 548     void                    *RegionContext)
 549 {
 550     ACPI_STATUS             Status = AE_OK;
 551
 552
 553     ACPI_FUNCTION_TRACE (ExPciBarSpaceHandler);
 554
 555
 556     return_ACPI_STATUS (Status);
 557 }
 558
 559
 560 /*******************************************************************************
 561  *
 562  * FUNCTION:    AcpiExDataTableSpaceHandler
 563  *
 564  * PARAMETERS:  Function            - Read or Write operation
 565  *              Address             - Where in the space to read or write
 566  *              BitWidth            - Field width in bits (8, 16, or 32)
 567  *              Value               - Pointer to in or out value
 568  *              HandlerContext      - Pointer to Handler's context
 569  *              RegionContext       - Pointer to context specific to the
 570  *                                    accessed region
 571  *
 572  * RETURN:      Status
 573  *
 574  * DESCRIPTION: Handler for the Data Table address space (Op Region)
 575  *
 576  ******************************************************************************/
 577
 578 ACPI_STATUS
 579 AcpiExDataTableSpaceHandler (
 580     UINT32                  Function,
 581     ACPI_PHYSICAL_ADDRESS   Address,
 582     UINT32                  BitWidth,
 583     ACPI_INTEGER            *Value,
 584     void                    *HandlerContext,
 585     void                    *RegionContext)
 586 {
 587     ACPI_FUNCTION_TRACE (ExDataTableSpaceHandler);
 588
 589
 590     /* Perform the memory read or write */
 591
 592     switch (Function)
 593     {
 594     case ACPI_READ:
 595
 596         ACPI_MEMCPY (ACPI_CAST_PTR (char, Value), ACPI_PHYSADDR_TO_PTR (Address),
 597             ACPI_DIV_8 (BitWidth));
 598         break;
 599
 600     case ACPI_WRITE:
 601     default:
 602
 603         return_ACPI_STATUS (AE_SUPPORT);
 604     }
 605
 606     return_ACPI_STATUS (AE_OK);
 607 }
 608
 609