The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/utilities/utresrc.c

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*******************************************************************************
    2  *
    3  * Module Name: utresrc - Resource management utilities
    4  *
    5  ******************************************************************************/
    6 
    7 /******************************************************************************
    8  *
    9  * 1. Copyright Notice
   10  *
   11  * Some or all of this work - Copyright (c) 1999 - 2022, 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  * Alternatively, you may choose to be licensed under the terms of the
  117  * following license:
  118  *
  119  * Redistribution and use in source and binary forms, with or without
  120  * modification, are permitted provided that the following conditions
  121  * are met:
  122  * 1. Redistributions of source code must retain the above copyright
  123  *    notice, this list of conditions, and the following disclaimer,
  124  *    without modification.
  125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  126  *    substantially similar to the "NO WARRANTY" disclaimer below
  127  *    ("Disclaimer") and any redistribution must be conditioned upon
  128  *    including a substantially similar Disclaimer requirement for further
  129  *    binary redistribution.
  130  * 3. Neither the names of the above-listed copyright holders nor the names
  131  *    of any contributors may be used to endorse or promote products derived
  132  *    from this software without specific prior written permission.
  133  *
  134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  145  *
  146  * Alternatively, you may choose to be licensed under the terms of the
  147  * GNU General Public License ("GPL") version 2 as published by the Free
  148  * Software Foundation.
  149  *
  150  *****************************************************************************/
  151 
  152 #include <contrib/dev/acpica/include/acpi.h>
  153 #include <contrib/dev/acpica/include/accommon.h>
  154 #include <contrib/dev/acpica/include/acresrc.h>
  155 
  156 
  157 #define _COMPONENT          ACPI_UTILITIES
  158         ACPI_MODULE_NAME    ("utresrc")
  159 
  160 
  161 /*
  162  * Base sizes of the raw AML resource descriptors, indexed by resource type.
  163  * Zero indicates a reserved (and therefore invalid) resource type.
  164  */
  165 const UINT8                 AcpiGbl_ResourceAmlSizes[] =
  166 {
  167     /* Small descriptors */
  168 
  169     0,
  170     0,
  171     0,
  172     0,
  173     ACPI_AML_SIZE_SMALL (AML_RESOURCE_IRQ),
  174     ACPI_AML_SIZE_SMALL (AML_RESOURCE_DMA),
  175     ACPI_AML_SIZE_SMALL (AML_RESOURCE_START_DEPENDENT),
  176     ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_DEPENDENT),
  177     ACPI_AML_SIZE_SMALL (AML_RESOURCE_IO),
  178     ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_IO),
  179     ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_DMA),
  180     0,
  181     0,
  182     0,
  183     ACPI_AML_SIZE_SMALL (AML_RESOURCE_VENDOR_SMALL),
  184     ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_TAG),
  185 
  186     /* Large descriptors */
  187 
  188     0,
  189     ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY24),
  190     ACPI_AML_SIZE_LARGE (AML_RESOURCE_GENERIC_REGISTER),
  191     0,
  192     ACPI_AML_SIZE_LARGE (AML_RESOURCE_VENDOR_LARGE),
  193     ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY32),
  194     ACPI_AML_SIZE_LARGE (AML_RESOURCE_FIXED_MEMORY32),
  195     ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS32),
  196     ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS16),
  197     ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_IRQ),
  198     ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS64),
  199     ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_ADDRESS64),
  200     ACPI_AML_SIZE_LARGE (AML_RESOURCE_GPIO),
  201     ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_FUNCTION),
  202     ACPI_AML_SIZE_LARGE (AML_RESOURCE_COMMON_SERIALBUS),
  203     ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_CONFIG),
  204     ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP),
  205     ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP_FUNCTION),
  206     ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP_CONFIG),
  207 };
  208 
  209 const UINT8                 AcpiGbl_ResourceAmlSerialBusSizes[] =
  210 {
  211     0,
  212     ACPI_AML_SIZE_LARGE (AML_RESOURCE_I2C_SERIALBUS),
  213     ACPI_AML_SIZE_LARGE (AML_RESOURCE_SPI_SERIALBUS),
  214     ACPI_AML_SIZE_LARGE (AML_RESOURCE_UART_SERIALBUS),
  215     ACPI_AML_SIZE_LARGE (AML_RESOURCE_CSI2_SERIALBUS),
  216 };
  217 
  218 
  219 /*
  220  * Resource types, used to validate the resource length field.
  221  * The length of fixed-length types must match exactly, variable
  222  * lengths must meet the minimum required length, etc.
  223  * Zero indicates a reserved (and therefore invalid) resource type.
  224  */
  225 static const UINT8          AcpiGbl_ResourceTypes[] =
  226 {
  227     /* Small descriptors */
  228 
  229     0,
  230     0,
  231     0,
  232     0,
  233     ACPI_SMALL_VARIABLE_LENGTH,     /* 04 IRQ */
  234     ACPI_FIXED_LENGTH,              /* 05 DMA */
  235     ACPI_SMALL_VARIABLE_LENGTH,     /* 06 StartDependentFunctions */
  236     ACPI_FIXED_LENGTH,              /* 07 EndDependentFunctions */
  237     ACPI_FIXED_LENGTH,              /* 08 IO */
  238     ACPI_FIXED_LENGTH,              /* 09 FixedIO */
  239     ACPI_FIXED_LENGTH,              /* 0A FixedDMA */
  240     0,
  241     0,
  242     0,
  243     ACPI_VARIABLE_LENGTH,           /* 0E VendorShort */
  244     ACPI_FIXED_LENGTH,              /* 0F EndTag */
  245 
  246     /* Large descriptors */
  247 
  248     0,
  249     ACPI_FIXED_LENGTH,              /* 01 Memory24 */
  250     ACPI_FIXED_LENGTH,              /* 02 GenericRegister */
  251     0,
  252     ACPI_VARIABLE_LENGTH,           /* 04 VendorLong */
  253     ACPI_FIXED_LENGTH,              /* 05 Memory32 */
  254     ACPI_FIXED_LENGTH,              /* 06 Memory32Fixed */
  255     ACPI_VARIABLE_LENGTH,           /* 07 Dword* address */
  256     ACPI_VARIABLE_LENGTH,           /* 08 Word* address */
  257     ACPI_VARIABLE_LENGTH,           /* 09 ExtendedIRQ */
  258     ACPI_VARIABLE_LENGTH,           /* 0A Qword* address */
  259     ACPI_FIXED_LENGTH,              /* 0B Extended* address */
  260     ACPI_VARIABLE_LENGTH,           /* 0C Gpio* */
  261     ACPI_VARIABLE_LENGTH,           /* 0D PinFunction */
  262     ACPI_VARIABLE_LENGTH,           /* 0E *SerialBus */
  263     ACPI_VARIABLE_LENGTH,           /* 0F PinConfig */
  264     ACPI_VARIABLE_LENGTH,           /* 10 PinGroup */
  265     ACPI_VARIABLE_LENGTH,           /* 11 PinGroupFunction */
  266     ACPI_VARIABLE_LENGTH,           /* 12 PinGroupConfig */
  267 };
  268 
  269 
  270 /*******************************************************************************
  271  *
  272  * FUNCTION:    AcpiUtWalkAmlResources
  273  *
  274  * PARAMETERS:  WalkState           - Current walk info
  275  * PARAMETERS:  Aml                 - Pointer to the raw AML resource template
  276  *              AmlLength           - Length of the entire template
  277  *              UserFunction        - Called once for each descriptor found. If
  278  *                                    NULL, a pointer to the EndTag is returned
  279  *              Context             - Passed to UserFunction
  280  *
  281  * RETURN:      Status
  282  *
  283  * DESCRIPTION: Walk a raw AML resource list(buffer). User function called
  284  *              once for each resource found.
  285  *
  286  ******************************************************************************/
  287 
  288 ACPI_STATUS
  289 AcpiUtWalkAmlResources (
  290     ACPI_WALK_STATE         *WalkState,
  291     UINT8                   *Aml,
  292     ACPI_SIZE               AmlLength,
  293     ACPI_WALK_AML_CALLBACK  UserFunction,
  294     void                    **Context)
  295 {
  296     ACPI_STATUS             Status;
  297     UINT8                   *EndAml;
  298     UINT8                   ResourceIndex;
  299     UINT32                  Length;
  300     UINT32                  Offset = 0;
  301     UINT8                   EndTag[2] = {0x79, 0x00};
  302 
  303 
  304     ACPI_FUNCTION_TRACE (UtWalkAmlResources);
  305 
  306 
  307     /* The absolute minimum resource template is one EndTag descriptor */
  308 
  309     if (AmlLength < sizeof (AML_RESOURCE_END_TAG))
  310     {
  311         return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
  312     }
  313 
  314     /* Point to the end of the resource template buffer */
  315 
  316     EndAml = Aml + AmlLength;
  317 
  318     /* Walk the byte list, abort on any invalid descriptor type or length */
  319 
  320     while (Aml < EndAml)
  321     {
  322         /* Validate the Resource Type and Resource Length */
  323 
  324         Status = AcpiUtValidateResource (WalkState, Aml, &ResourceIndex);
  325         if (ACPI_FAILURE (Status))
  326         {
  327             /*
  328              * Exit on failure. Cannot continue because the descriptor
  329              * length may be bogus also.
  330              */
  331             return_ACPI_STATUS (Status);
  332         }
  333 
  334         /* Get the length of this descriptor */
  335 
  336         Length = AcpiUtGetDescriptorLength (Aml);
  337 
  338         /* Invoke the user function */
  339 
  340         if (UserFunction)
  341         {
  342             Status = UserFunction (
  343                 Aml, Length, Offset, ResourceIndex, Context);
  344             if (ACPI_FAILURE (Status))
  345             {
  346                 return_ACPI_STATUS (Status);
  347             }
  348         }
  349 
  350         /* An EndTag descriptor terminates this resource template */
  351 
  352         if (AcpiUtGetResourceType (Aml) == ACPI_RESOURCE_NAME_END_TAG)
  353         {
  354             /*
  355              * There must be at least one more byte in the buffer for
  356              * the 2nd byte of the EndTag
  357              */
  358             if ((Aml + 1) >= EndAml)
  359             {
  360                 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
  361             }
  362 
  363             /*
  364              * Don't attempt to perform any validation on the 2nd byte.
  365              * Although all known ASL compilers insert a zero for the 2nd
  366              * byte, it can also be a checksum (as per the ACPI spec),
  367              * and this is occasionally seen in the field. July 2017.
  368              */
  369 
  370             /* Return the pointer to the EndTag if requested */
  371 
  372             if (!UserFunction)
  373             {
  374                 *Context = Aml;
  375             }
  376 
  377             /* Normal exit */
  378 
  379             return_ACPI_STATUS (AE_OK);
  380         }
  381 
  382         Aml += Length;
  383         Offset += Length;
  384     }
  385 
  386     /* Did not find an EndTag descriptor */
  387 
  388     if (UserFunction)
  389     {
  390         /* Insert an EndTag anyway. AcpiRsGetListLength always leaves room */
  391 
  392         (void) AcpiUtValidateResource (WalkState, EndTag, &ResourceIndex);
  393         Status = UserFunction (EndTag, 2, Offset, ResourceIndex, Context);
  394         if (ACPI_FAILURE (Status))
  395         {
  396             return_ACPI_STATUS (Status);
  397         }
  398     }
  399 
  400     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
  401 }
  402 
  403 
  404 /*******************************************************************************
  405  *
  406  * FUNCTION:    AcpiUtValidateResource
  407  *
  408  * PARAMETERS:  WalkState           - Current walk info
  409  *              Aml                 - Pointer to the raw AML resource descriptor
  410  *              ReturnIndex         - Where the resource index is returned. NULL
  411  *                                    if the index is not required.
  412  *
  413  * RETURN:      Status, and optionally the Index into the global resource tables
  414  *
  415  * DESCRIPTION: Validate an AML resource descriptor by checking the Resource
  416  *              Type and Resource Length. Returns an index into the global
  417  *              resource information/dispatch tables for later use.
  418  *
  419  ******************************************************************************/
  420 
  421 ACPI_STATUS
  422 AcpiUtValidateResource (
  423     ACPI_WALK_STATE         *WalkState,
  424     void                    *Aml,
  425     UINT8                   *ReturnIndex)
  426 {
  427     AML_RESOURCE            *AmlResource;
  428     UINT8                   ResourceType;
  429     UINT8                   ResourceIndex;
  430     ACPI_RS_LENGTH          ResourceLength;
  431     ACPI_RS_LENGTH          MinimumResourceLength;
  432 
  433 
  434     ACPI_FUNCTION_ENTRY ();
  435 
  436 
  437     /*
  438      * 1) Validate the ResourceType field (Byte 0)
  439      */
  440     ResourceType = ACPI_GET8 (Aml);
  441 
  442     /*
  443      * Byte 0 contains the descriptor name (Resource Type)
  444      * Examine the large/small bit in the resource header
  445      */
  446     if (ResourceType & ACPI_RESOURCE_NAME_LARGE)
  447     {
  448         /* Verify the large resource type (name) against the max */
  449 
  450         if (ResourceType > ACPI_RESOURCE_NAME_LARGE_MAX)
  451         {
  452             goto InvalidResource;
  453         }
  454 
  455         /*
  456          * Large Resource Type -- bits 6:0 contain the name
  457          * Translate range 0x80-0x8B to index range 0x10-0x1B
  458          */
  459         ResourceIndex = (UINT8) (ResourceType - 0x70);
  460     }
  461     else
  462     {
  463         /*
  464          * Small Resource Type -- bits 6:3 contain the name
  465          * Shift range to index range 0x00-0x0F
  466          */
  467         ResourceIndex = (UINT8)
  468             ((ResourceType & ACPI_RESOURCE_NAME_SMALL_MASK) >> 3);
  469     }
  470 
  471     /*
  472      * Check validity of the resource type, via AcpiGbl_ResourceTypes.
  473      * Zero indicates an invalid resource.
  474      */
  475     if (!AcpiGbl_ResourceTypes[ResourceIndex])
  476     {
  477         goto InvalidResource;
  478     }
  479 
  480     /*
  481      * Validate the ResourceLength field. This ensures that the length
  482      * is at least reasonable, and guarantees that it is non-zero.
  483      */
  484     ResourceLength = AcpiUtGetResourceLength (Aml);
  485     MinimumResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex];
  486 
  487     /* Validate based upon the type of resource - fixed length or variable */
  488 
  489     switch (AcpiGbl_ResourceTypes[ResourceIndex])
  490     {
  491     case ACPI_FIXED_LENGTH:
  492 
  493         /* Fixed length resource, length must match exactly */
  494 
  495         if (ResourceLength != MinimumResourceLength)
  496         {
  497             goto BadResourceLength;
  498         }
  499         break;
  500 
  501     case ACPI_VARIABLE_LENGTH:
  502 
  503         /* Variable length resource, length must be at least the minimum */
  504 
  505         if (ResourceLength < MinimumResourceLength)
  506         {
  507             goto BadResourceLength;
  508         }
  509         break;
  510 
  511     case ACPI_SMALL_VARIABLE_LENGTH:
  512 
  513         /* Small variable length resource, length can be (Min) or (Min-1) */
  514 
  515         if ((ResourceLength > MinimumResourceLength) ||
  516             (ResourceLength < (MinimumResourceLength - 1)))
  517         {
  518             goto BadResourceLength;
  519         }
  520         break;
  521 
  522     default:
  523 
  524         /* Shouldn't happen (because of validation earlier), but be sure */
  525 
  526         goto InvalidResource;
  527     }
  528 
  529     AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml);
  530     if (ResourceType == ACPI_RESOURCE_NAME_SERIAL_BUS)
  531     {
  532         /* Validate the BusType field */
  533 
  534         if ((AmlResource->CommonSerialBus.Type == 0) ||
  535             (AmlResource->CommonSerialBus.Type > AML_RESOURCE_MAX_SERIALBUSTYPE))
  536         {
  537             if (WalkState)
  538             {
  539                 ACPI_ERROR ((AE_INFO,
  540                     "Invalid/unsupported SerialBus resource descriptor: BusType 0x%2.2X",
  541                     AmlResource->CommonSerialBus.Type));
  542             }
  543             return (AE_AML_INVALID_RESOURCE_TYPE);
  544         }
  545     }
  546 
  547     /* Optionally return the resource table index */
  548 
  549     if (ReturnIndex)
  550     {
  551         *ReturnIndex = ResourceIndex;
  552     }
  553 
  554     return (AE_OK);
  555 
  556 
  557 InvalidResource:
  558 
  559     if (WalkState)
  560     {
  561         ACPI_ERROR ((AE_INFO,
  562             "Invalid/unsupported resource descriptor: Type 0x%2.2X",
  563             ResourceType));
  564     }
  565     return (AE_AML_INVALID_RESOURCE_TYPE);
  566 
  567 BadResourceLength:
  568 
  569     if (WalkState)
  570     {
  571         ACPI_ERROR ((AE_INFO,
  572             "Invalid resource descriptor length: Type "
  573             "0x%2.2X, Length 0x%4.4X, MinLength 0x%4.4X",
  574             ResourceType, ResourceLength, MinimumResourceLength));
  575     }
  576     return (AE_AML_BAD_RESOURCE_LENGTH);
  577 }
  578 
  579 
  580 /*******************************************************************************
  581  *
  582  * FUNCTION:    AcpiUtGetResourceType
  583  *
  584  * PARAMETERS:  Aml             - Pointer to the raw AML resource descriptor
  585  *
  586  * RETURN:      The Resource Type with no extraneous bits (except the
  587  *              Large/Small descriptor bit -- this is left alone)
  588  *
  589  * DESCRIPTION: Extract the Resource Type/Name from the first byte of
  590  *              a resource descriptor.
  591  *
  592  ******************************************************************************/
  593 
  594 UINT8
  595 AcpiUtGetResourceType (
  596     void                    *Aml)
  597 {
  598     ACPI_FUNCTION_ENTRY ();
  599 
  600 
  601     /*
  602      * Byte 0 contains the descriptor name (Resource Type)
  603      * Examine the large/small bit in the resource header
  604      */
  605     if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
  606     {
  607         /* Large Resource Type -- bits 6:0 contain the name */
  608 
  609         return (ACPI_GET8 (Aml));
  610     }
  611     else
  612     {
  613         /* Small Resource Type -- bits 6:3 contain the name */
  614 
  615         return ((UINT8) (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_SMALL_MASK));
  616     }
  617 }
  618 
  619 
  620 /*******************************************************************************
  621  *
  622  * FUNCTION:    AcpiUtGetResourceLength
  623  *
  624  * PARAMETERS:  Aml             - Pointer to the raw AML resource descriptor
  625  *
  626  * RETURN:      Byte Length
  627  *
  628  * DESCRIPTION: Get the "Resource Length" of a raw AML descriptor. By
  629  *              definition, this does not include the size of the descriptor
  630  *              header or the length field itself.
  631  *
  632  ******************************************************************************/
  633 
  634 UINT16
  635 AcpiUtGetResourceLength (
  636     void                    *Aml)
  637 {
  638     ACPI_RS_LENGTH          ResourceLength;
  639 
  640 
  641     ACPI_FUNCTION_ENTRY ();
  642 
  643 
  644     /*
  645      * Byte 0 contains the descriptor name (Resource Type)
  646      * Examine the large/small bit in the resource header
  647      */
  648     if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
  649     {
  650         /* Large Resource type -- bytes 1-2 contain the 16-bit length */
  651 
  652         ACPI_MOVE_16_TO_16 (&ResourceLength, ACPI_ADD_PTR (UINT8, Aml, 1));
  653 
  654     }
  655     else
  656     {
  657         /* Small Resource type -- bits 2:0 of byte 0 contain the length */
  658 
  659         ResourceLength = (UINT16) (ACPI_GET8 (Aml) &
  660             ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK);
  661     }
  662 
  663     return (ResourceLength);
  664 }
  665 
  666 
  667 /*******************************************************************************
  668  *
  669  * FUNCTION:    AcpiUtGetResourceHeaderLength
  670  *
  671  * PARAMETERS:  Aml             - Pointer to the raw AML resource descriptor
  672  *
  673  * RETURN:      Length of the AML header (depends on large/small descriptor)
  674  *
  675  * DESCRIPTION: Get the length of the header for this resource.
  676  *
  677  ******************************************************************************/
  678 
  679 UINT8
  680 AcpiUtGetResourceHeaderLength (
  681     void                    *Aml)
  682 {
  683     ACPI_FUNCTION_ENTRY ();
  684 
  685 
  686     /* Examine the large/small bit in the resource header */
  687 
  688     if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
  689     {
  690         return (sizeof (AML_RESOURCE_LARGE_HEADER));
  691     }
  692     else
  693     {
  694         return (sizeof (AML_RESOURCE_SMALL_HEADER));
  695     }
  696 }
  697 
  698 
  699 /*******************************************************************************
  700  *
  701  * FUNCTION:    AcpiUtGetDescriptorLength
  702  *
  703  * PARAMETERS:  Aml             - Pointer to the raw AML resource descriptor
  704  *
  705  * RETURN:      Byte length
  706  *
  707  * DESCRIPTION: Get the total byte length of a raw AML descriptor, including the
  708  *              length of the descriptor header and the length field itself.
  709  *              Used to walk descriptor lists.
  710  *
  711  ******************************************************************************/
  712 
  713 UINT32
  714 AcpiUtGetDescriptorLength (
  715     void                    *Aml)
  716 {
  717     ACPI_FUNCTION_ENTRY ();
  718 
  719 
  720     /*
  721      * Get the Resource Length (does not include header length) and add
  722      * the header length (depends on if this is a small or large resource)
  723      */
  724     return (AcpiUtGetResourceLength (Aml) +
  725         AcpiUtGetResourceHeaderLength (Aml));
  726 }
  727 
  728 
  729 /*******************************************************************************
  730  *
  731  * FUNCTION:    AcpiUtGetResourceEndTag
  732  *
  733  * PARAMETERS:  ObjDesc         - The resource template buffer object
  734  *              EndTag          - Where the pointer to the EndTag is returned
  735  *
  736  * RETURN:      Status, pointer to the end tag
  737  *
  738  * DESCRIPTION: Find the EndTag resource descriptor in an AML resource template
  739  *              Note: allows a buffer length of zero.
  740  *
  741  ******************************************************************************/
  742 
  743 ACPI_STATUS
  744 AcpiUtGetResourceEndTag (
  745     ACPI_OPERAND_OBJECT     *ObjDesc,
  746     UINT8                   **EndTag)
  747 {
  748     ACPI_STATUS             Status;
  749 
  750 
  751     ACPI_FUNCTION_TRACE (UtGetResourceEndTag);
  752 
  753 
  754     /* Allow a buffer length of zero */
  755 
  756     if (!ObjDesc->Buffer.Length)
  757     {
  758         *EndTag = ObjDesc->Buffer.Pointer;
  759         return_ACPI_STATUS (AE_OK);
  760     }
  761 
  762     /* Validate the template and get a pointer to the EndTag */
  763 
  764     Status = AcpiUtWalkAmlResources (NULL, ObjDesc->Buffer.Pointer,
  765         ObjDesc->Buffer.Length, NULL, (void **) EndTag);
  766 
  767     return_ACPI_STATUS (Status);
  768 }

Cache object: faa3e16404ca5f9b22f89b69cd8cbb36


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.