xref: /freebsd/sys/contrib/dev/acpica/components/resources/rsio.c (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
1 /*******************************************************************************
2  *
3  * Module Name: rsio - IO and DMA resource descriptors
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2022, 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 <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acresrc.h>
155 
156 #define _COMPONENT          ACPI_RESOURCES
157         ACPI_MODULE_NAME    ("rsio")
158 
159 
160 /*******************************************************************************
161  *
162  * AcpiRsConvertIo
163  *
164  ******************************************************************************/
165 
166 ACPI_RSCONVERT_INFO     AcpiRsConvertIo[5] =
167 {
168     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_IO,
169                         ACPI_RS_SIZE (ACPI_RESOURCE_IO),
170                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertIo)},
171 
172     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_IO,
173                         sizeof (AML_RESOURCE_IO),
174                         0},
175 
176     /* Decode flag */
177 
178     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Io.IoDecode),
179                         AML_OFFSET (Io.Flags),
180                         0},
181     /*
182      * These fields are contiguous in both the source and destination:
183      * Address Alignment
184      * Length
185      * Minimum Base Address
186      * Maximum Base Address
187      */
188     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Io.Alignment),
189                         AML_OFFSET (Io.Alignment),
190                         2},
191 
192     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Io.Minimum),
193                         AML_OFFSET (Io.Minimum),
194                         2}
195 };
196 
197 
198 /*******************************************************************************
199  *
200  * AcpiRsConvertFixedIo
201  *
202  ******************************************************************************/
203 
204 ACPI_RSCONVERT_INFO     AcpiRsConvertFixedIo[4] =
205 {
206     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_FIXED_IO,
207                         ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_IO),
208                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertFixedIo)},
209 
210     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_FIXED_IO,
211                         sizeof (AML_RESOURCE_FIXED_IO),
212                         0},
213     /*
214      * These fields are contiguous in both the source and destination:
215      * Base Address
216      * Length
217      */
218     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.FixedIo.AddressLength),
219                         AML_OFFSET (FixedIo.AddressLength),
220                         1},
221 
222     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.FixedIo.Address),
223                         AML_OFFSET (FixedIo.Address),
224                         1}
225 };
226 
227 
228 /*******************************************************************************
229  *
230  * AcpiRsConvertGenericReg
231  *
232  ******************************************************************************/
233 
234 ACPI_RSCONVERT_INFO     AcpiRsConvertGenericReg[4] =
235 {
236     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_GENERIC_REGISTER,
237                         ACPI_RS_SIZE (ACPI_RESOURCE_GENERIC_REGISTER),
238                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertGenericReg)},
239 
240     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_GENERIC_REGISTER,
241                         sizeof (AML_RESOURCE_GENERIC_REGISTER),
242                         0},
243     /*
244      * These fields are contiguous in both the source and destination:
245      * Address Space ID
246      * Register Bit Width
247      * Register Bit Offset
248      * Access Size
249      */
250     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.GenericReg.SpaceId),
251                         AML_OFFSET (GenericReg.AddressSpaceId),
252                         4},
253 
254     /* Get the Register Address */
255 
256     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.GenericReg.Address),
257                         AML_OFFSET (GenericReg.Address),
258                         1}
259 };
260 
261 
262 /*******************************************************************************
263  *
264  * AcpiRsConvertEndDpf
265  *
266  ******************************************************************************/
267 
268 ACPI_RSCONVERT_INFO   AcpiRsConvertEndDpf[2] =
269 {
270     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_END_DEPENDENT,
271                         ACPI_RS_SIZE_MIN,
272                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertEndDpf)},
273 
274     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_END_DEPENDENT,
275                         sizeof (AML_RESOURCE_END_DEPENDENT),
276                         0}
277 };
278 
279 
280 /*******************************************************************************
281  *
282  * AcpiRsConvertEndTag
283  *
284  ******************************************************************************/
285 
286 ACPI_RSCONVERT_INFO   AcpiRsConvertEndTag[2] =
287 {
288     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_END_TAG,
289                         ACPI_RS_SIZE_MIN,
290                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertEndTag)},
291 
292     /*
293      * Note: The checksum field is set to zero, meaning that the resource
294      * data is treated as if the checksum operation succeeded.
295      * (ACPI Spec 1.0b Section 6.4.2.8)
296      */
297     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_END_TAG,
298                         sizeof (AML_RESOURCE_END_TAG),
299                         0}
300 };
301 
302 
303 /*******************************************************************************
304  *
305  * AcpiRsGetStartDpf
306  *
307  ******************************************************************************/
308 
309 ACPI_RSCONVERT_INFO   AcpiRsGetStartDpf[6] =
310 {
311     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_START_DEPENDENT,
312                         ACPI_RS_SIZE (ACPI_RESOURCE_START_DEPENDENT),
313                         ACPI_RSC_TABLE_SIZE (AcpiRsGetStartDpf)},
314 
315     /* Defaults for Compatibility and Performance priorities */
316 
317     {ACPI_RSC_SET8,     ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
318                         ACPI_ACCEPTABLE_CONFIGURATION,
319                         2},
320 
321     /* Get the descriptor length (0 or 1 for Start Dpf descriptor) */
322 
323     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.DescriptorLength),
324                         AML_OFFSET (StartDpf.DescriptorType),
325                         0},
326 
327     /* All done if there is no flag byte present in the descriptor */
328 
329     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_AML_LENGTH, 0, 1},
330 
331     /* Flag byte is present, get the flags */
332 
333     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
334                         AML_OFFSET (StartDpf.Flags),
335                         0},
336 
337     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
338                         AML_OFFSET (StartDpf.Flags),
339                         2}
340 };
341 
342 
343 /*******************************************************************************
344  *
345  * AcpiRsSetStartDpf
346  *
347  ******************************************************************************/
348 
349 ACPI_RSCONVERT_INFO   AcpiRsSetStartDpf[10] =
350 {
351     /* Start with a default descriptor of length 1 */
352 
353     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_START_DEPENDENT,
354                         sizeof (AML_RESOURCE_START_DEPENDENT),
355                         ACPI_RSC_TABLE_SIZE (AcpiRsSetStartDpf)},
356 
357     /* Set the default flag values */
358 
359     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
360                         AML_OFFSET (StartDpf.Flags),
361                         0},
362 
363     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
364                         AML_OFFSET (StartDpf.Flags),
365                         2},
366     /*
367      * All done if the output descriptor length is required to be 1
368      * (i.e., optimization to 0 bytes cannot be attempted)
369      */
370     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
371                         ACPI_RS_OFFSET(Data.StartDpf.DescriptorLength),
372                         1},
373 
374     /* Set length to 0 bytes (no flags byte) */
375 
376     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT_NOPRIO)},
377 
378     /*
379      * All done if the output descriptor length is required to be 0.
380      *
381      * TBD: Perhaps we should check for error if input flags are not
382      * compatible with a 0-byte descriptor.
383      */
384     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
385                         ACPI_RS_OFFSET(Data.StartDpf.DescriptorLength),
386                         0},
387 
388     /* Reset length to 1 byte (descriptor with flags byte) */
389 
390     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT)},
391 
392 
393     /*
394      * All done if flags byte is necessary -- if either priority value
395      * is not ACPI_ACCEPTABLE_CONFIGURATION
396      */
397     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
398                         ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
399                         ACPI_ACCEPTABLE_CONFIGURATION},
400 
401     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
402                         ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
403                         ACPI_ACCEPTABLE_CONFIGURATION},
404 
405     /* Flag byte is not necessary */
406 
407     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT_NOPRIO)}
408 };
409