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>
49 #define _COMPONENT ACPI_PARSER
50 ACPI_MODULE_NAME("pstree")
52 /* Local prototypes */
53 #ifdef ACPI_OBSOLETE_FUNCTIONS
54 union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op);
57 /*******************************************************************************
59 * FUNCTION: acpi_ps_get_arg
61 * PARAMETERS: Op - Get an argument for this op
62 * Argn - Nth argument to get
64 * RETURN: The argument (as an Op object). NULL if argument does not exist
66 * DESCRIPTION: Get the specified op's argument.
68 ******************************************************************************/
70 union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn)
72 union acpi_parse_object *arg = NULL;
73 const struct acpi_opcode_info *op_info;
75 ACPI_FUNCTION_ENTRY();
77 /* Get the info structure for this opcode */
79 op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
80 if (op_info->class == AML_CLASS_UNKNOWN) {
82 /* Invalid opcode or ASCII character */
87 /* Check if this opcode requires argument sub-objects */
89 if (!(op_info->flags & AML_HAS_ARGS)) {
91 /* Has no linked argument objects */
96 /* Get the requested argument object */
98 arg = op->common.value.arg;
101 arg = arg->common.next;
107 /*******************************************************************************
109 * FUNCTION: acpi_ps_append_arg
111 * PARAMETERS: Op - Append an argument to this Op.
112 * Arg - Argument Op to append
116 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
118 ******************************************************************************/
121 acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg)
123 union acpi_parse_object *prev_arg;
124 const struct acpi_opcode_info *op_info;
126 ACPI_FUNCTION_ENTRY();
132 /* Get the info structure for this opcode */
134 op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
135 if (op_info->class == AML_CLASS_UNKNOWN) {
139 ACPI_ERROR((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
140 op->common.aml_opcode));
144 /* Check if this opcode requires argument sub-objects */
146 if (!(op_info->flags & AML_HAS_ARGS)) {
148 /* Has no linked argument objects */
153 /* Append the argument to the linked argument list */
155 if (op->common.value.arg) {
157 /* Append to existing argument list */
159 prev_arg = op->common.value.arg;
160 while (prev_arg->common.next) {
161 prev_arg = prev_arg->common.next;
163 prev_arg->common.next = arg;
165 /* No argument list, this will be the first argument */
167 op->common.value.arg = arg;
170 /* Set the parent in this arg and any args linked after it */
173 arg->common.parent = op;
174 arg = arg->common.next;
176 op->common.arg_list_length++;
180 #ifdef ACPI_FUTURE_USAGE
181 /*******************************************************************************
183 * FUNCTION: acpi_ps_get_depth_next
185 * PARAMETERS: Origin - Root of subtree to search
186 * Op - Last (previous) Op that was found
188 * RETURN: Next Op found in the search.
190 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
191 * Return NULL when reaching "origin" or when walking up from root
193 ******************************************************************************/
195 union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
196 union acpi_parse_object *op)
198 union acpi_parse_object *next = NULL;
199 union acpi_parse_object *parent;
200 union acpi_parse_object *arg;
202 ACPI_FUNCTION_ENTRY();
208 /* Look for an argument or child */
210 next = acpi_ps_get_arg(op, 0);
215 /* Look for a sibling */
217 next = op->common.next;
222 /* Look for a sibling of parent */
224 parent = op->common.parent;
227 arg = acpi_ps_get_arg(parent, 0);
228 while (arg && (arg != origin) && (arg != op)) {
229 arg = arg->common.next;
234 /* Reached parent of origin, end search */
239 if (parent->common.next) {
241 /* Found sibling of parent */
243 return (parent->common.next);
247 parent = parent->common.parent;
253 #ifdef ACPI_OBSOLETE_FUNCTIONS
254 /*******************************************************************************
256 * FUNCTION: acpi_ps_get_child
258 * PARAMETERS: Op - Get the child of this Op
260 * RETURN: Child Op, Null if none is found.
262 * DESCRIPTION: Get op's children or NULL if none
264 ******************************************************************************/
266 union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op)
268 union acpi_parse_object *child = NULL;
270 ACPI_FUNCTION_ENTRY();
272 switch (op->common.aml_opcode) {
276 case AML_THERMAL_ZONE_OP:
277 case AML_INT_METHODCALL_OP:
279 child = acpi_ps_get_arg(op, 0);
289 child = acpi_ps_get_arg(op, 1);
292 case AML_POWER_RES_OP:
293 case AML_INDEX_FIELD_OP:
295 child = acpi_ps_get_arg(op, 2);
298 case AML_PROCESSOR_OP:
299 case AML_BANK_FIELD_OP:
301 child = acpi_ps_get_arg(op, 3);
305 /* All others have no children */
312 #endif /* ACPI_FUTURE_USAGE */