xref: /titanic_52/usr/src/uts/intel/io/acpica/resources/rsirq.c (revision dd51520e127b452179a2ce4ea3bd8dee949f9afe)
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 - 2009, 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 __RSIRQ_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acresrc.h"
121 
122 #define _COMPONENT          ACPI_RESOURCES
123         ACPI_MODULE_NAME    ("rsirq")
124 
125 
126 /*******************************************************************************
127  *
128  * AcpiRsGetIrq
129  *
130  ******************************************************************************/
131 
132 ACPI_RSCONVERT_INFO     AcpiRsGetIrq[8] =
133 {
134     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_IRQ,
135                         ACPI_RS_SIZE (ACPI_RESOURCE_IRQ),
136                         ACPI_RSC_TABLE_SIZE (AcpiRsGetIrq)},
137 
138     /* Get the IRQ mask (bytes 1:2) */
139 
140     {ACPI_RSC_BITMASK16,ACPI_RS_OFFSET (Data.Irq.Interrupts[0]),
141                         AML_OFFSET (Irq.IrqMask),
142                         ACPI_RS_OFFSET (Data.Irq.InterruptCount)},
143 
144     /* Set default flags (others are zero) */
145 
146     {ACPI_RSC_SET8,     ACPI_RS_OFFSET (Data.Irq.Triggering),
147                         ACPI_EDGE_SENSITIVE,
148                         1},
149 
150     /* Get the descriptor length (2 or 3 for IRQ descriptor) */
151 
152     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Irq.DescriptorLength),
153                         AML_OFFSET (Irq.DescriptorType),
154                         0},
155 
156     /* All done if no flag byte present in descriptor */
157 
158     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_AML_LENGTH, 0, 3},
159 
160     /* Get flags: Triggering[0], Polarity[3], Sharing[4] */
161 
162     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Triggering),
163                         AML_OFFSET (Irq.Flags),
164                         0},
165 
166     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Polarity),
167                         AML_OFFSET (Irq.Flags),
168                         3},
169 
170     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Sharable),
171                         AML_OFFSET (Irq.Flags),
172                         4}
173 };
174 
175 
176 /*******************************************************************************
177  *
178  * AcpiRsSetIrq
179  *
180  ******************************************************************************/
181 
182 ACPI_RSCONVERT_INFO     AcpiRsSetIrq[13] =
183 {
184     /* Start with a default descriptor of length 3 */
185 
186     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_IRQ,
187                         sizeof (AML_RESOURCE_IRQ),
188                         ACPI_RSC_TABLE_SIZE (AcpiRsSetIrq)},
189 
190     /* Convert interrupt list to 16-bit IRQ bitmask */
191 
192     {ACPI_RSC_BITMASK16,ACPI_RS_OFFSET (Data.Irq.Interrupts[0]),
193                         AML_OFFSET (Irq.IrqMask),
194                         ACPI_RS_OFFSET (Data.Irq.InterruptCount)},
195 
196     /* Set the flags byte */
197 
198     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Triggering),
199                         AML_OFFSET (Irq.Flags),
200                         0},
201 
202     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Polarity),
203                         AML_OFFSET (Irq.Flags),
204                         3},
205 
206     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Sharable),
207                         AML_OFFSET (Irq.Flags),
208                         4},
209 
210     /*
211      * All done if the output descriptor length is required to be 3
212      * (i.e., optimization to 2 bytes cannot be attempted)
213      */
214     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
215                         ACPI_RS_OFFSET(Data.Irq.DescriptorLength),
216                         3},
217 
218     /* Set length to 2 bytes (no flags byte) */
219 
220     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ_NOFLAGS)},
221 
222     /*
223      * All done if the output descriptor length is required to be 2.
224      *
225      * TBD: Perhaps we should check for error if input flags are not
226      * compatible with a 2-byte descriptor.
227      */
228     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
229                         ACPI_RS_OFFSET(Data.Irq.DescriptorLength),
230                         2},
231 
232     /* Reset length to 3 bytes (descriptor with flags byte) */
233 
234     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ)},
235 
236     /*
237      * Check if the flags byte is necessary. Not needed if the flags are:
238      * ACPI_EDGE_SENSITIVE, ACPI_ACTIVE_HIGH, ACPI_EXCLUSIVE
239      */
240     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
241                         ACPI_RS_OFFSET (Data.Irq.Triggering),
242                         ACPI_EDGE_SENSITIVE},
243 
244     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
245                         ACPI_RS_OFFSET (Data.Irq.Polarity),
246                         ACPI_ACTIVE_HIGH},
247 
248     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
249                         ACPI_RS_OFFSET (Data.Irq.Sharable),
250                         ACPI_EXCLUSIVE},
251 
252     /* We can optimize to a 2-byte IrqNoFlags() descriptor */
253 
254     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ_NOFLAGS)}
255 };
256 
257 
258 /*******************************************************************************
259  *
260  * AcpiRsConvertExtIrq
261  *
262  ******************************************************************************/
263 
264 ACPI_RSCONVERT_INFO     AcpiRsConvertExtIrq[9] =
265 {
266     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_EXTENDED_IRQ,
267                         ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_IRQ),
268                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtIrq)},
269 
270     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_EXTENDED_IRQ,
271                         sizeof (AML_RESOURCE_EXTENDED_IRQ),
272                         0},
273 
274     /* Flag bits */
275 
276     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.ProducerConsumer),
277                         AML_OFFSET (ExtendedIrq.Flags),
278                         0},
279 
280     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Triggering),
281                         AML_OFFSET (ExtendedIrq.Flags),
282                         1},
283 
284     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Polarity),
285                         AML_OFFSET (ExtendedIrq.Flags),
286                         2},
287 
288     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Sharable),
289                         AML_OFFSET (ExtendedIrq.Flags),
290                         3},
291 
292     /* IRQ Table length (Byte4) */
293 
294     {ACPI_RSC_COUNT,    ACPI_RS_OFFSET (Data.ExtendedIrq.InterruptCount),
295                         AML_OFFSET (ExtendedIrq.InterruptCount),
296                         sizeof (UINT32)},
297 
298     /* Copy every IRQ in the table, each is 32 bits */
299 
300     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.ExtendedIrq.Interrupts[0]),
301                         AML_OFFSET (ExtendedIrq.Interrupts[0]),
302                         0},
303 
304     /* Optional ResourceSource (Index and String) */
305 
306     {ACPI_RSC_SOURCEX,  ACPI_RS_OFFSET (Data.ExtendedIrq.ResourceSource),
307                         ACPI_RS_OFFSET (Data.ExtendedIrq.Interrupts[0]),
308                         sizeof (AML_RESOURCE_EXTENDED_IRQ)}
309 };
310 
311 
312 /*******************************************************************************
313  *
314  * AcpiRsConvertDma
315  *
316  ******************************************************************************/
317 
318 ACPI_RSCONVERT_INFO     AcpiRsConvertDma[6] =
319 {
320     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_DMA,
321                         ACPI_RS_SIZE (ACPI_RESOURCE_DMA),
322                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertDma)},
323 
324     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_DMA,
325                         sizeof (AML_RESOURCE_DMA),
326                         0},
327 
328     /* Flags: transfer preference, bus mastering, channel speed */
329 
330     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Dma.Transfer),
331                         AML_OFFSET (Dma.Flags),
332                         0},
333 
334     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Dma.BusMaster),
335                         AML_OFFSET (Dma.Flags),
336                         2},
337 
338     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Dma.Type),
339                         AML_OFFSET (Dma.Flags),
340                         5},
341 
342     /* DMA channel mask bits */
343 
344     {ACPI_RSC_BITMASK,  ACPI_RS_OFFSET (Data.Dma.Channels[0]),
345                         AML_OFFSET (Dma.DmaChannelMask),
346                         ACPI_RS_OFFSET (Data.Dma.ChannelCount)}
347 };
348 
349