src/add-ons/kernel/bus_managers/acpi/acpica/components/resources/rsinfo.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsinfo - Dispatch and Info tables
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, 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 __RSINFO_C__
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "acresrc.h"
 121
 122 #define _COMPONENT          ACPI_RESOURCES
 123         ACPI_MODULE_NAME    ("rsinfo")
 124
 125 /*
 126  * Resource dispatch and information tables. Any new resource types (either
 127  * Large or Small) must be reflected in each of these tables, so they are here
 128  * in one place.
 129  *
 130  * The tables for Large descriptors are indexed by bits 6:0 of the AML
 131  * descriptor type byte. The tables for Small descriptors are indexed by
 132  * bits 6:3 of the descriptor byte. The tables for internal resource
 133  * descriptors are indexed by the ACPI_RESOURCE_TYPE field.
 134  */
 135
 136
 137 /* Dispatch table for resource-to-AML (Set Resource) conversion functions */
 138
 139 ACPI_RSCONVERT_INFO         *AcpiGbl_SetResourceDispatch[] =
 140 {
 141     AcpiRsSetIrq,                   /* 0x00, ACPI_RESOURCE_TYPE_IRQ */
 142     AcpiRsConvertDma,               /* 0x01, ACPI_RESOURCE_TYPE_DMA */
 143     AcpiRsSetStartDpf,              /* 0x02, ACPI_RESOURCE_TYPE_START_DEPENDENT */
 144     AcpiRsConvertEndDpf,            /* 0x03, ACPI_RESOURCE_TYPE_END_DEPENDENT */
 145     AcpiRsConvertIo,                /* 0x04, ACPI_RESOURCE_TYPE_IO */
 146     AcpiRsConvertFixedIo,           /* 0x05, ACPI_RESOURCE_TYPE_FIXED_IO */
 147     AcpiRsSetVendor,                /* 0x06, ACPI_RESOURCE_TYPE_VENDOR */
 148     AcpiRsConvertEndTag,            /* 0x07, ACPI_RESOURCE_TYPE_END_TAG */
 149     AcpiRsConvertMemory24,          /* 0x08, ACPI_RESOURCE_TYPE_MEMORY24 */
 150     AcpiRsConvertMemory32,          /* 0x09, ACPI_RESOURCE_TYPE_MEMORY32 */
 151     AcpiRsConvertFixedMemory32,     /* 0x0A, ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
 152     AcpiRsConvertAddress16,         /* 0x0B, ACPI_RESOURCE_TYPE_ADDRESS16 */
 153     AcpiRsConvertAddress32,         /* 0x0C, ACPI_RESOURCE_TYPE_ADDRESS32 */
 154     AcpiRsConvertAddress64,         /* 0x0D, ACPI_RESOURCE_TYPE_ADDRESS64 */
 155     AcpiRsConvertExtAddress64,      /* 0x0E, ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
 156     AcpiRsConvertExtIrq,            /* 0x0F, ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
 157     AcpiRsConvertGenericReg,        /* 0x10, ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
 158     AcpiRsConvertGpio,              /* 0x11, ACPI_RESOURCE_TYPE_GPIO */
 159     AcpiRsConvertFixedDma,          /* 0x12, ACPI_RESOURCE_TYPE_FIXED_DMA */
 160     NULL,                           /* 0x13, ACPI_RESOURCE_TYPE_SERIAL_BUS - Use subtype table below */
 161 };
 162
 163 /* Dispatch tables for AML-to-resource (Get Resource) conversion functions */
 164
 165 ACPI_RSCONVERT_INFO         *AcpiGbl_GetResourceDispatch[] =
 166 {
 167     /* Small descriptors */
 168
 169     NULL,                           /* 0x00, Reserved */
 170     NULL,                           /* 0x01, Reserved */
 171     NULL,                           /* 0x02, Reserved */
 172     NULL,                           /* 0x03, Reserved */
 173     AcpiRsGetIrq,                   /* 0x04, ACPI_RESOURCE_NAME_IRQ */
 174     AcpiRsConvertDma,               /* 0x05, ACPI_RESOURCE_NAME_DMA */
 175     AcpiRsGetStartDpf,              /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
 176     AcpiRsConvertEndDpf,            /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
 177     AcpiRsConvertIo,                /* 0x08, ACPI_RESOURCE_NAME_IO */
 178     AcpiRsConvertFixedIo,           /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO */
 179     AcpiRsConvertFixedDma,          /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
 180     NULL,                           /* 0x0B, Reserved */
 181     NULL,                           /* 0x0C, Reserved */
 182     NULL,                           /* 0x0D, Reserved */
 183     AcpiRsGetVendorSmall,           /* 0x0E, ACPI_RESOURCE_NAME_VENDOR_SMALL */
 184     AcpiRsConvertEndTag,            /* 0x0F, ACPI_RESOURCE_NAME_END_TAG */
 185
 186     /* Large descriptors */
 187
 188     NULL,                           /* 0x00, Reserved */
 189     AcpiRsConvertMemory24,          /* 0x01, ACPI_RESOURCE_NAME_MEMORY24 */
 190     AcpiRsConvertGenericReg,        /* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
 191     NULL,                           /* 0x03, Reserved */
 192     AcpiRsGetVendorLarge,           /* 0x04, ACPI_RESOURCE_NAME_VENDOR_LARGE */
 193     AcpiRsConvertMemory32,          /* 0x05, ACPI_RESOURCE_NAME_MEMORY32 */
 194     AcpiRsConvertFixedMemory32,     /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY32 */
 195     AcpiRsConvertAddress32,         /* 0x07, ACPI_RESOURCE_NAME_ADDRESS32 */
 196     AcpiRsConvertAddress16,         /* 0x08, ACPI_RESOURCE_NAME_ADDRESS16 */
 197     AcpiRsConvertExtIrq,            /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_IRQ */
 198     AcpiRsConvertAddress64,         /* 0x0A, ACPI_RESOURCE_NAME_ADDRESS64 */
 199     AcpiRsConvertExtAddress64,      /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 */
 200     AcpiRsConvertGpio,              /* 0x0C, ACPI_RESOURCE_NAME_GPIO */
 201     NULL,                           /* 0x0D, Reserved */
 202     NULL,                           /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS - Use subtype table below */
 203 };
 204
 205 /* Subtype table for SerialBus -- I2C, SPI, and UART */
 206
 207 ACPI_RSCONVERT_INFO         *AcpiGbl_ConvertResourceSerialBusDispatch[] =
 208 {
 209     NULL,
 210     AcpiRsConvertI2cSerialBus,
 211     AcpiRsConvertSpiSerialBus,
 212     AcpiRsConvertUartSerialBus,
 213 };
 214
 215
 216 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUGGER)
 217
 218 /* Dispatch table for resource dump functions */
 219
 220 ACPI_RSDUMP_INFO            *AcpiGbl_DumpResourceDispatch[] =
 221 {
 222     AcpiRsDumpIrq,                  /* ACPI_RESOURCE_TYPE_IRQ */
 223     AcpiRsDumpDma,                  /* ACPI_RESOURCE_TYPE_DMA */
 224     AcpiRsDumpStartDpf,             /* ACPI_RESOURCE_TYPE_START_DEPENDENT */
 225     AcpiRsDumpEndDpf,               /* ACPI_RESOURCE_TYPE_END_DEPENDENT */
 226     AcpiRsDumpIo,                   /* ACPI_RESOURCE_TYPE_IO */
 227     AcpiRsDumpFixedIo,              /* ACPI_RESOURCE_TYPE_FIXED_IO */
 228     AcpiRsDumpVendor,               /* ACPI_RESOURCE_TYPE_VENDOR */
 229     AcpiRsDumpEndTag,               /* ACPI_RESOURCE_TYPE_END_TAG */
 230     AcpiRsDumpMemory24,             /* ACPI_RESOURCE_TYPE_MEMORY24 */
 231     AcpiRsDumpMemory32,             /* ACPI_RESOURCE_TYPE_MEMORY32 */
 232     AcpiRsDumpFixedMemory32,        /* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
 233     AcpiRsDumpAddress16,            /* ACPI_RESOURCE_TYPE_ADDRESS16 */
 234     AcpiRsDumpAddress32,            /* ACPI_RESOURCE_TYPE_ADDRESS32 */
 235     AcpiRsDumpAddress64,            /* ACPI_RESOURCE_TYPE_ADDRESS64 */
 236     AcpiRsDumpExtAddress64,         /* ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
 237     AcpiRsDumpExtIrq,               /* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
 238     AcpiRsDumpGenericReg,           /* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
 239     AcpiRsDumpGpio,                 /* ACPI_RESOURCE_TYPE_GPIO */
 240     AcpiRsDumpFixedDma,             /* ACPI_RESOURCE_TYPE_FIXED_DMA */
 241     NULL,                           /* ACPI_RESOURCE_TYPE_SERIAL_BUS */
 242 };
 243
 244 ACPI_RSDUMP_INFO            *AcpiGbl_DumpSerialBusDispatch[] =
 245 {
 246     NULL,
 247     AcpiRsDumpI2cSerialBus,         /* AML_RESOURCE_I2C_BUS_TYPE */
 248     AcpiRsDumpSpiSerialBus,         /* AML_RESOURCE_SPI_BUS_TYPE */
 249     AcpiRsDumpUartSerialBus,        /* AML_RESOURCE_UART_BUS_TYPE */
 250 };
 251 #endif
 252
 253
 254 /*
 255  * Base sizes for external AML resource descriptors, indexed by internal type.
 256  * Includes size of the descriptor header (1 byte for small descriptors,
 257  * 3 bytes for large descriptors)
 258  */
 259 const UINT8                 AcpiGbl_AmlResourceSizes[] =
 260 {
 261     sizeof (AML_RESOURCE_IRQ),              /* ACPI_RESOURCE_TYPE_IRQ (optional Byte 3 always created) */
 262     sizeof (AML_RESOURCE_DMA),              /* ACPI_RESOURCE_TYPE_DMA */
 263     sizeof (AML_RESOURCE_START_DEPENDENT),  /* ACPI_RESOURCE_TYPE_START_DEPENDENT (optional Byte 1 always created) */
 264     sizeof (AML_RESOURCE_END_DEPENDENT),    /* ACPI_RESOURCE_TYPE_END_DEPENDENT */
 265     sizeof (AML_RESOURCE_IO),               /* ACPI_RESOURCE_TYPE_IO */
 266     sizeof (AML_RESOURCE_FIXED_IO),         /* ACPI_RESOURCE_TYPE_FIXED_IO */
 267     sizeof (AML_RESOURCE_VENDOR_SMALL),     /* ACPI_RESOURCE_TYPE_VENDOR */
 268     sizeof (AML_RESOURCE_END_TAG),          /* ACPI_RESOURCE_TYPE_END_TAG */
 269     sizeof (AML_RESOURCE_MEMORY24),         /* ACPI_RESOURCE_TYPE_MEMORY24 */
 270     sizeof (AML_RESOURCE_MEMORY32),         /* ACPI_RESOURCE_TYPE_MEMORY32 */
 271     sizeof (AML_RESOURCE_FIXED_MEMORY32),   /* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
 272     sizeof (AML_RESOURCE_ADDRESS16),        /* ACPI_RESOURCE_TYPE_ADDRESS16 */
 273     sizeof (AML_RESOURCE_ADDRESS32),        /* ACPI_RESOURCE_TYPE_ADDRESS32 */
 274     sizeof (AML_RESOURCE_ADDRESS64),        /* ACPI_RESOURCE_TYPE_ADDRESS64 */
 275     sizeof (AML_RESOURCE_EXTENDED_ADDRESS64),/*ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
 276     sizeof (AML_RESOURCE_EXTENDED_IRQ),     /* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
 277     sizeof (AML_RESOURCE_GENERIC_REGISTER), /* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
 278     sizeof (AML_RESOURCE_GPIO),             /* ACPI_RESOURCE_TYPE_GPIO */
 279     sizeof (AML_RESOURCE_FIXED_DMA),        /* ACPI_RESOURCE_TYPE_FIXED_DMA */
 280     sizeof (AML_RESOURCE_COMMON_SERIALBUS), /* ACPI_RESOURCE_TYPE_SERIAL_BUS */
 281 };
 282
 283
 284 const UINT8                 AcpiGbl_ResourceStructSizes[] =
 285 {
 286     /* Small descriptors */
 287
 288     0,
 289     0,
 290     0,
 291     0,
 292     ACPI_RS_SIZE (ACPI_RESOURCE_IRQ),
 293     ACPI_RS_SIZE (ACPI_RESOURCE_DMA),
 294     ACPI_RS_SIZE (ACPI_RESOURCE_START_DEPENDENT),
 295     ACPI_RS_SIZE_MIN,
 296     ACPI_RS_SIZE (ACPI_RESOURCE_IO),
 297     ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_IO),
 298     ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_DMA),
 299     0,
 300     0,
 301     0,
 302     ACPI_RS_SIZE (ACPI_RESOURCE_VENDOR),
 303     ACPI_RS_SIZE_MIN,
 304
 305     /* Large descriptors */
 306
 307     0,
 308     ACPI_RS_SIZE (ACPI_RESOURCE_MEMORY24),
 309     ACPI_RS_SIZE (ACPI_RESOURCE_GENERIC_REGISTER),
 310     0,
 311     ACPI_RS_SIZE (ACPI_RESOURCE_VENDOR),
 312     ACPI_RS_SIZE (ACPI_RESOURCE_MEMORY32),
 313     ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_MEMORY32),
 314     ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS32),
 315     ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS16),
 316     ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_IRQ),
 317     ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS64),
 318     ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_ADDRESS64),
 319     ACPI_RS_SIZE (ACPI_RESOURCE_GPIO),
 320     ACPI_RS_SIZE (ACPI_RESOURCE_COMMON_SERIALBUS)
 321 };
 322
 323 const UINT8                 AcpiGbl_AmlResourceSerialBusSizes[] =
 324 {
 325     0,
 326     sizeof (AML_RESOURCE_I2C_SERIALBUS),
 327     sizeof (AML_RESOURCE_SPI_SERIALBUS),
 328     sizeof (AML_RESOURCE_UART_SERIALBUS),
 329 };
 330
 331 const UINT8                 AcpiGbl_ResourceStructSerialBusSizes[] =
 332 {
 333     0,
 334     ACPI_RS_SIZE (ACPI_RESOURCE_I2C_SERIALBUS),
 335     ACPI_RS_SIZE (ACPI_RESOURCE_SPI_SERIALBUS),
 336     ACPI_RS_SIZE (ACPI_RESOURCE_UART_SERIALBUS),
 337 };