drivers/acpi/namespace/nsparse.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsparse - namespace interface to AML parser
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2008, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/acnamesp.h>
  46 #include <acpi/acparser.h>
  47 #include <acpi/acdispat.h>
  48 #include <acpi/actables.h>
  49
  50 #define _COMPONENT          ACPI_NAMESPACE
  51 ACPI_MODULE_NAME("nsparse")
  52
  53 /*******************************************************************************
  54  *
  55  * FUNCTION:    ns_one_complete_parse
  56  *
  57  * PARAMETERS:  pass_number             - 1 or 2
  58  *              table_desc              - The table to be parsed.
  59  *
  60  * RETURN:      Status
  61  *
  62  * DESCRIPTION: Perform one complete parse of an ACPI/AML table.
  63  *
  64  ******************************************************************************/
  65 acpi_status
  66 acpi_ns_one_complete_parse(u32 pass_number,
  67                            u32 table_index,
  68                            struct acpi_namespace_node *start_node)
  69 {
  70         union acpi_parse_object *parse_root;
  71         acpi_status status;
  72        u32 aml_length;
  73         u8 *aml_start;
  74         struct acpi_walk_state *walk_state;
  75         struct acpi_table_header *table;
  76         acpi_owner_id owner_id;
  77
  78         ACPI_FUNCTION_TRACE(ns_one_complete_parse);
  79
  80         status = acpi_tb_get_owner_id(table_index, &owner_id);
  81         if (ACPI_FAILURE(status)) {
  82                 return_ACPI_STATUS(status);
  83         }
  84
  85         /* Create and init a Root Node */
  86
  87         parse_root = acpi_ps_create_scope_op();
  88         if (!parse_root) {
  89                 return_ACPI_STATUS(AE_NO_MEMORY);
  90         }
  91
  92         /* Create and initialize a new walk state */
  93
  94         walk_state = acpi_ds_create_walk_state(owner_id, NULL, NULL, NULL);
  95         if (!walk_state) {
  96                 acpi_ps_free_op(parse_root);
  97                 return_ACPI_STATUS(AE_NO_MEMORY);
  98         }
  99
 100         status = acpi_get_table_by_index(table_index, &table);
 101         if (ACPI_FAILURE(status)) {
 102                 acpi_ds_delete_walk_state(walk_state);
 103                 acpi_ps_free_op(parse_root);
 104                 return_ACPI_STATUS(status);
 105         }
 106
 107         /* Table must consist of at least a complete header */
 108
 109         if (table->length < sizeof(struct acpi_table_header)) {
 110                 status = AE_BAD_HEADER;
 111         } else {
 112                 aml_start = (u8 *) table + sizeof(struct acpi_table_header);
 113                 aml_length = table->length - sizeof(struct acpi_table_header);
 114                 status = acpi_ds_init_aml_walk(walk_state, parse_root, NULL,
 115                                                aml_start, aml_length, NULL,
 116                                                (u8) pass_number);
 117         }
 118
 119         if (ACPI_FAILURE(status)) {
 120                 acpi_ds_delete_walk_state(walk_state);
 121                 goto cleanup;
 122         }
 123
 124         /* start_node is the default location to load the table */
 125
 126         if (start_node && start_node != acpi_gbl_root_node) {
 127                 status =
 128                     acpi_ds_scope_stack_push(start_node, ACPI_TYPE_METHOD,
 129                                              walk_state);
 130                 if (ACPI_FAILURE(status)) {
 131                         acpi_ds_delete_walk_state(walk_state);
 132                         goto cleanup;
 133                 }
 134         }
 135
 136         /* Parse the AML */
 137
 138         ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "*PARSE* pass %d parse\n",
 139                           (unsigned)pass_number));
 140         status = acpi_ps_parse_aml(walk_state);
 141
 142       cleanup:
 143         acpi_ps_delete_parse_tree(parse_root);
 144         return_ACPI_STATUS(status);
 145 }
 146
 147 /*******************************************************************************
 148  *
 149  * FUNCTION:    acpi_ns_parse_table
 150  *
 151  * PARAMETERS:  table_desc      - An ACPI table descriptor for table to parse
 152  *              start_node      - Where to enter the table into the namespace
 153  *
 154  * RETURN:      Status
 155  *
 156  * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
 157  *
 158  ******************************************************************************/
 159
 160 acpi_status
 161 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node)
 162 {
 163         acpi_status status;
 164
 165         ACPI_FUNCTION_TRACE(ns_parse_table);
 166
 167         /*
 168          * AML Parse, pass 1
 169          *
 170          * In this pass, we load most of the namespace.  Control methods
 171          * are not parsed until later.  A parse tree is not created.  Instead,
 172          * each Parser Op subtree is deleted when it is finished.  This saves
 173          * a great deal of memory, and allows a small cache of parse objects
 174          * to service the entire parse.  The second pass of the parse then
 175          * performs another complete parse of the AML.
 176          */
 177         ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "**** Start pass 1\n"));
 178         status =
 179             acpi_ns_one_complete_parse(ACPI_IMODE_LOAD_PASS1, table_index,
 180                                        start_node);
 181         if (ACPI_FAILURE(status)) {
 182                 return_ACPI_STATUS(status);
 183         }
 184
 185         /*
 186          * AML Parse, pass 2
 187          *
 188          * In this pass, we resolve forward references and other things
 189          * that could not be completed during the first pass.
 190          * Another complete parse of the AML is performed, but the
 191          * overhead of this is compensated for by the fact that the
 192          * parse objects are all cached.
 193          */
 194         ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "**** Start pass 2\n"));
 195         status =
 196             acpi_ns_one_complete_parse(ACPI_IMODE_LOAD_PASS2, table_index,
 197                                        start_node);
 198         if (ACPI_FAILURE(status)) {
 199                 return_ACPI_STATUS(status);
 200         }
 201
 202         return_ACPI_STATUS(status);
 203 }