acpica/resources/rslist.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: rslist - Linked list utilities
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    ("rslist")
0158
0159
0160 /*******************************************************************************
0161  *
0162  * FUNCTION:    AcpiRsConvertAmlToResources
0163  *
0164  * PARAMETERS:  ACPI_WALK_AML_CALLBACK
0165  *              ResourcePtr             - Pointer to the buffer that will
0166  *                                        contain the output structures
0167  *
0168  * RETURN:      Status
0169  *
0170  * DESCRIPTION: Convert an AML resource to an internal representation of the
0171  *              resource that is aligned and easier to access.
0172  *
0173  ******************************************************************************/
0174
0175 ACPI_STATUS
0176 AcpiRsConvertAmlToResources (
0177     UINT8                   *Aml,
0178     UINT32                  Length,
0179     UINT32                  Offset,
0180     UINT8                   ResourceIndex,
0181     void                    **Context)
0182 {
0183     ACPI_RESOURCE           **ResourcePtr = ACPI_CAST_INDIRECT_PTR (
0184                                 ACPI_RESOURCE, Context);
0185     ACPI_RESOURCE           *Resource;
0186     AML_RESOURCE            *AmlResource;
0187     ACPI_RSCONVERT_INFO     *ConversionTable;
0188     ACPI_STATUS             Status;
0189
0190
0191     ACPI_FUNCTION_TRACE (RsConvertAmlToResources);
0192
0193
0194     /*
0195      * Check that the input buffer and all subsequent pointers into it
0196      * are aligned on a native word boundary. Most important on IA64
0197      */
0198     Resource = *ResourcePtr;
0199     if (ACPI_IS_MISALIGNED (Resource))
0200     {
0201         ACPI_WARNING ((AE_INFO,
0202             "Misaligned resource pointer %p", Resource));
0203     }
0204
0205     /* Get the appropriate conversion info table */
0206
0207     AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml);
0208
0209     if (AcpiUtGetResourceType (Aml) ==
0210         ACPI_RESOURCE_NAME_SERIAL_BUS)
0211     {
0212         /* Avoid undefined behavior: member access within misaligned address */
0213
0214         AML_RESOURCE_COMMON_SERIALBUS CommonSerialBus;
0215         memcpy(&CommonSerialBus, AmlResource, sizeof(CommonSerialBus));
0216
0217         if (CommonSerialBus.Type >
0218             AML_RESOURCE_MAX_SERIALBUSTYPE)
0219         {
0220             ConversionTable = NULL;
0221         }
0222         else
0223         {
0224             /* This is an I2C, SPI, UART, or CSI2 SerialBus descriptor */
0225
0226             ConversionTable = AcpiGbl_ConvertResourceSerialBusDispatch [
0227                 CommonSerialBus.Type];
0228         }
0229     }
0230     else
0231     {
0232         ConversionTable = AcpiGbl_GetResourceDispatch[ResourceIndex];
0233     }
0234
0235     if (!ConversionTable)
0236     {
0237         ACPI_ERROR ((AE_INFO,
0238             "Invalid/unsupported resource descriptor: Type 0x%2.2X",
0239             ResourceIndex));
0240         return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
0241     }
0242
0243      /* Convert the AML byte stream resource to a local resource struct */
0244
0245     Status = AcpiRsConvertAmlToResource (
0246         Resource, AmlResource, ConversionTable);
0247     if (ACPI_FAILURE (Status))
0248     {
0249         ACPI_EXCEPTION ((AE_INFO, Status,
0250             "Could not convert AML resource (Type 0x%X)", *Aml));
0251         return_ACPI_STATUS (Status);
0252     }
0253
0254     if (!Resource->Length)
0255     {
0256         ACPI_EXCEPTION ((AE_INFO, Status,
0257             "Zero-length resource returned from RsConvertAmlToResource"));
0258     }
0259
0260     ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
0261         "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
0262         AcpiUtGetResourceType (Aml), Length,
0263         Resource->Length));
0264
0265     /* Point to the next structure in the output buffer */
0266
0267     *ResourcePtr = ACPI_NEXT_RESOURCE (Resource);
0268     return_ACPI_STATUS (AE_OK);
0269 }
0270
0271
0272 /*******************************************************************************
0273  *
0274  * FUNCTION:    AcpiRsConvertResourcesToAml
0275  *
0276  * PARAMETERS:  Resource            - Pointer to the resource linked list
0277  *              AmlSizeNeeded       - Calculated size of the byte stream
0278  *                                    needed from calling AcpiRsGetAmlLength()
0279  *                                    The size of the OutputBuffer is
0280  *                                    guaranteed to be >= AmlSizeNeeded
0281  *              OutputBuffer        - Pointer to the buffer that will
0282  *                                    contain the byte stream
0283  *
0284  * RETURN:      Status
0285  *
0286  * DESCRIPTION: Takes the resource linked list and parses it, creating a
0287  *              byte stream of resources in the caller's output buffer
0288  *
0289  ******************************************************************************/
0290
0291 ACPI_STATUS
0292 AcpiRsConvertResourcesToAml (
0293     ACPI_RESOURCE           *Resource,
0294     ACPI_SIZE               AmlSizeNeeded,
0295     UINT8                   *OutputBuffer)
0296 {
0297     UINT8                   *Aml = OutputBuffer;
0298     UINT8                   *EndAml = OutputBuffer + AmlSizeNeeded;
0299     ACPI_RSCONVERT_INFO     *ConversionTable;
0300     ACPI_STATUS             Status;
0301
0302
0303     ACPI_FUNCTION_TRACE (RsConvertResourcesToAml);
0304
0305
0306     /* Walk the resource descriptor list, convert each descriptor */
0307
0308     while (Aml < EndAml)
0309     {
0310         /* Validate the (internal) Resource Type */
0311
0312         if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
0313         {
0314             ACPI_ERROR ((AE_INFO,
0315                 "Invalid descriptor type (0x%X) in resource list",
0316                 Resource->Type));
0317             return_ACPI_STATUS (AE_BAD_DATA);
0318         }
0319
0320         /* Sanity check the length. It must not be zero, or we loop forever */
0321
0322         if (!Resource->Length)
0323         {
0324             ACPI_ERROR ((AE_INFO,
0325                 "Invalid zero length descriptor in resource list\n"));
0326             return_ACPI_STATUS (AE_AML_BAD_RESOURCE_LENGTH);
0327         }
0328
0329         /* Perform the conversion */
0330
0331         if (Resource->Type == ACPI_RESOURCE_TYPE_SERIAL_BUS)
0332         {
0333             if (Resource->Data.CommonSerialBus.Type >
0334                 AML_RESOURCE_MAX_SERIALBUSTYPE)
0335             {
0336                 ConversionTable = NULL;
0337             }
0338             else
0339             {
0340                 /* This is an I2C, SPI, UART or CSI2 SerialBus descriptor */
0341
0342                 ConversionTable = AcpiGbl_ConvertResourceSerialBusDispatch[
0343                     Resource->Data.CommonSerialBus.Type];
0344             }
0345         }
0346         else
0347         {
0348             ConversionTable = AcpiGbl_SetResourceDispatch[Resource->Type];
0349         }
0350
0351         if (!ConversionTable)
0352         {
0353             ACPI_ERROR ((AE_INFO,
0354                 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
0355                 Resource->Type));
0356             return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
0357         }
0358
0359         Status = AcpiRsConvertResourceToAml (Resource,
0360             ACPI_CAST_PTR (AML_RESOURCE, Aml), ConversionTable);
0361         if (ACPI_FAILURE (Status))
0362         {
0363             ACPI_EXCEPTION ((AE_INFO, Status,
0364                 "Could not convert resource (type 0x%X) to AML",
0365                 Resource->Type));
0366             return_ACPI_STATUS (Status);
0367         }
0368
0369         /* Perform final sanity check on the new AML resource descriptor */
0370
0371         Status = AcpiUtValidateResource (
0372             NULL, ACPI_CAST_PTR (AML_RESOURCE, Aml), NULL);
0373         if (ACPI_FAILURE (Status))
0374         {
0375             return_ACPI_STATUS (Status);
0376         }
0377
0378         /* Check for end-of-list, normal exit */
0379
0380         if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
0381         {
0382             /* An End Tag indicates the end of the input Resource Template */
0383
0384             return_ACPI_STATUS (AE_OK);
0385         }
0386
0387         /*
0388          * Extract the total length of the new descriptor and set the
0389          * Aml to point to the next (output) resource descriptor
0390          */
0391         Aml += AcpiUtGetDescriptorLength (Aml);
0392
0393         /* Point to the next input resource descriptor */
0394
0395         Resource = ACPI_NEXT_RESOURCE (Resource);
0396     }
0397
0398     /* Completed buffer, but did not find an EndTag resource descriptor */
0399
0400     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
0401 }