sys/contrib/dev/acpica/source/tools/acpiexec/aeinstall.c

   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 - 2018, 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_FIXED_HARDWARE,
 219     ACPI_ADR_SPACE_USER_DEFINED1,
 220     ACPI_ADR_SPACE_USER_DEFINED2
 221 };
 222
 223
 224 /******************************************************************************
 225  *
 226  * FUNCTION:    AeRegionInit
 227  *
 228  * PARAMETERS:  Region init handler
 229  *
 230  * RETURN:      Status
 231  *
 232  * DESCRIPTION: Opregion init function.
 233  *
 234  *****************************************************************************/
 235
 236 static ACPI_STATUS
 237 AeRegionInit (
 238     ACPI_HANDLE                 RegionHandle,
 239     UINT32                      Function,
 240     void                        *HandlerContext,
 241     void                        **RegionContext)
 242 {
 243
 244     if (Function == ACPI_REGION_DEACTIVATE)
 245     {
 246         *RegionContext = NULL;
 247     }
 248     else
 249     {
 250         *RegionContext = RegionHandle;
 251     }
 252
 253     return (AE_OK);
 254 }
 255
 256
 257 /******************************************************************************
 258  *
 259  * FUNCTION:    AeOverrideRegionHandlers
 260  *
 261  * PARAMETERS:  None
 262  *
 263  * RETURN:      None
 264  *
 265  * DESCRIPTION: Override the default region handlers for memory, i/o, and
 266  *              pci_config. Also install a handler for EC. This is part of
 267  *              the "install early handlers" functionality.
 268  *
 269  *****************************************************************************/
 270
 271 void
 272 AeOverrideRegionHandlers (
 273     void)
 274 {
 275     UINT32                  i;
 276     ACPI_STATUS             Status;
 277
 278     /*
 279      * Install handlers that will override the default handlers for some of
 280      * the space IDs.
 281      */
 282     for (i = 0; i < ACPI_ARRAY_LENGTH (DefaultSpaceIdList); i++)
 283     {
 284         /* Install handler at the root object */
 285
 286         Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT,
 287             DefaultSpaceIdList[i], AeRegionHandler, AeRegionInit,
 288             &AeMyContext);
 289
 290         if (ACPI_FAILURE (Status))
 291         {
 292             ACPI_EXCEPTION ((AE_INFO, Status,
 293                 "Could not install an OpRegion handler for %s space(%u)",
 294                 AcpiUtGetRegionName ((UINT8) DefaultSpaceIdList[i]),
 295                 DefaultSpaceIdList[i]));
 296         }
 297     }
 298 }
 299
 300
 301 /******************************************************************************
 302  *
 303  * FUNCTION:    AeInstallRegionHandlers
 304  *
 305  * PARAMETERS:  None
 306  *
 307  * RETURN:      None
 308  *
 309  * DESCRIPTION: Install handlers for the address spaces other than
 310  *              SystemMemory, SystemIO, and PCI_CONFIG.
 311  *
 312  *****************************************************************************/
 313
 314 void
 315 AeInstallRegionHandlers (
 316     void)
 317 {
 318     UINT32                  i;
 319     ACPI_STATUS             Status;
 320
 321
 322     /*
 323      * Install handlers for some of the "device driver" address spaces
 324      * such as SMBus, etc.
 325      */
 326     for (i = 0; i < ACPI_ARRAY_LENGTH (SpaceIdList); i++)
 327     {
 328         /* Install handler at the root object */
 329
 330         Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT,
 331             SpaceIdList[i], AeRegionHandler, AeRegionInit,
 332             &AeMyContext);
 333
 334         if (ACPI_FAILURE (Status))
 335         {
 336             ACPI_EXCEPTION ((AE_INFO, Status,
 337                 "Could not install an OpRegion handler for %s space(%u)",
 338                 AcpiUtGetRegionName((UINT8) SpaceIdList[i]), SpaceIdList[i]));
 339             return;
 340         }
 341     }
 342 }
 343
 344
 345 /*******************************************************************************
 346  *
 347  * FUNCTION:    AeInstallDeviceHandlers
 348  *
 349  * PARAMETERS:  None
 350  *
 351  * RETURN:      Status
 352  *
 353  * DESCRIPTION: Install handlers for all EC and PCI devices in the namespace
 354  *
 355  ******************************************************************************/
 356
 357 ACPI_STATUS
 358 AeInstallDeviceHandlers (
 359     void)
 360 {
 361
 362     /* Find all Embedded Controller devices */
 363
 364     AcpiGetDevices ("PNP0C09", AeInstallEcHandler, NULL, NULL);
 365
 366     /* Install a PCI handler */
 367
 368     AcpiGetDevices ("PNP0A08", AeInstallPciHandler, NULL, NULL);
 369     return (AE_OK);
 370 }
 371
 372
 373 /*******************************************************************************
 374  *
 375  * FUNCTION:    AeInstallEcHandler
 376  *
 377  * PARAMETERS:  ACPI_WALK_NAMESPACE callback
 378  *
 379  * RETURN:      Status
 380  *
 381  * DESCRIPTION: Walk entire namespace, install a handler for every EC
 382  *              device found.
 383  *
 384  ******************************************************************************/
 385
 386 static ACPI_STATUS
 387 AeInstallEcHandler (
 388     ACPI_HANDLE             ObjHandle,
 389     UINT32                  Level,
 390     void                    *Context,
 391     void                    **ReturnValue)
 392 {
 393     ACPI_STATUS             Status;
 394
 395
 396     /* Install the handler for this EC device */
 397
 398     Status = AcpiInstallAddressSpaceHandler (ObjHandle,
 399         ACPI_ADR_SPACE_EC, AeRegionHandler, AeRegionInit, &AeMyContext);
 400     if (ACPI_FAILURE (Status))
 401     {
 402         ACPI_EXCEPTION ((AE_INFO, Status,
 403             "Could not install an OpRegion handler for EC device (%p)",
 404             ObjHandle));
 405     }
 406
 407     return (Status);
 408 }
 409
 410
 411 /*******************************************************************************
 412  *
 413  * FUNCTION:    AeInstallPciHandler
 414  *
 415  * PARAMETERS:  ACPI_WALK_NAMESPACE callback
 416  *
 417  * RETURN:      Status
 418  *
 419  * DESCRIPTION: Walk entire namespace, install a handler for every PCI
 420  *              device found.
 421  *
 422  ******************************************************************************/
 423
 424 static ACPI_STATUS
 425 AeInstallPciHandler (
 426     ACPI_HANDLE             ObjHandle,
 427     UINT32                  Level,
 428     void                    *Context,
 429     void                    **ReturnValue)
 430 {
 431     ACPI_STATUS             Status;
 432
 433
 434     /* Install memory and I/O handlers for the PCI device */
 435
 436     Status = AcpiInstallAddressSpaceHandler (ObjHandle,
 437         ACPI_ADR_SPACE_SYSTEM_IO, AeRegionHandler, AeRegionInit,
 438         &AeMyContext);
 439     if (ACPI_FAILURE (Status))
 440     {
 441         ACPI_EXCEPTION ((AE_INFO, Status,
 442             "Could not install an OpRegion handler for PCI device (%p)",
 443             ObjHandle));
 444     }
 445
 446     Status = AcpiInstallAddressSpaceHandler (ObjHandle,
 447         ACPI_ADR_SPACE_SYSTEM_MEMORY, AeRegionHandler, AeRegionInit,
 448         &AeMyContext);
 449     if (ACPI_FAILURE (Status))
 450     {
 451         ACPI_EXCEPTION ((AE_INFO, Status,
 452             "Could not install an OpRegion handler for PCI device (%p)",
 453             ObjHandle));
 454     }
 455
 456     return (AE_CTRL_TERMINATE);
 457 }