reactos/drivers/bus/acpi/acpica/resources/rsirq.c

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