acpica/resources/rsirq.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: rsirq - IRQ resource descriptors
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acresrc.h"
0155
0156 #define _COMPONENT          ACPI_RESOURCES
0157         ACPI_MODULE_NAME    ("rsirq")
0158
0159
0160 /*******************************************************************************
0161  *
0162  * AcpiRsGetIrq
0163  *
0164  ******************************************************************************/
0165
0166 ACPI_RSCONVERT_INFO     AcpiRsGetIrq[9] =
0167 {
0168     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_IRQ,
0169                         ACPI_RS_SIZE (ACPI_RESOURCE_IRQ),
0170                         ACPI_RSC_TABLE_SIZE (AcpiRsGetIrq)},
0171
0172     /* Get the IRQ mask (bytes 1:2) */
0173
0174     {ACPI_RSC_BITMASK16,ACPI_RS_OFFSET (Data.Irq.Interrupts[0]),
0175                         AML_OFFSET (Irq.IrqMask),
0176                         ACPI_RS_OFFSET (Data.Irq.InterruptCount)},
0177
0178     /* Set default flags (others are zero) */
0179
0180     {ACPI_RSC_SET8,     ACPI_RS_OFFSET (Data.Irq.Triggering),
0181                         ACPI_EDGE_SENSITIVE,
0182                         1},
0183
0184     /* Get the descriptor length (2 or 3 for IRQ descriptor) */
0185
0186     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Irq.DescriptorLength),
0187                         AML_OFFSET (Irq.DescriptorType),
0188                         0},
0189
0190     /* All done if no flag byte present in descriptor */
0191
0192     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_AML_LENGTH, 0, 3},
0193
0194     /* Get flags: Triggering[0], Polarity[3], Sharing[4], Wake[5] */
0195
0196     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Triggering),
0197                         AML_OFFSET (Irq.Flags),
0198                         0},
0199
0200     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Polarity),
0201                         AML_OFFSET (Irq.Flags),
0202                         3},
0203
0204     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Shareable),
0205                         AML_OFFSET (Irq.Flags),
0206                         4},
0207
0208     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.WakeCapable),
0209                         AML_OFFSET (Irq.Flags),
0210                         5}
0211 };
0212
0213
0214 /*******************************************************************************
0215  *
0216  * AcpiRsSetIrq
0217  *
0218  ******************************************************************************/
0219
0220 ACPI_RSCONVERT_INFO     AcpiRsSetIrq[14] =
0221 {
0222     /* Start with a default descriptor of length 3 */
0223
0224     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_IRQ,
0225                         sizeof (AML_RESOURCE_IRQ),
0226                         ACPI_RSC_TABLE_SIZE (AcpiRsSetIrq)},
0227
0228     /* Convert interrupt list to 16-bit IRQ bitmask */
0229
0230     {ACPI_RSC_BITMASK16,ACPI_RS_OFFSET (Data.Irq.Interrupts[0]),
0231                         AML_OFFSET (Irq.IrqMask),
0232                         ACPI_RS_OFFSET (Data.Irq.InterruptCount)},
0233
0234     /* Set flags: Triggering[0], Polarity[3], Sharing[4], Wake[5] */
0235
0236     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Triggering),
0237                         AML_OFFSET (Irq.Flags),
0238                         0},
0239
0240     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Polarity),
0241                         AML_OFFSET (Irq.Flags),
0242                         3},
0243
0244     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.Shareable),
0245                         AML_OFFSET (Irq.Flags),
0246                         4},
0247
0248     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Irq.WakeCapable),
0249                         AML_OFFSET (Irq.Flags),
0250                         5},
0251
0252     /*
0253      * All done if the output descriptor length is required to be 3
0254      * (i.e., optimization to 2 bytes cannot be attempted)
0255      */
0256     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
0257                         ACPI_RS_OFFSET(Data.Irq.DescriptorLength),
0258                         3},
0259
0260     /* Set length to 2 bytes (no flags byte) */
0261
0262     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ_NOFLAGS)},
0263
0264     /*
0265      * All done if the output descriptor length is required to be 2.
0266      *
0267      * TBD: Perhaps we should check for error if input flags are not
0268      * compatible with a 2-byte descriptor.
0269      */
0270     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
0271                         ACPI_RS_OFFSET(Data.Irq.DescriptorLength),
0272                         2},
0273
0274     /* Reset length to 3 bytes (descriptor with flags byte) */
0275
0276     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ)},
0277
0278     /*
0279      * Check if the flags byte is necessary. Not needed if the flags are:
0280      * ACPI_EDGE_SENSITIVE, ACPI_ACTIVE_HIGH, ACPI_EXCLUSIVE
0281      */
0282     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
0283                         ACPI_RS_OFFSET (Data.Irq.Triggering),
0284                         ACPI_EDGE_SENSITIVE},
0285
0286     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
0287                         ACPI_RS_OFFSET (Data.Irq.Polarity),
0288                         ACPI_ACTIVE_HIGH},
0289
0290     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
0291                         ACPI_RS_OFFSET (Data.Irq.Shareable),
0292                         ACPI_EXCLUSIVE},
0293
0294     /* We can optimize to a 2-byte IrqNoFlags() descriptor */
0295
0296     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_IRQ_NOFLAGS)}
0297 };
0298
0299
0300 /*******************************************************************************
0301  *
0302  * AcpiRsConvertExtIrq
0303  *
0304  ******************************************************************************/
0305
0306 ACPI_RSCONVERT_INFO     AcpiRsConvertExtIrq[10] =
0307 {
0308     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_EXTENDED_IRQ,
0309                         ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_IRQ),
0310                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtIrq)},
0311
0312     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_EXTENDED_IRQ,
0313                         sizeof (AML_RESOURCE_EXTENDED_IRQ),
0314                         0},
0315
0316     /*
0317      * Flags: Producer/Consumer[0], Triggering[1], Polarity[2],
0318      *        Sharing[3], Wake[4]
0319      */
0320     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.ProducerConsumer),
0321                         AML_OFFSET (ExtendedIrq.Flags),
0322                         0},
0323
0324     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Triggering),
0325                         AML_OFFSET (ExtendedIrq.Flags),
0326                         1},
0327
0328     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Polarity),
0329                         AML_OFFSET (ExtendedIrq.Flags),
0330                         2},
0331
0332     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.Shareable),
0333                         AML_OFFSET (ExtendedIrq.Flags),
0334                         3},
0335
0336     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.ExtendedIrq.WakeCapable),
0337                         AML_OFFSET (ExtendedIrq.Flags),
0338                         4},
0339
0340     /* IRQ Table length (Byte4) */
0341
0342     {ACPI_RSC_COUNT,    ACPI_RS_OFFSET (Data.ExtendedIrq.InterruptCount),
0343                         AML_OFFSET (ExtendedIrq.InterruptCount),
0344                         sizeof (UINT32)},
0345
0346     /* Copy every IRQ in the table, each is 32 bits */
0347
0348     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.ExtendedIrq.Interrupts[0]),
0349                         AML_OFFSET (ExtendedIrq.Interrupts[0]),
0350                         0},
0351
0352     /* Optional ResourceSource (Index and String) */
0353
0354     {ACPI_RSC_SOURCEX,  ACPI_RS_OFFSET (Data.ExtendedIrq.ResourceSource),
0355                         ACPI_RS_OFFSET (Data.ExtendedIrq.Interrupts[0]),
0356                         sizeof (AML_RESOURCE_EXTENDED_IRQ)}
0357 };
0358
0359
0360 /*******************************************************************************
0361  *
0362  * AcpiRsConvertDma
0363  *
0364  ******************************************************************************/
0365
0366 ACPI_RSCONVERT_INFO     AcpiRsConvertDma[6] =
0367 {
0368     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_DMA,
0369                         ACPI_RS_SIZE (ACPI_RESOURCE_DMA),
0370                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertDma)},
0371
0372     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_DMA,
0373                         sizeof (AML_RESOURCE_DMA),
0374                         0},
0375
0376     /* Flags: transfer preference, bus mastering, channel speed */
0377
0378     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Dma.Transfer),
0379                         AML_OFFSET (Dma.Flags),
0380                         0},
0381
0382     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Dma.BusMaster),
0383                         AML_OFFSET (Dma.Flags),
0384                         2},
0385
0386     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Dma.Type),
0387                         AML_OFFSET (Dma.Flags),
0388                         5},
0389
0390     /* DMA channel mask bits */
0391
0392     {ACPI_RSC_BITMASK,  ACPI_RS_OFFSET (Data.Dma.Channels[0]),
0393                         AML_OFFSET (Dma.DmaChannelMask),
0394                         ACPI_RS_OFFSET (Data.Dma.ChannelCount)}
0395 };
0396
0397
0398 /*******************************************************************************
0399  *
0400  * AcpiRsConvertFixedDma
0401  *
0402  ******************************************************************************/
0403
0404 ACPI_RSCONVERT_INFO     AcpiRsConvertFixedDma[4] =
0405 {
0406     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_FIXED_DMA,
0407                         ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_DMA),
0408                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertFixedDma)},
0409
0410     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_FIXED_DMA,
0411                         sizeof (AML_RESOURCE_FIXED_DMA),
0412                         0},
0413
0414     /*
0415      * These fields are contiguous in both the source and destination:
0416      * RequestLines
0417      * Channels
0418      */
0419     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.FixedDma.RequestLines),
0420                         AML_OFFSET (FixedDma.RequestLines),
0421                         2},
0422
0423     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.FixedDma.Width),
0424                         AML_OFFSET (FixedDma.Width),
0425                         1},
0426 };