drivers/acpica/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 - 2009, 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 #define __RSLIST_C__
0117
0118 #include "acpi.h"
0119 #include "accommon.h"
0120 #include "acresrc.h"
0121
0122 #define _COMPONENT          ACPI_RESOURCES
0123         ACPI_MODULE_NAME    ("rslist")
0124
0125
0126 /*******************************************************************************
0127  *
0128  * FUNCTION:    AcpiRsConvertAmlToResources
0129  *
0130  * PARAMETERS:  ACPI_WALK_AML_CALLBACK
0131  *              ResourcePtr             - Pointer to the buffer that will
0132  *                                        contain the output structures
0133  *
0134  * RETURN:      Status
0135  *
0136  * DESCRIPTION: Convert an AML resource to an internal representation of the
0137  *              resource that is aligned and easier to access.
0138  *
0139  ******************************************************************************/
0140
0141 ACPI_STATUS
0142 AcpiRsConvertAmlToResources (
0143     UINT8                   *Aml,
0144     UINT32                  Length,
0145     UINT32                  Offset,
0146     UINT8                   ResourceIndex,
0147     void                    *Context)
0148 {
0149     ACPI_RESOURCE           **ResourcePtr = ACPI_CAST_INDIRECT_PTR (
0150                                 ACPI_RESOURCE, Context);
0151     ACPI_RESOURCE           *Resource;
0152     ACPI_STATUS             Status;
0153
0154
0155     ACPI_FUNCTION_TRACE (RsConvertAmlToResources);
0156
0157
0158     /*
0159      * Check that the input buffer and all subsequent pointers into it
0160      * are aligned on a native word boundary. Most important on IA64
0161      */
0162     Resource = *ResourcePtr;
0163     if (ACPI_IS_MISALIGNED (Resource))
0164     {
0165         ACPI_WARNING ((AE_INFO,
0166             "Misaligned resource pointer %p", Resource));
0167     }
0168
0169     /* Convert the AML byte stream resource to a local resource struct */
0170
0171     Status = AcpiRsConvertAmlToResource (
0172                 Resource, ACPI_CAST_PTR (AML_RESOURCE, Aml),
0173                 AcpiGbl_GetResourceDispatch[ResourceIndex]);
0174     if (ACPI_FAILURE (Status))
0175     {
0176         ACPI_EXCEPTION ((AE_INFO, Status,
0177             "Could not convert AML resource (Type %X)", *Aml));
0178         return_ACPI_STATUS (Status);
0179     }
0180
0181     ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
0182         "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
0183         AcpiUtGetResourceType (Aml), Length,
0184         Resource->Length));
0185
0186     /* Point to the next structure in the output buffer */
0187
0188     *ResourcePtr = ACPI_ADD_PTR (void, Resource, Resource->Length);
0189     return_ACPI_STATUS (AE_OK);
0190 }
0191
0192
0193 /*******************************************************************************
0194  *
0195  * FUNCTION:    AcpiRsConvertResourcesToAml
0196  *
0197  * PARAMETERS:  Resource            - Pointer to the resource linked list
0198  *              AmlSizeNeeded       - Calculated size of the byte stream
0199  *                                    needed from calling AcpiRsGetAmlLength()
0200  *                                    The size of the OutputBuffer is
0201  *                                    guaranteed to be >= AmlSizeNeeded
0202  *              OutputBuffer        - Pointer to the buffer that will
0203  *                                    contain the byte stream
0204  *
0205  * RETURN:      Status
0206  *
0207  * DESCRIPTION: Takes the resource linked list and parses it, creating a
0208  *              byte stream of resources in the caller's output buffer
0209  *
0210  ******************************************************************************/
0211
0212 ACPI_STATUS
0213 AcpiRsConvertResourcesToAml (
0214     ACPI_RESOURCE           *Resource,
0215     ACPI_SIZE               AmlSizeNeeded,
0216     UINT8                   *OutputBuffer)
0217 {
0218     UINT8                   *Aml = OutputBuffer;
0219     UINT8                   *EndAml = OutputBuffer + AmlSizeNeeded;
0220     ACPI_STATUS             Status;
0221
0222
0223     ACPI_FUNCTION_TRACE (RsConvertResourcesToAml);
0224
0225
0226     /* Walk the resource descriptor list, convert each descriptor */
0227
0228     while (Aml < EndAml)
0229     {
0230         /* Validate the (internal) Resource Type */
0231
0232         if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
0233         {
0234             ACPI_ERROR ((AE_INFO,
0235                 "Invalid descriptor type (%X) in resource list",
0236                 Resource->Type));
0237             return_ACPI_STATUS (AE_BAD_DATA);
0238         }
0239
0240         /* Perform the conversion */
0241
0242         Status = AcpiRsConvertResourceToAml (Resource,
0243                     ACPI_CAST_PTR (AML_RESOURCE, Aml),
0244                     AcpiGbl_SetResourceDispatch[Resource->Type]);
0245         if (ACPI_FAILURE (Status))
0246         {
0247             ACPI_EXCEPTION ((AE_INFO, Status,
0248                 "Could not convert resource (type %X) to AML",
0249                 Resource->Type));
0250             return_ACPI_STATUS (Status);
0251         }
0252
0253         /* Perform final sanity check on the new AML resource descriptor */
0254
0255         Status = AcpiUtValidateResource (
0256                     ACPI_CAST_PTR (AML_RESOURCE, Aml), NULL);
0257         if (ACPI_FAILURE (Status))
0258         {
0259             return_ACPI_STATUS (Status);
0260         }
0261
0262         /* Check for end-of-list, normal exit */
0263
0264         if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
0265         {
0266             /* An End Tag indicates the end of the input Resource Template */
0267
0268             return_ACPI_STATUS (AE_OK);
0269         }
0270
0271         /*
0272          * Extract the total length of the new descriptor and set the
0273          * Aml to point to the next (output) resource descriptor
0274          */
0275         Aml += AcpiUtGetDescriptorLength (Aml);
0276
0277         /* Point to the next input resource descriptor */
0278
0279         Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);
0280     }
0281
0282     /* Completed buffer, but did not find an EndTag resource descriptor */
0283
0284     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
0285 }
0286