acpica/utilities/utaddress.c

0001 /******************************************************************************
0002  *
0003  * Module Name: utaddress - OpRegion address range check
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155
0156
0157 #define _COMPONENT          ACPI_UTILITIES
0158         ACPI_MODULE_NAME    ("utaddress")
0159
0160
0161 /*******************************************************************************
0162  *
0163  * FUNCTION:    AcpiUtAddAddressRange
0164  *
0165  * PARAMETERS:  SpaceId             - Address space ID
0166  *              Address             - OpRegion start address
0167  *              Length              - OpRegion length
0168  *              RegionNode          - OpRegion namespace node
0169  *
0170  * RETURN:      Status
0171  *
0172  * DESCRIPTION: Add the Operation Region address range to the global list.
0173  *              The only supported Space IDs are Memory and I/O. Called when
0174  *              the OpRegion address/length operands are fully evaluated.
0175  *
0176  * MUTEX:       Locks the namespace
0177  *
0178  * NOTE: Because this interface is only called when an OpRegion argument
0179  * list is evaluated, there cannot be any duplicate RegionNodes.
0180  * Duplicate Address/Length values are allowed, however, so that multiple
0181  * address conflicts can be detected.
0182  *
0183  ******************************************************************************/
0184
0185 ACPI_STATUS
0186 AcpiUtAddAddressRange (
0187     ACPI_ADR_SPACE_TYPE     SpaceId,
0188     ACPI_PHYSICAL_ADDRESS   Address,
0189     UINT32                  Length,
0190     ACPI_NAMESPACE_NODE     *RegionNode)
0191 {
0192     ACPI_ADDRESS_RANGE      *RangeInfo;
0193
0194
0195     ACPI_FUNCTION_TRACE (UtAddAddressRange);
0196
0197
0198     if ((SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) &&
0199         (SpaceId != ACPI_ADR_SPACE_SYSTEM_IO))
0200     {
0201         return_ACPI_STATUS (AE_OK);
0202     }
0203
0204     /* Allocate/init a new info block, add it to the appropriate list */
0205
0206     RangeInfo = ACPI_ALLOCATE (sizeof (ACPI_ADDRESS_RANGE));
0207     if (!RangeInfo)
0208     {
0209         return_ACPI_STATUS (AE_NO_MEMORY);
0210     }
0211
0212     RangeInfo->StartAddress = Address;
0213     RangeInfo->EndAddress = (Address + Length - 1);
0214     RangeInfo->RegionNode = RegionNode;
0215
0216     RangeInfo->Next = AcpiGbl_AddressRangeList[SpaceId];
0217     AcpiGbl_AddressRangeList[SpaceId] = RangeInfo;
0218
0219     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
0220         "\nAdded [%4.4s] address range: 0x%8.8X%8.8X-0x%8.8X%8.8X\n",
0221         AcpiUtGetNodeName (RangeInfo->RegionNode),
0222         ACPI_FORMAT_UINT64 (Address),
0223         ACPI_FORMAT_UINT64 (RangeInfo->EndAddress)));
0224
0225     return_ACPI_STATUS (AE_OK);
0226 }
0227
0228
0229 /*******************************************************************************
0230  *
0231  * FUNCTION:    AcpiUtRemoveAddressRange
0232  *
0233  * PARAMETERS:  SpaceId             - Address space ID
0234  *              RegionNode          - OpRegion namespace node
0235  *
0236  * RETURN:      None
0237  *
0238  * DESCRIPTION: Remove the Operation Region from the global list. The only
0239  *              supported Space IDs are Memory and I/O. Called when an
0240  *              OpRegion is deleted.
0241  *
0242  * MUTEX:       Assumes the namespace is locked
0243  *
0244  ******************************************************************************/
0245
0246 void
0247 AcpiUtRemoveAddressRange (
0248     ACPI_ADR_SPACE_TYPE     SpaceId,
0249     ACPI_NAMESPACE_NODE     *RegionNode)
0250 {
0251     ACPI_ADDRESS_RANGE      *RangeInfo;
0252     ACPI_ADDRESS_RANGE      *Prev;
0253
0254
0255     ACPI_FUNCTION_TRACE (UtRemoveAddressRange);
0256
0257
0258     if ((SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) &&
0259         (SpaceId != ACPI_ADR_SPACE_SYSTEM_IO))
0260     {
0261         return_VOID;
0262     }
0263
0264     /* Get the appropriate list head and check the list */
0265
0266     RangeInfo = Prev = AcpiGbl_AddressRangeList[SpaceId];
0267     while (RangeInfo)
0268     {
0269         if (RangeInfo->RegionNode == RegionNode)
0270         {
0271             if (RangeInfo == Prev) /* Found at list head */
0272             {
0273                 AcpiGbl_AddressRangeList[SpaceId] = RangeInfo->Next;
0274             }
0275             else
0276             {
0277                 Prev->Next = RangeInfo->Next;
0278             }
0279
0280             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
0281                 "\nRemoved [%4.4s] address range: 0x%8.8X%8.8X-0x%8.8X%8.8X\n",
0282                 AcpiUtGetNodeName (RangeInfo->RegionNode),
0283                 ACPI_FORMAT_UINT64 (RangeInfo->StartAddress),
0284                 ACPI_FORMAT_UINT64 (RangeInfo->EndAddress)));
0285
0286             ACPI_FREE (RangeInfo);
0287             return_VOID;
0288         }
0289
0290         Prev = RangeInfo;
0291         RangeInfo = RangeInfo->Next;
0292     }
0293
0294     return_VOID;
0295 }
0296
0297
0298 /*******************************************************************************
0299  *
0300  * FUNCTION:    AcpiUtCheckAddressRange
0301  *
0302  * PARAMETERS:  SpaceId             - Address space ID
0303  *              Address             - Start address
0304  *              Length              - Length of address range
0305  *              Warn                - TRUE if warning on overlap desired
0306  *
0307  * RETURN:      Count of the number of conflicts detected. Zero is always
0308  *              returned for Space IDs other than Memory or I/O.
0309  *
0310  * DESCRIPTION: Check if the input address range overlaps any of the
0311  *              ASL operation region address ranges. The only supported
0312  *              Space IDs are Memory and I/O.
0313  *
0314  * MUTEX:       Assumes the namespace is locked.
0315  *
0316  ******************************************************************************/
0317
0318 UINT32
0319 AcpiUtCheckAddressRange (
0320     ACPI_ADR_SPACE_TYPE     SpaceId,
0321     ACPI_PHYSICAL_ADDRESS   Address,
0322     UINT32                  Length,
0323     BOOLEAN                 Warn)
0324 {
0325     ACPI_ADDRESS_RANGE      *RangeInfo;
0326     ACPI_PHYSICAL_ADDRESS   EndAddress;
0327     char                    *Pathname;
0328     UINT32                  OverlapCount = 0;
0329
0330
0331     ACPI_FUNCTION_TRACE (UtCheckAddressRange);
0332
0333
0334     if ((SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) &&
0335         (SpaceId != ACPI_ADR_SPACE_SYSTEM_IO))
0336     {
0337         return_UINT32 (0);
0338     }
0339
0340     RangeInfo = AcpiGbl_AddressRangeList[SpaceId];
0341     EndAddress = Address + Length - 1;
0342
0343     /* Check entire list for all possible conflicts */
0344
0345     while (RangeInfo)
0346     {
0347         /*
0348          * Check if the requested address/length overlaps this
0349          * address range. There are four cases to consider:
0350          *
0351          * 1) Input address/length is contained completely in the
0352          *    address range
0353          * 2) Input address/length overlaps range at the range start
0354          * 3) Input address/length overlaps range at the range end
0355          * 4) Input address/length completely encompasses the range
0356          */
0357         if ((Address <= RangeInfo->EndAddress) &&
0358             (EndAddress >= RangeInfo->StartAddress))
0359         {
0360             /* Found an address range overlap */
0361
0362             OverlapCount++;
0363             if (Warn)   /* Optional warning message */
0364             {
0365                 Pathname = AcpiNsGetNormalizedPathname (RangeInfo->RegionNode, TRUE);
0366
0367                 ACPI_WARNING ((AE_INFO,
0368                     "%s range 0x%8.8X%8.8X-0x%8.8X%8.8X conflicts with OpRegion 0x%8.8X%8.8X-0x%8.8X%8.8X (%s)",
0369                     AcpiUtGetRegionName (SpaceId),
0370                     ACPI_FORMAT_UINT64 (Address),
0371                     ACPI_FORMAT_UINT64 (EndAddress),
0372                     ACPI_FORMAT_UINT64 (RangeInfo->StartAddress),
0373                     ACPI_FORMAT_UINT64 (RangeInfo->EndAddress),
0374                     Pathname));
0375                 ACPI_FREE (Pathname);
0376             }
0377         }
0378
0379         RangeInfo = RangeInfo->Next;
0380     }
0381
0382     return_UINT32 (OverlapCount);
0383 }
0384
0385
0386 /*******************************************************************************
0387  *
0388  * FUNCTION:    AcpiUtDeleteAddressLists
0389  *
0390  * PARAMETERS:  None
0391  *
0392  * RETURN:      None
0393  *
0394  * DESCRIPTION: Delete all global address range lists (called during
0395  *              subsystem shutdown).
0396  *
0397  ******************************************************************************/
0398
0399 void
0400 AcpiUtDeleteAddressLists (
0401     void)
0402 {
0403     ACPI_ADDRESS_RANGE      *Next;
0404     ACPI_ADDRESS_RANGE      *RangeInfo;
0405     int                     i;
0406
0407
0408     /* Delete all elements in all address range lists */
0409
0410     for (i = 0; i < ACPI_ADDRESS_RANGE_MAX; i++)
0411     {
0412         Next = AcpiGbl_AddressRangeList[i];
0413
0414         while (Next)
0415         {
0416             RangeInfo = Next;
0417             Next = RangeInfo->Next;
0418             ACPI_FREE (RangeInfo);
0419         }
0420
0421         AcpiGbl_AddressRangeList[i] = NULL;
0422     }
0423 }