1/*******************************************************************************
2 *
3 * Module Name: rsirq - IRQ resource descriptors
4 *
5 ******************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 "acresrc.h"
155
156#define _COMPONENT          ACPI_RESOURCES
157        ACPI_MODULE_NAME    ("rsirq")
158
159
160/*******************************************************************************
161 *
162 * AcpiRsGetIrq
163 *
164 ******************************************************************************/
165
166ACPI_RSCONVERT_INFO     AcpiRsGetIrq[9] =
167{
168    {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_IRQ,
169                        ACPI_RS_SIZE (ACPI_RESOURCE_IRQ),
170                        ACPI_RSC_TABLE_SIZE (AcpiRsGetIrq)},
171
172    /* Get the IRQ mask (bytes 1:2) */
173
174    {ACPI_RSC_BITMASK16,ACPI_RS_OFFSET (Data.Irq.Interrupts[0]),
175                        AML_OFFSET (Irq.IrqMask),
176                        ACPI_RS_OFFSET (Data.Irq.InterruptCount)},
177
178    /* Set default flags (others are zero) */
179
180    {ACPI_RSC_SET8,     ACPI_RS_OFFSET (Data.Irq.Triggering),
181                        ACPI_EDGE_SENSITIVE,
182                        1},
183
184    /* Get the descriptor length (2 or 3 for IRQ descriptor) */
185
186    {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Irq.DescriptorLength),
187                        AML_OFFSET (Irq.DescriptorType),
188                        0},
189
190    /* All done if no flag byte present in descriptor */
191
192    {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_AML_LENGTH, 0, 3},
193
194    /* Get flags: Triggering[0], Polarity[3], Sharing[4], Wake[5] */
195
196    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Triggering),
197                        AML_OFFSET (Irq.Flags),
198                        0},
199
200    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Polarity),
201                        AML_OFFSET (Irq.Flags),
202                        3},
203
204    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Sharable),
205                        AML_OFFSET (Irq.Flags),
206                        4},
207
208    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.WakeCapable),
209                        AML_OFFSET (Irq.Flags),
210                        5}
211};
212
213
214/*******************************************************************************
215 *
216 * AcpiRsSetIrq
217 *
218 ******************************************************************************/
219
220ACPI_RSCONVERT_INFO     AcpiRsSetIrq[14] =
221{
222    /* Start with a default descriptor of length 3 */
223
224    {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_IRQ,
225                        sizeof (AML_RESOURCE_IRQ),
226                        ACPI_RSC_TABLE_SIZE (AcpiRsSetIrq)},
227
228    /* Convert interrupt list to 16-bit IRQ bitmask */
229
230    {ACPI_RSC_BITMASK16,ACPI_RS_OFFSET (Data.Irq.Interrupts[0]),
231                        AML_OFFSET (Irq.IrqMask),
232                        ACPI_RS_OFFSET (Data.Irq.InterruptCount)},
233
234    /* Set flags: Triggering[0], Polarity[3], Sharing[4], Wake[5] */
235
236    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Triggering),
237                        AML_OFFSET (Irq.Flags),
238                        0},
239
240    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Polarity),
241                        AML_OFFSET (Irq.Flags),
242                        3},
243
244    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Sharable),
245                        AML_OFFSET (Irq.Flags),
246                        4},
247
248    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.WakeCapable),
249                        AML_OFFSET (Irq.Flags),
250                        5},
251
252    /*
253     * All done if the output descriptor length is required to be 3
254     * (i.e., optimization to 2 bytes cannot be attempted)
255     */
256    {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
257                        ACPI_RS_OFFSET(Data.Irq.DescriptorLength),
258                        3},
259
260    /* Set length to 2 bytes (no flags byte) */
261
262    {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ_NOFLAGS)},
263
264    /*
265     * All done if the output descriptor length is required to be 2.
266     *
267     * TBD: Perhaps we should check for error if input flags are not
268     * compatible with a 2-byte descriptor.
269     */
270    {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
271                        ACPI_RS_OFFSET(Data.Irq.DescriptorLength),
272                        2},
273
274    /* Reset length to 3 bytes (descriptor with flags byte) */
275
276    {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ)},
277
278    /*
279     * Check if the flags byte is necessary. Not needed if the flags are:
280     * ACPI_EDGE_SENSITIVE, ACPI_ACTIVE_HIGH, ACPI_EXCLUSIVE
281     */
282    {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
283                        ACPI_RS_OFFSET (Data.Irq.Triggering),
284                        ACPI_EDGE_SENSITIVE},
285
286    {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
287                        ACPI_RS_OFFSET (Data.Irq.Polarity),
288                        ACPI_ACTIVE_HIGH},
289
290    {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
291                        ACPI_RS_OFFSET (Data.Irq.Sharable),
292                        ACPI_EXCLUSIVE},
293
294    /* We can optimize to a 2-byte IrqNoFlags() descriptor */
295
296    {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ_NOFLAGS)}
297};
298
299
300/*******************************************************************************
301 *
302 * AcpiRsConvertExtIrq
303 *
304 ******************************************************************************/
305
306ACPI_RSCONVERT_INFO     AcpiRsConvertExtIrq[10] =
307{
308    {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_EXTENDED_IRQ,
309                        ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_IRQ),
310                        ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtIrq)},
311
312    {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_EXTENDED_IRQ,
313                        sizeof (AML_RESOURCE_EXTENDED_IRQ),
314                        0},
315
316    /*
317     * Flags: Producer/Consumer[0], Triggering[1], Polarity[2],
318     *        Sharing[3], Wake[4]
319     */
320    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.ProducerConsumer),
321                        AML_OFFSET (ExtendedIrq.Flags),
322                        0},
323
324    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Triggering),
325                        AML_OFFSET (ExtendedIrq.Flags),
326                        1},
327
328    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Polarity),
329                        AML_OFFSET (ExtendedIrq.Flags),
330                        2},
331
332    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Sharable),
333                        AML_OFFSET (ExtendedIrq.Flags),
334                        3},
335
336    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.WakeCapable),
337                        AML_OFFSET (ExtendedIrq.Flags),
338                        4},
339
340    /* IRQ Table length (Byte4) */
341
342    {ACPI_RSC_COUNT,    ACPI_RS_OFFSET (Data.ExtendedIrq.InterruptCount),
343                        AML_OFFSET (ExtendedIrq.InterruptCount),
344                        sizeof (UINT32)},
345
346    /* Copy every IRQ in the table, each is 32 bits */
347
348    {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.ExtendedIrq.Interrupts[0]),
349                        AML_OFFSET (ExtendedIrq.Interrupts[0]),
350                        0},
351
352    /* Optional ResourceSource (Index and String) */
353
354    {ACPI_RSC_SOURCEX,  ACPI_RS_OFFSET (Data.ExtendedIrq.ResourceSource),
355                        ACPI_RS_OFFSET (Data.ExtendedIrq.Interrupts[0]),
356                        sizeof (AML_RESOURCE_EXTENDED_IRQ)}
357};
358
359
360/*******************************************************************************
361 *
362 * AcpiRsConvertDma
363 *
364 ******************************************************************************/
365
366ACPI_RSCONVERT_INFO     AcpiRsConvertDma[6] =
367{
368    {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_DMA,
369                        ACPI_RS_SIZE (ACPI_RESOURCE_DMA),
370                        ACPI_RSC_TABLE_SIZE (AcpiRsConvertDma)},
371
372    {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_DMA,
373                        sizeof (AML_RESOURCE_DMA),
374                        0},
375
376    /* Flags: transfer preference, bus mastering, channel speed */
377
378    {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Dma.Transfer),
379                        AML_OFFSET (Dma.Flags),
380                        0},
381
382    {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Dma.BusMaster),
383                        AML_OFFSET (Dma.Flags),
384                        2},
385
386    {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Dma.Type),
387                        AML_OFFSET (Dma.Flags),
388                        5},
389
390    /* DMA channel mask bits */
391
392    {ACPI_RSC_BITMASK,  ACPI_RS_OFFSET (Data.Dma.Channels[0]),
393                        AML_OFFSET (Dma.DmaChannelMask),
394                        ACPI_RS_OFFSET (Data.Dma.ChannelCount)}
395};
396
397
398/*******************************************************************************
399 *
400 * AcpiRsConvertFixedDma
401 *
402 ******************************************************************************/
403
404ACPI_RSCONVERT_INFO     AcpiRsConvertFixedDma[4] =
405{
406    {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_FIXED_DMA,
407                        ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_DMA),
408                        ACPI_RSC_TABLE_SIZE (AcpiRsConvertFixedDma)},
409
410    {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_FIXED_DMA,
411                        sizeof (AML_RESOURCE_FIXED_DMA),
412                        0},
413
414    /*
415     * These fields are contiguous in both the source and destination:
416     * RequestLines
417     * Channels
418     */
419    {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.FixedDma.RequestLines),
420                        AML_OFFSET (FixedDma.RequestLines),
421                        2},
422
423    {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.FixedDma.Width),
424                        AML_OFFSET (FixedDma.Width),
425                        1},
426};
427