sys/contrib/dev/acpica-unix-20061109/namespace/nsparse.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsparse - namespace interface to AML parser
   4  *              $Revision: 1.15 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 __NSPARSE_C__
 118
 119 #include "acpi.h"
 120 #include "acnamesp.h"
 121 #include "acparser.h"
 122 #include "acdispat.h"
 123 #include "actables.h"
 124
 125
 126 #define _COMPONENT          ACPI_NAMESPACE
 127         ACPI_MODULE_NAME    ("nsparse")
 128
 129
 130 /*******************************************************************************
 131  *
 132  * FUNCTION:    NsOneCompleteParse
 133  *
 134  * PARAMETERS:  PassNumber              - 1 or 2
 135  *              TableDesc               - The table to be parsed.
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: Perform one complete parse of an ACPI/AML table.
 140  *
 141  ******************************************************************************/
 142
 143 ACPI_STATUS
 144 AcpiNsOneCompleteParse (
 145     ACPI_NATIVE_UINT        PassNumber,
 146     ACPI_NATIVE_UINT        TableIndex)
 147 {
 148     ACPI_PARSE_OBJECT       *ParseRoot;
 149     ACPI_STATUS             Status;
 150     ACPI_NATIVE_UINT        AmlLength;
 151     UINT8                   *AmlStart;
 152     ACPI_WALK_STATE         *WalkState;
 153     ACPI_TABLE_HEADER       *Table;
 154     ACPI_OWNER_ID           OwnerId;
 155
 156
 157     ACPI_FUNCTION_TRACE (NsOneCompleteParse);
 158
 159
 160     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
 161     if (ACPI_FAILURE (Status))
 162     {
 163         return_ACPI_STATUS (Status);
 164     }
 165
 166     /* Create and init a Root Node */
 167
 168     ParseRoot = AcpiPsCreateScopeOp ();
 169     if (!ParseRoot)
 170     {
 171         return_ACPI_STATUS (AE_NO_MEMORY);
 172     }
 173
 174     /* Create and initialize a new walk state */
 175
 176     WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
 177     if (!WalkState)
 178     {
 179         AcpiPsFreeOp (ParseRoot);
 180         return_ACPI_STATUS (AE_NO_MEMORY);
 181     }
 182
 183     Status = AcpiGetTableByIndex (TableIndex, &Table);
 184     if (ACPI_FAILURE (Status))
 185     {
 186         AcpiDsDeleteWalkState (WalkState);
 187         AcpiPsFreeOp (ParseRoot);
 188         return_ACPI_STATUS (Status);
 189     }
 190
 191     /* Table must consist of at least a complete header */
 192
 193     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
 194     {
 195         Status = AE_BAD_HEADER;
 196     }
 197     else
 198     {
 199         AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
 200         AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
 201         Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL,
 202                     AmlStart, AmlLength, NULL, (UINT8) PassNumber);
 203     }
 204
 205     if (ACPI_FAILURE (Status))
 206     {
 207         AcpiDsDeleteWalkState (WalkState);
 208         AcpiPsDeleteParseTree (ParseRoot);
 209         return_ACPI_STATUS (Status);
 210     }
 211
 212     /* Parse the AML */
 213
 214     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "*PARSE* pass %d parse\n", PassNumber));
 215     Status = AcpiPsParseAml (WalkState);
 216
 217     AcpiPsDeleteParseTree (ParseRoot);
 218     return_ACPI_STATUS (Status);
 219 }
 220
 221
 222 /*******************************************************************************
 223  *
 224  * FUNCTION:    AcpiNsParseTable
 225  *
 226  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
 227  *              StartNode       - Where to enter the table into the namespace
 228  *
 229  * RETURN:      Status
 230  *
 231  * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
 232  *
 233  ******************************************************************************/
 234
 235 ACPI_STATUS
 236 AcpiNsParseTable (
 237     ACPI_NATIVE_UINT        TableIndex,
 238     ACPI_NAMESPACE_NODE     *StartNode)
 239 {
 240     ACPI_STATUS             Status;
 241
 242
 243     ACPI_FUNCTION_TRACE (NsParseTable);
 244
 245
 246     /*
 247      * AML Parse, pass 1
 248      *
 249      * In this pass, we load most of the namespace.  Control methods
 250      * are not parsed until later.  A parse tree is not created.  Instead,
 251      * each Parser Op subtree is deleted when it is finished.  This saves
 252      * a great deal of memory, and allows a small cache of parse objects
 253      * to service the entire parse.  The second pass of the parse then
 254      * performs another complete parse of the AML.
 255      */
 256     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start pass 1\n"));
 257     Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS1, TableIndex);
 258     if (ACPI_FAILURE (Status))
 259     {
 260         return_ACPI_STATUS (Status);
 261     }
 262
 263     /*
 264      * AML Parse, pass 2
 265      *
 266      * In this pass, we resolve forward references and other things
 267      * that could not be completed during the first pass.
 268      * Another complete parse of the AML is performed, but the
 269      * overhead of this is compensated for by the fact that the
 270      * parse objects are all cached.
 271      */
 272     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start pass 2\n"));
 273     Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS2, TableIndex);
 274     if (ACPI_FAILURE (Status))
 275     {
 276         return_ACPI_STATUS (Status);
 277     }
 278
 279     return_ACPI_STATUS (Status);
 280 }
 281
 282