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

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