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

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