1/****************************************************************************** 2 * 3 * Module Name: utaddress - OpRegion address range check 4 * 5 *****************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 "acpi.h" 153#include "accommon.h" 154#include "acnamesp.h" 155 156 157#define _COMPONENT ACPI_UTILITIES 158 ACPI_MODULE_NAME ("utaddress") 159 160 161/******************************************************************************* 162 * 163 * FUNCTION: AcpiUtAddAddressRange 164 * 165 * PARAMETERS: SpaceId - Address space ID 166 * Address - OpRegion start address 167 * Length - OpRegion length 168 * RegionNode - OpRegion namespace node 169 * 170 * RETURN: Status 171 * 172 * DESCRIPTION: Add the Operation Region address range to the global list. 173 * The only supported Space IDs are Memory and I/O. Called when 174 * the OpRegion address/length operands are fully evaluated. 175 * 176 * MUTEX: Locks the namespace 177 * 178 * NOTE: Because this interface is only called when an OpRegion argument 179 * list is evaluated, there cannot be any duplicate RegionNodes. 180 * Duplicate Address/Length values are allowed, however, so that multiple 181 * address conflicts can be detected. 182 * 183 ******************************************************************************/ 184 185ACPI_STATUS 186AcpiUtAddAddressRange ( 187 ACPI_ADR_SPACE_TYPE SpaceId, 188 ACPI_PHYSICAL_ADDRESS Address, 189 UINT32 Length, 190 ACPI_NAMESPACE_NODE *RegionNode) 191{ 192 ACPI_ADDRESS_RANGE *RangeInfo; 193 194 195 ACPI_FUNCTION_TRACE (UtAddAddressRange); 196 197 198 if ((SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) && 199 (SpaceId != ACPI_ADR_SPACE_SYSTEM_IO)) 200 { 201 return_ACPI_STATUS (AE_OK); 202 } 203 204 /* Allocate/init a new info block, add it to the appropriate list */ 205 206 RangeInfo = ACPI_ALLOCATE (sizeof (ACPI_ADDRESS_RANGE)); 207 if (!RangeInfo) 208 { 209 return_ACPI_STATUS (AE_NO_MEMORY); 210 } 211 212 RangeInfo->StartAddress = Address; 213 RangeInfo->EndAddress = (Address + Length - 1); 214 RangeInfo->RegionNode = RegionNode; 215 216 RangeInfo->Next = AcpiGbl_AddressRangeList[SpaceId]; 217 AcpiGbl_AddressRangeList[SpaceId] = RangeInfo; 218 219 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 220 "\nAdded [%4.4s] address range: 0x%8.8X%8.8X-0x%8.8X%8.8X\n", 221 AcpiUtGetNodeName (RangeInfo->RegionNode), 222 ACPI_FORMAT_UINT64 (Address), 223 ACPI_FORMAT_UINT64 (RangeInfo->EndAddress))); 224 225 return_ACPI_STATUS (AE_OK); 226} 227 228 229/******************************************************************************* 230 * 231 * FUNCTION: AcpiUtRemoveAddressRange 232 * 233 * PARAMETERS: SpaceId - Address space ID 234 * RegionNode - OpRegion namespace node 235 * 236 * RETURN: None 237 * 238 * DESCRIPTION: Remove the Operation Region from the global list. The only 239 * supported Space IDs are Memory and I/O. Called when an 240 * OpRegion is deleted. 241 * 242 * MUTEX: Assumes the namespace is locked 243 * 244 ******************************************************************************/ 245 246void 247AcpiUtRemoveAddressRange ( 248 ACPI_ADR_SPACE_TYPE SpaceId, 249 ACPI_NAMESPACE_NODE *RegionNode) 250{ 251 ACPI_ADDRESS_RANGE *RangeInfo; 252 ACPI_ADDRESS_RANGE *Prev; 253 254 255 ACPI_FUNCTION_TRACE (UtRemoveAddressRange); 256 257 258 if ((SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) && 259 (SpaceId != ACPI_ADR_SPACE_SYSTEM_IO)) 260 { 261 return_VOID; 262 } 263 264 /* Get the appropriate list head and check the list */ 265 266 RangeInfo = Prev = AcpiGbl_AddressRangeList[SpaceId]; 267 while (RangeInfo) 268 { 269 if (RangeInfo->RegionNode == RegionNode) 270 { 271 if (RangeInfo == Prev) /* Found at list head */ 272 { 273 AcpiGbl_AddressRangeList[SpaceId] = RangeInfo->Next; 274 } 275 else 276 { 277 Prev->Next = RangeInfo->Next; 278 } 279 280 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 281 "\nRemoved [%4.4s] address range: 0x%8.8X%8.8X-0x%8.8X%8.8X\n", 282 AcpiUtGetNodeName (RangeInfo->RegionNode), 283 ACPI_FORMAT_UINT64 (RangeInfo->StartAddress), 284 ACPI_FORMAT_UINT64 (RangeInfo->EndAddress))); 285 286 ACPI_FREE (RangeInfo); 287 return_VOID; 288 } 289 290 Prev = RangeInfo; 291 RangeInfo = RangeInfo->Next; 292 } 293 294 return_VOID; 295} 296 297 298/******************************************************************************* 299 * 300 * FUNCTION: AcpiUtCheckAddressRange 301 * 302 * PARAMETERS: SpaceId - Address space ID 303 * Address - Start address 304 * Length - Length of address range 305 * Warn - TRUE if warning on overlap desired 306 * 307 * RETURN: Count of the number of conflicts detected. Zero is always 308 * returned for Space IDs other than Memory or I/O. 309 * 310 * DESCRIPTION: Check if the input address range overlaps any of the 311 * ASL operation region address ranges. The only supported 312 * Space IDs are Memory and I/O. 313 * 314 * MUTEX: Assumes the namespace is locked. 315 * 316 ******************************************************************************/ 317 318UINT32 319AcpiUtCheckAddressRange ( 320 ACPI_ADR_SPACE_TYPE SpaceId, 321 ACPI_PHYSICAL_ADDRESS Address, 322 UINT32 Length, 323 BOOLEAN Warn) 324{ 325 ACPI_ADDRESS_RANGE *RangeInfo; 326 ACPI_PHYSICAL_ADDRESS EndAddress; 327 char *Pathname; 328 UINT32 OverlapCount = 0; 329 330 331 ACPI_FUNCTION_TRACE (UtCheckAddressRange); 332 333 334 if ((SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) && 335 (SpaceId != ACPI_ADR_SPACE_SYSTEM_IO)) 336 { 337 return_UINT32 (0); 338 } 339 340 RangeInfo = AcpiGbl_AddressRangeList[SpaceId]; 341 EndAddress = Address + Length - 1; 342 343 /* Check entire list for all possible conflicts */ 344 345 while (RangeInfo) 346 { 347 /* 348 * Check if the requested address/length overlaps this 349 * address range. There are four cases to consider: 350 * 351 * 1) Input address/length is contained completely in the 352 * address range 353 * 2) Input address/length overlaps range at the range start 354 * 3) Input address/length overlaps range at the range end 355 * 4) Input address/length completely encompasses the range 356 */ 357 if ((Address <= RangeInfo->EndAddress) && 358 (EndAddress >= RangeInfo->StartAddress)) 359 { 360 /* Found an address range overlap */ 361 362 OverlapCount++; 363 if (Warn) /* Optional warning message */ 364 { 365 Pathname = AcpiNsGetNormalizedPathname (RangeInfo->RegionNode, TRUE); 366 367 ACPI_WARNING ((AE_INFO, 368 "%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)", 369 AcpiUtGetRegionName (SpaceId), 370 ACPI_FORMAT_UINT64 (Address), 371 ACPI_FORMAT_UINT64 (EndAddress), 372 ACPI_FORMAT_UINT64 (RangeInfo->StartAddress), 373 ACPI_FORMAT_UINT64 (RangeInfo->EndAddress), 374 Pathname)); 375 ACPI_FREE (Pathname); 376 } 377 } 378 379 RangeInfo = RangeInfo->Next; 380 } 381 382 return_UINT32 (OverlapCount); 383} 384 385 386/******************************************************************************* 387 * 388 * FUNCTION: AcpiUtDeleteAddressLists 389 * 390 * PARAMETERS: None 391 * 392 * RETURN: None 393 * 394 * DESCRIPTION: Delete all global address range lists (called during 395 * subsystem shutdown). 396 * 397 ******************************************************************************/ 398 399void 400AcpiUtDeleteAddressLists ( 401 void) 402{ 403 ACPI_ADDRESS_RANGE *Next; 404 ACPI_ADDRESS_RANGE *RangeInfo; 405 int i; 406 407 408 /* Delete all elements in all address range lists */ 409 410 for (i = 0; i < ACPI_ADDRESS_RANGE_MAX; i++) 411 { 412 Next = AcpiGbl_AddressRangeList[i]; 413 414 while (Next) 415 { 416 RangeInfo = Next; 417 Next = RangeInfo->Next; 418 ACPI_FREE (RangeInfo); 419 } 420 421 AcpiGbl_AddressRangeList[i] = NULL; 422 } 423} 424