xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/resources/rsaddr.c (revision 44d19f4d32b8f7e9c01f00294c87ca5cc2e057f7)
1 /*******************************************************************************
2  *
3  * Module Name: rsaddr - Address resource descriptors (16/32/64)
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 "acresrc.h"
119 
120 #define _COMPONENT          ACPI_RESOURCES
121         ACPI_MODULE_NAME    ("rsaddr")
122 
123 
124 /*******************************************************************************
125  *
126  * AcpiRsConvertAddress16 - All WORD (16-bit) address resources
127  *
128  ******************************************************************************/
129 
130 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress16[5] =
131 {
132     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS16,
133                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS16),
134                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress16)},
135 
136     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS16,
137                         sizeof (AML_RESOURCE_ADDRESS16),
138                         0},
139 
140     /* Resource Type, General Flags, and Type-Specific Flags */
141 
142     {ACPI_RSC_ADDRESS,  0, 0, 0},
143 
144     /*
145      * These fields are contiguous in both the source and destination:
146      * Address Granularity
147      * Address Range Minimum
148      * Address Range Maximum
149      * Address Translation Offset
150      * Address Length
151      */
152     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Address16.Address.Granularity),
153                         AML_OFFSET (Address16.Granularity),
154                         5},
155 
156     /* Optional ResourceSource (Index and String) */
157 
158     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address16.ResourceSource),
159                         0,
160                         sizeof (AML_RESOURCE_ADDRESS16)}
161 };
162 
163 
164 /*******************************************************************************
165  *
166  * AcpiRsConvertAddress32 - All DWORD (32-bit) address resources
167  *
168  ******************************************************************************/
169 
170 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress32[5] =
171 {
172     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS32,
173                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS32),
174                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress32)},
175 
176     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS32,
177                         sizeof (AML_RESOURCE_ADDRESS32),
178                         0},
179 
180     /* Resource Type, General Flags, and Type-Specific Flags */
181 
182     {ACPI_RSC_ADDRESS,  0, 0, 0},
183 
184     /*
185      * These fields are contiguous in both the source and destination:
186      * Address Granularity
187      * Address Range Minimum
188      * Address Range Maximum
189      * Address Translation Offset
190      * Address Length
191      */
192     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.Address32.Address.Granularity),
193                         AML_OFFSET (Address32.Granularity),
194                         5},
195 
196     /* Optional ResourceSource (Index and String) */
197 
198     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address32.ResourceSource),
199                         0,
200                         sizeof (AML_RESOURCE_ADDRESS32)}
201 };
202 
203 
204 /*******************************************************************************
205  *
206  * AcpiRsConvertAddress64 - All QWORD (64-bit) address resources
207  *
208  ******************************************************************************/
209 
210 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress64[5] =
211 {
212     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS64,
213                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS64),
214                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress64)},
215 
216     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS64,
217                         sizeof (AML_RESOURCE_ADDRESS64),
218                         0},
219 
220     /* Resource Type, General Flags, and Type-Specific Flags */
221 
222     {ACPI_RSC_ADDRESS,  0, 0, 0},
223 
224     /*
225      * These fields are contiguous in both the source and destination:
226      * Address Granularity
227      * Address Range Minimum
228      * Address Range Maximum
229      * Address Translation Offset
230      * Address Length
231      */
232     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.Address64.Address.Granularity),
233                         AML_OFFSET (Address64.Granularity),
234                         5},
235 
236     /* Optional ResourceSource (Index and String) */
237 
238     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address64.ResourceSource),
239                         0,
240                         sizeof (AML_RESOURCE_ADDRESS64)}
241 };
242 
243 
244 /*******************************************************************************
245  *
246  * AcpiRsConvertExtAddress64 - All Extended (64-bit) address resources
247  *
248  ******************************************************************************/
249 
250 ACPI_RSCONVERT_INFO     AcpiRsConvertExtAddress64[5] =
251 {
252     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64,
253                         ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_ADDRESS64),
254                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtAddress64)},
255 
256     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64,
257                         sizeof (AML_RESOURCE_EXTENDED_ADDRESS64),
258                         0},
259 
260     /* Resource Type, General Flags, and Type-Specific Flags */
261 
262     {ACPI_RSC_ADDRESS,  0, 0, 0},
263 
264     /* Revision ID */
265 
266     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.ExtAddress64.RevisionID),
267                         AML_OFFSET (ExtAddress64.RevisionID),
268                         1},
269     /*
270      * These fields are contiguous in both the source and destination:
271      * Address Granularity
272      * Address Range Minimum
273      * Address Range Maximum
274      * Address Translation Offset
275      * Address Length
276      * Type-Specific Attribute
277      */
278     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.ExtAddress64.Address.Granularity),
279                         AML_OFFSET (ExtAddress64.Granularity),
280                         6}
281 };
282 
283 
284 /*******************************************************************************
285  *
286  * AcpiRsConvertGeneralFlags - Flags common to all address descriptors
287  *
288  ******************************************************************************/
289 
290 static ACPI_RSCONVERT_INFO  AcpiRsConvertGeneralFlags[6] =
291 {
292     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.Flags),
293                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertGeneralFlags)},
294 
295     /* Resource Type (Memory, Io, BusNumber, etc.) */
296 
297     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Address.ResourceType),
298                         AML_OFFSET (Address.ResourceType),
299                         1},
300 
301     /* General Flags - Consume, Decode, MinFixed, MaxFixed */
302 
303     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.ProducerConsumer),
304                         AML_OFFSET (Address.Flags),
305                         0},
306 
307     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Decode),
308                         AML_OFFSET (Address.Flags),
309                         1},
310 
311     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MinAddressFixed),
312                         AML_OFFSET (Address.Flags),
313                         2},
314 
315     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MaxAddressFixed),
316                         AML_OFFSET (Address.Flags),
317                         3}
318 };
319 
320 
321 /*******************************************************************************
322  *
323  * AcpiRsConvertMemFlags - Flags common to Memory address descriptors
324  *
325  ******************************************************************************/
326 
327 static ACPI_RSCONVERT_INFO  AcpiRsConvertMemFlags[5] =
328 {
329     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags),
330                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertMemFlags)},
331 
332     /* Memory-specific flags */
333 
334     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.WriteProtect),
335                         AML_OFFSET (Address.SpecificFlags),
336                         0},
337 
338     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Caching),
339                         AML_OFFSET (Address.SpecificFlags),
340                         1},
341 
342     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.RangeType),
343                         AML_OFFSET (Address.SpecificFlags),
344                         3},
345 
346     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Translation),
347                         AML_OFFSET (Address.SpecificFlags),
348                         5}
349 };
350 
351 
352 /*******************************************************************************
353  *
354  * AcpiRsConvertIoFlags - Flags common to I/O address descriptors
355  *
356  ******************************************************************************/
357 
358 static ACPI_RSCONVERT_INFO  AcpiRsConvertIoFlags[4] =
359 {
360     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags),
361                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertIoFlags)},
362 
363     /* I/O-specific flags */
364 
365     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.RangeType),
366                         AML_OFFSET (Address.SpecificFlags),
367                         0},
368 
369     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.Translation),
370                         AML_OFFSET (Address.SpecificFlags),
371                         4},
372 
373     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.TranslationType),
374                         AML_OFFSET (Address.SpecificFlags),
375                         5}
376 };
377 
378 
379 /*******************************************************************************
380  *
381  * FUNCTION:    AcpiRsGetAddressCommon
382  *
383  * PARAMETERS:  Resource            - Pointer to the internal resource struct
384  *              Aml                 - Pointer to the AML resource descriptor
385  *
386  * RETURN:      TRUE if the ResourceType field is OK, FALSE otherwise
387  *
388  * DESCRIPTION: Convert common flag fields from a raw AML resource descriptor
389  *              to an internal resource descriptor
390  *
391  ******************************************************************************/
392 
393 BOOLEAN
394 AcpiRsGetAddressCommon (
395     ACPI_RESOURCE           *Resource,
396     AML_RESOURCE            *Aml)
397 {
398     ACPI_FUNCTION_ENTRY ();
399 
400 
401     /* Validate the Resource Type */
402 
403     if ((Aml->Address.ResourceType > 2) &&
404         (Aml->Address.ResourceType < 0xC0))
405     {
406         return (FALSE);
407     }
408 
409     /* Get the Resource Type and General Flags */
410 
411     (void) AcpiRsConvertAmlToResource (
412         Resource, Aml, AcpiRsConvertGeneralFlags);
413 
414     /* Get the Type-Specific Flags (Memory and I/O descriptors only) */
415 
416     if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE)
417     {
418         (void) AcpiRsConvertAmlToResource (
419             Resource, Aml, AcpiRsConvertMemFlags);
420     }
421     else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE)
422     {
423         (void) AcpiRsConvertAmlToResource (
424             Resource, Aml, AcpiRsConvertIoFlags);
425     }
426     else
427     {
428         /* Generic resource type, just grab the TypeSpecific byte */
429 
430         Resource->Data.Address.Info.TypeSpecific =
431             Aml->Address.SpecificFlags;
432     }
433 
434     return (TRUE);
435 }
436 
437 
438 /*******************************************************************************
439  *
440  * FUNCTION:    AcpiRsSetAddressCommon
441  *
442  * PARAMETERS:  Aml                 - Pointer to the AML resource descriptor
443  *              Resource            - Pointer to the internal resource struct
444  *
445  * RETURN:      None
446  *
447  * DESCRIPTION: Convert common flag fields from a resource descriptor to an
448  *              AML descriptor
449  *
450  ******************************************************************************/
451 
452 void
453 AcpiRsSetAddressCommon (
454     AML_RESOURCE            *Aml,
455     ACPI_RESOURCE           *Resource)
456 {
457     ACPI_FUNCTION_ENTRY ();
458 
459 
460     /* Set the Resource Type and General Flags */
461 
462     (void) AcpiRsConvertResourceToAml (
463         Resource, Aml, AcpiRsConvertGeneralFlags);
464 
465     /* Set the Type-Specific Flags (Memory and I/O descriptors only) */
466 
467     if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE)
468     {
469         (void) AcpiRsConvertResourceToAml (
470             Resource, Aml, AcpiRsConvertMemFlags);
471     }
472     else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE)
473     {
474         (void) AcpiRsConvertResourceToAml (
475             Resource, Aml, AcpiRsConvertIoFlags);
476     }
477     else
478     {
479         /* Generic resource type, just copy the TypeSpecific byte */
480 
481         Aml->Address.SpecificFlags =
482             Resource->Data.Address.Info.TypeSpecific;
483     }
484 }
485