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