sys/contrib/dev/acpica/rslist.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rslist - Linked list utilities
   4  *              $Revision: 1.62 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #define __RSLIST_C__
 118
 119 #include <contrib/dev/acpica/acpi.h>
 120 #include <contrib/dev/acpica/acresrc.h>
 121
 122 #define _COMPONENT          ACPI_RESOURCES
 123         ACPI_MODULE_NAME    ("rslist")
 124
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    AcpiRsConvertAmlToResources
 129  *
 130  * PARAMETERS:  ACPI_WALK_AML_CALLBACK
 131  *              ResourcePtr             - Pointer to the buffer that will
 132  *                                        contain the output structures
 133  *
 134  * RETURN:      Status
 135  *
 136  * DESCRIPTION: Convert an AML resource to an internal representation of the
 137  *              resource that is aligned and easier to access.
 138  *
 139  ******************************************************************************/
 140
 141 ACPI_STATUS
 142 AcpiRsConvertAmlToResources (
 143     UINT8                   *Aml,
 144     UINT32                  Length,
 145     UINT32                  Offset,
 146     UINT8                   ResourceIndex,
 147     void                    *Context)
 148 {
 149     ACPI_RESOURCE           **ResourcePtr = ACPI_CAST_INDIRECT_PTR (
 150                                 ACPI_RESOURCE, Context);
 151     ACPI_RESOURCE           *Resource;
 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     /* Convert the AML byte stream resource to a local resource struct */
 170
 171     Status = AcpiRsConvertAmlToResource (
 172                 Resource, ACPI_CAST_PTR (AML_RESOURCE, Aml),
 173                 AcpiGbl_GetResourceDispatch[ResourceIndex]);
 174     if (ACPI_FAILURE (Status))
 175     {
 176         ACPI_EXCEPTION ((AE_INFO, Status,
 177             "Could not convert AML resource (Type %X)", *Aml));
 178         return_ACPI_STATUS (Status);
 179     }
 180
 181     ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
 182         "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
 183         AcpiUtGetResourceType (Aml), Length,
 184         Resource->Length));
 185
 186     /* Point to the next structure in the output buffer */
 187
 188     *ResourcePtr = ACPI_ADD_PTR (void, Resource, Resource->Length);
 189     return_ACPI_STATUS (AE_OK);
 190 }
 191
 192
 193 /*******************************************************************************
 194  *
 195  * FUNCTION:    AcpiRsConvertResourcesToAml
 196  *
 197  * PARAMETERS:  Resource            - Pointer to the resource linked list
 198  *              AmlSizeNeeded       - Calculated size of the byte stream
 199  *                                    needed from calling AcpiRsGetAmlLength()
 200  *                                    The size of the OutputBuffer is
 201  *                                    guaranteed to be >= AmlSizeNeeded
 202  *              OutputBuffer        - Pointer to the buffer that will
 203  *                                    contain the byte stream
 204  *
 205  * RETURN:      Status
 206  *
 207  * DESCRIPTION: Takes the resource linked list and parses it, creating a
 208  *              byte stream of resources in the caller's output buffer
 209  *
 210  ******************************************************************************/
 211
 212 ACPI_STATUS
 213 AcpiRsConvertResourcesToAml (
 214     ACPI_RESOURCE           *Resource,
 215     ACPI_SIZE               AmlSizeNeeded,
 216     UINT8                   *OutputBuffer)
 217 {
 218     UINT8                   *Aml = OutputBuffer;
 219     UINT8                   *EndAml = OutputBuffer + AmlSizeNeeded;
 220     ACPI_STATUS             Status;
 221
 222
 223     ACPI_FUNCTION_TRACE (RsConvertResourcesToAml);
 224
 225
 226     /* Walk the resource descriptor list, convert each descriptor */
 227
 228     while (Aml < EndAml)
 229     {
 230         /* Validate the (internal) Resource Type */
 231
 232         if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
 233         {
 234             ACPI_ERROR ((AE_INFO,
 235                 "Invalid descriptor type (%X) in resource list",
 236                 Resource->Type));
 237             return_ACPI_STATUS (AE_BAD_DATA);
 238         }
 239
 240         /* Perform the conversion */
 241
 242         Status = AcpiRsConvertResourceToAml (Resource,
 243                     ACPI_CAST_PTR (AML_RESOURCE, Aml),
 244                     AcpiGbl_SetResourceDispatch[Resource->Type]);
 245         if (ACPI_FAILURE (Status))
 246         {
 247             ACPI_EXCEPTION ((AE_INFO, Status,
 248                 "Could not convert resource (type %X) to AML",
 249                 Resource->Type));
 250             return_ACPI_STATUS (Status);
 251         }
 252
 253         /* Perform final sanity check on the new AML resource descriptor */
 254
 255         Status = AcpiUtValidateResource (
 256                     ACPI_CAST_PTR (AML_RESOURCE, Aml), NULL);
 257         if (ACPI_FAILURE (Status))
 258         {
 259             return_ACPI_STATUS (Status);
 260         }
 261
 262         /* Check for end-of-list, normal exit */
 263
 264         if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
 265         {
 266             /* An End Tag indicates the end of the input Resource Template */
 267
 268             return_ACPI_STATUS (AE_OK);
 269         }
 270
 271         /*
 272          * Extract the total length of the new descriptor and set the
 273          * Aml to point to the next (output) resource descriptor
 274          */
 275         Aml += AcpiUtGetDescriptorLength (Aml);
 276
 277         /* Point to the next input resource descriptor */
 278
 279         Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);
 280     }
 281
 282     /* Completed buffer, but did not find an EndTag resource descriptor */
 283
 284     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
 285 }
 286