blob: 46a79b0103b676ef5edf0008f40f70f1eb0ad80a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: nsparse - namespace interface to AML parser
4 *
5 *****************************************************************************/
6
7/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
45#include <acpi/acnamesp.h>
46#include <acpi/acparser.h>
47#include <acpi/acdispat.h>
Bob Mooref3d2e782007-02-02 19:48:18 +030048#include <acpi/actables.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#define _COMPONENT ACPI_NAMESPACE
Len Brown4be44fc2005-08-05 00:44:28 -040051ACPI_MODULE_NAME("nsparse")
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
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 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -070065acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +030066acpi_ns_one_complete_parse(acpi_native_uint pass_number,
Bob Moore7f4ac9f2008-04-10 19:06:39 +040067 acpi_native_uint table_index,
68 struct acpi_namespace_node * start_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069{
Len Brown4be44fc2005-08-05 00:44:28 -040070 union acpi_parse_object *parse_root;
71 acpi_status status;
Bob Mooref3d2e782007-02-02 19:48:18 +030072 acpi_native_uint aml_length;
73 u8 *aml_start;
Len Brown4be44fc2005-08-05 00:44:28 -040074 struct acpi_walk_state *walk_state;
Bob Mooref3d2e782007-02-02 19:48:18 +030075 struct acpi_table_header *table;
76 acpi_owner_id owner_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Bob Mooreb229cf92006-04-21 17:15:00 -040078 ACPI_FUNCTION_TRACE(ns_one_complete_parse);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Bob Mooref3d2e782007-02-02 19:48:18 +030080 status = acpi_tb_get_owner_id(table_index, &owner_id);
81 if (ACPI_FAILURE(status)) {
82 return_ACPI_STATUS(status);
83 }
84
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 /* Create and init a Root Node */
86
Len Brown4be44fc2005-08-05 00:44:28 -040087 parse_root = acpi_ps_create_scope_op();
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 if (!parse_root) {
Len Brown4be44fc2005-08-05 00:44:28 -040089 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 }
91
92 /* Create and initialize a new walk state */
93
Bob Mooref3d2e782007-02-02 19:48:18 +030094 walk_state = acpi_ds_create_walk_state(owner_id, NULL, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 if (!walk_state) {
Len Brown4be44fc2005-08-05 00:44:28 -040096 acpi_ps_free_op(parse_root);
97 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 }
99
Bob Mooref3d2e782007-02-02 19:48:18 +0300100 status = acpi_get_table_by_index(table_index, &table);
Len Brown4be44fc2005-08-05 00:44:28 -0400101 if (ACPI_FAILURE(status)) {
102 acpi_ds_delete_walk_state(walk_state);
Bob Mooref3d2e782007-02-02 19:48:18 +0300103 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,
Bob Moore1d18c052008-04-10 19:06:40 +0400115 aml_start, (u32) aml_length,
116 NULL, (u8) pass_number);
Bob Mooref3d2e782007-02-02 19:48:18 +0300117 }
118
119 if (ACPI_FAILURE(status)) {
120 acpi_ds_delete_walk_state(walk_state);
Bob Moore1d18c052008-04-10 19:06:40 +0400121 goto cleanup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 }
123
Bob Moore7f4ac9f2008-04-10 19:06:39 +0400124 /* start_node is the default location to load the table */
125
126 if (start_node && start_node != acpi_gbl_root_node) {
Bob Moore1d18c052008-04-10 19:06:40 +0400127 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 }
Bob Moore7f4ac9f2008-04-10 19:06:39 +0400134 }
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 /* Parse the AML */
137
Len Brown4be44fc2005-08-05 00:44:28 -0400138 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "*PARSE* pass %d parse\n",
Alexey Starikovskiyb0b7eaa2007-01-25 22:39:44 -0500139 (unsigned)pass_number));
Len Brown4be44fc2005-08-05 00:44:28 -0400140 status = acpi_ps_parse_aml(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Bob Moore1d18c052008-04-10 19:06:40 +0400142 cleanup:
Len Brown4be44fc2005-08-05 00:44:28 -0400143 acpi_ps_delete_parse_tree(parse_root);
144 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/*******************************************************************************
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
160acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300161acpi_ns_parse_table(acpi_native_uint table_index,
Len Brown4be44fc2005-08-05 00:44:28 -0400162 struct acpi_namespace_node *start_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
Len Brown4be44fc2005-08-05 00:44:28 -0400164 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Bob Mooreb229cf92006-04-21 17:15:00 -0400166 ACPI_FUNCTION_TRACE(ns_parse_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168 /*
169 * AML Parse, pass 1
170 *
171 * In this pass, we load most of the namespace. Control methods
172 * are not parsed until later. A parse tree is not created. Instead,
173 * each Parser Op subtree is deleted when it is finished. This saves
174 * a great deal of memory, and allows a small cache of parse objects
175 * to service the entire parse. The second pass of the parse then
Bob Mooreec3153f2007-02-02 19:48:21 +0300176 * performs another complete parse of the AML.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 */
Len Brown4be44fc2005-08-05 00:44:28 -0400178 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "**** Start pass 1\n"));
Bob Moore7f4ac9f2008-04-10 19:06:39 +0400179 status =
180 acpi_ns_one_complete_parse(ACPI_IMODE_LOAD_PASS1, table_index,
181 start_node);
Len Brown4be44fc2005-08-05 00:44:28 -0400182 if (ACPI_FAILURE(status)) {
183 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 }
185
186 /*
187 * AML Parse, pass 2
188 *
189 * In this pass, we resolve forward references and other things
190 * that could not be completed during the first pass.
191 * Another complete parse of the AML is performed, but the
192 * overhead of this is compensated for by the fact that the
193 * parse objects are all cached.
194 */
Len Brown4be44fc2005-08-05 00:44:28 -0400195 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "**** Start pass 2\n"));
Bob Moore7f4ac9f2008-04-10 19:06:39 +0400196 status =
197 acpi_ns_one_complete_parse(ACPI_IMODE_LOAD_PASS2, table_index,
198 start_node);
Len Brown4be44fc2005-08-05 00:44:28 -0400199 if (ACPI_FAILURE(status)) {
200 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 }
202
Len Brown4be44fc2005-08-05 00:44:28 -0400203 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204}