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

   1 /*******************************************************************************
   2  *
   3  * Module Name: rslist - Linked list utilities
   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    ("rslist")
 122
 123
 124 /*******************************************************************************
 125  *
 126  * FUNCTION:    AcpiRsConvertAmlToResources
 127  *
 128  * PARAMETERS:  ACPI_WALK_AML_CALLBACK
 129  *              ResourcePtr             - Pointer to the buffer that will
 130  *                                        contain the output structures
 131  *
 132  * RETURN:      Status
 133  *
 134  * DESCRIPTION: Convert an AML resource to an internal representation of the
 135  *              resource that is aligned and easier to access.
 136  *
 137  ******************************************************************************/
 138
 139 ACPI_STATUS
 140 AcpiRsConvertAmlToResources (
 141     UINT8                   *Aml,
 142     UINT32                  Length,
 143     UINT32                  Offset,
 144     UINT8                   ResourceIndex,
 145     void                    **Context)
 146 {
 147     ACPI_RESOURCE           **ResourcePtr = ACPI_CAST_INDIRECT_PTR (
 148                                 ACPI_RESOURCE, Context);
 149     ACPI_RESOURCE           *Resource;
 150     AML_RESOURCE            *AmlResource;
 151     ACPI_RSCONVERT_INFO     *ConversionTable;
 152     ACPI_STATUS             Status;
 153
 154
 155     ACPI_FUNCTION_TRACE (RsConvertAmlToResources);
 156
 157
 158     /*
 159      * Check that the input buffer and all subsequent pointers into it
 160      * are aligned on a native word boundary. Most important on IA64
 161      */
 162     Resource = *ResourcePtr;
 163     if (ACPI_IS_MISALIGNED (Resource))
 164     {
 165         ACPI_WARNING ((AE_INFO,
 166             "Misaligned resource pointer %p", Resource));
 167     }
 168
 169     /* Get the appropriate conversion info table */
 170
 171     AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml);
 172
 173     if (AcpiUtGetResourceType (Aml) ==
 174         ACPI_RESOURCE_NAME_SERIAL_BUS)
 175     {
 176         if (AmlResource->CommonSerialBus.Type >
 177             AML_RESOURCE_MAX_SERIALBUSTYPE)
 178         {
 179             ConversionTable = NULL;
 180         }
 181         else
 182         {
 183             /* This is an I2C, SPI, or UART SerialBus descriptor */
 184
 185             ConversionTable = AcpiGbl_ConvertResourceSerialBusDispatch [
 186                 AmlResource->CommonSerialBus.Type];
 187         }
 188     }
 189     else
 190     {
 191         ConversionTable = AcpiGbl_GetResourceDispatch[ResourceIndex];
 192     }
 193
 194     if (!ConversionTable)
 195     {
 196         ACPI_ERROR ((AE_INFO,
 197             "Invalid/unsupported resource descriptor: Type 0x%2.2X",
 198             ResourceIndex));
 199         return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
 200     }
 201
 202      /* Convert the AML byte stream resource to a local resource struct */
 203
 204     Status = AcpiRsConvertAmlToResource (
 205         Resource, AmlResource, ConversionTable);
 206     if (ACPI_FAILURE (Status))
 207     {
 208         ACPI_EXCEPTION ((AE_INFO, Status,
 209             "Could not convert AML resource (Type 0x%X)", *Aml));
 210         return_ACPI_STATUS (Status);
 211     }
 212
 213     ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
 214         "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
 215         AcpiUtGetResourceType (Aml), Length,
 216         Resource->Length));
 217
 218     /* Point to the next structure in the output buffer */
 219
 220     *ResourcePtr = ACPI_NEXT_RESOURCE (Resource);
 221     return_ACPI_STATUS (AE_OK);
 222 }
 223
 224
 225 /*******************************************************************************
 226  *
 227  * FUNCTION:    AcpiRsConvertResourcesToAml
 228  *
 229  * PARAMETERS:  Resource            - Pointer to the resource linked list
 230  *              AmlSizeNeeded       - Calculated size of the byte stream
 231  *                                    needed from calling AcpiRsGetAmlLength()
 232  *                                    The size of the OutputBuffer is
 233  *                                    guaranteed to be >= AmlSizeNeeded
 234  *              OutputBuffer        - Pointer to the buffer that will
 235  *                                    contain the byte stream
 236  *
 237  * RETURN:      Status
 238  *
 239  * DESCRIPTION: Takes the resource linked list and parses it, creating a
 240  *              byte stream of resources in the caller's output buffer
 241  *
 242  ******************************************************************************/
 243
 244 ACPI_STATUS
 245 AcpiRsConvertResourcesToAml (
 246     ACPI_RESOURCE           *Resource,
 247     ACPI_SIZE               AmlSizeNeeded,
 248     UINT8                   *OutputBuffer)
 249 {
 250     UINT8                   *Aml = OutputBuffer;
 251     UINT8                   *EndAml = OutputBuffer + AmlSizeNeeded;
 252     ACPI_RSCONVERT_INFO     *ConversionTable;
 253     ACPI_STATUS             Status;
 254
 255
 256     ACPI_FUNCTION_TRACE (RsConvertResourcesToAml);
 257
 258
 259     /* Walk the resource descriptor list, convert each descriptor */
 260
 261     while (Aml < EndAml)
 262     {
 263         /* Validate the (internal) Resource Type */
 264
 265         if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
 266         {
 267             ACPI_ERROR ((AE_INFO,
 268                 "Invalid descriptor type (0x%X) in resource list",
 269                 Resource->Type));
 270             return_ACPI_STATUS (AE_BAD_DATA);
 271         }
 272
 273         /* Sanity check the length. It must not be zero, or we loop forever */
 274
 275         if (!Resource->Length)
 276         {
 277             ACPI_ERROR ((AE_INFO,
 278                 "Invalid zero length descriptor in resource list\n"));
 279             return_ACPI_STATUS (AE_AML_BAD_RESOURCE_LENGTH);
 280         }
 281
 282         /* Perform the conversion */
 283
 284         if (Resource->Type == ACPI_RESOURCE_TYPE_SERIAL_BUS)
 285         {
 286             if (Resource->Data.CommonSerialBus.Type >
 287                 AML_RESOURCE_MAX_SERIALBUSTYPE)
 288             {
 289                 ConversionTable = NULL;
 290             }
 291             else
 292             {
 293                 /* This is an I2C, SPI, or UART SerialBus descriptor */
 294
 295                 ConversionTable = AcpiGbl_ConvertResourceSerialBusDispatch[
 296                     Resource->Data.CommonSerialBus.Type];
 297             }
 298         }
 299         else
 300         {
 301             ConversionTable = AcpiGbl_SetResourceDispatch[Resource->Type];
 302         }
 303
 304         if (!ConversionTable)
 305         {
 306             ACPI_ERROR ((AE_INFO,
 307                 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
 308                 Resource->Type));
 309             return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
 310         }
 311
 312         Status = AcpiRsConvertResourceToAml (Resource,
 313             ACPI_CAST_PTR (AML_RESOURCE, Aml), ConversionTable);
 314         if (ACPI_FAILURE (Status))
 315         {
 316             ACPI_EXCEPTION ((AE_INFO, Status,
 317                 "Could not convert resource (type 0x%X) to AML",
 318                 Resource->Type));
 319             return_ACPI_STATUS (Status);
 320         }
 321
 322         /* Perform final sanity check on the new AML resource descriptor */
 323
 324         Status = AcpiUtValidateResource (
 325             NULL, ACPI_CAST_PTR (AML_RESOURCE, Aml), NULL);
 326         if (ACPI_FAILURE (Status))
 327         {
 328             return_ACPI_STATUS (Status);
 329         }
 330
 331         /* Check for end-of-list, normal exit */
 332
 333         if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
 334         {
 335             /* An End Tag indicates the end of the input Resource Template */
 336
 337             return_ACPI_STATUS (AE_OK);
 338         }
 339
 340         /*
 341          * Extract the total length of the new descriptor and set the
 342          * Aml to point to the next (output) resource descriptor
 343          */
 344         Aml += AcpiUtGetDescriptorLength (Aml);
 345
 346         /* Point to the next input resource descriptor */
 347
 348         Resource = ACPI_NEXT_RESOURCE (Resource);
 349     }
 350
 351     /* Completed buffer, but did not find an EndTag resource descriptor */
 352
 353     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
 354 }