1 /******************************************************************************
3 * Module Name: pstree - Parser op tree manipulation/traversal/search
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include <acpi/acparser.h>
46 #include <acpi/amlcode.h>
48 #define _COMPONENT ACPI_PARSER
49 ACPI_MODULE_NAME("pstree")
51 /* Local prototypes */
52 #ifdef ACPI_OBSOLETE_FUNCTIONS
53 union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op);
56 /*******************************************************************************
58 * FUNCTION: acpi_ps_get_arg
60 * PARAMETERS: Op - Get an argument for this op
61 * Argn - Nth argument to get
63 * RETURN: The argument (as an Op object). NULL if argument does not exist
65 * DESCRIPTION: Get the specified op's argument.
67 ******************************************************************************/
69 union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn)
71 union acpi_parse_object *arg = NULL;
72 const struct acpi_opcode_info *op_info;
74 ACPI_FUNCTION_ENTRY();
76 /* Get the info structure for this opcode */
78 op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
79 if (op_info->class == AML_CLASS_UNKNOWN) {
81 /* Invalid opcode or ASCII character */
86 /* Check if this opcode requires argument sub-objects */
88 if (!(op_info->flags & AML_HAS_ARGS)) {
90 /* Has no linked argument objects */
95 /* Get the requested argument object */
97 arg = op->common.value.arg;
100 arg = arg->common.next;
106 /*******************************************************************************
108 * FUNCTION: acpi_ps_append_arg
110 * PARAMETERS: Op - Append an argument to this Op.
111 * Arg - Argument Op to append
115 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
117 ******************************************************************************/
120 acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg)
122 union acpi_parse_object *prev_arg;
123 const struct acpi_opcode_info *op_info;
125 ACPI_FUNCTION_ENTRY();
131 /* Get the info structure for this opcode */
133 op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
134 if (op_info->class == AML_CLASS_UNKNOWN) {
138 ACPI_ERROR((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
139 op->common.aml_opcode));
143 /* Check if this opcode requires argument sub-objects */
145 if (!(op_info->flags & AML_HAS_ARGS)) {
147 /* Has no linked argument objects */
152 /* Append the argument to the linked argument list */
154 if (op->common.value.arg) {
156 /* Append to existing argument list */
158 prev_arg = op->common.value.arg;
159 while (prev_arg->common.next) {
160 prev_arg = prev_arg->common.next;
162 prev_arg->common.next = arg;
164 /* No argument list, this will be the first argument */
166 op->common.value.arg = arg;
169 /* Set the parent in this arg and any args linked after it */
172 arg->common.parent = op;
173 arg = arg->common.next;
175 op->common.arg_list_length++;
179 #ifdef ACPI_FUTURE_USAGE
180 /*******************************************************************************
182 * FUNCTION: acpi_ps_get_depth_next
184 * PARAMETERS: Origin - Root of subtree to search
185 * Op - Last (previous) Op that was found
187 * RETURN: Next Op found in the search.
189 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
190 * Return NULL when reaching "origin" or when walking up from root
192 ******************************************************************************/
194 union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
195 union acpi_parse_object *op)
197 union acpi_parse_object *next = NULL;
198 union acpi_parse_object *parent;
199 union acpi_parse_object *arg;
201 ACPI_FUNCTION_ENTRY();
207 /* Look for an argument or child */
209 next = acpi_ps_get_arg(op, 0);
214 /* Look for a sibling */
216 next = op->common.next;
221 /* Look for a sibling of parent */
223 parent = op->common.parent;
226 arg = acpi_ps_get_arg(parent, 0);
227 while (arg && (arg != origin) && (arg != op)) {
228 arg = arg->common.next;
233 /* Reached parent of origin, end search */
238 if (parent->common.next) {
240 /* Found sibling of parent */
242 return (parent->common.next);
246 parent = parent->common.parent;
252 #ifdef ACPI_OBSOLETE_FUNCTIONS
253 /*******************************************************************************
255 * FUNCTION: acpi_ps_get_child
257 * PARAMETERS: Op - Get the child of this Op
259 * RETURN: Child Op, Null if none is found.
261 * DESCRIPTION: Get op's children or NULL if none
263 ******************************************************************************/
265 union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op)
267 union acpi_parse_object *child = NULL;
269 ACPI_FUNCTION_ENTRY();
271 switch (op->common.aml_opcode) {
275 case AML_THERMAL_ZONE_OP:
276 case AML_INT_METHODCALL_OP:
278 child = acpi_ps_get_arg(op, 0);
288 child = acpi_ps_get_arg(op, 1);
291 case AML_POWER_RES_OP:
292 case AML_INDEX_FIELD_OP:
294 child = acpi_ps_get_arg(op, 2);
297 case AML_PROCESSOR_OP:
298 case AML_BANK_FIELD_OP:
300 child = acpi_ps_get_arg(op, 3);
304 /* All others have no children */
311 #endif /* ACPI_FUTURE_USAGE */