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